chartmogul-ruby 1.1.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c40767c5703fd33e6082f381b76d6e37a21ec7a1
-  data.tar.gz: ba522825f3763def73d620cfd8e219d08f305185
+SHA256:
+  metadata.gz: f4f3fb69e05a0a258906b974f566741f9fa152f59f69dccae4cead5baef0f9f9
+  data.tar.gz: d3724ddc288874e997856c2f8159fa84312cf5c27723dd24cd54668e1fca2ea1
 SHA512:
-  metadata.gz: 2506be57ed3239b5a1686489b4ca57466392e847e9e478690ffaf5f44a825ea99286313614c56e2aa66860b856799cd01c40f8f0b83ff4caa5d2a2b4bc30fbf3
-  data.tar.gz: 4b5b19a865fcc201bbbfcb8a0c17a138f156c633f20518ffed6aeafb22d8f79d19af70ef3732708728e21604b59010fbfa1db1fada2b6a651fac1ba8585204cc
+  metadata.gz: 75f93ec8855dee1db9045ab6a203c53fc33f0e7b255d746e539f40034b90df85278c380133619e46aa06172c2d3c4b26d25b107ef7d71bd08e74d080597ac316
+  data.tar.gz: 256cddea65586fc78b381d52afdbf14e4b44747a268ba7b2749b7f9ca97a5146d3e75c5374425d71688764049dd28bb26b173441f3d4fceb35dc4e9e02ad9ebb

data/README.md

@@ -86,6 +86,16 @@ You can find examples for each endpoint in the ChartMogul [API documentation](ht
 
 [![https://gyazo.com/f7a2a1b86a409586ee8dd0f4f7563937](https://i.gyazo.com/f7a2a1b86a409586ee8dd0f4f7563937.gif)](https://i.gyazo.com/f7a2a1b86a409586ee8dd0f4f7563937.gif)
 
+## Rate Limits & Exponential Backoff
+
+The library will keep retrying if the request exceeds the rate limit or if there's any network related error. By default, the request will be retried for 20 times (approximated 15 minutes) before finally giving up.
+
+You can change the retry count with:
+```ruby
+ChartMogul.max_retries = 15
+```
+Set it to 0 to disable it.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/chartmogul-ruby.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'vcr', '~> 3.0'
   spec.add_development_dependency 'pry', '~> 0.10.3'
+  spec.add_development_dependency 'webmock', '~> 3.4', '>= 3.4.2'
 end

data/lib/chartmogul.rb

@@ -67,6 +67,7 @@ require 'chartmogul/enrichment/customer'
 
 module ChartMogul
   API_BASE = 'https://api.chartmogul.com'.freeze
+  MAX_RETRIES = 20
 
   class << self
     extend ConfigAttributes
@@ -77,5 +78,6 @@ module ChartMogul
 
     config_accessor :account_token
     config_accessor :secret_key
+    config_accessor :max_retries, MAX_RETRIES
   end
 end

data/lib/chartmogul/api_resource.rb

@@ -4,6 +4,16 @@ module ChartMogul
   class APIResource < ChartMogul::Object
     extend Forwardable
 
+    RETRY_STATUSES = [429, *500..599].freeze
+    RETRY_EXCEPTIONS = [
+      'Faraday::ConnectionFailed',
+      'Faraday::RetriableResponse'
+    ].freeze
+    BACKOFF_FACTOR = 2
+    INTERVAL_RANDOMNESS = 0.5
+    INTERVAL = 1
+    MAX_INTERVAL = 60
+
     class << self; attr_reader :resource_path, :resource_name, :resource_root_key end
 
     def self.set_resource_path(path)
@@ -22,6 +32,9 @@ module ChartMogul
       @connection ||= Faraday.new(url: ChartMogul::API_BASE) do |faraday|
         faraday.use Faraday::Request::BasicAuthentication, ChartMogul.account_token, ChartMogul.secret_key
         faraday.use Faraday::Response::RaiseError
+        faraday.request :retry, max: ChartMogul.max_retries, retry_statuses: RETRY_STATUSES,
+          max_interval: MAX_INTERVAL, backoff_factor: BACKOFF_FACTOR,
+          interval_randomness: INTERVAL_RANDOMNESS, interval: INTERVAL, exceptions: RETRY_EXCEPTIONS
         faraday.use Faraday::Adapter::NetHttp
       end
     end

data/lib/chartmogul/config_attributes.rb

@@ -1,8 +1,8 @@
 module ChartMogul
   module ConfigAttributes
-    def config_accessor(attribute)
+    def config_accessor(attribute, default_value = nil)
       define_method(attribute) do
-        attr = config.send(attribute)
+        attr = config.send(attribute) || default_value
         raise ConfigurationError, "Configuration for #{attribute} not set" if attr.nil?
         attr
       end

data/lib/chartmogul/configuration.rb

@@ -2,5 +2,6 @@ module ChartMogul
   class Configuration
     attr_accessor :account_token
     attr_accessor :secret_key
+    attr_accessor :max_retries
   end
 end

data/lib/chartmogul/version.rb

@@ -1,3 +1,3 @@
 module ChartMogul
-  VERSION = '1.1.9'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartmogul-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.2.0
 platform: ruby
 authors:
 - Jason Langenauer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 description: Official Ruby client for ChartMogul's API
 email:
 - jason@chartmogul.com
@@ -242,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Chartmogul API Ruby Client