intercom 3.9.4 → 4.1.1

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 && 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

data/lib/intercom/contact.rb

@@ -1,11 +1,29 @@
+# frozen_string_literal: true
+
+require 'intercom/traits/incrementable_attributes'
 require 'intercom/traits/api_resource'
+require 'intercom/api_operations/nested_resource'
 
 module Intercom
   class Contact
+    include Traits::IncrementableAttributes
     include Traits::ApiResource
+    include ApiOperations::NestedResource
+
+    nested_resource_methods :tag, operations: %i[add delete list]
+    nested_resource_methods :note, operations: %i[create list]
+    nested_resource_methods :company, operations: %i[add delete list]
+
+    def self.collection_proxy_class
+      Intercom::BaseCollectionProxy
+    end
+
+    def identity_vars
+      [:id]
+    end
 
-    def identity_vars ; [:email, :user_id] ; end
-    def flat_store_attributes ; [:custom_attributes] ; end
-    def update_verb; 'put' ; end
+    def flat_store_attributes
+      [:custom_attributes]
+    end
   end
 end

data/lib/intercom/conversation.rb

@@ -1,7 +1,12 @@
 require 'intercom/traits/api_resource'
+require 'intercom/api_operations/nested_resource'
 
 module Intercom
   class Conversation
     include Traits::ApiResource
+    include ApiOperations::NestedResource
+
+    nested_resource_methods :tag, operations: %i[add delete]
+    nested_resource_methods :contact, operations: %i[add delete], path: :customers
   end
 end

data/lib/intercom/data_attribute.rb

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

data/lib/intercom/deprecated_leads_collection_proxy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Intercom
+  class DeprecatedLeadsCollectionProxy < ClientCollectionProxy
+    def fetch(next_page)
+      response_hash = if next_page
+                        @client.get(next_page, {})
+                      else
+                        @client.get(@url, @params)
+                      end
+      transform(response_hash)
+    end
+
+    def transform(response_hash)
+      response_hash['type'] = 'lead.list'
+      leads_list = response_hash.delete('contacts')
+      leads_list.each { |lead| lead['type'] = 'lead' }
+      response_hash['leads'] = leads_list
+      response_hash
+    end
+  end
+end

data/lib/intercom/deprecated_resources.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Intercom
+  module DeprecatedResources
+    def deprecated__leads
+      Intercom::Service::Lead.new(self)
+    end
+
+    def deprecated__users
+      Intercom::Service::User.new(self)
+    end
+  end
+end

data/lib/intercom/errors.rb

@@ -96,6 +96,9 @@ module Intercom
   # Raised when a CDA is invalid
   class InvalidDocumentError < IntercomError; end
 
+  # Raised when a merge is invalid
+  class InvalidMergeError < IntercomError; end
+
   #
   # Non-public errors (internal to the gem)
   #

data/lib/intercom/extended_api_operations/segments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/client_collection_proxy'
 require 'intercom/utils'
 
@@ -6,7 +8,7 @@ module Intercom
     module Segments
       def by_segment(id)
         collection_name = Utils.resource_class_to_collection_name(collection_class)
-        ClientCollectionProxy.new(collection_name, finder_details: {url: "/#{collection_name}?segment_id=#{id}"}, client: @client)
+        ClientCollectionProxy.new(collection_name, collection_class, details: { url: "/#{collection_name}?segment_id=#{id}" }, client: @client)
       end
     end
   end

data/lib/intercom/extended_api_operations/tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/client_collection_proxy'
 require 'intercom/utils'
 
@@ -6,7 +8,7 @@ module Intercom
     module Tags
       def by_tag(id)
         collection_name = Utils.resource_class_to_collection_name(collection_class)
-        ClientCollectionProxy.new(collection_name, finder_details: {url: "/#{collection_name}?tag_id=#{id}"}, client: @client)
+        ClientCollectionProxy.new(collection_name, collection_class, details: { url: "/#{collection_name}?tag_id=#{id}" }, client: @client)
       end
     end
   end

data/lib/intercom/lead.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Lead
+    include Traits::ApiResource
+
+    def identity_vars
+      %i[email user_id]
+    end
+
+    def flat_store_attributes
+      [:custom_attributes]
+    end
+
+    def update_verb
+      'put'
+    end
+  end
+end

data/lib/intercom/lib/typed_json_deserializer.rb

@@ -1,54 +1,59 @@
+# frozen_string_literal: true
+
 require 'intercom/utils'
 
 module Intercom
   module Lib
-      # Responsibility: To decide whether we are deserializing a collection or an
-      # entity of a particular type and to dispatch deserialization
-      class TypedJsonDeserializer
-        attr_reader :json
-
-        def initialize(json)
-          @json = json
-        end
+    # Responsibility: To decide whether we are deserializing a collection or an
+    # entity of a particular type and to dispatch deserialization
+    class TypedJsonDeserializer
+      attr_reader :json
+
+      def initialize(json, client)
+        @json = json
+        @client = client
+      end
 
-        def deserialize
-          if blank_object_type?(object_type)
-            raise DeserializationError, "No type field was found to facilitate deserialization"
-          elsif list_object_type?(object_type)
-            deserialize_collection(json[object_entity_key])
-          else # singular object type
-            deserialize_object(json)
-          end
+      def deserialize
+        if blank_object_type?(object_type)
+          raise DeserializationError, 'No type field was found to facilitate deserialization'
+        elsif list_object_type?(object_type)
+          deserialize_collection(json[object_entity_key])
+        else # singular object type
+          deserialize_object(json)
         end
+      end
 
-        private
+      private
 
-        def blank_object_type?(object_type)
-          object_type.nil? || object_type == ''
-        end
+      def blank_object_type?(object_type)
+        object_type.nil? || object_type == ''
+      end
 
-        def list_object_type?(object_type)
-          object_type.end_with?('.list')
-        end
+      def list_object_type?(object_type)
+        object_type.end_with?('.list')
+      end
 
-        def deserialize_collection(collection_json)
-          return [] if collection_json == nil
-          collection_json.map { |item_json| TypedJsonDeserializer.new(item_json).deserialize }
-        end
+      def deserialize_collection(collection_json)
+        return [] if collection_json.nil?
 
-        def deserialize_object(object_json)
-          entity_class = Utils.constantize_singular_resource_name(object_entity_key)
-          entity_class.from_api(object_json)
-        end
+        collection_json.map { |item_json| TypedJsonDeserializer.new(item_json, @client).deserialize }
+      end
 
-        def object_type
-          @object_type ||= json['type']
-        end
+      def deserialize_object(object_json)
+        entity_class = Utils.constantize_singular_resource_name(object_entity_key)
+        deserialized = entity_class.from_api(object_json)
+        deserialized.client = @client
+        deserialized
+      end
 
-        def object_entity_key
-          @object_entity_key ||= Utils.entity_key_from_type(object_type)
-        end
+      def object_type
+        @object_type ||= json['type']
+      end
 
+      def object_entity_key
+        @object_entity_key ||= Utils.entity_key_from_type(object_type)
       end
+    end
   end
 end