omniauth-clover 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmQwOGVkNzhlOTZhOGRkOGQ0NGQzMzIxZTZlNWNiMDVjNGM4ODU0OA==
+  data.tar.gz: !binary |-
+    Y2QzNWYyMjAyOTJlMWRmN2M5NjA2ODMxYjkwM2FhMmMwMDRjMDYyNg==
+SHA512:
+  metadata.gz: !binary |-
+    OWVlYzFjNDg4YTk1Y2M5ZGIxZThjOWZiMGI3NTZmNDQ5YzVhYmJjZDA5ZDBk
+    ODRlMmY0MDYyMmQ3NzZkOWM0NDFhYmEzNDUxMTg2NWQ0NzVhZmFhYWU0OGIy
+    ZWEyNDVkODZiYzM2MTIyZmQ5ZTU0ZjZhOGU4NjFmMTdlMDQxMDY=
+  data.tar.gz: !binary |-
+    MTEyOTY3NDNhZDYxYjQwOGJkYjhmMjVjNjM0MzhmY2YzYmRhYTVmOGI4Mjll
+    ZjFhYjdjMjIxNWNjYWU1M2E2ZGQ3ZWJmZTdmYjA3NGY3OGUxMWRlNjIwZWI4
+    NGYyZDUzNWU5YjNkYTQwMTZlNmJlMWM5MDRlYjYxOTVkOGE2Nzk=

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'jruby-openssl', :platform => :jruby

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Yun
+
+MIT License
+
+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/README.md

@@ -0,0 +1,41 @@
+# Omniauth::Clover
+
+Clover OAuth2 Strategy for OmniAuth.
+
+Supports the OAuth 2.0 server-side and client-side flows. For more information: https://www.clover.com/docs/oauth
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-clover'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-clover
+
+## Usage
+
+config.omniauth :clover, "APP_ID", "APP_SECRET", :client_options => {:site => SITE}
+
+Please visit: https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview for more information.
+
+client options:
+---------------
+- site: Defaults to the production https://www.clover.com. Change SITE to point to the development server for testing.
+- authorize_url: Defaults to '/oauth/authorize'
+- token_url: Defaults to '/oauth/token' 
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/omniauth-clover.rb

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

data/lib/omniauth/clover.rb

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

data/lib/omniauth/clover/version.rb

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

data/lib/omniauth/strategies/clover.rb

@@ -0,0 +1,100 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Clover < OmniAuth::Strategies::OAuth2
+
+      option :name, 'clover'
+
+      # This is where you pass the options you would pass when
+      # initializing your consumer from the OAuth gem.
+
+      option :client_options, {
+        :site           => 'https://www.clover.com',
+        :authorize_url  => '/oauth/authorize',
+        :token_url      => '/oauth/token'
+      }
+
+      option :authorize_options, [:redirect_uri, :response_type, :state]
+
+
+      # After successful authentication, client information is returned
+      #
+      # Response parameters
+      # -------------------
+      #   merchant_id:  An ID that uniquely identifies the merchant who has authenticated with your app.
+      #
+      #   employee_id:  The employee ID of the current user. You can use this value to identify whether 
+      #                 the current user is the owner of the merchant account, an employee, or someone else.
+      #
+      #   client_id:    The application ID that the user is authenticated to. If your app supports multiple 
+      #                 markets (and you specified the client_ids parameter in the request to /oauth/authorize, 
+      #                 then use this value to determine which of your apps the user authenticated against.
+      #
+      #   code:         Authorization code.
+      #
+      #
+      # Employee Information
+      # --------------------
+      # Retrieves information for single employee
+      #
+      #   id (string, optional):                    Unique identifier
+      #   name (string):                            Full name of the employee
+      #   email (string, optional):                 Email of the employee (optional)
+      #   pin (string, optional):                   Employee PIN (hashed)
+      #   role (string, optional):                  ['ADMIN' or 'MANAGER' or 'EMPLOYEE']: Employee System Role
+      #
+      #   roles (array[Reference], optional)
+      #   customId (string, optional):              Custom ID of the employee
+      #   shifts (array[Reference], optional):      This employee's shifts
+      #   nickname (string, optional):              Nickname of the employee (shows up on receipts)
+      #   unhashedPin (string, optional):           Employee PIN
+      #   payments (array[Reference], optional):    This employee's payments
+      #   inviteSent (boolean, optional):           Returns true if this employee was sent an invite to activate their account
+      #   isOwner (boolean, optional):              Returns true if this employee is the owner account for this merchant
+      #   orders (array[Reference], optional):      This employee's orders
+      #   claimedTime (long, optional):             Timestamp of when this employee claimed their account
+
+      uid { 
+        raw_info['id'] 
+      }
+
+      info do 
+        {
+          :name         => raw_info['name'],
+          :first_name   => first_name,
+          :last_name    => last_name,
+          :email        => raw_info['email'],
+          :role         => raw_info['role'],
+          :urls         => { 'Clover' => raw_info['href'] }
+        }
+      end
+
+      extra do 
+        {
+          :merchant_id  => request.params['merchant_id'],
+          :employee_id  => request.params['employee_id'],
+          :client_id    => request.params['client_id'],
+          :code         => request.params['code']
+        }
+      end
+
+      def raw_info
+        merchant_id   = request.params['merchant_id']
+        empployee_id  = request.params['employee_id']
+        @raw_info ||= access_token.get("/v3/merchants/#{merchant_id}/employees/#{empployee_id}").parsed
+      end
+
+
+      private
+
+      def first_name
+        @raw_info['name'].blank? ? "" : @raw_info['name'].split(' ').first
+      end
+
+      def last_name
+        @raw_info['name'].blank? ? "" : @raw_info['name'].split[1..-1].join(' ')
+      end
+    end
+  end
+end

data/omniauth-clover.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/clover/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-clover"
+  spec.version       = OmniAuth::Clover::VERSION
+  spec.authors       = ["David Yun"]
+  spec.email         = ["davidy@gmail.com"]
+  spec.description   = %q{Clover OAuth2 Strategy for Omniauth}
+  spec.summary       = %q{Clover OAuth2 Strategy for Omniauth}
+  spec.homepage      = "https://github.com/davidy/omniauth-clover.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/omniauth/strategies/clover_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'omniauth-clover'
+
+describe OmniAuth::Strategies::Clover do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+  let(:app) {
+    lambda do
+      [200, {}, ["Hello."]]
+    end
+  }
+
+  subject do
+    OmniAuth::Strategies::Clover.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe '#client_options' do
+    it 'has correct site' do
+      expect(subject.client.site).to eq('https://www.clover.com')
+    end
+
+    it 'has correct authorize_url' do
+      expect(subject.client.options[:authorize_url]).to eq('/oauth/authorize')
+    end
+
+    it 'has correct token_url' do
+      expect(subject.client.options[:token_url]).to eq('/oauth/token')
+    end
+
+    describe "overrides" do
+      it 'should allow overriding the site' do
+        @options = {:client_options => {'site' => 'https://example.com'}}
+        expect(subject.client.site).to eq('https://example.com')
+      end
+
+      it 'should allow overriding the authorize_url' do
+        @options = {:client_options => {'authorize_url' => 'https://example.com'}}
+        expect(subject.client.options[:authorize_url]).to eq('https://example.com')
+      end
+
+      it 'should allow overriding the token_url' do
+        @options = {:client_options => {'token_url' => 'https://example.com'}}
+        expect(subject.client.options[:token_url]).to eq('https://example.com')
+      end
+    end
+  end
+
+  describe "#authorize_options" do
+    [:redirect_uri, :response_type, :state].each do |k|
+      it "should support #{k}" do
+        @options = {k => 'http://someval'}
+        expect(subject.authorize_params[k.to_s]).to eq('http://someval')
+      end
+    end
+
+    describe "redirect_uri" do
+      it 'should default to nil' do
+        @options = {}
+        expect(subject.authorize_params['redirect_uri']).to eq(nil)
+      end
+
+      it 'should set the redirect_uri parameter if present' do
+        @options = {:redirect_uri => 'https://example.com'}
+        expect(subject.authorize_params['redirect_uri']).to eq('https://example.com')
+      end
+    end
+
+    describe 'response_type' do
+      it 'should default to "code"' do
+        @options = {}
+        expect(subject.authorize_params['response_type']).to eq(nil)
+      end
+
+      it 'should set the response_type parameter if present' do
+        @options = {:response_type => 'token'}
+        expect(subject.authorize_params['response_type']).to eq('token')
+      end
+    end
+
+    describe 'state' do
+      it 'should set the state parameter' do
+        @options = {:state => 'some_state'}
+        expect(subject.authorize_params['state']).to eq('some_state')
+        expect(subject.session['omniauth.state']).to eq('some_state')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'omniauth-clover' # and any other gems you need
+require 'rspec'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-clover
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Yun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Clover OAuth2 Strategy for Omniauth
+email:
+- davidy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-clover.rb
+- lib/omniauth/clover.rb
+- lib/omniauth/clover/version.rb
+- lib/omniauth/strategies/clover.rb
+- omniauth-clover.gemspec
+- spec/omniauth/strategies/clover_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/davidy/omniauth-clover.git
+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: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Clover OAuth2 Strategy for Omniauth
+test_files:
+- spec/omniauth/strategies/clover_spec.rb
+- spec/spec_helper.rb