omniauth-allied_modders 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.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
+.idea/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@omniauth-allied-modders --create

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+# OmniAuth AlliedModders Strategy
+
+Strategy to auth with AlliedModders via OAuth2 in OmniAuth.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem "omniauth-allied_modders"
+```
+
+Then `bundle install`.
+
+## Usage
+
+Add the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :allied_modders, "CLIENT_ID", "CLIENT_SECRET"
+end
+```
+
+Auth Url is: /auth/allied_modders
+
+## Thanks
+
+This was written by Josh Ellithorpe. I merely made some edits to the original Google-OAuth2 strategy.
+
+## License
+
+Copyright (c) 2012 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,43 @@
+# 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-allied-modders'
+
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+class App < Sinatra::Base
+  get '/' do
+    <<-HTML
+    <ul>
+      <li><a href='/auth/allied_modders'>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
+  # Regular usage
+  provider :allied_modders, ENV['ALLIEDMODDERS_CLIENT_ID'], ENV['ALLIEDMODDERS_SECRET'], {}
+  
+  # Custom scope supporting youtube
+  # provider :google_oauth2, ENV['GOOGLE_KEY'], ENV['GOOGLE_SECRET'], {:scope => 'http://gdata.youtube.com,userinfo.email,userinfo.profile,plus.me', :access_type => 'online', :approval_prompt => ''}
+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 :allied_modders, ENV['ALLIEDMODDERS_CLIENT_ID'], ENV['ALLIEDMODDERS_SECRET'], {access_type: 'online', approval_prompt: ''}
+end

data/lib/omniauth-allied_modders.rb

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

data/lib/omniauth/allied_modders.rb

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

data/lib/omniauth/allied_modders/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module AlliedModders
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/strategies/allied_modders.rb

@@ -0,0 +1,77 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class AlliedModders < OmniAuth::Strategies::OAuth2
+
+      # Possible scopes: userinfo.email,userinfo.profile,plus.me
+      DEFAULT_SCOPE = ""
+
+      option :name, 'allied_modders'
+      option :authorize_options, [:scope, :approval_prompt, :access_type, :state, :hd]
+
+      option :client_options, {
+        :site          => 'https://forums.alliedmods.net',
+        :authorize_url => '/oauth/auth.php',
+        :token_url     => '/oauth/token.php'
+      }
+
+      def authorize_params
+        base_scope_url = ""
+        super.tap do |params|
+          # Read the params if passed directly to omniauth_authorize_path
+          %w(scope approval_prompt access_type state hd).each do |k|
+            params[k.to_sym] = request.params[k] unless [nil, ''].include?(request.params[k])
+          end
+          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?
+          # Override the state per request
+          session['omniauth.state'] = params[:state] if request.params['state']
+        end
+      end
+
+      uid{ raw_info['id'] || verified_email }
+
+      info do
+        prune!({
+          :name       => raw_info['username'],
+          :nickname   => raw_info['username'],
+          :email      => verified_email,
+          :image      => raw_info['avatar'],
+          :urls => {
+            'AlliedModders' => "https://forums.alliedmods.net/member.php?u=#{uid}"
+          }
+        })
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info unless skip_info?
+        prune! hash
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('https://forums.alliedmods.net/oauth/userinfo.php').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/allied_modders/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'omniauth', '~> 1.0'
+
+  gem.authors       = ["Mitch Dempsey"]
+  gem.email         = ["mitch@mitchdempsey.com"]
+  gem.description   = %q{A AlliedModders oauth2 strategy for OmniAuth 1.0}
+  gem.summary       = %q{A AlliedModders 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-allied_modders"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::AlliedModders::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/allied_modders_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+require 'omniauth-allied-modders'
+
+describe OmniAuth::Strategies::AlliedModders do
+  def app; lambda{|env| [200, {}, ["Hello."]]} end
+
+  before :each do
+    OmniAuth.config.test_mode = true
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+    @request.stub(:env) { {} }
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  subject do
+    args = ['appid', 'secret', @options || {}].compact
+    OmniAuth::Strategies::AlliedModders.new(app, *args).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://forums.alliedmods.net')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth/auth.php')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth/token.php')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      subject.callback_path.should eq('/auth/allied_modders/callback')
+    end
+  end
+
+  describe '#authorize_params' do
+    %w(approval_prompt access_type state hd).each do |k|
+      it "should set the #{k} authorize option dynamically in the request" do
+        @options = {k.to_sym => ''}
+        subject.stub(:request) { double('Request', {:params => { k => 'something' }, :env => {}}) }
+        subject.authorize_params[k].should eq('something')
+      end
+    end
+
+    describe 'scope' 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 dynamically set the scope in the request' do
+        @options = {:scope => 'http://example.com'}
+        subject.stub(:request) { double('Request', {:params => { 'scope' => 'userinfo.email' }, :env => {}}) }
+        subject.authorize_params['scope'].should eq('https://www.googleapis.com/auth/userinfo.email')
+      end
+    end
+
+    describe 'approval_prompt' do
+      it 'should set the approval_prompt parameter if present' do
+        @options = {:approval_prompt => 'prompt'}
+        subject.authorize_params['approval_prompt'].should eq('prompt')
+      end
+
+      it 'should default to "force"' do
+        @options = {}
+        subject.authorize_params['approval_prompt'].should eq('force')
+      end
+    end
+
+    describe 'access_type' do
+      it 'should set the access_type parameter if present' do
+        @options = {:access_type => 'type'}
+        subject.authorize_params['access_type'].should eq('type')
+      end
+
+      it 'should default to "offline"' do
+        @options = {}
+        subject.authorize_params['access_type'].should eq('offline')
+      end
+    end
+
+    describe 'state' do
+      it 'should set the state parameter' do
+        @options = {:state => 'some_state'}
+        subject.authorize_params['state'].should eq('some_state')
+        subject.session['omniauth.state'].should eq('some_state')
+      end
+
+      it 'should set the omniauth.state dynamically' do
+        subject.stub(:request) { double('Request', {:params => { 'state' => 'some_state' }, :env => {}}) }
+        subject.authorize_params['state'].should eq('some_state')
+        subject.session['omniauth.state'].should eq('some_state')
+      end
+    end
+
+    describe 'hd' do
+      it 'should set the hd (hosted domain) parameter if present' do
+        @options = {:hd => 'example.com'}
+        subject.authorize_params['hd'].should eq('example.com')
+      end
+    end
+  end
+
+  describe 'raw info' do
+    it 'should include raw_info in extras hash by default' do
+      subject.stub(:raw_info) { { :foo => 'bar' } }
+      subject.extra[:raw_info].should eq({ :foo => 'bar' })
+    end
+
+    it 'should not include raw_info in extras hash when skip_info is specified' do
+      @options = { :skip_info => true }
+      subject.extra.should_not have_key(:raw_info)
+    end
+  end
+
+  describe 'populate auth hash url' do
+    it 'should populate url map in auth hash if link present in raw_info' do
+      subject.stub(:raw_info) { { 'name' => 'Foo', 'link' => 'https://plus.google.com/123456' } }
+      subject.info[:urls]['Google'].should eq('https://plus.google.com/123456')
+    end
+
+    it 'should not populate url map in auth hash if no link present in raw_info' do
+      subject.stub(:raw_info) { { 'name' => 'Foo' } }
+      subject.info.should_not have_key(:urls)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+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,113 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-allied_modders
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mitch Dempsey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &2156740420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156740420
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: &2156753500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156753500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156752580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156752580
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156751880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156751880
+description: A AlliedModders oauth2 strategy for OmniAuth 1.0
+email:
+- mitch@mitchdempsey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- examples/config.ru
+- examples/omni_auth.rb
+- lib/omniauth-allied_modders.rb
+- lib/omniauth/allied_modders.rb
+- lib/omniauth/allied_modders/version.rb
+- lib/omniauth/strategies/allied_modders.rb
+- omniauth-contrib.gemspec
+- spec/omniauth/strategies/allied_modders_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2762080650861133142
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2762080650861133142
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A AlliedModders oauth2 strategy for OmniAuth 1.0
+test_files:
+- spec/omniauth/strategies/allied_modders_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb