paychex_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 758c001f0cf47cdd37c2e59088fbba2a9ffa8c2e
+  data.tar.gz: bde50ccd01aeb9f777074b41ac4fd766cb893437
+SHA512:
+  metadata.gz: 005a408302d26519b98a7cfcb04b602d1290e452cebf794880f14350626c3e6983ce0d8fb3b54ba90b698f1d0f2814ed0b25c132c972acc48974c77cd9e09be0
+  data.tar.gz: fa0bb1560f60452e3220bd045a2bf383660de76fa5d8436d497ec1cdcab92b0baea68070e823c94e7192c275c4dba06c7d8b51046e1a64abb8ddc89a18beba0b

data/.gitignore

@@ -0,0 +1,7 @@
+
+/.*.iml
+.idea/
+bridge_api.iml
+.byebug.*
+.byebug_history
+.*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    bridge_api (0.0.1)
+      faraday (~> 0.9.0)
+      faraday_middleware (~> 0.9.0)
+      footrest (>= 0.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (8.2.5)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.2)
+      faraday (>= 0.7.4, < 0.10)
+    footrest (0.5.1)
+      activesupport (>= 3.0.0)
+      faraday (~> 0.9.0)
+      link_header (>= 0.0.7)
+    hashdiff (0.3.7)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    link_header (0.0.8)
+    method_source (0.9.0)
+    minitest (5.11.1)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.1)
+    rack (1.6.8)
+    rack-protection (1.5.3)
+      rack
+    rake (0.9.6)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    safe_yaml (1.0.4)
+    sinatra (1.4.8)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    thread_safe (0.3.6)
+    tilt (1.4.1)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bridge_api!
+  bundler (~> 1.0, >= 1.0.0)
+  byebug (~> 8.2.2)
+  pry (~> 0)
+  rake (~> 0)
+  rspec (~> 2.6)
+  sinatra (~> 1.0)
+  tilt (~> 1.3, >= 1.3.4)
+  webmock (~> 1.22.6)
+
+BUNDLED WITH
+   1.16.0

data/lib/paychex_api.rb

@@ -0,0 +1,2 @@
+require 'paychex_api/version'
+require 'paychex_api/client'

data/lib/paychex_api/api_array.rb

@@ -0,0 +1,143 @@
+
+module PaychexAPI
+  class ApiArray
+    include Enumerable
+
+    @next_page = nil
+    @prev_page = nil
+
+    attr_reader :status, :headers, :members, :links, :metadata, :members
+
+    def self.process_response(response, api_client)
+      ApiArray.new(response, api_client)
+    end
+
+    def initialize(response, api_client)
+      @meta_fields = %w(metadata links)
+      @api_client = api_client
+      @links = []
+      @metadata = {}
+      case response.status
+        when *((200..206).to_a + [302])
+          apply_response_metadata(response)
+          @members = get_response_content(response)
+      end
+    end
+
+    def length
+      @members.length
+    end
+
+    def [](i)
+      @members[i]
+    end
+
+    def last
+      @members.last
+    end
+
+    def each(&block)
+      @members.each { |member| block.call(member) }
+    end
+
+    def pages?
+      !@next_page.nil?
+    end
+
+    def next_page
+      load_page(@next_page)
+    end
+
+    def each_page(&block)
+      block.call(@members, @linked, @meta)
+      while @next_page
+        response = get_page(@next_page)
+        apply_response_metadata(response, false)
+        @members = get_response_content(response)
+        block.call(@members, @linked, @meta)
+      end
+      @link_hash = {}
+    end
+
+    def all_pages!
+      if pages?
+        response = get_page(@next_page)
+        apply_response_metadata(response)
+        @members.concat(get_response_content(response))
+        while @next_page
+          response = get_page(@next_page)
+          apply_response_metadata(response)
+          @members.concat(get_response_content(response))
+        end
+      end
+      self
+    end
+
+    private
+
+    def get_page(url, params = {})
+      query = URI.parse(url).query
+      p = CGI.parse(query).merge(params)
+      u = url.gsub("?#{query}", '')
+      p.each { |k, v| p[k] = v.first if v.is_a?(Array) }
+      @api_client.connection.send(:get) do |r|
+        r.url(u, p)
+      end
+    end
+
+    def load_page(url)
+      response = get_page(url)
+      ApiArray.process_response(response, @api_client)
+    end
+
+    def get_response_content(response)
+      return [] unless response.body.is_a?(Hash)
+      content = response.body['content']
+      if content.length > 0
+        return content
+      end
+      []
+    end
+
+    def apply_response_metadata(response, concat = true)
+      unless concat
+        @links = {}
+        @metadata = {}
+      end
+      @status = response.status
+      @headers = response.headers
+      @method = response.env[:method]
+      init_pages(response)
+      init_linked(response)
+      init_meta(response)
+    end
+
+    def init_linked(response)
+      if response.body.is_a?(Hash) && response.body.key?('links')
+        @links = @links.concat(response.body['links'])
+      end
+    end
+
+    def init_meta(response)
+      if response.body.is_a?(Hash) && response.body.key?('metadata')
+        @metadata = response.body['metadata']
+      end
+    end
+
+    def init_pages(response)
+      @next_page = nil
+      @prev_page = nil
+      if response.body.is_a?(Hash) && response.body.key?('links')
+        response.body['links'].each do |link|
+          case link['rel']
+            when 'next'
+              @next_page = link['href']
+            when 'prev'
+              @prev_page = link['href']
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/paychex_api/client.rb

