omniauth-yahoo_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5e125eca3d64d95d72823a151562846622645f4
+  data.tar.gz: 4d5d29ec9d5fa62f44d84782010b4fa586cf6233
+SHA512:
+  metadata.gz: 62c8543dc77539c152a7d269b5442c813fecfa803877258bd6dcb5c300c73d8fcf19c724dcad09fb54b2da0459782853a3956de00b37f5865f82a0c8ce366caf
+  data.tar.gz: ec13f37df678478f612b5382831e04981a8c9302926a44beb8a715ccaf45402cb69f670de98efa3e761f2edd92c7661f92318a54804411cedaa645e7b3c70e34

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at karan150394@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Karan Pathak
+
+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/README.md

@@ -0,0 +1,182 @@
+# OmniAuth Yahoo OAuth2 Strategy
+
+Yahoo OAuth2 Strategy for OmniAuth. <br>
+Supports OAuth 2.0 client-side flow. Read about it at: https://developer.yahoo.com/oauth2/guide/
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-yahoo_auth'
+```
+
+Then `bundle install`.
+
+## Yahoo App Setup
+* Go to https://developer.yahoo.com/apps/
+* Click on `Create an app`. Give an application name, callback domain and Api Permissions.
+* This gem is tested with an app that had contacts and profiles API enabled with read access.
+* Then hit create app button.
+* Yahoo will now give you your app's id and secret.
+
+## Usage
+
+* Add a route `get 'auth/:provider/callback',  to: 'sessions#custom'` in your routes.rb file
+* Create a sessions controller and a custom method.
+* Add the following in one of your initializer files or create a new one(say config/initializers/omniauth.rb)
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :yahoo_auth, ENV['YAHOO_APP_ID'], ENV['YAHOO_APP_SECRET']
+end
+```
+* You can now restart your server and go to `/auth/yahoo_auth`.
+* Yahoo should now prompt the user to login using yahoo credentials. Enter them and hit login.
+* You should be able to get access to an Auth hash using `env["omniauth.auth"]` inside your session#custom method.
+
+**NOTE**: While developing your application, if you change the scope in the initializer you will need to restart your app server.
+
+## Configuring
+
+You can configure several options, which you pass in to the `provider` method via a `Hash`:
+
+Option name | Default | Explanation
+--- | --- | ---
+`name` | `yahoo_auth` | It can be changed to any value, for example `yahoo`. The OmniAuth URL will thus change to /auth/yahoo .
+`redirect_uri` | `/auth/yahoo/callback` | Specify a custom callback URL used during the server-side flow. Default is `https://www.your_callback_domain/auth/yahoo/callback`
+`image_size` | `192x192` | Set the size for the returned image in the auth hash. Valid options include sizes: 16x16, 24x24, 32x32, 48x48, 64x64, 96x96, 128x128, 192x192
+
+For example:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :yahoo_auth, ENV['YAHOO_APP_ID'], ENV['YAHOO_APP_SECRET'],
+  { name: "yahoo",
+    redirect_uri: "https://www.your_callback_domain/auth/yahoo/callback",
+    image_size: "96x96"}
+end
+```
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  info: {
+    nickname: 'Harvey',
+    email: 'harvey@suits.com',
+    first_name: 'Harvey',
+    last_name: 'Specter',
+    image: 'https://s.yimg.com/wm/modern/images/default_user_profile_pic_192.png',
+  },
+  credentials: {
+    token: 'HnEU9cep1...', # OAuth 2.0 ACCESS_TOKEN.
+    refresh_token: 'AFBTm...', # REFRESH_TOKEN to to get a new OAuth 2.0 access_token when the previous one expires.
+    expires_at: 1503232413, # Time at which your OAuth 2.0 access_token expires.
+    expires: true # this will always be true.
+  },
+  extra: {
+      gender: 'M',
+      language: 'en-IN',
+      location: 'User Location',
+      birth_year: 'User birth year',
+      birth_date: 'User birth date',
+      addresses: 'User addresses',
+      urls: {
+        default_image: 'https://s.yimg.com/wm/modern/images/default_user_profile_pic_192.png',
+        profile: 'http://profile.yahoo.com/KBA...'
+      }
+  }
+}
+```
+
+The precise information available will depend on your request.
+
+## Integration with Devise
+
+First define your application id and secret in `config/initializers/devise.rb`. Do not use the snippet mentioned in the [Usage](https://github.com/creative-karan/omniauth-yahoo_auth#usage) section.
+
+Configuration options can be passed as the last parameter here as key/value pairs.
+
+```ruby
+config.omniauth :yahoo_auth, 'YAHOO_APP_ID', 'YAHOO_APP_SECRET', {}
+```
+
+Then add the following to 'config/routes.rb' so the callback routes are defined.
+
+```ruby
+devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+```
+
+Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+
+```ruby
+devise :omniauthable, omniauth_providers: [:yahoo_auth]
+```
+
+Then make sure your callbacks controller is setup.
+
+```ruby
+# app/controllers/users/omniauth_callbacks_controller.rb
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def yahoo_auth
+      # You need to implement the method below in your model (e.g. app/models/user.rb)
+      @user = User.from_omniauth(request.env['omniauth.auth'])
+
+      if @user.persisted?
+        flash[:notice] = I18n.t 'devise.omniauth_callbacks.success', kind: 'Yahoo'
+        sign_in_and_redirect @user, event: :authentication
+      else
+        session['devise.yahoo_data'] = request.env['omniauth.auth']
+        redirect_to new_user_registration_url, alert: @user.errors.full_messages.join("\n")
+      end
+  end
+end
+```
+
+and bind to or create the user
+
+```ruby
+# app/models/user.rb
+def self.from_omniauth(access_token)
+    data = access_token.info
+    user = User.where(email: data['email']).first
+    # Uncomment the section below if you want users to be created if they don't exist
+    # unless user
+    #     user = User.create(name: data['nickname'],
+    #        email: data['email'],
+    #        password: Devise.friendly_token[0,20]
+    #     )
+    # end
+    user
+end
+```
+
+For your views you can login using:
+
+```erb
+<%= link_to "Sign in with Yahoo", user_yahoo_auth_omniauth_authorize_path %>
+
+<%# Devise prior 4.1.0: %>
+<%= link_to "Sign in with Yahoo", user_omniauth_authorize_path(:yahoo_auth) %>
+```
+
+## Test this gem locally
+Yahoo doesn't allow `localhost or 127.0.0.1` as callback domain while making an app. <br>
+So, you can follow below steps to test this gem on your local environment.
+
+* In case you are using unix or linux system, create a alias like `127.0.0.1 mywebsite.dev` in /etc/hosts
+ (you need have the line which is similar to the one mentioned here in the file)
+* Use http://website.dev/callbackurl/for/app in call back URL during local testing.
+* You will need to run your rails app at port 80.
+* To forcefully run your app on port 80 use `rvmsudo rails s -p 80`
+
+## Further Reading
+* Authorization flow of yahoo is described at : https://developer.yahoo.com/oauth2/guide/flows_authcode/.
+* Yahoo social api documentation : https://developer.yahoo.com/social/rest_api_guide/
+* Overview of devise and OAuth gems working together : https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/creative-karan/omniauth-yahoo_auth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/yahoo_auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth/strategies/yahoo_auth.rb

@@ -0,0 +1,110 @@
+require 'omniauth-oauth2'
+require 'base64'
+
+module OmniAuth
+  module Strategies
+    # Main class for Yahoo Auth Startegy
+    class YahooAuth < OmniAuth::Strategies::OAuth2
+      SOCIAL_API_URL = "https://social.yahooapis.com/v1/user/"
+
+      option :name, "yahoo_auth"
+
+      option :client_options, {
+        site: "https://api.login.yahoo.com",
+        authorize_url: "https://api.login.yahoo.com/oauth2/request_auth",
+        token_url: "https://api.login.yahoo.com/oauth2/get_token"
+      }
+
+      uid { access_token.params['xoauth_yahoo_guid'] }
+
+      info do
+        prune!(
+          nickname: raw_info['nickname'],
+          email: get_primary_email,
+          first_name: raw_info['givenName'],
+          last_name: raw_info['familyName'],
+          image: get_user_image
+        )
+      end
+
+      extra do
+        prune!(
+          gender: raw_info['gender'],
+          language: raw_info['lang'],
+          location: raw_info['location'],
+          birth_year: raw_info['birthYear'],
+          birth_date: raw_info['birthdate'],
+          addresses: raw_info['addresses'],
+          urls: {
+            default_image: raw_info['image']['imageUrl'],
+            profile: raw_info['profileUrl']
+          }
+        )
+      end
+
+      def raw_info
+        # This is a public API and does not need signing or authentication
+        raw_info_url = "#{SOCIAL_API_URL}#{uid}/profile?format=json"
+        @raw_info ||= access_token.get(raw_info_url).parsed['profile'] || {}
+        rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+
+      def custom_build_access_token
+        get_access_token(request)
+      end
+      alias build_access_token custom_build_access_token
+
+      private
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      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 get_primary_email
+        email = nil
+        email_hash = raw_info['emails']
+        if email_hash
+          email_info = email_hash.find{|e| e['primary']} || email_hash.first
+          email = email_info['handle']
+        end
+        email
+      end
+
+      def get_user_image
+        debugger
+        image_size = options[:image_size]
+        if image_size
+          image_url = "#{SOCIAL_API_URL}#{uid}/profile/image/#{image_size}?format=json"
+          image_hash = access_token.get(image_url).parsed["image"] || {}
+          image_hash["imageUrl"]
+        else
+          # Return default image
+          raw_info['image']['imageUrl']
+        end
+      end
+
+      def get_access_token(request)
+        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
+
+    end
+  end
+end

data/lib/omniauth/yahoo_auth.rb

@@ -0,0 +1,8 @@
+require "omniauth/yahoo_auth/version"
+require 'omniauth/strategies/yahoo_auth'
+
+# module Omniauth
+#   module YahooAuth
+#     # Your code goes here...
+#   end
+# end

data/lib/omniauth/yahoo_auth/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module YahooAuth
+    VERSION = "0.1.0"
+  end
+end

data/omniauth-yahoo_auth.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/yahoo_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-yahoo_auth"
+  spec.version       = Omniauth::YahooAuth::VERSION
+  spec.authors       = ["Karan Pathak"]
+  spec.email         = ["karan150394@gmail.com"]
+
+  spec.summary       = "Yahoo OAuth2 Strategy for OmniAuth."
+  spec.description   = "Yahoo OAuth2 Strategy. It lets you sign-in a rails app using yahoo login. Supports OAuth 2.0 client-side flow"
+  spec.homepage      = "https://github.com/creative-karan/omniauth-yahoo_auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-yahoo_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karan Pathak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Yahoo OAuth2 Strategy. It lets you sign-in a rails app using yahoo login.
+  Supports OAuth 2.0 client-side flow
+email:
+- karan150394@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth/strategies/yahoo_auth.rb
+- lib/omniauth/yahoo_auth.rb
+- lib/omniauth/yahoo_auth/version.rb
+- omniauth-yahoo_auth.gemspec
+homepage: https://github.com/creative-karan/omniauth-yahoo_auth
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Yahoo OAuth2 Strategy for OmniAuth.
+test_files: []