intercom 3.9.5 → 4.1.3

data/Rakefile

@@ -18,4 +18,4 @@ Rake::TestTask.new("spec:integration") do |spec|
 end
 
 task :spec => "spec:unit"
-task :default => :spec
+task :default => :spec

data/changes.txt

@@ -1,3 +1,35 @@
+4.1.2
+- Adding support for company delete.
+- Adding support for archiving/unarchiving contacts.
+- Adding support for listing contact segments.
+- Fixed issue with scroll collection proxy.
+- Fixed issue with running assignment rules on a conversation.
+
+4.1.1
+- Fixed bug with deprecated lead resource.
+
+4.1.0
+- Added support for new Articles API.
+- Added support for new Collections API.
+- Added support for new Sections API.
+- Added support to equate two resources.
+- Fixed issue for dirty tracking nested typed objects.
+
+4.0.1
+- Fixed bug with nested resources.
+- Support for add/remove contact on conversation object.
+
+4.0.0
+New version to support API version 2.0.
+- Added support for new Contacts API.
+- Added support for Conversation Search and for Conversation model changes.
+- New DataAttribute class to support the Data Attributes. See README for details on usage.
+- New method to run assignment rules on a conversation: `intercom.conversations.run_assignment_rules(<convo_id>)`.
+- See Migration guide for breaking changes: https://github.com/intercom/intercom-ruby/wiki/Migration-guide-for-v4
+
+3.9.5
+Add Unstable version support
+
 3.9.4
 Add handling for Gateway Timeouts
 

data/lib/intercom/api_operations/archive.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'intercom/utils'
 
 module Intercom
   module ApiOperations
     module Archive
       def archive(object)
-        collection_name = Utils.resource_class_to_collection_name(collection_class)
         @client.delete("/#{collection_name}/#{object.id}", {})
         object
       end

data/lib/intercom/api_operations/delete.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'intercom/utils'
+
+module Intercom
+  module ApiOperations
+    module Delete
+      def delete(object)
+        @client.delete("/#{collection_name}/#{object.id}", {})
+        object
+      end
+
+      alias_method 'archive', 'delete'
+    end
+  end
+end

data/lib/intercom/api_operations/find.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/utils'
 
 module Intercom
@@ -5,14 +7,15 @@ module Intercom
     module Find
       def find(params)
         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]
           id = params.delete(:id)
           response = @client.get("/#{collection_name}/#{id}", params)
         else
           response = @client.get("/#{collection_name}", params)
         end
-        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
+        raise Intercom::HttpError, 'Http Error - No response entity returned' unless response
+
         from_api(response)
       end
     end

data/lib/intercom/api_operations/find_all.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require 'intercom/client_collection_proxy'
 require 'intercom/utils'
 
 module Intercom
   module ApiOperations
     module FindAll
-
       def find_all(params)
         raise BadRequestError, "#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)
+
         finder_details = {}
         if params[:id] && !type_switched_finder?(params)
           finder_details[:url] = "/#{collection_name}/#{params[:id]}"
@@ -16,7 +17,7 @@ module Intercom
           finder_details[:url] = "/#{collection_name}"
           finder_details[:params] = params
         end
-        collection_proxy_class.new(collection_name, finder_details: finder_details,  client: @client)
+        collection_proxy_class.new(collection_name, collection_class, details: finder_details, client: @client)
       end
 
       private

data/lib/intercom/api_operations/list.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require 'intercom/client_collection_proxy'
+require 'intercom/base_collection_proxy'
 require 'intercom/utils'
 
 module Intercom
   module ApiOperations
     module List
       def all
-        ClientCollectionProxy.new(Utils.resource_class_to_collection_name(collection_class), client: @client)
+        collection_proxy_class.new(collection_name, collection_class, client: @client)
       end
     end
   end

data/lib/intercom/api_operations/load.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'intercom/utils'
 
 module Intercom
   module ApiOperations
     module Load
       def load(object)
-        collection_name = Utils.resource_class_to_collection_name(collection_class)
         if object.id
           response = @client.get("/#{collection_name}/#{object.id}", {})
         else
           raise "Cannot load #{collection_class} as it does not have a valid id."
         end
-        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
+        raise Intercom::HttpError, 'Http Error - No response entity returned' unless response
+
         object.from_response(response)
       end
     end

data/lib/intercom/api_operations/nested_resource.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Intercom
+  module ApiOperations
+    module NestedResource
+      module ClassMethods
+        def nested_resource_methods(resource,
+                                    path: nil,
+                                    operations: nil,
+                                    resource_plural: nil)
+          resource_plural ||= Utils.pluralize(resource.to_s)
+          path ||= resource_plural
+          raise ArgumentError, 'operations array required' if operations.nil?
+
+          resource_url_method = :"#{resource_plural}_url"
+
+          resource_name = Utils.resource_class_to_collection_name(self)
+
+          define_method(resource_url_method.to_sym) do |id, nested_id = nil|
+            url = "/#{resource_name}/#{id}/#{path}"
+            url += "/#{nested_id}" unless nested_id.nil?
+            url
+          end
+
+          operations.each do |operation|
+            case operation
+            when :create
+              define_method(:"create_#{resource}") do |params|
+                url = send(resource_url_method, self.id)
+                response = client.post(url, params)
+                raise_no_response_error unless response
+                self.class.from_api(response)
+              end
+            when :add
+              define_method(:"add_#{resource}") do |params|
+                url = send(resource_url_method, self.id)
+                response = client.post(url, params)
+                raise_no_response_error unless response
+                self.class.from_api(response)
+              end
+            when :delete
+              define_method(:"remove_#{resource}") do |params|
+                url = send(resource_url_method, self.id, params[:id])
+                response = client.delete(url, params)
+                raise_no_response_error unless response
+                self.class.from_api(response)
+              end
+            when :list
+              define_method(resource_plural.to_sym) do
+                url = send(resource_url_method, self.id)
+                resource_class = Utils.constantize_resource_name(resource.to_s)
+                resource_class.collection_proxy_class.new(resource_plural, resource_class, details: { url: url }, client: client)
+              end
+            else
+              raise ArgumentError, "Unknown operation: #{operation.inspect}"
+            end
+          end
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      private def raise_no_response_error
+        raise Intercom::HttpError, 'Http Error - No response entity returned'
+      end
+    end
+  end
+end

data/lib/intercom/api_operations/save.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/utils'
 require 'ext/sliceable_hash'
 
@@ -8,8 +10,8 @@ module Intercom
       private_constant :PARAMS_NOT_PROVIDED
 
       def create(params = PARAMS_NOT_PROVIDED)
-        if collection_class.ancestors.include?(Intercom::Contact) && params == PARAMS_NOT_PROVIDED
-          params = Hash.new
+        if collection_class.ancestors.include?(Intercom::Lead) && params == PARAMS_NOT_PROVIDED
+          params = {}
         elsif params == PARAMS_NOT_PROVIDED
           raise ArgumentError, '.create requires 1 parameter'
         end
@@ -20,17 +22,17 @@ module Intercom
       end
 
       def save(object)
-        collection_name = Utils.resource_class_to_collection_name(collection_class)
         if id_present?(object) && !posted_updates?(object)
           response = @client.put("/#{collection_name}/#{object.id}", object.to_submittable_hash)
         else
           response = @client.post("/#{collection_name}", object.to_submittable_hash.merge(identity_hash(object)))
         end
+        object.client = @client
         object.from_response(response) if response # may be nil we received back a 202
       end
 
       def identity_hash(object)
-        object.respond_to?(:identity_vars) ? SliceableHash.new(object.to_hash).slice(*(object.identity_vars.map(&:to_s))) : {}
+        object.respond_to?(:identity_vars) ? SliceableHash.new(object.to_hash).slice(*object.identity_vars.map(&:to_s)) : {}
       end
 
       private

data/lib/intercom/api_operations/scroll.rb

@@ -1,17 +1,16 @@
+# frozen_string_literal: true
+
 require 'intercom/scroll_collection_proxy'
 require 'intercom/utils'
 
 module Intercom
   module ApiOperations
     module Scroll
-
-      def scroll()
-        collection_name = Utils.resource_class_to_collection_name(collection_class)
+      def scroll
         finder_details = {}
         finder_details[:url] = "/#{collection_name}"
-        ScrollCollectionProxy.new(collection_name, finder_details: finder_details,  client: @client)
+        ScrollCollectionProxy.new(collection_name, collection_class, details: finder_details, client: @client)
       end
-
     end
   end
 end

data/lib/intercom/api_operations/search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/search_collection_proxy'
 require 'intercom/utils'
 
@@ -5,12 +7,11 @@ 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)
+        SearchCollectionProxy.new(collection_name, collection_class, details: search_details, client: @client)
       end
     end
   end

data/lib/intercom/article.rb

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

data/lib/intercom/base_collection_proxy.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'intercom/utils'
+
+module Intercom
+  class BaseCollectionProxy
+    attr_reader :resource_name, :url, :resource_class
+
+    def initialize(resource_name, resource_class, details: {}, client:, method: 'get')
+      @resource_name = resource_name
+      @resource_class = resource_class
+      @url = (details[:url] || "/#{@resource_name}")
+      @params = (details[:params] || {})
+      @client = client
+      @method = method
+    end
+
+    def each(&block)
+      loop do
+        response_hash = @client.public_send(@method, @url, payload)
+        raise Intercom::HttpError, '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)
+      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 = if resource_name == 'subscriptions'
+                               'items'
+                             else
+                               Utils.entity_key_from_type(top_level_type)
+                             end
+      response_hash[top_level_entity_key].each do |object_json|
+        block.call Lib::TypedJsonDeserializer.new(object_json, @client).deserialize
+      end
+    end
+
+    def has_next_link?(response_hash)
+      paging_info = response_hash.delete('pages')
+      return false unless paging_info
+
+      paging_next = paging_info['next']
+      if paging_next
+        @params[:starting_after] = paging_next['starting_after']
+        return true
+      else
+        @params[:starting_after] = nil
+        return false
+      end
+    end
+
+    def payload
+      payload = {}
+      payload[:per_page] = @params[:per_page] if @params[:per_page]
+      payload[:starting_after] = @params[:starting_after] if @params[:starting_after]
+      payload
+    end
+  end
+end

data/lib/intercom/client.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 module Intercom
   class MisconfiguredClientError < StandardError; end
   class Client
     include Options
-    attr_reader :base_url, :rate_limit_details, :username_part, :password_part, :handle_rate_limit, :timeouts, :api_version
+    include DeprecatedResources
+    attr_reader :base_url, :rate_limit_details, :token, :handle_rate_limit, :timeouts, :api_version
 
     class << self
       def set_base_url(base_url)
-        return Proc.new do |o|
+        proc do |o|
           old_url = o.base_url
           o.send(:base_url=, base_url)
-          Proc.new { |obj| set_base_url(old_url).call(o) }
+          proc { |_obj| set_base_url(old_url).call(o) }
         end
       end
 
       def set_timeouts(open_timeout: nil, read_timeout: nil)
-        return Proc.new do |o|
+        proc do |o|
           old_timeouts = o.timeouts
           timeouts = {}
           timeouts[:open_timeout] = open_timeout if open_timeout
           timeouts[:read_timeout] = read_timeout if read_timeout
           o.send(:timeouts=, timeouts)
-          Proc.new { |obj| set_timeouts(old_timeouts).call(o) }
+          proc { |_obj| set_timeouts(old_timeouts).call(o) }
         end
       end
     end
 
-    def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil, base_url:'https://api.intercom.io', handle_rate_limit: false, api_version: nil)
-      if token
-        @username_part = token
-        @password_part = ""
-      else
-        @username_part = app_id
-        @password_part = api_key
-      end
+    def initialize(token: nil, base_url: 'https://api.intercom.io', handle_rate_limit: false, api_version: nil)
+      @token = token
       validate_credentials!
 
       @api_version = api_version
@@ -51,6 +48,10 @@ module Intercom
       Intercom::Service::Admin.new(self)
     end
 
+    def articles
+      Intercom::Service::Article.new(self)
+    end
+
     def companies
       Intercom::Service::Company.new(self)
     end
@@ -67,10 +68,6 @@ module Intercom
       Intercom::Service::Counts.new(self)
     end
 
-    def customers
-      Intercom::Service::Customer.new(self)
-    end
-
     def events
       Intercom::Service::Event.new(self)
     end
@@ -91,6 +88,10 @@ module Intercom
       Intercom::Service::Segment.new(self)
     end
 
+    def sections
+      Intercom::Service::Section.new(self)
+    end
+
     def tags
       Intercom::Service::Tag.new(self)
     end
@@ -103,6 +104,10 @@ module Intercom
       Intercom::Service::User.new(self)
     end
 
+    def leads
+      Intercom::Service::Lead.new(self)
+    end
+
     def visitors
       Intercom::Service::Visitor.new(self)
     end
@@ -111,6 +116,14 @@ module Intercom
       Intercom::Service::Job.new(self)
     end
 
+    def data_attributes
+      Intercom::Service::DataAttribute.new(self)
+    end
+
+    def collections
+      Intercom::Service::Collection.new(self)
+    end
+
     def get(path, params)
       execute_request Intercom::Request.get(path, params)
     end
@@ -130,25 +143,23 @@ module Intercom
     private
 
     def validate_credentials!
-      error = MisconfiguredClientError.new("app_id and api_key must not be nil")
-      fail error if @username_part.nil?
+      error = MisconfiguredClientError.new('an access token must be provided')
+      raise error if @token.nil?
     end
 
     def validate_api_version!
-      error = MisconfiguredClientError.new("api_version must be either nil or a valid API version")
-      fail error if (@api_version && @api_version != 'Unstable' && Gem::Version.new(@api_version) < Gem::Version.new('1.0'))
+      error = MisconfiguredClientError.new('api_version must be either nil or a valid API version')
+      raise error if @api_version && @api_version != 'Unstable' && Gem::Version.new(@api_version) < Gem::Version.new('1.0')
     end
 
     def execute_request(request)
       request.handle_rate_limit = handle_rate_limit
-      request.execute(@base_url, username: @username_part, secret: @password_part, api_version: @api_version, **timeouts)
+      request.execute(@base_url, token: @token, api_version: @api_version, **timeouts)
     ensure
       @rate_limit_details = request.rate_limit_details
     end
 
-    def base_url=(new_url)
-      @base_url = new_url
-    end
+    attr_writer :base_url
 
     def timeouts=(timeouts)
       @timeouts = @timeouts.merge(timeouts)

data/lib/intercom/client_collection_proxy.rb

@@ -1,71 +1,49 @@
-require "intercom/utils"
+# frozen_string_literal: true
 
-module Intercom
-  class ClientCollectionProxy
-
-    attr_reader :resource_name, :finder_url, :resource_class
-
-    def initialize(resource_name, finder_details: {}, client:)
-      @resource_name = resource_name
-      @resource_class = Utils.constantize_resource_name(resource_name)
-      @finder_url = (finder_details[:url] || "/#{@resource_name}")
-      @finder_params = (finder_details[:params] || {})
-      @client = client
-    end
+require 'intercom/utils'
+require 'intercom/base_collection_proxy'
 
+module Intercom
+  class ClientCollectionProxy < BaseCollectionProxy
     def each(&block)
       next_page = nil
       current_page = nil
       loop do
-        if next_page
-          response_hash = @client.get(next_page, {})
-        else
-          response_hash = @client.get(@finder_url, @finder_params)
-        end
-        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
+        response_hash = fetch(next_page)
+        raise Intercom::HttpError, '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? or (@finder_params[:page] and (current_page  >=  @finder_params[:page]))
+        break if next_page.nil? || (@params[:page] && (current_page >= @params[:page]))
       end
       self
     end
 
-    def [](target_index)
-      self.each_with_index do |item, index|
-        return item if index == target_index
+    def fetch(next_page)
+      if next_page
+        @client.get(next_page, {})
+      else
+        @client.get(@url, @params)
       end
-      nil
     end
 
-    include Enumerable
-
     private
 
-    def deserialize_response_hash(response_hash, block)
-      top_level_type = response_hash.delete('type')
-      if resource_name == 'subscriptions'
-        top_level_entity_key = 'items'
-      else
-        top_level_entity_key = Utils.entity_key_from_type(top_level_type)
-      end
-      response_hash[top_level_entity_key].each do |object_json|
-        block.call Lib::TypedJsonDeserializer.new(object_json).deserialize
-      end
-    end
-
     def paging_info_present?(response_hash)
       !!(response_hash['pages'] && response_hash['pages']['type'])
     end
 
     def extract_next_link(response_hash)
       return nil unless paging_info_present?(response_hash)
+
       paging_info = response_hash.delete('pages')
-      paging_info["next"]
+      paging_info['next']
     end
 
     def extract_current_page(response_hash)
       return nil unless paging_info_present?(response_hash)
+
       response_hash['pages']['page']
     end
   end

data/lib/intercom/collection.rb

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

data/lib/intercom/company.rb

@@ -1,10 +1,18 @@
 require 'intercom/traits/incrementable_attributes'
 require 'intercom/traits/api_resource'
+require 'intercom/api_operations/nested_resource'
 
 module Intercom
   class Company
     include Traits::IncrementableAttributes
     include Traits::ApiResource
+    include ApiOperations::NestedResource
+
+    nested_resource_methods :contact, operations: %i[list]
+
+    def self.collection_proxy_class
+      Intercom::ClientCollectionProxy
+    end
 
     def identity_vars ; [:id, :company_id] ; end
     def flat_store_attributes ; [:custom_attributes] ; end