Bump version, created -> created_at, default to Time.now, and a type added.

Author: josler

changes.txt

@@ -1,4 +1,4 @@
-0.1.20
+0.2.0
 - Add UserEvents.
 
 0.1.19

lib/intercom/user_event.rb

@@ -8,17 +8,22 @@ module Intercom
   # Represents a User Event
   #
   # A user event consists of an event_name and a user the event applies to. The user is identified via email or id.
-  # Optionally, a created timestamp may be supplied.
+  # Additionally, a created timestamp is required.
   #
   # == Examples
   #
-  #  user_event = Intercom::UserEvent.create(:event_name => "funkratic", :created => Time.now, :company_id: "6", :user => current_user)
+  #  user_event = Intercom::UserEvent.create(:event_name => "post", :user => current_user, :created => Time.now)
   #
   #  You can also create an user-event and save it like this:
   #  user_event = Intercom::UserEvent.new
-  #  user_event.event_name = "funkratic"
-  #  user_event.created = Time.now
+  #  user_event.event_name = "publish-post"
   #  user_event.user = current_user
+  #  user_event.created = Time.now
+  #  user_event.metadata = {
+  #   :title => 'Gravity Review',
+  #   :link => 'https://example.org/posts/22',
+  #   :comments => 'https://example.org/posts/22/comments'
+  # }
   #  user_event.save
   #
   # == Batch
@@ -27,20 +32,23 @@ module Intercom
   # without calling .create, as follows:
   # 
   # user_event = Intercom::UserEvent.new
-  # user_event.event_name = "funkratic"
+  # user_event.event_name = "publish-post"
   # user_event.user = current_user
   #
   # Then pass them to the save_batch_events class method, along with an (optional) default user:
   #
   # Intercom::UserEvent.save_batch_events(events, default_user)
   #
   # Any events without a user will be assigned to the default_user.
+  #
+  # Note: if you do not supply a created time, the current time in UTC will be used. Events that have the same 
+  # user, name, and created time (to second granularity) may be treated as duplicates by the server.
 
   class UserEvent
     extend RequiresParameters
     include HashableObject
 
-    attr_accessor :event_name, :user, :created # required
+    attr_accessor :event_name, :user, :created_at # required
     attr_accessor :metadata, :type
 
     def initialize(attributes={})
@@ -51,8 +59,8 @@ def initialize(attributes={})
     # Creates a new User Event using params and saves it
     # @see #save
     def self.create(params)
-      params[:created] ||= Time.now
-      requires_parameters(params, %W(event_name user created))
+      params[:created_at] ||= Time.now
+      requires_parameters(params, %W(event_name user created_at))
       UserEvent.new(params).save
     end
 
@@ -84,8 +92,8 @@ def user_hash
     end
 
     def event_hash
-      event = { :event_name => event_name, :created => created.to_i }
-      event[:type] = type unless type.nil?
+      event = { :event_name => event_name, :created => created_at.nil? ?  Time.now.utc.to_i : created_at.to_i }
+      event[:type] = type.nil? ? 'event' : type
       event[:user] = user_hash unless user.nil?
       event[:metadata] = metadata unless metadata.nil?
       event

lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "0.1.20"
+  VERSION = "0.2.0"
 end

spec/integration/intercom_api_integration_spec.rb

@@ -74,7 +74,7 @@ def fixture(name)
     FakeWeb.register_uri(:get, %r(v1/users\?email=), :body => fixture('v1-user'))
     user = Intercom::User.find(:email => "[email protected]")
     FakeWeb.register_uri(:post, %r(/events), :status => ["202", "Created"])
-    Intercom::UserEvent.create(:event_name => "signup", :created => 1391691571, :user => user).event_name.must_equal "signup"
+    Intercom::UserEvent.create(:event_name => "signup", :created_at => 1391691571, :user => user).event_name.must_equal "signup"
   end
 
   it "should create batch user events" do
@@ -83,12 +83,12 @@ def fixture(name)
 
     first_event = Intercom::UserEvent.new
     first_event.event_name = "first event"
