wotc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c55912e173441fafde565727cfea98101a699ee28b0f3b949a9949f7730cab2b
+  data.tar.gz: 69abcb3adee7d97d0832c4a4b6b26d5d316b1940f4bd26bb8b4bfe87c8761664
+SHA512:
+  metadata.gz: a72f369eb59c4deeeecaf6b6cc5a69cb2420d685745a8edf2a7e2dd38c1710d29b219754c329c445585d4d93052cd5fc4bf530a9ee06060a6a7302e729fd86db
+  data.tar.gz: a428af1f1dd944dbe1509b86e19c45dd51a0439131e02f13bb8184ca8078884935e2ede71956a26379ca4297183d7cada0a72efe205cf7347e7558233b87fc41

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build wotc-ruby-gem-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated file" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install wotc-ruby-gem-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install wotc-ruby-gem-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push wotc-ruby-gem-0.1.0.gem to TODO: Set to 'http://mygemserver.com'" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run tests" fullCmd="test" taksId="test" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.3

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 xiaorong.ruby@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://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 wotc-ruby-gem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 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,83 @@
+![WOTC_logo_header-02](https://user-images.githubusercontent.com/1224077/79107910-d97bc880-7da7-11ea-95a3-40be03be614c.png)
+
+# wotc-ruby-gem
+
+Ruby toolkit for wotc.com API
+
+## wotc.com REST APIs and documentation
+
+1. Go to the [developer site](https://sandbox.wotc.com/portal/api/documentation) of wotc.com and create an sandbox account.
+2. create an access token in the [integration console](https://sandbox.wotc.com/portal/client/account/integrations#show-access-token).
+
+## quick start
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wotc-ruby-gem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wotc-ruby-gem
+
+## Usage Examples
+
+```
+# Provide authentication credential
+client = WOTC::Client.new(access_token: 'your access token')
+
+# Fetch the employees of current commpany
+client.employees
+
+# fetch the settings of a company
+client.get_company_settings
+
+# list all webhooks of a company
+client.webhooks
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/helloworld1812/wotc-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 the Wotc::Ruby::Gem project’s codebases, 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,34 @@
+require 'faraday'
+
+module FaradayMiddleWare
+  class RaiseHttpException < 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 WOTC::BadRequest, error_message(env)
+        when 404
+          raise WOTC::NotFound, error_message(env)
+        when 500
+          raise WOTC::InternalServerError, error_message(env)
+        when 502
+          raise WOTC::BadGateway, error_message(env)
+        when 503
+          raise WOTC::ServiceUnavailable, error_message(env)
+        when 504
+          raise WOTC::GatewayTimeout, error_message(env)
+        end
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "\nURL: #{env.url}\nmethod: #{env.method} \nstatus: #{env.status}\nerrors: #{env.response.body}"
+    end
+  end
+end

data/lib/wotc.rb

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

data/lib/wotc/api.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../configuration', __FILE__)
+
+module WOTC
+  class API
+    include Connection
+    include Request
+
+    attr_accessor *WOTC::Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = WOTC.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/wotc/client.rb

@@ -0,0 +1,20 @@
+module WOTC
+  # Wrapper for the WOTC REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in https://sandbox.wotc.com/portal/api/documentation
+  # @see https://sandbox.wotc.com/portal/api/documentation
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{ |f| require f }
+
+    include WOTC::Client::Employees
+    include WOTC::Client::Applicants
+    include WOTC::Client::Companies
+    include WOTC::Client::Documents
+    include WOTC::Client::Payrolls
+    include WOTC::Client::Locations
+    include WOTC::Client::Webhooks
+    include WOTC::Client::Users
+    include WOTC::Client::Registers
+    include WOTC::Client::Wotcs
+  end
+end

data/lib/wotc/client/applicants.rb

@@ -0,0 +1,32 @@
+module WOTC
+  class Client
+    # Defines methods related to applicants.
+    module Applicants
+      # Get as list of applicants
+      def applicants(options={})
+        paginate("applicants", options)
+      end
+
+      # Create an applicant
+      def create_applicant(options)
+        post('applicants', options)
+      end
+
+      # Update an applicant
+      def update_applicant(applicant_id, options={})
+        put("applicants/#{applicant_id}", options)
+      end
+
+      # TODO: boolean response
+      # Delete an applicant
+      def delete_applicant(applicant_id)
+        delete("applicants/#{applicant_id}")
+      end
+
+      # Get as of applicants whose WOTC status has changed in the last 24 hours.
+      # def recent_status_changed_applicants
+      #   get("applicants/changes/wotc/status")
+      # end
+    end
+  end
+end

data/lib/wotc/client/companies.rb

@@ -0,0 +1,25 @@
+module WOTC
+  class Client
+    # Defines methods related to companies
+    module Companies
+
+      # Get company settings, if there are no settings saved, anempty response if given.
+      def get_company_settings(company_id=nil)
+        if company_id.nil?
+          get("company/settings")
+        else
+          get("company/settings/?company_id=#{company_id}")
+        end
+      end
+
+      # Update company settings
+      def update_company_settings(company_id=nil, options={})
+        if company_id.nil?
+          put("company/settings", options)
+        else
+          put("company/settings?company_id=#{company_id}", options)
+        end
+      end
+    end
+  end
+end

data/lib/wotc/client/documents.rb

@@ -0,0 +1,22 @@
+module WOTC
+  class Client
+    # Defines methods related to documents
+    module Documents
+
+      # Upload a document
+      # def upload_document
+      #
+      # end
+
+      # Update a document
+      # def update_document
+      #
+      # end
+
+      # List documents
+      def all_documents(options={})
+        paginate("documents", options)
+      end
+    end
+  end
+end

data/lib/wotc/client/employees.rb

@@ -0,0 +1,50 @@
+module WOTC
+  class Client
+    # Defines methods related to employees.
+    module Employees
+      # Fetch all employees
+      def employees(options={})
+        paginate("employees", options)
+      end
+
+      # Get a single employee
+      def employee(employee_id)
+        get("employees/#{employee_id}")
+      end
+
+      # Update an employee
+      def update_employee(employee_id, options={})
+        put("employees/#{employee_id}", options)
+      end
+
+      # Create an employee
+      def create_employee(options={})
+        post("employees", options)
+      end
+
+      # Get employee's WOTC status
+      def employee_wotc_status(employee_id)
+        get("employees#{employee_id}/wotc/status")
+      end
+
+      # Get wotc info for specific employee
+      def employee_wotc_info(employee_id)
+        get("employees/#{employee_id}/wotc")
+      end
+
+      # Generate an auto fill WOTC url
+      def employee_auto_fill_wotc_url(employee_id)
+        get("employees/#{employee_id}/wotc/url")
+      end
+
+      # Get employees with certified WOTC status
+      def certified_employees(company_id=nil)
+        if company_id.nil?
+          get("employees/wotc/certified")
+        else
+          get("employees/wotc/certified?company_id=#{company_id}")
+        end
+      end
+    end
+  end
+end

data/lib/wotc/client/locations.rb

@@ -0,0 +1,23 @@
+module WOTC
+  class Client
+    # Defines methods related to locations
+    module Locations
+      # Get all locations
+      def all_locations
+        get("locations")
+      end
+
+      def create_location(options={})
+        post("locations", options)
+      end
+
+      def update_location(options={})
+        put("locations", options)
+      end
+
+      def delete_location(location_id)
+        delete("locations/#{location_id}")
+      end
+    end
+  end
+end

data/lib/wotc/client/payrolls.rb

@@ -0,0 +1,28 @@
+module WOTC
+  class Client
+    # Defines methods related to payrolls.
+    module Payrolls
+      # Get as list of hours and wages
+      def all_payrolls(options={})
+        paginate("hours-wages")
+      end
+
+      # Create a payroll record
+      def create_payroll(options={})
+        post("hours-wages", options)
+      end
+
+      # THIS API IS UNSTABLE!
+      # Get as list of hours and wages by employee record
+      # def employee_payrolls(employee_id, options={})
+      #   get("employees/#{employee_id}/hours-wages")
+      # end
+
+      # Update a payroll record
+      def update_payroll(payroll_id, options={})
+        put("hours-wages/#{payroll_id}")
+      end
+
+    end
+  end
+end

data/lib/wotc/client/registers.rb

@@ -0,0 +1,11 @@
+module WOTC
+  class Client
+    module Registers
+
+      # Register for an account and get back a life time access token.
+      def register(options)
+        post("register", options)
+      end
+    end
+  end
+end

data/lib/wotc/client/users.rb

@@ -0,0 +1,12 @@
+module WOTC
+  class Client
+    # Defines methods related to users.
+    module Users
+
+      # Get authorized user information.
+      def current_user
+        get('user')
+      end
+    end
+  end
+end

data/lib/wotc/client/webhooks.rb

@@ -0,0 +1,26 @@
+module WOTC
+  class Client
+    # Defines methods related to webhooks.
+    module Webhooks
+      # List company webhooks
+      def webhooks(options={})
+        paginate('webhooks')
+      end
+
+      # Create a webhook
+      def create_webhook(options = {})
+        post('webhooks', options)
+      end
+
+      # Update a webhook
+      def update_webhook(webhook_id, options = {})
+        put("webhooks/#{webhook_id}", options)
+      end
+
+      # Delete a webhook
+      def delete_webhook(webhook_id)
+        delete("webhooks/#{webhook_id}")
+      end
+    end
+  end
+end

data/lib/wotc/client/wotcs.rb

@@ -0,0 +1,8 @@
+module WOTC
+  class Client
+    # Defines methods related to users.
+    module Wotcs
+      #TODO
+    end
+  end
+end

data/lib/wotc/configuration.rb

@@ -0,0 +1,88 @@
+require 'faraday'
+
+module WOTC
+# Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {WOTC::API}
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :adapter,
+      :connection_options,
+      :endpoint,
+      :format,
+      :proxy,
+      :user_agent,
+      :auto_paginate,
+      :per_page,
+    ].freeze
+
+    # By default, don't set an access token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # By default, enable auto-paginate
+    DEFAULT_AUTO_PAGINATE = true
+
+    # By default, return 20 resources per page when there is an pagination.
+    DEFAULT_PER_PAGE = 20
+
+    # 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 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://sandbox.wotc.com/portal/api/v1/'.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
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "WOTC Ruby Gem #{WOTC::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.adapter            = DEFAULT_ADAPTER
+      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.auto_paginate      = DEFAULT_AUTO_PAGINATE
+      self.per_page           = DEFAULT_PER_PAGE
+    end
+  end
+end

data/lib/wotc/connection.rb

@@ -0,0 +1,30 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module WOTC
+  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
+        conn.request :json
+
+        conn.use FaradayMiddleWare::RaiseHttpException
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end
+

data/lib/wotc/error.rb

@@ -0,0 +1,25 @@
+module WOTC
+  # Custom error class for rescuing from all wotc.com errors
+  class Error < StandardError; end
+
+  # Raised when wotc.com returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when wotc.com returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when wotc.com returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when wotc.com returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when wotc.com returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when wotc.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/wotc/request.rb

@@ -0,0 +1,64 @@
+require 'base64'
+
+module WOTC
+  # 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
+
+    private
+
+    # Auto-pagination for HTTP get.
+    # return all resources when auto_paginate is set true.
+    # return just one page when auto_paginate is set false.
+    def paginate(path, options={})
+      per_page = options[:per_page] || options["per_page"] || @per_page
+      page = options[:page] || options["page"]
+      response = get(path+"?page=1&per_page=#{per_page}")
+
+      # return one page results without pagination.
+      return response if !@auto_paginate
+
+      # return all results when enabled auto paginate
+      last_response = response.dup
+      data = response["data"]
+      while last_response["next_page_url"]
+        last_response = get(last_response["next_page_url"] + "&per_page=#{per_page}")
+        data.concat(last_response["data"]) if last_response["data"].is_a?(Array)
+      end
+
+      return data
+    end
+
+    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 = options
+        end
+      end
+
+      return response.body
+    end
+  end
+end

data/lib/wotc/version.rb

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

data/wotc.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "wotc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wotc"
+  spec.version       = WOTC::VERSION
+  spec.authors       = ["workstream.us"]
+  spec.email         = ["ryan@workstream.is"]
+
+  spec.summary       = %q{Ruby wrapper for wotc.com APIs}
+  spec.description   = %q{An Ruby wrapper for wotc.com REST APIs}
+  spec.homepage      = "https://github.com/helloworld1812/wotc-ruby-gem"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # 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/wotc-ruby-gem"
+    spec.metadata["changelog_uri"] = "https://github.com/helloworld1812/wotc-ruby-gem/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: wotc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- workstream.us
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-13 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.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: 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: 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'
+description: An Ruby wrapper for wotc.com REST APIs
+email:
+- ryan@workstream.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/faraday/raise_http_exception.rb
+- lib/wotc.rb
+- lib/wotc/api.rb
+- lib/wotc/client.rb
+- lib/wotc/client/applicants.rb
+- lib/wotc/client/companies.rb
+- lib/wotc/client/documents.rb
+- lib/wotc/client/employees.rb
+- lib/wotc/client/locations.rb
+- lib/wotc/client/payrolls.rb
+- lib/wotc/client/registers.rb
+- lib/wotc/client/users.rb
+- lib/wotc/client/webhooks.rb
+- lib/wotc/client/wotcs.rb
+- lib/wotc/configuration.rb
+- lib/wotc/connection.rb
+- lib/wotc/error.rb
+- lib/wotc/request.rb
+- lib/wotc/version.rb
+- wotc.gemspec
+homepage: https://github.com/helloworld1812/wotc-ruby-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/helloworld1812/wotc-ruby-gem
+  source_code_uri: https://github.com/helloworld1812/wotc-ruby-gem
+  changelog_uri: https://github.com/helloworld1812/wotc-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for wotc.com APIs
+test_files: []