cogniteev-intercom 2.5.4

data/lib/intercom/traits/dirty_tracking.rb

@@ -0,0 +1,33 @@
+require 'set'
+
+module Intercom
+  module Traits
+    module DirtyTracking
+
+      def reset_changed_fields!
+        @changed_fields = Set.new
+      end
+
+      def mark_fields_as_changed!(field_names)
+        @changed_fields ||= Set.new
+        field_names.each do |attr|
+          @changed_fields.add(attr.to_s)
+        end
+      end
+
+      def mark_field_as_changed!(field_name)
+        @changed_fields ||= Set.new
+        @changed_fields.add(field_name.to_s)
+      end
+
+      def field_changed?(field_name)
+        @changed_fields ||= Set.new
+        @changed_fields.include?(field_name.to_s)
+      end
+
+      def instance_variables_excluding_dirty_tracking_field
+        instance_variables.reject{|var| var == :@changed_fields}
+      end
+    end
+  end
+end

data/lib/intercom/traits/generic_handler_binding.rb

@@ -0,0 +1,29 @@
+module Intercom
+  module Traits
+
+    # Allows us to have one class level method missing handler across all entities
+    # which can dispatch to the appropriate function based on the method name
+    module GenericHandlerBinding
+
+      module ClassMethods
+        def method_missing(method_sym, *arguments, &block)
+          if respond_to? :generic_tag and GenericHandlers::Tag.handles_method?(method_sym)
+            return generic_tag(method_sym, *arguments, block)
+          elsif respond_to? :generic_tag_find_all and GenericHandlers::TagFindAll.handles_method?(method_sym)
+            return generic_tag_find_all(method_sym, *arguments, block)
+          elsif respond_to? :generic_count and GenericHandlers::Count.handles_method?(method_sym)
+            return generic_count(method_sym, *arguments, block)
+          end
+          super
+        rescue Intercom::NoMethodMissingHandler
+          super
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/intercom/traits/incrementable_attributes.rb

@@ -0,0 +1,12 @@
+module Intercom
+  module Traits
+    module IncrementableAttributes
+
+      def increment(key, value=1)
+        existing_value = self.custom_attributes[key]
+        existing_value ||= 0
+        self.custom_attributes[key] = existing_value + value
+      end
+    end
+  end
+end

data/lib/intercom/user.rb

@@ -0,0 +1,30 @@
+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
+  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
+
+  end
+end

data/lib/intercom/utils.rb

@@ -0,0 +1,62 @@
+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
+
+      # the constantize method that exists in rails to allow for ruby 1.9 to get namespaced constants
+      def constantize(camel_cased_word)
+        names = camel_cased_word.split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      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, false)
+        namespaced_class_name = "Intercom::#{class_name}"
+        constantize 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, false)
+        namespaced_class_name = "Intercom::#{class_name}"
+        constantize 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

data/lib/intercom/version.rb

@@ -0,0 +1,3 @@
+module Intercom #:nodoc:
+  VERSION = "2.5.4"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,308 @@
+require 'intercom'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+def test_user(email="bob@example.com")
+  {
+    "type" =>"user",
+    "id" =>"aaaaaaaaaaaaaaaaaaaaaaaa",
+    "user_id" => 'id-from-customers-app',
+    "email" => email,
+    "name" => "Joe Schmoe",
+    "avatar" => {"type"=>"avatar", "image_url"=>"https://graph.facebook.com/1/picture?width=24&height=24"},
+    "app_id" => "the-app-id",
+    "custom_attributes" => {"a" => "b", "b" => 2},
+    "companies" =>
+     {"type"=>"company.list",
+      "companies"=>
+       [{"type"=>"company",
+         "company_id"=>"123",
+         "id"=>"bbbbbbbbbbbbbbbbbbbbbbbb",
+         "app_id"=>"the-app-id",
+         "name"=>"Company 1",
+         "remote_created_at"=>1390936440,
+         "created_at"=>1401970114,
+         "updated_at"=>1401970114,
+         "last_request_at"=>1401970113,
+         "monthly_spend"=>0,
+         "session_count"=>0,
+         "user_count"=>1,
+         "tag_ids"=>[],
+         "custom_attributes"=>{"category"=>"Tech"}}]},
+    "session_count" => 123,
+    "unsubscribed_from_emails" => true,
+    "last_request_at" =>1401970113,
+    "created_at" =>1401970114,
+    "remote_created_at" =>1393613864,
+    "updated_at" =>1401970114,
+    "user_agent_data" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+    "social_profiles" =>{"type"=>"social_profile.list",
+       "social_profiles" => [
+           {"type" => "social_profile", "name" => "twitter", "url" => "http://twitter.com/abc", "username" => "abc", "id" => nil},
+           {"type" => "social_profile", "name" => "twitter", "username" => "abc2", "url" => "http://twitter.com/abc2", "id" => nil},
+           {"type" => "social_profile", "name" => "facebook", "url" => "http://facebook.com/abc", "username" => "abc", "id" => "1234242"},
+           {"type" => "social_profile", "name" => "quora", "url" => "http://facebook.com/abc", "username" => "abc", "id" => "1234242"}
+       ]},
+   "location_data"=>
+    {"type"=>"location_data",
+     "city_name"=> 'Dublin',
+     "continent_code"=> 'EU',
+     "country_name"=> 'Ireland',
+     "latitude"=> '90',
+     "longitude"=> '10',
+     "postal_code"=> 'IE',
+     "region_name"=> 'Europe',
+     "timezone"=> '+1000',
+     "country_code" => "IRL"}
+  }
+end
+
+def test_messages
+  [test_message, test_message]
+end
+
+def test_message
+  {
+      "created_at" => 1329837506,
+      "updated_at" => 1329664706,
+      "read" => true,
+      "created_by_user" => true,
+      "thread_id" => 5591,
+      "messages" => [
+          {
+              "created_at" => 1329837506,
+              "html" => "<p>Hey Intercom, What is up?</p>\n",
+              "from" => {
+                  "email" => "bob@example.com",
+                  "name" => "Bob",
+                  "user_id" => "123",
+                  "is_admin" => false
+              }
+          },
+          {
+              "created_at" => 1329664706,
+              "rendered_body" => "<p>Not much, you?</p>\n",
+              "from" => {
+                  "name" => "Super Duper Admin",
+                  "avatar" => {
+                    "square_25" => "https://static.intercomcdn.com/avatars/13347/square_25/Ruairi_Profile.png?1375368166",
+                    "square_50" => "https://static.intercomcdn.com/avatars/13347/square_50/Ruairi_Profile.png?1375368166",
+                    "square_128" => "https://static.intercomcdn.com/avatars/13347/square_128/Ruairi_Profile.png?1375368166"
+                  },
+                  "is_admin" => true
+              }
+          },
+          {
+              "created_at" => 1329664806,
+              "rendered_body" => "<p>Not much either :(</p>\n",
+              "from" => {
+                  "email" => "bob@example.com",
+                  "name" => "Bob",
+                  "user_id" => "123",
+                  "is_admin" => false
+              }
+          }
+      ]
+  }
+end
+
+def page_of_users(include_next_link= false)
+  {
+     "type"=>"user.list",
+     "pages"=>
+      {
+        "type"=>"pages",
+        "next"=> (include_next_link ? "https://api.intercom.io/users?per_page=50&page=2" : nil),
+        "page"=>1,
+        "per_page"=>50,
+        "total_pages"=>7
+      },
+      "users"=> [test_user("user1@example.com"), test_user("user2@example.com"), test_user("user3@example.com")],
+      "total_count"=>314
+  }
+end
+
+def test_tag
+  {
+    "id" => "4f73428b5e4dfc000b000112",
+    "name" => "Test Tag",
+    "segment" => false,
+    "tagged_user_count" => 2
+  }
+end
+
+def test_user_notification
+  {
+    "type" => "notification_event",
+    "id" => "notif_123456-56465-546546",
+    "topic" => "user.created",
+    "app_id" => "aaaaaa",
+    "data" =>
+    {
+      "type" => "notification_event_data",
+      "item" =>
+      {
+        "type" => "user",
+        "id" => "aaaaaaaaaaaaaaaaaaaaaaaa",
+        "user_id" => nil,
+        "email" => "joe@example.com",
+        "name" => "Joe Schmoe",
+        "avatar" =>
+        {
+          "type" => "avatar",
+          "image_url" => nil
+        },
+        "app_id" => "aaaaa",
+        "companies" =>
+        {
+          "type" => "company.list",
+          "companies" => [ ]
+        },
+        "location_data" =>
+        {
+        },
+        "last_request_at" => nil,
+        "created_at" => "1401970114",
+        "remote_created_at" => nil,
+        "updated_at" => "1401970114",
+        "session_count" => 0,
+        "social_profiles" =>
+        {
+          "type" => "social_profile.list",
+          "social_profiles" => [ ]
+        },
+        "unsubscribed_from_emails" => false,
+        "user_agent_data" => nil,
+        "tags" =>
+        {
+          "type" => "tag.list",
+          "tags" => [ ]
+        },
+        "segments" =>
+        {
+          "type" => "segment.list",
+          "segments" => [ ]
+        },
+        "custom_attributes" =>
+        {
+        }
+      }
+    },
+    "delivery_status" => nil,
+    "delivery_attempts" => 1,
+    "delivered_at" => 0,
+    "first_sent_at" => 1410188629,
+    "created_at" => 1410188628,
+    "links" => { },
+    "self" => nil
+  }
+end
+
+def test_conversation_notification
+  {
+     "type"=>"notification_event",
+     "id"=>"notif_123456-56465-546546",
+     "topic"=>"conversation.user.created",
+     "app_id"=>"aaaaa",
+     "data"=>
+     {
+          "type"=>"notification_event_data",
+          "item"=>
+          {
+               "type"=>"conversation",
+               "id"=>"123456789",
+               "created_at"=>"1410335293",
+               "updated_at"=>"1410335293",
+               "user"=>
+               {
+                    "type"=>"user",
+                    "id"=>"540f1de7112d3d1d51001637",
+                    "name"=>"Kill Bill",
+                    "email"=>"bill@bill.bill"},
+               "assignee"=>
+               {
+                   "type"=>"nobody_admin",
+                   "id"=>nil
+               },
+               "conversation_message"=>
+               {
+                    "type"=>"conversation_message",
+                    "id"=>"321546",
+                    "subject"=>"",
+                    "body"=>"<p>An important message</p>",
+                    "author"=>
+                    {
+                         "type"=>"user",
+                         "id"=>"aaaaaaaaaaaaaaaaaaaaaa",
+                         "name"=>"Kill Bill",
+                         "email"=>"bill@bill.bill"},
+                    "attachments"=>[]
+               },
+               "conversation_parts"=>
+               {
+                   "type"=>"conversation_part.list",
+                   "conversation_parts"=>[]
+               },
+               "open"=>nil,
+               "read"=>true,
+               "links"=>
+               {
+                   "conversation_web"=>
+                    "https://app.intercom.io/a/apps/aaaaaa/inbox/all/conversations/123456789"}
+          }
+     },
+     "delivery_status"=>nil,
+     "delivery_attempts"=>1,
+     "delivered_at"=>0,
+     "first_sent_at"=>1410335293,
+     "created_at"=>1410335293,
+     "links"=>{},
+     "self"=>nil
+  }
+end
+
+def test_subscription
+  {"request"=>
+       {"type"=>"notification_subscription",
+        "id"=>"nsub_123456789",
+        "created_at"=>1410368642,
+        "updated_at"=>1410368642,
+        "service_type"=>"web",
+        "app_id"=>"3qmk5gyg",
+        "url"=>
+            "http://example.com",
+        "self"=>
+            "https://api.intercom.io/subscriptions/nsub_123456789",
+        "topics"=>["user.created", "conversation.user.replied", "conversation.admin.replied"],
+        "active"=>true,
+        "metadata"=>{},
+        "hub_secret"=>nil,
+        "mode"=>"point",
+        "links"=>
+            {"sent"=>
+                 "https://api.intercom.io/subscriptions/nsub_123456789/sent",
+             "retry"=>
+                 "https://api.intercom.io/subscriptions/nsub_123456789/retry",
+             "errors"=>
+                 "https://api.intercom.io/subscriptions/nsub_123456789/errors"},
+        "notes"=>[]}}
+end
+
+def error_on_modify_frozen
+  RUBY_VERSION =~ /1.8/ ? TypeError : RuntimeError
+end
+
+def capture_exception(&block)
+  begin
+    block.call
+  rescue => e
+    return e
+  end
+end
+
+def unshuffleable_array(array)
+  def array.shuffle
+    self
+  end
+  array
+end