hubspot-api-client 14.3.0 → 14.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab00d972a316aadaced5d712c7abe5d86ddab1236caa123a8b44d0b9cfcfeac
-  data.tar.gz: 9ed639a810e45d0601188e0b56b102a71a51312580aa7f12ceca3a0ba5ea291d
+  metadata.gz: 9767c7c7c1e949bd93690f2c111d3e47141be1ca597f99091402eba1ca3f968e
+  data.tar.gz: f435e7e0e1a4bff0d0f9e57a1dc284a9a48293e036bd8c1cfbf0e1b408825f9a
 SHA512:
-  metadata.gz: d478dd41e3b787640f72f395b6a7c79e7e05819c2ed507fe03a2594b190345b0c31b57299a15ceac472bd1b6ad0ce065c40cd57c41fc040f8e981aae0b7c67df
-  data.tar.gz: 469b1fe3d0660baf67e66e44fbcbb0968292038663bd1918312bcb123de055bcaf24178e0fe95b1a29885f06ae34a88310251669d7d9efa6649049822c26de91
+  metadata.gz: b383cf4b93fb791e6869120c1b4c7952a2b6242a355c4d958c1de1523ccee00aeac3210c0949ea7e22065f2ff2c67304a31eaeb4c788dcbd0d5e95529f19755a
+  data.tar.gz: 344aafe31b45ff09eec055504ab455a0548ed30c29bd51dba84ab33918c68390e4f442e4302eef20075cc6b1c802e846a7dc5008c266bfbdf7f84f4c4243ba53

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [14.5.0] - 2022-09-30
+### Changed
+
+- handling ApiError with retries
+
+## [14.4.0] - 2022-09-27
+### Changed
+
+- handling ApiError by passing a block
+
 ## [14.3.0] - 2022-08-31
 ### Changed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (14.3.0)
+    hubspot-api-client (14.5.0)
       json (~> 2.1, >= 2.1.0)
       require_all (~> 3.0.0)
       typhoeus (~> 1.4.0)
@@ -41,13 +41,13 @@ GEM
       rspec-mocks (~> 3.11.0)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+    rspec-support (3.11.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)

data/README.md

@@ -160,6 +160,18 @@ api_response = client.crm.schemas.core_api.create(body: body)
 
 ### Error handling
 
+for new discovery classes since version 14.4
+
+#### You can rescue an ApiError by passing a block to the method
+
+```ruby
+require 'hubspot-api-client'
+
+client = Hubspot::Client.new(access_token: 'your_access_token')
+
+contacts = client.crm.contacts.basic_api.get_page { |error| error.message }
+```
+
 #### You can set number of retry attempts and delay in seconds before retry on specific status code of response.
 
 Available params:
