spree_mixpanel 2.1.8

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,15 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+dump.rdb

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +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'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,99 @@
+SpreeMixpanel
+=============
+
+Spree integration with Mixpanel
+
+Installation
+------------
+
+Add spree_mixpanel to your Gemfile:
+
+```ruby
+gem 'spree_mixpanel', git: 'git@github.com:marcosteixeira/spree_mixpanel.git', branch: '2-1-stable'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_mixpanel:install
+```
+
+Run your redis server
+```shell
+redis-server
+```
+
+Execute Sidekiq
+```shell
+bundle exec sidekiq
+```
+
+Usage
+------------
+
+Add your Mixpanel credentials to `config/initializers/mixpanel.rb`:
+
+```ruby
+Spree::Mixpanel::Config.configure do |config|
+  config.connection_token = "YOUR TOKEN"
+end
+```
+
+### Storing user profiles
+
+```ruby
+@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.
+
+```ruby
+User.class_eval do
+  def mixpanel_personal_fields
+    { 
+      'My Field' => 'FIELD',
+      'Total sales' => self.total_sales
+    }
+  end
+end
+```
+
+### Sending orders to mixpanel
+
+```ruby
+@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.
+
+```ruby
+Order.class_eval do
+  def mixpanel_personal_fields
+    {
+      'My Field' => 'FIELD',
+      'Personal amout' => self.personal_amount
+    }
+  end
+end
+```
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_mixpanel/factories'
+```
+
+Copyright (c) 2014, released under the New BSD License

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_mixpanel'
+  Rake::Task['extension:test_app'].invoke
+end

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

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

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

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

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

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

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

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

data/app/models/spree/mixpanel_configuration.rb

@@ -0,0 +1,5 @@
+module Spree
+  class MixpanelConfiguration < Preferences::Configuration
+    preference :connection_token, :string
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,27 @@
+module Spree
+
+  Order.class_eval do
+
+    def mixpanel_track_order
+      MixpanelOrdersWorker.perform_async(self.id)
+    end
+
+    def mixpanel_fields
+      {
+        'Number' => number,
+        'Total' => total,
+        'State' => state,
+        'User email' => email,
+        'Payment state' => payment_state
+      }
+    end
+
+    def mixpanel_personal_fields
+      {}
+    end
+
+    def mixpanel_event_message
+      new_record? ? "Order created" : "Order updated"
+    end
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,21 @@
+module Spree
+
+  User.class_eval do
+
+    def mixpanel_track_user
+      MixpanelUsersWorker.perform_async(email, mixpanel_fields.merge(mixpanel_personal_fields))
+    end
+
+    def mixpanel_personal_fields
+      {}
+    end
+
+    def mixpanel_fields
+      {
+        '$first_name'       => first_name,
+        '$last_name'        => last_name,
+        '$email'            => email
+      }
+    end
+  end
+end

data/app/workers/mixpanel_orders_worker.rb

@@ -0,0 +1,8 @@
+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

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

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_mixpanel/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

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

@@ -0,0 +1,37 @@
+module SpreeMixpanel
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer
+        copy_file "mixpanel.rb", "config/initializers/mixpanel.rb"
+      end
+
+      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"
+      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
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_mixpanel'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

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

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

data/lib/spree_mixpanel.rb

@@ -0,0 +1,5 @@
+require 'spree_core'
+require 'spree_mixpanel/engine'
+require 'spree_mixpanel/mixpanel'
+require 'spree_mixpanel/tracker/mixpanel_tracker'
+require 'sidekiq'

data/lib/spree_mixpanel/engine.rb

@@ -0,0 +1,26 @@
+module SpreeMixpanel
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_mixpanel'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer "spree.mixpanel.environment", :before => :load_config_initializers do |app|
+      Spree::Mixpanel::Config = Spree::MixpanelConfiguration.new
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_mixpanel/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_mixpanel/factories'
+end

data/lib/spree_mixpanel/mixpanel.rb

@@ -0,0 +1,5 @@
+module Spree
+  module Mixpanel
+
+  end
+end

data/lib/spree_mixpanel/tracker/mixpanel_tracker.rb

@@ -0,0 +1,28 @@
+require 'mixpanel-ruby'
+
+module MixpanelTracker
+
+  def self.track_user(email, opts)
+    tracker.people.set(email, opts)
+  end
+
+  def self.track_order(order)
+   tracker.track(order.email, order.mixpanel_event_message, order.mixpanel_fields.merge(order.mixpanel_personal_fields))
+  end
+
+  private
+  def self.tracker
+    validate_connection_token
+    @tracker ||= Mixpanel::Tracker.new(connection_token)
+  end
+
+  def self.connection_token
+    Spree::Mixpanel::Config[:connection_token]
+  end
+
+  def self.validate_connection_token
+    raise MixpanelApiError, "Mixpanel connection token is required" if !connection_token.present?
+  end
+
+  class MixpanelApiError < StandardError; end
+end

data/spec/lib/spree_mixpanel/tracker/mixpanel_tracker_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module MixpanelTracker
+  describe MixpanelTracker do
+
+    let (:config) { Spree::Mixpanel::Config }
+
+    it "is invalid without a connection token" do
+      config[:connection_token] = nil
+      expect { MixpanelTracker.tracker }.to raise_error(MixpanelApiError)
+    end
+
+    it "is valid with a connection token" do
+      config[:connection_token] = "TOKEN"
+      expect { MixpanelTracker.tracker }.to_not raise_error
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories defined in spree_core
+require 'spree/testing_support/factories'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/url_helpers'
+
+# Requires factories defined in lib/spree_mixpanel/factories.rb
+require 'spree_mixpanel/factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  config.infer_spec_type_from_file_location!
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a separate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+end

data/spree_mixpanel.gemspec

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_mixpanel'
+  s.version     = '2.1.8'
+  s.summary     = 'Spree/Mixpanel integration'
+  s.description =  s.summary
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Marcos Teixeira'
+  s.email     = 'm.viniteixeira@gmail.com'
+  s.homepage  = 'https://github.com/marcosteixeira/spree_mixpanel'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core'
+  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'
+  s.add_development_dependency 'rspec-rails',  '~> 2.13'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: spree_mixpanel
+version: !ruby/object:Gem::Version
+  version: 2.1.8
+platform: ruby
+authors:
+- Marcos Teixeira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixpanel-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Spree/Mixpanel integration
+email: m.viniteixeira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- 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/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
+- bin/rails
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/spree_mixpanel/install/install_generator.rb
+- lib/generators/spree_mixpanel/install/templates/mixpanel.rb
+- lib/spree_mixpanel.rb
+- lib/spree_mixpanel/engine.rb
+- lib/spree_mixpanel/factories.rb
+- lib/spree_mixpanel/mixpanel.rb
+- lib/spree_mixpanel/tracker/mixpanel_tracker.rb
+- spec/lib/spree_mixpanel/tracker/mixpanel_tracker_spec.rb
+- spec/spec_helper.rb
+- spree_mixpanel.gemspec
+homepage: https://github.com/marcosteixeira/spree_mixpanel
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: Spree/Mixpanel integration
+test_files:
+- spec/lib/spree_mixpanel/tracker/mixpanel_tracker_spec.rb
+- spec/spec_helper.rb