intercom 3.5.10 → 4.1.2

data/lib/intercom/service/lead.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'intercom/service/base_service'
+require 'intercom/api_operations/load'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
+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/archive'
+require 'intercom/api_operations/request_hard_delete'
+require 'intercom/deprecated_leads_collection_proxy'
+
+module Intercom
+  module Service
+    class Lead < BaseService
+      include ApiOperations::Load
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::FindAll
+      include ApiOperations::Save
+      include ApiOperations::Scroll
+      include ApiOperations::Convert
+      include ApiOperations::Archive
+      include ApiOperations::RequestHardDelete
+
+      def collection_proxy_class
+        Intercom::DeprecatedLeadsCollectionProxy
+      end
+
+      def collection_class
+        Intercom::Lead
+      end
+
+      def collection_name
+        'contacts'
+      end
+    end
+  end
+end

data/lib/intercom/service/note.rb

@@ -1,22 +1,18 @@
 require 'intercom/service/base_service'
-require 'intercom/api_operations/list'
-require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/find'
-require 'intercom/api_operations/load'
-require 'intercom/api_operations/save'
 
 module Intercom
   module Service
     class Note < BaseService
-      include ApiOperations::Save
-      include ApiOperations::List
-      include ApiOperations::FindAll
       include ApiOperations::Find
-      include ApiOperations::Load
 
       def collection_class
         Intercom::Note
       end
+
+      def collection_proxy_class
+        Intercom::BaseCollectionProxy
+      end
     end
   end
 end

data/lib/intercom/service/section.rb

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

data/lib/intercom/service/tag.rb

@@ -2,6 +2,7 @@ require 'intercom/service/base_service'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/list'
 require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/find'
 
 module Intercom
   module Service
@@ -10,11 +11,16 @@ module Intercom
       include ApiOperations::List
       include ApiOperations::FindAll
       include ApiOperations::Delete
+      include ApiOperations::Find
 
       def collection_class
         Intercom::Tag
       end
 
+      def collection_proxy_class
+        Intercom::BaseCollectionProxy
+      end
+
       def tag(params)
         params['tag_or_untag'] = 'tag'
         create(params)
@@ -22,17 +28,11 @@ module Intercom
 
       def untag(params)
         params['tag_or_untag'] = 'untag'
-        users_or_companies(params).each do |user_or_company|
-          user_or_company[:untag] = true
+        params[:companies].each do |company|
+          company[:untag] = true
         end
         create(params)
       end
-
-      private
-
-      def users_or_companies(params)
-        params[:users] || params[:companies]
-      end
     end
   end
 end

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

@@ -1,26 +1,35 @@
 require 'intercom/service/base_service'
 require 'intercom/api_operations/load'
-require 'intercom/api_operations/list'
 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'
 
 module Intercom
   module Service
     class Visitor < BaseService
       include ApiOperations::Load
-      include ApiOperations::List
       include ApiOperations::Find
-      include ApiOperations::FindAll
       include ApiOperations::Save
-      include ApiOperations::Convert
       include ApiOperations::Delete
 
       def collection_class
         Intercom::Visitor
       end
+
+      def convert(visitor, contact = false)
+        req = { visitor: { user_id: visitor.user_id } }
+        if contact
+          req[:user] = identity_hash(contact)
+          req[:type] = 'user'
+        else
+          req[:type] = 'lead'
+        end
+        Intercom::Contact.new.from_response(
+          @client.post(
+            "/visitors/convert", req
+          )
+        )
+      end
     end
   end
 end

data/lib/intercom/tag.rb

@@ -3,5 +3,9 @@ require 'intercom/traits/api_resource'
 module Intercom
   class Tag
     include Traits::ApiResource
+
+    def self.collection_proxy_class
+      Intercom::BaseCollectionProxy
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/lib/flat_store'
 require 'intercom/lib/dynamic_accessors'
 require 'intercom/lib/dynamic_accessors_on_method_missing'
@@ -6,16 +8,19 @@ require 'intercom/lib/typed_json_deserializer'
 
 module Intercom
   module Traits
-
     module ApiResource
       include DirtyTracking
 
-      attr_accessor :id
+      attr_accessor :id, :client
 
       def initialize(attributes = {})
         from_hash(attributes)
       end
 
+      def ==(other)
+        self.class == other.class && to_json == other.to_json
+      end
+
       def from_response(response)
         from_hash(response)
         reset_changed_fields!
@@ -24,7 +29,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
@@ -32,59 +36,81 @@ module Intercom
       end
 
       def to_hash
-        instance_variables_excluding_dirty_tracking_field.inject({}) do |hash, variable|
-          hash[variable.to_s.delete("@")] = instance_variable_get(variable)
-          hash
+        instance_variables_excluding_dirty_tracking_field.each_with_object({}) do |variable, hash|
+          hash[variable.to_s.delete('@')] = instance_variable_get(variable)
+        end
+      end
+
+      def to_json(*args)
+        instance_variables_excluding_dirty_tracking_field.each_with_object({}) do |variable, hash|
+          next if variable == :@client
+
+          value = instance_variable_get(variable)
+          hash[variable.to_s.delete('@')] = value.respond_to?(:to_json) ? value.to_json(*args) : value
         end
       end
 
       def to_submittable_hash
         submittable_hash = {}
         to_hash.each do |attribute, value|
-          submittable_hash[attribute] = value if submittable_attribute?(attribute, value)
+          next unless submittable_attribute?(attribute, value)
+
+          submittable_hash[attribute] = value.respond_to?(:to_submittable_hash) ? value.to_submittable_hash : value
         end
         submittable_hash
       end
 
       def method_missing(method_sym, *arguments, &block)
-        Lib::DynamicAccessorsOnMethodMissing.new(method_sym, *arguments, self).
-          define_accessors_or_call { super }
+        Lib::DynamicAccessorsOnMethodMissing.new(method_sym, *arguments, self)
+                                            .define_accessors_or_call { super }
       end
 
       def flat_store_attribute?(attribute)
-        (respond_to?(:flat_store_attributes)) && (flat_store_attributes.map(&:to_s).include?(attribute.to_s))
+        respond_to?(:flat_store_attributes) && flat_store_attributes.map(&:to_s).include?(attribute.to_s)
       end
 
       private
 
       def initialize_property(attribute, value)
+        return if addressable_list?(attribute, value)
+
         Lib::DynamicAccessors.define_accessors(attribute, value, self) unless accessors_already_defined?(attribute)
         set_property(attribute, value)
       end
 
+      def addressable_list?(attribute, value)
+        return false unless typed_property?(attribute, value)
+
+        value['type'] == 'list' && value['url']
+      end
+
       def accessors_already_defined?(attribute)
         respond_to?(attribute) && respond_to?("#{attribute}=")
       end
 
       def set_property(attribute, value)
+        value_to_set = parsed_value_for_attribute(attribute, value)
+        call_setter_for_attribute(attribute, value_to_set)
+      end
+
+      def parsed_value_for_attribute(attribute, value)
         if typed_property?(attribute, value)
-          value_to_set = Intercom::Lib::TypedJsonDeserializer.new(value).deserialize
+          Intercom::Lib::TypedJsonDeserializer.new(value, client).deserialize
         elsif flat_store_attribute?(attribute)
-          value_to_set = Intercom::Lib::FlatStore.new(value)
+          Intercom::Lib::FlatStore.new(value)
         else
-          value_to_set = value
+          value
         end
-        call_setter_for_attribute(attribute, value_to_set)
       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,20 +120,16 @@ 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)
-        value.is_a? Hash and !!value['type']
+        value.is_a?(Hash) && !!value['type']
       end
 
       def call_setter_for_attribute(attribute, value)
-        setter_method = "#{attribute.to_s}="
-        self.send(setter_method, value)
-      end
-
-      def type_field?(attribute)
-        attribute == 'type'
+        setter_method = "#{attribute}="
+        send(setter_method, value)
       end
 
       def initialize_missing_flat_store_attributes
@@ -125,7 +147,7 @@ module Intercom
 
       module ClassMethods
         def from_api(api_response)
-          object = self.new
+          object = new
           object.from_response(api_response)
           object
         end
@@ -134,7 +156,6 @@ module Intercom
       def self.included(base)
         base.extend(ClassMethods)
       end
-
     end
   end
 end

data/lib/intercom/traits/dirty_tracking.rb

@@ -22,7 +22,14 @@ module Intercom
 
       def field_changed?(field_name)
         @changed_fields ||= Set.new
-        @changed_fields.include?(field_name.to_s)
+        field = instance_variable_get("@#{field_name}")
+        if field.respond_to?(:field_changed?)
+          field.to_hash.any? do |attribute, _|
+            field.field_changed?(attribute)
+          end
+        else
+          @changed_fields.include?(field_name.to_s)
+        end
       end
 
       def instance_variables_excluding_dirty_tracking_field

data/lib/intercom/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'intercom/traits/incrementable_attributes'
 require 'intercom/traits/api_resource'
 
@@ -6,9 +8,16 @@ module Intercom
     include Traits::IncrementableAttributes
     include Traits::ApiResource
 
-    def identity_vars ; [:id, :email, :user_id] ; end
-    def flat_store_attributes ; [:custom_attributes] ; end
-    def update_verb ; 'post' ; end
+    def identity_vars
+      %i[id email user_id]
+    end
+
+    def flat_store_attributes
+      [:custom_attributes]
+    end
 
+    def update_verb
+      'post'
+    end
   end
 end

data/lib/intercom/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Intercom
   module Utils
     class << self
@@ -7,6 +9,7 @@ module Intercom
 
       def pluralize(str)
         return str.gsub(/y$/, 'ies') if str =~ /y$/
+
         "#{str}s"
       end
 
@@ -23,7 +26,13 @@ module Intercom
       end
 
       def resource_class_to_singular_name(resource_class)
-        resource_class.to_s.split('::')[-1].downcase
+        resource_name = resource_class.to_s.split('::')[-1]
+        resource_name = maybe_underscore_name(resource_name)
+        resource_name.downcase
+      end
+
+      def maybe_underscore_name(resource_name)
+        resource_name.gsub!(/(.)([A-Z])/, '\1_\2') || resource_name
       end
 
       def resource_class_to_collection_name(resource_class)
@@ -52,9 +61,11 @@ module Intercom
       end
 
       def entity_key_from_type(type)
+        return 'data' if type == 'list'
+
         is_list = type.split('.')[1] == 'list'
         entity_name = type.split('.')[0]
-        is_list ?  Utils.pluralize(entity_name) : entity_name
+        is_list ? Utils.pluralize(entity_name) : entity_name
       end
     end
   end