stackone_hris_client 1.2.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b241dfbdc84f9582c191a12537b373ba49a14bdb881696ba1c7a64e1f74fb44c
-  data.tar.gz: 4ad67d1f9c45f73bfe9bf01719756dfcf2a4a4c6e6415989598e07039b3c52db
+  metadata.gz: 1f1bac9ffe1525736d5a4ee2b28ee7e86cc2dd02bad121ecca41aa0ab4e63626
+  data.tar.gz: feabaa81170c42b918e0b38779adc0c3f7880fdd6986af237b3a7b71c553c0d6
 SHA512:
-  metadata.gz: d06a74f8d0f275a95872fc8aad9202f98ad2a0bf26419f6bf1ece43e3df44b9f14e1ed5de9861170d363b25003fae1701e16e7d0427f2a47f1fb35eeecdb7a67
-  data.tar.gz: ca8692bc6cd8bd58e0e0891d6c126f19e538b5d596bacca4d14e2a20f2a438ecf8be52b6dbbb4d737f075b93aa5873fdadfc66a903424b305f3ade27e889f5d8
+  metadata.gz: ddc9ed201b396bdd1bece98c4a182ce9fa922c613a5559b6e708d15ad271238ae40c8713b29ce8913ce712fb3b9caf5942423ad264b3587dc44fd02a28204117
+  data.tar.gz: 1e21f2116a2d4808dd455e3b9ea6759c3c12b79a86a6dfede62b10cda78b2927e15c58ba9c893d80dc4f275812ea994522fe64f0455e702770af37ce508a4a23

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stackone_hris_client (1.2.2)
+    stackone_hris_client (1.3.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -7,7 +7,7 @@ The documentation for the StackOne Unified API - HRIS
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.2.2
+- Package version: 1.3.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,16 +23,16 @@ gem build stackone_hris_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./stackone_hris_client-1.2.2.gem
+gem install ./stackone_hris_client-1.3.1.gem
 ```
 
-(for development, run `gem install --dev ./stackone_hris_client-1.2.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./stackone_hris_client-1.3.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'stackone_hris_client', '~> 1.2.2'
+    gem 'stackone_hris_client', '~> 1.3.1'
 
 ### Install from Git
 

data/gem-config.yml

@@ -10,5 +10,5 @@ additionalProperties:
   gemName: "stackone_hris_client"
   gemRequiredRubyVersion: ">= 2.7"
   gemSummary: "StackOne HRIS client gem"
-  gemVersion: "1.2.2"
+  gemVersion: "1.3.1"
   library: "typhoeus"

data/lib/stackone_hris_client/api_client.rb

@@ -46,7 +46,7 @@ module StackOneHRIS
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
-    def call_api(http_method, path, opts = {})
+    def call_api_basic(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
       response = request.run
 
@@ -77,6 +77,12 @@ module StackOneHRIS
       return data, response.code, response.headers
     end
 
+    def call_api(http_method, path, opts = {})
+      retries_errors_with_exponential_backoff do
+        return call_api_basic(http_method, path, opts)
+      end
+    end
+
     # Builds the HTTP request
     #
     # @param [String] http_method HTTP method/verb (e.g. POST)
@@ -158,6 +164,41 @@ module StackOneHRIS
       data
     end
 
+    def retries_errors_with_exponential_backoff(
+      max_retries: @config.max_retries,
+      initial_backoff_seconds: @config.initial_backoff_seconds,
+      max_backoff_seconds: @config.max_backoff_seconds,
+      &block
+    )
+      retry_count = 0
+      backoff_seconds = initial_backoff_seconds
+
+      loop do
+        begin
+          yield
+          break
+        rescue ApiError => e
+          raise e unless @config.retry_status_codes.include? e.code
+
+          if @config.debugging
+            @config.logger.debug "The error code (#{e.code}) matches retry_status_codes list. Retrying #(#{retry_count}) in #{backoff_seconds}s..."
+          end
+
+          if retry_count >= max_retries
+            if @config.debugging
+              @config.logger.debug "Maximum number of retries (#{max_retries}) reached. Raising exception: #{e}"
+            end
+
+            raise e
+          else
+            sleep backoff_seconds
+            retry_count += 1
+            backoff_seconds = [backoff_seconds * 2, max_backoff_seconds].min
+          end
+        end
+      end
+    end
+
     # Save response body into a file in (the defined) temporary folder, using the filename
     # from the "Content-Disposition" header if provided, otherwise a random filename.
     # The response body is written to the file in chunks in order to handle files which

data/lib/stackone_hris_client/configuration.rb

@@ -152,6 +152,18 @@ module StackOneHRIS
 
     attr_accessor :force_ending_format
 
+    # Set this to customize the number of times to retry an API call when a server error occurs.
+    attr_accessor :max_retries
+
+    # Set this to customize the initial number of seconds to wait before retrying an API call when a server error occurs.
+    attr_accessor :initial_backoff_seconds
+
+    # Set this to customize the maximum number of seconds to keep retrying an API call when a server error occurs.
+    attr_accessor :max_backoff_seconds
+
+    # Define the status codes that should be retried.
+    attr_accessor :retry_status_codes
+
     def initialize
       @scheme = 'https'
       @host = 'stackone.com'
@@ -173,6 +185,12 @@ module StackOneHRIS
       @debugging = false
       @inject_format = false
       @force_ending_format = false
+
+      @max_retries = 20
+      @initial_backoff_seconds = 30
+      @max_backoff_seconds = 180
+      @retry_status_codes = [429]
+
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
 
       yield(self) if block_given?

data/lib/stackone_hris_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.5.0
 =end
 
 module StackOneHRIS
-  VERSION = '1.2.2'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackone_hris_client
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.1
 platform: ruby
 authors:
 - StackOne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus