omniauth-google-oauth2-moses 0.1.10

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree@omniauth-google-oauth2 --create

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :example do
+  gem 'sinatra'
+end

data/README.md

@@ -0,0 +1,15 @@
+# OmniAuth Google OAuth2 Strategy
+
+Strategy to auth with Google via OAuth2 in OmniAuth.
+
+Get your API key at https://code.google.com/apis/console/
+
+## License
+
+Copyright (c) 2011 by Josh Ellithorpe
+
+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,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/config.ru

@@ -0,0 +1,40 @@
+# Sample app for Google OAuth2 Strategy
+# Make sure to setup the ENV variables GOOGLE_KEY and GOOGLE_SECRET
+# Run with "bundle exec rackup"
+
+require 'rubygems'
+require 'bundler'
+require 'sinatra'
+require 'omniauth'
+require 'omniauth-google-oauth2'
+
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+class App < Sinatra::Base
+  get '/' do
+    <<-HTML
+    <ul>
+      <li><a href='/auth/google_oauth2'>Sign in with Google</a></li>
+    </ul>
+    HTML
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
+  
+  get '/auth/failure' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
+end
+
+use Rack::Session::Cookie, :secret => ENV['RACK_COOKIE_SECRET']
+
+use OmniAuth::Builder do
+  provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET'], {
+  }
+end
+
+run App.new

data/examples/omni_auth.rb

@@ -0,0 +1,6 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  # If you don't need a refresh token -- if you're only using Google for account creation/auth and don't need google services -- set the access_type to 'online'.
+  # Also, set the approval prompt to an empty string, since otherwise it will be set to 'force', which makes users manually approve to the Oauth every time they log in.
+  # See http://googleappsdeveloper.blogspot.com/2011/10/upcoming-changes-to-oauth-20-endpoint.html
+  provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET'], {access_type: 'online', approval_prompt: ''}
+end

data/lib/omniauth-google-oauth2.rb

@@ -0,0 +1 @@
+require "omniauth/google_oauth2"

data/lib/omniauth/google_oauth2.rb

@@ -0,0 +1 @@
+require 'omniauth/strategies/google_oauth2'

data/lib/omniauth/google_oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module GoogleOauth2
+    VERSION = "0.1.10"
+  end
+end

data/lib/omniauth/strategies/google_oauth2.rb

@@ -0,0 +1,73 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class GoogleOauth2 < OmniAuth::Strategies::OAuth2
+
+      # Possible scopes: userinfo.email,userinfo.profile,plus.me
+      DEFAULT_SCOPE = "userinfo.email,userinfo.profile"
+
+      option :name, 'google_oauth2'
+      option :authorize_options, [:scope, :approval_prompt, :access_type]
+
+      option :client_options, {
+        :site          => 'https://accounts.google.com',
+        :authorize_url => '/o/oauth2/auth',
+        :token_url     => '/o/oauth2/token'
+      }
+
+      def authorize_params
+        base_scope_url = "https://www.googleapis.com/auth/"
+        super.tap do |params|
+          scopes = (params[:scope] || DEFAULT_SCOPE).split(",")
+          scopes.map! { |s| s =~ /^https?:\/\// ? s : "#{base_scope_url}#{s}" }
+          params[:scope] = scopes.join(' ')
+          # This makes sure we get a refresh_token.
+          # http://googlecode.blogspot.com/2011/10/upcoming-changes-to-oauth-20-endpoint.html
+          params[:access_type] = 'offline' if params[:access_type].nil?
+          params[:approval_prompt] = 'force' if params[:approval_prompt].nil?
+          params[:state] = request.params['state'] if request.params['state']
+        end
+      end
+
+      uid{ raw_info['id'] || verified_email }
+
+      info do
+        prune!({
+          :name       => raw_info['name'],
+          :email      => verified_email,
+          :first_name => raw_info['given_name'],
+          :last_name  => raw_info['family_name'],
+          :image      => raw_info['picture'],
+          :urls => {
+            'Profile' => raw_info['link']
+          }
+        })
+      end
+
+      extra do
+        prune!({
+          'raw_info' => raw_info
+        })
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('https://www.googleapis.com/oauth2/v1/userinfo').parsed
+      end
+
+      private
+
+      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 verified_email
+        raw_info['verified_email'] ? raw_info['email'] : nil
+      end
+
+    end
+  end
+end

data/omniauth-contrib.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth/google_oauth2/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'omniauth', '~> 1.0'
+
+  gem.authors       = ["Josh Ellithorpe", "Yury Korolev", "Moses Hohman"]
+  gem.email         = ["quest@mac.com"]
+  gem.description   = %q{A Google oauth2 strategy for OmniAuth 1.0}
+  gem.summary       = %q{A Google oauth2 strategy for OmniAuth 1.0}
+  gem.homepage      = ""
+
+  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          = "omniauth-google-oauth2-moses"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::GoogleOauth2::VERSION
+
+  gem.add_runtime_dependency 'omniauth-oauth2'
+
+  gem.add_development_dependency 'rspec', '~> 2.6.0'
+  gem.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/google_oauth2_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'omniauth-google-oauth2'
+
+describe OmniAuth::Strategies::GoogleOauth2 do
+  before(:each) do
+    @request = double('Rack::Request')
+    @request.stub(:params) { {} }
+  end
+
+  subject do
+    OmniAuth::Strategies::GoogleOauth2.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct Google site' do
+      subject.client.site.should eq('https://accounts.google.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/o/oauth2/auth')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/o/oauth2/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it "has the correct callback path" do
+      subject.callback_path.should eq('/auth/google_oauth2/callback')
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should expand scope shortcuts' do
+      @options = { :authorize_options => [:scope], :scope => 'userinfo.email'}
+      subject.authorize_params['scope'].should eq('https://www.googleapis.com/auth/userinfo.email')
+    end
+
+    it 'should leave full scopes as is' do
+      @options = { :authorize_options => [:scope], :scope => 'https://www.googleapis.com/auth/userinfo.profile'}
+      subject.authorize_params['scope'].should eq('https://www.googleapis.com/auth/userinfo.profile')
+    end
+
+    it 'should join scopes' do
+      @options = { :authorize_options => [:scope], :scope => 'userinfo.profile,userinfo.email'}
+      subject.authorize_params['scope'].should eq('https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email')
+    end
+
+    it 'should set default scope to userinfo.email,userinfo.profile' do
+      @options = { :authorize_options => [:scope]}
+      subject.authorize_params['scope'].should eq('https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile')
+    end
+
+    it 'should include request.params[:state] when present' do
+      @request.stub(:params) { { 'state' => 'some_state' } }
+      subject.authorize_params[:state].should eq('some_state')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,37 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'http://bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('http://bar')
+      subject.authorize_params['foo'].should eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any token params passed in the :token_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :token_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-google-oauth2-moses
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 10
+  version: 0.1.10
+platform: ruby
+authors: 
+- Josh Ellithorpe
+- Yury Korolev
+- Moses Hohman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: omniauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: omniauth-oauth2
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A Google oauth2 strategy for OmniAuth 1.0
+email: 
+- quest@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- examples/config.ru
+- examples/omni_auth.rb
+- lib/omniauth-google-oauth2.rb
+- lib/omniauth/google_oauth2.rb
+- lib/omniauth/google_oauth2/version.rb
+- lib/omniauth/strategies/google_oauth2.rb
+- omniauth-contrib.gemspec
+- spec/omniauth/strategies/google_oauth2_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A Google oauth2 strategy for OmniAuth 1.0
+test_files: 
+- spec/omniauth/strategies/google_oauth2_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb