intercom 2.5.4 → 3.0.0b1

data/lib/intercom/admin.rb

@@ -1,9 +1,7 @@
-require 'intercom/api_operations/list'
 require 'intercom/traits/api_resource'
 
 module Intercom
   class Admin
-    include ApiOperations::List
     include Traits::ApiResource
   end
 end

data/lib/intercom/api_operations/convert.rb

@@ -3,13 +3,13 @@ require 'intercom/traits/api_resource'
 module Intercom
   module ApiOperations
     module Convert
-      def convert(user)
-        from_response(
-          Intercom.post(
+      def convert(contact, user)
+        Intercom::User.new.from_response(
+          @client.post(
             "/contacts/convert",
             {
-              contact: { user_id: user_id },
-              user: user.identity_hash
+              contact: { user_id: contact.user_id },
+              user: identity_hash(user)
             }
           )
         )

data/lib/intercom/api_operations/delete.rb

@@ -3,13 +3,11 @@ require 'intercom/traits/api_resource'
 module Intercom
   module ApiOperations
     module Delete
-
-      def delete
-        collection_name = Utils.resource_class_to_collection_name(self.class)
-        Intercom.delete("/#{collection_name}/#{id}", {})
-        self
+      def delete(object)
+        collection_name = Utils.resource_class_to_collection_name(collection_class)
+        @client.delete("/#{collection_name}/#{object.id}", {})
+        object
       end
-
     end
   end
 end

data/lib/intercom/api_operations/find.rb

@@ -1,22 +1,16 @@
 module Intercom
   module ApiOperations
     module Find
-      module ClassMethods
-        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(self)
-          if params[:id]
-            response = Intercom.get("/#{collection_name}/#{params[:id]}", {})
-          else
-            response = Intercom.get("/#{collection_name}", params)
-          end
-          raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
-          from_api(response)
+      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]
+          response = @client.get("/#{collection_name}/#{params[:id]}", {})
+        else
+          response = @client.get("/#{collection_name}", params)
         end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
+        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
+        from_api(response)
       end
     end
   end

data/lib/intercom/api_operations/find_all.rb

@@ -1,32 +1,27 @@
-require 'intercom/collection_proxy'
+require 'intercom/client_collection_proxy'
 
 module Intercom
   module ApiOperations
     module FindAll
-      module ClassMethods
-        def find_all(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(self)
-          finder_details = {}
-          if params[:id] && !type_switched_finder?(params)
-            finder_details[:url] = "/#{collection_name}/#{params[:id]}"
-            finder_details[:params] = {}
-          else
-            finder_details[:url] = "/#{collection_name}"
-            finder_details[:params] = params
-          end
-          CollectionProxy.new(collection_name, finder_details)
-        end
-
-        private
 
-        def type_switched_finder?(params)
-          params.include?(:type)
+      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]}"
+          finder_details[:params] = {}
+        else
+          finder_details[:url] = "/#{collection_name}"
+          finder_details[:params] = params
         end
+        ClientCollectionProxy.new(collection_name, finder_details: finder_details,  client: @client)
       end
 
-      def self.included(base)
-        base.extend(ClassMethods)
+      private
+
+      def type_switched_finder?(params)
+        params.include?(:type)
       end
     end
   end

data/lib/intercom/api_operations/list.rb

@@ -1,16 +1,10 @@
-require 'intercom/collection_proxy'
+require 'intercom/client_collection_proxy'
 
 module Intercom
   module ApiOperations
-    module List # TODO: Should we rename to All
-      module ClassMethods
-        def all
-          CollectionProxy.new(Utils.resource_class_to_collection_name(self))
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
+    module List
+      def all
+        ClientCollectionProxy.new(Utils.resource_class_to_collection_name(collection_class), client: @client)
       end
     end
   end

data/lib/intercom/api_operations/load.rb

@@ -1,15 +1,15 @@
 module Intercom
   module ApiOperations
     module Load
