ueberauth_foursquare

Foursquare OAuth2 Strategy for Überauth

Monthly Downloads: 19

Programming language: Elixir

License: MIT License

Tags: Authentication    

Latest version: v0.1.3

README

Überauth Foursquare

Foursquare OAuth2 strategy for Überauth.

Installation

1. Setup your application at Foursquare Developer.

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

   def deps do
     [{:ueberauth_foursquare, "~> 0.1"}]
   end
   

3. Add the strategy to your applications:

   def application do
     [applications: [:ueberauth_foursquare]]
   end
   

4. Add Foursquare to your Überauth configuration:

   config :ueberauth, Ueberauth,
     providers: [
       foursquare: {Ueberauth.Strategy.Foursquare, []}
     ]
   

5. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.Foursquare.OAuth,
     client_id:     System.get_env("FOURSQUARE_CLIENT_ID"),
     client_secret: System.get_env("FOURSQUARE_CLIENT_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. 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

You can initial the request through:

/auth/foursquare

License

Please see LICENSE for licensing details.