intercom 0.0.10 → 0.0.11

data/README.rdoc

@@ -25,6 +25,7 @@ The API supports:
     POST,PUT,GET https://api.intercom.io/v1/users
     POST,PUT,GET https://api.intercom.io/v1/users/messages
     POST https://api.intercom.io/v1/users/impressions
+    POST https://api.intercom.io/v1/users/notes
 
 === Examples:
 
@@ -52,6 +53,10 @@ The API supports:
 
     Intercom::Impression.create(:email => "bob@example.com", :location => "/path/in/my/app", :user_ip => "1.2.3.4", :user_agent => "my-savage-iphone-app-0.1"
 
+==== Notes
+
+    Intercom::Note.create(:email => "bob@example.com", :body => "This is the text of the note"
+
 === Errors
 
     Intercom::AuthenticationError

data/changes.txt

@@ -1,3 +1,9 @@
+0.0.11
+ - add support for creating notes on users
+
+0.0.10
+ - allow settings dates to nil
+
 0.0.9
  - add support for settings/updating url attribute for message_threads
 

data/lib/intercom.rb

@@ -3,6 +3,7 @@ require "intercom/user_resource"
 require "intercom/user"
 require "intercom/message_thread"
 require "intercom/impression"
+require "intercom/note"
 require "intercom/request"
 require "json"
 

data/lib/intercom/note.rb

@@ -0,0 +1,45 @@
+require 'intercom/user_resource'
+
+module Intercom
+
+  ##
+  # Represents a note on a user
+  #
+  # A note contains a note (the text of the note you want to leave)
+  #
+  # == Examples
+  #
+  #  note = Intercom::Note.create(:email => "person@example.com", :body => "This is the note you want to make on the user account")
+
+  # You can also create a note and save it like this:
+  #  note = Intercom::Note.new
+  #  note.body = "This is the note you want to make on the user account"
+  #  note.save
+
+  class Note < UserResource
+    ##
+    # Creates a new Note using params and saves it
+    # @see #save
+    def self.create(params)
+      requires_parameters(params, %W(body))
+      Note.new(params).save
+    end
+
+    ##
+    # Records a note on a user of your application
+    def save
+      response = Intercom.post("users/notes", to_hash)
+      self.update_from_api_response(response)
+    end
+
+    ##
+    # Set the text of the note for the user
+    def body=(body)
+      @attributes["body"] = body
+    end
+
+    def user
+      User.from_api(@attributes['user'])
+    end
+  end
+end

data/lib/intercom/unix_timestamp_unwrapper.rb

@@ -6,7 +6,7 @@ module Intercom
     end
 
     def set_time_at(attribute_name, time)
-      @attributes[attribute_name.to_s] = (time.nil?) ? nil : time.to_i
+      @attributes[attribute_name.to_s] = time.to_i
     end
   end
-end
+end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/spec/integration/intercom_api_integration_spec.rb

@@ -47,4 +47,10 @@ describe "api.intercom.io dummy data requests" do
     impression.unread_messages.must_be :>, 0
     impression.email.must_equal 'somebody@example.com'
   end
+
+  it "should create some notes" do
+    note = Intercom::Note.create(:body => "This is a note", :email => "somebody@example.com")
+    note.html.must_equal "<p>This is a note</p>"
+    note.user.email.must_equal "somebody@example.com"
+  end
 end

data/spec/unit/intercom/note_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe "/v1/notes" do
+  it "creates a note" do
+    Intercom.expects(:post).with("users/notes", {"body" => "Note to leave on user"}).returns({"html" => "<p>Note to leave on user</p>", "created_at" => 1234567890})
+    note = Intercom::Note.create("body" => "Note to leave on user")
+    note.html.must_equal "<p>Note to leave on user</p>"
+  end
+
+  it "sets/gets allowed keys" do
+    params = {"body" => "Note body", "email" => "me@example.com", :user_id => "abc123"}
+    note = Intercom::Note.new(params)
+    note.to_hash.keys.sort.must_equal params.keys.map(&:to_s).sort
+    params.keys.each do | key|
+      note.send(key).must_equal params[key]
+    end
+  end
+end

data/spec/unit/intercom/user_spec.rb

@@ -123,12 +123,6 @@ describe "Intercom::User" do
     end
   end
 
-  it "allows setting dates to nil without converting them to 0" do
-    Intercom.expects(:post).with("users", {"email" => "jo@example.com", "created_at" => nil}).returns({"email" => "jo@example.com"})
-    user = Intercom::User.create("email" => "jo@example.com", "created_at" => nil)
-    user.created_at.must_equal nil
-  end
-
   it "sets/gets rw keys" do
     params = {"email" => "me@example.com", :user_id => "abc123", "name" => "Bob Smith", "last_seen_ip" => "1.2.3.4", "last_seen_user_agent" => "ie6", "created_at" => Time.now}
     user = Intercom::User.new(params)
@@ -158,4 +152,4 @@ describe "Intercom::User" do
     Intercom::User.expects(:find).with(:user_id => "abc123")
     Intercom::User.find_by_user_id("abc123")
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -84,6 +84,7 @@ files:
 - lib/intercom.rb
 - lib/intercom/impression.rb
 - lib/intercom/message_thread.rb
+- lib/intercom/note.rb
 - lib/intercom/request.rb
 - lib/intercom/social_profile.rb
 - lib/intercom/unix_timestamp_unwrapper.rb
@@ -95,6 +96,7 @@ files:
 - spec/integration/intercom_api_integration_spec.rb
 - spec/unit/intercom/impression_spec.rb
 - spec/unit/intercom/message_thread_spec.rb
+- spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/user_collection_proxy_spec.rb
 - spec/unit/intercom/user_custom_data_spec.rb
 - spec/unit/intercom/user_resource_spec.rb
@@ -129,10 +131,10 @@ test_files:
 - spec/integration/intercom_api_integration_spec.rb
 - spec/unit/intercom/impression_spec.rb
 - spec/unit/intercom/message_thread_spec.rb
+- spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/user_collection_proxy_spec.rb
 - spec/unit/intercom/user_custom_data_spec.rb
 - spec/unit/intercom/user_resource_spec.rb
 - spec/unit/intercom/user_spec.rb
 - spec/unit/intercom_spec.rb
 - spec/unit/spec_helper.rb
-has_rdoc: