intercom 3.5.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af771d03313306122d7cd15732e481d1be985ea2
-  data.tar.gz: 5868caffd6bb8f2f66a674e6610b7e2278a13882
+  metadata.gz: d85b66c4f019a0f8c063d8110ac924ac77d1795a
+  data.tar.gz: 546be6dc3600a8adae3e671e32fd37f8dd2cf38f
 SHA512:
-  metadata.gz: 46b5dec841b7297280ddfddcb79400fc606e73c27324177bbc6f7fee6614851e06e409273b95c271773eec588ddd5b7aca332344ae9f4bd0c793c5f7312a822a
-  data.tar.gz: c74408ea271f4ab2695d8e9cde03a5e862ad5c59993423f478ca98d05617fea3880daf97dbc583e4ca6cf69936b167085176a9543a151c12b6bd0fb3ebee3e91
+  metadata.gz: 672212ab75756e91d0cf82c38b07c3a7eb2acee1e92715d2d0e4181bc527099cce3bf0e0fc828a619124a0db7d309c6e92677f067ca814a35d90b4cf5ea1390e
+  data.tar.gz: 7044d4fa88f2ca8ce4fd53230595a473a3770aa480e9952d0a15753a38027edcfe04cb3b0b0513b4affeb212ace7f36b18499bb30d463b3364b56db0077cd890

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.0"
+    gem 'intercom', "~> 3.5.1"
 
 ## Basic Usage
 
@@ -30,12 +30,17 @@ Using bundler:
 
 ```ruby
 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:
 intercom = Intercom::Client.new(token: 'my_token')
 ```
 
-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).
+If you are building a third party application you can get your access_tokens by [setting-up-oauth](https://developers.intercom.io/page/setting-up-oauth) for Intercom.
+You can also use the [omniauth-intercom lib](https://github.com/intercom/omniauth-intercom) which is a middleware helping you to handle the authentication process with Intercom.
 
 ### Resources
 
@@ -439,10 +444,9 @@ intercom.jobs.errors(id: 'job_abcd1234')
 
 There are different styles for error handling - some people prefer exceptions; some prefer nil and check; some prefer error objects/codes. Balancing these preferences alongside our wish to provide an idiomatic gem has brought us to use the current mechanism of throwing specific exceptions. Our approach in the client is to propagate errors and signal our failure loudly so that erroneous data does not get propagated through our customers' systems - in other words, if you see a `Intercom::ServiceUnavailableError` you know where the problem is.
 
-You do not need to deal with the HTTP response from an API call directly. If there is an unsuccessful response then an error that is a subclass of `Intercom::Error` will be raised. If desired, you can get at the http_code of an `Intercom::Error` via its `http_code` method.
+You do not need to deal with the HTTP response from an API call directly. If there is an unsuccessful response then an error that is a subclass of `Intercom::IntercomError` will be raised. If desired, you can get at the http_code of an `Intercom::IntercomError` via its `http_code` method.
 
-The list of different error subclasses are listed below. As they all inherit off Intercom::IntercomError you can choose to rescue Intercom::IntercomError or
-else rescue the more specific error subclass.
+The list of different error subclasses are listed below. As they all inherit off Intercom::IntercomError you can choose to rescue Intercom::IntercomError or else rescue the more specific error subclass.
 
 ```ruby
 Intercom::AuthenticationError

data/changes.txt

@@ -1,3 +1,10 @@
+3.5.2
+- Add Support for pagination
+
+3.5.1
+ - Support for 'visitors'
+ - Fix utf8 body parsing
+
 3.4.0
  - Add a "token" keyword for OAuth clients
 

data/lib/intercom/api_operations/find.rb

@@ -5,7 +5,8 @@ module Intercom
         raise BadRequestError, "#{self}#find takes a hash as its parameter but you supplied #{params.inspect}" unless params.is_a? Hash
         collection_name = Utils.resource_class_to_collection_name(collection_class)
         if params[:id]
-          response = @client.get("/#{collection_name}/#{params[:id]}", {})
+          id = params.delete(:id)
+          response = @client.get("/#{collection_name}/#{id}", params)
         else
           response = @client.get("/#{collection_name}", params)
         end

data/lib/intercom/client_collection_proxy.rb

@@ -16,6 +16,7 @@ module Intercom
 
     def each(&block)
       next_page = nil
+      current_page = nil
       loop do
         if next_page
           response_hash = @client.get(next_page, {})
@@ -23,9 +24,10 @@ module Intercom
           response_hash = @client.get(@finder_url, @finder_params)
         end
         raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
+        current_page = extract_current_page(response_hash)
         deserialize_response_hash(response_hash, block)
         next_page = extract_next_link(response_hash)
-        break if next_page.nil?
+        break if next_page.nil? or (@finder_params[:page] and (current_page  >=  @finder_params[:page]))
       end
       self
     end
@@ -62,5 +64,10 @@ module Intercom
       paging_info = response_hash.delete('pages')
       paging_info["next"]
     end
+
+    def extract_current_page(response_hash)
+      return nil unless paging_info_present?(response_hash)
+      response_hash['pages']['page']
+    end
   end
 end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.1"
+  VERSION = "3.5.2"
 end

data/spec/spec_helper.rb

@@ -57,6 +57,61 @@ def test_user(email="bob@example.com")
   }
 end
 
+def test_user_dates(email="bob@example.com", created_at=1401970114, last_request_at=1401970113)
+  {
+      "type" =>"user",
+      "id" =>"aaaaaaaaaaaaaaaaaaaaaaaa",
+      "user_id" => 'id-from-customers-app',
+      "email" => email,
+      "name" => "Joe Schmoe",
+      "avatar" => {"type"=>"avatar", "image_url"=>"https://graph.facebook.com/1/picture?width=24&height=24"},
+      "app_id" => "the-app-id",
+      "custom_attributes" => {"a" => "b", "b" => 2},
+      "companies" =>
+          {"type"=>"company.list",
+           "companies"=>
+               [{"type"=>"company",
+                 "company_id"=>"123",
+                 "id"=>"bbbbbbbbbbbbbbbbbbbbbbbb",
+                 "app_id"=>"the-app-id",
+                 "name"=>"Company 1",
+                 "remote_created_at"=>1390936440,
+                 "created_at"=>1401970114,
+                 "updated_at"=>1401970114,
+                 "last_request_at"=>1401970113,
+                 "monthly_spend"=>0,
+                 "session_count"=>0,
+                 "user_count"=>1,
+                 "tag_ids"=>[],
+                 "custom_attributes"=>{"category"=>"Tech"}}]},
+      "session_count" => 123,
+      "unsubscribed_from_emails" => true,
+      "last_request_at" =>last_request_at,
+      "created_at" =>created_at,
+      "remote_created_at" =>1393613864,
+      "updated_at" =>1401970114,
+      "user_agent_data" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+      "social_profiles" =>{"type"=>"social_profile.list",
+                           "social_profiles" => [
+                               {"type" => "social_profile", "name" => "twitter", "url" => "http://twitter.com/abc", "username" => "abc", "id" => nil},
+                               {"type" => "social_profile", "name" => "twitter", "username" => "abc2", "url" => "http://twitter.com/abc2", "id" => nil},
+                               {"type" => "social_profile", "name" => "facebook", "url" => "http://facebook.com/abc", "username" => "abc", "id" => "1234242"},
+                               {"type" => "social_profile", "name" => "quora", "url" => "http://facebook.com/abc", "username" => "abc", "id" => "1234242"}
+                           ]},
+      "location_data"=>
+          {"type"=>"location_data",
+           "city_name"=> 'Dublin',
+           "continent_code"=> 'EU',
+           "country_name"=> 'Ireland',
+           "latitude"=> '90',
+           "longitude"=> '10',
+           "postal_code"=> 'IE',
+           "region_name"=> 'Europe',
+           "timezone"=> '+1000',
+           "country_code" => "IRL"}
+  }
+end
+
 def test_admin_list
   {
     "type" => "admin.list",
@@ -161,6 +216,23 @@ def page_of_users(include_next_link= false)
   }
 end
 
+def users_pagination(include_next_link=false, per_page=0, page=0, total_pages=0, total_count=0, user_list=[])
+  {
+      "type"=>"user.list",
+      "pages"=>
+          {
+              "type"=>"pages",
+              "next"=> (include_next_link ? "https://api.intercom.io/users?per_page=" \
+                                            + per_page.to_s + "&page=" +  (page+1).to_s : nil),
+              "page"=>page,
+              "per_page"=>per_page,
+              "total_pages"=>total_pages
+          },
+      "users"=> user_list,
+      "total_count"=>total_count
+  }
+end
+
 def test_conversation
   {
     "type" => "conversation",

data/spec/unit/intercom/client_collection_proxy_spec.rb

@@ -32,4 +32,49 @@ describe Intercom::ClientCollectionProxy do
     client.expects(:get).with("/users", {:tag_name => 'Taggart J'}).returns(page_of_users(false))
     client.users.find_all(:tag_name => 'Taggart J').map(&:email).must_equal %W(user1@example.com user2@example.com user3@example.com)
   end
+
+  it "supports single page pagination" do
+    users = [test_user("user1@example.com"), test_user("user2@example.com"), test_user("user3@example.com"),
+     test_user("user4@example.com"), test_user("user5@example.com"), test_user("user6@example.com"),
+     test_user("user7@example.com"), test_user("user8@example.com"), test_user("user9@example.com"),
+     test_user("user10@example.com")]
+    client.expects(:get).with("/users", {:type=>'users', :per_page => 10, :page => 1}).returns(users_pagination(false, per_page=10, page=1, total_pages=1, total_count=10, user_list=users))
+    result = client.users.find_all(:type=>'users', :per_page => 10, :page => 1).map {|user| user.email }
+    result.must_equal %W(user1@example.com user2@example.com user3@example.com user4@example.com user5@example.com user6@example.com user7@example.com user8@example.com user9@example.com user10@example.com)
+  end
+
+  it "supports multi page pagination" do
+    users = [test_user("user3@example.com"), test_user("user4@example.com")]
+    client.expects(:get).with("/users", {:type=>'users', :per_page => 2, :page => 3}).returns(users_pagination(true, per_page=2, page=3, total_pages=5, total_count=10, user_list=users))
+    result = client.users.find_all(:type=>'users', :per_page => 2, :page => 3).map {|user| user.email }
+    result.must_equal %W(user3@example.com user4@example.com)
+  end
+
+  it "works with page out of range request" do
+    users = []
+    client.expects(:get).with("/users", {:type=>'users', :per_page => 2, :page => 30}).returns(users_pagination(true, per_page=2, page=30, total_pages=2, total_count=3, user_list=users))
+    result = client.users.find_all(:type=>'users', :per_page => 2, :page => 30).map {|user| user.email }
+    result.must_equal %W()
+  end
+
+  it "works with asc order" do
+    test_date=1457337600
+    time_increment=1000
+    users = [test_user_dates(email="user1@example.com", created_at=test_date), test_user_dates(email="user2@example.com", created_at=test_date-time_increment),
+             test_user_dates(email="user3@example.com", created_at=test_date-2*time_increment), test_user_dates(email="user4@example.com", created_at=test_date-3*time_increment)]
+    client.expects(:get).with("/users", {:type=>'users', :per_page => 4, :page => 5, :order => "asc", :sort => "created_at"}).returns(users_pagination(true, per_page=4, page=5, total_pages=6, total_count=30, user_list=users))
+    result = client.users.find_all(:type=>'users', :per_page => 4, :page => 5, :order => "asc", :sort => "created_at").map(&:email)
+    result.must_equal %W(user1@example.com user2@example.com user3@example.com user4@example.com)
+  end
+
+  it "works with desc order" do
+    test_date=1457337600
+    time_increment=1000
+    users = [test_user_dates(email="user4@example.com", created_at=3*test_date), test_user_dates(email="user3@example.com", created_at=test_date-2*time_increment),
+             test_user_dates(email="user2@example.com", created_at=test_date-time_increment), test_user_dates(email="user1@example.com", created_at=test_date)]
+    client.expects(:get).with("/users", {:type=>'users', :per_page => 4, :page => 5, :order => "desc", :sort => "created_at"}).returns(users_pagination(true, per_page=4, page=5, total_pages=6, total_count=30, user_list=users))
+    result = client.users.find_all(:type=>'users', :per_page => 4, :page => 5, :order => "desc", :sort => "created_at").map {|user| user.email }
+    result.must_equal %W(user4@example.com user3@example.com user2@example.com user1@example.com)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.2
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -225,7 +225,7 @@ 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
@@ -251,4 +251,3 @@ test_files:
 - spec/unit/intercom/user_spec.rb
 - spec/unit/intercom/visitors_spec.rb
 - spec/unit/intercom_spec.rb
-has_rdoc: