meta_events 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  data.tar.gz: 463ed55b0baf280ad2558b526c2d06cd78dc5ef8
-  metadata.gz: 4883769055fc1db0206a278ba5dc382cb2c711e3
-SHA512: 
-  data.tar.gz: 9dbe5bd43bf131c893c5b799afe3838775018a7dbcb8d349214ca8c126adc78ac9befcd428cfe068d708ae146dde01b5b32e26de4605bfaadeb34a2baa33cc08
-  metadata.gz: cff9954c133137b9fa77cecec136029a0e39b76decbf17c7bc60f82189c8c67ebc8ccf0135c0faac8a4737c20a89f20feda4f4d45f74e55dbc8445b0af03735d
+---
+SHA1:
+  metadata.gz: b0e91bff1639de3f7c06814202408e65284d049e
+  data.tar.gz: 44e8e53c21fef0ed5d59264359e695f8f63735a9
+SHA512:
+  metadata.gz: 347f0e4b5bb972dc9eb0ea40f636edc5a73c6f956def29db094beeb3c906d9bc88e58557163a40f114946e755f47e36d901d65ed9ec2ed02a5aa196fe0eb2003
+  data.tar.gz: 4afaffbe07364ff7f2c8601108c5e440dd0dccd69c5d46233671a076710b1d4998e44055beba7525b1a05ccad05352aec231b29458a4751cb6acd66b521e66ab

data/CHANGES.md

@@ -0,0 +1,7 @@
+# `meta_events` Changelog
+
+## 1.0.3,
+
+* Fixed an issue where the `TestReceiver`'s `Rails.logger` reference could happen before `Rails.logger` was actually loaded, causing an exception. (Thanks to [Jesse Rusak](https://github.com/jder)!)
+* Fixed a minor documentation bug (Thanks to [Jesse Rusak](https://github.com/jder)!)
+* Added Changelog.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Andrew Geweke
+Copyright (c) 2014 Swiftype, Inc.
 
 MIT License
 

data/README.md

@@ -11,6 +11,8 @@ particularly dependent on exact Ruby versions, and should be compatible with a b
 
 Current build status: ![Current Build Status](https://api.travis-ci.org/swiftype/meta_events.png?branch=master)
 
+Brought to you by the folks at [Swiftype](https://www.swiftype.com/). First version written by [Andrew Geweke](https://www.github.com/ageweke).
+
 ### Background
 
 Sending user-centric events to (_e.g._) Mixpanel is far from difficult; it's a single method call. However, in a
@@ -90,8 +92,8 @@ uses this for doing geolocation of users:
 
     class ApplicationController < ActionController::Base
       ...
-      def event_tracker
-        @event_tracker ||= MetaEvents::Tracker.new(current_user.try(:id), request.remote_ip)
+      def meta_events_tracker
+        @meta_events_tracker ||= MetaEvents::Tracker.new(current_user.try(:id), request.remote_ip)
       end
       ...
     end
@@ -102,7 +104,7 @@ Now, from the controller, we can fire an event and pass a couple of properties:
       ...
       def create
         ...
-        event_tracker.event!(:user, :signed_up, { :user_gender => @new_user.gender, :user_age => @new_user.age })
+        meta_events_tracker.event!(:user, :signed_up, { :user_gender => @new_user.gender, :user_age => @new_user.age })
         ...
       end
       ...
@@ -114,7 +116,7 @@ _event receivers_.
 ### Hooking Up Mixpanel and a Test Receiver
 
 An _event receiver_ is any object that responds to a method `#track(distinct_id, event_name, event_properties)`, where
-`distinct_id` is the distinct ID of the user, `event_name` is a `String` and `event_name` is a Hash mapping `String`
+`distinct_id` is the distinct ID of the user, `event_name` is a `String` and `event_properties` is a Hash mapping `String`
 property names to simple scalar values &mdash; `true`, `false`, `nil`, numbers (all `Numeric`s, including both
 integers and floating-point numbers, are supported), `String`s (and `Symbol`s will be converted to `String`s
 transparently), and `Time` objects.
@@ -372,7 +374,7 @@ You could add these to every single call to `#event!`, but MetaEvents has a bett
 
     class ApplicationController < ActionController::Base
       ...
-      def event_tracker
+      def meta_events_tracker
         implicit_properties = { }
         if current_user
           implicit_properties.merge!(
@@ -380,8 +382,8 @@ You could add these to every single call to `#event!`, but MetaEvents has a bett
             :user_age => current_user.age
           )
         end
-        @event_tracker ||= MetaEvents::Tracker.new(current_user.try(:id), request.remote_ip,
-                                                   :implicit_properties => implicit_properties)
+        @meta_events_tracker ||= MetaEvents::Tracker.new(current_user.try(:id), request.remote_ip,
+                                                        :implicit_properties => implicit_properties)
       end
       ...
     end
@@ -398,7 +400,7 @@ properties that are defined on it. For example, imagine we have an event trigger
 another user. We have at least three entities: the 'from' user, the 'to' user, and the message itself. If we really
 want to instrument this event properly, we're going to want something like this:
 
-    event_tracker.event!(:user, :sent_message, {
+    meta_events_tracker.event!(:user, :sent_message, {
       :from_user_country => from_user.country,
       :from_user_state => from_user.state,
       :from_user_postcode => from_user.postcode,
@@ -462,7 +464,7 @@ automatically expanded and their names prefixed by the outer hash key. So let's
 
 Now, we can pass the exact same set of properties as the above example, by simply doing:
 
-    event_tracker.event!(:user, :sent_message, {
+    meta_events_tracker.event!(:user, :sent_message, {
       :from_user => from_user.to_event_properties,
       :to_user => to_user.to_event_properties,
       :message => message.to_event_properties
@@ -476,7 +478,7 @@ And &mdash; tah-dah! &mdash; MetaEvents supports this syntax automatically. If y
 that object defines a method called `#to_event_properties`, then it will be called automatically, and replaced.
 Our code now looks like:
 
-    event_tracker.event!(:user, :sent_message, { :from_user => from_user, :to_user => to_user, :message => message })
+    meta_events_tracker.event!(:user, :sent_message, { :from_user => from_user, :to_user => to_user, :message => message })
 
 ### How to Take the Most Advantage
 

data/lib/meta_events/test_receiver.rb

@@ -9,7 +9,7 @@ module MetaEvents
   # This object is useful for watching and debugging events in development environments.
   class TestReceiver
     def initialize(target = nil, &block)
-      @target = target || block || ::Rails.logger
+      @target = target || block || lambda { |string| ::Rails.logger.info(string) }
     end
 
     def track(distinct_id, event_name, properties)

data/lib/meta_events/version.rb

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

metadata

@@ -1,82 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: meta_events
-version: !ruby/object:Gem::Version 
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.0.3
 platform: ruby
-authors: 
+authors:
 - Andrew Geweke
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-02-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !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.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.99.99
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.5"
+  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
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id006 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !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'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.14"
+  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'
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
 description: 
-email: 
+email:
 - ageweke@swiftype.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .travis.yml
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -102,29 +121,31 @@ 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: 
-  - *id006
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id006
+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'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.1
 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