config | ||
lib | ||
test | ||
.gitignore | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
LICENSE | ||
mix.exs | ||
mix.lock | ||
README.md |
Überauth Twitter
Twitter strategy for Überauth.
Note: Sessions are required for this strategy.
Installation
-
Setup your application at Twitter Developers.
-
Add
:ueberauth_twitter
to your list of dependencies inmix.exs
:def deps do [{:ueberauth_twitter, "~> 0.2"}, {:oauth, github: "tim/erlang-oauth"}] end
-
Add the strategy to your applications:
def application do [applications: [:ueberauth_twitter]] end
-
Add Twitter to your Überauth configuration:
config :ueberauth, Ueberauth, providers: [ twitter: {Ueberauth.Strategy.Twitter, []} ]
-
Update your provider configuration:
config :ueberauth, Ueberauth.Strategy.Twitter.OAuth, consumer_key: System.get_env("TWITTER_CONSUMER_KEY"), consumer_secret: System.get_env("TWITTER_CONSUMER_SECRET")
-
Include the Überauth plug in your controller:
defmodule MyApp.AuthController do use MyApp.Web, :controller plug Ueberauth ... end
-
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
-
Your controller needs to implement callbacks to deal with
Ueberauth.Auth
andUeberauth.Failure
responses.
For an example implementation see the Überauth Example application.
Calling
Depending on the configured url you can initiate the request through:
/auth/twitter
Development mode
As noted when registering your application on the Twitter Developer site, you need to explicitly specify the oauth_callback
url. While in development, this is an example url you need to enter.
Website - http://127.0.0.1
Callback URL - http://127.0.0.1:4000/auth/twitter/callback
License
Please see LICENSE for licensing details.