omniauth-taskrabbit 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.rvmrc
+.bundle
+.rspec
+/Gemfile.lock
+pkg/*
+.powenv
+tmp
+bin

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+gem 'jruby-openssl', :platform => :jruby
+gem 'debugger'
+gem 'sinatra'

data/README.md

@@ -0,0 +1,88 @@
+# OmniAuth TaskRabbit
+
+TaskRabbit OAuth2 Strategy for OmniAuth 1.0.
+
+Supports the OAuth 2.0 server-side and client-side flows.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-taskrabbit'
+```
+
+Then `bundle install`.
+
+## Usage
+
+Add to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :taskrabbit, ENV['TR_API_KEY'], ENV['TR_SECRET']
+end
+```
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'taskrabbit',
+  :uid => 283559,
+  :info => {
+    :email => "sponge.bob@example.com"
+    :first_name => "Bob",
+    :last_name => "Sponge",
+    :full_name => "Bob Sponge",
+    :zip_code => "21314",
+    :city: {
+      :id: 1,
+      :name: "Boston"
+    },
+  },
+  :credentials => {
+    :token => 'oXOIDNEOInwiewniwnaiNSiocnione', # OAuth 2.0 access_token, which you may wish to store
+    :expires => false
+  },
+  :extra => {
+    :raw_info => {
+      :id => 283559,
+      :zip_code => "21314",
+      :first_name => "Bob",
+      :last_name => "Sponge",
+      :full_name => "Bob Sponge",
+      :short_name => "Bob",
+      :display_name => "Bob S.",
+      :email => "sponge.bob@example.com",
+      :city: {
+        :id: 1,
+        :name: "Boston"
+      },
+      :links => {
+        :avatar_url => "https://www.taskrabbit.com/images/default_avatars/poster_thumb.png",
+        :get => "/api/v1/users/283559"
+      },
+      :tasks => {
+        :links => {
+          :get => "/api/v1/users/283559/tasks",
+          :last => "/api/v1/users/283559/tasks?page=1",
+          :first => "/api/v1/users/283559/tasks?page=1"
+        }
+      },
+      :locations => {
+        :links => {
+          :get => "/api/v1/users/283559/locations"
+        }
+      },
+      :counts => {
+        :posted_tasks => 5,
+        :ongoing_tasks => 2,
+        :active_tasks => 1
+      }
+    }   
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+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 TaskRabbit OAuth2 Strategy
+# Make sure to setup the ENV variables TR_API_KEY and TR_SECRET
+# Run with "bundle exec rackup"
+ENV['TR_API_KEY']    = 'ior8jfh723hfD8fj9eSi383Niojreiu3U832hf90'
+ENV['TR_API_SECRET'] = 'pfjf7dfw392h2D2iofkjpxqdreLKue523tdnbdff'
+
+require 'rubygems'
+require 'bundler'
+require 'sinatra'
+require 'omniauth'
+require 'omniauth-taskrabbit'
+require 'openssl'
+require 'debugger'
+
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+class App < Sinatra::Base
+  get '/' do
+    <<-HTML
+    <ul>
+      <li><a href='/auth/taskrabbit'>Sign in with TaskRabbit</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 :taskrabbit, ENV['TR_API_KEY'], ENV['TR_API_SECRET']
+end
+
+run App.new

data/examples/omni_auth.rb

@@ -0,0 +1,3 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :taskrabbit, ENV['TR_API_KEY'], ENV['TR_SECRET']
+end

data/lib/omniauth-taskrabbit.rb

@@ -0,0 +1 @@
+require 'omniauth/taskrabbit'

data/lib/omniauth/strategies/taskrabbit.rb

@@ -0,0 +1,65 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class TaskRabbit < OmniAuth::Strategies::OAuth2
+      option :name, "taskrabbit"
+      
+      option :client_options, {
+              :site => "https://www.taskrabbit.com",
+              :authorize_url => '/api/authorize',
+              :request_token_url  => "/api/oauth/request_token",
+              :token_url          => '/api/oauth/token'
+            }
+
+      option :access_token_options, {
+        :header_format => 'OAuth %s',
+        :param_name => 'access_token'
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!({
+          'email' => raw_info['email'],
+          'first_name' => raw_info['first_name'],
+          'last_name' => raw_info['last_name'],
+          'full_name' => raw_info['full_name'],
+          'zip_code' => raw_info['zip_code'],
+          'city' => raw_info['city'],
+        })
+      end
+      
+      extra do
+        prune!({
+          'raw_info' => raw_info
+        })
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/account').parsed
+      end
+
+      def build_access_token
+        super.tap do |token|
+          token.options.merge!(access_token_options)
+        end
+      end
+
+      def access_token_options
+        options.access_token_options.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+      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
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'taskrabbit', 'TaskRabbit'

data/lib/omniauth/taskrabbit.rb

@@ -0,0 +1,2 @@
+require 'omniauth/taskrabbit/version'
+require 'omniauth/strategies/taskrabbit'

data/lib/omniauth/taskrabbit/version.rb

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

data/omniauth-taskrabbit.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/taskrabbit/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-taskrabbit'
+  s.version  = OmniAuth::TaskRabbit::VERSION
+  s.authors  = ['Jean-Richard Lai']
+  s.email    = ['jrichardlai@gmail.com']
+  s.summary  = 'Taskrabbit strategy for OmniAuth'
+  s.homepage = 'https://github.com/jrichardlai/omniauth-taskrabbit'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.0.2'
+
+  s.add_development_dependency 'rspec', '~> 2'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/taskrabbit_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'omniauth-taskrabbit'
+require 'openssl'
+require 'base64'
+
+describe OmniAuth::Strategies::TaskRabbit do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+    @request.stub(:env) { {} }
+
+    @client_id = '123'
+    @client_secret = '53cr3tz'
+  end
+
+  subject do
+    args = [@client_id, @client_secret, @options].compact
+    OmniAuth::Strategies::TaskRabbit.new(nil, *args).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct TaskRabbit site' do
+      subject.client.site.should eq('https://www.taskrabbit.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/api/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/api/oauth/token')
+    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 => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_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 :authorize_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,116 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-taskrabbit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jean-Richard Lai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jrichardlai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- examples/config.ru
+- examples/omni_auth.rb
+- lib/omniauth-taskrabbit.rb
+- lib/omniauth/strategies/taskrabbit.rb
+- lib/omniauth/taskrabbit.rb
+- lib/omniauth/taskrabbit/version.rb
+- omniauth-taskrabbit.gemspec
+- spec/omniauth/strategies/taskrabbit_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/jrichardlai/omniauth-taskrabbit
+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: -844660181069885661
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -844660181069885661
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Taskrabbit strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/taskrabbit_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb