intercom 1.0.0 → 2.0.0

data/lib/intercom/traits/incrementable_attributes.rb

@@ -0,0 +1,23 @@
+module Intercom
+  module Traits
+    module IncrementableAttributes
+
+      def increment(key, value=1)
+        mark_field_as_changed!(:increments)
+        increments[key] ||= 0
+        increments[key] += value
+      end
+
+      private
+
+      def increments
+        @increments ||= {}
+      end
+
+      def increments=(hash)
+        mark_field_as_changed!(:increments)
+        @increments = hash
+      end
+    end
+  end
+end

data/lib/intercom/user.rb

@@ -1,366 +1,30 @@
-require 'intercom/user_resource'
-require 'intercom/flat_store'
-require 'intercom/user_collection_proxy'
-require 'intercom/social_profile'
+require 'intercom/api_operations/count'
+require 'intercom/api_operations/list'
+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/delete'
+require 'intercom/extended_api_operations/tags'
+require 'intercom/traits/incrementable_attributes'
+require 'intercom/traits/api_resource'
 
 module Intercom
-  # Represents a user of your application on Intercom.
-  #
-  # == Example usage
-  # * Fetching a user
-  #    Intercom::User.find_by_email("bob@example.com")
-  #
-  # * Getting the count of all users
-  #    Intercom::User.all.count
-  #
-  # * Fetching all users
-  #    Intercom::User.all.each { |user| puts user.email }
-  #
-  # * Updating custom data on a user
-  #    user = Intercom::User.find_by_email("bob@example.com")
-  #    user.custom_data["number_of_applications"] = 11
-  #    user.save
-  class User < UserResource
+  class User
+    include ApiOperations::Count
+    include ApiOperations::List
+    include ApiOperations::Load
+    include ApiOperations::Find
+    include ApiOperations::FindAll
+    include ApiOperations::Save
+    include ApiOperations::Delete
+    include ExtendedApiOperations::Tags
+    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
 
