oauth strategy for ueberauth lib using data from OSM
Go to file
Jeff Browning 97435e8643 Improve OAuth error handling (#10)
* Fixes a crash on network error in access_token!/2 and request_token!/2
* Fixes a crash when an API request results in a non-200 status
2016-10-27 09:35:12 -06:00
config Improve OAuth error handling (#10) 2016-10-27 09:35:12 -06:00
lib Improve OAuth error handling (#10) 2016-10-27 09:35:12 -06: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.3 2016-08-15 08:48:31 -06: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
README.md fix 'providers' configuration step in README 2015-12-20 09:08:14 -05:00
mix.exs Add poison to dependencies (#11) 2016-10-27 09:34:37 -06:00
mix.lock Release 0.2.3 2016-08-15 08:48:31 -06:00

README.md

Ü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. You 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/twitter

License

Please see LICENSE for licensing details.