mixpal 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29a0e62e6775b0e59acac47db4e0ef9c0af4b708
-  data.tar.gz: bf499158ffa8e0e15dfff70c5f5c67286826eea4
+  metadata.gz: fb233388194e4bb65920f2397f440b69c0e84d3e
+  data.tar.gz: 83af8a3d7aca41e8cbbb049175847f3e74d0be81
 SHA512:
-  metadata.gz: 6c41217c5011aa6a47f46203be1304a33d8421c8aa34614b593945fd37e53ecf531e64a5a30dd6c396f388075f12810cb866de5d47c24d5cbd41802bdc01409b
-  data.tar.gz: 845c43bf95de75e6d679a2ee2b1f03f4ebea45398cd6c9c48a5cb222a74fa8c9d3595d70786994d7cbe2794b2343880e5b1d2b72f829973358e0fcac3112f6d8
+  metadata.gz: 576d25b01395d3f4e2dda4dfa00df0b93660bb358d914117d596dd472aea60d7caa90828daed689e752716caf0532574f2c78e41b9253e11444eb3c3c9759b51
+  data.tar.gz: fb5c7d9aacc19f111d8a82fdfdd5b36677542cd9d86a2ff79ccd5fc08415d05306f5d6d861a2ac44be53677718f33a81d88c2f42ff58de127a7ee5901a2b9930

data/.rubocop.yml

@@ -16,9 +16,6 @@ MethodLength:
 DoubleNegation:
   Enabled: false
 
-AbcSize:
-  Max: 20
-
 AllCops:
   Include:
     - "Rakefile"

data/README.md

@@ -78,6 +78,38 @@ mixpanel.update_user email: "mynewemail@example.com"
 
 As with `register_user`, this method will also identify "special properties".
 
+### Custom Events
+
+Mixpal allows you to define custom mixpal methods to use in your controllers/views
+
+1. create a custom module and define your mixpal events
+```ruby
+module YourCustomEventsModule
+  def sign_up(user)
+    register_user user.attributes.slice('name', 'email')
+    track 'User signed up'
+  end
+end
+```
+
+2. create a mixpal.rb initializer and configure mixpal to use your module
+```ruby
+Mixpal.configure do |config|
+  config.helper_module = YourCustomEventsModule
+end
+```
+
+3. use in controllers/views
+```ruby
+class UserController < ActionController::Base
+  def create
+    # ... do cool stuff ...
+    mixpal.sign_up(user)
+    redirect_to root_path
+  end
+end
+```
+
 ### Persistance Across Redirects
 
 Mixpal stores any tracked events or user data in the session when

data/lib/mixpal.rb

@@ -7,6 +7,7 @@ module Mixpal
   autoload :Tracker, 'mixpal/tracker'
   autoload :Event, 'mixpal/event'
   autoload :User, 'mixpal/user'
+  autoload :Revenue, 'mixpal/revenue'
   autoload :Integration, 'mixpal/integration'
 
   class << self

data/lib/mixpal/revenue.rb

@@ -0,0 +1,32 @@
+module Mixpal
+  class Revenue
+    attr_reader :amount, :properties
+
+    def initialize(amount, properties)
+      @amount = amount
+      @properties = properties
+    end
+
+    def render
+      args = "#{amount}, #{properties_as_js_object_for_mixpanel}"
+      "mixpanel.people.track_charge(#{args});".html_safe
+    end
+
+    def to_store
+      {
+        'amount' => amount,
+        'properties' => properties
+      }
+    end
+
+    def self.from_store(data)
+      new(data['amount'], data['properties'])
+    end
+
+    private
+
+    def properties_as_js_object_for_mixpanel
+      Mixpal::Util.hash_to_js_object_string(properties)
+    end
+  end
+end

data/lib/mixpal/tracker.rb

@@ -1,6 +1,6 @@
 module Mixpal
   class Tracker
-    attr_reader :events, :user_updates, :identity, :alias_user
+    attr_reader :events, :user_updates, :revenue_updates, :identity, :alias_user
 
     STORAGE_KEY = 'mixpal'
 
@@ -9,6 +9,7 @@ module Mixpal
 
       @events = []
       @user_updates = []
+      @revenue_updates = []
 
       @identity = args[:identity]
     end
@@ -26,6 +27,10 @@ module Mixpal
       events << Mixpal::Event.new(name, properties)
     end
 
+    def track_charge(amount, properties = {})
+      revenue_updates << Mixpal::Revenue.new(amount, properties)
+    end
+
     def render
       ''.tap do |html|
         html << '<script type="text/javascript">'
@@ -33,6 +38,7 @@ module Mixpal
         html << "mixpanel.identify(\"#{identity}\");" if identity
         html << events.map(&:render).join('')
         html << user_updates.map(&:render).join('')
+        html << revenue_updates.map(&:render).join('')
         html << '</script>'
       end.html_safe
     end
@@ -56,6 +62,11 @@ module Mixpal
           data['user_updates'].map { |u| Mixpal::User.from_store(u) }
       end
 
