intercom 3.7.7 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb52e11279caa2be1661a7fdfbc7abc1829d2d73
-  data.tar.gz: '092c4c0c51aac933d960596327577905c93590aa'
+SHA256:
+  metadata.gz: da9b3a3eada2fcf56d0d91d948bf4bed01fd27db5d5175293666be7cc702ef20
+  data.tar.gz: e2d4b731ce51e10b3d3bcba67024e3926595aea618d4cdee7a9bde38fca45f21
 SHA512:
-  metadata.gz: 071616a6160830c039e7980e0a35689ff4be1035bb4dbc9bdb492bfc8ce4d6862e0f8357c50cb1fc3951428387931689023878f7099555346694f8bdd4c024d9
-  data.tar.gz: 878a9f3fc2780fb76079ef2af88ef86262ff673cef19b21e4507ee508f82dd3f589cc83c69ff8426f0cfe66d7c679346b429f8936812b31588e3d136723a6922
+  metadata.gz: 3ef7cde04e9affeb408ec48d0767d39c88923aa4249ad89b6f30029f2e0e172972e105310078d1139a804bae9290b683e86f38a079beedf23441bd1fe4dafb8d
+  data.tar.gz: 6b088e5a334fcd48df68ed57293ee3e7c0b8cfaf26e0ba67bc724d24b4d7ce7177dec4b7cd9d69f8aa893a358268109356dc0369771131aafb77c63c1240ce2f

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.7.6'
+    gem 'intercom', '~> 3.7.7'
 
 ## Basic Usage
 
@@ -97,7 +97,7 @@ intercom.users.find_all(type: 'users', page: 1, per_page: 10, created_since: 2,
 # 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}"}
 
-# Duplicate users? If you have duplicate users you can search for them via their email address. 
+# Duplicate users? If you have duplicate users you can search for them via their email address.
 # Note this feature is only available from version 1.1 of the API so you will need to switch to that version
 # This will return multiple users if they have the same email address
 usrs = intercom.users.find_all(type: 'users', email: 'myemail@example.com', page: 1, per_page: 10, order: :asc)
@@ -402,7 +402,7 @@ 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.
 
-### Contacts
+#### Contacts
 
 `Contacts` represent logged out users of your application.
 Note that `contacts` are referred to as `leads` in the [Intercom](https://developers.intercom.com/intercom-api-reference/reference#leads)
@@ -458,7 +458,13 @@ intercom.contacts.scroll.each { |lead| puts lead.id}
 # Please see users scroll for more details of how to use scroll
 ```
 
-### Counts
+#### Customers
+
+# Search for customers
+customers = intercom.customers.search(query: { "field": "name", "operator": "=", "value": "Alice"}, per_page: 50, sort_field: "name", sort_order: "ascending")
+customers.each { |customer| p customer.name }
+
+#### Counts
 
 ```ruby
 # App-wide counts
@@ -468,7 +474,7 @@ intercom.counts.for_app
 intercom.counts.for_type(type: 'user', count: 'segment')
 ```
 
-### Subscriptions
+#### Subscriptions
 
 Subscribe to events in Intercom to receive webhooks.
 

data/changes.txt

@@ -1,3 +1,6 @@
+3.7.7
+Remove deprecated features from Gemspec
+
 3.7.6
 Added error handling for invalid_document error state
 

data/lib/intercom.rb

@@ -4,6 +4,7 @@ require 'intercom/service/company'
 require 'intercom/service/contact'
 require 'intercom/service/conversation'
 require 'intercom/service/count'
+require 'intercom/service/customer'
 require 'intercom/service/event'
 require 'intercom/service/message'
 require 'intercom/service/note'
@@ -17,6 +18,7 @@ require 'intercom/options'
 require 'intercom/client'
 require "intercom/contact"
 require "intercom/count"
+require "intercom/customer"
 require "intercom/user"
 require "intercom/company"
 require "intercom/note"

data/lib/intercom/api_operations/search.rb

@@ -0,0 +1,17 @@
+require 'intercom/search_collection_proxy'
+require 'intercom/utils'
+
+module Intercom
+  module ApiOperations
+    module Search
+      def search(params)
+        collection_name = Utils.resource_class_to_collection_name(collection_class)
+        search_details = {
+          url: "/#{collection_name}/search",
+          params: params
+        }
+        SearchCollectionProxy.new(collection_name, search_details: search_details, client: @client)
+      end
+    end
+  end
+end

data/lib/intercom/client.rb

@@ -67,6 +67,10 @@ module Intercom
       Intercom::Service::Counts.new(self)
     end
 
+    def customers
+      Intercom::Service::Customer.new(self)
+    end
+
     def events
       Intercom::Service::Event.new(self)
     end

data/lib/intercom/customer.rb

@@ -0,0 +1,10 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Customer
+    include Traits::ApiResource
+
+    def identity_vars ; [:id, :email, :user_id] ; end
+    def flat_store_attributes ; [:custom_attributes] ; end
+  end
+end

data/lib/intercom/search_collection_proxy.rb

@@ -0,0 +1,82 @@
+require "intercom/utils"
+
+module Intercom
+  class SearchCollectionProxy
+
+    attr_reader :resource_name, :resource_class
+
+    def initialize(resource_name, search_details: {}, client:)
+      @resource_name = resource_name
+      @resource_class = Utils.constantize_resource_name(resource_name)
+      @search_url = search_details[:url]
+      @search_params = search_details[:params]
+      @client = client
+    end
+
+    def each(&block)
+      loop do
+        response_hash = @client.post(@search_url, payload)
+        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
+        deserialize_response_hash(response_hash, block)
+        break unless has_next_link?(response_hash)
+      end
+      self
+    end
+
+    def [](target_index)
+      self.each_with_index do |item, index|
+        return item if index == target_index
+      end
+      nil
+    end
+
+    include Enumerable
+
+    private
+
+    def deserialize_response_hash(response_hash, block)
+      top_level_type = response_hash.delete('type')
+      top_level_entity_key = Utils.entity_key_from_type(top_level_type)
+      response_hash[top_level_entity_key].each do |object_json|
+        block.call Lib::TypedJsonDeserializer.new(object_json).deserialize
+      end
+    end
+
+    def has_next_link?(response_hash)
+      paging_info = response_hash.delete('pages')
+      paging_next = paging_info["next"]
+      if paging_next
+        @search_params[:starting_after] = paging_next["starting_after"]
+        return true
+      else
+        return false
+      end
+    end
+
+    def payload
+      payload = {
+        query: @search_params[:query]
+      }
+      if @search_params[:sort_field] || @search_params[:sort_order]
+        payload[:sort] = {}
+        if @search_params[:sort_field]
+          payload[:sort][:field] = @search_params[:sort_field]
+        end
+        if @search_params[:sort_order]
+          payload[:sort][:order] = @search_params[:sort_order]
+        end
+      end
+      if @search_params[:per_page] || @search_params[:starting_after]
+        payload[:pagination] = {}
+        if @search_params[:per_page]
+          payload[:pagination][:per_page] = @search_params[:per_page]
+        end
+        if @search_params[:starting_after]
+          payload[:pagination][:starting_after] = @search_params[:starting_after]
+        end
+      end
+      return payload
+    end
+
+  end
+end

data/lib/intercom/service/customer.rb

@@ -0,0 +1,14 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/search'
+
+module Intercom
+  module Service
+    class Customer < BaseService
+      include ApiOperations::Search
+
+      def collection_class
+        Intercom::Customer
+      end
+    end
+  end
+end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.7.7"
+  VERSION = "3.8.0"
 end

data/spec/spec_helper.rb

@@ -5,6 +5,13 @@ require 'webmock'
 require 'time'
 include WebMock::API
 
+def test_customer(email="bob@example.com")
+  customer = test_user(email)
+  customer["type"] = "customer"
+  customer["role"] = "user"
+  customer
+end
+
 def test_user(email="bob@example.com")
   {
     "type" =>"user",
@@ -228,6 +235,22 @@ def page_of_users(include_next_link= false)
   }
 end
 
+def page_of_customers(include_starting_after= false)
+  {
+     "type"=>"customer.list",
+     "pages"=>
+      {
+        "type"=>"pages",
+        "next"=> (include_starting_after ? { "page" => 2, "starting_after" => "EnCrYpTeDsTrInG" } : nil),
+        "page"=>1,
+        "per_page"=>50,
+        "total_pages"=>7
+      },
+      "customers"=> [test_customer("user1@example.com"), test_customer("user2@example.com"), test_customer("user3@example.com")],
+      "total_count"=>314
+  }
+end
+
 def users_scroll(include_users= false)
   {
       "type"=>"user.list",

data/spec/unit/intercom/search_collection_proxy_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Intercom::SearchCollectionProxy do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
+  it "send query to the customer search endpoint" do
+    client.expects(:post).with("/customers/search", { query: {} }).  returns(page_of_customers(false))
+    client.customers.search(query: {}).first
+  end
+
+  it "send query to the customer search endpoint with sort_field" do
+    client.expects(:post).with("/customers/search", { query: {}, sort: { field: "name" } }).  returns(page_of_customers(false))
+    client.customers.search(query: {}, sort_field: "name").first
+  end
+
+  it "send query to the customer search endpoint with sort_field and sort_order" do
+    client.expects(:post).with("/customers/search", { query: {}, sort: { field: "name", order: "ascending" } }).  returns(page_of_customers(false))
+    client.customers.search(query: {}, sort_field: "name", sort_order: "ascending").first
+  end
+
+  it "send query to the customer search endpoint with per_page" do
+    client.expects(:post).with("/customers/search", { query: {}, pagination: { per_page: 10 }}).  returns(page_of_customers(false))
+    client.customers.search(query: {}, per_page: 10).first
+  end
+
+  it "send query to the customer search endpoint with starting_after" do
+    client.expects(:post).with("/customers/search", { query: {}, pagination: { starting_after: "EnCrYpTeDsTrInG" }}).  returns(page_of_customers(false))
+    client.customers.search(query: {}, starting_after: "EnCrYpTeDsTrInG").first
+  end
+
+  it "stops iterating if no starting_after value" do
+    client.expects(:post).with("/customers/search", { query: {} }).  returns(page_of_customers(false))
+    emails = []
+    client.customers.search(query: {}).each { |user| emails << user.email }
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
+  it "keeps iterating if starting_after value" do
+    client.expects(:post).with("/customers/search", { query: {} }).returns(page_of_customers(true))
+    client.expects(:post).with("/customers/search", { query: {}, pagination: { starting_after: "EnCrYpTeDsTrInG" }}).returns(page_of_customers(false))
+    emails = []
+    client.customers.search(query: {}).each { |user| emails << user.email }
+  end
+
+  it "supports indexed array access" do
+    client.expects(:post).with("/customers/search", { query: {} }).returns(page_of_customers(false))
+    client.customers.search(query: {})[0].email.must_equal 'user1@example.com'
+  end
+
+  it "supports map" do
+    client.expects(:post).with("/customers/search", { query: {} }).returns(page_of_customers(false))
+    emails = client.customers.search(query: {}).map { |user| user.email }
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.7.7
+  version: 3.8.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -143,12 +143,14 @@ files:
 - lib/intercom/api_operations/request_hard_delete.rb
 - lib/intercom/api_operations/save.rb
 - lib/intercom/api_operations/scroll.rb
+- lib/intercom/api_operations/search.rb
 - lib/intercom/client.rb
 - lib/intercom/client_collection_proxy.rb
 - lib/intercom/company.rb
 - lib/intercom/contact.rb
 - lib/intercom/conversation.rb
 - lib/intercom/count.rb
+- lib/intercom/customer.rb
 - lib/intercom/errors.rb
 - lib/intercom/event.rb
 - lib/intercom/extended_api_operations/segments.rb
@@ -163,6 +165,7 @@ files:
 - lib/intercom/options.rb
 - lib/intercom/request.rb
 - lib/intercom/scroll_collection_proxy.rb
+- lib/intercom/search_collection_proxy.rb
 - lib/intercom/segment.rb
 - lib/intercom/service/admin.rb
 - lib/intercom/service/base_service.rb
@@ -170,6 +173,7 @@ files:
 - lib/intercom/service/contact.rb
 - lib/intercom/service/conversation.rb
 - lib/intercom/service/count.rb
+- lib/intercom/service/customer.rb
 - lib/intercom/service/event.rb
 - lib/intercom/service/job.rb
 - lib/intercom/service/message.rb
@@ -203,6 +207,7 @@ files:
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/request_spec.rb
 - spec/unit/intercom/scroll_collection_proxy_spec.rb
+- spec/unit/intercom/search_collection_proxy_spec.rb
 - spec/unit/intercom/segment_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
@@ -230,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
@@ -250,6 +255,7 @@ test_files:
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/request_spec.rb
 - spec/unit/intercom/scroll_collection_proxy_spec.rb
+- spec/unit/intercom/search_collection_proxy_spec.rb
 - spec/unit/intercom/segment_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb