hubspot-api-client 14.1.0 → 14.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 258c55c06d2bb92967ba618919065c527f886d5066f771fae9cd40bde1f7999e
-  data.tar.gz: deb1a80f49da296b0ea65e5bbdd8736f8568167808974db91dbfbbb4b62f8e5e
+  metadata.gz: 8a4cd52d4916355ef186e0e1c115027bbabc111b46c537eee81ee9eed1a4758e
+  data.tar.gz: 4915341310b70bd5ad5b5476b9a1a70d86fecb0f6f9b0a0a4581d68353b78a91
 SHA512:
-  metadata.gz: 1551a766599640bfef6efc93bb4709c9c0af1d96949787e539b02c130aa744cf4c03d09600668faccc6da656faa324eb5422f5deb71dc5d97f71a5de143cfab6
-  data.tar.gz: c111b2335a6e5b938d3ca0844f4185d2c1637c9b36856ee49e42bb2d6131521e758ecaf2ffac6e91232f692cb540e21a86579f4c57fbc5d161d4623ee5621238
+  metadata.gz: 989b451ae98b489c0df15533ab91ac351b11d864ce6a48b2f2d464cd1654234a14ae9ab4f828e93ae5e5fcf636f0948fd4f155dbf1ceec759afbef6094ddc1fd
+  data.tar.gz: 6050d81e977c5b24a5844eaf8087cdb78d846f592ad4cd6ea004653c81a05dec6f7b8f8e5051f99d55e7cfcaa2e9aeb9218389cad396092cca1272b38427ee70

data/CHANGELOG.md

@@ -5,6 +5,36 @@ 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.2] - 2022-10-05
+### Fixed
+
+- passing params with existing model
+
+## [14.5.1] - 2022-09-30
+### Changed
+
+- with_http methods were added to the discovery classes
+
+## [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
+
+- using hash instead of model object for Hubspot::Client with body param
+
+## [14.2.0] - 2022-08-25
+### Changed
+
+- using new separate configurations for Hubspot::Client
+
 ## [14.1.0] - 2022-08-23
 ### Changed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (14.1.0)
+    hubspot-api-client (14.5.2)
       json (~> 2.1, >= 2.1.0)
       require_all (~> 3.0.0)
       typhoeus (~> 1.4.0)
@@ -10,8 +10,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     ZenTest (4.12.1)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     autotest-growl (0.2.16)
@@ -29,7 +29,7 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.7)
+    public_suffix (5.0.0)
     rake (12.3.3)
     rake-release (1.3.0)
       bundler (>= 1.11, < 3)
