intercom 3.5.12 → 3.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84719dadeaf7d2aeff38ba123e258b8d13dda3ca
-  data.tar.gz: 6f5b639d8f587bd42a62c7807437ff70e2643a4e
+  metadata.gz: 8cf1ca0778bd7e64ae81296aa6dadb5414c80aea
+  data.tar.gz: 698516d5a4b3e43e7b44325a03cc20f7675b6849
 SHA512:
-  metadata.gz: 8af7c5cc8fb66238a15c2fc20888ffd6f9914c800b0983bc281c737270899cbc9652d709fa82ad84b32ae94d5a84a0983badac8ecf8b6e58890c800ffcf5e0de
-  data.tar.gz: 373c03846b1fd01ae42ad8214b65bcf2abe00ea31351214410476dff921501862e463a2f2a2a89674ccbbe424110831a0cd05cd6170017ec2a65da1b75bb255a
+  metadata.gz: 06bd3d79d91911456744b179287d78f6b752b063d4e4a02a8cb8205ba9b4ee72d1ef97d6cd50cc09e62bcba302ffe0cc97676a249f418a596d8d506497a12024
+  data.tar.gz: 35863aff023fc454d73bdd4bcfde829158682ff5685e0ae2445661dadbd6504bf47314b5963f67d7c92feeb0174f164df83dacdb53dfcc398c0213ea721415ed

data/README.md

@@ -54,7 +54,6 @@ Resources this API supports:
     https://api.intercom.io/messages
     https://api.intercom.io/subscriptions
     https://api.intercom.io/jobs
-    https://api.intercom.io/bulk
 
 ### Examples
 
@@ -100,16 +99,6 @@ result = intercom.users.scroll.next
 result.scroll_param
 => "0730e341-63ef-44da-ab9c-9113f886326d"
 result = intercom.users.scroll.next("0730e341-63ef-44da-ab9c-9113f886326d");
-
-#Bulk operations.
-# Submit bulk job to create users. If any of the items in create_items match an existing user that user will be updated
-intercom.users.submit_bulk_job(create_items: [{user_id: "25", email: "alice@example.com"}, {user_id: "25", email: "bob@example.com"}])
-# Submit bulk job to create users with companies. Companies must be sent as an array of objects nested within each applicable user object
-intercom.users.submit_bulk_job(create_items: [{user_id: "25", email: "alice@example.com", companies: [{company_id: 9, name: "Test Company"}]}])
-# Submit bulk job, to delete users
-intercom.users.submit_bulk_job(delete_items: [{user_id: "25", email: "alice@example.com"}, {user_id: "25", email: "bob@example.com"}])
-# Submit bulk job, to add items to existing job
-intercom.users.submit_bulk_job(create_items: [{user_id: "25", email: "alice@example.com"}], delete_items: [{user_id: "25", email: "bob@example.com"}], job_id:'job_abcd1234')
 ```
 
 #### Admins
@@ -189,7 +178,7 @@ intercom.conversations.find_all(type: 'admin', id: '7').each {|convo| ... }
 intercom.conversations.find_all(type: 'admin', id: 7, open: true).each {|convo| ... }
 # Iterate over closed conversations assigned to an admin
 intercom.conversations.find_all(type: 'admin', id: 7, open: false).each {|convo| ... }
-# Iterate over closed conversations for assigned an admin, before a certain moment in time
+# Iterate over closed conversations which are assigned to an admin, and where updated_at is before a certain moment in time
 intercom.conversations.find_all(type: 'admin', id: 7, open: false, before: 1374844930).each {|convo| ... }
 
 # FINDING CONVERSATIONS FOR A USER
@@ -362,54 +351,6 @@ The metadata key values in the example are treated as follows-
 
 *NB:* This version of the gem reserves the field name `type` in Event data.
 
-Bulk operations.
-```ruby
-# Submit bulk job, to create events
-intercom.events.submit_bulk_job(create_items: [
-  {
-    event_name: "ordered-item",
-    created_at: 1438944980,
-    user_id: "314159",
-    metadata: {
-      order_date: 1438944980,
-      stripe_invoice: "inv_3434343434"
-    }
-  },
-  {
-    event_name: "invited-friend",
-    created_at: 1438944979,
-    user_id: "314159",
-    metadata: {
-      invitee_email: "pi@example.org",
-      invite_code: "ADDAFRIEND"
-    }
-  }
-])
-
-
-# Submit bulk job, to add items to existing job
-intercom.events.submit_bulk_job(create_items: [
-  {
-    event_name: "ordered-item",
-    created_at: 1438944980,
-    user_id: "314159",
-    metadata: {
-      order_date: 1438944980,
-      stripe_invoice: "inv_3434343434"
-    }
-  },
-  {
-    event_name: "invited-friend",
-    created_at: 1438944979,
-    user_id: "314159",
-    metadata: {
-      invitee_email: "pi@example.org",
-      invite_code: "ADDAFRIEND"
-    }
-  }
-], job_id:'job_abcd1234')
-```
-
 ### Contacts
 
 `Contacts` represent logged out users of your application.
@@ -453,18 +394,13 @@ intercom.subscriptions.create(url: "http://example.com", topics: ["user.created"
 # fetch a subscription
 intercom.subscriptions.find(id: "nsub_123456789")
 
+# delete a subscription
+subscription = intercom.subscriptions.find(id: "nsub_123456789")
+intercom.subscriptions.delete(subscription)
+
 # list subscriptions
 intercom.subscriptions.all
 ```
