omniauth-yahoo-oauth2 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 784ac84ce174a7e01cc6ff2093f87258edaffa52
+  data.tar.gz: 6383b98740bbac0c5b93787bb869306c828710de
+SHA512:
+  metadata.gz: 499b6375e10ac27c860f80ae59e77b21aefb0a0958e6936355207f8d85fa79637b4ab6abe3145d5020f57b80be08213ffece4369f24e3f0647500508877d0204
+  data.tar.gz: 1d635f2e19db108e51d11f0303da8f0852212064aa1e3cd31a4eb1ff0f6ed589313beac37c5f69c253bafcd3b226aaf5388bab1b02ea0fe147442b1886c1c1db

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+## omniauth-yahoo-oauth2 ##
+
+An unofficial, hastily-written Oauth2 OmniAuth strategy for Yahoo. Uses the authorization flow described at https://developer.yahoo.com/oauth2/guide/flows_authcode/.
+
+Built using https://github.com/intridea/omniauth-oauth2.
+
+## Setup ##
+`gem install omniauth-yahoo-oauth2`
+
+Create an app at https://developer.yahoo.com/apps to get a Yahoo client ID and secret.
+
+## Usage ##
+```ruby
+# In an initializer
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :yahoo_oauth2, yahoo_client_id, yahoo_secret,
+    name: 'yahoo'
+end
+```
+
+See https://github.com/intridea/omniauth for Omniauth instructions.
+
+## Notes ##
+OmniAuth doesn't currently have built-in support for Basic Authentication for retrieving OAuth tokens, so `YahooOauth2#build_access_token` handles this inline.
+
+Yahoo returns an access_token, a refresh_token, and an expiration time for the access_token. They are available in the authentication hash in the callback:
+
+```ruby
+auth_info = request.env['omniauth.auth']
+access_token = auth_info[:credentials][:token]
+refresh_token = auth_info[:credentials][:refresh_token]
+expires_at = auth_info[:credentials][:expires_at]
+```
+
+You can use the refresh_token to generate new access tokens:
+
+```ruby
+require 'oauth2'
+require 'base64'
+
+oauth_client = OAuth2::Client.new(YAHOO_CLIENT_ID, YAHOO_SECRET, {
+  site: 'https://api.login.yahoo.com',
+  authorize_url: '/oauth2/request_auth',
+  token_url: '/oauth2/get_token',
+})
+
+auth = "Basic #{Base64.strict_encode64("#{YAHOO_CLIENT_ID}:#{YAHOO_SECRET}")}"
+
+new_token = oauth_client.get_token({
+  redirect_uri: YOUR_CALLBACK_URL,
+  refresh_token: YOUR_REFRESH_TOKEN,
+  grant_type: 'refresh_token',
+  headers: { 'Authorization' => auth } })
+```
+
+## TODO ##
+- Handle failure cases. (https://developer.yahoo.com/oauth2/guide/errors/)
+- Test something. Anything.

data/lib/omniauth-yahoo-oauth2.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'yahoo_oauth2')

data/lib/omniauth/strategies/yahoo_oauth2.rb

@@ -0,0 +1,49 @@
+require 'omniauth/strategies/oauth2'
+require 'base64'
+
+module OmniAuth
+  module Strategies
+    class YahooOauth2 < OmniAuth::Strategies::OAuth2
+      option :name, 'yahoo_oauth2'
+      
+      option :client_options, {
+        site: 'https://api.login.yahoo.com',
+        authorize_url: '/oauth2/request_auth',
+        token_url: '/oauth2/get_token',
+      }
+
+      uid { access_token.params['xoauth_yahoo_guid'] }
+
+      info do
+        {
+          name: raw_info['profile']['nickname'],
+          nickname: raw_info['profile']['nickname'],
+          gender: raw_info['profile']['gender'],
+          language: raw_info['profile']['lang'],
+          location: raw_info['profile']['location'],
+          urls: {
+            image: raw_info['profile']['image']['imageUrl'],
+            profile: raw_info['profile']['profileUrl']
+          }
+        }
+      end
+
+      def build_access_token
+        verifier = request.params['code']
+        
+        auth = "Basic #{Base64.strict_encode64("#{options.client_id}:#{options.client_secret}")}"
+        
+        token = client.get_token(
+          { redirect_uri: callback_url, code: verifier, grant_type: 'authorization_code', headers: { 'Authorization' => auth } }.
+          merge(token_params.to_hash(symbolize_keys: true)), deep_symbolize(options.auth_token_params))
+        
+        token
+      end
+      
+      def raw_info
+        raw_info_url = "https://social.yahooapis.com/v1/user/#{uid}/profile?format=json"
+        @raw_info ||= access_token.get(raw_info_url).parsed
+      end
+    end
+  end
+end

data/lib/omniauth/yahoo_oauth2.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'strategies', 'yahoo_oauth2')

data/lib/omniauth/yahoo_oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module YahooOauth2
+    VERSION = '1.1.0'
+  end
+end

data/omniauth-yahoo-oauth2.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path(File.join('..', 'lib', 'omniauth', 'yahoo_oauth2', 'version'), __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_runtime_dependency 'omniauth', '~> 1.1'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+  gem.add_development_dependency 'bundler', '~> 1.0'
+
+  gem.authors       = ['Amir Manji']
+  gem.email         = ['amanji75@gmail.com']
+  gem.description   = 'A Yahoo OAuth2 strategy for OmniAuth.'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/amirmanji/omniauth-yahoo-oauth2'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.name          = 'omniauth-yahoo-oauth2'
+  gem.require_paths = ['lib']
+  gem.version       = OmniAuth::YahooOauth2::VERSION
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-yahoo-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Amir Manji
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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: 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: 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: A Yahoo OAuth2 strategy for OmniAuth.
+email:
+- amanji75@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/omniauth-yahoo-oauth2.rb
+- lib/omniauth/strategies/yahoo_oauth2.rb
+- lib/omniauth/yahoo_oauth2.rb
+- lib/omniauth/yahoo_oauth2/version.rb
+- omniauth-yahoo-oauth2.gemspec
+homepage: https://github.com/amirmanji/omniauth-yahoo-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.2.2
+signing_key: 
+specification_version: 4
+summary: A Yahoo OAuth2 strategy for OmniAuth.
+test_files: []