@@ -0,0 +1,79 @@
+require 'footrest/client'
+require 'faraday'
+require 'footrest'
+require 'footrest/http_error'
+require 'footrest/pagination'
+require 'footrest/follow_redirects'
+require 'footrest/parse_json'
+require 'base64'
+require 'active_support/time'
+require 'paychex_api/api_array'
+
+module PaychexAPI
+  class Client < Footrest::Client
+
+    API_PATH = ""
+    COMPANIES_PATH = '/companies'
+    ORGANIZATIONS_PATH = '/organizations'
+    JOB_TITLES_PATH = '/jobtitles'
+    WORKER_STATUSES_PATH = '/workerstatuses'
+    WORKERS_PATH = '/workers'
+    COMMUNICATIONS_PATH = '/communications'
+    COMPENSATION_PATH = '/compensation'
+    DIRECT_DEPOSITS_PATH = '/directdeposits'
+    PAY_PERIODS_PATH = '/payperiods'
+    PAY_COMPONENTS_PATH = '/paycomponents'
+    CHECKS_PATH = '/checks'
+    OAUTH_TOKEN_PATH = '/auth/oauth/v2/token'
+
+    attr_reader :authorization
+
+    Dir[File.dirname(__FILE__) + '/client/*.rb'].each do |file|
+      require file
+      include self.const_get("#{File.basename(file).gsub('.rb','').split("_").map{|ea| ea.capitalize}.join('')}")
+    end
+
+    # Override Footrest request for ApiArray support
+    def request(method, &block)
+      if @authorization.blank? || @authorization['expiration'] <= DateTime.now - 30.seconds
+        temp_client =  get_default_faraday
+        response = temp_client.post(
+          OAUTH_TOKEN_PATH,
+          {
+            client_id: config[:client_id],
+            client_secret: config[:client_secret],
+            grant_type: 'client_credentials'
+          }
+        )
+        @authorization = response.body
+        @authorization['expiration'] = DateTime.now + @authorization['expires_in'].to_i.seconds
+      end
+      connection.headers[:authorization] =   "Bearer #{@authorization['access_token']}"
+      ApiArray::process_response(connection.send(method, &block), self)
+    end
+
+    def set_connection(config)
+      config[:logger] = config[:logging] if config[:logging]
+      @connection = get_default_faraday
+    end
+
+    def get_default_faraday
+      Faraday.new(url: config[:prefix]) do |faraday|
+        faraday.request                     :multipart
+        faraday.request                     :url_encoded
+        if config[:logger] == true
+          faraday.response :logger
+        elsif config[:logger]
+          faraday.use Faraday::Response::Logger, config[:logger]
+        end
+        faraday.use                         Footrest::FollowRedirects, limit: 5 unless config[:follow_redirects] == false
+        faraday.adapter                     Faraday.default_adapter
+        faraday.use                         Footrest::ParseJson, :content_type => /\bjson$/
+        faraday.use                         Footrest::RaiseFootrestErrors
+        faraday.use                         Footrest::Pagination
+        faraday.headers[:accept]          = "application/json"
+        faraday.headers[:user_agent]      = "Footrest"
+      end
+    end
+  end
+end

data/lib/paychex_api/client/companies.rb

