paychex_api 0.0.26 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f72a02ebb9077fda3a04a01702c7cc0cb6b2f935922a96f792285456f0c2309
-  data.tar.gz: 6332d3d87f09fd1e0eaf556ac5571cbbcffa32a8cea53cc1d48ebfd967f95a0a
+  metadata.gz: 64d05e8b83a00fd01ba8934f109fc66bcbe1dc92937fed269e100c5557093eef
+  data.tar.gz: fb87588d4e5d234b72c5c048553de5b9e9d6a756d863398e1d8dc6792f2286a5
 SHA512:
-  metadata.gz: cf887d44b56107c7d554322c9d0c6f5333dbc0b56414f237fb051a5d3fd198320d08f656ebe6b45c9b5e5143d3d6a83515ab3c4ea51fb8c5a0608df0ff2d96e1
-  data.tar.gz: 898d26059ce7b3068d330b51ef822865c390e52ffbd95bbefee8e95603d17bf399f03c3e332bb52cf57e76c9f495de2b1805ab6b952aefad1c844aa6c272f502
+  metadata.gz: d873ee94a663cec68f5ab81e440c2fa1271a4abb3e6f7869e6c0de175ed2b62096346cc6dbee8ea5d83002a4dc9ae598488247fe838826a5b55e829a383de5af
+  data.tar.gz: b7a19e1dd16e36dccab4d12934ee678dcd77fef51dca440252dcdaec5ad66b9d2e58c0983a296b18c4a3da483c9c35ecfb119a1121c1b2e2bfc8d51c0b11aa89

data/.github/workflows/ci.yml

@@ -10,9 +10,10 @@ jobs:
       - name: Setup Ruby # Step 2 (we gave the name 'Setup Ruby' to this step)
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5.0
+          ruby-version: 3.2.2
       - name: Install bundle and gems # Step 4
         run: |
+          gem update --system
           gem install bundler
           bundle install --jobs 4 --retry 3
       - if: ${{ failure() }}

data/.rubocop.yml

@@ -22,3 +22,5 @@ Metrics/MethodLength:
       - spec/**/*
 Naming/AccessorMethodName:
   Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Gemfile.lock

@@ -1,71 +1,81 @@
 PATH
   remote: .
   specs:
