omniauth-bungie-oauth2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 902e8466e478598129f2cfaddf9be23a7c208ae9
+  data.tar.gz: 3dd6a9d0b761309041f052b6d6a51019c37891e3
+SHA512:
+  metadata.gz: d622358e21d6ea2cdc0c250cc78f0202f2ac399cd369baa4bc8e83d09b7cc31f28172001b09645ec8436d7745e706a60c5047a136b1301ef970647d3d096529a
+  data.tar.gz: 6a8b7d04d85dfc5fd84e6d02705588337b8c911d7393a8925bb2e89e9c6a3a7826ae5fff625705a564af47927144da973b47d40259a4de971fb2bc24c30ba343

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dkruban@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitry Ruban
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Omniauth::Bungie::Oauth2
+
+A Bungie OAuth2 strategy for Omniauth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-bungie-oauth2'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+For full usage this gem You must create an application on [Bungie.net](https://www.bungie.net/en/application).
+
+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`:
+
+~~~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
+~~~~
+
+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;
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RuBAN-GT/omniauth-bungie-oauth2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Fireteam
+
+If you want to fight with Oryx with me or create any interesting applications for Destiny, you can add me ([https://www.bungie.net/en/Profile/254/12488384](https://www.bungie.net/en/Profile/254/12488384)).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/oauth2/bungie_access_token.rb

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,90 @@
+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'])
+
+      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

data/lib/omniauth-bungie-oauth2.rb

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

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

@@ -0,0 +1,5 @@
+module Omniauth
+  module BungieOauth2
+    VERSION = '0.1.0'
+  end
+end

data/lib/omniauth/strategies/bungie.rb

@@ -0,0 +1,102 @@
+require 'omniauth'
+require 'omniauth-oauth2'
+require 'socket'
+require 'timeout'
+
+module OmniAuth
+  module Strategies
+    class Bungie < OmniAuth::Strategies::OAuth2
+      # Arguments
+      args [:api_key, :auth_url]
+
+      # 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
+
+      # 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
+          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
+
+      #  Defining of Origin string
+      def origin
+        if options.origin === true
+          request.base_url
+        elsif options.origin.is_a? String
+          options.origin
+        else
+          ''
+        end
+      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
+      end
+
+      # Get important data
+      uid { raw_info.dig('bungieNetUser', 'membershipId') }
+      info do
+        destiny = raw_info['destinyAccounts']&.first
+
+        {
+          :membership_id => destiny.dig('userInfo', 'membershipId'),
+          :membership_type => destiny.dig('userInfo', 'membershipType'),
+          :display_name => destiny.dig('userInfo', 'displayName')
+        } unless destiny.nil?
+      end
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+      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')
+      end
+    end
+  end
+end

data/omniauth-bungie-oauth2.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-bungie-oauth2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-bungie-oauth2'
+  spec.version       = Omniauth::BungieOauth2::VERSION
+  spec.authors       = ['Dmitry Ruban']
+  spec.email         = ['dkruban@gmail.com']
+
+  spec.summary       = %q{A Bungie OAuth2 strategy for Omniauth}
+  spec.description   = %q{A Bungie OAuth2 strategy for Omniauth}
+  spec.homepage      = 'https://github.com/RuBAN-GT/omniauth-bungie-oauth2'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  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

data/spec/omniauth/strategies/bungie_oauth2_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'omniauth-bungie-oauth2'
+
+describe Omniauth::Strategies::Bungie do
+  it "has a version number" do
+    expect(Omniauth::BungieOauth2::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.join('bundler', 'setup')
+require 'rspec'

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-bungie-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Ruban
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: A Bungie OAuth2 strategy for Omniauth
+email:
+- dkruban@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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
+- omniauth-bungie-oauth2.gemspec
+- spec/omniauth/strategies/bungie_oauth2_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/RuBAN-GT/omniauth-bungie-oauth2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A Bungie OAuth2 strategy for Omniauth
+test_files: []