@@ -0,0 +1,24 @@
+module PaychexAPI
+  class Client
+    module Companies
+
+      def get_company(company_id, params = {})
+        get("#{API_PATH}#{COMPANIES_PATH}/#{company_id}", params)
+      end
+
+      def get_company_by_display_id(display_id, params = {})
+        params = params.merge({displayid: display_id})
+        get("#{API_PATH}#{COMPANIES_PATH}", params)
+      end
+
+      def get_organizations(company_id, organization_id, params = {})
+        get("#{API_PATH}#{COMPANIES_PATH}/#{company_id}#{ORGANIZATIONS_PATH}", params)
+      end
+
+      def get_organization(company_id, organization_id, params = {})
+        get("#{API_PATH}#{COMPANIES_PATH}/#{company_id}#{ORGANIZATIONS_PATH}/#{organization_id}", params)
+      end
+
+    end
+  end
+end

data/lib/paychex_api/client/workers.rb

@@ -0,0 +1,31 @@
+module PaychexAPI
+  class Client
+    module Workers
+
+      def get_all_workers(company_id, params = {})
+        get("#{API_PATH}#{COMPANIES_PATH}/#{company_id}#{WORKERS_PATH}", params)
+      end
+
+      def get_communications(worker_id, params = {})
+        get("#{API_PATH}#{WORKERS_PATH}/#{worker_id}#{COMMUNICATIONS_PATH}", params)
+      end
+
+      def get_communication(worker_id, communication_id, params = {})
+        get("#{API_PATH}#{WORKERS_PATH}/#{worker_id}#{COMMUNICATIONS_PATH}/#{communication_id}", params)
+      end
+
+      def create_communication(worker_id, params = {})
+        post("#{API_PATH}#{WORKERS_PATH}/#{worker_id}#{COMMUNICATIONS_PATH}", params)
+      end
+
+      def update_communication(worker_id, communication_id, params = {})
+        put("#{API_PATH}#{WORKERS_PATH}/#{worker_id}#{COMMUNICATIONS_PATH}/#{communication_id}", params)
+      end
+
+      def delete_communication(worker_id, communication_id, params = {})
+        delete("#{API_PATH}#{WORKERS_PATH}/#{worker_id}#{COMMUNICATIONS_PATH}/#{communication_id}", params)
+      end
+
+    end
+  end
+end

data/lib/paychex_api/version.rb

@@ -0,0 +1,3 @@
+module PaychexAPI
+  VERSION = '0.0.1' unless defined?(PaychexAPI::VERSION)
+end

data/paychex_api.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'paychex_api/version'
+
+Gem::Specification.new do |gem|
+  gem.authors =       ["Jay Shaffer"]
+  gem.email =         ["jshaffer@instructure.com"]
+  gem.description =   %q{Interface for interacting with the paychex enterprise API}
+  gem.summary =       %q{Paychex API}
+  gem.homepage =      ""
+  gem.license = 'MIT'
+
+  gem.files = `git ls-files`.split("\n")
+  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("spec/**/*")
+  gem.test_files    = Dir.glob("spec/**/*")
+  gem.name          = "paychex_api"
+  gem.require_paths = ["lib"]
+  gem.version       = PaychexAPI::VERSION
+
+  gem.add_development_dependency 'rake', '~> 0'
+  gem.add_development_dependency 'bundler', '~> 1.0', '>= 1.0.0'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'webmock', '~>1.22.6'
+  gem.add_development_dependency 'pry', '~> 0'
+  gem.add_development_dependency 'tilt', '>= 1.3.4', '~> 1.3'
+  gem.add_development_dependency 'sinatra', '~> 1.0'
+  gem.add_development_dependency 'byebug', '~> 8.2.2'
+
+  gem.add_dependency 'footrest', '>= 0.5.1'
+  gem.add_dependency 'faraday', '~> 0.9.0'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.0'
+
+end

data/spec/fixtures/auth.json

@@ -0,0 +1,6 @@
+{
+  "access_token": "99f9c30a-8134-4a30-a789-7c7665add41e",
+  "token_type": "Bearer",
+  "expires_in": 600,
+  "scope": "oob"
+}

data/spec/fixtures/communications.json

@@ -0,0 +1,99 @@
+{
+  "content": [
+    {
+      "communicationId": "00Z5V9BTINBT97UMERCA",
+      "type": "EMAIL",
+      "usageType": "BUSINESS",
+      "uri": "jd_work@noreplay.com",
+      "links": [
+        {
+          "rel": "self",
+          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCA"
+        }
+      ]
+    },
+    {
+     "communicationId": "00Z5V9BTINBT97UMERCB",
+      "type": "PHONE",
+      "usageType": "BUSINESS",
+      "dialCountry": "1",
+      "dialArea": "999",
+      "dialNumber": "8887777",
+      "dialExtension": "6",
+      "links": [
+        {
+          "rel": "self",
+          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCB"
+        }
+      ]
+    },
+    {
+      "communicationId": "00Z5V9BTINBT97UMERCC",
+      "type": "MOBILE_PHONE",
+      "usageType": "BUSINESS",
+      "dialCountry": "1",
+      "dialArea": "777",
+      "dialNumber": "6665555",
+      "links": [
+        {
+          "rel": "self",
+          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCC"
+        }
+      ]
+    },
+    {
+      "communicationId": "00Z5V9BTINBT97UMERCD",
+      "type": "FAX",
+      "usageType": "BUSINESS",
+      "dialCountry": "1",
+      "dialArea": "555",
+      "dialNumber": "4443333",
+      "links": [
+        {
+          "rel": "self",
+          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCD"
+        }
+      ]
+    },
+    {
+      "communicationId": "00Z5V9BTINBT97UMERCE",
+      "type": "PAGER",
+      "usageType": "BUSINESS",
+      "dialCountry": "1",
+      "dialArea": "666",
+      "dialNumber": "5554444",
+      "links": [
+        {
+          "rel": "self",
+          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCE"
+        }
+      ]
+    },
+    {
+      "communicationId": "00Z5V9BTINBT97UMERCF",
+      "type": "STREET_ADDRESS",
+      "streetLineOne": "1 Main Street",
+      "streetLineTwo": "Office 3",
+      "city": "Webster",
+      "countrySubdivisionCode": "NEW_YORK",
+      "postalCode": "14580",
+      "countryCode": "US",
+      "links": [
+        {
+          "rel": "self",
+          "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications/00Z5V9BTINBT97UMERCF"
+        }
+      ]
+    }
+  ],
+  "links": [
+    {
+      "rel": "self",
+      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications"
+    },
+    {
+      "rel": "create",
+      "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH/communications"
+    }
+  ]
+}

data/spec/fixtures/companies.json

@@ -0,0 +1,38 @@
+{
+   "metadata": {"contentItemCount": 1},
+   "content": [   {
+      "companyId": "99Z5V9BTI8J2FCGESC05",
+      "displayId": "09620579",
+      "legalName": "Monsters, Inc",
+      "legalId":       {
+         "legalIdType": "FEIN",
+         "legalIdValue": "995886885"
+      },
+      "communications": [      {
+         "type": "STREET_ADDRESS",
+         "usageType": "BUSINESS",
+         "streetLineOne": "Mike St",
+         "streetLineTwo": "Sulley Ln",
+         "city": "ANAHEIM",
+         "countrySubdivisionCode": "CA",
+         "postalCode": "92802",
+         "countryCode": "US"
+      }],
+      "links":       [
+                  {
+            "rel": "self",
+            "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05"
+         },
+                  {
+            "rel": "workers",
+            "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/workers"
+         }
+      ]
+   }],
+   "links":    [
+            {
+         "rel": "self",
+         "href": "https://api.paychex.com/companies"
+      }
+   ]
+}

data/spec/fixtures/organizations.json

@@ -0,0 +1,32 @@
+{
+  "content": [
+    {
+      "organizationId": "970000055981384",
+      "name": "2 Division B",
+      "links": [
+        {
+          "rel": "self",
+          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981384"
+        },
+        {
+          "rel": "parent",
+          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981383"
+        },
+        {
+          "rel": "child",
+          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981385"
+        },
+        {
+          "rel": "child",
+          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981386"
+        }
+         ]
+    }
+  ],
+  "links": [
+    {
+      "rel": "self",
+      "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations"
+    }
+  ]
+}

data/spec/fixtures/workers.json