-      def load
-        collection_name = Utils.resource_class_to_collection_name(self.class)
-        if id
-          response = Intercom.get("/#{collection_name}/#{id}", {})
+      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 #{self.class} as it does not have a valid id."
+          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
-        from_response(response)
+        object.from_response(response)
       end
     end
   end

data/lib/intercom/api_operations/save.rb

@@ -3,48 +3,43 @@ require 'intercom/traits/api_resource'
 module Intercom
   module ApiOperations
     module Save
-
-      module ClassMethods
-        PARAMS_NOT_PROVIDED = Object.new
-        def create(params = PARAMS_NOT_PROVIDED)
-          if self.ancestors.include?(Intercom::Contact) && params == PARAMS_NOT_PROVIDED
-            params = Hash.new
-          elsif params == PARAMS_NOT_PROVIDED
-            raise ArgumentError, '.create requires 1 parameter'
-          end
-
-          instance = self.new(params)
-          instance.mark_fields_as_changed!(params.keys)
-          instance.save
+      PARAMS_NOT_PROVIDED = Object.new
+      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
+        elsif params == PARAMS_NOT_PROVIDED
+          raise ArgumentError, '.create requires 1 parameter'
         end
-      end
 
-      def self.included(base)
-        base.extend(ClassMethods)
+        instance = collection_class.new(params)
+        instance.mark_fields_as_changed!(params.keys)
+        save(instance)
       end
 
-      def save
-        collection_name = Utils.resource_class_to_collection_name(self.class)
-        if id_present? && !posted_updates?
-          response = Intercom.put("/#{collection_name}/#{id}", to_submittable_hash)
+      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}/#{id}", object.to_submittable_hash)
         else
-          response = Intercom.post("/#{collection_name}", to_submittable_hash.merge(identity_hash))
+          response = @client.post("/#{collection_name}", object.to_submittable_hash.merge(identity_hash(object)))
         end
-        from_response(response) if response # may be nil we received back a 202
+        object.from_response(response) if response # may be nil we received back a 202
       end
 
-      def identity_hash
-        respond_to?(:identity_vars) ? SliceableHash.new(to_hash).slice(*(identity_vars.map(&:to_s))) : {}
+      def identity_hash(object)
+        object.respond_to?(:identity_vars) ? SliceableHash.new(object.to_hash).slice(*(object.identity_vars.map(&:to_s))) : {}
       end
 
       private
 
-      def id_present?
-        id && id.to_s != ''
+      def id_present?(object)
+        object.id && object.id.to_s != ''
       end
 
-      def posted_updates?
-        respond_to?(:update_verb) && update_verb == 'post'
+      def posted_updates?(object)
+        object.respond_to?(:update_verb) && object.update_verb == 'post'
       end
     end
   end

data/lib/intercom/client.rb

@@ -0,0 +1,95 @@
+module Intercom
+  class Client
+    include Options
+    attr_reader :base_url, :rate_limit_details
+
+    class << self
+      def set_base_url(base_url)
+        return Proc.new do |o|
+          old_url = o.base_url
+          o.send(:base_url=, base_url)
+          Proc.new { |obj| set_base_url(old_url).call(o) }
+        end
+      end
+    end
+
+    def initialize(app_id: 'my_app_id', api_key: 'my_api_key')
+      @app_id = app_id
+      @api_key = api_key
+      @base_url = 'https://api.intercom.io'
+      @rate_limit_details = {}
+    end
+
+    def admins
+      Intercom::Service::Admin.new(self)
+    end
+
+    def companies
+      Intercom::Service::Company.new(self)
+    end
+
+    def contacts
+      Intercom::Service::Contact.new(self)
+    end
+
+    def conversations
+      Intercom::Service::Conversation.new(self)
+    end
+
+    def events
+      Intercom::Service::Event.new(self)
+    end
+
+    def messages
+      Intercom::Service::Message.new(self)
+    end
+
+    def notes
+      Intercom::Service::Note.new(self)
+    end
+
+    def subscriptions
+      Intercom::Service::Subscription.new(self)
+    end
+
+    def segments
+      Intercom::Service::Segment.new(self)
+    end
+
+    def tags
+      Intercom::Service::Tag.new(self)
+    end
+
+    def users
+      Intercom::Service::User.new(self)
+    end
+
+    def get(path, params)
+      execute_request Intercom::Request.get(path, params)
+    end
+
+    def post(path, payload_hash)
+      execute_request Intercom::Request.post(path, payload_hash)
+    end
+
+    def put(path, payload_hash)
+      execute_request Intercom::Request.put(path, payload_hash)
+    end
+
+    def delete(path, payload_hash)
+      execute_request Intercom::Request.delete(path, payload_hash)
+    end
+
+    private
+
+    def execute_request(request)
+      result = request.execute(@base_url, username: @app_id, secret: @api_key)
+      @rate_limit_details = request.rate_limit_details
+      result
+    end
+
+    def base_url=(new_url)
+      @base_url = new_url
+    end
+  end
+end

data/lib/intercom/{collection_proxy.rb → client_collection_proxy.rb}

@@ -2,24 +2,25 @@ require "intercom/utils"
 require "ext/sliceable_hash"
 
 module Intercom
-  class CollectionProxy
+  class ClientCollectionProxy
 
     attr_reader :resource_name
 
-    def initialize(resource_name, finder_details = {})
+    def initialize(resource_name, finder_details: {}, client: 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
 
     def each(&block)
       next_page = nil
       loop do
         if next_page
-          response_hash = Intercom.get(next_page, {})
+          response_hash = @client.get(next_page, {})
         else
-          response_hash = Intercom.get(@finder_url, @finder_params)
+          response_hash = @client.get(@finder_url, @finder_params)
         end
         raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
         deserialize_response_hash(response_hash, block)
@@ -38,10 +39,6 @@ module Intercom
 
     include Enumerable
 
-    def count
-      raise NoMethodError, "undefined method `count' for #{self.class}. Consider using the dedicated Intercom::Count interface if suitable"
-    end
-
     private
 
     def resource_class; @resource_class; end

data/lib/intercom/company.rb

@@ -1,24 +1,8 @@
-require 'intercom/api_operations/count'
-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/load'
-require 'intercom/extended_api_operations/users'
-require 'intercom/extended_api_operations/tags'
 require 'intercom/traits/incrementable_attributes'
 require 'intercom/traits/api_resource'
 
 module Intercom
   class Company
-    include ApiOperations::Count
-    include ApiOperations::List
-    include ApiOperations::Find
-    include ApiOperations::FindAll
-    include ApiOperations::Save
-    include ApiOperations::Load
-    include ExtendedApiOperations::Users
-    include ExtendedApiOperations::Tags
     include Traits::IncrementableAttributes
     include Traits::ApiResource
 

data/lib/intercom/contact.rb

@@ -1,18 +1,7 @@
-require 'intercom/api_operations/count'
-require 'intercom/api_operations/load'
-require 'intercom/api_operations/find'
-require 'intercom/api_operations/find_all'
-require 'intercom/api_operations/save'
-require 'intercom/api_operations/convert'
 require 'intercom/traits/api_resource'
 
 module Intercom
   class Contact
-    include ApiOperations::Load
-    include ApiOperations::Find
-    include ApiOperations::FindAll
-    include ApiOperations::Save
-    include ApiOperations::Convert
     include Traits::ApiResource
 
     def identity_vars ; [:email, :user_id] ; end

data/lib/intercom/conversation.rb

@@ -1,17 +1,7 @@
-require 'intercom/extended_api_operations/reply'
-require 'intercom/api_operations/find_all'
-require 'intercom/api_operations/find'
-require 'intercom/api_operations/load'
-require 'intercom/api_operations/save'
 require 'intercom/traits/api_resource'
 
 module Intercom
   class Conversation
-    include ExtendedApiOperations::Reply
-    include ApiOperations::FindAll
-    include ApiOperations::Find
-    include ApiOperations::Load
-    include ApiOperations::Save
     include Traits::ApiResource
   end
 end