gusto_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 285fdebd872f38aa6a87e1de29a100b3170b046bb2856f454c550c934165308d
+  data.tar.gz: d1d0cebc49f6569900fe2c1c83bca3b2676f87f9ba042d2d499ec2eb4819b211
+SHA512:
+  metadata.gz: 52049e71564be76fdf10348c62ef51c96eec5cb9957a01ab0b8395990b326fdfe7f51d43f8c32f0556c1a223b31d2552503b1332cbf110e22810389a33d01a91
+  data.tar.gz: e44de1d86d7b3f9a6e19bf2a6121eae0442158bde8bf5007c9898b820618cc71aea7ef8acb6a26583f97ceb0bc67e1d1102a09445961c6db6818d88d340e67d1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.0.1
+
+Initial release
+Allow for creating companies
+Allow for fetching employees
+Allow for fetching current user

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joncodes+github@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gusto_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    gusto_api (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gusto_api!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jon Evans
+
+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,209 @@
+# GustoApi
+
+This gem provides an easy way to talk with the API for [Gusto](https://gusto.com/).
+
+The functionality for this gem is by no means exhaustive. If there's an endpoint
+that is unsupported, please feel free to add and open a PR.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gusto_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gusto_api
+
+## Usage
+
+### Configuration
+
+In an initializer, say, `config/initializers/gusto_api.rb`, configure the gem
+with settings provided by Gusto:
+
+```ruby
+GustoApi.configure do |config|
+  config.api_token = 'token'
+  config.client_id = 'client id'
+  config.client_secret = 'client secret'
+  config.redirect_url = 'redirect url'
+end
+```
+
+### OAuth flow
+
+Details are documented here: https://docs.gusto.com/v1/basics/authentication
+
+You'll have to set up a controller for the OAuth authorization callback. Set `redirect_url` to its URL.
+
+To get the initial URL to trigger the OAuth flow, use
+
+```ruby
+GustoApi::Oauth.auth_url
+```
+
+Link people to that URL and they'll see an authorization page on Gusto's site. After they accept, they'll be redirected to your `redirect_url` with `params[:code]` set to a temporary code that can be exchanged for an `access_token` and `refresh_token` with:
+
+```ruby
+GustoApi::Oauth.get_token(code)
+```
+This returns a hash:
+```ruby
+{
+  "access_token" => "ju53kDqMS0iPVsOECQF-H0ifxHDFBDTi2BHOopMrW1X",
+  "token_type" => "Bearer",
+  "expires_in" => 7200,
+  "refresh_token" => "64ir0v_ioQMdWin6Dv9poXGW-SI04yQr2oXE67YqgP5",
+  "scope" => "public",
+  "created_at" => 1610493513
+}
+```
+
+The temporary code lasts for 10 minutes and the access token lasts for 2 hours.
+
+After the access token expires, you'll need to use the `refresh_token` to get a new one:
+
+```ruby
+GustoApi::Oauth.refresh_token(refresh_token)
+```
+
+The hash returned is identical to that returned by `get_token`. It will give a new `access_token` and `refresh_token`. Each `refresh_token` can only be used once.
+
+### Creating a Company
+
+This requires configuring the API token above with the token provided by Gusto.
+
+Example with the minimum set of attributes:
+
+```ruby
+GustoApi::Company.create(
+  user: {
+    first_name: 'George',
+    last_name: 'Hampton,'
+    email: 'george@example.com'
+  },
+  company: {
+    name: 'Hampton LLC'
+  }
+)
+```
+
+Returns:
+
+```
+{
+  "account_claim_url": "https://app.gusto.com/claim_account/3456789"
+}
+```
+
+Documentation for full list of attributes and possible errors: https://docs.gusto.com/v1/examples/creating-a-company
+
+### Getting the Current User
+
+To get the authenticated user:
+
+```ruby
+GustoApi::CurrentUser.fetch(access_token)
+```
+
+This will return a hash:
+
+```ruby
+{
+  "id" => 7757869449967110,
+  "email" => "bonusly+demo@gusto.com",
+  "roles" => {
+    "payroll_admin" => {
+      "companies" => [
+        {
+          "id" => 7756341740967741,
+          "name" => "Bonusly Demo",
+          "trade_name" => "",
+          "locations" => [
+            {
+              "id" => 7757727716494058,
+              "street_1" => "912 Silver St.",
+              "street_2" => "Suite 1966",
+              "city" => "San Francisco",
+              "state" => "CA",
+              "zip" => "94107",
+              "country" => "USA",
+              "active" => true
+            }
+          ]
+        }
+      ]
+    }
+  }
+}
+
+```
+
+### Getting a Company's Employees
+
+This and most other endpoints require getting an `access_token` via OAuth.
+
+```ruby
+GustoApi::Company.new(id, access_token).employees
+```
+
+Documentation for response: https://docs.gusto.com/v1/employees
+
+### Want to interact with a different API endpoint?
+
+GustoApi provides two generic `Request` classes for interacting with the API.
+
+For API endpoints where you use the API key provided by Gusto, there's `GustoApi::TokenRequest` class with the following initialize signature:
+
+```ruby
+def initialize(endpoint:, method:, params: {})
+```
+
+`method` must be `:get` or `:post`, and `endpoint` is the URI for the API endpoint starting with "v1/".
+
+`params` is a hash that will be sent as query params for a GET request or the response's body for a POST.
+
+For API endpoints where you use the `access_token` fetched via OAuth, there's `GustoApi::BearerRequest` with the following initialize signature:
+
+```ruby
+def initialize(endpoint:, method:, params: {}, auth_token:)
+```
+
+The arguments are the same except that it requires passing in the `access_token` as the `auth_token` argument.
+
+Calling `submit` on the request instance will use HTTParty to send the request and return the response.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bonusly/gusto_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bonusly/gusto_api/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gusto::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bonusly/gusto_api/blob/master/CODE_OF_CONDUCT.md).
+
+## About Bonusly
+
+![Bonusly Logo](https://bonusly-files.s3.amazonaws.com/bonusly-logo.png?small)
+
+Bonusly is the fun and easy way to engage all of your employees and improve retention and productivity at every level of your organization.
+
+Check out [our product](https://bonus.ly) or [our engineering blog](https://engineering.bonus.ly).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gusto_api"
+
+# 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/gusto_api.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/gusto_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gusto_api"
+  spec.version       = GustoApi::VERSION
+  spec.authors       = ["Jon Evans"]
+  spec.email         = ["jon@bonus.ly"]
+
+  spec.summary       = %q{A small wrapper around the Gusto API}
+  spec.homepage      = "https://github.com/bonusly/gusto_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bonusly/gusto_api"
+  spec.metadata["changelog_uri"] = "https://github.com/bonusly/gusto_api/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) 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("httparty")
+end

data/lib/gusto_api.rb

@@ -0,0 +1,25 @@
+require "gusto_api/version"
+require "gusto_api/configuration"
+require "gusto_api/request"
+require "gusto_api/token_request"
+require "gusto_api/bearer_request"
+require "gusto_api/oauth_request"
+require "gusto_api/company"
+require "gusto_api/oauth"
+require "gusto_api/current_user"
+
+module GustoApi
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/gusto_api/bearer_request.rb

@@ -0,0 +1,7 @@
+module GustoApi
+  class BearerRequest < Request
+    def initialize(endpoint:, method:, params: {}, auth_token:)
+      super(endpoint: endpoint, method: method, params: params, auth_token: auth_token, auth_type: 'Bearer')
+    end
+  end
+end

data/lib/gusto_api/company.rb

@@ -0,0 +1,32 @@
+module GustoApi
+  class Company
+    def self.create(user:, company:)
+      raise Error.new("Missing a required attribute") unless user[:first_name] && user[:last_name] && user[:email] && company[:name]
+
+      TokenRequest.new(
+        endpoint: 'v1/provision',
+        method: :post,
+        params: { user: user, company: company }
+      ).submit
+    end
+
+    def initialize(id, access_token)
+      self.id = id
+      self.access_token = access_token
+    end
+
+    def employees(include_terminated: false)
+      params = include_terminated ? {} : { terminated: false }
+      BearerRequest.new(
+        endpoint: "v1/companies/#{id}/employees",
+        method: :get,
+        params: params,
+        auth_token: access_token
+      ).submit
+    end
+
+    private
+
+    attr_accessor :id, :access_token
+  end
+end

data/lib/gusto_api/configuration.rb

@@ -0,0 +1,13 @@
+module GustoApi
+  class Configuration
+    attr_accessor :api_token, :client_id, :client_secret, :redirect_url, :testing
+
+    def initialize
+      self.testing = true
+    end
+
+    def base_uri
+      testing ? 'https://api.gusto-demo.com/' : 'https://api.gusto.com/'
+    end
+  end
+end

data/lib/gusto_api/current_user.rb

@@ -0,0 +1,11 @@
+module GustoApi
+  class CurrentUser
+    def self.fetch(access_token)
+      GustoApi::BearerRequest.new(
+        endpoint: 'v1/me',
+        method: :get,
+        auth_token: access_token
+      ).submit
+    end
+  end
+end

data/lib/gusto_api/oauth.rb

@@ -0,0 +1,39 @@
+module GustoApi
+  class Oauth
+    def self.auth_url
+      URI(GustoApi.configuration.base_uri + "oauth/authorize").tap do |uri|
+        uri.query = URI.encode_www_form(
+          client_id: GustoApi.configuration.client_id,
+          redirect_uri: GustoApi.configuration.redirect_url,
+          response_type: 'code'
+        )
+      end.to_s
+    end
+
+    def self.get_token(code)
+      OauthRequest.new(
+        method: :post,
+        params: {
+          client_id: GustoApi.configuration.client_id,
+          client_secret: GustoApi.configuration.client_secret,
+          redirect_uri: GustoApi.configuration.redirect_url,
+          code: code,
+          grant_type: 'authorization_code'
+        }
+      ).submit
+    end
+
+    def self.refresh_token(refresh_token)
+      OauthRequest.new(
+        method: :post,
+        params: {
+          client_id: GustoApi.configuration.client_id,
+          client_secret: GustoApi.configuration.client_secret,
+          redirect_uri: GustoApi.configuration.redirect_url,
+          refresh_token: refresh_token,
+          grant_type: 'refresh_token'
+        }
+      ).submit
+    end
+  end
+end

data/lib/gusto_api/oauth_request.rb

@@ -0,0 +1,13 @@
+module GustoApi
+  class OauthRequest < Request
+    def initialize(method:, params: {})
+      super(
+        endpoint: 'oauth/token',
+        method: method,
+        params: params,
+        auth_token: nil,
+        auth_type: nil
+      )
+    end
+  end
+end

data/lib/gusto_api/request.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+
+module GustoApi
+  class Request
+    def initialize(endpoint:, method:, params: {}, auth_token:, auth_type: 'Token')
+      raise Error.new("Invalid method: #{method}. Must be :get or :post") unless %i[get post].include?(method)
+
+      self.endpoint = endpoint
+      self.method = method
+      self.params = params
+      self.auth_token = auth_token
+      self.auth_type = auth_type
+    end
+
+    def submit
+      HTTParty.send(method, url, options)
+    end
+
+    private
+
+    attr_accessor :endpoint, :method, :params, :auth_token, :auth_type
+
+    def options
+      {
+        headers: headers
+      }.merge(param_options)
+    end
+
+    def headers
+      return {} if auth_token.nil?
+
+      {
+        "Authorization" => "#{auth_type} #{auth_token}"
+      }
+    end
+
+    def param_options
+      return {} unless params.any?
+
+      {
+        params_key => params
+      }
+    end
+
+    def url
+      URI.join(GustoApi.configuration.base_uri, endpoint).to_s
+    end
+
+    def params_key
+      method == :get ? :query : :body
+    end
+  end
+end

data/lib/gusto_api/token_request.rb

@@ -0,0 +1,7 @@
+module GustoApi
+  class TokenRequest < Request
+    def initialize(endpoint:, method:, params: {})
+      super(endpoint: endpoint, method: method, params: params, auth_token: GustoApi.configuration.api_token, auth_type: 'Token')
+    end
+  end
+end

data/lib/gusto_api/version.rb

@@ -0,0 +1,3 @@
+module GustoApi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: gusto_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Evans
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- jon@bonus.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gusto_api.gemspec
+- lib/gusto_api.rb
+- lib/gusto_api/bearer_request.rb
+- lib/gusto_api/company.rb
+- lib/gusto_api/configuration.rb
+- lib/gusto_api/current_user.rb
+- lib/gusto_api/oauth.rb
+- lib/gusto_api/oauth_request.rb
+- lib/gusto_api/request.rb
+- lib/gusto_api/token_request.rb
+- lib/gusto_api/version.rb
+homepage: https://github.com/bonusly/gusto_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bonusly/gusto_api
+  source_code_uri: https://github.com/bonusly/gusto_api
+  changelog_uri: https://github.com/bonusly/gusto_api/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A small wrapper around the Gusto API
+test_files: []