intercom 3.5.10 → 3.9.5

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/base_service.rb

@@ -1,3 +1,5 @@
+require 'intercom/client_collection_proxy'
+
 module Intercom
   module Service
     class BaseService
@@ -11,6 +13,10 @@ module Intercom
         raise NotImplementedError
       end
 
+      def collection_proxy_class
+        Intercom::ClientCollectionProxy
+      end
+
       def from_api(api_response)
         object = collection_class.new
         object.from_response(api_response)

data/lib/intercom/service/company.rb

@@ -1,10 +1,10 @@
 require 'intercom/service/base_service'
 require 'intercom/api_operations/list'
+require 'intercom/api_operations/scroll'
 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'
 
@@ -15,14 +15,26 @@ module Intercom
       include ApiOperations::FindAll
       include ApiOperations::Load
       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/service/contact.rb

@@ -6,7 +6,8 @@ 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'
+require 'intercom/api_operations/archive'
+require 'intercom/api_operations/request_hard_delete'
 
 module Intercom
   module Service
@@ -18,7 +19,8 @@ module Intercom
       include ApiOperations::Save
       include ApiOperations::Scroll
       include ApiOperations::Convert
-      include ApiOperations::Delete
+      include ApiOperations::Archive
+      include ApiOperations::RequestHardDelete
 
       def collection_class
         Intercom::Contact

data/lib/intercom/service/conversation.rb

@@ -9,6 +9,7 @@ module Intercom
   module Service
     class Conversation < BaseService
       include ApiOperations::FindAll
+      include ApiOperations::List
       include ApiOperations::Find
       include ApiOperations::Load
       include ApiOperations::Save
@@ -28,6 +29,12 @@ module Intercom
         collection_class.new.from_response(response)
       end
 
+      def reply_to_last(reply_data)
+        collection_name = Utils.resource_class_to_collection_name(collection_class)
+        response = @client.post("/#{collection_name}/last/reply", reply_data)
+        collection_class.new.from_response(response)
+      end
+
       def open(reply_data)
         reply reply_data.merge(message_type: 'open', type: 'admin')
       end
@@ -36,6 +43,11 @@ module Intercom
         reply reply_data.merge(message_type: 'close', type: 'admin')
       end
 
+      def snooze(reply_data)
+        snoozed_until = reply_data.fetch(:snoozed_until) { fail 'snoozed_until field is required' }
+        reply reply_data.merge(message_type: 'snoozed', type: 'admin')
+      end
+
       def assign(reply_data)
         assignee_id = reply_data.fetch(:assignee_id) { fail 'assignee_id is required' }
         reply reply_data.merge(message_type: 'assignment', assignee_id: assignee_id, type: 'admin')

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/service/event.rb

@@ -1,8 +1,16 @@
+require 'intercom/client_collection_proxy'
 require 'intercom/service/base_service'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/bulk/submit'
 
 module Intercom
+  class EventCollectionProxy < ClientCollectionProxy
+
+    def paging_info_present?(response_hash)
+      !!(response_hash['pages'])
+    end
+  end
+
   module Service
     class Event < BaseService
       include ApiOperations::FindAll
@@ -12,6 +20,10 @@ module Intercom
       def collection_class
         Intercom::Event
       end
+
+      def collection_proxy_class
+        Intercom::EventCollectionProxy
+      end
     end
   end
 end

data/lib/intercom/service/subscription.rb

@@ -2,7 +2,7 @@ require 'intercom/api_operations/list'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/find'
 require 'intercom/api_operations/save'
-require 'intercom/api_operations/delete'
+require 'intercom/api_operations/archive'
 
 module Intercom
   module Service
@@ -11,7 +11,7 @@ module Intercom
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Subscription

data/lib/intercom/service/tag.rb

@@ -9,7 +9,7 @@ module Intercom
       include ApiOperations::Save
       include ApiOperations::List
       include ApiOperations::FindAll
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Tag

data/lib/intercom/service/team.rb

@@ -0,0 +1,17 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
+
+module Intercom
+  module Service
+    class Team < BaseService
+      include ApiOperations::List
+      include ApiOperations::Find
+
+      def collection_class
+        Intercom::Team
+      end
+
+    end
+  end
+end

data/lib/intercom/service/user.rb

@@ -5,8 +5,9 @@ require 'intercom/api_operations/scroll'
 require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
-require 'intercom/api_operations/delete'
+require 'intercom/api_operations/archive'
 require 'intercom/api_operations/bulk/submit'
+require 'intercom/api_operations/request_hard_delete'
 require 'intercom/extended_api_operations/tags'
 require 'intercom/extended_api_operations/segments'
 
@@ -19,7 +20,8 @@ module Intercom
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Delete
+      include ApiOperations::Archive
+      include ApiOperations::RequestHardDelete
       include ApiOperations::Bulk::Submit
       include ExtendedApiOperations::Tags
       include ExtendedApiOperations::Segments

data/lib/intercom/service/visitor.rb

@@ -5,7 +5,7 @@ require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/convert'
-require 'intercom/api_operations/delete'
+require 'intercom/api_operations/archive'
 
 module Intercom
   module Service
@@ -16,7 +16,7 @@ module Intercom
       include ApiOperations::FindAll
       include ApiOperations::Save
       include ApiOperations::Convert
-      include ApiOperations::Delete
+      include ApiOperations::Archive
 
       def collection_class
         Intercom::Visitor

data/lib/intercom/team.rb

@@ -0,0 +1,7 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Team
+    include Traits::ApiResource
+  end
+end

data/lib/intercom/traits/api_resource.rb

@@ -24,7 +24,6 @@ module Intercom
 
       def from_hash(hash)
         hash.each do |attribute, value|
-          next if type_field?(attribute)
           initialize_property(attribute, value)
         end
         initialize_missing_flat_store_attributes if respond_to? :flat_store_attributes
@@ -78,13 +77,13 @@ module Intercom
       end
 
       def custom_attribute_field?(attribute)
-        attribute == 'custom_attributes'
+        attribute.to_s == 'custom_attributes'
       end
-      
+
       def message_from_field?(attribute, value)
         attribute.to_s == 'from' && value.is_a?(Hash) && value['type']
       end
-      
+
       def message_to_field?(attribute, value)
         attribute.to_s == 'to' && value.is_a?(Hash) && value['type']
       end
@@ -94,7 +93,7 @@ module Intercom
           !custom_attribute_field?(attribute) &&
           !message_from_field?(attribute, value) &&
           !message_to_field?(attribute, value) &&
-          attribute != 'metadata'
+          attribute.to_s != 'metadata'
       end
 
       def typed_value?(value)
@@ -106,10 +105,6 @@ module Intercom
         self.send(setter_method, value)
       end
 
-      def type_field?(attribute)
-        attribute == 'type'
-      end
-
       def initialize_missing_flat_store_attributes
         flat_store_attributes.each do |attribute|
           unless instance_variables_excluding_dirty_tracking_field.map(&:to_s).include? "@#{attribute}"

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.10"
+  VERSION = "3.9.5"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,17 @@
 require 'intercom'
 require 'minitest/autorun'
 require 'mocha/setup'
+require 'webmock'
+require 'time'
+require 'pry'
+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")
   {
@@ -135,6 +146,35 @@ def test_admin
   }
 end
 
+def test_team_list
+  {
+    "type"=> "team.list",
+    "teams" => [
+      {
+        "type"=> "team",
+        "id"=> "2744328",
+        "name"=> "the_a_team",
+        "admin_ids"=> [646303, 814860],
+      },
+      {
+        "type"=> "team",
+        "id"=> "814865",
+        "name"=> "BA_App",
+        "admin_ids" => [492881, 1195856]
+      },
+    ]
+  }
+end
+
+def test_team
+  {
+      "type" => "team",
+      "id" => "2744328",
+      "name" => "the_a_team",
+      "admin_ids" => [646303, 814860]
+  }
+end
+
 def test_company
   {
     "type" => "company",
@@ -225,6 +265,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",
@@ -233,7 +289,7 @@ def users_scroll(include_users= false)
   }
 end
 
-def users_pagination(include_next_link=false, per_page=0, page=0, total_pages=0, total_count=0, user_list=[])
+def users_pagination(include_next_link:, per_page:, page:, total_pages:, total_count:, user_list:)
   {
       "type"=>"user.list",
       "pages"=>
@@ -289,6 +345,56 @@ def test_conversation
   }
 end
 
+def test_conversation_list
+  {
+    "type" => "conversation.list",
+   "pages" => {
+     "type" => "pages",
+     "page" => 1,
+     "per_page" => 20,
+     "total_pages" => 1
+   },
+   "conversations" => [
+     {
+       "type" => "conversation",
+       "id" => "147",
+       "created_at" => 1400850973,
+       "updated_at" => 1400857494,
+       "conversation_message" => {
+         "type" => "conversation_message",
+         "subject" => "",
+         "body" => "<p>Hi Alice,</p>\n\n<p>We noticed you using our Product, do you have any questions?</p> \n<p>- Jane</p>",
+         "author" => {
+           "type" => "admin",
+           "id" => "25"
+         },
+         "attachments" => [
+           {
+             "name" => "signature",
+             "url" => "http =>//someurl.com/signature.jpg"
+           }
+         ]
+       },
+       "user" => {
+         "type" => "user",
+         "id" => "536e564f316c83104c000020"
+       },
+       "assignee" => {
+         "type" => "admin",
+         "id" => "25"
+       },
+       "open" => true,
+       "read" => true,
+       "conversation_parts" => {
+         "type" => "conversation_part.list",
+         "conversation_parts" => [
+         ]
+       }
+     }
+   ]
+  }
+end
+
 def segment
   {
     "type" => "segment",
@@ -568,11 +674,27 @@ def test_event_list
     "type" => "event.list",
     "events" => [ test_event ],
     "pages" => {
-      "next" => "https =>//api.intercom.io/events?type=user&intercom_user_id=55a3b&before=144474756550"
+      "next" => "https://api.intercom.io/events?type=user&intercom_user_id=55a3b&before=144474756550"
     }
   }
 end
 
+def tomorrow
+  (DateTime.now.to_time + 1).to_i
+end
+
+def page_of_events(include_next_link=false)
+  {
+     "type" => "event.list",
+     "events" => [ test_event ],
+     "pages" =>
+      {
+        "next" => (include_next_link ? "https://api.intercom.io/events?type=user&intercom_user_id=55a3b&before=144474756550" : nil),
+      }
+  }
+end
+
+
 def error_on_modify_frozen
   RUBY_VERSION =~ /1.8/ ? TypeError : RuntimeError
 end