omniauth-oauth2-line 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb70abf402713d2b97848573c761074646b82eb3b19d8d9738d83539fe1cef1c
+  data.tar.gz: c77f372a56ad532e402604627b3b15ebcee6535ddf2455a993ccc0a982b40963
+SHA512:
+  metadata.gz: 617145f360f2248a2b0d6c3d8f8bcbeeaf12f7a8e6626d6d73ec9350c9e671a7dcdea2358cfa8e990a766bf0c78facef94755938255317622df593746d2a5244
+  data.tar.gz: ef323f760a62556b392daa2f5d3763b7897e3489d8d7d1dbed3a5eb07e9a1ead333bc97736c18157e26e6a5ce324769e12fbc167c4f6d6a6833abb2fa0bc25e6

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'rspec', '~> 3.2'
+  gem 'rack-test'
+  gem 'simplecov'
+  gem 'webmock'
+end

data/README.md

@@ -0,0 +1,49 @@
+# OmniAuth Line
+
+This gem contains the Line OAuth2 Strategy for OmniAuth.
+
+Supports the OpenID Connect Web Login. Read the Line developers docs for more details: https://developers.line.me/en/docs/line-login/web/integrate-line-login/
+
+## Using This Strategy
+
+First start by adding this gem to your Gemfile:
+
+```ruby
+gem 'omniauth-oauth2-line' 
+```
+
+Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
+
+```ruby
+# PROFILE permission required!!
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider  :line_oauth2, "Channel_ID", "Channel_Secret"
+end
+```
+
+## Authentication Hash
+An example auth hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => "line",
+  :uid => "a123b4....",
+  :info => {
+    :name => "yamada tarou",
+    :image => "http://dl.profile.line.naver.jp/xxxxx",
+    :description => "breakfast now.",
+    :email => "foo@bar.com"
+  },
+  :credentials => {
+    :token => "a1b2c3d4...", # The OAuth 2.0 access token
+    :secret => "abcdef1234"
+  },
+  :extra => {
+    # nil
+  }
+}
+```
+
+## Supported Rubies
+
+OmniAuth Line is tested under 2.4.x 

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/omniauth-oauth2-line.rb

@@ -0,0 +1,2 @@
+require "omniauth-oauth2-line/version"
+require 'omniauth/strategies/oauth2_line'

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

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Oauth2Line
+    VERSION = "0.0.7"
+  end
+end

data/lib/omniauth/strategies/oauth2_line.rb

@@ -0,0 +1,91 @@
+require 'omniauth-oauth2'
+require 'json'
+
+module OmniAuth
+  module Strategies
+    class LineOauth2 < OmniAuth::Strategies::OAuth2
+      option :name, 'line_oauth2'
+      option :scope, 'profile openid email'
+
+      option :client_options, {
+        site: 'https://access.line.me',
+        authorize_url: '/oauth2/v2.1/authorize',
+        token_url: '/oauth2/v2.1/token'
+      }
+      
+      def callback_url
+        if options.authorization_code_from_signed_request_in_cookie
+          ''
+        else
+          # Fixes regression in omniauth-oauth2 v1.4.0 by https://github.com/intridea/omniauth-oauth2/commit/85fdbe117c2a4400d001a6368cc359d88f40abc7
+          options[:callback_url] || (full_host + script_name + callback_path)
+        end
+      end
+      # host changed
+      def callback_phase  
+        options[:client_options][:site] = 'https://api.line.me'
+        super
+      end
+     
+      uid { raw_info['userId'] }
+  
+      info do
+        {
+          name:        raw_info['displayName'],
+          image:       raw_info['pictureUrl'],
+          description: raw_info['statusMessage'],
+          email:  email_from_id_token
+        }
+      end
+     
+      def email_from_id_token
+        if !options[:skip_jwt] && !access_token['id_token'].nil?
+          decoded = ::JWT.decode(access_token['id_token'], nil, false).first
+          payload_decoded = base64url_decode(access_token['id_token'].split(".")[1])
+          #Rails.logger.info  "JWT decode payload =>" + payload_decoded.to_s
+          email = payload_decoded['email']
+          # We have to manually verify the claims because the third parameter to
+          # JWT.decode is false since no verification key is provided.
+          ::JWT::Verify.verify_claims(decoded,
+                                      verify_iss: true,
+                                      iss: 'https://access.line.me',
+                                      verify_aud: true,
+                                      aud: options.client_id,
+                                      verify_sub: false,
+                                 #     verify_expiration: true,
+                                      verify_not_before: true,
+                                      verify_iat: true,
+                                      verify_jti: false,
+                                      leeway: options[:jwt_leeway])    
+         end    
+        return email
+     end
+      
+     
+     def base64url_decode(target)
+        rem = (target.length) % 4
+        if (rem > 0)
+         target += '=' * (4 - rem)
+        end
+        return JSON.load(Base64.urlsafe_decode64(target))
+
+     end     
+     
+     def prune!(hash)
+        hash.delete_if do |_, v|
+          prune!(v) if v.is_a?(Hash)
+          v.nil? || (v.respond_to?(:empty?) && v.empty?)
+        end
+      end 
+      
+
+      # Require: Access token with PROFILE permission issued.
+      def raw_info
+        @raw_info ||= JSON.load(access_token.get('v2/profile').body)
+      rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+
+    end
+  end
+end

data/omniauth-oauth2-line.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-oauth2-line/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-oauth2-line"
+  s.version     = OmniAuth::Oauth2Line::VERSION
+  s.authors     = ["TC Juan"]
+  s.email       = ["tcjuan@gmail.com"]
+  s.homepage    = "https://github.com/tcjuan/omniauth-oauth2-line"
+  s.description = %q{OmniAuth strategy for ominauth-oauth2 1.6 for Line}
+  s.summary     = s.description
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'json', '~> 1.3'
+  s.add_dependency 'omniauth-oauth2', '~>1.6'
+  s.add_development_dependency 'bundler', '~> 1.0'
+
+end

data/spec/omniauth/strategies/line_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Line do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+
+  subject do
+    args = ['channel_id', 'secret', @options || {}].compact
+    OmniAuth::Strategies::Line.new(*args).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  describe 'client options' do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq('line')
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://access.line.me')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('/oauth2/v2.1/authorize')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('/oauth2/v2.1/token')
+    end
+  end
+
+  describe 'uid' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(raw_info_hash)
+    end
+
+    it 'should returns the uid' do
+      expect(subject.uid).to eq(raw_info_hash['mid'])
+    end
+  end
+
+  describe 'info' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(raw_info_hash)
+    end
+
+    it 'should returns the name' do
+      expect(subject.info[:name]).to eq(raw_info_hash['displayName'])
+    end
+
+    it 'should returns the image' do
+      expect(subject.info[:image]).to eq(raw_info_hash['pictureUrl'])
+    end
+
+    it 'should returns the description' do
+      expect(subject.info[:description]).to eq(raw_info_hash['statusMessage'])
+    end
+  end
+
+  describe 'request_phase' do
+    context 'with no request params set' do
+      before do
+        allow(subject).to receive(:request).and_return(
+          double('Request', {:params => {}})
+        )
+        allow(subject).to receive(:request_phase).and_return(:whatever)
+      end
+
+      it 'should not break' do
+        expect { subject.request_phase }.not_to raise_error
+      end
+    end
+  end
+
+end
+
+private
+
+def raw_info_hash
+  {
+    'uid'           => 'hoge',
+    'displayName'   => 'Foo Bar',
+    'pictureUrl'    => 'http://xxx.com/aaa.jpg',
+    'statusMessage' => 'Developer'
+  }
+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(75.00)
+end
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-line'
+
+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,96 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-oauth2-line
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- TC Juan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: OmniAuth strategy for ominauth-oauth2 1.6 for Line
+email:
+- tcjuan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-oauth2-line.rb
+- lib/omniauth-oauth2-line/version.rb
+- lib/omniauth/strategies/oauth2_line.rb
+- omniauth-oauth2-line.gemspec
+- spec/omniauth/strategies/line_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tcjuan/omniauth-oauth2-line
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for ominauth-oauth2 1.6 for Line
+test_files:
+- spec/omniauth/strategies/line_spec.rb
+- spec/spec_helper.rb