meta_events 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 17804195b940669ecc8da4161a1f15c0027e8a61
-  data.tar.gz: 1c8769fcc9213b3314429b982b3e039dd48a2e19
-SHA512:
-  metadata.gz: 403256b58246ab75b6f935d2e3379a88b175730340c1dd9ba9fb26cae13ac0e6dd0ede0946675523ec154f8b912da898e7eb7280381a6f34c05df20845caed5b
-  data.tar.gz: 947da714267904239fb3bc510ded6ad3b8c528a4266b99c2d8db34eb5ef0a9d8fafd768f2ba090955427ffcc0b15383484d35e506a1bda0efc0d8a02c5bd4e11
+--- 
+SHA1: 
+  data.tar.gz: 463ed55b0baf280ad2558b526c2d06cd78dc5ef8
+  metadata.gz: 4883769055fc1db0206a278ba5dc382cb2c711e3
+SHA512: 
+  data.tar.gz: 9dbe5bd43bf131c893c5b799afe3838775018a7dbcb8d349214ca8c126adc78ac9befcd428cfe068d708ae146dde01b5b32e26de4605bfaadeb34a2baa33cc08
+  metadata.gz: cff9954c133137b9fa77cecec136029a0e39b76decbf17c7bc60f82189c8c67ebc8ccf0135c0faac8a4737c20a89f20feda4f4d45f74e55dbc8445b0af03735d

data/README.md

@@ -558,6 +558,11 @@ Patches are welcome. ;-)
 
 ### Times
 
+MetaEvents automatically adds a `time` property to any event you fire via `#event!`; this is so that you can take the
+set of properties in a receiver and make it asynchronous, and don't have to worry about getting the time right. You
+can override this, however, by simply passing a `:time` property with your event; it will override any time we would
+otherwise set. (You can even set `:time => nil` if you want to make sure no time is passed at all.)
+
 MetaEvents correctly converts any `Time` object you pass into the correct String format for Mixpanel (_e.g._,
 `2014-02-03T15:49:17`), converting it to UTC first. This should make your times much cleaner.
 

data/lib/meta_events/tracker.rb

@@ -343,6 +343,7 @@ module MetaEvents
     # class.
     def event!(category_name, event_name, additional_properties = { })
       event_data = effective_properties(category_name, event_name, additional_properties)
+      event_data[:properties] = { 'time' => Time.now.to_i }.merge(event_data[:properties])
 
       self.event_receivers.each do |receiver|
         receiver.track(event_data[:distinct_id], event_data[:event_name], event_data[:properties])

data/lib/meta_events/version.rb

@@ -1,3 +1,3 @@
 module MetaEvents
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/meta_events/tracker_spec.rb

@@ -66,7 +66,20 @@ describe MetaEvents::Tracker do
     next_event = calls.shift
     expect(next_event[0]).to eq(expected_distinct_id)
     expect(next_event[1]).to eq(event_name)
-    expect(next_event[2]).to eq(event_properties)
+    actual_properties = next_event[2]
+
+    filtered_actual_properties = actual_properties.dup
+
+    # handle automatic properties that we may not want to care about every time
+    %w{ip time}.each do |automatic_property_name|
+      if ! event_properties.has_key?(automatic_property_name)
+        filtered_actual_properties.delete(automatic_property_name)
+      end
+    end
+
+    expect(filtered_actual_properties).to eq(event_properties)
+
+    actual_properties
   end
 
   def tep_object(props)
@@ -148,13 +161,40 @@ EOS
     end
   end
 
-  describe "#track_event" do
+  describe "#event!" do
     it "should allow firing a valid event" do
       i = new_instance(@distinct_id, nil, :definitions => definition_set, :version => 1)
       i.event!(:foo, :bar, { })
       expect_event('xy1_foo_bar', { })
     end
 
+    describe "time support" do
+      it "should add the time to the event" do
+        start_time = Time.now.to_i
+        i = new_instance(@distinct_id, nil, :definitions => definition_set, :version => 1)
+        i.event!(:foo, :bar, { })
+        end_time = Time.now.to_i
+        actual_properties = expect_event('xy1_foo_bar', { })
+        time = actual_properties['time']
+        expect(time).to be >= start_time
+        expect(time).to be >= end_time
+      end
+
+      it "should allow overriding the time" do
+        actual_time = Time.now.to_i - 500
+        i = new_instance(@distinct_id, nil, :definitions => definition_set, :version => 1)
+        i.event!(:foo, :bar, { :time => actual_time })
+        expect_event('xy1_foo_bar', { 'time' => actual_time })
+      end
+
+      it "should allow omitting the time" do
+        actual_time = Time.now.to_i - 500
+        i = new_instance(@distinct_id, nil, :definitions => definition_set, :version => 1)
+        i.event!(:foo, :bar, { :time => nil })
+        expect_event('xy1_foo_bar', { 'time' => nil })
+      end
+    end
+
     describe "ip-address passing" do
       it "should pass through an IPv4 String IP" do
         i = new_instance(@distinct_id, "138.93.206.193", :definitions => definition_set, :version => 1)

metadata

@@ -1,98 +1,80 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: meta_events
-version: !ruby/object:Gem::Version
-  version: 1.0.1
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
 platform: ruby
-authors:
+authors: 
 - Andrew Geweke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-02-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - <=
-      - !ruby/object:Gem::Version
-        version: 4.99.99
+      - !ruby/object:Gem::Version 
+        version: "1.0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - <=
-      - !ruby/object:Gem::Version
-        version: 4.99.99
-- !ruby/object:Gem::Dependency
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    - - <
+      - !ruby/object:Gem::Version 
+        version: "4.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        version: "1.5"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.14'
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id006 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.14'
+      - !ruby/object:Gem::Version 
+        version: "2.14"
+  type: :development
+  version_requirements: *id005
 description: 
-email:
+email: 
 - ageweke@swiftype.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -120,35 +102,32 @@ files:
 - spec/meta_events/tracker_spec.rb
 - vendor/assets/javascripts/meta_events.js.erb
 homepage: http://www.github.com/swiftype/meta_events
-licenses:
+licenses: 
 - MIT
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id006
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id006
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Structured, documented, powerful event emitting library for Mixpanel and
-  other such systems.
-test_files:
+summary: Structured, documented, powerful event emitting library for Mixpanel and other such systems.
+test_files: 
 - spec/meta_events/controller_methods_and_helpers_spec.rb
 - spec/meta_events/definition/category_spec.rb
 - spec/meta_events/definition/definition_set_spec.rb
 - spec/meta_events/definition/event_spec.rb
 - spec/meta_events/definition/version_spec.rb
 - spec/meta_events/tracker_spec.rb
-has_rdoc: