spree_mixpanel 2.1.8 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd4a0289d4e8aea4964282fb8d7e6ecea884abf0
-  data.tar.gz: 716077b12521d92afb45b445780b78285ebf1b55
+  metadata.gz: b6cb12efc5f8e72659dfde5c2aabb9b8193dbcef
+  data.tar.gz: f2064fb3e32810fd76d14b72a262c1d8dc2fc0db
 SHA512:
-  metadata.gz: d7f6fb50e9c089bf9a6dd207f1eaea2d596ceacd31163e62ce2dfd7d76b1d868de0c2368703f7101d3196240b646ae56e022fe47c6766d6377af789220514fb4
-  data.tar.gz: 6d5a5dfbc256877d79128ab058ee1e39ae095655bfc3683b514e143437393276802387e67dfd292fe745ab6be112bedb1dc82b97a3a7eb11a1f978f16e6deb5e
+  metadata.gz: aa566a347f48e3e35cc916d0710489cefbd0e376313237c226526247b7bfb549eefa1ea7dedd25ad913e23effd0965956f801f63036222a653cd875ab53f8ecc
+  data.tar.gz: e65db0a0f1e16986e682d23fa9e7a6746d2bd5dc95f4822f2ab87b2ec6d009f9e052a57115a6001775ec0100aef87a3de949342581fe58350269d67dbd88e830

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
 # Provides basic authentication functionality for testing parts of your engine
-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', :branch => '2-1-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', :branch => '2-2-stable'
 
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 SpreeMixpanel
 =============
 
-Spree integration with Mixpanel
+[Spree](http://spreecommerce.com/) integration with [Mixpanel](https://mixpanel.com)
 
 Installation
 ------------
@@ -9,7 +9,8 @@ Installation
 Add spree_mixpanel to your Gemfile:
 
 ```ruby
-gem 'spree_mixpanel', git: 'git@github.com:marcosteixeira/spree_mixpanel.git', branch: '2-1-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-2-stable'
+gem 'spree_mixpanel', git: 'git@github.com:marcosteixeira/spree_mixpanel.git', branch: '2-2-stable'
 ```
 
 Bundle your dependencies and run the installation generator:
@@ -19,6 +20,10 @@ bundle
 bundle exec rails g spree_mixpanel:install
 ```
 
+### Sidekiq (Optional)
+
+In order to upload data to mixpanel in background you can use [Sidekiq](http://sidekiq.org/) gem.
+
 Run your redis server
 ```shell
 redis-server
@@ -46,14 +51,14 @@ end
 @user.mixpanel_track_user
 ```
 
-By default, we send `first_name`, `last_name`, and `email` from user. You can override user `mixpanel_personal_fields` and return personalized fields.
+By default, we send `first_name`, `last_name`, and `email` from user. You can override user `mixpanel_personalized_fields` and return personalized fields.
 
 ```ruby
 User.class_eval do
-  def mixpanel_personal_fields
-    { 
+  def mixpanel_personalized_fields
+    {
       'My Field' => 'FIELD',
-      'Total sales' => self.total_sales
+      'Total sales' => self.total_sales # personalized method in your user model
     }
   end
 end
@@ -65,18 +70,53 @@ end
 @order.mixpanel_track_order
 ```
 
-By default, we send `number`, `total`, `state`, `email` and `payment_state` from order. You can override order `mixpanel_personal_fields` and return personalized fields.
+By default, we send `number`, `total`, `state`, `email` and `payment_state` from order. You can override order `mixpanel_personalized_fields` and return personalized fields.
 
 ```ruby
 Order.class_eval do
-  def mixpanel_personal_fields
+  def mixpanel_personalized_fields
     {
       'My Field' => 'FIELD',
-      'Personal amout' => self.personal_amount
+      'Personal amount' => self.personal_amount
     }
   end
 end
 ```
+### Tracking order revenue
+
+```ruby
+@order.mixpanel_track_charges
+```
+
+By default paid orders revenue  are automatically sent to mixpanel.
+
+You can change this behaviour changing `push_order_charges` configuration.
+
+```ruby
+# config/initializers/mixpanel.rb
+Spree::Mixpanel::Config.configure do |config|
+  config.push_order_charges = false # true by default
+end
+```
+
+You can override `mixpanel_total`.
+
+```ruby
+Order.class_eval do
+  def mixpanel_total
+    100 # personalized total
+  end
+end
+```
+By default we send the revenue time. In order to send personalized fields you can override `mixpanel_charge_fields`
+
+```ruby
+Order.class_eval do
+  def mixpanel_charge_fields
+    {'User name' => user_name } # personalized field
+  end
+end
+```
 
 Testing
 -------

data/app/assets/javascripts/spree/backend/spree_mixpanel.js

@@ -0,0 +1 @@
+//= require spree/backend

data/app/assets/javascripts/spree/frontend/all.js

@@ -0,0 +1 @@
+//= require spree/frontend

data/app/assets/stylesheets/spree/backend/spree_mixpanel.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/backend
+*/

data/app/assets/stylesheets/spree/frontend/spree_mixpanel.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/frontend
+*/

data/app/models/spree/mixpanel_configuration.rb

@@ -1,5 +1,6 @@
 module Spree
   class MixpanelConfiguration < Preferences::Configuration
     preference :connection_token, :string
+    preference :push_order_charges, :boolean, :default => true
   end
 end

data/app/models/spree/order_decorator.rb

@@ -3,25 +3,37 @@ module Spree
   Order.class_eval do
 
     def mixpanel_track_order
-      MixpanelOrdersWorker.perform_async(self.id)
+      Mixpanel::EventHandler.new('event' => :order, 'order_id' => self.id).handle_event
+    end
+
+    def mixpanel_track_charges
+      Mixpanel::EventHandler.new('event' => :charge, 'order_id' => self.id).handle_event
     end
 
     def mixpanel_fields
       {
         'Number' => number,
-        'Total' => total,
+        'Total' => mixpanel_total,
         'State' => state,
         'User email' => email,
         'Payment state' => payment_state
       }
     end
 
-    def mixpanel_personal_fields
+    def mixpanel_charge_fields
+      {}
+    end
+
+    def mixpanel_personalized_fields
       {}
     end
 
     def mixpanel_event_message
       new_record? ? "Order created" : "Order updated"
     end
+
+    def mixpanel_total
+      display_total.cents.to_f / 100
+    end
   end
 end

data/app/models/spree/user_decorator.rb

@@ -3,10 +3,14 @@ module Spree
   User.class_eval do
 
     def mixpanel_track_user
-      MixpanelUsersWorker.perform_async(email, mixpanel_fields.merge(mixpanel_personal_fields))
+      Mixpanel::EventHandler.new('event' => :user, 'user_email' => self.email).handle_event
     end
 
-    def mixpanel_personal_fields
+    def mixpanel_opts
+      mixpanel_fields.merge(mixpanel_personalized_fields)
+    end
+
+    def mixpanel_personalized_fields
       {}
     end
 

data/app/workers/spree_mixpanel_worker.rb

@@ -0,0 +1,8 @@
+class SpreeMixpanelWorker
+  include Sidekiq::Worker
+
+  def perform(opts={})
+    Spree::Mixpanel::EventHandler.new(opts).mixpanel_perform
+  end
+end
+

data/lib/generators/spree_mixpanel/install/install_generator.rb

@@ -11,13 +11,13 @@ module SpreeMixpanel
       class_option :auto_run_migrations, :type => :boolean, :default => false
 
       def add_javascripts
-        append_file 'app/assets/javascripts/store/all.js', "//= require store/spree_mixpanel\n"
-        append_file 'app/assets/javascripts/admin/all.js', "//= require admin/spree_mixpanel\n"
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_mixpanel\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_mixpanel\n"
       end
 
       def add_stylesheets
-        inject_into_file 'app/assets/stylesheets/store/all.css', " *= require store/spree_mixpanel\n", :before => /\*\//, :verbose => true
-        inject_into_file 'app/assets/stylesheets/admin/all.css', " *= require admin/spree_mixpanel\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_mixpanel\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_mixpanel\n", :before => /\*\//, :verbose => true
       end
 
       def add_migrations

data/lib/generators/spree_mixpanel/install/templates/mixpanel.rb

@@ -1,3 +1,4 @@
 Spree::Mixpanel::Config.configure do |config|
  config.connection_token = 'YOUR TOKEN'
+ config.push_order_charges = true
 end

data/lib/spree_mixpanel/mixpanel.rb

@@ -1,5 +1,53 @@
 module Spree
   module Mixpanel
+    class EventHandler
 
+      def initialize(opts={})
+        @opts = opts
+        @event_opts = opts["event_opts"]
+        @event = opts["event"].try(:to_sym) || :track
+        @user_email = opts["user_email"]
+        @order_id = opts["order_id"]
+        @event_name = opts["event_name"]
+      end
+
+      def handle_event
+        if has_sidekiq?
+          begin
+            SpreeMixpanelWorker.perform_async(opts)
+          rescue Redis::CannotConnectError
+            Rails.logger.info "Cannot connect with Redis"
+          end
+        else
+          mixpanel_perform
+        end
+      end
+
+      def mixpanel_perform
+        case event
+        when :user
+          MixpanelTracker.track_user(user_email)
+        when :order
+          MixpanelTracker.track_order(order_id)
+        when :charge
+          MixpanelTracker.track_charge(order_id)
+        when :track
+          MixpanelTracker.track_event(user_email, event_name, event_opts)
+        end
+      end
+
+      private
+
+      attr_reader :opts, :event_opts, :event, :user_email, :order_id, :event_name
+
+      def has_sidekiq?
+        @has_sidekiq ||= begin
+                           require 'sidekiq'
+                           true
+                         rescue LoadError
+                           false
+                         end
+      end
+    end
   end
 end

data/lib/spree_mixpanel/tracker/mixpanel_tracker.rb

@@ -2,14 +2,28 @@ require 'mixpanel-ruby'
 
 module MixpanelTracker
 
-  def self.track_user(email, opts)
-    tracker.people.set(email, opts)
+  def self.track_user(email)
+    user = Spree.user_class.find_by_email(email)
+    tracker.people.set(email, user.mixpanel_opts)
   end
 
-  def self.track_order(order)
-   tracker.track(order.email, order.mixpanel_event_message, order.mixpanel_fields.merge(order.mixpanel_personal_fields))
+  def self.track_order(order_id)
+    order = Spree::Order.find(order_id)
+    tracker.track(order.email, order.mixpanel_event_message, order.mixpanel_fields.merge(order.mixpanel_personalized_fields))
+    track_charge(order.id) if push_order_charges? && order.paid?
   end
 
+  def self.track_charge(order_id)
+    order = Spree::Order.find(order_id)
+    tracker.people.track_charge(order.email, order.mixpanel_total, {'$time' => I18n.l(DateTime.now, format: "%Y-%m-%dT%H:%M:%S")}.merge(order.mixpanel_charge_fields))
+  end
+
+  def self.track_event(user_email,name, opts={})
+    tracker.track(user_email, name, opts)
+  end
+
+  class MixpanelApiError < StandardError; end
+
   private
   def self.tracker
     validate_connection_token
@@ -20,9 +34,11 @@ module MixpanelTracker
     Spree::Mixpanel::Config[:connection_token]
   end
 
-  def self.validate_connection_token
-    raise MixpanelApiError, "Mixpanel connection token is required" if !connection_token.present?
+  def self.push_order_charges?
+    @push_charges ||= Spree::Mixpanel::Config[:push_order_charges]
   end
 
-  class MixpanelApiError < StandardError; end
+  def self.validate_connection_token
+    raise MixpanelApiError, "Mixpanel connection token is required" unless connection_token.present?
+  end
 end

data/lib/spree_mixpanel.rb

@@ -2,4 +2,3 @@ require 'spree_core'
 require 'spree_mixpanel/engine'
 require 'spree_mixpanel/mixpanel'
 require 'spree_mixpanel/tracker/mixpanel_tracker'
-require 'sidekiq'

data/spree_mixpanel.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_mixpanel'
-  s.version     = '2.1.8'
+  s.version     = '2.2.0'
   s.summary     = 'Spree/Mixpanel integration'
   s.description =  s.summary
   s.required_ruby_version = '>= 1.9.3'
@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.requirements << 'none'
 
-  s.add_dependency 'spree_core'
+  spree_version = '~> 2.2.0'
+  s.add_dependency 'spree_core', spree_version
   s.add_dependency 'mixpanel-ruby', '~> 1.4.0'
-  s.add_dependency 'sidekiq', '~> 3.2.1'
 
   s.add_development_dependency 'database_cleaner'
   s.add_development_dependency 'factory_girl', '~> 4.2'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: spree_mixpanel
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 2.2.0
 platform: ruby
 authors:
 - Marcos Teixeira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: mixpanel-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +38,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.0
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -120,15 +106,15 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/admin/spree_mixpanel.js
-- app/assets/javascripts/store/spree_mixpanel.js
-- app/assets/stylesheets/admin/spree_mixpanel.css
-- app/assets/stylesheets/store/spree_mixpanel.css
+- app/assets/javascripts/spree/backend/spree_mixpanel.js
+- app/assets/javascripts/spree/frontend/all.js
+- app/assets/javascripts/spree/frontend/spree_mixpanel.js
+- app/assets/stylesheets/spree/backend/spree_mixpanel.css
+- app/assets/stylesheets/spree/frontend/spree_mixpanel.css
 - app/models/spree/mixpanel_configuration.rb
 - app/models/spree/order_decorator.rb
 - app/models/spree/user_decorator.rb
-- app/workers/mixpanel_orders_worker.rb
-- app/workers/mixpanel_users_worker.rb
+- app/workers/spree_mixpanel_worker.rb
 - bin/rails
 - config/locales/en.yml
 - config/routes.rb
@@ -162,10 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - none
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Spree/Mixpanel integration
-test_files:
-- spec/lib/spree_mixpanel/tracker/mixpanel_tracker_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/app/assets/javascripts/admin/spree_mixpanel.js

@@ -1 +0,0 @@
-//= require admin/spree_backend

data/app/assets/javascripts/store/spree_mixpanel.js

@@ -1 +0,0 @@
-//= require store/spree_frontend

data/app/assets/stylesheets/admin/spree_mixpanel.css

@@ -1,3 +0,0 @@
-/*
- *= require admin/spree_backend
-*/

data/app/assets/stylesheets/store/spree_mixpanel.css

@@ -1,3 +0,0 @@
-/*
- *= require store/spree_frontend
-*/

data/app/workers/mixpanel_orders_worker.rb

@@ -1,8 +0,0 @@
-class MixpanelOrdersWorker
-  include Sidekiq::Worker
-
-  def perform(order_id)
-    order = Spree::Order.find(order_id)
-    MixpanelTracker.track_order(order)
-  end
-end

data/app/workers/mixpanel_users_worker.rb

@@ -1,7 +0,0 @@
-class MixpanelUsersWorker
-  include Sidekiq::Worker
-
-  def perform(user_email, opts={})
-    MixpanelTracker.track_user(user_email, opts)
-  end
-end