mixpanel 3.0.2 → 3.1.0

data/README.md

@@ -9,6 +9,7 @@
 - [Usage] (#usage)
   - [Initialize Mixpanel] (#initialize-mixpanel)
 	- [Track Events Directly](#track-events-directly)
+	- [Pixel Based Event Tracking](#pixel-based-event-tracking)
 	- [Import Events](#import-events)
 	- [Set Person Attributes Directly](#set-person-attributes-directly)
 	- [Increment Person Attributes Directly](#increment-person-attributes-directly)
@@ -188,6 +189,25 @@ Example:
 @mixpanel.track 'Purchased credits', { :number => 5, 'First Time Buyer' => true }
 ```
 
+### Pixel Based Event Tracking
+
+```ruby
+@mixpanel.tracking_pixel "Opened Email", { :distinct_id => "bob@email.com", :campaign => "Retarget" }
+```
+
+This allows to track events just by loading a pixel. It's usually useful for tracking opened emails.
+You've got to specify your own `distinct_id` as it won't be able to retrieve it from cookies.
+
+And you can use it in your views with an image_tag helper:
+```ruby
+image_tag @mixpanel.tracking_pixel("Opened Email", { :distinct_id => "bob@email.com", :campaign => "Retarget" }), :width => 1, :height => 1
+```
+
+
+Mixpanel docs: https://mixpanel.com/docs/api-documentation/pixel-based-event-tracking
+
+
+
 ### Import Events
 
 ```ruby
@@ -377,3 +397,4 @@ end
 * [GBH](https://github.com/GBH)
 * [Goalee](https://github.com/Goalee)
 * [Ahmed Belal](https://github.com/AhmedBelal)
+* [Esteban Pastorino](https://github.com/kitop)

data/lib/mixpanel/event.rb

@@ -6,6 +6,10 @@ module Mixpanel::Event
   def track(event, properties={}, options={})
     track_event event, properties, options, TRACK_URL
   end
+
+  def tracking_pixel(event, properties={}, options={})
+    build_url event, properties, options.merge(:url => TRACK_URL, :img => true)
+  end
   
   def import(event, properties={}, options={})
     track_event event, properties, options, IMPORT_URL
@@ -19,9 +23,7 @@ module Mixpanel::Event
   
   def track_event(event, properties, options, default_url)
     options.reverse_merge! :url => default_url, :async => @async, :api_key => @api_key
-    data = build_event event, track_properties(properties)
-    url = "#{options[:url]}?data=#{encoded_data(data)}"
-    url += "&api_key=#{options[:api_key]}" if options[:api_key].present?
+    url = build_url event, properties, options
     parse_response request(url, options[:async])
   end
   
@@ -38,4 +40,12 @@ module Mixpanel::Event
   def build_event(event, properties)
     { :event => event, :properties => properties_hash(properties, EVENT_PROPERTIES) }
   end
-end
+
+  def build_url event, properties, options
+    data = build_event event, track_properties(properties)
+    url = "#{options[:url]}?data=#{encoded_data(data)}"
+    url << "&api_key=#{options[:api_key]}" if options[:api_key].present?
+    url << "&img=1" if options[:img]
+    url
+  end
+end

data/mixpanel.gemspec

@@ -2,7 +2,7 @@ files = ['README.md', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/**/
 
 spec = Gem::Specification.new do |s|
   s.name = "mixpanel"
-  s.version = "3.0.2"
+  s.version = "3.1.0"
   s.rubyforge_project = "mixpanel"
   s.description = "Simple lib to track events in Mixpanel service. It can be used in any rack based framework."
   s.author = "Alvaro Gil"

data/spec/mixpanel/tracker_spec.rb

@@ -30,6 +30,16 @@ describe Mixpanel::Tracker do
         @mixpanel.track('Sign up', { :likeable => true }, { :api_key => 'asdf' }).should == true
       end
     end
+
+    context "Tracking pixel" do
+      it "should return a URL" do
+        @mixpanel.tracking_pixel("Sign up").should be_a(String)
+      end
+
+      it "should include img=1" do
+        @mixpanel.tracking_pixel("Sign up").should match(/&img=1/)
+      end
+    end
     
     context "Importing events" do
       it "should import simple events" do

metadata

@@ -1,134 +1,172 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mixpanel
-version: !ruby/object:Gem::Version
-  version: 3.0.2
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  hash: 3
+  prerelease: false
+  segments: 
+  - 3
+  - 1
+  - 0
+  version: 3.1.0
 platform: ruby
-authors:
+authors: 
 - Alvaro Gil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-11-13 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &2153672300 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2153672300
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rack
-  requirement: &2153671860 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2153671860
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: escape
-  requirement: &2153671440 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2153671440
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: active_support
-  requirement: &2153671020 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2153671020
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &2153670600 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2153670600
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: rack-test
-  requirement: &2153670180 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2153670180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: fakeweb
-  requirement: &2153669760 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2153669760
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: &2153669340 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2153669340
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &2153668920 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
   prerelease: false
-  version_requirements: *2153668920
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &2160944480 !ruby/object:Gem::Requirement
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2160944480
-description: Simple lib to track events in Mixpanel service. It can be used in any
-  rack based framework.
+  version_requirements: *id010
+description: Simple lib to track events in Mixpanel service. It can be used in any rack based framework.
 email: zevarito@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.md
-files:
+files: 
 - README.md
 - LICENSE
 - Rakefile
@@ -144,28 +182,39 @@ files:
 - lib/mixpanel/subprocess.rb
 - lib/mixpanel/tracker.rb
 - lib/mixpanel.rb
+has_rdoc: true
 homepage: http://github.com/zevarito/mixpanel
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: mixpanel
-rubygems_version: 1.8.15
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Supports direct request api and javascript requests through a middleware.
 test_files: []
+