intercom 3.5.10 → 4.1.2

data/RELEASING.md

@@ -0,0 +1,9 @@
+# Releasing Intercom
+
+We use https://github.com/svenfuchs/gem-release to tag, bump, and release new versions
+
+Please add a line to changes.txt before you release a new version.
+
+```
+gem bump --tag --release
+```

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,144 @@
+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
+
+3.9.3
+Fix regression added in 3.9.2
+
+3.9.2
+Added error handling for malformed responses
+
+3.9.1
+Version skipped in error
+
+3.9.0
+Added Teams endpoint functionality
+
+3.8.1
+Added error handling for company_not_found
+
+3.8.0
+Add support for Customer Search (currently in Unstable API Version)
+https://developers.intercom.com/intercom-api-reference/v0/reference#customers
+
+3.7.7
+Remove deprecated features from Gemspec
+
+3.7.6
+Added error handling for invalid_document error state
+
+3.7.5
+Added error handling for scroll_exists error state
+
+3.7.4
+Added support for API versioning via
+Intercom::Client.new(token: "token", api_version "1.1")
+
+3.7.3
+Added error handling for when an admin cannot be found.
+
+3.7.2
+Added error handling for when an app's custom attribute limits have been reached.
+
+3.7.1
+Extra version bump after faulty previous bump
+
+3.7.0
+Providing the ability to hard delete users as described here:
+https://developers.intercom.com/intercom-api-reference/reference#archive-a-user
+
+This chaged the previous delete action to an archive action and added a new hard delete option
+You can still use the delete method but it will archive a user, we added an alias for delete.
+#442 archiving alias
+#410 add ability to hard delete users
+
+Alos enabling reply to last from the SDK
+#443 Residently conversations last reply
+
+3.6.2
+#384 Add ability to snooze conversation
+You can now snooze conversations in your app via:
+intercom.conversations.snooze(...)
+
+3.6.1
+#430 Allow all conversations to be listed
+You can now iterate over all conversations for your app via:
+intercom.conversations.all.each { |convo| ... }
+
+3.6.0
+BREAKING CHANGE companies
+We updated companies to be able to list users via company_id as well as id (#428 )
+Note that this is a breaking change as we had to remove the old way of listing users via company.
+
+Previously it was:
+intercom.companies.users(company.id)
+
+Now you get a list of users in a company by Intercom Company ID
+intercom.companies.users_by_intercom_company_id(company.id)
+
+Now you get a list of users in a company by external company_id
+intercom.companies.users_by_company_id(company.company_id)
+
+Rate limit handling
+We also improved the way we handle rate limits in PR #409 which was related to issue #405
+
+3.5.23
+ - New type of error (ResourceNotUniqueError). Thrown when trying to create a resource that already exists in Intercom
+
+3.5.22
+ - Return object type
+
+3.5.21
+ - Fix for PR-353 which addressed "NoMethodError in intercom/request"
+ - There were issues on older versions of Ruby (<2.3)
+ - This PR does not use lonely operator and instead simple checks for nil parsed_body
+
+3.5.17
+ - Fix BlockedUserError typo
+
+3.5.16
+ - Standardize comparison of attribute as string when input is Hash or JSON
+
+3.5.15
+- UnauthorizedError on invalid token
+- BlockerUserError on restoring blocked user
+
+3.5.14
+- Rate Limit Exception (@jaimeiniesta)
+
+3.5.12
+- Use base_url in initialize parameter
+
+3.5.11
+- Add scroll api for companies
+
+3.5.10
+  - Add Support for find_all events pagination (@jkeyes)
+
 3.5.9
  - Fix event create method
 

data/intercom.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |spec|
   spec.summary     = %q{Ruby bindings for the Intercom API}
   spec.description = %Q{Intercom (https://www.intercom.io) is a customer relationship management and messaging tool for web app owners. This library wraps the api provided by Intercom. See http://docs.intercom.io/api for more details. }
   spec.license     = "MIT"
-  spec.rubyforge_project = "intercom"
 
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -20,12 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'minitest', '~> 5.4'
+  spec.add_development_dependency "m", "~> 1.5.0"
   spec.add_development_dependency 'rake', '~> 10.3'
   spec.add_development_dependency 'mocha', '~> 1.0'
   spec.add_development_dependency "fakeweb", ["~> 1.3"]
   spec.add_development_dependency "pry"
 
-  spec.add_dependency 'json', '>= 1.8'
   spec.required_ruby_version = '>= 2.1.0'
   spec.add_development_dependency 'gem-release'
 end

data/lib/intercom.rb

@@ -1,5 +1,9 @@
-require "intercom/version"
+# frozen_string_literal: true
+
+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'
@@ -10,28 +14,39 @@ require 'intercom/service/note'
 require 'intercom/service/job'
 require 'intercom/service/subscription'
 require 'intercom/service/segment'
+require 'intercom/service/section'
 require 'intercom/service/tag'
-require 'intercom/service/user'
+require 'intercom/service/team'
 require 'intercom/service/visitor'
+require 'intercom/service/user'
+require 'intercom/service/lead'
+require 'intercom/deprecated_resources.rb'
 require 'intercom/options'
 require 'intercom/client'
-require "intercom/contact"
-require "intercom/count"
-require "intercom/user"
-require "intercom/company"
-require "intercom/note"
-require "intercom/job"
-require "intercom/tag"
-require "intercom/segment"
-require "intercom/event"
-require "intercom/conversation"
-require "intercom/message"
-require "intercom/admin"
-require "intercom/request"
-require "intercom/subscription"
-require "intercom/errors"
-require "intercom/visitor"
-require "json"
+require 'intercom/contact'
+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'
+require 'intercom/errors'
+require 'intercom/visitor'
+require 'intercom/data_attribute'
+require 'json'
 
 ##
 # Intercom is a customer relationship management and messaging tool for web app owners

data/lib/intercom/api_operations/archive.rb

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

data/lib/intercom/api_operations/delete.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 require 'intercom/utils'
 
 module Intercom
   module ApiOperations
     module Delete
       def delete(object)
-        collection_name = Utils.resource_class_to_collection_name(collection_class)
         @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
-        ClientCollectionProxy.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