@@ -41,17 +41,17 @@ 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)
-    webmock (3.17.1)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -116,9 +116,62 @@ object_schema_egg = ::Hubspot::Crm::Schemas::ObjectSchemaEgg.new(
 api_response = api.create(object_schema_egg)
 ```
 
+for new discovery classes since version 14.3
+```ruby
+client = Hubspot::Client.new(access_token: 'your_oauth2_access_token')
+
+labels = {
+  singular: 'My object',
+  plural: 'My objects'
+}
+
+option = {
+  label: 'Option A',
+  value: 'A',
+  description: 'Choice number one',
+  display_order: 1,
+  hidden: false
+}
+
+property = {
+  name: 'property001',
+  label: 'My object property',
+  group_name: 'my_object_information',
+  options: [option],
+  display_order: 2,
+  type: 'enumeration',
+  field_type: 'select'
+}
+
+body = {
+  labels: labels,
+  required_properties: ['property001'],
+  searchable_properties: [],
+  primary_display_property: 'property001',
+  secondary_display_properties: [],
+  properties: [property],
+  associated_objects: ['CONTACT'],
+  name: 'my_object'
+}
+
+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:
@@ -143,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/client.rb

@@ -2,8 +2,6 @@ require_rel 'discovery'
 
 module Hubspot
   class Client
-    attr_reader :api_key, :access_token
-
     def self.api_modules
       %i[
         automation
@@ -28,25 +26,9 @@ module Hubspot
       'Hubspot::Discovery'
     end
 
-    def configure_api_key
-      Hubspot.configure do |config|
-        config.api_key['hapikey'] = api_key
-      end
-    end
-
-    def configure_access_token
-      Hubspot.configure do |config|
-        config.access_token = access_token
-      end
-    end
-
     def initialize(params)
       raise 'Please, pass :api_key or :access_token' if params[:api_key].nil? && params[:developer_api_key].nil? && params[:access_token].nil?
-      @api_key = params[:api_key] || params[:developer_api_key]
-      @access_token = params[:access_token]
       @params = params
-      configure_api_key if @api_key
-      configure_access_token if @access_token
     end
   end
 end

data/lib/hubspot/discovery/base_api_client.rb

@@ -1,3 +1,5 @@
+require_rel '../helpers/camel_case'
+
 module Hubspot
   module Discovery
     module BaseApiClient
@@ -9,15 +11,22 @@ module Hubspot
       end
 
       def api_methods
-        api.methods.grep(/with_http_info/).map {|elem| elem.to_s.gsub('_with_http_info', '').to_sym }
+        api.methods.grep(/with_http_info/).inject([]) do |methods, method|
+          methods << method
+          methods << method.to_s.gsub('_with_http_info', '').to_sym
+        end
+      end
+
+      def config
+        @config ||= new_config
       end
 
       def api_client
-        api&.api_client
+        @api_client ||= Kernel.const_get("#{codegen_module_name}::ApiClient").new(config)
       end
 
       def api
-        @api ||= Kernel.const_get(codegen_api_class).new
+        @api ||= Kernel.const_get(codegen_api_class).new(api_client)
       end
 
       def get_all(params = {})
@@ -26,17 +35,66 @@ module Hubspot
 
       private
 
+      def new_config
+        config = Kernel.const_get("#{self.class.name.gsub('Discovery::', '').gsub(/(.*)::.*/, '\1')}::Configuration").new
+        config.access_token = base_params[:access_token] if base_params[:access_token]
+        config.api_key['hapikey'] = base_params[:api_key] if base_params[:api_key]
+        config.api_key['hapikey'] = base_params[:developer_api_key] if base_params[:developer_api_key]
+        config
+      end
+
       def codegen_api_class
         self.class.name.gsub('Discovery::', '')
       end
 
+      def codegen_module_name
+        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]
@@ -53,15 +111,23 @@ 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 unless signature_param_names.include?(param_name)
+              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|
-              raise "Param #{param} is required for #{api.class}\##{api_method} method" if req == :req && params_with_defaults[param].nil?
-              params_with_defaults[param]
+              if params_with_defaults[param].nil?
+                model_name = Hubspot::Helpers::CamelCase.new.format(param.to_s)
+                Kernel.const_get("#{codegen_module_name}::#{model_name}").build_from_hash(params_with_defaults[:body])
+              else
+                params_with_defaults[param]
+              end
+            rescue NameError
+              raise "Param #{param} is required for #{api.class}\##{api_method} method" if req == :req
             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.1.0'
+  VERSION = '14.5.2'
  end

data/spec/discovery/base_api_client_spec.rb

@@ -6,6 +6,9 @@ describe 'Hubspot::Discovery::BaseApiClient' do
   end
 
   class Hubspot::SomeApiClass
+    def initialize(api_client)
+    end
+
     def get(test_id, opts = {})
       "got test_id: #{test_id}, opts: #{opts}"
     end
@@ -14,20 +17,66 @@ describe 'Hubspot::Discovery::BaseApiClient' do
     end
 
     def update(test_id, simple_public_object_input, opts = {})
-      "updated test_id: #{test_id}, simple_public_object_input: #{simple_public_object_input}, opts: #{opts}"
+      "updated test_id: #{test_id}, name: #{simple_public_object_input.name}, email: #{simple_public_object_input.email}, opts: #{opts}"
     end
 
     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
+    def initialize(config)
+    end
+  end
+
+  class Hubspot::ApiError < ::StandardError
+    def message
+      'test error'
+    end
+
+    def code
+      429
+    end
+  end
+
+  class Hubspot::SimplePublicObjectInput
+    attr_reader :name, :email
+
+    def initialize(params)
+      @name = params[:name]
+      @email = params[:email]
+    end
+
+    def self.build_from_hash(params)
+      new(params)
+    end
   end
 
   subject(:client) { Hubspot::Discovery::SomeApiClass.new(access_token: 'test') }
   let(:api) { client.api }
+  let(:body) { {name: 'test_name', email: 'test_email'} }
   
   it { is_expected.to respond_to(:get) }
   it { is_expected.to respond_to(:update) }
-  it { is_expected.not_to respond_to(:get_with_http_info) }
-  it { is_expected.not_to respond_to(:update_with_http_info) }
+  it { is_expected.to respond_to(:get_with_http_info) }
+  it { is_expected.to respond_to(:update_with_http_info) }
 
   describe '#get' do
     subject(:get) { client.get(params) }
@@ -43,27 +92,75 @@ 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
     subject(:update) { client.update(params) }
 
     context 'with default params order' do
-      let(:params) { {test_id: 'test_id_value', simple_public_object_input: 'simple_public_object_input_value', limit: 10} }
+      let(:params) { {test_id: 'test_id_value', simple_public_object_input: Hubspot::SimplePublicObjectInput.new(body), limit: 10} }
 
-      it { is_expected.to eq('updated test_id: test_id_value, simple_public_object_input: simple_public_object_input_value, opts: {:auth_names=>"oauth2", :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
 
     context 'with reversed params order' do
-      let(:params) { {limit: 5, simple_public_object_input: 'simple_public_object_input_value', test_id: 'test_id_value'} }
+      let(:params) { {limit: 5, simple_public_object_input: Hubspot::SimplePublicObjectInput.new(body), test_id: 'test_id_value'} }
       
-      it { is_expected.to eq('updated test_id: test_id_value, simple_public_object_input: simple_public_object_input_value, opts: {:auth_names=>"oauth2", :limit=>5}') }
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>5}') }
     end
 
     context 'with shuffled params order' do
-      let(:params) { {simple_public_object_input: 'simple_public_object_input_value', limit: 7, test_id: 'test_id_value'} }
+      let(:params) { {simple_public_object_input: Hubspot::SimplePublicObjectInput.new(body), limit: 7, test_id: 'test_id_value'} }
       
-      it { is_expected.to eq('updated test_id: test_id_value, simple_public_object_input: simple_public_object_input_value, opts: {:auth_names=>"oauth2", :limit=>7}') }
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>7}') }
+    end
+
+    context 'with body' do
+      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
+
+    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.1.0
+  version: 14.5.2
 platform: ruby
 authors:
 - HubSpot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus