omniauth-yahoojp 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddfcc06cecbd12767a22ba155a343720208b92be
-  data.tar.gz: b7547f8051e0b489208035dc3be0da2146997c63
+  metadata.gz: ca264c63b14fa89691cfe5a8e11f23cde931c0a4
+  data.tar.gz: adf2273ad2d2d2b3af15fd3e2b68503daf9c7d4e
 SHA512:
-  metadata.gz: b7eea18d381216b2cf8ef6d9586b1238157522e47ab10acc99912962a1882a0383e5b9e53e10897efe5c49de4e80f1f44fec222481c4e41a466290eb9a0502a3
-  data.tar.gz: cd81879c9e537cb6ace8e97e716493e559bdf9b485591780a321039232ff7a8acf9ea5775529bcc9ab68370d3621fd4e4e375338127f24712286a1944ee9a0bc
+  metadata.gz: 8acdf1219c6775476415c42f5914e3afc16ab94ad28977c87183a736efafc689a13ec3156075a5a979b9eadbac25f9f4618bcc799a50c3bcf20a5fa458484775
+  data.tar.gz: 3a53191f69d16ff6442d88297630d320e5251b75cced5ff31d7f796cd92b4d059f92933a57ad24baef25a11cf6a2b11c4c0db5cb781eb9b1c3e20f232ee33b71

data/README.md

@@ -1,24 +1,72 @@
 # OmniAuth YahooJp [![Gem Version](https://badge.fury.io/rb/omniauth-yahoojp.svg)](https://badge.fury.io/rb/omniauth-yahoojp)
 
-This is the official OmniAuth strategy for authenticating to Yahoo! JAPAN( [YConnect](http://developer.yahoo.co.jp/yconnect/) ).
-To use it, you'll need to sign up for a YConnect Application ID and Secret
+**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
 
-YConnect API v1 lets you set scopes to provide granular access to different types of data: 
+`OmniAuth::Strategies::YahooJp` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
 
-    use OmniAuth::Builder do
-        provider :yahoojp, ENV['YAHOOJP_KEY'], ENV['YAHOOJP_SECRET'], 
-        {
-            scope: "openid profile email address"
-        }
-    end
+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, :bail parameter to specify behavior of sign-in and permission page.
-More info on [YConnect](http://developer.yahoo.co.jp/yconnect/).
+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: {
+            site: 'https://auth.login.yahoo.co.jp',
+            authorize_url: '/yconnect/v1/authorization',
+            token_url: '/yconnect/v1/token'
+        }
+    }
+end
+```
 
 ## License
 

data/lib/omniauth-yahoojp/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module YahooJp
-    VERSION = "0.1.4"
+    VERSION = "0.2.0"
   end
 end

data/lib/omniauth/strategies/yahoojp.rb

@@ -8,8 +8,8 @@ module OmniAuth
       option :name, 'yahoojp'
       option :client_options, {
         :site => 'https://auth.login.yahoo.co.jp',
-        :authorize_url => '/yconnect/v1/authorization',
-        :token_url => '/yconnect/v1/token',
+        :authorize_url => '/yconnect/v2/authorization',
+        :token_url => '/yconnect/v2/token',
         :auth_scheme => :basic_auth
       }
 
@@ -19,17 +19,27 @@ module OmniAuth
         super
       end
 
-      uid { raw_info['user_id'] }
+      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'],
-          :first_name => raw_info['given_name'],
-          :last_name  => raw_info['family_name'],
-          :urls => {
-            'YahooJp' => raw_info['link'],
-          },
+          :email_verified => raw_info['email_verified'],
+          :address    => raw_info['address'], 
         })
       end
 
@@ -41,7 +51,7 @@ module OmniAuth
 
       def raw_info
         access_token.options[:mode] = :header
-        @raw_info ||= access_token.get('https://userinfo.yahooapis.jp/yconnect/v1/attribute?schema=openid').parsed
+        @raw_info ||= access_token.get('https://userinfo.yahooapis.jp/yconnect/v2/attribute').parsed
       end
 
       def prune!(hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-yahoojp
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - mikanmarusan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth