paychex_api 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28e5713e53b656a1ea003fffa4ea22e249beed79b88b65efebe0c63365c0e36c
-  data.tar.gz: 77b3c66897ee0b9dab9661aa0d7d3505198d585f05ba8394f36d2af121dbdae1
+  metadata.gz: 2f72a02ebb9077fda3a04a01702c7cc0cb6b2f935922a96f792285456f0c2309
+  data.tar.gz: 6332d3d87f09fd1e0eaf556ac5571cbbcffa32a8cea53cc1d48ebfd967f95a0a
 SHA512:
-  metadata.gz: 40ae78528ac7ef837ca25006124397dd99dd5bfda4d4f765d7a39c75e5b8c1dda6a0216ece16c203101a01153836601842290b8054f909fc71d242d40fcc3c07
-  data.tar.gz: 2dcead30a08cfb0e4d445b9b467154473bdb0d0dec41ac857253ab1bc89a4c74863938dc91ab389404383e60c5739f0913b5bd6e6ce3cec2674abe22c697a67d
+  metadata.gz: cf887d44b56107c7d554322c9d0c6f5333dbc0b56414f237fb051a5d3fd198320d08f656ebe6b45c9b5e5143d3d6a83515ab3c4ea51fb8c5a0608df0ff2d96e1
+  data.tar.gz: 898d26059ce7b3068d330b51ef822865c390e52ffbd95bbefee8e95603d17bf399f03c3e332bb52cf57e76c9f495de2b1805ab6b952aefad1c844aa6c272f502

data/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+# Virtual environments with possible versions infos: https://github.com/actions/virtual-environments
+
+name: CI
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2 # Step 1: github action that clones the repository
+      - 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
+      - name: Install bundle and gems # Step 4
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - if: ${{ failure() }}
+        run: echo "Something went wrong on the previous steps"
+      - if: ${{ success() }}
+        name: Run Rubocop # Step 7
+        run: bundle exec rubocop
+  brakeman:
+    name: runner / brakeman # Step 8
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+      - name: brakeman
+        uses: reviewdog/action-brakeman@v1
+        with:
+          brakeman_version: 4.8.2
+          github_token: ${{ secrets.github_token }}
+          reporter: github-pr-review # Default is github-pr-check

data/.gitignore

@@ -6,3 +6,4 @@ bridge_api.iml
 .byebug_history
 *.gem
 coverage
+.history

data/Gemfile.lock

@@ -1,31 +1,31 @@
 PATH
   remote: .
   specs:
-    paychex_api (0.0.25)
-      faraday (~> 0.9)
+    paychex_api (0.0.26)
+      faraday (~> 0.9.0)
       faraday_middleware (>= 0.12.2)
       footrest (>= 0.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.6)
+    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.17.3)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
@@ -40,14 +40,14 @@ GEM
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.5)
+    i18n (1.8.7)
       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.1)
+    minitest (5.14.3)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
     mustermann (1.1.1)
@@ -98,16 +98,15 @@ GEM
       rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
     sqlite3 (1.4.2)
-    thread_safe (0.3.6)
     tilt (2.0.10)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/lib/paychex_api/api_array.rb

@@ -1,4 +1,4 @@
-
+# rubocop:disable Metrics/AbcSize,Metrics/MethodLength
 module PaychexAPI
   class ApiArray
     include Enumerable
@@ -63,7 +63,7 @@ module PaychexAPI
     def each_page
       yield(members, @linked, @meta)
       while @next_page
-        response = get_page(@next_page)
+        response = page(@next_page)
         apply_response_metadata(response, false)
         @members = get_response_content(response)
         yield(members, @linked, @meta)
@@ -73,6 +73,7 @@ module PaychexAPI
 
     def all_pages!
       return self unless pages?
+
       combine_page
       combine_pages
       self
@@ -89,39 +90,42 @@ module PaychexAPI
     end
 
     def combine_page
-      response = get_page(@next_page)
+      response = page(@next_page)
       apply_response_metadata(response)
       @members.concat(get_response_content(response))
     end
 
-    def get_page(url, params = {}, tries=0)
+    def page(url, params = {}, tries = 0)
       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) }
+
       resp = @api_client.connection.send(:get) do |r|
         r.url(u, p)
       end
+
       tries = 0 if status == 200
       resp
     rescue Footrest::HttpError::Unauthorized => e
-      if tries == 0
-        # token may have expired for long running pagination requests, refresh and try again
-        @api_client.refresh_token!
-        get_page(url, params, (tries +1))
-      else
-        raise e
-      end
+      raise e unless tries.zero?
+
+      # token may have expired for long running pagination requests, refresh and try again
+      @api_client.refresh_token!
+      page(url, params, (tries + 1))
     end
 
     def load_page(url)
-      response = get_page(url)
+      response = page(url)
       ApiArray.process_response(response, @api_client)
     end
 
     def get_response_content(response)
       body = response.body
+
       return [] unless body.is_a?(Hash)
+
       if body.key?('content')
         body['content'] || []
       else
@@ -134,9 +138,11 @@ module PaychexAPI
         @links = []
         @metadata = {}
       end
