Git Product home page Git Product logo

ueberauth_bnet's Introduction

Ü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.

ueberauth_bnet's People

Contributors

schwarz avatar

Watchers

Adam Rubin avatar James Cloos avatar

Forkers

dionridley

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.