paychex 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 536525ed2919179c29274b85dc3556a8820192a7356642d441afa3810b9d6779
+  data.tar.gz: b0360d844bc9bf7a6e7dc74d1b9a0dd487c1164159e863adbadb912c3996dd16
+SHA512:
+  metadata.gz: c8041f078a3f9f7b1dec848a2e9848d5b5fadb9e071d8a534da2d4e30d1117e475b7ba6c50ca50665af3bc4b1be42dd8c56f1c6d5b07b1f1d618eb4a833c1161
+  data.tar.gz: 565beda31f91e267c9e7b4aa505499f97c49ae3835ceb6927abc9a39a4e7bfcdff115794c5448db8e55e68e882f5a90f1be38435dd2cc71469dfb7d0cac1ea8d

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/.rubocop.yml

@@ -0,0 +1,29 @@
+# inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.6.6
+  DisplayCopNames: true
+  Exclude:
+    - 'db/schema.rb'
+    - 'bin/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+# Metrics/BlockLength:
+#   Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/.travis.yml

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

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 mayankdedhia@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in paychex.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    paychex (0.1.0)
+      faraday
+      faraday_middleware
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    ruby2_keywords (0.0.2)
+    webmock (3.9.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.17)
+  byebug
+  paychex!
+  pry
+  rake (>= 12.3.3)
+  rspec (>= 3.9.0)
+  webmock
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mayank Dedhia
+
+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,132 @@
+# Paychex
+
+Ruby toolkit for [Paychex APIs](https://developer.paychex.com/api-documentation-and-exploration/api-references).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paychex'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install paychex
+
+## Usage
+
+```
+# Require the toolkit
+require "paychex"
+
+# Get an instance of Paychex::Client
+client = Paychex.client()
+
+# Before any other API call do call authorize
+client.authorize({
+  grant_type: "client_credentials",
+  client_id: "c22",
+  client_secret: "8f6a4213",
+})
+
+# Fetch all the linked commpanies
+client.linked_companies()
+
+# Fetch profile for individual company
+client.linked_company(company_id)
+
+# Fetch all workers associated with a company
+client.workers(company_id)
+
+# Fetch workers with pagination support
+client.workers(company_id, {
+  limit: 20,  # indicates total number of workers to be given in a response
+              # Un-documented on Paychex but limit value is capped at 20
+  offset: 0,  # zero based index to start showing workers
+              # if 5 is passed, the response will display from 6th worker
+})
+
+# Fetch a specific worker's profile
+client.worker(worker_id)
+
+# Fetch labor assignments for a company
+client.labor_assignments(company_id)
+
+# Fetch a specific labor assignment of a company
+client.labor_assignment(company_id, labor_assignment_id)
+
+# Fetch jobs for a company
+client.jobs(company_id)
+
+# Fetch a specific job of a company
+client.job(company_id, job_id)
+
+# Fetch locations for a company
+client.locations(company_id)
+
+# Fetch locations with asof option for a company
+client.locations(company_id, {
+  asof: "2019-01-18T00:00:00Z"  # This will give location/locations data for
+                                # that particular date.
+})
+
+# Fetch a specific location of a company
+client.location(company_id, location_id)
+# Sepcific location method can also be sent the option of asof like in
+# locations method.
+```
+
+Fetching of workers supports more options along with paginations. For more
+details refer to the [workers documentation](https://developer.paychex.com/api-documentation-and-exploration/api-references/workers).
+
+## 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).
+
+## Future
+
+- Pending collection APIs for workers
+  - Worker Job Titles
+
+- All other APIs which do inserts or updates.
+
+- Give all static dropdown options as collection or constants
+  - workerType
+  - employmentType
+  - exemptionType
+  - sex
+  - statusType
+  - statusReason - values are based on statusType
+  - legalIdType
+
+- Fix usage of application/x-www-form-urlencoded content type for auth
+- Make host and endpoint URLs support staging and production servers based on
+  environment configuration parameter
+- Handle token expiry by refreshing
+- Add support for auto-pagination and start using per_page configuration
+
+## Play Around
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Contributing
+
+Any Ruby code should go in the `lib` directory.
+Bug reports and pull requests are welcome on GitHub at https://github.com/helloworld1812/paychex. 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/helloworld1812/paychex/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 Paychex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/helloworld1812/paychex/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  # TODO: Check if following options work properly or not
+  task.rspec_opts = ["--color", "--format", "nested"]
+  task.verbose = false
+end
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,32 @@
+require 'faraday'
+
+module PaychexFaradayMiddleWare
+  class RaisePaychexHttpException < Faraday::Middleware
+    def initialize(app)
+      super(app)
+    end
+
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response.status.to_i
+        when 400
+          raise Paychex::BadRequest, response
+        when 401
+          raise Paychex::Unauthorized, response
+        when 403
+          raise Paychex::NoAccess, response
+        when 404
+          raise Paychex::NotFound, response
+        when 500
+          raise Paychex::InternalServerError, response
+        when 502
+          raise Paychex::BadGateway, response
+        when 503
+          raise Paychex::ServiceUnavailable, response
+        when 504
+          raise Paychex::GatewayTimeout, response
+        end
+      end
+    end
+  end
+end

data/lib/paychex/api.rb

@@ -0,0 +1,28 @@
+require "paychex/connection"
+require "paychex/request"
+require "paychex/configuration"
+
+module Paychex
+  class API
+    include Connection
+    include Request
+
+    attr_accessor *Paychex::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options = {})
+      options = Paychex.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+  end
+end

data/lib/paychex/client/auth.rb

@@ -0,0 +1,23 @@
+module Paychex
+  class Client
+    module Auth
+      # Authorize a client and get back a access token with expiry.
+      def authorize(options = {})
+        response = auth('auth/oauth/v2/token', options)
+        if response.body.is_a?(Hash) && response.body['access_token']
+          self.access_token = response.body['access_token']
+          self.token_timeout = Time.new + response.body['expires_in']
+          response
+        else
+          # raise error when token is missing.
+          raise Paychex::BadRequest, response
+        end
+      end
+
+      # Indicates expiry of the auth token
+      def token_expired?
+        token_timeout < Time.new
+      end
+    end
+  end
+end

data/lib/paychex/client/companies.rb

@@ -0,0 +1,77 @@
+module Paychex
+  class Client
+    module Companies
+      # Get a list of all the linked companies
+      def linked_companies
+        get('companies')
+      end
+
+      # Get profile of a linked company
+      def linked_company(company_id)
+        get("companies/#{company_id}")
+      end
+
+      # Get company's linked status
+      def company_status(company_id)
+        begin
+          content = linked_company(company_id).body.fetch('content')
+          return 'linked' if content[0]&.fetch('companyId') == company_id
+        rescue Paychex::NoAccess => e
+          return 'not-linked'
+        rescue Paychex::NotFound => e
+          return 'invalid'
+        rescue StandardError => e
+          p 'Paychex Gem: Handle more errors'
+          p e
+        end
+        'unsupported'
+      end
+
+      def details_by_display_id(display_id)
+        begin
+          content = linked_companies.body.fetch('content')
+          company = content.find { |company| company.fetch('displayId') == display_id }
+          return {
+            "company": company,
+            "message": company.nil? ? 'not-found' : 'found'
+          }
+        rescue Paychex::NoAccess => e
+          return {
+            "company": nil,
+            "message": 'unknown'
+          }
+        rescue StandardError => e
+          p 'Paychex Gem: Handle more errors'
+          p e
+        end
+        {
+          "company": nil,
+          "message": 'unsupported'
+        }
+      end
+
+      def details_by_display_ids(display_ids)
+        ret = {}
+        begin
+          content = linked_companies.body.fetch('content')
+          display_ids.each do |display_id|
+            company = content.find { |company| company.fetch('displayId') == display_id }
+            ret[display_id.to_s] = {
+              "company": company,
+              "message": company.nil? ? 'not-found' : 'found'
+            }
+          end
+          return ret
+        rescue Paychex::NoAccess => e
+          ret['message'] = 'unknown'
+          return ret
+        rescue StandardError => e
+          p 'Paychex Gem: Handle more errors'
+          p e
+        end
+        ret['message'] = 'unsupported'
+        ret
+      end
+    end
+  end
+end

data/lib/paychex/client/direct_deposit.rb

@@ -0,0 +1,20 @@
+module Paychex
+  class Client
+    module DirectDeposit
+      # Get the worker's all direct deposit details
+      def direct_deposits(worker_id)
+        get("workers/#{worker_id}/directdeposits")
+      end
+
+      # Get a worker's specific direct deposit details
+      def direct_deposit(worker_id, direct_deposit_id)
+        get("workers/#{worker_id}/directdeposits/#{direct_deposit_id}")
+      end
+
+      # Add a worker's direct deposit details
+      def add_direct_deposit(worker_id, options = {})
+        post("workers/#{worker_id}/directdeposits", options)
+      end
+    end
+  end
+end

data/lib/paychex/client/federal_tax.rb

@@ -0,0 +1,15 @@
+module Paychex
+  class Client
+    module FederalTax
+      # Get a specific worker's federal tax
+      def federal_tax(worker_id)
+        get("workers/#{worker_id}/federaltax")
+      end
+
+      # Add a worker's federal tax
+      def add_federal_tax(worker_id, options = {})
+        post("workers/#{worker_id}/federaltax", options)
+      end
+    end
+  end
+end

data/lib/paychex/client/job_titles.rb

@@ -0,0 +1,15 @@
+module Paychex
+  class Client
+    module JobTitles
+      # Get a list of the job titles for a company
+      def job_titles(company_id)
+        get("companies/#{company_id}/jobtitles")
+      end
+
+      # Get a specific job title's details
+      def job_title(company_id, job_title_id)
+        get("companies/#{company_id}/jobtitles/#{job_title_id}")
+      end
+    end
+  end
+end

data/lib/paychex/client/jobs.rb

@@ -0,0 +1,15 @@
+module Paychex
+  class Client
+    module Jobs
+      # Get a list of the jobs for a company
+      def jobs(company_id)
+        get("companies/#{company_id}/jobs")
+      end
+
+      # Get a specific job's details
+      def job(company_id, job_id)
+        get("companies/#{company_id}/jobs/#{job_id}")
+      end
+    end
+  end
+end

data/lib/paychex/client/labor_assignments.rb

@@ -0,0 +1,15 @@
+module Paychex
+  class Client
+    module LaborAssignments
+      # Get a list of the labor assignments for a company
+      def labor_assignments(company_id)
+        get("companies/#{company_id}/laborassignments")
+      end
+
+      # Get a specific labor assignment's details
+      def labor_assignment(company_id, labor_assignment_id)
+        get("companies/#{company_id}/laborassignments/#{labor_assignment_id}")
+      end
+    end
+  end
+end

data/lib/paychex/client/locations.rb

@@ -0,0 +1,15 @@
+module Paychex
+  class Client
+    module Locations
+      # Get a list of the locations for a company
+      def locations(company_id, options = {})
+        get("companies/#{company_id}/locations")
+      end
+
+      # Get a specific location's details
+      def location(company_id, location_id, options = {})
+        get("companies/#{company_id}/locations/#{location_id}")
+      end
+    end
+  end
+end

data/lib/paychex/client/organizations.rb

@@ -0,0 +1,15 @@
+module Paychex
+  class Client
+    module Organizations
+      # Get a list of the organizations for a company
+      def organizations(company_id)
+        get("companies/#{company_id}/organizations")
+      end
+
+      # Get a specific organization's details
+      def organization(company_id, organization_id)
+        get("companies/#{company_id}/organizations/#{organization_id}")
+      end
+    end
+  end
+end

data/lib/paychex/client/pay_rates.rb

@@ -0,0 +1,20 @@
+module Paychex
+  class Client
+    module PayRates
+      # Get a list of compensation rates for a worker
+      def pay_rates(worker_id)
+        get("workers/#{worker_id}/compensation/payrates")
+      end
+
+      # Get a worker's specific compensation rate
+      def pay_rate(worker_id, pay_rate_id)
+        get("workers/#{worker_id}/compensation/payrates/#{pay_rate_id}")
+      end
+
+      # Add a worker's pay rate
+      def add_pay_rate(worker_id, options = {})
+        post("workers/#{worker_id}/compensation/payrates", options)
+      end
+    end
+  end
+end

data/lib/paychex/client/workers.rb

@@ -0,0 +1,40 @@
+module Paychex
+  class Client
+    module Workers
+      # Get a list of the workers of the company
+      def workers(company_id, options = {})
+        get("companies/#{company_id}/workers", options)
+      end
+
+      # Get a specific worker's profile
+      def worker(worker_id, options = {})
+        get("workers/#{worker_id}", options)
+      end
+
+      # Create a worker
+      def create_worker(company_id, options = {})
+        post("companies/#{company_id}/workers", options)
+      end
+
+      def remove_worker(worker_id, options = {})
+        delete("workers/#{worker_id}", options)
+      end
+
+      # Get company's linked status
+      def worker_status(company_id, worker_id)
+        begin
+          content = workers(company_id).body.fetch('content')
+          return 'valid' if content.one?{ |worker| worker.fetch('workerId') == worker_id }
+        rescue Paychex::NoAccess => e
+          return 'not-linked'
+        rescue Paychex::NotFound => e
+          return 'invalid'
+        rescue StandardError => e
+          p 'Paychex Gem: Handle more errors'
+          p e
+        end
+        'unsupported'
+      end
+    end
+  end
+end

data/lib/paychex/client.rb

@@ -0,0 +1,35 @@
+require 'paychex/api'
+
+module Paychex
+  # Wrapper for the Paychex REST API
+  #
+  # @note All methods have been separated into modules for better management.
+  # @see https://developer.paychex.com/api-documentation-and-exploration/api-references
+  class Client < Paychex::API
+    require 'paychex/client/auth'
+    require 'paychex/client/companies'
+    require 'paychex/client/workers'
+    require 'paychex/client/jobs'
+    require 'paychex/client/job_titles'
+    require 'paychex/client/locations'
+    require 'paychex/client/labor_assignments'
+    require 'paychex/client/pay_rates'
+    require 'paychex/client/federal_tax'
+    require 'paychex/client/direct_deposit'
+    require 'paychex/client/organizations'
+
+    include Paychex::Client::Auth
+    include Paychex::Client::Companies
+    include Paychex::Client::Workers
+    include Paychex::Client::Jobs
+    include Paychex::Client::JobTitles
+    include Paychex::Client::Locations
+    include Paychex::Client::LaborAssignments
+    include Paychex::Client::PayRates
+    include Paychex::Client::FederalTax
+    include Paychex::Client::DirectDeposit
+    include Paychex::Client::Organizations
+
+    attr_accessor :token_timeout
+  end
+end

data/lib/paychex/configuration.rb

@@ -0,0 +1,98 @@
+require "paychex/version"
+
+module Paychex
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Paychex::API}
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :host,
+      :endpoint,
+      :format,
+      :connection_options,
+      :proxy,
+      :environment,
+      :user_agent,
+      :per_page,
+      :timeout,
+      :open_timeout,
+      :token_timeout,
+    ].freeze
+
+    # By default, don't set an access_token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # By default, return 20 resources per page when there is an pagination.
+    DEFAULT_PER_PAGE = 20
+
+    # By default, don't set connection options.
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # Default timeout time is 20 seconds
+    DEFAULT_TIMEOUT = 20
+
+    # By default, the open timeout is 20 seconds.
+    DEFAULT_OPEN_TIMEOUT = 20
+
+    DEFAULT_TOKEN_TIMEOUT = Time.new
+
+    # By default, use sandbox environment
+    DEFAULT_HOST = "https://sandbox.api.paychex.com".freeze
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = "https://sandbox.api.paychex.com/".freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # By default, environment will be sandbox
+    DEFAULT_ENVIRONMENT = "sandbox"
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Paychex Ruby Gem #{Paychex::VERSION}".freeze
+
+    # An array of valid request/response formats
+    VALID_FORMATS = [:json].freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.access_token = DEFAULT_ACCESS_TOKEN
+      self.host = DEFAULT_HOST
+      self.endpoint = DEFAULT_ENDPOINT
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.format = DEFAULT_FORMAT
+      self.proxy = DEFAULT_PROXY
+      self.environment = DEFAULT_ENVIRONMENT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.per_page = DEFAULT_PER_PAGE
+      self.timeout = DEFAULT_TIMEOUT
+      self.open_timeout = DEFAULT_OPEN_TIMEOUT
+      self.token_timeout = DEFAULT_TOKEN_TIMEOUT
+    end
+  end
+end

