omniauth-eauth-oauth2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6708df6506c52fbb0b3609d5894145a46109f7f
+  data.tar.gz: 0e2244d86bfd0915e930c360160a1d26f4591f14
+SHA512:
+  metadata.gz: 0a8433e77e55e3edac03401d05a64a371419ab7fd744029662b73cfca84a4013923bb5374202eb40e1a6fa9404a56365f57e7a6ece6b5f581c189f1903b5bd77
+  data.tar.gz: 91168966ceae50a30b594f418bbb2ec2333e0485f3f21a044116b660f130eea6fc94753727109a5dc5f2a86fba003e7cc4bc92b8e726d33c8776c8dce88449a6

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,14 @@
+dist: trusty
+
+rvm:
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - jruby-1.7.26
+  - rbx-3
+
+matrix:
+  allow_failures:
+    - rvm: rbx-3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-eauth.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task default: :spec

data/lib/omniauth/eauth_oauth2/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module EauthOauth2
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/eauth_oauth2.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/eauth_oauth2'

data/lib/omniauth/strategies/eauth_oauth2.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class EauthOauth2 < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site => 'https://eauth.pelith.com/',
+        :authorize_url => '/oauth/authorize',
+        :token_url => '/oauth/token'
+      }
+
+      def request_phase
+        super
+      end
+
+      def authorize_params
+        super.tap do |params|
+          %w[scope client_options].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
+
+      uid { raw_info['id'].to_s }
+
+      info do
+        {
+          nickname: raw_info['login'],
+          name: raw_info['name'],
+          username: raw_info['username'],
+          email: raw_info['email']
+        }
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/oauth/user').parsed
+      end
+
+      private
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'eauthoauth2', 'EauthOauth2'

data/lib/omniauth-eauth-oauth2.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/eauth_oauth2'

data/omniauth-eauth-oauth2.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'eauth_oauth2', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Pei-Chen Tsou"]
+  gem.email         = ["pei@pelith.com"]
+  gem.description   = %q{Official OmniAuth strategy for Eauth.}
+  gem.summary       = %q{Official OmniAuth strategy for Eauth.}
+  gem.homepage      = "https://github.com/pelith/omniauth-eauth-oauth2"
+  gem.license       = "MIT"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-eauth-oauth2"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::EauthOauth2::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.5'
+  gem.add_dependency 'omniauth-oauth2', '>= 1.4.0', '< 2.0'
+  gem.add_development_dependency 'rspec', '~> 3.5'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/eauth_oauth2_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::EauthOauth2 do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+
+  subject do
+    args = ['appid', 'secret', @options || {}].compact
+    OmniAuth::Strategies::EauthOauth2.new(*args).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  describe 'client options' do
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://eauth.pelith.com/')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('/oauth/authorize')
+    end
+
+    it 'should have correct token_url' do
+      expect(subject.options.client_options.token_url).to eq('/oauth/token')
+    end
+  end
+
+  describe 'info' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(raw_info_hash)
+    end
+
+    it 'should returns the nickname' do
+      expect(subject.info[:nickname]).to eq(raw_info_hash['screen_name'])
+    end
+
+    it 'should returns the name' do
+      expect(subject.info[:name]).to eq(raw_info_hash['name'])
+    end
+
+    it 'should returns the email' do
+      expect(subject.info[:email]).to eq(raw_info_hash['email'])
+    end
+
+    it 'should returns the location' do
+      expect(subject.info[:location]).to eq(raw_info_hash['location'])
+    end
+
+    it 'should returns the description' do
+      expect(subject.info[:description]).to eq(raw_info_hash['description'])
+    end
+
+    it 'should returns the urls' do
+      expect(subject.info[:urls]['Website']).to eq(raw_info_hash['url'])
+      expect(subject.info[:urls]['Eauth']).to eq("https://demo.pelith.com/#{raw_info_hash['screen_name']}")
+    end
+  end
+
+  describe 'image_size option' do
+    context 'when user has an image' do
+      it 'should return image with size specified' do
+        @options = { :image_size => 'original' }
+        allow(subject).to receive(:raw_info).and_return(
+          { 'profile_image_url' => 'http://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0_normal.png' }
+        )
+        expect(subject.info[:image]).to eq('http://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0.png')
+      end
+
+      it 'should return bigger image when bigger size specified' do
+        @options = { :image_size => 'bigger' }
+        allow(subject).to receive(:raw_info).and_return(
+          { 'profile_image_url' => 'http://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0_normal.png' }
+        )
+        expect(subject.info[:image]).to eq('http://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0_bigger.png')
+      end
+
+      it 'should return secure image with size specified' do
+        @options = { :secure_image_url => 'true', :image_size => 'mini' }
+        allow(subject).to receive(:raw_info).and_return(
+          { 'profile_image_url_https' => 'https://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0_normal.png' }
+        )
+        expect(subject.info[:image]).to eq('https://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0_mini.png')
+      end
+
+      it 'should return normal image by default' do
+        allow(subject).to receive(:raw_info).and_return(
+          { 'profile_image_url' => 'http://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0_normal.png' }
+        )
+        expect(subject.info[:image]).to eq('http://twimg0-a.akamaihd.net/sticky/default_profile_images/default_profile_0_normal.png')
+      end
+    end
+  end
+
+  describe 'skip_info option' do
+    context 'when skip info option is enabled' do
+      it 'should not include raw_info in extras hash' do
+        @options = { :skip_info => true }
+        allow(subject).to receive(:raw_info).and_return({:foo => 'bar'})
+        expect(subject.extra[:raw_info]).to eq(nil)
+      end
+    end
+  end
+
+  describe 'request_phase' do
+    context 'with no request params set and x_auth_access_type specified' do
+      before do
+        allow(subject).to receive(:request).and_return(
+          double('Request', {:params => {'x_auth_access_type' => 'read'}})
+        )
+        allow(subject).to receive(:old_request_phase).and_return(:whatever)
+      end
+
+      it 'should not break' do
+        expect { subject.request_phase }.not_to raise_error
+      end
+    end
+
+    context "with no request params set and use_authorize options provided" do
+      before do
+        @options = { :use_authorize => true }
+        allow(subject).to receive(:request) do
+          double('Request', {:params => {} })
+        end
+        allow(subject).to receive(:old_request_phase) { :whatever }
+      end
+
+      it "should switch authorize_path from authenticate to authorize" do
+        expect { subject.request_phase }.to change { subject.options.client_options.authorize_path }.from('/oauth/authenticate').to('/oauth/authorize')
+      end
+    end
+
+    context 'with a specified callback_url in the params' do
+      before do
+        params = { 'callback_url' => 'http://foo.dev/auth/eauth/foobar' }
+        allow(subject).to receive(:request) do
+          double('Request', :params => params)
+        end
+        allow(subject).to receive(:session) do
+          double('Session', :[] => { 'callback_url' => params['callback_url'] })
+        end
+        allow(subject).to receive(:old_request_phase) { :whatever }
+      end
+
+      it 'should use the callback_url' do
+        expect(subject.callback_url).to eq 'http://foo.dev/auth/eauth/foobar'
+      end
+
+      it 'should return the correct callback_path' do
+        expect(subject.callback_path).to eq '/auth/eauth/foobar'
+      end
+    end
+
+    context 'with no callback_url set' do
+      before do
+        allow(subject).to receive(:request) do
+          double('Request', :params => {})
+        end
+        allow(subject).to receive(:session) do
+          double('Session', :[] => {})
+        end
+        allow(subject).to receive(:old_request_phase) { :whatever }
+        allow(subject).to receive(:old_callback_url).and_return(:old_callback)
+      end
+
+      it 'callback_url should return nil' do
+        expect(subject.callback_url).to eq :old_callback
+      end
+
+      it 'should return the default callback_path value' do
+        expect(subject.callback_path).to eq '/auth/eauth/callback'
+      end
+    end
+
+    context "with no request params set and force_login specified" do
+      before do
+        allow(subject).to receive(:request) do
+          double('Request', {:params => { 'force_login' => true } })
+        end
+        allow(subject).to receive(:old_request_phase) { :whatever }
+      end
+
+      it "should change add force_login=true to authorize_params" do
+        expect { subject.request_phase }.to change {subject.options.authorize_params.force_login}.from(nil).to(true)
+      end
+    end
+  end
+end
+
+private
+
+def raw_info_hash
+  {
+    'screen_name' => 'foo',
+    'name' => 'Foo Bar',
+    'email' => 'foo@example.com',
+    'location' => 'India',
+    'description' => 'Developer',
+    'url' => 'example.com/foobar'
+  }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start do
+  minimum_coverage(94.59)
+end
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-eauth'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-eauth-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pei-Chen Tsou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Official OmniAuth strategy for Eauth.
+email:
+- pei@pelith.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Rakefile
+- lib/omniauth-eauth-oauth2.rb
+- lib/omniauth/eauth_oauth2.rb
+- lib/omniauth/eauth_oauth2/version.rb
+- lib/omniauth/strategies/eauth_oauth2.rb
+- omniauth-eauth-oauth2.gemspec
+- spec/omniauth/strategies/eauth_oauth2_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pelith/omniauth-eauth-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.3
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for Eauth.
+test_files:
+- spec/omniauth/strategies/eauth_oauth2_spec.rb
+- spec/spec_helper.rb