paychex 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b108a5bafb14b19e27ff229025979dfacc3cbfda66fc85d090bafe0938cfd9ac
-  data.tar.gz: 10a0d2572db4ad5aa98af00ca09823773cc2cde782e71ce929dc2b07f650b388
+  metadata.gz: 45e870f2d315996be069c400602a4ccf366a9994cd266618114f6dffc54c9004
+  data.tar.gz: 92f46dee54c5fa14fb1b1b1ff10b7ac4615f57e2cae2eee3ee7dcde9090c7e60
 SHA512:
-  metadata.gz: 5012a0ccd1850760585823bca158af65e653c88fac133edb5f2c077cf5a797284f7c4cc25a8874ba9e80257e84ad0d12a458f3e827d2b9803fdba7f7918f9301
-  data.tar.gz: 2cc60fd55900567803106581ea33a8a20f881d4f1a58d2cdeb0e062740fb9d7318bc91fc107c281100dc002b80958babd0e051c42b09c526616ab0c82a59daad
+  metadata.gz: a052c5f5d6ee6811fad22bf8391b302f274fb9fe2d794e21033e3180f8094a7528e79a8230e953b61c1aef239d028adf294ce85a3d13a4c58324664d2efe745f
+  data.tar.gz: 1bf76e48e2e5ed81b69fd055f01f84d5a042f11d9fd93ef7e8dcfe0b124c46458edaac46502e83c503d669e9ce05973d2466e0a9342447167344c7c5eae08a4a

data/Gemfile.lock