data/lib/paychex/connection.rb

@@ -0,0 +1,31 @@
+require 'faraday_middleware'
+require 'faraday/raise_paychex_http_exception'
+
+module Paychex
+  module Connection
+    private
+
+    def connection
+      options = {
+        headers: {
+          'Accept' => "application/#{format}; charset=utf-8",
+          'User-Agent' => user_agent
+        },
+        proxy: proxy,
+        url: endpoint
+      }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |conn|
+        conn.authorization :Bearer, access_token unless access_token.nil?
+        # https://github.com/lostisland/faraday/issues/417#issuecomment-223413386
+        conn.options[:timeout] = timeout
+        conn.options[:open_timeout] = open_timeout
+        conn.request :json
+
+        conn.use ::PaychexFaradayMiddleWare::RaisePaychexHttpException
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/paychex/error.rb

@@ -0,0 +1,61 @@
+module Paychex
+  # Custom error class for rescuing from all paychex errors
+  class Error < StandardError
+    attr_reader :http_method, :url, :errors, :response, :raw_errors
+
+    def initialize(response)
+      super
+      @response = response.dup
+      @http_method = response.method.to_s
+      @url = response.url
+      @raw_errors = response.body.fetch('errors') if response.body.is_a?(Hash) && !response.body.empty? && !response.body.fetch('errors', nil).nil?
+    end
+
+    def message
+      <<-HEREDOC
+        URL: #{@response.url}
+        method: #{@response.method}
+        response status: #{@response.status}
+        response body: #{@response.response.body}
+      HEREDOC
+    end
+
+    def error_sentence
+      return if @raw_errors.nil?
+
+      array = []
+      @raw_errors.each do |v|
+        array += "#{v['code']}: #{v['description']}, #{v['resolution']}"
+      end
+
+      array.join(' ')
+    end
+  end
+
+  # Raised when api.paychex.com returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when api.paychex.com returns the HTTP status code 401
+  class Unauthorized < Error; end
+
+  # Raised when api.paychex.com returns the HTTP status code 403
+  class NoAccess < Error; end
+
+  # Raised when api.paychex.com returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when api.paychex.com returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when api.paychex.com returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when api.paychex.com returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when api.paychex.com returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+
+  # Raised when client fails to provide required parameters.
+  class MissingRequiredArgument < Error; end
+end

data/lib/paychex/request.rb

@@ -0,0 +1,54 @@
+require 'uri'
+require 'base64'
+
+module Paychex
+  # Defines HTTP request methods
+  module Request
+    # HTTP GET request
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    # HTTP POST request
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    # HTTP PUT request
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    # HTTP DELETE request
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    def auth(path, options = {})
+      options['Content-Type'] = 'application/x-www-form-urlencoded'
+      request(:post, path, options)
+    end
+
+    private
+
+    def request(method, path, options)
+      encoded_path = Addressable::URI.escape(path)
+      connection.send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(encoded_path, options)
+        # TODO: Need to test for more post and put requests
+        when :post, :put
+          request.path = encoded_path
+          content_type = options.delete('Content-Type')
+          if content_type == 'application/x-www-form-urlencoded'
+            request.headers['Content-Type'] = content_type
+            request.body = URI.encode_www_form(options)
+          else
+            request.body = options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/paychex/version.rb

@@ -0,0 +1,3 @@
+module Paychex
+  VERSION = '0.1.1'
+end

data/lib/paychex.rb

@@ -0,0 +1,27 @@
+require 'paychex/configuration'
+require 'paychex/error'
+require 'paychex/api'
+require 'paychex/client'
+
+module Paychex
+  extend Configuration
+
+  # Alias for Paychex::Client.new
+  #
+  # @return [Paychex::Client]
+  def self.client(options = {})
+    ::Paychex::Client.new(options)
+  end
+
+  # Delegate to Paychex::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Paychex::Client
+  def self.respond_to?(method, include_all = false)
+    client.respond_to?(method, include_all) || super
+  end
+end