@@ -0,0 +1,85 @@
+{
+  "metadata": {
+    "contentItemCount": 5,
+    "pagination": {
+      "offset": 5,
+      "limit": 5,
+      "itemCount": 56
+    }
+  },
+  "content": [
+    {
+        "workerId": "00Z5V9BTIHRQF2CF7BTH",
+        "employeeId": "3052",
+        "workerType": "EMPLOYEE",
+        "employmentType": "FULL_TIME",
+        "exemptionType": "NON_EXEMPT",
+        "birthDate": "1899-07-01T00:00:00Z",
+        "clockId": "4321",
+        "sex": "MALE",
+        "ethnicityCode": "WHITE_NOT_OF_HISPANIC_ORIGIN",
+        "hireDate": "2015-06-15T00:00:00Z",
+        "name": {
+          "familyName": "JONES",
+          "middleName": "H",
+          "givenName": "INDIANA",
+          "preferredName": "Indi",
+          "qualificationAffixCode": "Jr",
+          "titleAffixCode": "DR"
+        },
+        "legalId": {
+          "legalIdType": "SSN",
+          "legalIdValue": "333221111"
+        },
+        "currentStatus": {
+          "workerStatusId": "00DWS906IMW2JSH8AQJ9",
+          "statusReason": "HIRED",
+          "statusType": "ACTIVE",
+          "effectiveDate": "2015-06-15T00:00:00Z"
+        },
+        "job": {
+          "jobTitleId": "00DWS906IMW2JSH8AQJ8",
+          "title": "Archaeologist"
+        },
+        "organization": {
+          "organizationId": "970000055981384",
+          "name": "2 Division B"
+        },
+        "supervisor": {
+          "workerId": "00H2A1IUJ4IPERJ589YE",
+          "name": {
+              "familyName": "Scott",
+              "givenName": "Willie"
+            }
+        },
+        "links": [
+          {
+            "rel": "self",
+            "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTH"
+          },
+          {
+            "rel": "communications",
+            "href": "https://api.paychex.com/workers/00Z5V9BTIHRQF2CF7BTF/communications"
+          },
+          {
+            "rel": "supervisor",
+            "href": "https://api.paychex.com/workers/00H2A1IUJ4IPERJ589YE"
+          }
+        ]
+      }
+  ],
+  "links": [
+    {
+      "rel": "self",
+      "href": "https://api.paychex.com/companies/00Z5V9BTI8J2FCGESC05/workers?offset=5&limit=5"
+    },
+    {
+      "rel": "next",
+      "href": "https://api.paychex.com/companies/00Z5V9BTI8J2FCGESC05/workers?offset=10&limit=5"
+    },
+    {
+      "rel": "prev",
+      "href": "https://api.paychex.com/companies/00Z5V9BTI8J2FCGESC05/workers?offset=0&limit=5"
+    }
+  ]
+}

data/spec/paychex_api/client/companies_spec.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+describe PaychexAPI::Client::Companies do
+
+  before do
+    @client = PaychexAPI::Client.new(prefix: "http://test.paychex.com", client_id: "client_id", client_secret: 'client_secret')
+  end
+
+  it 'should get a company' do
+    response = @client.get_company(1)
+    expect(response.first['companyId']).to(eq("99Z5V9BTI8J2FCGESC05"))
+  end
+
+  it 'should get a company by display id' do
+    response = @client.get_company_by_display_id(1)
+    expect(response.first['companyId']).to(eq("99Z5V9BTI8J2FCGESC05"))
+  end
+
+  it 'should get organizations' do
+    response = @client.get_organizations(1, 2)
+    expect(response.first['organizationId']).to(eq("970000055981384"))
+  end
+
+end

data/spec/paychex_api/client/workers_spec.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+describe PaychexAPI::Client::Workers do
+
+  before do
+    @client = PaychexAPI::Client.new(prefix: "http://test.paychex.com", client_id: "client_id", client_secret: 'client_secret')
+  end
+
+  it 'should get all workers' do
+    response = @client.get_all_workers("1")
+    expect(response.first['workerId']).to(eq("00Z5V9BTIHRQF2CF7BTH"))
+  end
+
+  it 'should get all communications' do
+    response = @client.get_communications(1)
+    expect(response.first['communicationId']).to(eq("00Z5V9BTINBT97UMERCA"))
+  end
+
+  it 'should get a communication' do
+    response = @client.get_communication(1, 1)
+    expect(response.first['communicationId']).to(eq("00Z5V9BTINBT97UMERCA"))
+  end
+
+  it 'should get create a communication' do
+    response = @client.create_communication(1)
+    expect(response.first['communicationId']).to(eq("00Z5V9BTINBT97UMERCA"))
+  end
+
+  it 'should update a communication' do
+    response = @client.update_communication(1, 1, {something: 'something'})
+    expect(response.first['communicationId']).to(eq("00Z5V9BTINBT97UMERCA"))
+  end
+
+end

