intercom 3.5.17 → 3.5.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c01c8eb70ddcf8ebfbf6a2cfe271caaf610edf6
-  data.tar.gz: 56b74c46c5214b4bab506f81668ecfdea9deb889
+  metadata.gz: 0d73b6f0f89970d9ccc8e82cfb969549e5f9720a
+  data.tar.gz: eecb568c0c6116afbef3cec73ee93a459af3bb23
 SHA512:
-  metadata.gz: a0118ea62d5810289c2a3858212ad1e3bbfdc80c1c230287a5912bb14ae11476353eda8822fc9aa10932bc104f94164965f91e217e119a6e5259480ccdc934f6
-  data.tar.gz: edfad895f3e8a9ef70acbbe60b837577c56cc743181827a20c98ff968851ca8ce7559adb8c459d50d34c48b1950b8fe26cea16f6a135313f56e6aa74df9a785a
+  metadata.gz: c1c7a6abeaa8ad78409defd2435908245d152f222dbd68a01ef4ef8dbea14a49044f4a6339b9bfecb3db511e8e9fd0cb027ddcd9359d0b0a1c83cb4dec2417f6
+  data.tar.gz: 369edfbdd536899f05923d299c61e53b57b57e975370ad7bb16d6090d03786228e86a14b69ea018d8836ef0e688d0adce3d4978339cf4dfbd93be0a4f5a85560

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 sudo: false
+before_install:
+  - gem install bundler
+  - gem update --system
+  - gem --version
 rvm:
   - 2.1.0
   - 2.2.0

data/Gemfile

@@ -1,5 +1,6 @@
 source "http://rubygems.org"
 
+gem 'webmock'
 gemspec
 
 group :development, :test do

data/README.md

@@ -22,7 +22,7 @@ This version of the gem is compatible with `Ruby 2.1` and above.
 
 Using bundler:
 
-    gem 'intercom', '~> 3.5.10'
+    gem 'intercom', '~> 3.5.18'
 
 ## Basic Usage
 
@@ -134,6 +134,9 @@ intercom.companies.all.each {|company| puts %Q(#{company.name} - #{company.custo
 intercom.companies.all.map {|company| company.name }
 # Get a list of users in a company
 intercom.companies.users(company.id)
+# Get a large list of companies using scroll
+intercom.companies.scroll.each { |comp| puts comp.name}
+# Please see users scroll for more details of how to use scroll
 ```
 
 #### Tags
@@ -371,6 +374,10 @@ intercom.contacts.convert(contact, user)
 
 # Delete a contact
 intercom.contacts.delete(contact)
+
+# Get a large list of contacts using scroll
+intercom.contacts.scroll.each { |lead| puts lead.id}
+# Please see users scroll for more details of how to use scroll
 ```
 
 ### Counts
@@ -433,6 +440,12 @@ intercom.rate_limit_details
 #=> {:limit=>180, :remaining=>179, :reset_at=>2014-10-07 14:58:00 +0100}
 ```
 
+You can handle the rate limits yourself but a simple option is to use the handle_rate_limit flag.
+This will automatically catch the 429 rate limit exceeded error and wait until the reset time to retry.
+
+```
+intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true)
+```
 
 ### Pull Requests
 

data/changes.txt

@@ -1,3 +1,6 @@
+3.5.17
+ - Fix BlockedUserError typo
+
 3.5.16
  - Standardize comparison of attribute as string when input is Hash or JSON
 

data/lib/intercom/client.rb

@@ -2,7 +2,7 @@ module Intercom
   class MisconfiguredClientError < StandardError; end
   class Client
     include Options
-    attr_reader :base_url, :rate_limit_details, :username_part, :password_part
+    attr_reader :base_url, :rate_limit_details, :username_part, :password_part, :handle_rate_limit
 
     class << self
       def set_base_url(base_url)
@@ -14,7 +14,7 @@ module Intercom
       end
     end
 
-    def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil, base_url:'https://api.intercom.io')
+    def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil, base_url:'https://api.intercom.io', handle_rate_limit: false)
       if token
         @username_part = token
         @password_part = ""
@@ -26,6 +26,7 @@ module Intercom
 
       @base_url = base_url
       @rate_limit_details = {}
+      @handle_rate_limit = handle_rate_limit
     end
 
     def admins
@@ -108,6 +109,7 @@ module Intercom
     end
 
     def execute_request(request)
+      request.handle_rate_limit = handle_rate_limit
       request.execute(@base_url, username: @username_part, secret: @password_part)
     ensure
       @rate_limit_details = request.rate_limit_details

data/lib/intercom/request.rb

@@ -3,11 +3,12 @@ require 'net/https'
 
 module Intercom
   class Request
-    attr_accessor :path, :net_http_method, :rate_limit_details
+    attr_accessor :path, :net_http_method, :rate_limit_details, :handle_rate_limit
 
     def initialize(path, net_http_method)
       self.path = path
       self.net_http_method = net_http_method
+      self.handle_rate_limit = false
     end
 
     def set_common_headers(method, base_uri)
@@ -58,6 +59,7 @@ module Intercom
     end
 
     def execute(target_base_url=nil, username:, secret: nil)
+      retries = 3
       base_uri = URI.parse(target_base_url)
       set_common_headers(net_http_method, base_uri)
       set_basic_auth(net_http_method, username, secret)
@@ -70,6 +72,13 @@ module Intercom
             parsed_body = parse_body(decoded_body, response)
             raise_errors_on_failure(response)
             parsed_body
+          rescue Intercom::RateLimitExceeded => e
+            if @handle_rate_limit
+              sleep (@rate_limit_details[:reset_at] - Time.now.utc).ceil
+              retry unless (retries -=1).zero?
+            else
+              raise e
+            end
           rescue Timeout::Error
             raise Intercom::ServiceUnavailableError.new('Service Unavailable [request timed out]')
           end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.17"
+  VERSION = "3.5.19"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'intercom'
 require 'minitest/autorun'
 require 'mocha/setup'
+require 'webmock'
+include WebMock::API
 
 def test_user(email="bob@example.com")
   {

data/spec/unit/intercom/request_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 require 'ostruct'
 
+WebMock.enable!
+
 describe 'Intercom::Request' do
   it 'raises an error when a html error page rendered' do
     response = OpenStruct.new(:code => 500)
@@ -14,9 +16,50 @@ describe 'Intercom::Request' do
     proc {req.parse_body('<html>somethjing</html>', response)}.must_raise(Intercom::RateLimitExceeded)
   end
 
+  describe 'Intercom::Client' do
+    let (:client) { Intercom::Client.new(token: 'foo', handle_rate_limit: true) }
+    let (:uri) {"https://api.intercom.io/users"}
+
+    it 'should have handle_rate_limit set' do
+       client.handle_rate_limit.must_equal(true)
+    end
+
+    it 'should call sleep for rate limit error three times' do
+      # Use webmock to mock the HTTP request
+      stub_request(:any, uri).\
+      to_return(status: [429, "Too Many Requests"], headers: { 'X-RateLimit-Reset' => Time.now.utc + 10 })
+      req = Intercom::Request.get(uri, "")
+      req.handle_rate_limit=true
+      req.expects(:sleep).times(3).with(any_parameters)
+      req.execute(target_base_url=uri, username: "ted", secret: "")
+    end
+
+    it 'should not call sleep for rate limit error' do
+      # Use webmock to mock the HTTP request
+      stub_request(:any, uri).\
+      to_return(status: [200, "OK"], headers: { 'X-RateLimit-Reset' => Time.now.utc + 10 })
+      req = Intercom::Request.get(uri, "")
+      req.handle_rate_limit=true
+      req.expects(:sleep).never.with(any_parameters)
+      req.execute(target_base_url=uri, username: "ted", secret: "")
+    end
+
+    it 'should call sleep for rate limit error just once' do
+      # Use webmock to mock the HTTP request
+      stub_request(:any, uri).\
+      to_return(status: [429, "Too Many Requests"], headers: { 'X-RateLimit-Reset' => Time.now.utc + 10 }).\
+      then.to_return(status: [200, "OK"])
+      req = Intercom::Request.get(uri, "")
+      req.handle_rate_limit=true
+      req.expects(:sleep).with(any_parameters)
+      req.execute(target_base_url=uri, username: "ted", secret: "")
+    end
+
+  end
+
   it 'parse_body returns nil if decoded_body is nil' do
     response = OpenStruct.new(:code => 500)
     req = Intercom::Request.new('path/', 'GET')
-    req.parse_body(nil, response).must_equal(nil)
+    assert_nil(req.parse_body(nil, response))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.5.17
+  version: 3.5.19
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -243,31 +243,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
-test_files:
-- spec/spec_helper.rb
-- spec/unit/intercom/admin_spec.rb
-- spec/unit/intercom/client_collection_proxy_spec.rb
-- spec/unit/intercom/client_spec.rb
-- spec/unit/intercom/company_spec.rb
-- spec/unit/intercom/contact_spec.rb
-- spec/unit/intercom/conversation_spec.rb
-- spec/unit/intercom/count_spec.rb
-- spec/unit/intercom/event_spec.rb
-- spec/unit/intercom/job_spec.rb
-- spec/unit/intercom/lib/flat_store_spec.rb
-- spec/unit/intercom/message_spec.rb
-- spec/unit/intercom/note_spec.rb
-- spec/unit/intercom/request_spec.rb
-- spec/unit/intercom/scroll_collection_proxy_spec.rb
-- spec/unit/intercom/segment_spec.rb
-- spec/unit/intercom/subscription_spec.rb
-- spec/unit/intercom/tag_spec.rb
-- spec/unit/intercom/traits/api_resource_spec.rb
-- spec/unit/intercom/user_spec.rb
-- spec/unit/intercom/visitors_spec.rb
-- spec/unit/intercom_spec.rb
-has_rdoc: 
+test_files: []