oauth strategy for ueberauth lib using data from OSM
Go to file
2019-03-12 21:12:47 -07:00
config Improve OAuth error handling (#10) 2016-10-27 09:35:12 -06:00
lib Add location to Info (#19) 2018-02-13 11:30:01 -07:00
test Improve OAuth error handling (#10) 2016-10-27 09:35:12 -06:00
.gitignore Initial Twitter strategy 2015-11-24 21:14:54 -08:00
CHANGELOG.md Release 0.2.4 2016-12-26 21:12:19 -07:00
CONTRIBUTING.md Initial Twitter strategy 2015-11-24 21:14:54 -08:00
LICENSE Initial Twitter strategy 2015-11-24 21:14:54 -08:00
mix.exs Update Ueberauth to 0.6.0 2019-03-12 21:12:47 -07:00
mix.lock Update Ueberauth to 0.6.0 2019-03-12 21:12:47 -07:00
README.md dev mode example (#23) 2018-06-05 22:00:43 -04:00

Überauth Twitter

Twitter strategy for Überauth.

Note: Sessions are required for this strategy.

Installation

  1. Setup your application at Twitter Developers.

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

    def deps do
      [{:ueberauth_twitter, "~> 0.2"},
       {:oauth, github: "tim/erlang-oauth"}]
    end
    
  3. Add the strategy to your applications:

    def application do
      [applications: [:ueberauth_twitter]]
    end
    
  4. Add Twitter to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        twitter: {Ueberauth.Strategy.Twitter, []}
      ]
    
  5. 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")
    
  6. Include the Überauth plug in your controller:

    defmodule MyApp.AuthController do
      use MyApp.Web, :controller
      plug Ueberauth
      ...
    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 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.