namely 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 555f85e223a6cb8657f5c9fda719c37124f5cc52
-  data.tar.gz: 1a42b8f292cc9301217898da0f7345e4dba49b2a
+  metadata.gz: e43ba1385890f1253066c41a14eae2213145d660
+  data.tar.gz: f334b88109df6428c2e900755e56b6f3f9dc0435
 SHA512:
-  metadata.gz: f30766bb3ecc9e527790e55ac71a58f74d4010dc7ce81d39b2e642bf1178b97d9b5d6254a21179a162f536829884b369c404131a2b3dc21293e3452763d854f0
-  data.tar.gz: 788d44d719b70ae72b657f8558d9ba1838ea53ca7632644e675aaf430f184be6919aa6fdd89eb8fb7ef9618f5ebaed85acd2734323acdbd54eee5c2c7f52aa01
+  metadata.gz: c73def2dc1ee53081c84a174c19a21c2085cb921bcdb20a8ce0eeaf69d336448da68f8a935bb8f77e9ba0d0e4c6d5f42f4b12b8a813d7a89a9d3c2e797ed3fde
+  data.tar.gz: 5e98f5d8e6cdb893c84d7a0100886915d398158e48bb392729f8d4de0b456392921dc140168aae242703c962f9642146585d58de929f736de337c0ab9c0a7142

data/README.md

@@ -41,6 +41,22 @@ Namely associates a subdomain with your organization. For example, if
 your account is at `http://your-organization.namely.com/`, your
 subdomain would be `"your-organization"`.
 
+## Configuration
+
+You can override default configuration using `Namely.configuration` like:
+
+```Ruby
+Namely.configuration do |config|
+
+  # While returning paged results, which http codes should be rescued and
+  # retried? Defaults to none.
+  config.http_codes_to_retry = [504] # gateway timeout
+
+  # The number of times to retry the requests rescued above. Default is 0
+  config.retries = 2
+end
+```
+
 ## Usage Examples
 
 Once you've created a connection you can use it to access your data.
@@ -118,7 +134,7 @@ page of the site.
 5. Create a new pull request. We'll review it and leave feedback for
    you ASAP.
 