-
-    ##
-    # Fetches an Intercom::User from our API.
-    #
-    # Calls GET https://api.intercom.io/v1/users
-    #
-    # returns Intercom::User object representing the state on our servers.
-    #
-    # @return [User]
-    def self.find(params)
-      response = Intercom.get("/v1/users", params)
-      User.from_api(response)
-    end
-
-    # Calls GET https://api.intercom.io/v1/users?email=EMAIL
-    #
-    # returns Intercom::User object representing the state on our servers.
-    #
-    # @param [String] email address of the user
-    # @return [User]
-    def self.find_by_email(email)
-      find({:email => email})
-    end
-
-    # Calls GET https://api.intercom.io/v1/users?user_id=USER-ID
-    #
-    # returns Intercom::User object representing the state on our servers.
-    #
-    # @param [String] user_id user id of the user
-    # @return [User]
-    def self.find_by_user_id(user_id)
-      find({:user_id => user_id})
-    end
-
-    # Creates (or updates when a user already exists for that email/user_id) a user record on your application.
-    #
-    # Calls POST https://api.intercom.io/v1/users
-    #
-    # returns Intercom::User object representing the state on our servers.
-    #
-    # This operation is idempotent.
-    # @return [User]
-    def self.create(params)
-      User.new(params).save
-    end
-
-    # Retrieve all the users
-    # Examples:
-    #   Intercom::User.all.each do |user|
-    #     puts user.inspect
-    #   end
-    #     > ["user1@example.com" ,"user2@example.com" ,....]
-    #   Intercom::User.all.map(&:email)
-    #     > ["user1@example.com" ,"user2@example.com" ,....]
-    #
-    # @return [UserCollectionProxy]
-    def self.all
-      UserCollectionProxy.new
-    end
-
-    # Retrieve all the users that match a query
-    # Examples:
-    #   Intercom::User.where(:tag_name => 'Free Trial').each do |user|
-    #     puts user.inspect
-    #   end
-    #     > ["user1@example.com" ,"user2@example.com" ,....]
-    #   Intercom::User.where(:tag_name => 'Free Trial').map(&:email)
-    #     > ["user1@example.com" ,"user2@example.com" ,....]
-    #
-    # Currently only supports tag_name and tag_id querying
-    #
-    # @return [UserCollectionProxy]
-    def self.where(params)
-      UserCollectionProxy.new(params)
-    end
-
-    # Fetches a count of all Users tracked on Intercom.
-    # Example:
-    #   Intercom::User.all.count
-    #     > 5346
-    #
-    # @return [Integer]
-    def self.count
-      response = Intercom.get("/v1/users", {:per_page => 1})
-      response["total_count"]
-    end
-
-    # Deletes a user record on your application.
-    #
-    # Calls DELETE https://api.intercom.io/v1/users
-    #
-    # returns Intercom::User object representing the user just before deletion.
-    #
-    # This operation is not idempotent.
-    # @return [User]
-    def self.delete(params)
-      response = Intercom.delete("/v1/users", params)
-      User.from_api(response)
-    end
-
-    # instance method alternative to #create
-    # @return [User]
-    def save
-      response = Intercom.post("/v1/users", to_hash)
-      self.update_from_api_response(response)
-    end
-
-    # Increment a custom data value on a user
-    # @return [User]
-    def increment(key, value=1)
-      increments[key] ||= 0
-      increments[key] += value
-    end
-
-    # @return [String] the {User}'s name
-    def name
-      @attributes["name"]
-    end
-
-    # @param [String] name {User}'s name
-    # @return [void]
-    def name=(name)
-      @attributes["name"]=name
-    end
-
-    # @return [String]
-    def last_seen_ip
-      @attributes["last_seen_ip"]
-    end
-
-    # @return [void]
-    def last_seen_ip=(last_seen_ip)
-      @attributes["last_seen_ip"]=last_seen_ip
-    end
-
-    # @return [String]
-    def last_seen_user_agent
-      @attributes["last_seen_user_agent"]
-    end
-
-    # @return [void]
-    def last_seen_user_agent=(last_seen_user_agent)
-      @attributes["last_seen_user_agent"]=last_seen_user_agent
-    end
-
-    # @return [Integer]
-    def relationship_score
-      @attributes["relationship_score"]
-    end
-
-    # @return [Integer]
-    def session_count
-      @attributes["session_count"]
-    end
-
-    ##
-    # Get last time this User interacted with your application
-    # @return [Time]
-    def last_impression_at
-      time_at("last_impression_at")
-    end
-
-    ##
-    # Set Time at which this User last made a request your application.
-    # @return [void]
-    def last_impression_at=(time)
-      set_time_at("last_impression_at", time)
-    end
-
-    ##
-    # Get last time this User interacted with your application
-    # @return [Time]
-    def last_request_at
-      time_at("last_request_at")
-    end
-
-    ##
-    # Set Time at which this User last made a request your application.
-    # @return [void]
-    def last_request_at=(time)
-      set_time_at("last_request_at", time)
-    end
-
-    ##
-    # Get Time at which this User started using your application.
-    # @return [Time]
-    def created_at
-      time_at("created_at")
-    end
-
-    ##
-    # Set Time at which this User started using your application.
-    # @return [void]
-    def created_at=(time)
-      set_time_at("created_at", time)
-    end
-
-    ##
-    # Get whether user has unsubscribed from email
-    # @return [Boolean]
-    def unsubscribed_from_emails
-      @attributes['unsubscribed_from_emails']
-    end
-
-    ##
-    # Get url for user's avatar, if present. Otherwise, nil.
-    # @return [String]
-    def avatar_url
-      @attributes["avatar_url"]
-    end
-
-    ##
-    # Set whether user has unsubscribed from email
-    # @return [void]
-    def unsubscribed_from_emails=(unsubscribed_from_emails)
-      @attributes['unsubscribed_from_emails'] = unsubscribed_from_emails
-    end
-
-    ##
-    # Get array of Intercom::SocialProfile objects attached to this Intercom::User
-    #
-    # See http://docs.intercom.io/#SocialProfiles for more information
-    # @return [Array<SocialProfile>]
-    def social_profiles
-      @social_profiles ||= [].freeze
-    end
-
-    ##
-    # Get hash of location attributes associated with this Intercom::User
-    #
-    # Possible entries: city_name, continent_code, country_code, country_name, latitude, longitude, postal_code, region_name, timezone
-    #
-    # e.g.
-    #
-    #    {"city_name"=>"Santiago", "continent_code"=>"SA", "country_code"=>"CHL", "country_name"=>"Chile",
-    #     "latitude"=>-33.44999999999999, "longitude"=>-70.6667, "postal_code"=>"", "region_name"=>"12",
-    #     "timezone"=>"Chile/Continental"}
-    # @return [Hash]
-    def location_data
-      @location_data ||= {}.freeze
-    end
-
-    # Custom attributes stored for this Intercom::User
-    #
-    # See http://docs.intercom.io/#CustomData for more information
-    #
-    # Example: Reading custom_data value for an existing user
-    #  user = Intercom::User.find(:email => "someone@example.com")
-    #  puts user.custom_data[:plan]
-    #
-    # Example: Setting some custom data for an existing user
-    #  user = Intercom::User.find(:email => "someone@example.com")
-    #  user.custom_data[:plan] = "pro"
-    #  user.save
-    #
-    # @return [FlatStore]
-    def custom_data
-      @attributes["custom_data"] ||= FlatStore.new
-    end
-
-    # Set a {Hash} of custom data attributes to save/update on this user
-    #
-    # @param [Hash] custom_data
-    # @return [FlatStore]
-    def custom_data=(custom_data)
-      @attributes["custom_data"] = FlatStore.new(custom_data)
-    end
-
-    # Company stored for this Intercom::User
-    #
-    # See http://docs.intercom.io/#Companies for more information
-    #
-    # Example: Setting a company for an existing user
-    #  user = Intercom::User.find(:email => "someone@example.com")
-    #  user.company[:id] = 6
-    #  user.company[:name] = "Intercom"
-    #  user.save
-    #
-    # @return [FlatStore]
-    def company
-      @attributes["company"] ||= FlatStore.new
-    end
-
-    # Set a {Hash} of company attributes to save/update on this user
-    #
-    # @param [Hash] company
-    # @return [FlatStore]
-    def company=(company)
-      @attributes["company"] = FlatStore.new(company)
-    end
-
-    # Multiple companies for this Intercom::User
-    #
-    # See http://docs.intercom.io/#Companies for more information
-    #
-    # Example: Setting a company for an existing user
-    #  user = Intercom::User.find(:email => "someone@example.com")
-    #  user.companies = [{:id => 6, :name => "intercom"}, {:id => 9, :name => "Test Company"}]
-    #  user.save
-    #
-    # @return [Array]
-    def companies
-      @attributes["companies"] ||= []
-    end
-
-    # Set an {Array} of {Hash} company attributes to save/update on this user
-    #
-    # @param [Array] companies
-    # @return [Array]
-    def companies=(companies)
-      raise ArgumentError.new("Companies requires an array of hashes of companies") unless companies.is_a?(Array) && companies.all? {|company| company.is_a?(Hash)}
-      @attributes["companies"] = companies.collect {|company| FlatStore.new(company) }
-    end
-    
-    ##
-    # Creates an Event for the given User
-    # @param {Hash} options, keys for :created_at (Unix timestamp) and metadata
-    def track_event(event_name, options={})
-      attributes = {:event_name => event_name, :user => self}
-      attributes[:created_at] = options[:created_at] unless options[:created_at].nil?
-      attributes[:metadata] = options[:metadata] unless options[:metadata].nil?
-      Event.create(attributes)
-    end
-
-    protected
-      def social_profiles=(social_profiles) #:nodoc:
-        @social_profiles = social_profiles.map { |account| SocialProfile.new(account) }.freeze
-      end
-
-      def location_data=(hash) #:nodoc:
-        @location_data = hash.freeze
-      end
-
-      def increments #:nodoc:
-        @attributes["increments"] ||= {}
-      end
-
-      def increments=(hash) #:nodoc:
-        @attributes["increments"] = hash
-      end
   end
 end

