Release v4.1.0 (#531)

rahulgdsouza · web-flow · commit fae9d35ebcbb · 2020-07-14T18:09:07.000+05:30
* Articles endpoint SDK support * Collections Endpoint Support (#523) * Sections Endpoint Support (#524) * Added Collections endpoint SDK support * Added test coverage * Added dirty_tracking support for nested objects (#525) * Added support to check for equality of two resources (#527) * Updated README and logged changes for v4.1.0 (#526)
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ intercom = Intercom::Client.new(token: 'my_token')
 
 ```ruby
 # With a versioned app:
-intercom = Intercom::Client.new(token: 'my_token', api_version: '2.0')
+intercom = Intercom::Client.new(token: 'my_token', api_version: '2.1')
 ```
 
 If you are building a third party application you can get your access_tokens by [setting-up-oauth](https://developers.intercom.io/page/setting-up-oauth) for Intercom.
@@ -61,6 +61,9 @@ Resources this API supports:
     https://api.intercom.io/counts
     https://api.intercom.io/subscriptions
     https://api.intercom.io/jobs
+    https://api.intercom.io/articles
+    https://api.intercom.io/help_center/collections
+    https://api.intercom.io/help_center/sections
 
 
 ### Examples
@@ -525,6 +528,103 @@ intercom.subscriptions.delete(subscription)
 intercom.subscriptions.all
 ```
 
+#### Articles
+```ruby
+# Create an article
+article = intercom.articles.create(title: "New Article", author_id: "123456")
+
+# Create an article with translations
+article = intercom.articles.create(title: "New Article",
+                                   author_id: "123456",
+                                   translated_content: {fr: {title: "Nouvel Article"}, es: {title: "Nuevo artículo"}})
+
+# Fetch an article
+intercom.articles.find(id: "123456")
+
+# List all articles
+articles = intercom.articles.all
+articles.each { |article| p article.title }
+
+# Update an article
+article.title = "Article Updated!"
+intercom.articles.save(article)
+
+# Update an article's existing translation
+article.translated_content.en.title = "English Updated!"
+intercom.articles.save(article)
+
+# Update an article by adding a new translation
+article.translated_content.es = {title: "Artículo en español"}
+intercom.articles.save(article)
+
+# Delete an article
+intercom.articles.delete(article)
+```
+
+#### Collections
+```ruby
+# Create a collection
+collection = intercom.collections.create(name: "New Collection")
+
+# Create a collection with translations
+collection = intercom.collections.create(name: "New Collection",
+                                         translated_content: {fr: {name: "Nouvelle collection"}, es: {name: "Nueva colección"}})
+
+# Fetch a collection
+intercom.collections.find(id: "123456")
+
+# List all collections
+collections = intercom.collections.all
+collections.each { |collection| p collection.name }
+
+# Update a collection
+collection.name = "Collection updated!"
+intercom.collections.save(collection)
+
+# Update a collection's existing translation
+collection.translated_content.en.name = "English Updated!"
+intercom.collections.save(collection)
+
+# Update a collection by adding a new translation
+collection.translated_content.es = {name: "Colección en español", description: "Descripción en español"}
+intercom.collections.save(collection)
+
+# Delete an collection
+intercom.collections.delete(collection)
+```
+
+#### Sections
+```ruby
+# Create a section
+section = intercom.sections.create(name: "New Section", parent_id: "123456")
+
+# Create a section with translations
+section = intercom.sections.create(name: "New Section",
+                                   translated_content: {fr: {name: "Nouvelle section"}, es: {name: "Nueva sección"}})
+
+# Fetch a section
+intercom.sections.find(id: "123456")
+
+# List all sections
+sections = intercom.sections.all
+sections.each { |section| p section.name }
+
+# Update a section
+section.name = "Section updated!"
+intercom.sections.save(section)
+
+# Update a section's existing translation
+section.translated_content.en.name = "English Updated!"
+intercom.collections.save(section)
+
+# Update a section by adding a new translation
+section.translated_content.es = {name: "Sección en español"}
+intercom.collections.save(section)
+
+# Delete an section
+intercom.sections.delete(section)
+```
+
 ### Errors
 
 There are different styles for error handling - some people prefer exceptions; some prefer nil and check; some prefer error objects/codes. Balancing these preferences alongside our wish to provide an idiomatic gem has brought us to use the current mechanism of throwing specific exceptions. Our approach in the client is to propagate errors and signal our failure loudly so that erroneous data does not get propagated through our customers' systems - in other words, if you see a `Intercom::ServiceUnavailableError` you know where the problem is.
diff --git a/lib/intercom.rb b/lib/intercom.rb
@@ -2,6 +2,8 @@
 
 require 'intercom/version'
 require 'intercom/service/admin'
+require 'intercom/service/article'
+require 'intercom/service/collection'
 require 'intercom/service/company'
 require 'intercom/service/contact'
 require 'intercom/service/conversation'
@@ -12,6 +14,7 @@
 require 'intercom/service/job'
 require 'intercom/service/subscription'
 require 'intercom/service/segment'
+require 'intercom/service/section'
 require 'intercom/service/tag'
 require 'intercom/service/team'
 require 'intercom/service/visitor'
@@ -24,16 +27,19 @@
 require 'intercom/user'
 require 'intercom/lead'
 require 'intercom/count'
+require 'intercom/collection'
 require 'intercom/company'
 require 'intercom/service/data_attribute'
 require 'intercom/note'
 require 'intercom/job'
 require 'intercom/tag'
 require 'intercom/segment'
+require 'intercom/section'
 require 'intercom/event'
 require 'intercom/conversation'
 require 'intercom/message'
 require 'intercom/admin'
+require 'intercom/article'
 require 'intercom/request'
 require 'intercom/subscription'
 require 'intercom/team'
diff --git a/lib/intercom/article.rb b/lib/intercom/article.rb
@@ -0,0 +1,7 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Article
+    include Traits::ApiResource
+  end
+end
diff --git a/lib/intercom/client.rb b/lib/intercom/client.rb
@@ -48,6 +48,10 @@ def admins
       Intercom::Service::Admin.new(self)
     end
 
+    def articles
+      Intercom::Service::Article.new(self)
+    end
+
     def companies
       Intercom::Service::Company.new(self)
     end
@@ -84,6 +88,10 @@ def segments
       Intercom::Service::Segment.new(self)
     end
 
+    def sections
+      Intercom::Service::Section.new(self)
+    end
+
     def tags
       Intercom::Service::Tag.new(self)
     end
@@ -108,6 +116,10 @@ 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
diff --git a/lib/intercom/collection.rb b/lib/intercom/collection.rb
@@ -0,0 +1,7 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Collection
+    include Traits::ApiResource
+  end
+end
diff --git a/lib/intercom/section.rb b/lib/intercom/section.rb
@@ -0,0 +1,23 @@
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/save'
+require 'intercom/api_operations/delete'
+
+module Intercom
+  module Service
+    class Section < BaseService
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::Save
+      include ApiOperations::Delete
+
+      def collection_class
+        Intercom::Section
+      end
+
+      def collection_name
+        'help_center/sections'
+      end
+    end
+  end
+end
diff --git a/lib/intercom/service/article.rb b/lib/intercom/service/article.rb
@@ -0,0 +1,20 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/delete'
+require 'intercom/api_operations/save'
+
+module Intercom
+  module Service
+    class Article < BaseService
+      include ApiOperations::Find
+      include ApiOperations::List
+      include ApiOperations::Delete
+      include ApiOperations::Save
+
+      def collection_class
+        Intercom::Article
+      end
+    end
+  end
+end
diff --git a/lib/intercom/service/collection.rb b/lib/intercom/service/collection.rb
@@ -0,0 +1,24 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/delete'
+require 'intercom/api_operations/save'
+
+module Intercom
+  module Service
+    class Collection < BaseService
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::Delete
+      include ApiOperations::Save
+
+      def collection_class
+        Intercom::Collection
+      end
+
+      def collection_name
+        "help_center/collections"
+      end
+    end
+  end
+end
diff --git a/lib/intercom/service/section.rb b/lib/intercom/service/section.rb
@@ -0,0 +1,7 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Section
+    include Traits::ApiResource
+  end
+end
diff --git a/lib/intercom/traits/api_resource.rb b/lib/intercom/traits/api_resource.rb
@@ -17,6 +17,10 @@ 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!
@@ -37,10 +41,21 @@ def to_hash
         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
diff --git a/lib/intercom/traits/dirty_tracking.rb b/lib/intercom/traits/dirty_tracking.rb
@@ -22,7 +22,14 @@ def mark_field_as_changed!(field_name)
 
       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
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
diff --git a/spec/unit/intercom/article_spec.rb b/spec/unit/intercom/article_spec.rb
diff --git a/spec/unit/intercom/collection_spec.rb b/spec/unit/intercom/collection_spec.rb
diff --git a/spec/unit/intercom/section_spec.rb b/spec/unit/intercom/section_spec.rb
diff --git a/spec/unit/intercom/traits/api_resource_spec.rb b/spec/unit/intercom/traits/api_resource_spec.rb
