intercom 1.0.0 → 2.0.0

data/spec/unit/intercom_spec.rb

@@ -8,18 +8,18 @@ describe Intercom do
   describe "API" do
     before do
       Intercom.app_id = "abc123"
-      Intercom.api_key = "super-secret-key"
+      Intercom.app_api_key = "super-secret-key"
     end
 
-    it "raises ArgumentError if no app_id or api_key specified" do
+    it "raises ArgumentError if no app_id or app_api_key specified" do
       Intercom.app_id = nil
-      Intercom.api_key = nil
-      proc { Intercom.target_base_url }.must_raise ArgumentError, "You must set both Intercom.app_id and Intercom.api_key to use this client. See https://github.com/intercom/intercom-ruby for usage examples."
+      Intercom.app_api_key = nil
+      proc { Intercom.target_base_url }.must_raise ArgumentError, "You must set both Intercom.app_id and Intercom.app_api_key to use this client. See https://github.com/intercom/intercom-ruby for usage examples."
     end
 
-    it "returns the app_id and api_key previously set" do
+    it "returns the app_id and app_api_key previously set" do
       Intercom.app_id.must_equal "abc123"
-      Intercom.api_key.must_equal "super-secret-key"
+      Intercom.app_api_key.must_equal "super-secret-key"
     end
 
     it "defaults to https to api.intercom.io" do
@@ -81,4 +81,4 @@ describe Intercom do
     Intercom.check_required_params("email" => "bob@example.com", :something => "else")
     Intercom.check_required_params(:user_id => "123")
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -11,10 +11,11 @@ authors:
 - Kyle Daigle
 - Declan McGrath
 - Jamie Osler
+- Bob Long
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -97,6 +98,7 @@ email:
 - kyle@digitalworkbox.com
 - declan@intercom.io
 - jamie@intercom.io
+- bob@intercom.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,38 +112,51 @@ files:
 - changes.txt
 - intercom.gemspec
 - lib/data/cacert.pem
+- lib/ext/hash.rb
 - lib/intercom.rb
+- lib/intercom/api_operations/count.rb
+- lib/intercom/api_operations/delete.rb
+- lib/intercom/api_operations/find.rb
+- lib/intercom/api_operations/find_all.rb
+- lib/intercom/api_operations/list.rb
+- lib/intercom/api_operations/load.rb
+- lib/intercom/api_operations/save.rb
+- lib/intercom/collection_proxy.rb
+- lib/intercom/company.rb
+- lib/intercom/conversation.rb
+- lib/intercom/count.rb
+- lib/intercom/errors.rb
 - lib/intercom/event.rb
-- lib/intercom/flat_store.rb
-- lib/intercom/hashable_object.rb
-- lib/intercom/impression.rb
-- lib/intercom/message_thread.rb
+- lib/intercom/extended_api_operations/reply.rb
+- lib/intercom/extended_api_operations/tags.rb
+- lib/intercom/extended_api_operations/users.rb
+- lib/intercom/generic_handlers/base_handler.rb
+- lib/intercom/generic_handlers/count.rb
+- lib/intercom/generic_handlers/tag.rb
+- lib/intercom/generic_handlers/tag_find_all.rb
+- lib/intercom/lib/dynamic_accessors.rb
+- lib/intercom/lib/dynamic_accessors_on_method_missing.rb
+- lib/intercom/lib/flat_store.rb
+- lib/intercom/lib/typed_json_deserializer.rb
+- lib/intercom/message.rb
 - lib/intercom/note.rb
 - lib/intercom/request.rb
-- lib/intercom/requires_parameters.rb
-- lib/intercom/social_profile.rb
+- lib/intercom/segment.rb
 - lib/intercom/tag.rb
-- lib/intercom/unix_timestamp_unwrapper.rb
+- lib/intercom/traits/api_resource.rb
+- lib/intercom/traits/dirty_tracking.rb
+- lib/intercom/traits/generic_handler_binding.rb
+- lib/intercom/traits/incrementable_attributes.rb
 - lib/intercom/user.rb