-### Bulk jobs
-
-```ruby
-# fetch a job
-intercom.jobs.find(id: 'job_abcd1234')
-
-# fetch a job's error feed
-intercom.jobs.errors(id: 'job_abcd1234')
-```
 
 ### Errors
 

data/changes.txt

@@ -1,3 +1,9 @@
+3.5.12
+- Use base_url in initialize parameter
+
+3.5.11
+- Add scroll api for companies
+
 3.5.10
   - Add Support for find_all events pagination (@jkeyes)
 

data/lib/intercom/client.rb

@@ -14,7 +14,7 @@ module Intercom
       end
     end
 
-    def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil)
+    def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil, base_url:'https://api.intercom.io')
       if token
         @username_part = token
         @password_part = ""
@@ -24,7 +24,7 @@ module Intercom
       end
       validate_credentials!
 
-      @base_url = 'https://api.intercom.io'
+      @base_url = base_url
       @rate_limit_details = {}
     end
 
@@ -108,9 +108,9 @@ module Intercom
     end
 
     def execute_request(request)
-      result = request.execute(@base_url, username: @username_part, secret: @password_part)
+      request.execute(@base_url, username: @username_part, secret: @password_part)
+    ensure
       @rate_limit_details = request.rate_limit_details
-      result
     end
 
     def base_url=(new_url)

data/lib/intercom/request.rb

@@ -115,6 +115,8 @@ module Intercom
         raise Intercom::AuthenticationError.new('Unauthorized')
       elsif res.code.to_i.eql?(403)
         raise Intercom::AuthenticationError.new('Forbidden')
+      elsif res.code.to_i.eql?(429)
+        raise Intercom::RateLimitExceeded.new('Rate Limit Exceeded')
       elsif res.code.to_i.eql?(500)
         raise Intercom::ServerError.new('Server Error')
       elsif res.code.to_i.eql?(502)

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.12"
+  VERSION = "3.5.14"
 end

data/spec/unit/intercom/request_spec.rb

@@ -8,6 +8,12 @@ describe 'Intercom::Request' do
     proc {req.parse_body('<html>somethjing</html>', response)}.must_raise(Intercom::ServerError)
   end
 
+  it 'raises a RateLimitExceeded error when the response code is 429' do
+    response = OpenStruct.new(:code => 429)
+    req = Intercom::Request.new('path/', 'GET')
+    proc {req.parse_body('<html>somethjing</html>', response)}.must_raise(Intercom::RateLimitExceeded)
+  end
+
   it 'parse_body returns nil if decoded_body is nil' do
     response = OpenStruct.new(:code => 500)
     req = Intercom::Request.new('path/', 'GET')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.5.12
+  version: 3.5.14
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest