ueberauth_khanacademy

Khan Academy strategy for Überauth


Keywords
elixir, khan-academy, oauth, plug, strategy, ueberauth
License
MIT

Documentation

Überauth Khan Academy

Khan Academy strategy for Überauth.

Note: Sessions are required for this strategy.

Source code is available on Github.
Package is available on hex.

Installation

  1. Register your app at Khan Academy.

  2. Add :ueberauth_khanacademy to your list of dependencies in mix.exs:

    def deps do
      [{:ueberauth_khanacademy, "~> 0.0.1"}]
    end
  3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_khanacademy]]
    end
  4. Add Khan Academy to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        khanacademy: {Ueberauth.Strategy.KhanAcademy, []}
      ]
  5. Update your provider configuration:

    config :ueberauth, Ueberauth.Strategy.KhanAcademy.OAuth,
      consumer_key: System.get_env("KHANACADEMY_CONSUMER_KEY"),
      consumer_secret: System.get_env("KHANACADEMY_CONSUMER_SECRET")
  6. Include the Überauth plug in your controller:

    defmodule MyApp.AuthController do
      use MyApp.Web, :controller
    
      pipeline :browser do
        plug Ueberauth
        ...
       end
    end
  7. Create the request and callback routes if you haven't already:

    scope "/auth", MyApp do
      pipe_through :browser
    
      get "/:provider", AuthController, :request
      get "/:provider/callback", AuthController, :callback
    end
  8. Your controller needs to implement callbacks to deal with Ueberauth.Auth and Ueberauth.Failure responses.

For an example implementation see the Überauth Example application.

Calling

Depending on the configured url you can initial the request through:

/auth/khanacademy

Currently no permissions or scope is available.

License

Please see LICENSE for licensing details.

Acknowledgment

My best to Christopher Adams as his Flickr strategy was the starting point for this application. Appreciate your work sir!