data/spec/paychex_api/client_spec.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+describe PaychexAPI::Client do
+
+  it 'should pull the auth token' do
+    client = PaychexAPI::Client.new(prefix: "https://www.fake.com", client_id: "client_id", client_secret: 'client_secret')
+    client.get_all_workers("1")
+    expect(client.authorization['access_token']).to(eq('99f9c30a-8134-4a30-a789-7c7665add41e'))
+  end
+
+  it 'should skip pulling the auth token' do
+    client = PaychexAPI::Client.new(prefix: "https://www.fake.com", client_id: "client_id", client_secret: 'client_secret')
+    expect(client.authorization).to(eq(nil))
+    client.get_all_workers("1")
+    expect(client.authorization['access_token']).to(eq('99f9c30a-8134-4a30-a789-7c7665add41e'))
+    expect_any_instance_of(Faraday).not_to receive(:post)
+    client.get_all_workers("1")
+  end
+
+  it 'should set the auth header to bearer auth' do
+    client = PaychexAPI::Client.new(prefix: "https://www.fake.com", client_id: "client_id", client_secret: 'client_secret')
+    client.get_all_workers("1")
+    expect(client.connection.headers['Authorization']).to(eq("Bearer 99f9c30a-8134-4a30-a789-7c7665add41e"))
+  end
+
+end

data/spec/support/fake_paychex.rb

@@ -0,0 +1,61 @@
+require 'sinatra/base'
+require 'tilt'
+
+class FakePaychex < Sinatra::Base
+
+  #auth
+  post %r{/auth/oauth/v2/token$} do
+    get_json_data 200, 'auth.json'
+  end
+
+  #workers
+  get %r{/companies/\d+/workers$} do
+    get_json_data 200, 'workers.json'
+  end
+
+  get %r{/workers/\d+/communications$} do
+    get_json_data 200, 'communications.json'
+  end
+
+  get %r{/workers/\d+/communications/\d+$} do
+    get_json_data 200, 'communications.json'
+  end
+
+  post %r{/workers/\d+/communications$} do
+    get_json_data 200, 'communications.json'
+  end
+
+  put %r{/workers/\d+/communications/\d+$} do
+    get_json_data 200, 'communications.json'
+  end
+
+  delete %r{/workers/\d+/communications/\d+$} do
+    get_json_data 200, 'communications.json'
+  end
+
+  #companies
+  get %r{/companies/\d+$} do
+    get_json_data 200, 'companies.json'
+  end
+
+  get %r{/companies$} do
+    get_json_data 200, 'companies.json'
+  end
+
+  get %r{/companies/\d/organizations+$} do
+    get_json_data 200, 'organizations.json'
+  end
+
+  private
+
+  def get_json_data(response_code, file_name)
+    content_type :json
+    status response_code
+    unless file_name.nil?
+      File.open(File.dirname(__FILE__) + '/../fixtures/' + file_name).read
+    else
+      {}
+    end
+  end
+
+end

data/spec/test_helper.rb

@@ -0,0 +1,20 @@
+require 'paychex_api'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+require 'pry'
+require 'byebug'
+
+RSpec.configure do |config|
+  Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+  config.before(:each) do
+    WebMock.disable_net_connect!
+    WebMock.stub_request(:any, /.*/).to_rack(FakePaychex)
+  end
+end
+
+
+def fixture(*file)
+  File.new(File.join(File.expand_path("../fixtures", __FILE__), *file))
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: paychex_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jay Shaffer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+- !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: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 8.2.2
+- !ruby/object:Gem::Dependency
+  name: footrest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Interface for interacting with the paychex enterprise API
+email:
+- jshaffer@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- lib/paychex_api.rb
+- lib/paychex_api/api_array.rb
+- lib/paychex_api/client.rb
+- lib/paychex_api/client/companies.rb
+- lib/paychex_api/client/workers.rb
+- lib/paychex_api/version.rb
+- paychex_api.gemspec
+- spec/fixtures/auth.json
+- spec/fixtures/communications.json
+- spec/fixtures/companies.json
+- spec/fixtures/organizations.json
+- spec/fixtures/workers.json
+- spec/paychex_api/client/companies_spec.rb
+- spec/paychex_api/client/workers_spec.rb
+- spec/paychex_api/client_spec.rb
+- spec/support/fake_paychex.rb
+- spec/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Paychex API
+test_files:
+- spec/fixtures/auth.json
+- spec/fixtures/communications.json
+- spec/fixtures/companies.json
+- spec/fixtures/organizations.json
+- spec/fixtures/workers.json
+- spec/paychex_api/client/companies_spec.rb
+- spec/paychex_api/client/workers_spec.rb
+- spec/paychex_api/client_spec.rb
+- spec/support/fake_paychex.rb
+- spec/test_helper.rb