basecrm 1.3.7 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 81e618bee05571f2a52e708272b1a98e2df15fea
-  data.tar.gz: c666efadef83778b816dac13d211d285e1db3cd4
+SHA256:
+  metadata.gz: 2cbaf008b35c02a9330bcc937cce7b22193ae82a12aedfbdad924701490227c0
+  data.tar.gz: fed5a5badb4163c281be2f271503507f17cc385bca983e9489519f074a8d9da6
 SHA512:
-  metadata.gz: 49547fc7c42a6bcba273dda105f3615b08840f4ffdcc2398e6b619e2aeb1bac7307ff453514769cc93abd6f4af32fc8cd895089a27bb275ed54b9fa847cefb7b
-  data.tar.gz: 863811e19747374fb1710e8a08a3fc3ccc768a31b1fd0fdd301aec47e02d4698e9c99eb5dfd59b5c744b2649afd99e6685ffba218ba7cf4df8e15d7b8e61f89f
+  metadata.gz: 7d70a8c2558153ba60f3af7fd27d8ecd25ee116c7f21a9438c1785e80668761c1773a5fb8b2794219c9a5a11b39800363e548971d6d25016aa468c6d1e0260cd
+  data.tar.gz: 595a8e756d8b3638901165380d07e491f6f65c3ec6e181dcb7295a92487a4393e4db48711ed3fa99f7a634daf4af1e2580af0de0c2814f8c40de74bc6897a85f

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 Zendesk
+   Copyright 2013 Zendesk
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -21,7 +21,7 @@ gem 'basecrm'
 To get the latest version, put this in your Gemfile:
 
 ```ruby
-gem 'basecrm', :git => 'git://github.com/basecrm/basecrm-ruby.git'
+gem 'basecrm', :git => 'git://github.com/zendesk/basecrm-ruby.git'
 ```
 
 ## Usage
@@ -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
 
@@ -481,10 +483,16 @@ Actions:
 * Retrieve visit outcomes - `client.visit_outcomes.all`
 
 ## Bug Reports
-Report [here](https://github.com/basecrm/basecrm-ruby/issues).
+Report [here](https://github.com/zendesk/basecrm-ruby/issues).
+
+## Releasing new version of gem
+
+1. Update version [lib/basecrm/version.rb](lib/basecrm/version.rb) and [VERSION](VERSION) and push to `master`
+2. Create new GitHub release with tag name starting with `v` and the version, for example `v1.0.0`
+3. Gem will be automatically built and pushed to rubygems.org with GitHub Action
 
 ## Copyright and license
 
-Copyright 2020 Zendesk
+Copyright 2013 Zendesk
 
 Licensed under the [Apache License, Version 2.0](LICENSE)

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/models/deal.rb

@@ -34,7 +34,7 @@ module BaseCRM
     #   @return [Hash] Custom fields are key-value data attached to a deal. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).
     # attr_accessor :custom_fields
     # @!attribute [rw] customized_win_likelihood
-    #   @return [Integer] User-provided win likelihood with value range 0–100.
+    #   @return [Integer] User-provided win likelihood with value range 0-100.
     # attr_accessor :customized_win_likelihood
     # @!attribute [rw] estimated_close_date
     #   @return [String] Estimated close date of the deal
@@ -63,6 +63,9 @@ module BaseCRM
     # @!attribute [rw] tags
     #   @return [Array<String>] An array of tags for a deal. See more at [Tags](/docs/rest/articles/requests#tags).
     # attr_accessor :tags
+    # @!attribute [rw] added_on
+    #   @return [DateTime] Date and time when the deal was added in UTC (ISO8601 format).
+    # attr_accessor :added_on
     # @!attribute [rw] value
     #   @return [BigDecimal] Value of the deal in a currency specified in the `currency` field.
     # attr_accessor :value

data/lib/basecrm/services/deals_service.rb

@@ -2,7 +2,9 @@
 
 module BaseCRM
   class DealsService
-    OPTS_KEYS_TO_PERSIST = Set[:contact_id, :currency, :custom_fields, :hot, :loss_reason_id, :name, :owner_id, :source_id, :stage_id, :tags, :value, :last_stage_change_at, :estimated_close_date, :customized_win_likelihood]
+    OPTS_KEYS_TO_PERSIST = Set[:contact_id, :currency, :custom_fields, :hot, :loss_reason_id,
+      :unqualified_reason_id, :name, :owner_id, :source_id, :stage_id, :tags, :value, :last_stage_change_at,
+      :estimated_close_date, :customized_win_likelihood, :added_on]
 
     def initialize(client)
       @client = client

data/lib/basecrm/version.rb

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

data/spec/factories/contact.rb

@@ -2,7 +2,7 @@ FactoryBot.define do
   factory :contact, class: BaseCRM::Contact do
 
     description { "I know him via Tom" }
-    email { "mark@designservices.com" }
+    email { "mark#{SecureRandom.hex}@example.com" }
     facebook { "mjohnson" }
     fax { "+44-208-1234567" }
     first_name { Faker::Name.first_name }
@@ -17,7 +17,7 @@ FactoryBot.define do
     tags { ["important"] }
     title { "CEO" }
     twitter { "mjohnson" }
-    website { "www.designservices.com" }
+    website { "www.example.com" }
 
 
     to_create do |contact|

data/spec/factories/deal_source.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :deal_source, class: BaseCRM::DealSource do
 
-    name { Faker::Name.name }
+    name { "source#{SecureRandom.hex}" }
 
 
     to_create do |deal_source|

data/spec/factories/deal_unqualified_reason.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :deal_unqualified_reason, class: BaseCRM::DealUnqualifiedReason do
 
-    name { Faker::Name.name }
+    name { "unqualified_reason#{SecureRandom.hex}" }
 
 
     to_create do |deal_unqualified_reason|

data/spec/factories/lead.rb

@@ -2,7 +2,7 @@ FactoryBot.define do
   factory :lead, class: BaseCRM::Lead do
 
     description { "I know him via Tom" }
-    email { "mark@designservices.com" }
+    email { "mark#{SecureRandom.hex}@example.com" }
     facebook { "mjohnson" }
     fax { "+44-208-1234567" }
     first_name { Faker::Name.first_name }
@@ -16,7 +16,7 @@ FactoryBot.define do
     tags { ["important"] }
     title { "CEO" }
     twitter { "mjohnson" }
-    website { "www.designservices.com" }
+    website { "www.example.com" }
 
 
     to_create do |lead|

data/spec/factories/lead_source.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :lead_source, class: BaseCRM::LeadSource do
 
-    name { Faker::Name.name }
+    name { "source#{SecureRandom.hex}" }
 
 
     to_create do |lead_source|

data/spec/factories/loss_reason.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :loss_reason, class: BaseCRM::LossReason do
 
-    name { Faker::Name.name }
+    name { "loss_reason#{Time.now.to_i}" }
 
 
     to_create do |loss_reason|

data/spec/factories/source.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :source, class: BaseCRM::Source do
 
-    name { Faker::Name.name }
+    name { "source#{SecureRandom.hex}" }
 
 
     to_create do |source|

data/spec/factories/tag.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :tag, class: BaseCRM::Tag do
 
-    name { Faker::Name.name }
+    name { "tag#{SecureRandom.hex}" }
 
     resource_type { :contact }
 

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/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rspec/collection_matchers'
 require 'factory_bot'
 require 'faker'
+require 'securerandom'
 
 require 'basecrm'
 

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basecrm
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 2.0.0
 platform: ruby
 authors:
 - Zendesk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: BaseCRM Official API V2 library client for ruby
+description: Zendesk Sell Official API V2 library client for ruby
 email:
 - opensource@zendesk.com
 executables: []
@@ -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
@@ -243,7 +238,7 @@ files:
 - spec/support/client_helpers.rb
 - spec/utils/coercion.rb
 - spec/utils/coercion_spec.rb
-homepage: https://github.com/basecrm/basecrm-ruby
+homepage: https://github.com/zendesk/basecrm-ruby
 licenses:
 - Apache License Version 2.0
 metadata: {}
@@ -262,60 +257,60 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: BaseCRM Official API V2 library client for ruby
+summary: Zendesk Sell Official API V2 library client for ruby
 test_files:
 - spec/spec_helper.rb
-- spec/middlewares/raise_error_spec.rb
-- spec/utils/coercion_spec.rb
-- spec/utils/coercion.rb
-- spec/models/sync_meta_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/pipelines_service_spec.rb
+- spec/services/contacts_service_spec.rb
+- spec/services/orders_service_spec.rb
+- spec/services/visits_service_spec.rb
+- spec/services/leads_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/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/line_items_service_spec.rb
+- spec/services/text_messages_service_spec.rb
+- spec/basecrm/sync_spec.rb
 - spec/support/client_helpers.rb
-- spec/factories/note.rb
-- spec/factories/source.rb
+- spec/factories/lead_unqualified_reason.rb
+- spec/factories/order.rb
 - spec/factories/tag.rb
-- spec/factories/contact.rb
 - spec/factories/deal.rb
-- spec/factories/call.rb
-- spec/factories/product.rb
+- spec/factories/source.rb
 - spec/factories/text_message.rb
-- spec/factories/lead.rb
-- spec/factories/deal_unqualified_reason.rb
-- spec/factories/lead_unqualified_reason.rb
-- spec/factories/deal_source.rb
-- spec/factories/order.rb
-- spec/factories/lead_source.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/task.rb
-- spec/basecrm/sync_spec.rb
-- spec/services/notes_service_spec.rb
-- spec/services/text_messages_service_spec.rb
-- spec/services/pipelines_service_spec.rb
-- spec/services/sources_service_spec.rb
-- spec/services/orders_service_spec.rb
-- spec/services/tasks_service_spec.rb
-- spec/services/stages_service_spec.rb
-- spec/services/tags_service_spec.rb
-- spec/services/products_service_spec.rb
-- spec/services/call_outcomes_service_spec.rb
-- spec/services/lead_sources_service_spec.rb
-- spec/services/associated_contacts_service_spec.rb
-- spec/services/users_service_spec.rb
-- spec/services/leads_service_spec.rb
-- spec/services/line_items_service_spec.rb
-- spec/services/loss_reasons_service_spec.rb
-- spec/services/deal_sources_service_spec.rb
-- spec/services/visit_outcomes_service_spec.rb
-- spec/services/calls_service_spec.rb
-- spec/services/deal_unqualified_reasons_service_spec.rb
-- spec/services/visits_service_spec.rb
-- spec/services/sync_service_spec.rb
-- spec/services/lead_unqualified_reasons_service_spec.rb
-- spec/services/accounts_service_spec.rb
-- spec/services/contacts_service_spec.rb
-- spec/services/deals_service_spec.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