4me-sdk 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 864b07c2b953a22cde7b603d2ca40e0c922af5ab
-  data.tar.gz: 191f083e0183d044f77c9872a3b28f6e3541bf24
+  metadata.gz: 5709d9ce126fa6349fdff96ab4a2dd1c80b8653a
+  data.tar.gz: 56ea4d39c7dce6e5c0578f0eb5ab1bbeb154622d
 SHA512:
-  metadata.gz: 161e613f6c9e5af777051f09aad8c83cd4ade36395550e0c4da63c8d7ee4a399f161aadbd0c3ee965db44864c2faa3ed4f336017b98e85b9196c6a0ee8844d13
-  data.tar.gz: 348aa6bb7536b81c6cf0642e0b7376c3aea935d88dc6743af82cdf563b023d92f82773f72ef500c44458a448eb96b0027bce74d9e4b79f7f9c2901f3483bb013
+  metadata.gz: 754794a8253b590ddfd4064d2d96e9bae96597ab89c0169c6ebdb7fc8db4dd9035e7a0770be6f6644cff362a9f0dc5e061cb3992e15e6502556921bbdd997c5a
+  data.tar.gz: 80eaad3b45968a8ca3e1ce3afa4a6750c74105ba188122e1bcaf800ea87c64ab63c88893d70ee32793bf8bc19b22a38f5cec830935c153a03ccb978c83fb1607

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    4me-sdk (1.1.4)
+    4me-sdk (1.1.5)
       activesupport (>= 4.2)
       gem_config (>= 0.3)
       mime-types (>= 3.0)
@@ -9,21 +9,21 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
+    activesupport (5.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.4)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.1)
     gem_config (0.3.1)
     hashdiff (0.3.7)
-    i18n (1.1.1)
+    i18n (1.5.1)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     mime-types (3.2.2)

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 https://code.4me.com
+Copyright (c) 2019 https://code.4me.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -40,9 +40,10 @@ All options available:
 * _max_retry_time_: maximum nr of seconds to wait for server to respond (default = 5400 = 1.5 hours)<br/>
   The sleep time between retries starts at 2 seconds and doubles after each retry, i.e.
   2, 6, 18, 54, 162, 486, 1458, 4374, 13122, ... seconds.<br/>
-  One retry will always be performed unless you set the value to -1.
+  Set to 0 to prevent retries.
 * _read_timeout_:   [HTTP read timeout](http://ruby-doc.org/stdlib-2.0.0/libdoc/net/http/rdoc/Net/HTTP.html#method-i-read_timeout-3D) in seconds (default = 25)
-* _block_at_rate_limit_: Set to `true` to block the request until the [rate limit](http://developer.4me.com/v1/#rate-limiting) is lifted, default: `false`
+* _block_at_rate_limit_: Set to `true` to block the request until the [rate limit](http://developer.4me.com/v1/#rate-limiting) is lifted, default: `false`<br/>
+  The `Retry-After` header is used to compute when the retry should be performed. If that moment is later than the _max_retry_time_ the request will not be blocked and the throttled response is returned. 
 * _proxy_host_:     Define in case HTTP traffic needs to go through a proxy
 * _proxy_port_:     Port of the proxy, defaults to 8080
 * _proxy_user_:     Proxy user

data/lib/sdk4me/client.rb

@@ -298,14 +298,25 @@ module Sdk4me
   end
 
   module SendWithRateLimitBlock
-    # Wraps the _send method with retries when the server does not responsd, see +initialize+ option +:rate_limit_block+
+    # Wraps the _send method with retries when the server does not respond, see +initialize+ option +:rate_limit_block+
     def _send(request, domain = @domain, port = @port, ssl = @ssl)
       return super(request, domain, port, ssl) unless option(:block_at_rate_limit)
       now = Time.now
+      timed_out = false
+      # respect the max_retry_time with fallback to max 1 hour and 1 minute wait time
+      max_retry_time = option(:max_retry_time) > 0 ? option(:max_retry_time) : 3660
       begin
         _response = super(request, domain, port, ssl)
-        @logger.warn { "Request throttled, trying again in 5 minutes: #{_response.message}" } and sleep(300) if _response.throttled?
-      end while _response.throttled? && (Time.now - now) < 3660 # max 1 hour and 1 minute
+        if _response.throttled?
+          retry_after = _response.retry_after == 0 ? 300 : [_response.retry_after, 2].max
+          if (Time.now - now + retry_after) < max_retry_time
+            @logger.warn { "Request throttled, trying again in #{retry_after} seconds: #{_response.message}" }
+            sleep(retry_after)
+          else
+            timed_out = true
+          end
+        end
+      end while _response.throttled? && !timed_out
       _response
     end
   end
@@ -314,15 +325,24 @@ module Sdk4me
   module SendWithRetries
     # Wraps the _send method with retries when the server does not respond, see +initialize+ option +:retries+
     def _send(request, domain = @domain, port = @port, ssl = @ssl)
+      return super(request, domain, port, ssl) unless option(:max_retry_time) > 0
       retries = 0
-      sleep_time = 2
-      total_retry_time = 0
+      sleep_time = 1
+      now = Time.now
+      timed_out = false
       begin
         _response = super(request, domain, port, ssl)
-        @logger.warn { "Request failed, retry ##{retries += 1} in #{sleep_time} seconds: #{_response.message}" } and sleep(sleep_time) if (_response.raw.code.to_s != '204' && _response.empty?) && option(:max_retry_time) > 0
-        total_retry_time += sleep_time
-        sleep_time *= 2
-      end while (_response.raw.code.to_s != '204' && _response.empty?) && total_retry_time < option(:max_retry_time)
+        # throttling is handled separately
+        if !_response.success? && !_response.throttled?
+          sleep_time *= 2
+          if (Time.now - now + sleep_time) < option(:max_retry_time)
+            @logger.warn { "Request failed, retry ##{retries += 1} in #{sleep_time} seconds: #{_response.message}" }
+            sleep(sleep_time)
+          else
+            timed_out = true
+          end
+        end
+      end while !_response.success? && !_response.throttled? && !timed_out
       _response
     end
   end

data/lib/sdk4me/client/response.rb

@@ -111,6 +111,10 @@ module Sdk4me
       !!(@response.code.to_s == '429' || (message && message =~ /Too Many Requests/))
     end
 
+    def retry_after
+      @current_page ||= @response.header['Retry-After'].to_i
+    end
+
     def to_s
       valid? ? json.to_s : message
     end

data/lib/sdk4me/client/version.rb

@@ -1,5 +1,5 @@
 module Sdk4me
   class Client
-    VERSION = '1.1.4'
+    VERSION = '1.1.5'
   end
 end

data/spec/lib/sdk4me/client_spec.rb

@@ -282,7 +282,8 @@ describe Sdk4me::Client do
   context 'import' do
     before(:each) do
       @client = Sdk4me::Client.new(api_token: 'secret', max_retry_time: -1)
-      @multi_part_body = "--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npeople\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"file\"; filename=\"#{@fixture_dir}/people.csv\"\r\nContent-Type: text/csv\r\n\r\nPrimary Email,Name\nchess.cole@example.com,Chess Cole\ned.turner@example.com,Ed Turner\r\n--0123456789ABLEWASIEREISAWELBA9876543210--"
+      csv_mime_type = ['text/csv', 'text/comma-separated-values'].detect{|t| MIME::Types[t].any?} # which mime type is used depends on version of mime-types gem
+      @multi_part_body = "--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npeople\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"file\"; filename=\"#{@fixture_dir}/people.csv\"\r\nContent-Type: #{csv_mime_type}\r\n\r\nPrimary Email,Name\nchess.cole@example.com,Chess Cole\ned.turner@example.com,Ed Turner\r\n--0123456789ABLEWASIEREISAWELBA9876543210--"
       @multi_part_headers = {'Accept'=>'*/*', 'Content-Type'=>'multipart/form-data; boundary=0123456789ABLEWASIEREISAWELBA9876543210', 'User-Agent'=>'Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6'}
 
       @import_queued_response = {body: {state: 'queued'}.to_json}
@@ -477,10 +478,11 @@ describe Sdk4me::Client do
 
     it 'should not retry 4 times when max_retry_time = 16' do
       stub = stub_request(:get, 'https://api.4me.com/v1/me').with(basic_auth: ['secret', 'x']).to_raise(StandardError.new('network error'))
-      [2,4,8,16].each_with_index do |secs, i|
+      [2,4,8].each_with_index do |secs, i|
         expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
         expect_log("Request failed, retry ##{i+1} in #{secs} seconds: 500: No Response from Server - network error for 'api.4me.com:443/v1/me'", :warn)
       end
+      expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
 
       client = Sdk4me::Client.new(api_token: 'secret', max_retry_time: 16)
       allow(client).to receive(:sleep)
@@ -522,7 +524,37 @@ describe Sdk4me::Client do
     it 'should block on rate limit when block_at_rate_limit is true' do
       stub = stub_request(:get, 'https://api.4me.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: {message: 'Too Many Requests'}.to_json).then.to_return(body: {name: 'my name'}.to_json)
       expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
-      expect_log('Request throttled, trying again in 5 minutes: 429: Too Many Requests', :warn)
+      expect_log('Request throttled, trying again in 300 seconds: 429: Too Many Requests', :warn)
+      expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
+      expect_log(%(Response:\n{\n  "name": "my name"\n}), :debug )
+
+      client = Sdk4me::Client.new(api_token: 'secret', block_at_rate_limit: true)
+      allow(client).to receive(:sleep)
+      response = client.get('me')
+      expect(stub).to have_been_requested.times(2)
+      expect(response.valid?).to be_truthy
+      expect(response[:name]).to eq('my name')
+    end
+
+    it 'should block on rate limit using Retry-After when block_at_rate_limit is true' do
+      stub = stub_request(:get, 'https://api.4me.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: {message: 'Too Many Requests'}.to_json, headers: {'Retry-After' => '20'}).then.to_return(body: {name: 'my name'}.to_json)
+      expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
+      expect_log('Request throttled, trying again in 20 seconds: 429: Too Many Requests', :warn)
+      expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
+      expect_log(%(Response:\n{\n  "name": "my name"\n}), :debug )
+
+      client = Sdk4me::Client.new(api_token: 'secret', block_at_rate_limit: true)
+      allow(client).to receive(:sleep)
+      response = client.get('me')
+      expect(stub).to have_been_requested.times(2)
+      expect(response.valid?).to be_truthy
+      expect(response[:name]).to eq('my name')
+    end
+
+    it 'should block on rate limit using Retry-After with minimum of 2 seconds when block_at_rate_limit is true' do
+      stub = stub_request(:get, 'https://api.4me.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: {message: 'Too Many Requests'}.to_json, headers: {'Retry-After' => '1'}).then.to_return(body: {name: 'my name'}.to_json)
+      expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
+      expect_log('Request throttled, trying again in 2 seconds: 429: Too Many Requests', :warn)
       expect_log('Sending GET request to api.4me.com:443/v1/me', :debug )
       expect_log(%(Response:\n{\n  "name": "my name"\n}), :debug )
 

data/spec/lib/sdk4me/response_spec.rb

@@ -93,10 +93,10 @@ describe Sdk4me::Response do
       stub_request(:get, 'https://api.4me.com/v1/organizations').with(basic_auth: ['secret', 'x']).to_return(body: '==$$!invalid')
       response = @client.get('organizations')
 
-      message = "Invalid JSON - 765: unexpected token at '==$$!invalid' for:\n#{response.body}"
-      expect(response.json[:message]).to eq(message)
-      expect(response.json['message']).to eq(message)
-      expect(response.message).to eq(message)
+      message = "unexpected token at '==$$!invalid' for:\n#{response.body}"
+      expect(response.json[:message]).to include(message)
+      expect(response.json['message']).to include(message)
+      expect(response.message).to include(message)
     end
 
     it 'should have a blank message when single record is succesfully retrieved' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 4me-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - 4me
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: The official 4me SDK for Ruby. Provides easy access to the APIs found at