intercom 3.5.4 → 3.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65f8ee35be573105827b5e3b6241d07154e0a075
-  data.tar.gz: 5a61122d948cd69ea4d2b6ddade7ab6a614de8a5
+  metadata.gz: d1a6847dce96b450a0a76df67eca84f56d3ef455
+  data.tar.gz: 22145c09b5d23cf751309bc7f270fa219f170d11
 SHA512:
-  metadata.gz: 74f22fb60b9c7ac2b65eaa1921be6cb44a18c1862254ba961f3f6bb57187cfbf56f56c555e241ac7681a6cd79ef28f11329b5c9dc5c0a49368710bcfaad85df9
-  data.tar.gz: 4561b5bdf72b92be0a91eebd9ad049239d5682b5b37b4f3f93e41a3cd8a5faa3a861a2d9f51a3ecdb1924e24cedadcc2cf756ab69553eb3570deafa244257141
+  metadata.gz: c319a85c4f7e6bc3de496f4d3730f656290da92ced3153b3d23c1deb75de58a38e03f7bc5e25f71d8b9f3377193112b8e16658285199cd2a1f3238fc29fd74f3
+  data.tar.gz: e4586310e90cfe1cbf5a87bf0988658bb04cb66aad4ae44feaf75f49e4c2fc735bc0530e76defb116f5e081a172185c48bf9542c47e4d4773aae28cba6a8b9fd

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.3"
+    gem 'intercom', "~> 3.5.5"
 
 ## Basic Usage
 
@@ -35,7 +35,7 @@ intercom = Intercom::Client.new(app_id: 'my_app_id', api_key: 'my_api_key')
 You can get your `app_id` from the URL when you're logged into Intercom (it's the alphanumeric just after `/apps/`) and your API key from the API keys integration settings page (under your app settings - integrations in Intercom).
 
 ```ruby
-# With an OAuth token:
+# With an OAuth or Personal Access token:
 intercom = Intercom::Client.new(token: 'my_token')
 ```
 
@@ -82,13 +82,34 @@ intercom.users.save(user)
 # Perform incrementing
 user.increment('karma')
 intercom.users.save(user)
+# Perform decrementing
+user.decrement('karma', 5)
+intercom.users.save(user)
 # Iterate over all users
 intercom.users.all.each {|user| puts %Q(#{user.email} - #{user.custom_attributes["average_monthly_spend"]}) }
 intercom.users.all.map {|user| user.email }
+# List your users create in the last two days
+intercom.users.find_all(type: 'users', page: 1, per_page: 10, created_since: 2, order: :asc).to_a.each_with_index {|usr, i| puts "#{i+1}: #{usr.name}"};
+# Paginate through your list of users choosing how many to return per page (default and max is 50 per page)
+intercom.users.find_all(type: 'users', page: 1, per_page: 10, order: :asc).to_a.each_with_index {|usr, i| puts "#{i+1}: #{usr.name}"}
+# If you have over 10,000 users then you will need to use the scroll function to list your users
+# otherwise you will encounter a page limit with list all your users
+# You can use the scroll method to list all your users
+intercom.users.scroll.each { |user| puts user.name}
+# Alternatively you can use the scroll.next method to get 100 users with each request
+result = intercom.users.scroll.next
+# The result object then contains a records attributes that is an array of your user objects and it also contains a scroll_param which
+# you can then use to request the next 100 users. Note that the scroll parameter will time out after one minute and you will need to
+# make a new request
+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
+# 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
@@ -97,6 +118,8 @@ intercom.users.submit_bulk_job(create_items: [{user_id: 25, email: "alice@exampl
 
 #### Admins
 ```ruby
+# Find an admin by id
+intercom.admins.find(:id => admin_id)
 # Iterate over all admins
 intercom.admins.all.each {|admin| puts admin.email }
 ```
@@ -469,3 +492,20 @@ Calling your client's `rate_limit_details` returns a Hash that contains details
 intercom.rate_limit_details
 #=> {:limit=>180, :remaining=>179, :reset_at=>2014-10-07 14:58:00 +0100}
 ```
+
+
+### Pull Requests
+
+- **Add tests!** Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour**. Make sure the README and any other
+  relevant documentation are kept up-to-date.
+
+- **Create topic branches**. Don't ask us to pull from your master branch.
+
+- **One pull request per feature**. If you want to do more than one thing, send
+  multiple pull requests.
+
+- **Send coherent history**. Make sure each individual commit in your pull
+  request is meaningful. If you had to make multiple intermediate commits while
+  developing, please squash them before sending them to us.

data/changes.txt

@@ -1,3 +1,11 @@
+3.5.5
+- Add scroll api for contacts
+- Add extra context to IntercomError
+- Add support to find admin by id
+- Add decrement method to incrementable traits
+- Suppress printing of users during test runs
+
+
 3.5.4
 - Add support for scoll API feature
 

data/lib/intercom/errors.rb

@@ -2,12 +2,25 @@ module Intercom
 
   # Base class exception from which all public Intercom exceptions will be derived
   class IntercomError < StandardError
-    attr_reader :http_code, :application_error_code
-    def initialize(message, http_code = nil, error_code = application_error_code)
-      @http_code = http_code
-      @application_error_code = error_code
+    attr_reader :http_code, :application_error_code, :field, :request_id
+    def initialize(message, context={})
+      @http_code = context[:http_code]
+      @application_error_code = context[:application_error_code]
+      @field = context[:field]
+      @request_id = context[:request_id]
       super(message)
     end
+    def inspect
+      attributes = instance_variables.map do |var|
+        value = instance_variable_get(var).inspect
+        "#{var}=#{value}"
+      end
+      "##{self.class.name}:#{message} #{attributes.join(' ')}"
+    end
+    def to_hash
+      {message: message}
+        .merge(Hash[instance_variables.map{ |var| [var[1..-1], instance_variable_get(var)] }])
+    end
   end
 
   # Raised when the credentials you provide don't match a valid account on Intercom.

data/lib/intercom/request.rb

@@ -128,10 +128,13 @@ module Intercom
       # Currently, we don't support multiple errors
       error_details = error_list_details['errors'].first
       error_code = error_details['type'] || error_details['code']
+      error_field = error_details['field']
       parsed_http_code = (http_code > 0 ? http_code : nil)
       error_context = {
         :http_code => parsed_http_code,
-        :application_error_code => error_code
+        :application_error_code => error_code,
+        :field => error_field,
+        :request_id => error_list_details['request_id']
       }
       case error_code
       when 'unauthorized', 'forbidden'

data/lib/intercom/service/admin.rb

@@ -1,10 +1,12 @@
 require 'intercom/service/base_service'
 require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
 
 module Intercom
   module Service
     class Admin < BaseService
       include ApiOperations::List
+      include ApiOperations::Find
 
       def collection_class
         Intercom::Admin

data/lib/intercom/service/contact.rb

@@ -4,6 +4,7 @@ require 'intercom/api_operations/list'
 require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
+require 'intercom/api_operations/scroll'
 require 'intercom/api_operations/convert'
 require 'intercom/api_operations/delete'
 
@@ -15,6 +16,7 @@ module Intercom
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save
+      include ApiOperations::Scroll
       include ApiOperations::Convert
       include ApiOperations::Delete
 

data/lib/intercom/traits/incrementable_attributes.rb

@@ -7,6 +7,12 @@ module Intercom
         existing_value ||= 0
         self.custom_attributes[key] = existing_value + value
       end
+
+      def decrement(key, value=1)
+        existing_value = self.custom_attributes[key] || 0
+        self.custom_attributes[key] = existing_value - value
+      end
+
     end
   end
 end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.4"
+  VERSION = "3.5.5"
 end

data/spec/spec_helper.rb

@@ -126,6 +126,15 @@ def test_admin_list
   }
 end
 
+def test_admin
+  {
+    "type" => "admin",
+    "id" => "1234",
+    "name" => "Hoban Washburne",
+    "email" => "wash@serenity.io"
+  }
+end
+
 def test_company
   {
     "type" => "company",

data/spec/unit/intercom/admin_spec.rb

@@ -13,4 +13,9 @@ describe "Intercom::Admin" do
     client.expects(:get).with("/admins", {}).returns(test_admin_list)
     client.admins.all.each { |a| }
   end
+
+  it "gets an admin" do
+    client.expects(:get).with("/admins/1234", {}).returns(test_admin)
+    client.admins.find(:id => "1234")
+  end
 end

data/spec/unit/intercom/user_spec.rb

@@ -148,6 +148,34 @@ describe "Intercom::User" do
     end
   end
 
+  describe "decrementing custom_attributes fields" do
+    before :each do
+      @now = Time.now
+      @user = Intercom::User.new("email" => "jo@example.com", :user_id => "i-1224242", :custom_attributes => {"mad" => 123, "another" => 432, "other" => @now.to_i, :thing => "yay"})
+    end
+
+    it "decrements down by 1 with no args" do
+      @user.decrement("mad")
+      @user.to_hash["custom_attributes"]["mad"].must_equal 122
+    end
+
+    it "decrements down by given value" do
+      @user.decrement("mad", 3)
+      @user.to_hash["custom_attributes"]["mad"].must_equal 120
+    end
+
+    it "can decrement new custom data fields" do
+      @user.decrement("new_field", 5)
+      @user.to_hash["custom_attributes"]["new_field"].must_equal -5
+    end
+
+    it "can call decrement on the same key twice and decrement by 2" do
+      @user.decrement("mad")
+      @user.decrement("mad")
+      @user.to_hash["custom_attributes"]["mad"].must_equal 121
+    end
+  end
+
   it "fetches a user" do
     client.expects(:get).with("/users", {"email" => "bo@example.com"}).returns(test_user)
     user = client.users.find("email" => "bo@example.com")
@@ -238,8 +266,17 @@ describe "Intercom::User" do
   it 'can print users without crashing' do
     client.expects(:get).with("/users", {"email" => "bo@example.com"}).returns(test_user)
     user = client.users.find("email" => "bo@example.com")
-    puts user
-    p user
+
+    begin
+      orignal_stdout = $stdout
+      $stdout = StringIO.new
+
+      puts user
+      p user
+
+    ensure
+      $stdout = orignal_stdout
+    end
   end
 
   describe 'bulk operations' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.5.5
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,90 +15,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-30 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
 description: 'Intercom (https://www.intercom.io) is a customer relationship management
@@ -117,9 +117,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".gitignore"
-- ".travis.yml"
+- .github/ISSUE_TEMPLATE.md
+- .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -218,17 +218,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.5.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API