adamrubin / ueberauth_bnet

Ueberauth Strategy for Battle.net Login

Überauth Battle.net

Battle.net OAuth2 strategy for Überauth.

Installation

1. Setup your application on the Battle.net Developer Portal.

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

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

3. Add the strategy to your applications:

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

4. Add Battle.net to your Überauth configuration:

   config :ueberauth, Ueberauth,
     providers: [
       bnet: {Ueberauth.Strategy.Bnet, []}
     ]

5. Update your provider configuration:

   config :ueberauth, Ueberauth.Strategy.Bnet.OAuth,
     client_id: System.get_env("BNET_CLIENT_ID"),
     client_secret: System.get_env("BNET_CLIENT_SECRET"),
     region: System.get_env("BNET_REGION")

   By default the US region is used.

6. Include the Überauth plug in your controller:

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

   Battle.net expects a HTTPS redirect URI, extra steps might be necessary to set it up for your dev environment.

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/bnet

Or with options:

/auth/bnet?scope=wow.profile%20sc2.profile

By default the requested scope is empty and the region is US. Scope can be configured either explicitly as a scope query value on the request path or in your configuration:

config :ueberauth, Ueberauth,
  providers: [
    bnet: {Ueberauth.Strategy.Bnet, [scope: "wow.profile sc2.profiles"]}
  ]

Available scopes are: wow.profile and sc2.profile.

License

Please see LICENSE for licensing details.