omniauth-harvest 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    omniauth-harvest (0.1.0)
+      omniauth-oauth2 (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    faraday (0.8.0)
+      multipart-post (~> 1.1)
+    hashie (1.2.0)
+    httpauth (0.1)
+    multi_json (1.3.4)
+    multipart-post (1.1.5)
+    oauth2 (0.6.1)
+      faraday (~> 0.7)
+      httpauth (~> 0.1)
+      multi_json (~> 1.3)
+    omniauth (1.1.0)
+      hashie (~> 1.2)
+      rack
+    omniauth-oauth2 (1.0.2)
+      oauth2 (~> 0.6.0)
+      omniauth (~> 1.0)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-harvest!
+  rake
+  rspec

data/README.md

@@ -0,0 +1,60 @@
+# OmniAuth Harvest
+
+Harvest OAuth2 Strategy for OmniAuth 1.0. Largely inspired by Shopify's OmniAuth strategy: https://github.com/Shopify/omniauth-shopify-oauth2
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-harvest'
+```
+
+Then run `bundle install`.
+
+## Usage
+
+Read the OmniAuth 1.0 docs for detailed instructions on using OmniAuth: https://github.com/intridea/omniauth.
+
+You will need to set up your application in your Harvest account `https://<companyname>.harvestapp.com/oauth2_clients`. Support for receiving these details from users (for accessing multiple accounts) will be coming soon.
+
+To use this in Rails, for example, add the following in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :harvest, ENV['HARVEST_IDENTIFIER'], ENV['HARVEST_SECRET']
+end
+```
+
+There is also a simple Sinatra example in ./example/config.ru
+
+## Authentication Hash
+
+Here's an example *Authentication Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'harvest',
+  :credentials => {
+    :token => 'afasd923kjh0934kf', # OAuth 2.0 access_token; use this for authenticating API requests
+  }
+}
+```
+
+## License
+Copyright (c) 2012 by Core
+
+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.
+
+### Based on the Shopify OmniAuth Strategy
+Copyright (c) 2012 by Shopify Inc
+
+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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/example/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rack'
+
+gem 'sinatra'
+gem 'omniauth-harvest', :path => '../'

data/example/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: ../
+  specs:
+    omniauth-harvest (0.1.0)
+      omniauth-oauth2 (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    faraday (0.8.0)
+      multipart-post (~> 1.1)
+    hashie (1.2.0)
+    httpauth (0.1)
+    multi_json (1.3.4)
+    multipart-post (1.1.5)
+    oauth2 (0.6.1)
+      faraday (~> 0.7)
+      httpauth (~> 0.1)
+      multi_json (~> 1.3)
+    omniauth (1.1.0)
+      hashie (~> 1.2)
+      rack
+    omniauth-oauth2 (1.0.2)
+      oauth2 (~> 0.6.0)
+      omniauth (~> 1.0)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-harvest!
+  rack
+  sinatra

data/example/config.ru

@@ -0,0 +1,41 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-harvest'
+
+class App < Sinatra::Base
+  get '/auth/:provider/callback' do
+    <<-HTML
+    <html>
+    <head>
+      <title>Harvest Oauth2</title>
+    </head>
+    <body>
+      <h3>Authorized</h3>
+      <p>Token: #{request.env['omniauth.auth']['credentials']['token']}</p>
+    </body>
+    </html>
+    HTML
+  end
+
+  get '/auth/failure' do
+    <<-HTML
+    <html>
+    <head>
+      <title>Harvest Oauth2</title>
+    </head>
+    <body>
+      <h3>Failed Authorization</h3>
+      <p>Message: #{params[:message]}</p>
+    </body>
+    </html>
+    HTML
+  end
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :harvest, ENV['HARVEST_IDENTIFIER'], ENV['HARVEST_SECRET']
+end
+
+run App.new

data/lib/omniauth-harvest.rb

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

data/lib/omniauth/harvest.rb

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

data/lib/omniauth/harvest/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Harvest
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/harvest.rb

@@ -0,0 +1,36 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Harvest < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site => 'https://api.harvestapp.com',
+        :authorize_url => '/oauth2/authorize',
+        :token_url => '/oauth2/token'
+      }
+      
+      def authorize_params
+        super.tap do |params|
+          params[:response_type] = "code"
+          params[:client_id] = client.id
+          params[:redirect_uri] ||= callback_url
+        end
+      end
+
+      def request_phase
+        super
+      end
+
+      def build_access_token
+        token_params = {
+          :code => request.params['code'],
+          :redirect_uri => callback_url,
+          :client_id => client.id,
+          :client_secret => client.secret,
+          :grant_type => 'authorization_code'
+        }
+        client.get_token(token_params)
+      end
+    end
+  end
+end

data/omniauth-harvest.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/harvest/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-harvest'
+  s.version  = OmniAuth::Harvest::VERSION
+  s.authors  = ['Robert May']
+  s.email    = ['robotmay@gmail.com']
+  s.summary  = 'Harvest strategy for OmniAuth'
+  s.homepage = 'https://github.com/corewebdesign/omniauth-harvest'
+
+  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.0'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/harvest_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'omniauth-harvest'
+require 'base64'
+
+describe OmniAuth::Strategies::Harvest do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+
+    @client_id = '123'
+    @client_secret = '53cr3tz'
+    @options = {}
+  end
+
+  subject do
+    args = [@client_id, @client_secret, @options].compact
+    OmniAuth::Strategies::Harvest.new(nil, *args).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  describe '#client' do
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth2/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth2/token')
+    end
+  end
+
+  describe '#credentials' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      @access_token.stub(:token)
+      @access_token.stub(:expires?)
+      @access_token.stub(:expires_at)
+      @access_token.stub(:refresh_token)
+      subject.stub(:access_token) { @access_token }
+    end
+
+    it 'returns a Hash' do
+      subject.credentials.should be_a(Hash)
+    end
+
+    it 'returns the token' do
+      @access_token.stub(:token) { '123' }
+      subject.credentials['token'].should eq('123')
+    end
+
+    it 'returns the expiry status' do
+      @access_token.stub(:expires?) { true }
+      subject.credentials['expires'].should eq(true)
+
+      @access_token.stub(:expires?) { false }
+      subject.credentials['expires'].should eq(false)
+    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,36 @@
+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 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,112 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-harvest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Robert May
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !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:
+- robotmay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- example/Gemfile
+- example/Gemfile.lock
+- example/config.ru
+- lib/omniauth-harvest.rb
+- lib/omniauth/harvest.rb
+- lib/omniauth/harvest/version.rb
+- lib/omniauth/strategies/harvest.rb
+- omniauth-harvest.gemspec
+- spec/omniauth/strategies/harvest_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/corewebdesign/omniauth-harvest
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Harvest strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/harvest_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb