oauth strategy for ueberauth lib using data from OSM
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tykayn 747208ac09 Mise à jour de 'LICENSE' 12 months ago
.idea 📖 docs replace links to github to tedomum gitlab 1 year ago
config Improve OAuth error handling (#10) 5 years ago
lib 📖 docs replace links to github to tedomum gitlab 1 year ago
test 📖 docs replace links to github to tedomum gitlab 1 year ago
.gitignore Initial Twitter strategy 6 years ago
CHANGELOG.md Bump version (#29) 3 years ago
CONTRIBUTING.md Initial Twitter strategy 6 years ago
LICENSE Mise à jour de 'LICENSE' 12 months ago
README.md 📖 docs replace links to github to tedomum gitlab 1 year ago
mix.exs 📖 docs replace links to github to tedomum gitlab 1 year ago
mix.lock Remove Poison from deps 3 years ago

README.md

Überauth OpenStreetMap

OpenStreetMap strategy for Überauth.

Note: Sessions are required for this strategy.

Notes

avoir un compte OSM et créer son app sur OSM ici https://www.openstreetmap.org/user/username/oauth_clients

URL du jeton de requête :

https://www.openstreetmap.org/oauth/request_token

URL du jeton d’accès :

https://www.openstreetmap.org/oauth/access_token

URL d’autorisation :

https://www.openstreetmap.org/oauth/authorize

Demande les permissions suivantes à l’utilisateur :

  • lire les préférences de l’utilisateur

Nous prenons en charge les signatures HMAC-SHA1 (recommandé) et RSA-SHA1.

Installation

  1. Setup your application at OpenStreetMap Developers.

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

    def deps do
      [
        {:ueberauth_OpenStreetMap, "~> 0.3"}
      ]
    end
    
  3. Add OpenStreetMap to your Überauth configuration:

    config :ueberauth, Ueberauth,
      providers: [
        OpenStreetMap: {Ueberauth.Strategy.OpenStreetMap, []}
      ]
    
  4. Update your provider configuration:

    config :ueberauth, Ueberauth.Strategy.OpenStreetMap.OAuth,
      consumer_key: System.get_env("OpenStreetMap_CONSUMER_KEY"),
      consumer_secret: System.get_env("OpenStreetMap_CONSUMER_SECRET")
    
  5. Include the Überauth plug in your controller:

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

Development mode

As noted when registering your application on the OpenStreetMap 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/OpenStreetMap/callback

License

Please see LICENSE for licensing details.