nov-omniauth-yahoojp 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b91f04e35715a3cc7068cd91f13fdb24361cf51a06f03596398e2cc87c96f99d
+  data.tar.gz: c9df9a1fd79972d67507b75c4565b73f390c3c4dc72ed141841a71518cb3783e
+SHA512:
+  metadata.gz: e1def1da09813381b81e65fbc588681686dfd0f12c01b60b0fb29df72f29240e77344f2576dcab86922f12683a698c1ec23dc6a9db696d78b6cd248a6f1da613
+  data.tar.gz: a6bf7593a907840dc712fc43db46039efd534f4b210d8ca7ea6b5ef4eea4c507e0b99377a7f2d8cb1b1c2e0825ccc7e1c6ea484b14877b0d9cfb2ec7da1e8e71

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+/pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-yahoojp.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('omniauth-yahoojp.gemspec')
+end

data/README.md

@@ -0,0 +1,78 @@
+# OmniAuth YahooJp [![Gem Version](https://badge.fury.io/rb/omniauth-yahoojp.svg)](https://badge.fury.io/rb/omniauth-yahoojp)
+
+**These notes are based on master, please see tags for README pertaining to specific releases.**
+
+This is the official OmniAuth strategy for authenticating to Yahoo! JAPAN( [YConnect](http://developer.yahoo.co.jp/yconnect/v2/) ).
+To use it, you'll need to sign up for a YConnect Client ID and Secret
+on the [Yahoo! JAPAN Developer Network](https://e.developer.yahoo.co.jp/dashboard/).
+
+Supports OAuth 2.0 Authorization Code flows. Read the Yahoo!JAPAN docs for more details: https://developer.yahoo.co.jp/yconnect/v2/
+
+## Installing
+
+Add to your `Gemfile`: 
+
+```ruby
+gem 'omniauth-yahoojp'
+```
+
+Then `bundle install`.
+
+## Basic Usage
+
+`OmniAuth::Strategies::YahooJp` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
+
+YConnect API v2 lets you set scopes to provide granular access to different types of data: 
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :yahoojp, ENV['YAHOOJP_KEY'], ENV['YAHOOJP_SECRET'], 
+    {
+        scope: "openid profile email address"
+    }
+end
+```
+
+## Advanced Parameters
+
+You can also set :display, :prompt, :scope, :bail parameter to specify behavior of sign-in and permission page.
+More info on [YConnect](http://developer.yahoo.co.jp/yconnect/v2/).
+
+For example, to request `openid`, `profile`,  and `email` permissions and display the authentication page in a popup window:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :yahoojp, ENV['YAHOOJP_KEY'], ENV['YAHOOJP_SECRET'], 
+    {
+        scope: "openid profile email",
+        display: "popup"
+    }
+end
+```
+
+### API Version
+
+OmniAuth YahooJp uses versioned API endpoints by default (current v2). You can configure a different version via `client_options` hash passed to `provider`, specifically you should change the version in the `site` and `authorize_url` parameters. For example, to change to v1:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :yahoojp, ENV['YAHOOJP_KEY'], ENV['YAHOOJP_SECRET'], 
+    {
+        scope: "openid profile email address",
+        client_options: {
+            authorize_url: '/yconnect/v1/authorization',
+            token_url: '/yconnect/v1/token'
+        }
+    }
+end
+```
+
+## License
+
+Copyright (c) 2013 by mikanmarusan
+
+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/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/lib/omniauth/strategies/yahoojp.rb

@@ -0,0 +1,101 @@
+require 'omniauth-oauth2'
+require 'httpauth'
+require 'json/jwt'
+
+module OmniAuth
+  module Strategies
+    class YahooJp < OmniAuth::Strategies::OAuth2
+
+      option :name, 'yahoojp'
+      option :client_options, {
+        :site => 'https://auth.login.yahoo.co.jp',
+        :authorize_url => '/yconnect/v2/authorization',
+        :token_url => '/yconnect/v2/token',
+        :auth_scheme => :basic_auth,
+        :userinfo_url => 'https://userinfo.yahooapis.jp/yconnect/v2/attribute'
+      }
+      option :authorize_options, [:display, :prompt, :scope, :bail]
+      option :userinfo_access, true
+
+      def request_phase
+        super
+      end
+
+      uid { raw_info['sub'] }
+
+      info do
+        prune!({
+          :sub        => raw_info['sub'],
+          :name       => raw_info['name'],
+          :given_name => raw_info['given_name'],
+          :given_name_ja_kana_jp => raw_info['given_name#ja-Kana-JP'],
+          :given_name_ja_hani_jp => raw_info['given_name#ja-Hani-JP'],
+          :family_name => raw_info['family_name'],
+          :family_name_ja_kana_jp => raw_info['family_name#ja-Kana-JP'],
+          :family_name_ja_hani_jp => raw_info['family_name#ja-Hani-JP'],
+          :gender     => raw_info['gender'],
+          :zoneinfo   => raw_info['zoneinfo'],
+          :locale     => raw_info['locale'],
+          :birthdate  => raw_info['birthdate'],
+          :nickname   => raw_info['nickname'],
+          :picture    => raw_info['picture'],
+          :email      => raw_info['email'],
+          :email_verified => raw_info['email_verified'],
+          :address    => raw_info['address'],
+        })
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info unless skip_info?
+        prune! hash
+      end
+
+      def raw_info
+        @raw_info ||= if options.userinfo_access
+          access_token.options[:mode] = :header
+          access_token.get(options.client_options.userinfo_url).parsed
+        elsif id_token
+          id_token_claims.slice(:sub).merge(
+            id_token: id_token,
+            id_token_claims: id_token_claims,
+          )
+        else
+          {}
+        end
+      end
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+
+      def build_access_token
+        token_params = {
+          :code => request.params['code'],
+          :redirect_uri => callback_url,
+          :grant_type => 'authorization_code',
+          :headers => {'Authorization' => HTTPAuth::Basic.pack_authorization(client.id, client.secret)}
+        }
+
+        client.get_token(token_params);
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def id_token
+        access_token&.params&.dig('id_token')
+      end
+
+      def id_token_claims
+        JSON::JWT.decode(id_token, :skip_verification)
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'yahoojp', 'YahooJp'

data/lib/omniauth-yahoojp/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module YahooJp
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth-yahoojp.rb

@@ -0,0 +1,2 @@
+require "omniauth-yahoojp/version"
+require 'omniauth/strategies/yahoojp'

data/omniauth-yahoojp.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-yahoojp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["nov"]
+  gem.email         = ["nov@matake.jp"]
+  gem.description   = %q{Fork of Official OmniAuth strategy for Yahoo! JAPAN.}
+  gem.summary       = %q{Fork of Official OmniAuth strategy for Yahoo! JAPAN.}
+  gem.homepage      = "https://github.com/nov/omniauth-yahoojp"
+
+  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          = "nov-omniauth-yahoojp"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::YahooJp::VERSION
+  gem.licenses      = "MIT"
+
+  gem.add_dependency 'omniauth', '>= 1.0'
+  gem.add_dependency 'omniauth-oauth2', '>= 1.1'
+  gem.add_dependency 'httpauth'
+  gem.add_dependency 'json-jwt'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/yahoojp_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'omniauth-yahoojp'
+
+describe OmniAuth::Strategies::YahooJp do
+  let(:strategy) { described_class.new(app, options) }
+  let(:options) { {} }
+  let(:app) { nil }
+
+  describe "client options" do
+    subject { strategy.options.client_options }
+
+    its(:site) do
+      should eq "https://auth.login.yahoo.co.jp"
+    end
+
+    its(:authorize_url) do
+      should eq '/yconnect/v2/authorization'
+    end
+
+    its(:token_url) do
+      should eq '/yconnect/v2/token'
+    end
+
+    its(:userinfo_url) do
+      should eq 'https://userinfo.yahooapis.jp/yconnect/v2/attribute'
+    end
+  end
+
+  describe 'userinfo access' do
+    subject { strategy.options.userinfo_access }
+
+    context 'as default' do
+      it { should be_truthy }
+    end
+
+    context 'when disabled' do
+      let(:options) do
+        {userinfo_access: false}
+      end
+      it { should be_falsy }
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: nov-omniauth-yahoojp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- nov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: httpauth
+  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: json-jwt
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: 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: Fork of Official OmniAuth strategy for Yahoo! JAPAN.
+email:
+- nov@matake.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/omniauth-yahoojp.rb
+- lib/omniauth-yahoojp/version.rb
+- lib/omniauth/strategies/yahoojp.rb
+- omniauth-yahoojp.gemspec
+- spec/omniauth/strategies/yahoojp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nov/omniauth-yahoojp
+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.4.10
+signing_key:
+specification_version: 4
+summary: Fork of Official OmniAuth strategy for Yahoo! JAPAN.
+test_files:
+- spec/omniauth/strategies/yahoojp_spec.rb
+- spec/spec_helper.rb