@@ -184,6 +196,28 @@ api_client = ::Hubspot::Crm::Companies::ApiClient.new(config)
 basic_api = ::Hubspot::Crm::Companies::BasicApi.new(api_client)
 ```
 
+for new discovery classes since version 14.5
+
+Available params:
+  - max_retries (maximum number of retries)
+  - seconds_delay (pause in seconds between retries)
+  - passing a block (block that handles errors occured)
+
+
+```ruby
+require 'hubspot-api-client'
+
+# Set handlers of statuses you want to handle
+retry_config = {
+  500..530 => { max_retries: 2, seconds_delay: 2 },
+  400 => { max_retries: 3, seconds_delay: 3 }
+}
+
+client = Hubspot::Client.new(access_token: 'your_access_token')
+
+contacts = client.crm.contacts.basic_api.get_page(retry: retry_config) { |error| error.code }
+```
+
 ### Sample apps
 
 Please, take a look at our [Sample apps](https://github.com/HubSpot/sample-apps-list)

data/lib/hubspot/discovery/base_api_client.rb

@@ -48,13 +48,50 @@ module Hubspot
         codegen_api_class.gsub(/(.*)::.*/, '\1')
       end
 
+      def call_api(api_method, params_to_pass)
+        api.public_send(api_method, *params_to_pass)
+      end
+
+      def call_api_with_rescue(api_method, params_to_pass)
+        error = Kernel.const_get("#{codegen_module_name}::ApiError")
+        call_api(api_method, params_to_pass)
+      rescue error => e
+        yield(e)
+      end
+
+      def call_api_with_retry(api_method, params_to_pass, retry_config, &block)
+        call_api_with_rescue(api_method, params_to_pass) do |error|
+          opts = retry_config.detect{ |k,v| k === error.code }&.last
+          retries = opts&.dig(:max_retries) || 5
+
+          block.call(error) unless block.nil?
+
+          response = error
+
+          while retries > 0 && opts
+            sleep opts[:seconds_delay] if opts[:seconds_delay]
+            response = call_api_with_rescue(api_method, params_to_pass) do |e|
+              block.call(e) unless block.nil?
+              e
+            end
+
+            return response unless response.respond_to?(:code)
+
+            opts = retry_config.detect{ |k,v| k === response.code }&.last
+            retries -= 1
+          end
+
+          response
+        end
+      end
+
       def define_methods
         define_api_methods
       end
       
       def define_api_methods
         api_methods.each do |api_method|
-          self.class.define_method(api_method) do |params = {}|
+          self.class.define_method(api_method) do |params = {}, &block|
             params_with_defaults = params
             params_with_defaults[:opts] ||= {}
             params_with_defaults[:opts][:auth_names] = if base_params[:access_token]
@@ -71,7 +108,7 @@ module Hubspot
 
             signature_param_names = signature_params.map { |_, param| param }
             params_with_defaults.each do |param_name, param_value|
-              params_with_defaults[:opts][param_name] = param_value if !signature_param_names.include?(param_name) && param_name != :body
+              params_with_defaults[:opts][param_name] = param_value if !signature_param_names.include?(param_name) && param_name != :body && param_name != :retry
             end
 
             params_to_pass = signature_params.map do |req, param|
@@ -83,7 +120,9 @@ module Hubspot
               params_with_defaults[param]
             end
 
-            api.public_send(api_method, *params_to_pass)
+            return call_api_with_retry(api_method, params_to_pass, params[:retry], &block) unless params[:retry].nil?
+            return call_api_with_rescue(api_method, params_to_pass, &block) unless block.nil?
+            call_api(api_method, params_to_pass)
           end
         end
       end

data/lib/hubspot/version.rb

@@ -1,3 +1,3 @@
  module Hubspot
-  VERSION = '14.3.0'
+  VERSION = '14.5.0'
  end

data/spec/discovery/base_api_client_spec.rb

@@ -22,6 +22,23 @@ describe 'Hubspot::Discovery::BaseApiClient' do
 
     def update_with_http_info
     end
+
+    def raise_error
+      raise Hubspot::ApiError
+    end
+
+    def raise_error_with_http_info
+    end
+
+    def raise_error_on_third_call
+      @calls_count ||= 0
+      @calls_count += 1
+      raise Hubspot::ApiError if @calls_count < 3
+      'ok'
+    end
+
+    def raise_error_on_third_call_with_http_info
+    end
   end
 
   class Hubspot::ApiClient
@@ -29,6 +46,16 @@ describe 'Hubspot::Discovery::BaseApiClient' do
     end
   end
 
+  class Hubspot::ApiError < ::StandardError
+    def message
+      'test error'
+    end
+
+    def code
+      429
+    end
+  end
+
   class Hubspot::SimplePublicObjectInput
     attr_reader :name, :email
 
@@ -65,6 +92,13 @@ describe 'Hubspot::Discovery::BaseApiClient' do
 
       it { is_expected.to eq('got test_id: test_id_value, opts: {:auth_names=>"oauth2", :limit=>5}') }
     end
+
+    context 'with error handle block' do
+      subject(:get) { client.get(params) { |e| e.message } }
+      let(:params) { {test_id: 'test_id_value', limit: 10} }
+
+      it { is_expected.to eq('got test_id: test_id_value, opts: {:auth_names=>"oauth2", :limit=>10}') }
+    end
   end
   
   describe '#update' do
@@ -93,5 +127,40 @@ describe 'Hubspot::Discovery::BaseApiClient' do
 
       it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>10}') }
     end
+
+    context 'with block' do
+      subject(:update) { client.update(params) { |e| e.message } }
+      let(:params) { {test_id: 'test_id_value', body: body, limit: 10} }
+
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>10}') }
+    end
+  end
+
+  describe '#raise_error' do
+    subject(:raise_error) { client.raise_error { |e| e.message } }
+
+    it { is_expected.to eq('test error') }
+  end
+
+  describe '#raise_error_on_third_call' do
+    subject(:raise_error_on_third_call) { client.raise_error_on_third_call(retry: retry_config) }
+
+    context 'with 2 retries' do
+      let(:retry_config) { {429 => { max_retries: 2 }} }
+
+      it { is_expected.to eq('ok') }
+
+      context 'with range config' do
+        let(:retry_config) { {429..442 => { max_retries: 2 }} }
+
+        it { is_expected.to eq('ok') }
+      end
+    end
+
+    context 'with 1 retry' do
+      let(:retry_config) { {429 => { max_retries: 1 }} }
+
+      it { is_expected.to have_attributes(code: 429, message: 'test error') }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-client
 version: !ruby/object:Gem::Version
-  version: 14.3.0
+  version: 14.5.0
 platform: ruby
 authors:
 - HubSpot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus