intercom 3.5.26 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a1defabdef4a55f98769450ea8363083783d649
-  data.tar.gz: 140dfa0321bbabb1cf80cbdc132c8b3ceb30e6d4
+  metadata.gz: da3b7fbe7b404dd5989bd60385c83931f9d58460
+  data.tar.gz: 2ee3931952cc325396e6d43d6c6b2cf08504b6f7
 SHA512:
-  metadata.gz: 1799b76b57bac79de2bb3a1f8dda2aa0b28b4f9dd73fea1839169125d25ca228bdee677d1bd8b9d464baa51d54b8ffe6d8fa2e4f59399080c7df995a44dc7bc6
-  data.tar.gz: 8e37c3ed1b57d739b5b9922b890b0e35e32d30190154be0aebd0ee4e85d9b23594d9630c380ad626111d84e71a495309069932d43d36d7b705956d0e835fcff0
+  metadata.gz: 30eec0038ac5ab50f2c031fffc9596bb563060ae72dab806921dd78fedf44683c7b48d57b9c2c083c5f50bfafc5f8bd44ae9f3fe72c727d8db8a3271a2a608d9
+  data.tar.gz: 301ca8d4de5e006b41046de14d6498fa9b03a0c72d4f82fca15e10a12a7ca2f80c00d6fbe85efbef118a524a910a5bd1f725f6e55752920fd431fbf7f8cbffcd

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.25'
+    gem 'intercom', '~> 3.6.0'
 
 ## Basic Usage
 
@@ -132,8 +132,10 @@ intercom.companies.save(company)
 # Iterate over all companies
 intercom.companies.all.each {|company| puts %Q(#{company.name} - #{company.custom_attributes["referral_source"]}) }
 intercom.companies.all.map {|company| company.name }
-# Get a list of users in a company
-intercom.companies.users(company.id)
+# Get a list of users in a company by Intercom Company ID
+intercom.companies.users_by_intercom_company_id(company.id)
+# Get a list of users in a company by external company_id
+intercom.companies.users_by_company_id(company.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
@@ -149,7 +151,7 @@ intercom.tags.untag(name: 'blue',  users: [{user_id: "42ea2f1b93891f6a99000427"}
 intercom.tags.all.each {|tag| "#{tag.id} - #{tag.name}" }
 intercom.tags.all.map {|tag| tag.name }
 # Tag companies
-tag = intercom.tags.tag(name: 'blue', companies: [{id: "42ea2f1b93891f6a99000427"}])
+tag = intercom.tags.tag(name: 'blue', companies: [{company_id: "42ea2f1b93891f6a99000427"}])
 ```
 
 #### Segments
@@ -469,7 +471,7 @@ intercom.rate_limit_details
 ```
 
 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.
+This will automatically catch the 429 rate limit exceeded error and wait until the reset time to retry. After three retries a rate limit exception will be raised. Encountering this error frequently may require a revisiting of your usage of the API.
 
 ```
 intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true)

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, :handle_rate_limit
+    attr_reader :base_url, :rate_limit_details, :username_part, :password_part, :handle_rate_limit, :timeouts
 
     class << self
       def set_base_url(base_url)
@@ -12,6 +12,17 @@ module Intercom
           Proc.new { |obj| set_base_url(old_url).call(o) }
         end
       end
+
+      def set_timeouts(open_timeout: nil, read_timeout: nil)
+        return Proc.new do |o|
+          old_timeouts = o.timeouts
+          timeouts = {}
+          timeouts[:open_timeout] = open_timeout if open_timeout
+          timeouts[:read_timeout] = read_timeout if read_timeout
+          o.send(:timeouts=, timeouts)
+          Proc.new { |obj| set_timeouts(old_timeouts).call(o) }
+        end
+      end
     end
 
     def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil, base_url:'https://api.intercom.io', handle_rate_limit: false)
@@ -27,6 +38,10 @@ module Intercom
       @base_url = base_url
       @rate_limit_details = {}
       @handle_rate_limit = handle_rate_limit
+      @timeouts = {
+        open_timeout: 30,
+        read_timeout: 90
+      }
     end
 
     def admins
@@ -110,7 +125,7 @@ module Intercom
 
     def execute_request(request)
       request.handle_rate_limit = handle_rate_limit
-      request.execute(@base_url, username: @username_part, secret: @password_part)
+      request.execute(@base_url, username: @username_part, secret: @password_part, **timeouts)
     ensure
       @rate_limit_details = request.rate_limit_details
     end
@@ -118,5 +133,9 @@ module Intercom
     def base_url=(new_url)
       @base_url = new_url
     end
+
+    def timeouts=(timeouts)
+      @timeouts = @timeouts.merge(timeouts)
+    end
   end
 end

data/lib/intercom/request.rb

@@ -46,25 +46,25 @@ module Intercom
       {'Accept-Encoding' => 'gzip, deflate', 'Accept' => 'application/vnd.intercom.3+json', 'User-Agent' => "Intercom-Ruby/#{Intercom::VERSION}"}
     end
 
-    def client(uri)
+    def client(uri, read_timeout:, open_timeout:)
       net = Net::HTTP.new(uri.host, uri.port)
       if uri.is_a?(URI::HTTPS)
         net.use_ssl = true
         net.verify_mode = OpenSSL::SSL::VERIFY_PEER
         net.ca_file = File.join(File.dirname(__FILE__), '../data/cacert.pem')
       end
-      net.read_timeout = 90
-      net.open_timeout = 30
+      net.read_timeout = read_timeout
+      net.open_timeout = open_timeout
       net
     end
 
-    def execute(target_base_url=nil, username:, secret: nil)
+    def execute(target_base_url=nil, username:, secret: nil, read_timeout: 90, open_timeout: 30)
       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)
       begin
-        client(base_uri).start do |http|
+        client(base_uri, read_timeout: read_timeout, open_timeout: open_timeout).start do |http|
           begin
             response = http.request(net_http_method)
             set_rate_limit_details(response)
@@ -75,8 +75,12 @@ module Intercom
           rescue Intercom::RateLimitExceeded => e
             if @handle_rate_limit
               seconds_to_retry = (@rate_limit_details[:reset_at] - Time.now.utc).ceil
-              sleep seconds_to_retry unless seconds_to_retry < 0
-              retry unless (retries -=1).zero?
+              if (retries -= 1) < 0
+                raise Intercom::RateLimitExceeded.new('Rate limit retries exceeded. Please examine current API Usage.')
+              else
+                sleep seconds_to_retry unless seconds_to_retry < 0
+                retry
+              end
             else
               raise e
             end

data/lib/intercom/service/company.rb

@@ -5,7 +5,6 @@ require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/load'
-require 'intercom/extended_api_operations/users'
 require 'intercom/extended_api_operations/tags'
 require 'intercom/extended_api_operations/segments'
 
@@ -18,13 +17,24 @@ module Intercom
       include ApiOperations::List
       include ApiOperations::Scroll
       include ApiOperations::Save
-      include ExtendedApiOperations::Users
       include ExtendedApiOperations::Tags
       include ExtendedApiOperations::Segments
 
       def collection_class
         Intercom::Company
       end
+
+      def users_by_intercom_company_id(id)
+        get_users(url: "/companies/#{id}/users")
+      end
+
+      def users_by_company_id(id)
+        get_users(url: "/companies", params: { company_id: id, type: "user" })
+      end
+
+      private def get_users(url:, params: {})
+        ClientCollectionProxy.new("users", finder_details: { url: url, params: params }, client: @client)
+      end
     end
   end
 end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.26"
+  VERSION = "3.6.0"
 end

data/spec/unit/intercom/client_spec.rb

@@ -17,6 +17,27 @@ module Intercom
       client.base_url.must_equal('https://api.intercom.io')
     end
 
+    it 'should be able to change the timeouts' do
+      prev = client.options(Intercom::Client.set_timeouts(open_timeout: 10, read_timeout: 15))
+      client.timeouts.must_equal(open_timeout: 10, read_timeout: 15)
+      client.options(prev)
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 90)
+    end
+
+    it 'should be able to change the open timeout individually' do
+      prev = client.options(Intercom::Client.set_timeouts(open_timeout: 50))
+      client.timeouts.must_equal(open_timeout: 50, read_timeout: 90)
+      client.options(prev)
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 90)
+    end
+
+    it 'should be able to change the read timeout individually' do
+      prev = client.options(Intercom::Client.set_timeouts(read_timeout: 50))
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 50)
+      client.options(prev)
+      client.timeouts.must_equal(open_timeout: 30, read_timeout: 90)
+    end
+
     it 'should raise on nil credentials' do
       proc { Client.new(app_id: nil, api_key: nil) }.must_raise MisconfiguredClientError
     end

data/spec/unit/intercom/company_spec.rb

@@ -1,36 +1,40 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Intercom::Company do
-  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+  let (:client) { Intercom::Client.new(app_id: "app_id",  api_key: "api_key") }
 
-  describe 'when no response raises error' do
-    it 'on find' do
-      client.expects(:get).with("/companies", {:company_id => '4'}).returns(nil)
-      proc {client.companies.find(:company_id => '4')}.must_raise Intercom::HttpError
+  describe "when no response raises error" do
+    it "on find" do
+      client.expects(:get).with("/companies", {:company_id => "4"}).returns(nil)
+      proc {client.companies.find(:company_id => "4")}.must_raise Intercom::HttpError
     end
 
-    it 'on find_all' do
+    it "on find_all" do
       client.expects(:get).with("/companies", {}).returns(nil)
       proc {client.companies.all.each {|company| }}.must_raise Intercom::HttpError
     end
 
-    it 'on load' do
-      client.expects(:get).with("/companies", {:company_id => '4'}).returns({'type' =>'user', 'id' =>'aaaaaaaaaaaaaaaaaaaaaaaa', 'company_id' => '4', 'name' => 'MyCo'})
-      company = client.companies.find(:company_id => '4')
-      client.expects(:get).with('/companies/aaaaaaaaaaaaaaaaaaaaaaaa', {}).returns(nil)
+    it "on load" do
+      client.expects(:get).with("/companies", {:company_id => "4"}).returns({"type" =>"user", "id" =>"aaaaaaaaaaaaaaaaaaaaaaaa", "company_id" => "4", "name" => "MyCo"})
+      company = client.companies.find(:company_id => "4")
+      client.expects(:get).with("/companies/aaaaaaaaaaaaaaaaaaaaaaaa", {}).returns(nil)
       proc {client.companies.load(company)}.must_raise Intercom::HttpError
     end
   end
 
-  it 'gets users in a company' do
+  it "gets users in a company by intercom ID" do
     client.expects(:get).with("/companies/abc123/users", {}).returns(page_of_users(false))
-    client.companies.users('abc123').each do |u|
-    end
+    client.companies.users_by_intercom_company_id("abc123").each { |u| }
+  end
+
+  it "gets users in a company by external company ID" do
+    client.expects(:get).with("/companies", { company_id: "abc123", type: "user" }).returns(page_of_users(false))
+    client.companies.users_by_company_id("abc123").each { |u| }
   end
 
-  it 'finds a company' do
+  it "finds a company" do
     client.expects(:get).with("/companies/531ee472cce572a6ec000006", {}).returns(test_company)
-    company = client.companies.find(id: '531ee472cce572a6ec000006')
+    company = client.companies.find(id: "531ee472cce572a6ec000006")
     company.name.must_equal("Blue Sun")
   end
 end

data/spec/unit/intercom/request_spec.rb

@@ -30,14 +30,15 @@ describe 'Intercom::Request' 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).to_i.to_s })
-      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: "")
+    it 'should call sleep for rate limit error three times and raise a rate limit error otherwise' do
+      expect {
+        stub_request(:any, uri).\
+        to_return(status: [429, "Too Many Requests"], headers: { 'X-RateLimit-Reset' => (Time.now.utc + 10).to_i.to_s })
+        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: "")
+      }.must_raise(Intercom::RateLimitExceeded)
     end
 
     it 'should not call sleep for rate limit error' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.5.26
+  version: 3.6.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -152,7 +152,6 @@ files:
 - lib/intercom/event.rb
 - lib/intercom/extended_api_operations/segments.rb
 - lib/intercom/extended_api_operations/tags.rb
-- lib/intercom/extended_api_operations/users.rb
 - lib/intercom/job.rb
 - lib/intercom/lib/dynamic_accessors.rb
 - lib/intercom/lib/dynamic_accessors_on_method_missing.rb

data/lib/intercom/extended_api_operations/users.rb

@@ -1,16 +0,0 @@
-require 'intercom/client_collection_proxy'
-require 'intercom/utils'
-
-module Intercom
-  module ExtendedApiOperations
-    module Users
-      def users(id)
-        collection_name = Utils.resource_class_to_collection_name(collection_class)
-        finder_details = {}
-        finder_details[:url] = "/#{collection_name}/#{id}/users"
-        finder_details[:params] = {}
-        ClientCollectionProxy.new("users", finder_details: finder_details, client: @client)
-      end
-    end
-  end
-end