-    paychex_api (0.0.26)
-      faraday (~> 0.9.0)
+    paychex_api (0.0.28)
+      faraday (~> 0.17.3)
       faraday_middleware (>= 0.12.2)
       footrest (>= 0.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    faraday (0.9.2)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    drb (2.2.1)
+    faraday (0.17.6)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
-    footrest (0.5.3)
+    footrest (0.5.5)
       activesupport (>= 3.0.0)
       faraday (>= 0.9.0, < 1)
       link_header (>= 0.0.7)
-    gergich (1.2.0)
+    gergich (1.2.3)
       httparty (~> 0.17)
       sqlite3 (~> 1.4)
-    hashdiff (1.0.1)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
+    hashdiff (1.1.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.7)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
     link_header (0.0.8)
     method_source (1.0.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    minitest (5.14.3)
+    mini_mime (1.1.5)
+    minitest (5.22.2)
     multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    mustermann (1.1.1)
+    multipart-post (2.4.0)
+    mustermann (2.0.2)
       ruby2_keywords (~> 0.0.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    pry (0.13.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.5)
-    rack (2.2.3)
-    rack-protection (2.0.8.1)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (2.2.8.1)
+    rack-protection (2.2.4)
       rack
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
       rspec-expectations (~> 2.99.0)
@@ -74,42 +84,42 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.4)
-    rubocop (0.88.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.2.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
-    safe_yaml (1.0.5)
-    simplecov (0.18.5)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    sinatra (2.0.8.1)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.8.1)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sinatra (2.2.4)
+      mustermann (~> 2.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.4)
       tilt (~> 2.0)
-    sqlite3 (1.4.2)
-    tilt (2.0.10)
-    tzinfo (2.0.4)
+    sqlite3 (1.7.2-arm64-darwin)
+    tilt (2.3.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
+    unicode-display_width (1.8.0)
+    webmock (3.23.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
 
 DEPENDENCIES
   bundler (>= 1.0)
@@ -125,4 +135,4 @@ DEPENDENCIES
   webmock (>= 1.22)
 
 BUNDLED WITH
-   1.17.3
+   2.4.22

data/lib/paychex_api/client/companies.rb

@@ -22,6 +22,14 @@ module PaychexAPI
         get("#{API_PATH}#{COMPANIES_PATH}/#{company_id}#{WORKERS_PATH}", params)
       end
 
+      def get_company_locations(company_id, params = {})
+        get("#{API_PATH}#{COMPANIES_PATH}/#{company_id}/#{LOCATIONS_PATH}", params)
+      end
+
+      def get_company_location(company_id, location_id, params = {})
+        get("#{API_PATH}#{COMPANIES_PATH}/#{company_id}/#{LOCATIONS_PATH}/#{location_id}", params)
+      end
+
       def get_company_by_display_id(display_id, params = {})
         params = params.merge(displayid: display_id)
         get("#{API_PATH}#{COMPANIES_PATH}", params)

data/lib/paychex_api/client/notifications.rb

@@ -1,11 +1,9 @@
-# rubocop:disable Lint/UriEscapeUnescape
 module PaychexAPI
   class Client
     module Notifications
       def send_notification(notification_id, params = {})
-        post("#{API_PATH}#{NOTIFICATIONS_PATH}/#{URI.escape(notification_id)}", params)
+        post("#{API_PATH}#{NOTIFICATIONS_PATH}/#{CGI.escape(notification_id).gsub('+', '%20')}", params)
       end
     end
   end
 end
-# rubocop:enable Lint/UriEscapeUnescape

data/lib/paychex_api/client.rb

@@ -32,6 +32,7 @@ module PaychexAPI
     OAUTH_TOKEN_PATH = '/auth/oauth/v2/token'.freeze
     USERS_PATH = '/users'.freeze
     PURCHASES_PATH = '/purchases'.freeze
+    LOCATIONS_PATH = '/locations'.freeze
 
     attr_reader :authorization
 

data/lib/paychex_api/version.rb

@@ -1,3 +1,3 @@
 module PaychexAPI
-  VERSION = '0.0.26'.freeze unless defined?(PaychexAPI::VERSION)
+  VERSION = '0.0.28'.freeze unless defined?(PaychexAPI::VERSION)
 end

data/paychex_api.gemspec

@@ -3,8 +3,8 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'paychex_api/version'
 
 Gem::Specification.new do |gem|
-  gem.authors =       ['Jay Shaffer']
-  gem.email =         ['jshaffer@instructure.com']
+  gem.authors =       ['Cody Tanner']
+  gem.email =         ['cody.tanner@getbridge.com']
   gem.description =   'Interface for interacting with the paychex enterprise API'
   gem.summary =       'Paychex API'
   gem.homepage =      ''
@@ -29,7 +29,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'sinatra', '>= 1.0', '< 3'
   gem.add_development_dependency 'webmock', '>= 1.22'
 
-  gem.add_dependency 'faraday', '~> 0.9.0'
+  gem.add_dependency 'faraday', '~> 0.17.3'
   gem.add_dependency 'faraday_middleware', '>= 0.12.2'
   gem.add_dependency 'footrest', '>= 0.5.1'
 end

data/spec/fixtures/company_location.json

@@ -0,0 +1,17 @@
+{
+    "content": [
+        {
+            "locationId": "1040011892857651",
+            "name": "Location_110207",
+            "address": {
+                "streetLineOne": "886 Queen Avenue",
+                "streetLineTwo": "866 Euclid Gate",
+                "city": "Buffalo",
+                "postalCode": "14202",
+                "countrySubdivisionCode": "NY",
+                "countryCode": "US"
+            }
+        }
+    ],
+    "links": []
+}

data/spec/fixtures/company_locations.json

@@ -0,0 +1,80 @@
+{
+    "metadata": {
+        "contentItemCount": 6
+    },
+    "content": [
+        {
+            "locationId": "1040011892857651",
+            "name": "Location_110207",
+            "address": {
+                "streetLineOne": "886 Queen Avenue",
+                "streetLineTwo": "866 Euclid Gate",
+                "city": "Buffalo",
+                "postalCode": "14202",
+                "countrySubdivisionCode": "NY",
+                "countryCode": "US"
+            }
+        },
+        {
+            "locationId": "1040011892857657",
+            "name": "Location_830745",
+            "address": {
+                "streetLineOne": "540 Cardinal Court",
+                "streetLineTwo": "347 Jackson Trail",
+                "city": "Bridgeport",
+                "postalCode": "06601",
+                "countrySubdivisionCode": "CT",
+                "countryCode": "US"
+            }
+        },
+        {
+            "locationId": "1040011892857681",
+            "name": "Location_965274",
+            "address": {
+                "streetLineOne": "700 Sixth Street",
+                "streetLineTwo": "948 Cypress Circle",
+                "city": "Portsmouth",
+                "postalCode": "03802",
+                "countrySubdivisionCode": "NH",
+                "countryCode": "US"
+            }
+        },
+        {
+            "locationId": "1040011892857669",
+            "name": "Location_933960",
+            "address": {
+                "streetLineOne": "91 Orchard Freeway",
+                "streetLineTwo": "386 Second Court",
+                "city": "Bangor",
+                "postalCode": "04402",
+                "countrySubdivisionCode": "ME",
+                "countryCode": "US"
+            }
+        },
+        {
+            "locationId": "1040011892857675",
+            "name": "Location_223814",
+            "address": {
+                "streetLineOne": "696 Bridle Highway",
+                "streetLineTwo": "238 Standish Heights",
+                "city": "Boston",
+                "postalCode": "02113",
+                "countrySubdivisionCode": "MA",
+                "countryCode": "US"
+            }
+        },
+        {
+            "locationId": "1040011892857663",
+            "name": "Location_882082",
+            "address": {
+                "streetLineOne": "367 Tanglewood Bay",
+                "streetLineTwo": "739 Nineth Freeway",
+                "city": "Burlington",
+                "postalCode": "05401",
+                "countrySubdivisionCode": "VT",
+                "countryCode": "US"
+            }
+        }
+    ],
+    "links": []
+}

data/spec/paychex_api/client/companies_spec.rb

@@ -31,6 +31,16 @@ describe PaychexAPI::Client::Companies do
     expect(response.first['workerId']).to(eq('00Z5V9BTIHRQF2CF7BTH'))
   end
 
+  it 'should get company locations' do
+    response = @client.get_company_locations(1)
+    expect(response.first['locationId']).to(eq('1040011892857651'))
+  end
+
+  it 'should get a company location' do
+    response = @client.get_company_location(1, 1)
+    expect(response.first['locationId']).to(eq('1040011892857651'))
+  end
+
   it 'should get company associations with association type' do
     response = @client.get_company_associations_by_regex_type(1, /LMS.*/)
     expect(response.first['associations'].length).to(eq(1))

data/spec/support/fake_paychex.rb

@@ -21,6 +21,15 @@ class FakePaychex < Sinatra::Base
     get_json_data 200, 'workers.json'
   end
 
+  # locations
+  get %r{/companies/.*/locations} do
+    get_json_data 200, 'company_locations.json'
+  end
+
+  get %r{/companies/.*/locations/\+d+} do
+    get_json_data 200, 'company_location.json'
+  end
+
   get %r{/workers/\d+/users} do
     case request.env['HTTP_ACCEPT']
     when "application/json;profile='http://api.paychex.com/profiles/users/v1'"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paychex_api
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.0.28
 platform: ruby
 authors:
-- Jay Shaffer
+- Cody Tanner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.17.3
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -200,7 +200,7 @@ dependencies:
         version: 0.5.1
 description: Interface for interacting with the paychex enterprise API
 email:
-- jshaffer@instructure.com
+- cody.tanner@getbridge.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -234,6 +234,8 @@ files:
 - spec/fixtures/communications.json
 - spec/fixtures/companies.json
 - spec/fixtures/companies_associations.json
+- spec/fixtures/company_location.json
+- spec/fixtures/company_locations.json
 - spec/fixtures/messages.json
 - spec/fixtures/organizations.json
 - spec/fixtures/status.json
@@ -271,31 +273,33 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Paychex API
 test_files:
-- spec/paychex_api/paychex_api_spec.rb
-- spec/paychex_api/client_spec.rb
+- spec/fixtures/association_companies.json
+- spec/fixtures/auth.json
+- spec/fixtures/communications.json
+- spec/fixtures/companies.json
+- spec/fixtures/companies_associations.json
+- spec/fixtures/company_location.json
+- spec/fixtures/company_locations.json
+- spec/fixtures/messages.json
+- spec/fixtures/organizations.json
+- spec/fixtures/status.json
+- spec/fixtures/users.json
+- spec/fixtures/workers.json
 - spec/paychex_api/api_array_spec.rb
-- spec/paychex_api/client/companies_spec.rb
 - spec/paychex_api/client/associations_spec.rb
+- spec/paychex_api/client/companies_spec.rb
+- spec/paychex_api/client/messages_spec.rb
+- spec/paychex_api/client/notifications_spec.rb
 - spec/paychex_api/client/purchases_spec.rb
 - spec/paychex_api/client/statuses_spec.rb
 - spec/paychex_api/client/users_spec.rb
-- spec/paychex_api/client/messages_spec.rb
 - spec/paychex_api/client/workers_spec.rb
-- spec/paychex_api/client/notifications_spec.rb
+- spec/paychex_api/client_spec.rb
+- spec/paychex_api/paychex_api_spec.rb
 - spec/support/fake_paychex.rb
-- spec/fixtures/messages.json
-- spec/fixtures/organizations.json
-- spec/fixtures/users.json
-- spec/fixtures/companies.json
-- spec/fixtures/workers.json
-- spec/fixtures/auth.json
-- spec/fixtures/communications.json
-- spec/fixtures/association_companies.json
-- spec/fixtures/status.json
-- spec/fixtures/companies_associations.json
 - spec/test_helper.rb