basecrm 1.3.10 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9c7c2b6f189115331790b2027167f24bdf1622b7e7ac9118194c12de64f5546
-  data.tar.gz: 9c6344acf5d6453a8e856e1e897167c71d4da90ae3fbf0c3926ca47f7164f67b
+  metadata.gz: 2cbaf008b35c02a9330bcc937cce7b22193ae82a12aedfbdad924701490227c0
+  data.tar.gz: fed5a5badb4163c281be2f271503507f17cc385bca983e9489519f074a8d9da6
 SHA512:
-  metadata.gz: 228dbe4fae8b33c86f6441f2719d87f122be51c8d53188392585b93b541609f9095ee3c978c4d09c72fd4a187d7f709665283579c51869f2064bea051e0e7dfb
-  data.tar.gz: a08d41e8009afcc221cd0b602bff61c51c1ec141ea0df3b99ddf57156b02af340721c8620a06033c677fc8767b798842603b7e65d3f64e8888a98da9b250db39
+  metadata.gz: 7d70a8c2558153ba60f3af7fd27d8ecd25ee116c7f21a9438c1785e80668761c1773a5fb8b2794219c9a5a11b39800363e548971d6d25016aa468c6d1e0260cd
+  data.tar.gz: 595a8e756d8b3638901165380d07e491f6f65c3ec6e181dcb7295a92487a4393e4db48711ed3fa99f7a634daf4af1e2580af0de0c2814f8c40de74bc6897a85f

data/README.md

@@ -49,6 +49,8 @@ The following options are available while instantiating a client:
  * __timeout__: Request timeout
  * __verbose__: Verbose/debug mode
  * __logger__: Logger used in verbose mode
+ * __max_retry__: Number of retries on failed requests. Passed to Faraday
+ * __retry_statuses__: By default only timeout error will be retries. This allows to retry on specific HTTP statuses. Passed to Faraday
 
 ### Architecture
 

data/lib/basecrm/configuration.rb

@@ -7,6 +7,8 @@ module BaseCRM
     attr_reader :user_agent
     attr_reader :timeout
     attr_reader :verify_ssl
+    attr_reader :max_retry
+    attr_reader :retry_statuses
 
     attr_reader :logger, :verbose
     alias_method :debug?, :verbose
@@ -19,6 +21,8 @@ module BaseCRM
       @verbose = !!options[:verbose]
       @timeout = options[:timeout] || 30
       @verify_ssl = options.fetch(:verify_ssl, true)
+      @max_retry = options[:max_retry]
+      @retry_statuses = options[:retry_statuses]
     end
 
     def validate!

data/lib/basecrm/http_client.rb

@@ -22,6 +22,7 @@ module BaseCRM
       options[:ssl] = { verify: false } unless config.verify_ssl
 
       @client = Faraday.new(config.base_url, options) do |faraday|
+        faraday.request :retry, retry_options
         faraday.use BaseCRM::Middlewares::OAuthBearerToken, config.access_token
         faraday.use BaseCRM::Middlewares::RaiseError
         faraday.response :logger, config.logger if config.debug?
@@ -74,7 +75,7 @@ module BaseCRM
       body = extract_body(res)
       @config.logger.debug body if @config.debug? && body && @config.logger
       [res.status, res.headers, body]
-    rescue Faraday::Error::ConnectionFailed => e
+    rescue Faraday::ConnectionFailed => e
       raise ConnectionError, e.message
     end
 
@@ -89,5 +90,12 @@ module BaseCRM
       content_type = res.headers['Content-Type']
       content_type && content_type.include?('json') ? JSON.parse(res.body, symbolize_names: true) : res.body
     end
+
+    def retry_options
+      retry_options = {}
+      retry_options[:max] = @config.max_retry if @config.max_retry
+      retry_options[:retry_statuses] = @config.retry_statuses if @config.retry_statuses
+      retry_options
+    end
   end
 end

data/lib/basecrm/version.rb

@@ -1,3 +1,3 @@
 module BaseCRM
-  VERSION = "1.3.10"
+  VERSION = "2.0.0"
 end

data/spec/http_client_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe BaseCRM::HttpClient do
+  describe 'Retries' do
+    let(:statuses_to_retry) { [503] }
+    let(:max_retry) { 3 }
+    subject(:client_with_retry) { client_with_basic_retry(max_retry: max_retry, on_statuses: statuses_to_retry) }
+
+    it "should pass retry statues to Faraday and do a valid request" do
+      expect(client_with_retry.http_client.client.app.options.retry_statuses).to match_array(statuses_to_retry)
+      expect(client_with_retry.http_client.client.app.options.max).to eq(max_retry)
+      expect(client_with_retry.accounts.self).to be_instance_of BaseCRM::Account
+    end
+  end
+end

data/spec/support/client_helpers.rb

@@ -3,6 +3,10 @@ module ClientHelpers
     @client ||= BaseCRM::Client.new(access_token: access_token, base_url: base_url)
   end
 
