omniauth-zenpayroll 0.0.9

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjBiMzBkYjAzMDgyZDAwN2EwNjBlNjlhZjNjZTNlMWRhMGE5NzA3NA==
+  data.tar.gz: !binary |-
+    ODJkNTkyYjM2NTIzYWMzOTIwOGQ3YzJiNmQ3MTU5ZTNmZjdmOTAxMw==
+SHA512:
+  metadata.gz: !binary |-
+    ZTAyYjFlZDEwZjZjMjJiY2ZlZTczMmQ0N2VhZGM2YTNhZjZhODhhNTRmMzI3
+    OWIzMzE0MjUzZWYyMGQ0M2FlY2RhNTgwYjRjOTlkM2EyMWRiNzZiZWQyMzdl
+    OTQxNjk4MDcwMTllOTg1NTk2Y2JhYWY3YTdiNzVhYzY4ZjFiYmY=
+  data.tar.gz: !binary |-
+    Y2FlNGY1ZDZjNWI0M2EwZmI4ZDUzN2Q3ZjFhN2IxZTQ4ZjhmNDY5MzMyOGM5
+    MzI1MmRkOTE1ZjYwNTMxNjg2YjQxMGY0N2QwNjE0OTFkNDA3NWRhYzZmZGQ1
+    ZjhjMmE4MWFhYWJmYjc3ZjFiN2ZjOTU2NThmNjhiY2NkYTVjZDA=

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'rake'
+# Specify your gem's dependencies in omniauth-zenpayroll.gemspec
+gemspec

data/README.md

@@ -0,0 +1,106 @@
+# OmniAuth ZenPayroll
+
+This gem contains the ZenPayroll strategy for OmniAuth.
+
+ZenPayroll implements a standard [OAuth 2.0](http://en.wikipedia.org/wiki/OAuth#OAuth_2.0) authentication process, issuing 
+a short term (~10 minute ttl) authentication token that is then used to retrieve a longer-term (~2 hour ttl) access token 
+and single-use refresh token.
+
+For more detailed information see the [ZenPayroll Authentication Example](http://docs.zenpayroll.com/v1/examples/authentication/)
+in the API docs.
+
+## Before You Begin
+
+You should have already installed OmniAuth in your app; if not, read the [OmniAuth README](https://github.com/intridea/omniauth) 
+to get started. Also, Ryan Bates has made a number of excellent [Railscasts](http://railscasts.com/episodes/235-devise-and-omniauth-revised)
+on getting started with OmniAuth and Devise.
+
+You'll need to create an application with ZenPayroll first. Take note of your Client ID, Client Secret and Redirect URI,
+your application will use these to authenticate against the ZenPayroll API.
+
+## Using This Strategy
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'omniauth-zenpayroll'
+```
+
+If you need to use the latest HEAD version, you can do so with:
+
+```ruby
+gem 'omniauth-zenpayroll', :github => 'shiftdock/omniauth-zenpayroll'
+```
+
+Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :zenpayroll, "CLIENT_ID", "CLIENT_SECRET"
+end
+```
+
+Replace `CLIENT_ID` and `CLIENT_SECRET` with the appropriate values you obtained from ZenPayroll earlier.
+
+If you need to override the Redirect URI (i.e. if yours deviates from the default) you can do so by setting it as the
+`callback_url` in an `authorize_params` options hash. 
+
+```ruby
+Rails.application.config.middleware.user OmniAuth:Builder do
+  provider :zenpayroll, "CLIENT_ID", "CLIENT_SECRET", :authorize_params => {:callback_url => '/my/app/callback/url'}
+end
+```
+
+#### UID Gotcha
+
+As the ZenPayroll API doesn't expose a unique ID for the user being authenticated we have to use their email address 
+instead. ZenPayroll ensure that it will be unique. To remain consistent with other OmniAuth strategies the email address
+is returned as both the `uid` and as `email` in the `info` hash.
+
+## Authentication Hash
+
+An example auth hash available in `request.env['omniauth.auth']`:
+```ruby
+{
+  :provider => "zenpayroll",
+  :uid => "auth_user@zenpayroll.x",
+  :info => {
+    :email => "auth_user@zenpayroll.x"
+  },
+  :credentials => {
+    :token         => "a1b2c3d4...", # The OAuth 2.0 access token
+    :refresh_token => "abcdef1234",
+    :expires       => true,
+    :expires_at    => 456102000
+  },
+  :extra => {
+    :email => "auth_user@zenpayroll.x",
+    :permissions => {
+      :payroll_admin => {
+        :company_ids => [123456789]
+      }
+    }
+  }
+}
+```
+
+## Tests
+
+Although the strategy is currently in production use at [ShiftDock](https://shiftdock.com), the version is <1.0.0 until the project
+includes robust tests.
+
+## Credits
+
+Built with example from the awesome [omniauth-twitter](https://github.com/arunagw/omniauth-twitter) gem by Arun Agrawal and 
+[omniauth-facebook](https://github.com/mkdynamic/omniauth-facebook) gem by Mark Dodwell.
+
+
+## License
+
+Copyright (c) 2013 by John M. Hope
+
+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 @@
+require "bundler/gem_tasks"

data/lib/omniauth-zenpayroll.rb

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

data/lib/omniauth-zenpayroll/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module ZenPayroll
+    VERSION = "0.0.9"
+  end
+end

data/lib/omniauth/strategies/zenpayroll.rb

@@ -0,0 +1,74 @@
+require 'omniauth-oauth2'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class ZenPayroll < OmniAuth::Strategies::OAuth2
+      
+      option :name, 'zenpayroll'
+<<<<<<< HEAD
+      option :client_options, { authorize_url: '/oauth/authorize',
+                                token_url:     '/oauth/token',
+                                site:          'https://zenpayroll.com/' }
+                     
+      option :token_params, {
+        parse:      :json,
+        grant_type: 'authorization_code'
+      }
+=======
+      option :client_options, {:authorize_path => '/oauth/authorize',
+                               :site => 'https://zenpayroll-demo.com'}
+>>>>>>> df6131f... First stage authentication routing works
+
+      option :auth_token_params, {
+        param_name: 'access_token',
+        mode:       :query
+      }
+
+      uid { raw_info['email'] }
+
+      info do
+        {
+          'email' => raw_info['email']
+         }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+      
+      # ZenPayroll are strict on redirect_uri.
+      # Pass 'origin=...' as parameter to provider url to pass through. 
+      def callback_url
+        options.authorize_params.callback_url or super
+      end
+      
+      def request_phase
+        redirect client.auth_code.authorize_url({:redirect_uri => callback_url}.merge(options.authorize_params))
+      end
+
+      def callback_url
+        options.authorize_params.callback_url or super
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me.json').parsed
+      rescue ::Errno::ETIMEDOUT
+        raise ::Timeout::Error
+      end
+
+      def build_access_token
+        token_params = options.token_params.merge({
+            code:          request.params['code'],
+            redirect_uri:  callback_url,
+            client_id:     client.id,
+            client_secret: client.secret
+          })
+        
+        client.get_token(token_params, deep_symbolize(options.auth_token_params))
+      end
+     end
+   end
+end
+
+OmniAuth.config.add_camelization 'zenpayroll', 'ZenPayroll'

data/omniauth-zenpayroll.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-zenpayroll/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-zenpayroll"
+  s.version     = OmniAuth::ZenPayroll::VERSION
+  s.authors     = ["John M. Hope"]
+  s.email       = ["john@shiftdock.com"]
+  s.homepage    = "https://github.com/shiftdock/omniauth-zenpayroll"
+  s.summary     = %q{OmniAuth strategy for ZenPayroll}
+  s.description = %q{OmniAuth strategy for ZenPayroll}
+  s.license     = "MIT"
+
+  s.rubyforge_project = "omniauth-zenpayroll"
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'multi_json', '~> 1.3'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.1'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-zenpayroll
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+platform: ruby
+authors:
+- John M. Hope
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OmniAuth strategy for ZenPayroll
+email:
+- john@shiftdock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-zenpayroll.rb
+- lib/omniauth-zenpayroll/version.rb
+- lib/omniauth/strategies/zenpayroll.rb
+- omniauth-zenpayroll.gemspec
+homepage: https://github.com/shiftdock/omniauth-zenpayroll
+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: omniauth-zenpayroll
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for ZenPayroll
+test_files: []