Überauth Shopify

Shopify OAuth2 strategy for Überauth.

Installation

1. Setup your application at Shopify.

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

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

3. Add the strategy to your applications:

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

4. Add Shopify to your Überauth configuration:

   config :ueberauth, Ueberauth,
     providers: [
       shopify: {Ueberauth.Strategy.Shopify, []}
     ]

5. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.Shopify.OAuth,
     client_id: System.get_env("SHOPIFY_API_KEY"),
     client_secret: System.get_env("SHOPIFY_SECRET")

6. If you haven’t already, create a pipeline and setup routes for your callback handler:

   pipeline :auth do
     Ueberauth.plug "/auth"
   end
   
   scope "/auth" do
     pipe_through [:browser, :auth]
   
     get "/:provider/callback", AuthController, :callback
   end

7. Create an endpoint for the callback where you will handle the Ueberauth.Auth struct:

   defmodule MyApp.AuthController do
     use MyApp.Web, :controller
   
     def callback_phase(%{ assigns: %{ ueberauth_failure: fails } } = conn, _params) do
       # do things with the failure
     end
   
     def callback_phase(%{ assigns: %{ ueberauth_auth: auth } } = conn, params) do
       # do things with the auth
     end
   end

8. 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 initial the request through:

/auth/shopify

Or with options:

/auth/shopify?scope=read_orders%20read_products

By default the requested scope is “read_products,read_customers,read_orders”. Scope can be configured either explicitly as a scope query value on the request path or in your configuration:

config :ueberauth, Ueberauth,
  providers: [
    shopify: { Ueberauth.Strategy.Shopify, [default_scope: "read_products,read_customers,read_orders"] }
  ]

License

Please see LICENSE for licensing details.