data/lib/intercom/utils.rb

@@ -0,0 +1,50 @@
+module Intercom
+  module Utils
+    class << self
+      def singularize(str)
+        str.gsub(/ies$/, 'y').gsub(/s$/, '')
+      end
+
+      def pluralize(str)
+        return str.gsub(/y$/, 'ies') if str =~ /y$/
+        "#{str}s"
+      end
+
+      def resource_class_to_singular_name(resource_class)
+        resource_class.to_s.split('::')[-1].downcase
+      end
+
+      def resource_class_to_collection_name(resource_class)
+        Utils.pluralize(resource_class_to_singular_name(resource_class))
+      end
+
+      def constantize_resource_name(resource_name)
+        class_name = Utils.singularize(resource_name.capitalize)
+        define_lightweight_class(class_name) unless Intercom.const_defined?(class_name)
+        namespaced_class_name = "Intercom::#{class_name}"
+        Object.const_get(namespaced_class_name)
+      end
+
+      def constantize_singular_resource_name(resource_name)
+        class_name = resource_name.split('_').map(&:capitalize).join
+        define_lightweight_class(class_name) unless Intercom.const_defined?(class_name)
+        namespaced_class_name = "Intercom::#{class_name}"
+        Object.const_get(namespaced_class_name )
+      end
+
+      def define_lightweight_class(class_name)
+        #File.open('./intercom_ruby_dynamically_defined_classes.log', 'a') {|f| f.puts("Dynamically defining the class Intercom::#{class_name}") } #HACK
+        new_class_definition = Class.new(Object) do
+          include Traits::ApiResource
+        end
+        Intercom.const_set(class_name, new_class_definition)
+      end
+
+      def entity_key_from_type(type)
+        is_list = type.split('.')[1] == 'list'
+        entity_name = type.split('.')[0]
+        is_list ?  Utils.pluralize(entity_name) : entity_name
+      end
+    end
+  end
+end