@@ -1,65 +1,65 @@
-PATH
-  remote: .
-  specs:
-    paychex (0.3.3)
-      addressable
-      faraday
-      faraday_middleware
-      rexml
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    byebug (11.1.3)
-    coderay (1.1.3)
-    crack (0.4.4)
-    diff-lcs (1.4.4)
-    faraday (1.1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday_middleware (1.0.0)
-      faraday (~> 1.0)
-    hashdiff (1.0.1)
-    method_source (1.0.0)
-    multipart-post (2.1.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rake (13.0.1)
-    rexml (3.2.5)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    ruby2_keywords (0.0.4)
-    webmock (3.9.3)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.17)
-  byebug
-  paychex!
-  pry
-  rake (>= 12.3.3)
-  rspec (>= 3.9.0)
-  webmock
-
-BUNDLED WITH
-   2.4.4
+PATH
+  remote: .
+  specs:
+    paychex (0.3.5)
+      addressable
+      faraday
+      faraday_middleware
+      rexml
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    rexml (3.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    ruby2_keywords (0.0.4)
+    webmock (3.9.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.17)
+  byebug
+  paychex!
+  pry
+  rake (>= 12.3.3)
+  rspec (>= 3.9.0)
+  webmock
+
+BUNDLED WITH
+   2.4.4

data/lib/paychex/client/companies.rb

@@ -2,9 +2,42 @@ module Paychex
   class Client
     module Companies
       # Get a list of all the linked companies
-      # This will be unavailable once we have 200+ linked companies
       def linked_companies
-        get('companies')
+        limit = per_page
+        opts = { limit: limit, offset: 0 }
+        response_content = []
+        current_page = 1
+
+        response = companies(opts)
+
+        begin
+          while response && response.body
+            begin
+              companies_count = response.body.fetch('metadata').fetch('pagination').fetch('total')
+
+              no_of_pages = (companies_count.to_f / limit).ceil
+            rescue KeyError => e
+              # Consider no_of_pages = 1 unless pagination - total node is missing
+              no_of_pages = 1
+            end
+
+            companies_content = response.body.fetch('content').to_a
+            companies_content = companies_content.select { |c| c['hasPermission'] } if companies_content
+            response_content += companies_content
+
+            current_page += 1
+            if current_page <= no_of_pages
+              opts = { limit: limit, offset: (current_page - 1) * limit }
+              response = companies(opts)
+            else
+              break
+            end
+          end
+        rescue StandardError => e
+          return response_content
+        end
+
+        response_content
       end
 
       # Get profile of a linked company
@@ -85,5 +118,15 @@ module Paychex
         ret
       end
     end
+
+    private
+
+    def companies(options)
+      begin
+        get('companies', options)
+      rescue => e
+        nil
+      end
+    end
   end
 end

data/lib/paychex/configuration.rb

@@ -1,98 +1,98 @@
-require "paychex/version"
-
-module Paychex
-  # Defines constants and methods related to configuration
-  module Configuration
-    # An array of valid keys in the options hash when configuring a {Paychex::API}
-    VALID_OPTIONS_KEYS = [
-      :access_token,
-      :host,
-      :endpoint,
-      :format,
-      :connection_options,
-      :proxy,
-      :environment,
-      :user_agent,
-      :per_page,
-      :timeout,
-      :open_timeout,
-      :token_timeout,
-    ].freeze
-
-    # By default, don't set an access_token
-    DEFAULT_ACCESS_TOKEN = nil
-
-    # By default, return 20 resources per page when there is an pagination.
-    DEFAULT_PER_PAGE = 20
-
-    # By default, don't set connection options.
-    DEFAULT_CONNECTION_OPTIONS = {}
-
-    # Default timeout time is 60 seconds
-    DEFAULT_TIMEOUT = 60
-
-    # By default, the open timeout is 60 seconds.
-    DEFAULT_OPEN_TIMEOUT = 60
-
-    DEFAULT_TOKEN_TIMEOUT = Time.new
-
-    # By default, use sandbox environment
-    DEFAULT_HOST = "https://sandbox.api.paychex.com".freeze
-
-    # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = "https://sandbox.api.paychex.com/".freeze
-
-    # The response format appended to the path and sent in the 'Accept' header if none is set
-    #
-    # @note JSON is the only available format at this time
-    DEFAULT_FORMAT = :json
-
-    # By default, don't use a proxy server
-    DEFAULT_PROXY = nil
-
-    # By default, environment will be sandbox
-    DEFAULT_ENVIRONMENT = "sandbox"
-
-    # The user agent that will be sent to the API endpoint if none is set
-    DEFAULT_USER_AGENT = "Paychex Ruby Gem #{Paychex::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.host = DEFAULT_HOST
-      self.endpoint = DEFAULT_ENDPOINT
-      self.connection_options = DEFAULT_CONNECTION_OPTIONS
-      self.format = DEFAULT_FORMAT
-      self.proxy = DEFAULT_PROXY
-      self.environment = DEFAULT_ENVIRONMENT
-      self.user_agent = DEFAULT_USER_AGENT
-      self.per_page = DEFAULT_PER_PAGE
-      self.timeout = DEFAULT_TIMEOUT
-      self.open_timeout = DEFAULT_OPEN_TIMEOUT
-      self.token_timeout = DEFAULT_TOKEN_TIMEOUT
-    end
-  end
-end
+require "paychex/version"
+
+module Paychex
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Paychex::API}
+    VALID_OPTIONS_KEYS = [
+      :access_token,
+      :host,
+      :endpoint,
+      :format,
+      :connection_options,
+      :proxy,
+      :environment,
+      :user_agent,
+      :per_page,
+      :timeout,
+      :open_timeout,
+      :token_timeout,
+    ].freeze
+
+    # By default, don't set an access_token
+    DEFAULT_ACCESS_TOKEN = nil
+
+    # By default, return 20 resources per page when there is an pagination.
+    DEFAULT_PER_PAGE = 100
+
+    # By default, don't set connection options.
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # Default timeout time is 60 seconds
+    DEFAULT_TIMEOUT = 60
+
+    # By default, the open timeout is 60 seconds.
+    DEFAULT_OPEN_TIMEOUT = 60
+
+    DEFAULT_TOKEN_TIMEOUT = Time.new
+
+    # By default, use sandbox environment
+    DEFAULT_HOST = "https://sandbox.api.paychex.com".freeze
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = "https://sandbox.api.paychex.com/".freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is the only available format at this time
+    DEFAULT_FORMAT = :json
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # By default, environment will be sandbox
+    DEFAULT_ENVIRONMENT = "sandbox"
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Paychex Ruby Gem #{Paychex::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.host = DEFAULT_HOST
+      self.endpoint = DEFAULT_ENDPOINT
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.format = DEFAULT_FORMAT
+      self.proxy = DEFAULT_PROXY
+      self.environment = DEFAULT_ENVIRONMENT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.per_page = DEFAULT_PER_PAGE
+      self.timeout = DEFAULT_TIMEOUT
+      self.open_timeout = DEFAULT_OPEN_TIMEOUT
+      self.token_timeout = DEFAULT_TOKEN_TIMEOUT
+    end
+  end
+end

data/lib/paychex/connection.rb

@@ -1,32 +1,32 @@
-require 'faraday_middleware'
-require 'faraday/raise_paychex_http_exception'
-
-module Paychex
-  module Connection
-    private
-
-    def connection
-      options = {
-        headers: {
-          'Accept' => "application/#{format}",
-          'User-Agent' => user_agent
-        },
-        proxy: proxy,
-        url: endpoint
-      }.merge(connection_options)
-
-      Faraday::Connection.new(options) do |conn|
-        conn.authorization :Bearer, access_token unless access_token.nil?
-        # https://github.com/lostisland/faraday/issues/417#issuecomment-223413386
-        conn.options[:timeout] = timeout
-        conn.options[:open_timeout] = open_timeout
-        conn.request :json
-        conn.request :instrumentation, name: 'request.paychex'
-
-        conn.use ::PaychexFaradayMiddleWare::RaisePaychexHttpException
-        conn.response :json, content_type: /\bjson$/
-        conn.adapter Faraday.default_adapter
-      end
-    end
-  end
-end
+require 'faraday_middleware'
+require 'faraday/raise_paychex_http_exception'
+
+module Paychex
+  module Connection
+    private
+
+    def connection
+      options = {
+        headers: {
+          'Accept' => "application/#{format}",
+          'User-Agent' => user_agent
+        },
+        proxy: proxy,
+        url: endpoint
+      }.merge(connection_options)
+
+      Faraday::Connection.new(options) do |conn|
+        conn.authorization :Bearer, access_token unless access_token.nil?
+        # https://github.com/lostisland/faraday/issues/417#issuecomment-223413386
+        conn.options[:timeout] = timeout
+        conn.options[:open_timeout] = open_timeout
+        conn.request :json
+        conn.request :instrumentation, name: 'request.paychex'
+
+        conn.use ::PaychexFaradayMiddleWare::RaisePaychexHttpException
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/paychex/version.rb

@@ -1,3 +1,3 @@
-module Paychex
-  VERSION = '0.3.3'
-end
+module Paychex
+  VERSION = '0.3.5'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paychex
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Mayank Dedhia
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,7 +199,7 @@ metadata:
   homepage_uri: https://github.com/helloworld1812/paychex-ruby-gem
   source_code_uri: https://github.com/helloworld1812/paychex-ruby-gem
   changelog_uri: https://github.com/helloworld1812/paychex-ruby-gem/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +214,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for paychex.com APIs.
 test_files: []