paylocity_web_service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 687fc5ccf711675bbc2b78b59ea4e14c17bb43299724e8df0c341824fe01d948
+  data.tar.gz: c73541d6298ba908050027f73a69dbcfa726ac21d5eedfdd37e7c19a0fbb3472
+SHA512:
+  metadata.gz: b31b8fee32111c963201c92c7404544a6baf3efd73d21bb3fba04faaa1570b411db3c95d99ef3f288e63e8968360c991216791ef9b11bae47d46ac092d24397e
+  data.tar.gz: 3074459e1e51a24a12b48b7835fcf4a5301f3a7b324101ff45639f70a86a0016cc45c315efbcf06fce33f7ce378f5d638b0db6db0d25da22ca8ff72c30b2e4d0

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,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at xiaorong.ruby@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# All dependencies from the gemspec and Gemfile will be installed by `bundle install`.
+# https://bundler.io/rubygems.html#using-bundler-while-developing-a-gem
+gemspec
+
+# The following gems are required for local development and will not be included by `gem install mygem` or `bundle add mygem`.
+group :development, :test do
+  gem 'awesome_print', require: 'ap'
+  gem 'pry-byebug'
+  gem 'rubocop'
+  gem 'rake'
+  gem 'bundler'
+  gem "rspec", "~> 3.0"
+  gem 'webmock', '~> 3.8', '>= 3.8.2'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ryan Lv
+
+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,101 @@
+![image](https://user-images.githubusercontent.com/1224077/118908609-53d82e00-b954-11eb-8392-91411d4de5e6.png)
+
+# Paylocity Ruby Gem
+
+Ruby toolkit for paylocity.com API.
+
+## REST APIs and documentation
+ 
+[Paylocity Web Service API Documentation](https://docs.paylocity.com/weblink/guides/Paylocity_Web_Services_API/Paylocity_Web_Services_API.htm#section/Overview)
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paylocity-ruby-gem'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install paylocity_web_service
+
+## Config the gem
+
+```ruby
+# config/initializers/paylocity.rb
+public_key = <<HEREDOC
+-----BEGIN PUBLIC KEY-----
+your public key
+-----END PUBLIC KEY-----
+HEREDOC
+
+
+PaylocityWebService.configure do |config|
+  config.client_id = 'your_client_id'
+  config.client_secret = 'your_client_secret' 
+  config.public_key = public_key
+end
+```
+
+## Making requests
+
+```ruby
+# Provide authentication credentials
+client = PaylocityWebService::Client.new(company_id: 'S2222')
+
+# retrieve all employees
+client.employees
+
+# get the employee by id
+client.employee(1)
+
+# create the employee
+client.create_employee(options={})
+
+# get the open api document of current company.
+client.company_schema
+```
+
+
+## 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 the created tag, 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/helloworld1812/paylocity-ruby-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+Here are some ways you can contribute:
+
+- by reporting bugs
+- by suggesting new features
+- by writing or editing documentation
+- by writing test case
+- by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
+- by refactoring code
+- by closing issues
+- by reviewing patches
+
+## 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 this project’s codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/wotc-ruby-gem/blob/master/CODE_OF_CONDUCT.md).
+
+## Reference
+
+**Good examples of API Wrapper**
+
+- [Octokit](https://github.com/octokit/octokit.rb/blob/master/lib/octokit/client.rb)
+- [Instagram](https://github.com/Instagram/instagram-ruby-gem/blob/master/lib/instagram/client.rb)
+- [Twitter](https://github.com/sferik/twitter/blob/master/lib/twitter/rest/api.rb)
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "paylocity_web_service"
+
+# Disable SSL verification
+OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+require 'pry'
+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/paylocity_web_service.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "paylocity_web_service/version"
+require_relative 'paylocity_web_service/error'
+require_relative 'paylocity_web_service/connection'
+require_relative 'paylocity_web_service/configuration'
+require_relative 'paylocity_web_service/authentication'
+require_relative 'paylocity_web_service/client'
+
+module PaylocityWebService
+  extend PaylocityWebService::Configuration
+
+  class << self
+    def client
+      @client || PaylocityWebService::Client.new(options)
+    end
+  end
+end

data/lib/paylocity_web_service/authentication.rb

@@ -0,0 +1,49 @@
+require 'json'
+require 'base64'
+require 'paylocity_web_service/cache'
+
+module PaylocityWebService
+  module Authentication
+    def access_token
+      token = PaylocityWebService::Cache.read(access_token_cache_key)
+
+      if token.nil?
+        refresh_token
+      else
+        token
+      end
+    end
+
+    def refresh_token
+      resp = Faraday.post(endpoint + '/IdentityServer/connect/token') do |req|
+        req.body = {
+          grant_type: 'client_credentials',
+          scope:      'WebLinkAPI'
+        }
+        req.headers = {
+          'Content-Type':   'application/x-www-form-urlencoded',
+          'Authorization':  "Basic #{ basic_auth_token }"
+        }
+      end
+
+
+      body = JSON.parse(resp.body)
+      token, expires_in = body['access_token'], body['expires_in']
+      PaylocityWebService::Cache.write(access_token_cache_key, token, expires_in)
+      token
+    end
+
+    def access_token_cache_key
+      'access_token_cache_key'
+    end
+
+    def basic_auth_token
+      secret_value = if client_secret.is_a?(Proc)
+                       client_secret.call
+                     else
+                       client_secret
+                     end
+      Base64.strict_encode64("#{ client_id }:#{ secret_value }")
+    end
+  end
+end

data/lib/paylocity_web_service/cache.rb

@@ -0,0 +1,25 @@
+module PaylocityWebService
+  class Cache
+    def self.read(key)
+      return if store[key].nil?
+      return if store[key][:expires_at].nil?
+      return if store[key][:value].nil?
+      return if store[key][:expires_at] < Time.now.to_i
+
+      store[key][:value]
+    end
+
+    def self.write(key, value, expires_in = 3600 )
+      expires_at = (Time.now.to_i + expires_in) - 60
+      store[key] = { value: value, expires_at: expires_at}
+    end
+
+    def self.store
+      @cache_store ||= {}
+    end
+
+    def self.flush!
+      @cache_store = {}
+    end
+  end
+end

data/lib/paylocity_web_service/client.rb

@@ -0,0 +1,27 @@
+require 'paylocity_web_service/connection'
+require 'paylocity_web_service/authentication'
+require 'paylocity_web_service/configuration'
+require 'paylocity_web_service/error'
+require 'paylocity_web_service/client/companies'
+require 'paylocity_web_service/client/employees'
+require 'paylocity_web_service/client/credentials'
+
+module PaylocityWebService
+  class Client
+    include PaylocityWebService::Authentication
+    include PaylocityWebService::Configuration
+    include PaylocityWebService::Connection
+    include PaylocityWebService::Encryption
+    include PaylocityWebService::Client::Employees
+    include PaylocityWebService::Client::Companies
+    include PaylocityWebService::Client::Credentials
+
+    def initialize(options={})
+      options = PaylocityWebService.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+  end
+end

data/lib/paylocity_web_service/client/companies.rb

@@ -0,0 +1,28 @@
+module PaylocityWebService
+  class Client
+    module Companies
+      CodeResources = %W(costcenter1 costcenter2 costcenter3 deductions earnings taxes paygrade positions)
+
+      def company_schema
+        get("/api/v2/companies/#{company_id}/openapi")
+      end
+
+      # Available Code Resources:
+      # - costcenter1
+      # - costcenter2
+      # - costcenter3
+      # - deductions
+      # - earnings
+      # - taxes
+      # - paygrade
+      # - positions
+      def company_codes(code_resource)
+        get("/api/v2/companies/#{company_id}/codes/#{code_resource}")
+      end
+
+      def code_resources
+        CodeResources
+      end
+    end
+  end
+end

data/lib/paylocity_web_service/client/credentials.rb

@@ -0,0 +1,9 @@
+module PaylocityWebService
+  class Client
+    module Credentials
+      def create_client_credential
+        post("/api/v2/credentials/secrets")
+      end
+    end
+  end
+end

data/lib/paylocity_web_service/client/employees.rb

@@ -0,0 +1,17 @@
+module PaylocityWebService
+  class Client
+    module Employees
+      def employees
+        get("/api/v2/companies/#{company_id}/employees/")
+      end
+
+      def employee(employee_id)
+        get("/api/v2/companies/#{company_id}/employees/#{employee_id}")
+      end
+
+      def create_employee(options={})
+        post("/api/v2/companies/#{company_id}/employees", options)
+      end
+    end
+  end
+end

data/lib/paylocity_web_service/configuration.rb

@@ -0,0 +1,86 @@
+module PaylocityWebService
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :client_id,
+      :client_secret,
+      :endpoint,
+      :public_key,
+      :company_id,
+      :proxy,
+      :ssl_verify_mode,
+      :format,
+      :connection_options,
+      :user_agent
+    ]
+
+    # By default, don't set a user access token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application ID
+    DEFAULT_CLIENT_ID = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CLIENT_SECRET = nil
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note There is no reason to use any other endpoint at this time
+    DEFAULT_ENDPOINT = 'https://apisandbox.paylocity.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, the ssl_verify_mode is true
+    DEFAULT_SSL_VERIFY_MODE = true
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "paylocity-ruby-gem #{PaylocityWebService::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset configuration options to default values
+    def reset
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.ssl_verify_mode    = DEFAULT_SSL_VERIFY_MODE
+
+      self
+    end
+  end
+end

data/lib/paylocity_web_service/connection.rb

@@ -0,0 +1,106 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'paylocity_web_service/authentication'
+require 'paylocity_web_service/encryption'
+require "paylocity_web_service/middleware/response/raise_error"
+
+module PaylocityWebService
+  # Network layer for API clients.
+  module Connection
+    include PaylocityWebService::Authentication
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @return [Sawyer::Resource]
+    def get(url)
+      request :get, url
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def patch(url, options = {})
+      request :patch, url, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def head(url, options = {})
+      request :head, url, options
+    end
+
+
+    private
+
+    def request(method, path, options = {})
+      response = connection.send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(URI.encode(path), options)
+        when :post, :put
+          request.path = URI.encode(path)
+          request.body = envelope_encrypt(options)
+        end
+      end
+
+      response
+    end
+
+    def connection
+      options = {
+        headers: {
+          'Accept' => "application/#{format}; charset=utf-8",
+          'User-Agent' => user_agent,
+          'Content-Type' => "application/#{format}"
+        },
+        proxy: proxy,
+        url: endpoint,
+      }.merge(connection_options)
+
+      connection = Faraday::Connection.new(options) do |conn|
+        conn.use Faraday::Request::Authorization, :Bearer, access_token
+        conn.request :retry, max: 2
+        conn.request :json
+
+        conn.use PaylocityWebService::Middleware::Response::RaiseError
+        conn.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+      end
+
+      connection
+    end
+  end
+end

data/lib/paylocity_web_service/encryption.rb

@@ -0,0 +1,32 @@
+require 'openssl'
+
+module PaylocityWebService
+  module Encryption
+    def envelope_encrypt(data)
+      # 1 generate data encryption key and IV.
+      aes = OpenSSL::Cipher::AES.new(256, :CBC)
+      aes.encrypt
+
+      key = aes.random_key
+      iv  = aes.random_iv
+
+      # 2. encrypt data use your data encryption key
+      encrypted_data = aes.update(data.to_json) + aes.final
+      encoded_data64 = Base64.strict_encode64(encrypted_data)
+
+      # 3. encrypt your key through the public key issued by paylocity
+      pub_key = OpenSSL::PKey::RSA.new(self.public_key)
+      encrypted_key64 = Base64.strict_encode64(pub_key.public_encrypt(key))
+      encoded_iv64   = Base64.strict_encode64(iv)
+
+      # 4. put together.
+      {
+        secureContent: {
+          key:      encrypted_key64,
+          iv:       encoded_iv64,
+          content:  encoded_data64
+        }
+      }
+    end
+  end
+end

data/lib/paylocity_web_service/error.rb

@@ -0,0 +1,122 @@
+module PaylocityWebService
+  class Error < StandardError
+    # Returns the appropriate PaylocityWebService::Error subclass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [PaylocityWebService::Error]
+    def self.from_response(response)
+      case response[:status]
+      when 400
+        raise PaylocityWebService::BadRequest, response_values(response)
+      when 401
+        raise PaylocityWebService::ClientError, response_values(response)
+      when 403
+        raise PaylocityWebService::Forbidden, response_values(response)
+      when 404
+        raise PaylocityWebService::NotFound, response_values(response)
+      when 405
+        raise PaylocityWebService::MethodNotAllowed, response_values(response)
+      when 406
+        raise PaylocityWebService::NotAcceptable, response_values(response)
+      when 409
+        raise PaylocityWebService::Conflict, response_values(response)
+      when 415
+        raise PaylocityWebService::UnsupportedMediaType, response_values(response)
+      when 422
+        raise PaylocityWebService::UnprocessableEntity, response_values(response)
+      when 451
+        raise PaylocityWebService::UnavailableForLegalReasons, response_values(response)
+      when 400..499
+        raise PaylocityWebService::ClientError, response_values(response)
+      when 500
+        raise PaylocityWebService::InternalServerError, response_values(response)
+      when 501
+        raise PaylocityWebService::NotImplemented, response_values(response)
+      when 502
+        raise PaylocityWebService::BadGateway, response_values(response)
+      when 503
+        raise PaylocityWebService::ServiceUnavailable, response_values(response)
+      when 500..599
+        raise PaylocityWebService::ServerError, response_values(response)
+      end
+    end
+
+    private
+
+    def self.response_values(response)
+      return nil if response.nil?
+
+      {
+        status: response.status,
+        headers: response.response_headers,
+        body: response.body,
+        request: {
+          method: response.method,
+          url_path: response.url.path,
+          params: response.params,
+          headers: response.request_headers,
+          body: response.request_body
+        }
+      }
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when returns a 414 HTTP status code
+  class UnsupportedMediaType < ClientError; end
+
+  # Raised when returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised when returns a 451 HTTP status code
+  class UnavailableForLegalReasons < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+
+  # Raised when client fails to provide valid Content-Type
+  class MissingContentType < ArgumentError; end
+
+  # Raised when client fails to provide a required key
+  class MissingKey < ArgumentError; end
+
+  # Raised when a method requires an application client_id
+  # and secret but none is provided
+  class ApplicationCredentialsRequired < StandardError; end
+end

data/lib/paylocity_web_service/middleware/response/raise_error.rb

@@ -0,0 +1,26 @@
+require 'paylocity_web_service/error'
+
+module PaylocityWebService
+  module Middleware
+    # Faraday response middleware
+    module Response
+
+      # This class raises an exception based
+      # HTTP status codes returned by the API
+      class RaiseError < Faraday::Response::Middleware
+
+        def initialize(app)
+          super app
+        end
+
+        def call(env)
+          @app.call(env).on_complete do |response|
+            if error = PaylocityWebService::Error.from_response(response)
+              raise error
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/paylocity_web_service/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PaylocityWebService
+  VERSION = "0.1.0"
+end

data/paylocity_web_service.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/paylocity_web_service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "paylocity_web_service"
+  spec.version       = PaylocityWebService::VERSION
+  spec.authors       = ["Ryan Lv"]
+  spec.email         = ["tech@workstream.is"]
+
+  spec.summary       = "Ruby wrapper for the API of Paylocity Web Service"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/helloworld1812/paylocity-ruby-gem"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/helloworld1812/paylocity-ruby-gem"
+  spec.metadata["changelog_uri"] = "https://github.com/helloworld1812/paylocity-ruby-gem/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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: paylocity_web_service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Lv
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-21 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Ruby wrapper for the API of Paylocity Web Service
+email:
+- tech@workstream.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paylocity_web_service.rb
+- lib/paylocity_web_service/authentication.rb
+- lib/paylocity_web_service/cache.rb
+- lib/paylocity_web_service/client.rb
+- lib/paylocity_web_service/client/companies.rb
+- lib/paylocity_web_service/client/credentials.rb
+- lib/paylocity_web_service/client/employees.rb
+- lib/paylocity_web_service/configuration.rb
+- lib/paylocity_web_service/connection.rb
+- lib/paylocity_web_service/encryption.rb
+- lib/paylocity_web_service/error.rb
+- lib/paylocity_web_service/middleware/request/.keep
+- lib/paylocity_web_service/middleware/response/raise_error.rb
+- lib/paylocity_web_service/version.rb
+- paylocity_web_service.gemspec
+homepage: https://github.com/helloworld1812/paylocity-ruby-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/helloworld1812/paylocity-ruby-gem
+  source_code_uri: https://github.com/helloworld1812/paylocity-ruby-gem
+  changelog_uri: https://github.com/helloworld1812/paylocity-ruby-gem/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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the API of Paylocity Web Service
+test_files: []