+  def client_with_basic_retry(max_retry: 1, on_statuses: [])
+    @client_with_basic_retry ||= BaseCRM::Client.new(access_token: access_token, base_url: base_url, max_retry: max_retry, retry_statuses: on_statuses)
+  end
+
   def access_token
     @access_token ||= ENV.fetch("BASECRM_ACCESS_TOKEN") { raise '"BASECRM_ACCESS_TOKEN" has not been found.'  }
   end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: basecrm
 version: !ruby/object:Gem::Version
-  version: 1.3.10
+  version: 2.0.0
 platform: ruby
 authors:
 - Zendesk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +205,7 @@ files:
 - spec/factories/tag.rb
 - spec/factories/task.rb
 - spec/factories/text_message.rb
+- spec/http_client_spec.rb
 - spec/middlewares/raise_error_spec.rb
 - spec/models/sync_meta_spec.rb
 - spec/services/accounts_service_spec.rb
@@ -267,54 +262,55 @@ signing_key:
 specification_version: 4
 summary: Zendesk Sell Official API V2 library client for ruby
 test_files:
-- spec/models/sync_meta_spec.rb
-- spec/factories/associated_contact.rb
-- spec/factories/tag.rb
-- spec/factories/contact.rb
-- spec/factories/deal_source.rb
-- spec/factories/lead_unqualified_reason.rb
-- spec/factories/loss_reason.rb
-- spec/factories/line_item.rb
-- spec/factories/product.rb
-- spec/factories/deal_unqualified_reason.rb
-- spec/factories/order.rb
-- spec/factories/source.rb
-- spec/factories/task.rb
-- spec/factories/lead_source.rb
-- spec/factories/text_message.rb
-- spec/factories/call.rb
-- spec/factories/deal.rb
-- spec/factories/note.rb
-- spec/factories/lead.rb
-- spec/basecrm/sync_spec.rb
-- spec/support/client_helpers.rb
 - spec/spec_helper.rb
-- spec/middlewares/raise_error_spec.rb
-- spec/utils/coercion_spec.rb
-- spec/utils/coercion.rb
-- spec/services/line_items_service_spec.rb
-- spec/services/deal_unqualified_reasons_service_spec.rb
+- spec/services/calls_service_spec.rb
+- spec/services/deals_service_spec.rb
 - spec/services/stages_service_spec.rb
+- spec/services/users_service_spec.rb
+- spec/services/tasks_service_spec.rb
+- spec/services/lead_unqualified_reasons_service_spec.rb
+- spec/services/deal_sources_service_spec.rb
+- spec/services/products_service_spec.rb
+- spec/services/accounts_service_spec.rb
 - spec/services/call_outcomes_service_spec.rb
-- spec/services/lead_sources_service_spec.rb
 - spec/services/pipelines_service_spec.rb
-- spec/services/lead_unqualified_reasons_service_spec.rb
-- spec/services/text_messages_service_spec.rb
-- spec/services/sources_service_spec.rb
 - spec/services/contacts_service_spec.rb
-- spec/services/loss_reasons_service_spec.rb
-- spec/services/deals_service_spec.rb
-- spec/services/calls_service_spec.rb
-- spec/services/sync_service_spec.rb
-- spec/services/associated_contacts_service_spec.rb
 - spec/services/orders_service_spec.rb
+- spec/services/visits_service_spec.rb
 - spec/services/leads_service_spec.rb
-- spec/services/tasks_service_spec.rb
-- spec/services/deal_sources_service_spec.rb
-- spec/services/notes_service_spec.rb
-- spec/services/accounts_service_spec.rb
+- spec/services/sources_service_spec.rb
+- spec/services/lead_sources_service_spec.rb
+- spec/services/sync_service_spec.rb
 - spec/services/visit_outcomes_service_spec.rb
-- spec/services/visits_service_spec.rb
-- spec/services/products_service_spec.rb
+- spec/services/loss_reasons_service_spec.rb
+- spec/services/associated_contacts_service_spec.rb
+- spec/services/notes_service_spec.rb
+- spec/services/deal_unqualified_reasons_service_spec.rb
 - spec/services/tags_service_spec.rb
-- spec/services/users_service_spec.rb
+- spec/services/line_items_service_spec.rb
+- spec/services/text_messages_service_spec.rb
+- spec/basecrm/sync_spec.rb
+- spec/support/client_helpers.rb
+- spec/factories/lead_unqualified_reason.rb
+- spec/factories/order.rb
+- spec/factories/tag.rb
+- spec/factories/deal.rb
+- spec/factories/source.rb
+- spec/factories/text_message.rb
+- spec/factories/task.rb
+- spec/factories/contact.rb
+- spec/factories/associated_contact.rb
+- spec/factories/line_item.rb
+- spec/factories/deal_source.rb
+- spec/factories/deal_unqualified_reason.rb
+- spec/factories/call.rb
+- spec/factories/note.rb
+- spec/factories/lead_source.rb
+- spec/factories/loss_reason.rb
+- spec/factories/product.rb
+- spec/factories/lead.rb
+- spec/utils/coercion.rb
+- spec/utils/coercion_spec.rb
+- spec/models/sync_meta_spec.rb
+- spec/http_client_spec.rb
+- spec/middlewares/raise_error_spec.rb