omniauth-gusto 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b0c7e7e85d01a5ac9c5d3a19f400d3d1f25db73
+  data.tar.gz: d6fc44dd339fbe417385bbe87b3362720612a867
+SHA512:
+  metadata.gz: 5771200c245678925323bc25957cd30e43db4d0ccf2c8ad0130500d71481d80d12fbb6de3f002b0aabb023dae24bb917609e06b1669288f300709d3dd5e5f65b
+  data.tar.gz: 7874c181bfd07825c7e6c7eb71143679cba36dfbd72317fabea2b559031e9aaa29f671df39b39448b6f2f8aa7e5b5b7cbeacca3ec85005d67be89c319535ae9f

data/.circleci/config.yml

@@ -0,0 +1,134 @@
+version: 2.1
+
+orbs:
+  omniauth-gusto:
+    executors:
+      ruby-2-3:
+        docker:
+          - image: circleci/ruby:2.3-node-browsers
+      ruby-2-4:
+        docker:
+          - image: circleci/ruby:2.4-node-browsers
+      ruby-2-5:
+        docker:
+          - image: circleci/ruby:2.5-node-browsers
+      ruby-2-6:
+        docker:
+          - image: circleci/ruby:2.6-node-browsers
+
+    commands:
+      install:
+        steps:
+          - checkout
+          - run:
+              name: Configure Bundler
+              command: |
+                echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+                source $BASH_ENV
+                gem install bundler
+          # Download and cache dependencies
+          - restore_cache:
+              keys:
+                - v1-dependencies-{{ checksum "Gemfile.lock" }}
+                # fallback to using the latest cache if no exact match is found
+                - v1-dependencies-
+          - run:
+              name: install dependencies
+              command: |
+                bundle install --jobs=4 --retry=3 --path vendor/bundle
+          - save_cache:
+              paths:
+                - ./vendor/bundle
+              key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+    jobs:
+      test:
+        executor: << parameters.executor >>
+        parameters:
+          executor:
+            type: string
+        steps:
+          - install
+          - run:
+              name: run tests
+              command: |
+                mkdir /tmp/test-results
+                TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+                  circleci tests split --split-by=timings)"
+
+                bundle exec rspec \
+                  --format progress \
+                  --format RspecJunitFormatter \
+                  --out /tmp/test-results/rspec.xml \
+                  --format progress \
+                  $TEST_FILES
+          - store_test_results:
+              path: /tmp/test-results
+          - store_artifacts:
+              path: /tmp/test-results
+              destination: test-results
+
+      lint:
+        executor: ruby-2-6
+        steps:
+          - install
+          - run:
+              name: lint
+              command: bundle exec rubocop
+
+      build:
+        executor: << parameters.executor >>
+        parameters:
+          executor:
+            type: string
+        steps:
+          - install
+          - run: gem build omniauth-gusto.gemspec
+
+      publish:
+        executor: ruby-2-6
+        steps:
+          - run: echo 'Publishing'
+
+workflows:
+  version: 2
+  CI:
+    jobs:
+      - omniauth-gusto/test:
+          name: test (Ruby 2.3)
+          executor: ruby-2-3
+      - omniauth-gusto/test:
+          name: test (Ruby 2.4)
+          executor: ruby-2-4
+      - omniauth-gusto/test:
+          name: test (Ruby 2.5)
+          executor: ruby-2-5
+      - omniauth-gusto/test:
+          name: test (Ruby 2.6)
+          executor: ruby-2-6
+      - omniauth-gusto/lint:
+          name: lint
+      - omniauth-gusto/build:
+          name: build (Ruby 2.3)
+          executor: ruby-2-3
+      - omniauth-gusto/build:
+          name: build (Ruby 2.4)
+          executor: ruby-2-4
+      - omniauth-gusto/build:
+          name: build (Ruby 2.5)
+          executor: ruby-2-5
+      - omniauth-gusto/build:
+          name: build (Ruby 2.6)
+          executor: ruby-2-6
+      - omniauth-gusto/publish:
+          name: publish
+          requires:
+            - test (Ruby 2.3)
+            - test (Ruby 2.4)
+            - test (Ruby 2.5)
+            - test (Ruby 2.6)
+            - lint
+            - build (Ruby 2.3)
+            - build (Ruby 2.4)
+            - build (Ruby 2.5)
+            - build (Ruby 2.6)

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+.DS_Store
+
+# rspec failure tracking
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - Gemfile
+    - omniauth-gusto.gemspec
+    - lib/omniauth-gusto.rb
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - ./**/*_spec.rb
+
+Naming/FileName:
+  Exclude:
+    - lib/omniauth-gusto.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-omniauth-gusto.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    omniauth-gusto (0.1.0)
+      omniauth-oauth2 (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.6.0)
+    jaro_winkler (1.5.3)
+    jwt (2.2.1)
+    method_source (0.9.2)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.9.0)
+      hashie (>= 3.4.6, < 3.7.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.6.0)
+      oauth2 (~> 1.1)
+      omniauth (~> 1.9)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rack (2.0.7)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  omniauth-gusto!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+  rubocop
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Gusto
+
+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,108 @@
+# OmniAuth Gusto
+
+Official OmniAuth strategy for authenticating with [Gusto](https://gusto.com/) using [Gusto’s API](https://docs.gusto.com/).
+
+[![CircleCI](https://circleci.com/gh/Gusto/omniauth-gusto.svg?style=shield&circle-token=909a0685695a00064b3ebc9c3374a61ea85d8cf0)](https://circleci.com/gh/Gusto/omniauth-gusto)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-gusto'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-gusto
+
+## Usage
+
+Integrate the strategy into your middleware. Refer to [Devise’s documentation](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview) if using Devise.
+
+```ruby
+# config/initializers/omniauth.rb
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :gusto, ENV['GUSTO_CLIENT_ID'], ENV['GUSTO_CLIENT_SECRET']
+end
+```
+
+The route `/auth/gusto` will become available to initiate authentication.
+Set up the callback route `/auth/gusto/callback` and tie to a controller action
+to handle any post-authentication actions.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  get '/auth/gusto/callback', to: 'sample_controller#gusto'
+end
+
+```
+
+For more information on how to use OmniAuth, refer to the [OmniAuth documentation](https://github.com/omniauth/omniauth).
+
+## Gusto’s API
+Use the access token from the Auth Hash `request.env['omniauth.auth']['credentials']['token']` to
+make calls to other [Gusto API](https://docs.gusto.com/) endpoints
+such as [payrolls](https://docs.gusto.com/v1/payrolls).
+To gain access to Gusto’s API, [contact Gusto](https://gusto.com/about/contact) to establish a client id and secret.
+
+## Sample Response
+
+Below is an example Auth Hash availble in `request.env['omniauth.auth']`. Note `info['name']` is set to the user’s email and that employee names will have to be fetched from the [employees endpoint](https://docs.gusto.com/v1/employees).
+
+```ruby
+{
+  "provider" => "gusto",
+  "uid" => 123,
+  "info" => {
+    "email" => "example.user@gmail.com",
+    "name" => "example.user@gmail.com"
+  },
+  "credentials" => {
+    "token" => "456",
+    "refresh_token" => "789",
+    "expires_at" => 1561589955,
+    "expires" => true
+  },
+  "extra" => {
+    "raw_info" => {
+      "id" => 123,
+      "email" => "example.user@gmail.com",
+      "roles" => {
+        "payroll_admin" => {
+          "companies" => [
+            {
+              "id" => 101112,
+              "name" => "Poi's Doughnuts",
+              "trade_name" => null,
+              "locations" => [
+                {
+                  "id" => 131415,
+                  "street_1" => "1236 Mission St",
+                  "street_2" => "",
+                  "city" => "San Francisco",
+                  "state" => "CA",
+                  "zip" => "94103",
+                  "country" => "USA",
+                  "active" => true
+                }
+              ]
+            }
+          ]
+        }
+      }
+    }
+  }
+}
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'omniauth/omniauth-gusto'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth-gusto.rb

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

data/lib/omniauth-gusto/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OmniauthGusto
+  VERSION = '1.0.0'
+end

data/lib/omniauth/strategies/gusto.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    # Provides an Omniauth strategy for Gusto
+    class Gusto < OmniAuth::Strategies::OAuth2
+      option :name, 'gusto'
+
+      # Options can be overridden in OmniAuth config initialization
+
+      option(
+        :client_options,
+        site: 'https://api.gusto.com/',
+        authorize_url: '/oauth/authorize',
+        token_url: '/oauth/token'
+      )
+
+      option :authorize_options, %i[redirect_uri response_type]
+
+      # Response phase
+      #
+      # Following params are returned:
+      #   uid: Gusto user id of the user that initiated the authentication request
+      #   info:
+      #     email: Gusto email of the user
+      #     name: Gusto email of the user
+      #   extra:
+      #     raw_info: User info gained from https://docs.gusto.com/v1/current_user
+      #
+      # See https://docs.gusto.com/ for detailed info about Gusto's API
+
+      uid do
+        raw_info['id']
+      end
+
+      info do
+        { 'email' => raw_info['email'] }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      private
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/v1/me').parsed
+      end
+    end
+  end
+end

data/omniauth-gusto.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-gusto/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-gusto'
+  spec.version       = OmniauthGusto::VERSION
+  spec.authors       = %w[juliannaroen lisasli]
+  spec.email         = ['julianna.roen@gusto.com', 'lisa.li@gusto.com']
+
+  spec.summary       = 'Official OmniAuth strategy for Gusto'
+  spec.description   = 'Official OmniAuth strategy for Gusto'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'omniauth-oauth2', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-gusto
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- juliannaroen
+- lisasli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 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.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: rubocop
+  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: Official OmniAuth strategy for Gusto
+email:
+- julianna.roen@gusto.com
+- lisa.li@gusto.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-gusto.rb
+- lib/omniauth-gusto/version.rb
+- lib/omniauth/strategies/gusto.rb
+- omniauth-gusto.gemspec
+homepage: ''
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Official OmniAuth strategy for Gusto
+test_files: []