+
       @status = response.status
       @headers = response.headers
       @method = response.env[:method]
+
       init_pages(response)
       init_linked(response)
       init_meta(response)
@@ -144,16 +150,19 @@ module PaychexAPI
 
     def init_linked(response)
       return nil unless response.body.is_a?(Hash) && response.body.key?('links')
+
       @links = @links.concat(response.body['links'])
     end
 
     def init_meta(response)
       return nil unless response.body.is_a?(Hash) && response.body.key?('metadata')
+
       @metadata = response.body['metadata']
     end
 
     def init_pages(response)
       return nil unless response.body.is_a?(Hash) && response.body.key?('links')
+
       @next_page, @prev_page = nil
       response.body['links'].each do |link|
         case link['rel']
@@ -166,3 +175,4 @@ module PaychexAPI
     end
   end
 end
+# rubocop:enable Metrics/AbcSize,Metrics/MethodLength

data/lib/paychex_api/client.rb

@@ -10,6 +10,7 @@ require 'base64'
 require 'active_support/time'
 require 'paychex_api/api_array'
 
+# rubocop:disable Lint/NonDeterministicRequireOrder
 module PaychexAPI
   class Client < Footrest::Client
     API_PATH = ''.freeze
@@ -47,10 +48,11 @@ module PaychexAPI
 
     def token
       return config[:token] if config[:token].present?
+
       authorize if @authorization.blank? || @authorization['expiration'] <= Time.now - 30.seconds
       @authorization['access_token']
     end
-    
+
     def refresh_token!
       config.delete(:token)
       authorize
@@ -113,7 +115,7 @@ module PaychexAPI
     end
 
     def faraday_proxy(faraday)
-      faraday.proxy = PaychexAPI.proxy if PaychexAPI.proxy
+      faraday.proxy PaychexAPI.proxy if PaychexAPI.proxy
       faraday
     end
 
@@ -150,3 +152,4 @@ module PaychexAPI
     end
   end
 end
+# rubocop:enable Lint/NonDeterministicRequireOrder

data/lib/paychex_api/client/notifications.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Lint/UriEscapeUnescape
 module PaychexAPI
   class Client
     module Notifications
@@ -7,3 +8,4 @@ module PaychexAPI
     end
   end
 end
+# rubocop:enable Lint/UriEscapeUnescape

data/lib/paychex_api/client/statuses.rb

@@ -1,15 +1,15 @@
 module PaychexAPI
   class Client
     module Statuses
-      def company_status(params={})
+      def company_status(params = {})
         get("#{API_PATH}#{STATUS_PATH}/company", params)
       end
 
-      def user_status(params={})
+      def user_status(params = {})
         get("#{API_PATH}#{STATUS_PATH}/user", params)
       end
 
-      def worker_status(params={})
+      def worker_status(params = {})
         get("#{API_PATH}#{STATUS_PATH}/worker", params)
       end
     end

data/lib/paychex_api/version.rb

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

data/paychex_api.gemspec

@@ -1,5 +1,5 @@
-
 $LOAD_PATH.push File.expand_path('lib', __dir__)
+
 require 'paychex_api/version'
 
 Gem::Specification.new do |gem|
@@ -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'
+  gem.add_dependency 'faraday', '~> 0.9.0'
   gem.add_dependency 'faraday_middleware', '>= 0.12.2'
   gem.add_dependency 'footrest', '>= 0.5.1'
 end

data/spec/paychex_api/client/messages_spec.rb

@@ -1,10 +1,11 @@
 require 'test_helper'
+
 describe PaychexAPI::Client::Notifications do
   let!(:body) do
     {
       'companyId' => '00Z5V9BTI687WL8V60GT',
       'asOfDate' => '2018-01-12T00:00:00Z',
-      'domains' =>  ['CLT_PROD'],
+      'domains' => ['CLT_PROD'],
       'action' => 'ADD',
       'productCode' => 'LMS_ENH'
     }

data/spec/paychex_api/client/notifications_spec.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+
 describe PaychexAPI::Client::Notifications do
   before do
     @client = PaychexAPI::Client.new(
@@ -8,13 +9,15 @@ describe PaychexAPI::Client::Notifications do
 
   it 'should send a notification' do
     response = @client.send_notification('f7f9c815-0d4c-46e5-9434-5cc19470d1ed-3520000031155394')
+
     expect(response.status).to(eq(200))
   end
 
   it 'should URI escape a notification id' do
     expect_any_instance_of(PaychexAPI::Client::Notifications)
       .to receive(:post)
-      .with("/notifications/f7f9c815-0d4c-46e5-9434-5cc1%209470d1ed-3520000031155394", {})
+      .with('/notifications/f7f9c815-0d4c-46e5-9434-5cc1%209470d1ed-3520000031155394', {})
+
     @client.send_notification('f7f9c815-0d4c-46e5-9434-5cc1 9470d1ed-3520000031155394')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paychex_api
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - Jay Shaffer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-02 00:00:00.000000000 Z
+date: 2021-01-13 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'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +205,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".simplecov"