View Source README
Shift4Shop Oauth
Shift4Shop OAuth2 strategy for Überauth/Assent.
installation
Installation
Setup your application at Shift4Shop Developers.
Add
:ueberauth_shift4shop
to your list of dependencies inmix.exs
:def deps do [{:oauth2_shift4shop, "~> 1.0.0"}] end
Add the strategy to your applications:
def application do [applications: [:oauth2_shift4shop]] end
Add Shift4Shop to your Überauth configuration:
config :ueberauth, Ueberauth, providers: [ oauth2_shift4shop: {Shift4Shop.Strategy.Ueberauth, []} ]
Update your provider configuration:
config :ueberauth, Shift4Shop.Strategy.OAuth2, client_id: System.get_env("SHIFT4SHOP_KEY")
Include the Überauth plug in your controller:
defmodule MyApp.AuthController do use MyApp.Web, :controller plug Ueberauth ... end
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
And make sure to set the correct redirect URI(s) in your Shift4Shop application to wire up the callback.
Your controller needs to implement callbacks to deal with
Ueberauth.Auth
andUeberauth.Failure
responses.
For an example implementation see the Überauth Example application.
calling
Calling
Depending on the configured url you can initialize the request through:
/auth/shift4shop
You must use something other than Shift4Shop in the callback routes, I use /auth/td see below:
config :ueberauth, Ueberauth,
providers: [
shift4shop: {Ueberauth.Strategy.Shift4Shop, [request_path: "/auth/shift4shop", callback_path: "/auth/shift4shop/callback"]}
]
license
License
Please see LICENSE for licensing details.