-    first_event.created = Time.now
+    first_event.created_at = Time.now
     first_event.user = user
 
     second_event = Intercom::UserEvent.new
     second_event.event_name = "second event"
-    second_event.created = Time.now
+    second_event.created_at = Time.now
 
     FakeWeb.register_uri(:post, %r(/events), :status => ["202", "Created"])
     Intercom::UserEvent.save_batch_events([first_event, second_event], user)

spec/unit/intercom/user_event_spec.rb

@@ -8,16 +8,17 @@
   it "creates a user event" do
     Intercom.expects(:post).with("/events",
                                  { :type => 'event.list',
-                                   :data => [ {:event_name => "signup", :created => created_time.to_i, :user => { :user_id => user.user_id}
+                                   :data => [ {:event_name => "signup", :created => created_time.to_i, :type => 'event', 
+                                      :user => { :user_id => user.user_id}, :metadata => {:some => "data"}
                                     }]}).returns(:status => 200)
 
-    Intercom::UserEvent.create({ :event_name => "signup", :user => user, :created => created_time })
+    Intercom::UserEvent.create({ :event_name => "signup", :user => user, :created_at => created_time, :metadata => {:some => "data"} })
   end
 
   it 'automatically adds a created time upon creation' do
     Intercom.expects(:post).with("/events",
                                  { :type => 'event.list',
-                                   :data => [ {:event_name => "sale of item", :created => Time.now.to_i, :user => { :user_id => user.user_id}
+                                   :data => [ {:event_name => "sale of item", :created => Time.now.to_i, :type => 'event', :user => { :user_id => user.user_id}
                                     }]}).returns(:status => 200)
 
     Intercom::UserEvent.create({ :event_name => "sale of item", :user => user })
@@ -26,15 +27,15 @@
   it "creates a user event with metadata" do
     Intercom.expects(:post).with("/events",
                                  { :type => 'event.list',
-                                   :data => [ {:event_name => "signup", :created => created_time.to_i, :user => { :user_id => user.user_id}, :metadata => { :something => "here"}
+                                   :data => [ {:event_name => "signup", :created => created_time.to_i, :type => 'event', :user => { :user_id => user.user_id}, :metadata => { :something => "here"}
                                     }]}).returns(:status => 200)
-    Intercom::UserEvent.create({ :event_name => "signup", :user => user, :created => created_time, :metadata => { :something => "here"} })
+    Intercom::UserEvent.create({ :event_name => "signup", :user => user, :created_at => created_time, :metadata => { :something => "here"} })
   end
 
   it 'fails when no user supplied' do
     user_event = Intercom::UserEvent.new
     user_event.event_name = "some event"
-    user_event.created = Time.now
+    user_event.created_at = Time.now
     proc { user_event.save }.must_raise ArgumentError, "Missing User"
   end
 
@@ -43,25 +44,26 @@
     let (:event1) do
       user_event = Intercom::UserEvent.new
       user_event.event_name = "first event"
-      user_event.created = Time.now
+      user_event.created_at = Time.now
       user_event.user = user
       user_event
     end
 
     let (:event2) do
       user_event = Intercom::UserEvent.new
       user_event.event_name = "second event"
-      user_event.created = Time.now
+      user_event.created_at = Time.now
       user_event
     end
 
     it 'creates batched events' do
       Intercom.expects(:post).with("/events",
                                    { :type => 'event.list',
                                      :data => [ 
-                                         {:event_name => "first event", :created => event1.created.to_i,
-                                          :user => {:user_id => user.user_id}},
-                                         {:event_name => "second event", :created => event2.created.to_i },
+                                         {:event_name => "first event", :created => event1.created_at.to_i,
+                                          :type => 'event', :user => {:user_id => user.user_id}},
+                                         {:event_name => "second event", :created => event2.created_at.to_i,
+                                          :type => 'event'},
                                      ],
                                      :user => { :user_id => user.user_id}}).returns(:status => 200)
       Intercom::UserEvent.save_batch_events([event1, event2], user)