+      if data['revenue_updates']
+        @revenue_updates =
+          data['revenue_updates'].map { |u| Mixpal::Revenue.from_store(u) }
+      end
+
       session.delete(STORAGE_KEY)
     end
 
@@ -66,7 +77,8 @@ module Mixpal
         'alias_user' => alias_user,
         'identity' => identity,
         'events' => events.map(&:to_store),
-        'user_updates' => user_updates.map(&:to_store)
+        'user_updates' => user_updates.map(&:to_store),
+        'revenue_updates' => revenue_updates.map(&:to_store)
       }
     end
   end

data/lib/mixpal/version.rb

@@ -1,3 +1,3 @@
 module Mixpal
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/lib/mixpal/revenue_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Mixpal::Revenue do
+  let(:properties) do
+    {
+      sku: 'SKU-1010'
+    }
+  end
+
+  let(:amount) { 50 }
+
+  let(:subject) { described_class.new(amount, properties) }
+
+  describe '#render' do
+    it 'delegates to Util for js_object composition' do
+      Mixpal::Util.should_receive(:hash_to_js_object_string).with(properties)
+      subject.render
+    end
+
+    it 'outputs a call to people.track_charge' do
+      js_object = Mixpal::Util.hash_to_js_object_string(properties)
+      expect(subject.render)
+        .to eq "mixpanel.people.track_charge(#{amount}, #{js_object});"
+    end
+
+    it 'outputs an html safe string' do
+      expect(subject.render).to be_html_safe
+    end
+  end
+
+  describe '#to_store' do
+    it 'returns a hash with its data' do
+      expect(subject.to_store).to eq(
+        'amount' => amount,
+        'properties' => properties
+      )
+    end
+  end
+
+  describe '#from_store' do
+    let(:result) do
+      described_class.from_store(
+        'amount' => amount,
+        'properties' => properties
+      )
+    end
+
+    it 'instantiates a new instance' do
+      expect(result).to be_an_instance_of(described_class)
+    end
+
+    it 'sets its amount from the data' do
+      expect(result.amount).to eq amount
+    end
+
+    it 'sets its properties from the data' do
+      expect(result.properties).to eq properties
+    end
+  end
+end

data/spec/lib/mixpal/tracker_spec.rb

@@ -26,6 +26,10 @@ describe Mixpal::Tracker do
       expect(subject.user_updates).to eq []
     end
 
+    it 'creates an empty set of revenue_updates' do
+      expect(subject.revenue_updates).to eq []
+    end
+
     context 'with an :identity arg' do
       subject { subject_with_identity }
 
@@ -82,6 +86,22 @@ describe Mixpal::Tracker do
     end
   end
 
+  describe '#track_charge' do
+    it 'instantiates a new Revenue object with properties' do
+      properties = { sku: 'SKU-1010' }
+      Mixpal::Revenue.should_receive(:new).with(50, properties)
+      subject.track_charge(50, properties)
+    end
+
+    it 'adds the Revenue to revenue_updates for rendering later' do
+      expect do
+        subject.track_charge(50, sku: 'SKU-1010')
+      end.to change(subject.revenue_updates, :size).by(1)
+
+      subject.revenue_updates.first.should be_an_instance_of(Mixpal::Revenue)
+    end
+  end
+
   describe '#render' do
     it 'outputs script tag' do
       expect(subject.render).to have_tag('script')
@@ -152,6 +172,24 @@ describe Mixpal::Tracker do
         expect(subject.render).to include joined
       end
     end
+
+    context 'with revenue' do
+      before do
+        subject.track_charge(50)
+        subject.track_charge(100, sku: 'SKU-1010')
+      end
+
+      it 'delegates render to the revenues' do
+        subject.revenue_updates.each { |r| r.should_receive :render }
+        subject.render
+      end
+
+      it 'joins each rendered revenue' do
+        joined =
+          subject.revenue_updates[0].render + subject.revenue_updates[1].render
+        expect(subject.render).to include joined
+      end
+    end
   end
 
   describe '#store!' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpal
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - patbenatar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,12 +184,14 @@ files:
 - lib/mixpal.rb
 - lib/mixpal/event.rb
 - lib/mixpal/integration.rb
+- lib/mixpal/revenue.rb
 - lib/mixpal/tracker.rb
 - lib/mixpal/user.rb
 - lib/mixpal/util.rb
 - lib/mixpal/version.rb
 - mixpanel_assistant.gemspec
 - spec/lib/mixpal/event_spec.rb
+- spec/lib/mixpal/revenue_spec.rb
 - spec/lib/mixpal/tracker_spec.rb
 - spec/lib/mixpal/user_spec.rb
 - spec/lib/mixpal/util_spec.rb
@@ -275,6 +277,7 @@ summary: As the JavaScript library is Mixpanel's preferred method of usage, Mixp
   form submissions.
 test_files:
 - spec/lib/mixpal/event_spec.rb
+- spec/lib/mixpal/revenue_spec.rb
 - spec/lib/mixpal/tracker_spec.rb
 - spec/lib/mixpal/user_spec.rb
 - spec/lib/mixpal/util_spec.rb