mixpanel-ruby 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9e1a1a4366eebfc28e385aafb1a74df684b02d4
-  data.tar.gz: 2569a46638a4c168e6766ca21c3ce54adf5d9ee4
+  metadata.gz: ffb9a7cb934ae663374cf0850ba2049e77ad6844
+  data.tar.gz: 577cf98aaeb43e608a7d50e0b37d49b2437dd298
 SHA512:
-  metadata.gz: 2e759bb1cd88260c95e1d5edf2efd61bcf284984f3595c5e1b3126b3db428db85806942bf09d73e2974cd0da8b292d8c8edd9315ad2cb81a9456bfe555049ee6
-  data.tar.gz: 9d53eccb3b1cee24a2dbda7cf16719feb5933002bf394079050bd10882493ecd53f93263e489df28a049e649344f5cfc992cce10914aa24417a958e342606020
+  metadata.gz: 3e768a749828219fd77e9d3b4c29810d2f92a47b6ec8d4f6e0ab92f977d6f540b1c57bba0881f73d18fb59073a1e97da8688fe0a3cc8d4d10aefe6825aa36870
+  data.tar.gz: c19c92bcbb59663e617ba24eb6df74662e67e08605cbb535040185d5d66c28206c70d5f34268d1e98a0e98558707772dc338f57c61f1bc6cfcd0a127bc7bd9a4

data/Readme.rdoc

@@ -13,7 +13,7 @@ updates to \Mixpanel from your ruby applications.
 
     require 'mixpanel-ruby'
 
-    tracker = Mixpanel::Tracker.new(YOUR_TOKEN)
+    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
 
     # Track an event on behalf of user "User1"
     tracker.track('User1', 'A Mixpanel Event')
@@ -49,6 +49,12 @@ In particular, for Rails apps, the following projects are currently actively mai
 
 == Changes
 
+== 2.2.0
+* Add Mixpanel::ErrorHandler to simplify custom error handling.
+* Modify Mixpanel::People#fix_property_dates to handle ActiveSupport::TimeWithZone.
+* Increase open and ssl timeouts from 2s to 10s.
+* Fix Doc inconsistancy: always pass token on Mixpanel::tracker.new.
+
 == 2.1.0
 * Add Mixpanel::Tracker#generate_tracking_url, which generates {pixel tracking urls}[https://mixpanel.com/docs/api-documentation/pixel-based-event-tracking].
 * Rescue JSONErrors in the consumer and raise Mixpanel::ServerError in Mixpanel::Consumer#send!.

data/lib/mixpanel-ruby/consumer.rb

@@ -1,17 +1,8 @@
 require 'base64'
-require 'net/https'
 require 'json'
+require 'net/https'
 
 module Mixpanel
-  class MixpanelError < StandardError
-  end
-  
-  class ConnectionError < MixpanelError
-  end
-  
-  class ServerError < MixpanelError
-  end
-
   @@init_http = nil
 
   # This method exists for backwards compatibility. The preferred
@@ -44,7 +35,7 @@ module Mixpanel
   # either by passing in an argument with a #send! method when you construct
   # the tracker, or just passing a block to Mixpanel::Tracker.new
   #
-  #    tracker = Mixpanel::Tracker.new(MY_TOKEN) do |type, message|
+  #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN) do |type, message|
   #        # type will be one of :event, :profile_update or :import
   #        @kestrel.set(ANALYTICS_QUEUE, [type, message].to_json)
   #    end
@@ -134,10 +125,10 @@ module Mixpanel
 
       client = Net::HTTP.new(uri.host, uri.port)
       client.use_ssl = true
-      client.open_timeout = 2
+      client.open_timeout = 10
       client.continue_timeout = 10
       client.read_timeout = 10
-      client.ssl_timeout = 2
+      client.ssl_timeout = 10
 
       Mixpanel.with_http(client)
 
@@ -157,7 +148,7 @@ module Mixpanel
   #
   #    buffered_consumer = Mixpanel::BufferedConsumer.new
   #    begin
-  #        buffered_tracker = Mixpanel::Tracker.new(YOUR_TOKEN) do |type, message|
+  #        buffered_tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN) do |type, message|
   #            buffered_consumer.send!(type, message)
   #        end
   #        # Do some tracking here

data/lib/mixpanel-ruby/error.rb

@@ -0,0 +1,46 @@
+module Mixpanel
+
+  # Mixpanel specific errors that are thrown in the gem.
+  # In the default consumer we catch all errors and raise
+  # Mixpanel specific errors that can be handled using a
+  # custom error handler.
+  class MixpanelError < StandardError
+  end
+  
+  class ConnectionError < MixpanelError
+  end
+  
+  class ServerError < MixpanelError
+  end
+
+
+  # The default behavior of the gem is to silence all errors
+  # thrown in the consumer.  If you wish to handle MixpanelErrors
+  # yourself you can pass an instance of a class that extends
+  # Mixpanel::ErrorHandler to Mixpanel::Tracker on initialize.
+  #
+  #    require 'logger'
+  #
+  #    class MyErrorHandler < Mixpanel::ErrorHandler
+  #
+  #      def initialize
+  #        @logger = Logger.new('mylogfile.log')
+  #        @logger.level = Logger::ERROR
+  #      end
+  #    
+  #      def handle(error)
+  #        logger.error "#{error.inspect}\n Backtrace: #{error.backtrace}"
+  #      end
+  #
+  #    end
+  #
+  #    my_error_handler = MyErrorHandler.new
+  #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN, my_error_handler)
+  class ErrorHandler
+
+    # Override #handle to customize error handling
+    def handle(error)
+      false
+    end
+  end
+end

data/lib/mixpanel-ruby/events.rb

@@ -1,6 +1,8 @@
-require 'mixpanel-ruby/consumer'
 require 'time'
 
+require 'mixpanel-ruby/consumer'
+require 'mixpanel-ruby/error'
+
 module Mixpanel
 
   # Handles formatting Mixpanel event tracking messages
@@ -8,7 +10,7 @@ module Mixpanel
   # is a subclass of this class, and the best way to
   # track events is to instantiate a Mixpanel::Tracker
   #
-  #     tracker = Mixpanel::Tracker.new # Has all of the methods of Mixpanel::Event
+  #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN) # Has all of the methods of Mixpanel::Event
   #     tracker.track(...)
   #
   class Events
@@ -18,10 +20,11 @@ module Mixpanel
     # is to use Mixpanel::Tracker
     #
     #     # tracker has all of the methods of Mixpanel::Events
-    #     tracker = Mixpanel::Tracker.new(...)
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
-    def initialize(token, &block)
+    def initialize(token, error_handler=nil, &block)
       @token = token
+      @error_handler = error_handler || ErrorHandler.new
 
       if block
         @sink = block
@@ -37,7 +40,7 @@ module Mixpanel
     # describing that event. Properties are provided as a Hash with
     # string keys and strings, numbers or booleans as values.
     #
-    #     tracker = Mixpanel::Tracker.new
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
     #     # Track that user "12345"'s credit card was declined
     #     tracker.track("12345", "Credit Card Declined")
@@ -68,7 +71,8 @@ module Mixpanel
       ret = true
       begin
         @sink.call(:event, message.to_json)
-      rescue MixpanelError
+      rescue MixpanelError => e
+        @error_handler.handle(e)
         ret = false
       end
 
@@ -83,7 +87,7 @@ module Mixpanel
     # we pass the time of the method call as the time the event occured, if you
     # wish to override this pass a timestamp in the properties hash.
     #
-    #     tracker = Mixpanel::Tracker.new
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
     #     # Track that user "12345"'s credit card was declined
     #     tracker.import("API_KEY", "12345", "Credit Card Declined")