-- lib/intercom/user_collection_proxy.rb
-- lib/intercom/user_resource.rb
+- lib/intercom/utils.rb
 - lib/intercom/version.rb
-- spec/integration/fixtures/v1-user.json
-- spec/integration/fixtures/v1-users-impression.json
-- spec/integration/fixtures/v1-users-message_thread.json
-- spec/integration/fixtures/v1-users-message_threads.json
-- spec/integration/fixtures/v1-users-note.json
-- spec/integration/fixtures/v1-users.json
-- spec/integration/intercom_api_integration_spec.rb
 - spec/spec_helper.rb
-- spec/unit/intercom/flat_store_spec.rb
-- spec/unit/intercom/impression_spec.rb
-- spec/unit/intercom/message_thread_spec.rb
+- spec/unit/intercom/collection_proxy_spec.rb
+- spec/unit/intercom/event_spec.rb
+- spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/tag_spec.rb
-- spec/unit/intercom/user_collection_proxy_spec.rb
-- spec/unit/intercom/user_event_spec.rb
-- spec/unit/intercom/user_resource_spec.rb
+- spec/unit/intercom/traits/api_resource_spec.rb
 - spec/unit/intercom/user_spec.rb
 - spec/unit/intercom_spec.rb
 homepage: https://www.intercom.io
@@ -164,9 +179,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/unit/intercom/collection_proxy_spec.rb
+- spec/unit/intercom/event_spec.rb
+- spec/unit/intercom/lib/flat_store_spec.rb
+- spec/unit/intercom/note_spec.rb
+- spec/unit/intercom/tag_spec.rb
+- spec/unit/intercom/traits/api_resource_spec.rb
+- spec/unit/intercom/user_spec.rb
+- spec/unit/intercom_spec.rb
 has_rdoc: 

data/lib/intercom/flat_store.rb

@@ -1,27 +0,0 @@
-module Intercom
-  # Sub-class of {Hash} for storing custom data attributes.
-  # Doesn't allow nested Hashes or Arrays. And requires {String} or {Symbol} keys.
-  class FlatStore < Hash
-    def initialize(attributes={})
-      (attributes).each do |key, value|
-        validate_key_and_value(key, value)
-        self[key] = value
-      end
-    end
-
-    def []=(key, value)
-      validate_key_and_value(key, value)
-      super(key.to_s, value)
-    end
-
-    def [](key)
-      super(key.to_s)
-    end
-
-    private
-    def validate_key_and_value(key, value)
-      raise ArgumentError.new("This does not support nested data structures (key: #{key}, value: #{value}") if value.is_a?(Array) || value.is_a?(Hash)
-      raise ArgumentError.new("Key must be String or Symbol: #{key}") unless key.is_a?(String) || key.is_a?(Symbol)
-    end
-  end
-end

data/lib/intercom/hashable_object.rb

@@ -1,22 +0,0 @@
-module Intercom
-  module HashableObject
-    def from_hash(hash)
-      hash.each {|attribute, value| instance_variable_set("@#{attribute}".to_sym, value) }
-    end
-
-    def to_hash
-      instance_variables.inject({}) do |hash, var|
-        hash[var.to_s.delete("@").to_sym] = instance_variable_get(var)
-        hash
-      end
-    end
-
-    def displayable_attributes
-      Hash[ to_hash.select {|attribute, value| self.respond_to?(attribute) } ]
-    end
-
-    def to_wire
-      Hash[ to_hash.select {|attribute, value| self.respond_to?("#{attribute.to_s}=") } ]
-    end
-  end
-end

data/lib/intercom/impression.rb

