omniauth-bungie-oauth2 0.1.2 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1c3aa5d2f1b05dc0187ed37d39f075c66fb3b29
-  data.tar.gz: c9aad36bed6c0079d5e37db9eb3a622cce82d215
+  metadata.gz: b651f2022b030e894273b6b25b4611671df43ff0
+  data.tar.gz: 581fcf757b94b5959c57f2c40a465277ef380e7e
 SHA512:
-  metadata.gz: 310acd967bf14533cd1d490992be687ead6bb733d102a5193f43ff65ce967319c350ae790868e8fb1a12eb1890fe25c099d11c7abea7eeff7f99ca1307aa8165
-  data.tar.gz: 67edafe5cce55d5f2c5e2eb39ab343e5eb9a679c86a687fe072b37e4beec746e50863368d665281c1c87fd40f9356d71468be35ef0afabc1c8856340e2d97b31
+  metadata.gz: 4382fe1d09c6d158cf099a5feb99ba0dc12d67e1722a6aaa707a433fc60e7c1d2ac4df5cbd80ea9d23deabad425521cc974f7f968184a2d8c7d7d7ef2711fd31
+  data.tar.gz: 0d3142627717410b590c4377fe2405a7dc043d1eb551ef40c9be6bbecf8df1d482e8b618fdd9a21ab292b91477cc3b9b5302698fa1d63440acf9c9f205f6467e

data/README.md

@@ -9,9 +9,9 @@ A Bungie OAuth2 strategy for Omniauth.
 
 Add this line to your application's Gemfile:
 
-```ruby
+~~~~ruby
 gem 'omniauth-bungie-oauth2'
-```
+~~~~
 
 And then execute:
 
@@ -21,20 +21,17 @@ And then execute:
 
 ### Settings
 
-For full usage this gem You must create an application with authentication access on [Bungie.net](https://www.bungie.net/en/application).
+For usage this gem You must create an application with authentication access on [Bungie.net](https://www.bungie.net/en/application).
+You should set **Confidential** value in the `OAuth Client Type` field.
 
 After this, you can integrate this strategy with your application. (More about A Bungie OAuth2 you can read on [Help page](https://www.bungie.net/en/Help/Article/45481))
 
-For example, you can add the middleware to a Rails application in `/config/application.rb`:
+**This provider uses four arguments:**
 
-~~~ruby
-config.middleware.use OmniAuth::Builder do
-  provider :bungie,
-    'x_api_key_from_bungie_app_settings',
-    'authorization_url_from_bungie_app_settings',
-    :origin => 'origin_url_if_you_need'
-end
-~~~~
+* `client_id` - OAuth client_id,
+* `client_secret` - OAuth client_secret,
+* `x_api_key` - API Key,
+* `redirect_uri` - Redirect URL.
 
 ### Rails integration
 
@@ -43,12 +40,15 @@ For integration with Rails You have to setup your strategy configuration in `con
 ~~~~ruby
 Devise.setup do |config|
   config.omniauth :bungie,
-    'x_api_key_from_bungie_app_settings',
-    'authorization_url_from_bungie_app_settings',
-    :origin => 'origin_url_if_you_need'
+    'client_id',
+    'client_secret',
+    'x_api_key',
+    'redirect_url'
 end
 ~~~~
 
+> You can also define it in initializers with `config.middleware.use OmniAuth::Builder`.
+
 After this You should define omniauth callback in routes and controller.
 
 **routes.rb:**
@@ -78,28 +78,30 @@ class Devise::OmniauthCallbacksController < Devise::OmniauthCallbacksController
       redirect_to '/'
     end
   end
+end
+~~~~
 
-  def failure
-    redirect_to '/'
+Now You should define `from_omniauth` method in your `User` model:
+
+~~~~ruby
+def self.from_omniauth(auth)
+  where(:uid => auth.uid).first_or_create do |user|
+    user.membership_id = auth.info.membership_id
+    user.display_name  = auth.info.display_name
+    user.unique_name   = auth.info.unique_name
   end
 end
 ~~~~
 
+> Do not forget to specify model fields in your migration.
+
 ### Result
 
 After all manipulation the `request.env["omniauth.auth"]` have the next fields:
 
 * `uid` with BungieNetUser membershipId
-* `info` with Destiny membershipId, membershipType and displayName
-* `extra` with [GetBungieAccount](https://destinydevs.github.io/BungieNetPlatform/docs/UserService/GetBungieAccount) result
-
-## Configuration
-
-This provider require two arguments and have one special option:
-
-* `api_key` - X-Api-Key for Bungie API;
-* `auth_url` - Autherization url;
-* `origin` - Origin url;
+* `info` with membershipId, uniqueName, displayName
+* `extra` with [GetCurrentBungieNetUser](https://destinydevs.github.io/BungieNetPlatform/docs/UserService/GetCurrentBungieNetUser) result
 
 ## Contributing
 

data/lib/omniauth/strategies/bungie.rb

@@ -1,118 +1,50 @@
-require 'omniauth'
-require 'omniauth-oauth2'
-require 'socket'
-require 'timeout'
-
 module OmniAuth
   module Strategies
     class Bungie < OmniAuth::Strategies::OAuth2
-      # Arguments
-      args [:api_key, :auth_url]
+      args [:client_id, :client_secret, :api_key, :redirect_uri]
 
-      # Options
       option :name, 'bungie'
-      option :origin, nil
-
-      # Update client with Faraday middleware & special authorize url.
-      def client
-        client_options = {
-          :authorize_url => options.auth_url
-        }.merge(options.client_options)
-
-        ::OAuth2::BungieClient.new(nil, nil, deep_symbolize(client_options)) do |b|
-          b.request :json
-
-          b.adapter Faraday.default_adapter
-        end
-      end
-
-      def merge_stack(stack)
-        stack.inject({}) do |a, e|
-          a.merge!(e) unless e.nil?
-          a
-        end
-      end
-
-      # Updated callback phase with new refreshing
-      def callback_phase
-        error = request.params["error_reason"] || request.params["error"]
-
-        if error
-          fail!(error, CallbackError.new(request.params["error"], request.params["error_description"] || request.params["error_reason"], request.params["error_uri"]))
-        elsif !options.provider_ignores_state && (request.params["state"].to_s.empty? || request.params["state"] != session.delete("omniauth.state"))
-          fail!(:csrf_detected, CallbackError.new(:csrf_detected, "CSRF detected"))
-        else
-          self.access_token = build_access_token
-          self.access_token = access_token.refresh!(token_params) if access_token.expired?
 
-          env['omniauth.auth'] = auth_hash
+      option :client_options, {
+        :site => 'https://www.bungie.net',
+        :authorize_url => '/en/oauth/authorize',
+        :token_url => '/platform/app/oauth/token'
+      }
 
-          call_app!
-        end
-      rescue ::OAuth2::Error, CallbackError => e
-        fail!(:invalid_credentials, e)
-      rescue ::Timeout::Error, ::Errno::ETIMEDOUT => e
-        fail!(:timeout, e)
-      rescue ::SocketError => e
-        fail!(:failed_to_connect, e)
-      end
+      def client
+        client_options = options.client_options.merge(
+          :connection_opts => {
+            :headers => { 'X-API-Key' => options.api_key }
+          },
+          :redirect_uri => options.redirect_uri
+        )
 
-      #  Defining of Origin string
-      def origin
-        if options.origin === true
-          request.base_url
-        elsif options.origin.is_a? String
-          options.origin
-        else
-          ''
-        end
+        ::OAuth2::Client.new(
+          options.client_id,
+          options.client_secret,
+          deep_symbolize(client_options)
+        )
       end
 
-      # Token params with X-Api-Key & Origin
-      def token_params
-        token_params = options.token_params.merge(options_for("token"))
-
-        token_params[:headers] ||= {}
-        token_params[:headers]['X-Api-Key'] = options.api_key
-        token_params[:headers]['Origin'] = origin unless options.origin.nil?
-
-        token_params
+      uid do
+        raw_info['membershipId']
       end
 
-      # Get important data
-      uid { raw_info.dig('bungieNetUser', 'membershipId') }
       info do
-        if raw_info['destinyAccounts'].any?
-          destiny = raw_info['destinyAccounts'].first
-          {
-            :membership_id => destiny.dig('userInfo', 'membershipId'),
-            :membership_type => destiny.dig('userInfo', 'membershipType'),
-            :display_name => destiny.dig('userInfo', 'displayName')
-          }
-        else
-          destiny = raw_info['bungieNetUser']
-
-          {
-            :membership_id => destiny['membershipId'],
-            :membership_type => 254,
-            :display_name => destiny['displayName']
-          }
-        end
-      end
-      extra do
         {
-          'raw_info' => raw_info
+          :membership_id => raw_info['membershipId'],
+          :unique_name => raw_info['uniqueName'],
+          :display_name => raw_info['displayName']
         }
       end
+
+      extra { raw_info }
+
       def raw_info
         return @raw_info unless @raw_info.nil?
 
-        @raw_info = access_token.get(
-          '/Platform/User/GetCurrentBungieAccount/',
-          token_params
-        ).parsed
-
-        @raw_info = @raw_info.dig('Response')
+        @raw_info = access_token.get('/Platform/User/GetCurrentBungieNetUser/').parsed
+        @raw_info = (@raw_info['ErrorCode'] == 1) ? @raw_info['Response'] : {}
       end
     end
   end

data/lib/omniauth-bungie-oauth2/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module BungieOauth2
-    VERSION = '0.1.2'
+    VERSION = '1.0'
   end
 end

data/lib/omniauth-bungie-oauth2.rb

@@ -1,9 +1,4 @@
-require 'json'
-require 'faraday'
-require 'faraday_middleware'
-require 'oauth2'
+require 'omniauth-oauth2'
 
-require 'oauth2/bungie_access_token'
-require 'oauth2/bungie_client'
 require 'omniauth-bungie-oauth2/version'
 require 'omniauth/strategies/bungie'

data/omniauth-bungie-oauth2.gemspec

@@ -23,9 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_runtime_dependency 'faraday', '~> 0.9'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 0'
-  spec.add_runtime_dependency 'oauth2', '~> 1.2', '>= 1.2.0'
-  spec.add_runtime_dependency 'omniauth', '~> 1.3', '>= 1.3.1'
   spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.4', '>= 1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-bungie-oauth2
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: '1.0'
 platform: ruby
 authors:
 - Dmitry Ruban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,74 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: oauth2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: omniauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +89,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/oauth2/bungie_access_token.rb
-- lib/oauth2/bungie_client.rb
 - lib/omniauth-bungie-oauth2.rb
 - lib/omniauth-bungie-oauth2/version.rb
 - lib/omniauth/strategies/bungie.rb

data/lib/oauth2/bungie_access_token.rb

@@ -1,19 +0,0 @@
-module OAuth2
-  class BungieAccessToken < AccessToken
-    # Updated refreshing method for a special bungie page
-    def refresh!(params = {})
-      raise('A refresh_token is not available') unless refresh_token
-
-      params[:client_id]     = @client.id
-      params[:client_secret] = @client.secret
-      params[:grant_type]    = 'refresh_token'
-      params[:refresh_token] = refresh_token
-      params[:refreshToken]  = params[:refresh_token]
-
-      new_token = @client.get_token_with_refresh(params)
-      new_token.options = options
-      new_token.refresh_token = refresh_token unless new_token.refresh_token
-      new_token
-    end
-  end
-end

data/lib/oauth2/bungie_client.rb

@@ -1,90 +0,0 @@
-module OAuth2
-  class BungieClient < Client
-    def initialize(client_id, client_secret, options = {}, &block)
-      opts = options.dup
-      @id = client_id
-      @secret = client_secret
-      @site = 'https://www.bungie.net'
-      ssl = opts.delete(:ssl)
-      @options = {
-        :authorize_url     => 'https://www.bungie.net',
-        :token_url         => 'https://www.bungie.net/Platform/App/GetAccessTokensFromCode',
-        :refresh_token_url => 'https://www.bungie.net/Platform/App/GetAccessTokensFromRefreshToken',
-        :token_method      => :post,
-        :connection_opts   => {},
-        :connection_build  => block,
-        :max_redirects     => 5,
-        :raise_errors      => true}.merge(opts)
-      @options[:connection_opts][:ssl] = ssl if ssl
-    end
-
-    def get_token(params, access_token_opts = {}, access_token_class = BungieAccessToken)
-      opts = {:raise_errors => options[:raise_errors], :parse => params.delete(:parse)}
-
-      if options[:token_method] == :post
-        headers = params.delete(:headers)
-        opts[:body] = params
-        opts[:headers] = {'Content-Type' => 'application/json'}
-        opts[:headers].merge!(headers) if headers
-      else
-        opts[:params] = params
-      end
-
-      response = request(options[:token_method], token_url, opts)
-
-      error = Error.new(response)
-
-      response = get_normalized_response(response)
-
-      raise(error) if options[:raise_errors] && (!response.is_a?(Hash) || response['access_token'].nil?)
-
-      access_token_class.from_hash(self, response.merge(access_token_opts))
-    end
-
-    def get_token_with_refresh(params, access_token_opts = {}, access_token_class = BungieAccessToken)
-      opts = {:raise_errors => options[:raise_errors], :parse => params.delete(:parse)}
-
-      if options[:token_method] == :post
-        headers = params.delete(:headers)
-        opts[:body] = params
-        opts[:headers] = {'Content-Type' => 'application/json'}
-        opts[:headers].merge!(headers) if headers
-      else
-        opts[:params] = params
-      end
-
-      response = request(
-        options[:token_method],
-        connection.build_url(options[:refresh_token_url]).to_s,
-        opts
-      )
-
-      error = Error.new(response)
-
-      response = get_normalized_response(response)
-
-      raise(error) if options[:raise_errors] && !(response.is_a?(Hash) && response['access_token'])
-
-      access_token_class.from_hash(self, response.merge(access_token_opts))
-    end
-
-    # Transform response body to RFC specification
-    def get_normalized_response(response)
-      response = response.parsed
-
-      return nil unless response.is_a?(Hash)
-
-      if response['ErrorCode'] == 1 && !response.dig('Response', 'accessToken').nil?
-        {
-          'access_token' => response.dig('Response', 'accessToken', 'value'),
-          'token_type' => 'Bearer',
-          'expires_in' => response.dig('Response', 'accessToken', 'expires'),
-          'refresh_token' => response.dig('Response', 'refreshToken', 'value'),
-          'refresh_expries_in' => response.dig('Response', 'refreshToken', 'expires')
-        }
-      else
-        response
-      end
-    end
-  end
-end