https://github.com/borodiychuk/ueberauth_foursquare

Foursquare OAuth2 Strategy for Überauth
https://github.com/borodiychuk/ueberauth_foursquare

elixir foursquare foursquare-oauth2-strategy oauth2

Last synced: 5 days ago
JSON representation

Foursquare OAuth2 Strategy for Überauth

• Host: GitHub
• URL: https://github.com/borodiychuk/ueberauth_foursquare
• Owner: borodiychuk
• License: mit
• Created: 2017-01-13T23:36:15.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-19T19:01:53.000Z (almost 8 years ago)
• Last Synced: 2024-12-10T05:32:25.837Z (about 1 month ago)
• Topics: elixir, foursquare, foursquare-oauth2-strategy, oauth2
• Language: Elixir
• Homepage:
• Size: 12.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-elixir - ueberauth_foursquare - Foursquare OAuth2 Strategy for Überauth. (Authentication)
• freaking_awesome_elixir - Elixir - Foursquare OAuth2 Strategy for Überauth. (Authentication)
• awesome-elixir - ueberauth_foursquare - Foursquare OAuth2 Strategy for Überauth. (Authentication)

README

        
# Überauth Foursquare

Foursquare OAuth2 strategy for Überauth.

[![Build Status](https://travis-ci.org/borodiychuk/ueberauth_foursquare.svg?branch=master)](https://travis-ci.org/borodiychuk/ueberauth_foursquare) [![Deps Status](https://beta.hexfaktor.org/badge/all/github/borodiychuk/ueberauth_foursquare.svg)](https://beta.hexfaktor.org/github/borodiychuk/ueberauth_foursquare) 

## Installation

1. Setup your application at [Foursquare Developer](https://developer.foursquare.com/).

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

    ```elixir

    def deps do

      [{:ueberauth_foursquare, "~> 0.1"}]

    end

    ```

1. Add the strategy to your applications:

    ```elixir

    def application do

      [applications: [:ueberauth_foursquare]]

    end

    ```

1. Add Foursquare to your Überauth configuration:

    ```elixir

    config :ueberauth, Ueberauth,

      providers: [

        foursquare: {Ueberauth.Strategy.Foursquare, []}

      ]

    ```

1.  Update your provider configuration:

    ```elixir

    config :ueberauth, Ueberauth.Strategy.Foursquare.OAuth,

      client_id:     System.get_env("FOURSQUARE_CLIENT_ID"),

      client_secret: System.get_env("FOURSQUARE_CLIENT_SECRET")

    ```

1.  Include the Überauth plug in your controller:

    ```elixir

    defmodule MyApp.AuthController do

      use MyApp.Web, :controller

      pipeline :browser do

        plug Ueberauth

        ...

       end

    end

    ```

1.  Create the request and callback routes if you haven't already:

    ```elixir

    scope "/auth", MyApp do

      pipe_through :browser

      get "/:provider", AuthController, :request

      get "/:provider/callback", AuthController, :callback

    end

    ```

1. You controller needs to implement callbacks to deal with `Ueberauth.Auth` and `Ueberauth.Failure` responses.

For an example implementation see the [Überauth Example](https://github.com/ueberauth/ueberauth_example) application.

## Calling

You can initial the request through:

    /auth/foursquare

## License

Please see [LICENSE](https://github.com/borodiychuk/ueberauth_foursquare/blob/master/LICENSE) for licensing details.