-[Namely's HTTP API]: http://namely.readme.io/v1/docs
+[Namely's HTTP API]: https://developers.namely.com
 [thoughtbot's style guide]: https://github.com/thoughtbot/guides/tree/master/style
 [JSON API standard]: http://jsonapi.org/
 [dotenv]: https://github.com/bkeepers/dotenv

data/lib/namely.rb

@@ -2,6 +2,7 @@ require "json"
 require "ostruct"
 require "rest_client"
 
+require "namely/configuration"
 require "namely/authenticator"
 require "namely/exceptions"
 require "namely/resource_gateway"

data/lib/namely/configuration.rb

@@ -0,0 +1,56 @@
+module Namely
+  class Configuration
+
+    # The http codes that should be retried if a request fails while returning
+    # a page in paged results. Number of times to retry specified in {#retries}.
+    # Defaults to an empty Array.
+    #
+    # @see #retries
+    # @return [Array<Integer>] the http codes to retry for a failed request
+    attr_reader :http_codes_to_retry
+
+    # Specifies the http codes of failed GET requests encountered while paging
+    # that should be retried.
+    #
+    # @param codes [Array<Integer>, Integer] http codes to retry
+    def http_codes_to_retry=(codes)
+      @http_codes_to_retry = Array(codes).map(&:to_int)
+    end
+
+    # Controls the number of times that a request for a page that failed while
+    # returning paged results with one of the http codes listed in
+    # {#http_codes_to_retry} will be retried before raising
+    # an exception. 0 by default.
+    #
+    # @return [Integer] number of times to retry request.
+    attr_accessor :retries
+
+    def initialize
+      @http_codes_to_retry = []
+      @retries = 0
+    end
+  end
+
+  # @return [Namely::Configuration] Namely's current configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Set Namely's configuration
+  # @param config [Namely::Configuration]
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  # Modify Namely's current configuration
+  # @yieldparam [Namely::Configuration] config current Namely config
+  # ```
+  # Namely.configure do |config|
+  #   config.retries = 3
+  # end
+  # ```
+  def self.configure
+    yield configuration
+  end
+end
+

data/lib/namely/resource_gateway.rb

@@ -44,7 +44,7 @@ module Namely
         params = {}
 
         loop do
-          objects = get("/#{endpoint}", params)[resource_name]
+          objects = with_retry { get("/#{endpoint}", params)[resource_name] }
           break if objects.empty?
 
           objects.each { |o| y << o }
@@ -73,6 +73,15 @@ module Namely
       )
     end
 
+    def with_retry
+      retries ||= 0
+      yield
+    rescue RestClient::Exception => e
+      raise unless Namely.configuration.http_codes_to_retry.include?(e.http_code)
+      retry if (retries += 1) < Namely.configuration.retries
+      raise
+    end
+
     def get(path, params = {})
       params.merge!(access_token: access_token)
       JSON.parse(RestClient.get(url(path), accept: :json, params: params))

data/lib/namely/version.rb

@@ -1,3 +1,3 @@
 module Namely
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/namely.gemspec

@@ -6,7 +6,7 @@ require "namely/version"
 Gem::Specification.new do |spec|
   spec.name          = "namely"
   spec.version       = Namely::VERSION
-  spec.authors       = ["Namely Integrations Team"]
+  spec.authors       = ["Namely"]
   spec.email         = ["integrations-dev@namely.com"]
   spec.summary       = "Wraps the Namely HTTP API in lovely Ruby."
   spec.homepage      = "https://github.com/namely/ruby-client"

data/spec/namely/configuration_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Namely::Configuration do
+
+  describe "#http_codes_to_retry" do
+    it "is empty array by default" do
+      expect(Namely.configuration.http_codes_to_retry).to eq []
+    end
+
+    it "accepts an array of intergers" do
+      expected_result = http_codes = [504, 502]
+
+      Namely.configure { |config| config.http_codes_to_retry = http_codes }
+
+      expect(Namely.configuration.http_codes_to_retry).to eq expected_result
+    end
+
+    it "accepts a single integer" do
+      http_code = 504
+      expected_return = [http_code]
+
+      Namely.configure { |config| config.http_codes_to_retry = http_code }
+
+      expect(Namely.configuration.http_codes_to_retry).to eq expected_return
+    end
+  end
+
+  describe "#retries" do
+    it "is 0 by default" do
+      expect(Namely.configuration.retries).to eq 0
+    end
+
+    it "accepts an interger representing the number of retries" do
+      expected_result = number_of_retries = 3
+
+      Namely.configure { |config| config.retries = number_of_retries }
+
+      expect(Namely.configuration.retries).to eq expected_result
+    end
+  end
+end

data/spec/namely/resource_gateway_spec.rb

@@ -73,6 +73,38 @@ describe Namely::ResourceGateway do
 
         expect(ids).to eq(['123-456', '456-789'])
       end
+
+      it "retries http failures given the configured codes and number of retries" do
+        Namely.configuration.retries = 3
+        Namely.configuration.http_codes_to_retry = [504]
+
+        stub_request(:get, "https://#{subdomain}.namely.com/api/v1/widgets").
+          with(query: { access_token: access_token }).to_return(status:504).times(2).
+          then.to_return(body: { widgets: [ id: "123-456" ] }.to_json)
+
+        stub_request(:get, "https://#{subdomain}.namely.com/api/v1/widgets").
+          with(query: { access_token: access_token, after: "123-456" }).
+          to_return(body: { widgets: [ id: "456-789" ] }.to_json)
+
+        stub_request(:get, "https://#{subdomain}.namely.com/api/v1/widgets").
+          with(query: { access_token: access_token, after: "456-789" }).
+          to_return(body: { widgets: [ ] }.to_json)
+
+        ids = gateway.json_index.map { |h| h['id'] }
+
+        expect(ids).to eq(['123-456', '456-789'])
+      end
+
+      it "raises an exception if exceeds configured retry number" do
+        Namely.configuration.retries = 3
+        Namely.configuration.http_codes_to_retry = [504]
+
+        stub_request(:get, "https://#{subdomain}.namely.com/api/v1/widgets").
+          with(query: { access_token: access_token }).to_return(status: 504)
+
+        expect { gateway.json_index.map { |h| h['id'] } }.
+          to raise_error(RestClient::GatewayTimeout)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: namely
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
-- Namely Integrations Team
+- Namely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-13 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -143,6 +143,7 @@ files:
 - lib/namely.rb
 - lib/namely/authenticator.rb
 - lib/namely/collection.rb
+- lib/namely/configuration.rb
 - lib/namely/connection.rb
 - lib/namely/exceptions.rb
 - lib/namely/model.rb
@@ -182,6 +183,7 @@ files:
 - spec/fixtures/vcr_cassettes/token.yml
 - spec/fixtures/vcr_cassettes/token_refresh.yml
 - spec/namely/authenticator_spec.rb
+- spec/namely/configuration_spec.rb
 - spec/namely/connection_spec.rb
 - spec/namely/integration_spec.rb
 - spec/namely/resource_gateway_spec.rb
@@ -210,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Wraps the Namely HTTP API in lovely Ruby.
@@ -248,6 +250,7 @@ test_files:
 - spec/fixtures/vcr_cassettes/token.yml
 - spec/fixtures/vcr_cassettes/token_refresh.yml
 - spec/namely/authenticator_spec.rb
+- spec/namely/configuration_spec.rb
 - spec/namely/connection_spec.rb
 - spec/namely/integration_spec.rb
 - spec/namely/resource_gateway_spec.rb