omniauth-line-messenger 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79f8458cb7c4306e51a7cbfdc32ec4c30eb266fea5d622b2a32eb9eef3900e43
+  data.tar.gz: 99e30e6dff57b2ecc094a920270ce98ea6dc6ffc8b96255efd0bed7f077cdd7e
+SHA512:
+  metadata.gz: 8339b116425c105f62bc2bd1c93a33ec6487885480972542fbe2de3634002cfaa144c253e8fd3d7e76693fdc8b23482353188485521b60e630120a814c629d1c
+  data.tar.gz: 92da81f4da46e4ed6d0d268af1af6a7135674f6fef1c71f72432dca71a6be0f6ae047a3a400aecaf58f7022b018513fb62e99ccffe84cb26d98315cb431beaeb

data/.gitignore

@@ -0,0 +1,3 @@
+/coverage
+/coverage/*
+*.DS_Store

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/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    omniauth-line-messenger (0.2.0)
+      json (>= 2.3.0)
+      omniauth-oauth2 (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.1.1)
+    hashie (5.0.0)
+    json (2.7.2)
+    jwt (2.9.0)
+      base64
+    multi_xml (0.6.0)
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    omniauth (2.1.2)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
+    public_suffix (5.1.1)
+    rack (3.1.7)
+    rack-protection (3.0.6)
+      rack
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rake (13.2.1)
+    rexml (3.3.7)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    version_gem (1.1.4)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  omniauth-line-messenger!
+  rack-test
+  rake
+  rspec (~> 3.2)
+  simplecov
+  webmock
+
+BUNDLED WITH
+   2.4.22

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-line-messenger'
+```
+
+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_messenger, "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.1.x, 2.2.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/strategies/line_messenger.rb

@@ -0,0 +1,54 @@
+require 'omniauth-oauth2'
+require 'json'
+
+module OmniAuth
+  module Strategies
+    class LineMessenger < OmniAuth::Strategies::OAuth2
+      option :name, 'line_messenger'
+      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'
+      }
+
+      # host changed
+      def callback_phase
+        options[:client_options][:site] = 'https://api.line.me'
+        super
+      end
+
+      def callback_url
+        # 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
+
+      uid { raw_info['userId'] }
+
+      info do
+        {
+          name:        raw_info['displayName'],
+          image:       raw_info['pictureUrl'],
+          description: raw_info['statusMessage'],
+          email:       fetch_email
+          # email:       JWT.decode(access_token.params['id_token'], options['client_secret']).first&.dig('email')
+        }
+      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
+
+      def fetch_email
+        data = JSON.load(access_token.post('oauth2/v2.1/verify', params: { id_token: access_token.params['id_token'], client_id: options['client_id'] }).body)
+        data['email']
+      rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module OmniAuth
+  module LineMessenger
+    VERSION = "0.2.0"
+  end
+end

data/lib/omniauth-line-messenger.rb

@@ -0,0 +1,2 @@
+require "omniauth-line-messenger/version"
+require 'omniauth/strategies/line_messenger'

data/omniauth-line-messenger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-line-messenger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-line-messenger"
+  s.version     = OmniAuth::LineMessenger::VERSION
+  s.authors     = ["kazasiki", "marsz"]
+  s.email       = ["marsz330@gmail.com"]
+  s.homepage    = "https://github.com/marsz/omniauth-line-messenger"
+  s.description = %q{OmniAuth strategy 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', '>= 2.3.0'
+  s.add_dependency 'omniauth-oauth2', '~>1.3'
+  s.add_development_dependency 'bundler', '~> 2.0'
+end

data/spec/omniauth/strategies/line_messenger_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::LineMessenger do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+
+  subject do
+    args = ['channel_id', 'secret', @options || {}].compact
+    OmniAuth::Strategies::LineMessenger.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_messenger')
+    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)
+      allow(subject).to receive(:fetch_email).and_return('foo@bar.com')
+    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)
+      allow(subject).to receive(:fetch_email).and_return('foo@bar.com')
+    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-messenger'
+
+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,99 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-line-messenger
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- kazasiki
+- marsz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: OmniAuth strategy for Line
+email:
+- marsz330@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/omniauth-line-messenger.rb
+- lib/omniauth-line-messenger/version.rb
+- lib/omniauth/strategies/line_messenger.rb
+- omniauth-line-messenger.gemspec
+- spec/omniauth/strategies/line_messenger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/marsz/omniauth-line-messenger
+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.1.6
+signing_key:
+specification_version: 4
+summary: OmniAuth strategy for Line
+test_files:
+- spec/omniauth/strategies/line_messenger_spec.rb
+- spec/spec_helper.rb