@@ -118,7 +122,8 @@ module Mixpanel
       ret = true
       begin
         @sink.call(:import, message.to_json)
-      rescue MixpanelError
+      rescue MixpanelError => e
+        @error_handler.handle(e)
         ret = false
       end
 

data/lib/mixpanel-ruby/people.rb

@@ -1,8 +1,10 @@
-require 'mixpanel-ruby/consumer'
-require 'json'
 require 'date'
+require 'json'
 require 'time'
 
+require 'mixpanel-ruby/consumer'
+require 'mixpanel-ruby/error'
+
 module Mixpanel
 
   # Handles formatting Mixpanel profile updates and
@@ -17,11 +19,12 @@ module Mixpanel
     # You likely won't need to instantiate instances of Mixpanel::People
     # directly. The best way to get an instance of Mixpanel::People is
     #
-    #     tracker = Mixpanel::Tracker.new(...)
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #     tracker.people # An instance of Mixpanel::People
     #
-    def initialize(token, &block)
+    def initialize(token, error_handler=nil, &block)
       @token = token
+      @error_handler = error_handler || ErrorHandler.new
 
       if block
         @sink = block
@@ -35,7 +38,7 @@ module Mixpanel
     # keys, and values that are strings, numbers, booleans, or
     # DateTimes
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #    # Sets properties on profile with id "1234"
     #    tracker.people.set("1234", {
     #        'company' => 'Acme',
@@ -61,7 +64,7 @@ module Mixpanel
     # in the profile. That means you can call set_once many times
     # without changing an original value.
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #    tracker.people.set_once("12345", {
     #        'First Login Date': DateTime.now
     #    });
@@ -83,7 +86,7 @@ module Mixpanel
     # property. If no property exists with a given name, the value
     # will be added to zero.
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #    tracker.people.increment("12345", {
     #        'Coins Spent' => 7,
     #        'Coins Earned' => -7, # Use a negative number to subtract
@@ -104,7 +107,7 @@ module Mixpanel
     # by one. Calling #plus_one(distinct_id, property_name) is the same as calling
     # #increment(distinct_id, {property_name => 1})
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #    tracker.people.plus_one("12345", "Albums Released")
     #
     def plus_one(distinct_id, property_name, ip=nil, optional_params={})
@@ -115,7 +118,7 @@ module Mixpanel
     # If the given properties don't exist, a new list-valued
     # property will be created.
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #    tracker.people.append("12345", {
     #        'Login Dates' => DateTime.now,
     #        'Alter Ego Names' => 'Ziggy Stardust'
@@ -138,7 +141,7 @@ module Mixpanel
     # property. After a union, every element in the list associated
     # with a property will be unique.
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #    tracker.people.union("12345", {
     #        'Levels Completed' => ['Suffragette City']
     #    });
@@ -156,7 +159,7 @@ module Mixpanel
 
     # Removes properties and their values from a profile.
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
     #    # removes a single property and its value from a profile
     #    tracker.people.unset("12345", "Overdue Since")
@@ -178,7 +181,7 @@ module Mixpanel
     # Records a payment to you to a profile. Charges recorded with
     # #track_charge will appear in the \Mixpanel revenue report.
     #
-    #    tracker = Mixpanel::Tracker.new
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
     #    # records a charge of $25.32 from user 12345
     #    tracker.people.track_charge("12345", 25.32)
@@ -228,7 +231,8 @@ module Mixpanel
       ret = true
       begin
         @sink.call(:profile_update, message.to_json)
-      rescue MixpanelError
+      rescue MixpanelError => e
+        @error_handler.handle(e)
         ret = false
       end
 
@@ -237,10 +241,12 @@ module Mixpanel
 
     private
 
-    def fix_property_dates(h)
-      h.inject({}) do |ret,(k,v)|
-        v = v.respond_to?(:new_offset) ? v.new_offset('0') : v
-        ret[k] = v.respond_to?(:strftime) ? v.strftime('%Y-%m-%dT%H:%M:%S') : v
+    def fix_property_dates(properties)
+      properties.inject({}) do |ret, (key, value)|
+        value = value.respond_to?(:new_offset) ? value.new_offset('0') : value
+        value = value.respond_to?(:utc) ? value.utc : value  # Handle ActiveSupport::TimeWithZone
+
+        ret[key] = value.respond_to?(:strftime) ? value.strftime('%Y-%m-%dT%H:%M:%S') : value
         ret
       end
     end

data/lib/mixpanel-ruby/tracker.rb

@@ -42,10 +42,10 @@ module Mixpanel
     # If a block is provided, it is passed a type (one of :event or :profile_update)
     # and a string message. This same format is accepted by Mixpanel::Consumer#send!
     # and Mixpanel::BufferedConsumer#send!
-    def initialize(token, &block)
-      super(token, &block)
+    def initialize(token, error_handler=nil, &block)
+      super(token, error_handler, &block)
       @token = token
-      @people = People.new(token, &block)
+      @people = People.new(token, error_handler, &block)
     end
 
     # A call to #track is a report that an event has occurred.  #track
@@ -55,7 +55,7 @@ module Mixpanel
     # as a Hash with string keys and strings, numbers or booleans as
     # values.
     #
-    #     tracker = Mixpanel::Tracker.new
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
     #     # Track that user "12345"'s credit card was declined
     #     tracker.track("12345", "Credit Card Declined")
@@ -79,7 +79,7 @@ module Mixpanel
     # as a Hash with string keys and strings, numbers or booleans as
     # values.
     #
-    #     tracker = Mixpanel::Tracker.new
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
     #     # Import event that user "12345"'s credit card was declined
     #     tracker.import("API_KEY", "12345", "Credit Card Declined", {
@@ -125,7 +125,8 @@ module Mixpanel
       ret = true
       begin
         consumer.send!(:event, message.to_json)
-      rescue MixpanelError
+      rescue MixpanelError => e
+        @error_handler.handle(e)
         ret = false
       end
 
@@ -140,7 +141,7 @@ module Mixpanel
     # strings, numbers or booleans as values. For more information, please see:
     # https://mixpanel.com/docs/api-documentation/pixel-based-event-tracking
     #
-    #     tracker = Mixpanel::Tracker.new
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
     #
     #     # generate pixel tracking url in order to track that user
     #     # "12345"'s credit card was declined

data/lib/mixpanel-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mixpanel
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/mixpanel-ruby.gemspec

@@ -14,6 +14,7 @@ spec = Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
+  spec.add_development_dependency 'activesupport', '~> 4.0'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 1.18'

data/spec/mixpanel-ruby/consumer_spec.rb

@@ -1,6 +1,7 @@
+require 'base64'
 require 'spec_helper'
 require 'webmock'
-require 'base64'
+
 require 'mixpanel-ruby/consumer'
 
 describe Mixpanel::Consumer do

data/spec/mixpanel-ruby/error_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+require 'mixpanel-ruby/error.rb'
+require 'mixpanel-ruby/events.rb'
+
+class TestErrorHandler < Mixpanel::ErrorHandler
+  def initialize(log)
+    @log = log
+  end
+
+  def handle(error)
+    @log << error.to_s
+  end
+end
+
+describe Mixpanel::ErrorHandler do
+  it "should respond to #handle`" do
+    error_handler = Mixpanel::ErrorHandler.new
+    expect(error_handler.respond_to?(:handle)).to be true
+  end
+
+  context 'without a customer error_handler' do
+
+    before(:each) do
+      @tracker = Mixpanel::Tracker.new('TEST TOKEN') do |type, message|
+        raise Mixpanel::MixpanelError
+      end
+    end
+
+    it "should silence errors in track calls" do
+      expect {
+        expect(@tracker.track('TEST ID', 'Test Event')).to be false
+      }.to_not raise_error
+    end
+
+    it "should handle errors in import calls" do
+      expect {
+        expect(@tracker.import('TEST API KEY', 'TEST DISTINCT_ID', 'Test Event')).to be false
+      }.to_not raise_error
+    end
+
+    it "should handle errors in people calls" do
+      expect {
+        expect(@tracker.people.set('TEST ID', {})).to be false
+      }.to_not raise_error
+    end
+
+  end
+
+  context 'with a custom error_handler' do
+
+    before(:each) do
+      @log = []
+      @error_handler = TestErrorHandler.new(@log)
+      @tracker = Mixpanel::Tracker.new('TEST TOKEN', @error_handler) do |type, message|
+        raise Mixpanel::MixpanelError
+      end
+    end
+
+    it "should handle errors in track calls" do
+      @tracker.track('TEST ID', 'Test Event', {})
+      expect(@log).to eq(['Mixpanel::MixpanelError'])
+    end
+
+    it "should handle errors in import calls" do
+      @tracker.import('TEST API KEY', 'TEST DISTINCT_ID', 'Test Event')
+      expect(@log).to eq(['Mixpanel::MixpanelError'])
+    end
+
+    it "should handle errors in people calls" do
+      @tracker.people.set('TEST ID', {})
+      expect(@log).to eq(['Mixpanel::MixpanelError'])
+    end
+
+  end
+end

data/spec/mixpanel-ruby/events_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
+require 'time'
+
 require 'mixpanel-ruby/events.rb'
 require 'mixpanel-ruby/version.rb'
-require 'time'
 
 describe Mixpanel::Events do
   before(:each) do

data/spec/mixpanel-ruby/people_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'active_support/time'
+
 require 'mixpanel-ruby/people'
 
 describe Mixpanel::People do
@@ -44,14 +46,29 @@ describe Mixpanel::People do
 
   it 'should convert offset datetimes to UTC' do
     @people.set("TEST ID", {
-        'created_at' => DateTime.new(2013, 1, 1, 18, 4, 5, '-9')
+        'created_at' => DateTime.new(2013, 1, 1, 18, 4, 5, '-8')
     })
     expect(@log).to eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
         '$set' => {
-            'created_at' => '2013-01-02T03:04:05'
+            'created_at' => '2013-01-02T02:04:05'
+        }
+    }]])
+  end
+
+  it 'should convert offset ActiveSupport::TimeWithZone objects to UTC' do
+    Time.zone = 'Pacific Time (US & Canada)'
+    @people.set("TEST ID", {
+        'created_at' => Time.zone.local(2013, 1, 1, 18, 4, 5)
+    })
+    expect(@log).to eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set' => {
+            'created_at' => '2013-01-02T02:04:05'
         }
     }]])
   end

data/spec/mixpanel-ruby/tracker_spec.rb

@@ -1,8 +1,8 @@
-require 'mixpanel-ruby'
 require 'base64'
+require 'cgi'
 require 'json'
+require 'mixpanel-ruby'
 require 'uri'
-require 'cgi'
 
 describe Mixpanel::Tracker do
   before(:each) do

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Mixpanel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,12 +84,14 @@ files:
 - demo/simple_messages.rb
 - lib/mixpanel-ruby.rb
 - lib/mixpanel-ruby/consumer.rb
+- lib/mixpanel-ruby/error.rb
 - lib/mixpanel-ruby/events.rb
 - lib/mixpanel-ruby/people.rb
 - lib/mixpanel-ruby/tracker.rb
 - lib/mixpanel-ruby/version.rb
 - mixpanel-ruby.gemspec
 - spec/mixpanel-ruby/consumer_spec.rb
+- spec/mixpanel-ruby/error_spec.rb
 - spec/mixpanel-ruby/events_spec.rb
 - spec/mixpanel-ruby/people_spec.rb
 - spec/mixpanel-ruby/tracker_spec.rb