@@ -1,63 +0,0 @@
-require 'intercom/user_resource'
-
-module Intercom
-
-  ##
-  # Represents a users interaction with your app (eg page view, or using a particular feature)
-  #
-  # An impressions contains user_ip, user_agent and location.
-  #
-  # == Examples
-  #
-  #  impression = Intercom::Impression.create(:email => "person@example.com", :location => "/pricing/upgrade",
-  #                                           :user_ip => '1.2.3.4', :user_agent => "my-service-iphone-app-1.2")
-  # The impression response will contain {#unread_messages}
-  #  impression.unread_messages
-  # You can also create an impression and save it like this:
-  #  impression = Intercom::Impression.new
-  #  impression.email = "person@example.com"
-  #  impression.location = "person@example.com"
-  #  ....
-  #  impression.save
-  class Impression < UserResource
-    ##
-    # Creates a new Impression using params and saves it
-    # @see #save
-    def self.create(params)
-      Impression.new(params).save
-    end
-
-    ##
-    # Records that a user has interacted with your application, including the 'location' within the app they used
-    def save
-      response = Intercom.post("/v1/users/impressions", to_hash)
-      self.update_from_api_response(response)
-    end
-
-    ##
-    # Set the ip address of the user for this impression
-    def user_ip=(user_ip)
-      @attributes["user_ip"] = user_ip
-    end
-
-    ##
-    # Set the location in your application that this impression occurred. E.g. the url in a web app, or perhaps the screen in a desktop  or phone application.
-    def location=(location)
-      @attributes["location"] = location
-    end
-
-    ##
-    # Set the user agent of the user this impression (E.g. their browser user agent, or the name and version of a desktop or phone application)
-    def user_agent=(user_agent)
-      @attributes["user_agent"] = user_agent
-    end
-
-    ##
-    # For convenience, after saving, the unread_messages count will be updated with the number of unread messages for the user for their current location.
-    #
-    # Remember, Auto Messages (http://docs.intercom.io/#AutoMessages) can be targeted to only show when a user views a particular page in your application.
-    def unread_messages
-      @attributes["unread_messages"]
-    end
-  end
-end

data/lib/intercom/message_thread.rb

@@ -1,189 +0,0 @@
-require 'intercom/user_resource'
-
-module Intercom
-  # A conversation with a user. Either started by the users sending a message to your application using Intercom, or by an Admin sending a message to the user.
-  # == Examples
-  #
-  # Fetching all {MessageThread}'s for a user
-  #    message_threads = Intercom::MessageThread.find_all(:email => "bob@example.com")
-  #    message_threads.size
-  #    message_thread = message_threads[0]
-  #
-  # Fetching a particular {MessageThread}
-  #    message_thread = Intercom::MessageThread.find(:email => "bob@example.com", :thread_id => 123)
-  #    message_thread.messages.map{|message| message.html }
-  #
-  # Creating a {MessageThread} on behalf of a user:
-  #    message_thread = Intercom::MessageThread.create(:email => "bob@example.com", :body => "Hello, I need some help....")
-  #
-  class MessageThread < UserResource
-    include UnixTimestampUnwrapper
-
-    # Finds a particular Message identified by thread_id
-    # @return [Message]
-    def self.find(params)
-      requires_parameters(params, %W(thread_id))
-      api_response = Intercom.get("/v1/users/message_threads", params)
-      MessageThread.from_api(api_response)
-    end
-
-    # Finds all Messages to show a particular user
-    # @return [Array<Message>]
-    def self.find_all(params)
-      response = Intercom.get("/v1/users/message_threads", params)
-      response.map { |message| MessageThread.from_api(message) }
-    end
-
-    # Either creates a new message from this user to your application admins, or a comment on an existing one
-    # @return [Message]
-    def self.create(params)
-      requires_parameters(params, %W(body))
-      MessageThread.new(params).save
-    end
-
-    # Marks a message (identified by thread_id) as read
-    # @return [Message]
-    def self.mark_as_read(params)
-      requires_parameters(params, %W(thread_id))
-      MessageThread.new({"read" => true}.merge(params)).save(:put)
-    end
-
-    # @return [Message]
-    def save(method=:post)
-      response = Intercom.send(method, "/v1/users/message_threads", to_hash)
-      self.update_from_api_response(response)
-    end
-
-    # @return [Message]
-    def mark_as_read!
-      Intercom::MessageThread.mark_as_read(:thread_id => thread_id, :email => email)
-    end
-
-    # Set the content of the message for new message creation.
-    # @param [String] body of the message. Supports markdown syntax
-    # @return [String]
-    def body=(body)
-      @attributes["body"] = body
-    end
-
-    # @return [Time] when this {MessageThread} was created
-    def created_at
-      time_at("created_at")
-    end
-
-    # @return [Time] when the last update to this {MessageThread} happened
-    def updated_at
-      time_at("updated_at")
-    end
-
-    # @return [Integer]
-    # @param [Integer thread_id]
-    def thread_id=(thread_id)
-      @attributes["thread_id"] = thread_id
-    end
-
-    # @return [Integer]
-    def thread_id
-      @attributes["thread_id"]
-    end
-
-    # @return [Boolean]
-    # @param [Boolean] read whether the latest revision of the thread has been read by the user
-    def read=(read)
-      @attributes["read"] = read
-    end
-
-    # @return [Boolean]
-    def read
-      @attributes["read"]
-    end
-
-    # @return [String]
-    # @param [String] read the url that was being viewed when the comment was sent
-    def url=(url)
-      @attributes["url"] = url
-    end
-
-    # @return [String]
-    def url
-      @attributes["url"]
-    end
-
-    # @return [Array<Message>]
-    def messages
-      @attributes["messages"].map {|message_hash| Message.new(message_hash)}
-    end
-  end
-
-  # a {MessageThread} contains multiple {Message}'s
-  #
-  # {Message}'s are a read only part of a {MessageThread}
-  class Message
-    include UnixTimestampUnwrapper
-
-    # Used to create a {Message} from part of the response from the API
-    def initialize(params)
-      @attributes = params
-    end
-
-    # @return [MessageAuthor] Author, which can be either an end user, or an Admin for your application
-    def from
-      MessageAuthor.new(@attributes["from"])
-    end
-
-    # @return [String] html markup for the message
-    def html
-      @attributes["html"]
-    end
-
-    # @return [Time] when this message was posted
-    def created_at
-      time_at("created_at")
-    end
-  end
-
-  # each {Message} in a {MessageThread} has a {MessageAuthor}
-  #
-  # Admin authors have a name, avatar_path_25, avatar_path_50, and avatar_path_128. Non-admin authors have a name, user_id and email.
-  class MessageAuthor
-    # Used to create a {MessageAuthor} from part of the response from the API
-    def initialize(params)
-      @attributes = params
-    end
-
-    # @return [Boolean] whether this author is an admin or not
-    def admin?
-      @attributes['is_admin']
-    end
-
-    # @return [String] email address of the author (only available when {#admin?} is false)
-    def email
-      @attributes['email']
-    end
-
-    # @return [String] user_id of the author (only available when {#admin?} is false)
-    def user_id
-      @attributes['user_id']
-    end
-
-    # @return [String] url of 25x25 avatar of the admin who posted this message (only available when {#admin?} is true)
-    def avatar_path_25
-      self.admin? ? @attributes['avatar']['square_25'] : nil
-    end
-
-    # @return [String] url of 50x50 avatar of the admin who posted this message (only available when {#admin?} is true)
-    def avatar_path_50
-      self.admin? ? @attributes['avatar']['square_50'] : nil
-    end
-
-    # @return [String] url of 128x128 avatar of the admin who posted this message (only available when {#admin?} is true)
-    def avatar_path_128
-      self.admin? ? @attributes['avatar']['square_128'] : nil
-    end
-
-    # @return [String] real name of the Admin/User, when available.
-    def name
-      @attributes['name']
-    end
-  end
-end