meta_events 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,15 @@
---- 
-SHA1: 
-  metadata.gz: c8e90b6eab418b987148fddd9cef0821956dc09f
-  data.tar.gz: eba083b1ffef6f56b1775cc28ac55bd94e5c7dc9
-SHA512: 
-  metadata.gz: f2e1dbafa769577654782ecdfc7c1a7f8d0fb4b06a983b10677710bec4e85a79164412bcabc7af0ed77f8941588d4b9d40cdbe3c5881b3dba1f91a87bbf4e1e1
-  data.tar.gz: 39f251715f387ad67b30c8bee7ba12e9fa8be416e95c9309cfe18b9c57446721ef06dffae1ee3de84a167cd9685d7a0bf61a9bb8cafeca16b667f477f4f47c07
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Nzk0YTYzYzQ3ZjRhZjEwZTY2MGViNDllNzIzNzY1ZTljYjY4NzIzZg==
+  data.tar.gz: !binary |-
+    MTkyYmZjNTA4ZWUwYTQzNmE5NDE5NGQ2MjgyMDA4ODI5Y2I1MzQ2ZA==
+SHA512:
+  metadata.gz: !binary |-
+    MzI3NjNhNjQ1NWY2ZDliNDNkODdkYWM0Yzk5OTQyZTc4NjQ3MWU3YmIxODc4
+    OTcwOGNlOGQ4MTJiNTRhY2ZjNjIxZjQ2ZmJhNjBkNGJkNDE2ZmUxZTQ3NTJk
+    M2E5ODAzZmE3ZjNjNzc2ZmUzMTkxZTgxYmRlMWNiMmI5ZTYzMmE=
+  data.tar.gz: !binary |-
+    YTM3ODBmYmQyMDNiOWI5MzI5ZjM2OGY4ZThmMjNjZmMzMmMyNDBkOTBjYWNi
+    YzYyNTZmNjY2MTg5ODI2YmI5M2ZkNjUxYmM3ODg1ODVjODZhNDAyM2EyZDM4
+    ZDg0NmQ2ZDQ5ZjM0YTAxZDA1MDNjNWNhYWY2ZWRlMzFkZTUyZWQ=

data/.travis.yml

@@ -1,6 +1,6 @@
 rvm:
-    - "2.1.0"
+    - "2.1.1"
     - "2.0.0"
     - "1.9.3"
     - "1.8.7"
-    - "jruby-1.7.9"
+    - "jruby-1.7.11"

data/CHANGES.md

@@ -1,5 +1,15 @@
 # `meta_events` Changelog
 
+### 1.1.1, 26 May 2014
+
+* 1.1.0 was accidentally released with a bad dependency that prevented it from installing against anything that used
+  ActiveSupport >= 4.0. This corrects that error.
+* Documented how to make MetaEvents work with background systems like Resque or Sidekiq to make event dispatch
+  asynchronous.
+* Documented that the `mixpanel-ruby` gem is still required to work with Mixpanel server-side, and that the Mixpanel
+  JavaScript code is still required to work with Mixpanel on the front end.
+* Changed Travis configuration to use Ruby 2.1.1 (vs. 2.1.0) and JRuby 1.7.11 (vs. 1.7.9).
+
 ## 1.1.0, 25 May 2014
 
 * Support for customizing the event names to Mixpanel using any algorithm you want (`:external_name` in `MetaEvents::Tracker#initialize` or `MetaEvents::Tracker.default_external_name`), or by overriding them on an `Event`-by-`Event` basis (`:external_name` in the DSL on an `Event`). Many thanks to [Aaron Lerch](https://github.com/aaronlerch) for the awesome code and responsiveness!

data/README.md

@@ -52,6 +52,9 @@ use a powerful mechanism to fire front-end events in any way you want.
 
 Let's get started. We'll assume we're working in a Rails project, although MetaEvents has no dependencies on Rails or any other particular framework. We'll also assume you've installed the MetaEvents gem (ideally via your `Gemfile`).
 
+**Note**: You will also need to provide whatever API your analytics system uses; for example, in the case of Mixpanel,
+you must also add `gem mixpanel-ruby` to your `Gemfile`.
+
 ### Declaring Events
 
 First, let's declare an event that we want to fire. Create `config/meta_events.rb` (MetaEvents automatically
@@ -170,6 +173,11 @@ the use of Rails (because `MetaEvents::ControllerMethods` is intended for use wi
 `MetaEvents::Helpers` is intended for use with `ActionView`), although the techniques are generally applicable and
 easy enough to use with any framework.
 
+**Note**: Again, because MetaEvents does not directly require any one user-centric analytics system, you must make sure
+the JavaScript API to whatever system you're using is loaded, too. So, for example, if you're using Mixpanel, make sure
+the JavaScript code Mixpanel provides you to use its API is loaded on your page _as well as_ the MetaEvents JavaScript
+code.
+
 #### Auto-Tracking
 
 Auto-tracking is the easiest way of triggering front-end events. MetaEvents provides a Rails helper method that adds
@@ -340,7 +348,7 @@ There are a few situations where you need to take special care, however:
   way to do this, as well as using something like nginx's `ngx_http_userid_module`.
   (Note that Mixpanel has facilities to do this automatically; however, it uses cookies set on their
   domain, which means you can't read them, which limits it unacceptably — server-side code and even your own
-  Javascript will be unable to use this ID.)
+  Javascript will be unable to use this ID.) If you do this, take a look at [`web_server_uid`](https://github.com/swiftype/web_server_uid), a gem that makes manipulating the resulting IDs vastly easier in Ruby.
 * **What do I do when a user logs in?** Typically, you simply want to switch completely from using their old
   (cookie-based) unique ID to using the primary key of your `users` table (or whatever you use for tracking logged-in
   users). This may seem counterintuitive, but it makes sense, particularly in broad consumer applications: until
@@ -493,6 +501,31 @@ to you.
 
 A few things before we're done:
 
+### Performance and Asynchronousness
+
+When deploying Mixpanel or other such systems in a live application, you very often want to dispatch event reporting
+in the background, so that any slowdown in Mixpanel's servers doesn't slow down your application (or, in the worst
+case, bring it down entirely). Typically, this is done using something like [Resque](https://github.com/resque/resque),
+[Sidekiq](http://sidekiq.org/), or another queue-based system. There are literally dozens of these systems available
+for Ruby, and it's highly likely that your codebase either uses one already or will soon. Additionally, many users
+layer additional features like logging, durability, or other infrastructure services on top of the base functionality
+of these packages.
+
+Because there is such a wide variety of these systems available, MetaEvents does not _directly_ provide support for
+them — doing so would be a great deal of effort, and yet still unlikely to satisfy most users. Instead,
+MetaEvents makes it very easy to use any package you want:
+
+    class MyEventReceiver
+      def track(distinct_id, event_name, event_properties)
+        # Call Resque, Sidekiq, or anything else you want here; enqueue a job that, when run, will call:
+        #   Mixpanel::Tracker.new($my_mixpanel_api_key).track(distinct_id, event_name, event_properties)
+      end
+    end
+
+    MetaEvents::Tracker.default_event_receivers << MyEventReceiver.new
+
+Voilà &mdash; asynchronous event tracking.
+
 ### Mixpanel, Aliasing, and People
 
 MetaEvents is _not_ intended as a complete superset of a backend analytics library (like Mixpanel) &mdash; there are

data/lib/meta_events/version.rb

@@ -1,3 +1,3 @@
 module MetaEvents
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,80 +1,98 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: meta_events
-version: !ruby/object:Gem::Version 
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.1.1
 platform: ruby
-authors: 
+authors:
 - Andrew Geweke
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-05-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+      - !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: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "3.0"
-    - - <
-      - !ruby/object:Gem::Version 
-        version: "4.0"
+  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.99.99
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  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"
+      - !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: 
+  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"
+      - !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: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGES.md
@@ -103,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