data/paychex.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paychex/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'paychex'
+  spec.version = Paychex::VERSION
+  spec.authors = ['Mayank Dedhia']
+  spec.email = ['mayankdedhia@gmail.com']
+
+  spec.summary = 'Ruby wrapper for paychex.com APIs.'
+  spec.description = "A Ruby wrapper for paychex.com REST APIs which will make \
+    it easy to interact with Paychex."
+  spec.homepage = 'https://github.com/helloworld1812/paychex-ruby-gem'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # Currently no push is allowed
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/helloworld1812/paychex-ruby-gem'
+  spec.metadata['changelog_uri'] = 'https://github.com/helloworld1812/paychex-ruby-gem/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(__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_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '>= 3.9.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_runtime_dependency 'addressable'
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: paychex
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mayank Dedhia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: 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: pry
+  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: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.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'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: A Ruby wrapper for paychex.com REST APIs which will make     it easy
+  to interact with Paychex.
+email:
+- mayankdedhia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/faraday/raise_paychex_http_exception.rb
+- lib/paychex.rb
+- lib/paychex/api.rb
+- lib/paychex/client.rb
+- lib/paychex/client/auth.rb
+- lib/paychex/client/companies.rb
+- lib/paychex/client/direct_deposit.rb
+- lib/paychex/client/federal_tax.rb
+- lib/paychex/client/job_titles.rb
+- lib/paychex/client/jobs.rb
+- lib/paychex/client/labor_assignments.rb
+- lib/paychex/client/locations.rb
+- lib/paychex/client/organizations.rb
+- lib/paychex/client/pay_rates.rb
+- lib/paychex/client/workers.rb
+- lib/paychex/configuration.rb
+- lib/paychex/connection.rb
+- lib/paychex/error.rb
+- lib/paychex/request.rb
+- lib/paychex/version.rb
+- paychex.gemspec
+homepage: https://github.com/helloworld1812/paychex-ruby-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/helloworld1812/paychex-ruby-gem
+  source_code_uri: https://github.com/helloworld1812/paychex-ruby-gem
+  changelog_uri: https://github.com/helloworld1812/paychex-ruby-gem/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.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for paychex.com APIs.
+test_files: []