solidus_events_tracker 2.1.0 → 2.1.1

data/app/models/spree/page_event.rb

@@ -0,0 +1,14 @@
+module Spree
+  class PageEvent < Spree::Base
+    ACTIVITIES = { view: :view, search: :search, filter: :filter, index: :index }
+
+    belongs_to :actor, polymorphic: true
+    belongs_to :target, polymorphic: true
+
+    validates :activity,
+              :session_id, presence: true
+
+    scope :viewed, -> { where(activity: :view) }
+    scope :product, -> { where(target_type: 'Spree::Product') }
+  end
+end

data/app/trackers/spree/cart/event/tracker.rb

@@ -0,0 +1,44 @@
+module Spree
+  module Cart
+    module Event
+      class Tracker < Spree::Event::Tracker
+        attr_reader :target
+        attr_accessor :activity, :quantity
+
+        def initialize(arguments = {})
+          super(arguments)
+          @quantity = arguments[:quantity]
+          @total = arguments[:total]
+          @variant_id = arguments[:variant_id]
+        end
+
+        def track
+          changed_quantity = changed_quantity(target.previous_changes[:quantity].map(&:to_i))
+          self.activity = activity(changed_quantity, target)
+          self.quantity = changed_quantity
+          CartEvent.create(instance_values)
+        end
+
+        private
+          # 1. ADD EVENT: When a new product is added to cart
+          #    so the changed quantity will be equal to line_item.quantity
+          # 2. REMOVE EVENT: When a product is removed from cart,
+          #    change in quantity will be negative and line_items quantity will be zero
+          # 3. UPDATE EVENT: When product's quantity is changed from the cart and it shouldn't be removed
+          def activity(changed_quantity, line_item)
+            if (changed_quantity > 0 && changed_quantity == line_item.quantity)
+              :add
+            elsif (changed_quantity < 0 && line_item.quantity == 0)
+              :remove
+            elsif changed_quantity
+              :update
+            end
+          end
+
+          def changed_quantity(previous_quantity_changes)
+            previous_quantity_changes.last - previous_quantity_changes.first
+          end
+      end
+    end
+  end
+end

data/app/trackers/spree/checkout/event/tracker.rb

@@ -0,0 +1,18 @@
+module Spree
+  module Checkout
+    module Event
+      class Tracker < Spree::Event::Tracker
+
+        def initialize(arguments = {})
+          super(arguments)
+          @previous_state = arguments[:previous_state]
+          @next_state = arguments[:next_state]
+        end
+
+        def track
+          CheckoutEvent.create(instance_values)
+        end
+      end
+    end
+  end
+end

data/app/trackers/spree/event/tracker.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Event
+    class Tracker
+      def initialize(arguments = {})
+        @activity = arguments[:activity]
+        @actor = arguments[:actor]
+        @target = arguments[:target]
+        @referrer = arguments[:referrer]
+        @session_id = arguments[:session_id]
+      end
+
+      def track
+        raise '#track should be implemented in a sub-class of Event::Tracker'
+      end
+    end
+  end
+end

data/app/trackers/spree/page/event/tracker.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Page::Event
+    class Tracker < Spree::Event::Tracker
+      EVENTS = { show: :view, search: :search, filter: :filter, index: :index }
+
+      def initialize(arguments = {})
+        super(arguments)
+        @search_keywords = arguments[:search_keywords]
+        @query_string = arguments[:query_string]
+      end
+
+      def track
+        PageEvent.create(instance_values)
+      end
+    end
+  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/solidus_events_tracker/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+# 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:

data/config/routes.rb

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

data/db/migrate/20160313145434_create_spree_cart_events.rb

@@ -0,0 +1,15 @@
+class CreateSpreeCartEvents < ActiveRecord::Migration
+  def change
+    create_table :spree_cart_events do |t|
+      t.belongs_to :actor, polymorphic: true, index: true
+      t.belongs_to :target, polymorphic: true, index: true
+      t.string :activity
+      t.string :referrer
+      t.integer :quantity
+      t.decimal :total, precision: 16, scale: 4
+      t.string :session_id
+      t.belongs_to :variant, index: true
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160314080710_create_spree_page_events.rb

@@ -0,0 +1,14 @@
+class CreateSpreePageEvents < ActiveRecord::Migration
+  def change
+    create_table :spree_page_events do |t|
+      t.belongs_to :actor, polymorphic: true, index: true
+      t.belongs_to :target, polymorphic: true, index: true
+      t.string :activity
+      t.string :referrer
+      t.string :search_keywords
+      t.string :session_id
+      t.string :query_string
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160314080822_create_spree_checkout_events.rb

@@ -0,0 +1,14 @@
+class CreateSpreeCheckoutEvents < ActiveRecord::Migration
+  def change
+    create_table :spree_checkout_events do |t|
+      t.belongs_to :actor, polymorphic: true, index: true
+      t.belongs_to :target, polymorphic: true, index: true
+      t.string :activity
+      t.string :referrer
+      t.string :previous_state
+      t.string :next_state
+      t.string :session_id
+      t.timestamps null: false
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module SolidusEventsTracker
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_events_tracker\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_events_tracker\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_events_tracker\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_events_tracker\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_events_tracker'
+      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/solidus_events_tracker.rb

@@ -0,0 +1,2 @@
+require 'solidus_core'
+require 'solidus_events_tracker/engine'

data/lib/solidus_events_tracker/engine.rb

@@ -0,0 +1,20 @@
+module SolidusEventsTracker
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_events_tracker'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    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/solidus_events_tracker/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_events_tracker/factories'
+end

data/solidus_events_tracker.gemspec

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solidus_events_tracker'
+  s.version     = '2.1.1'
+  s.summary     = 'Tracks user activity for reporting.'
+  s.description = 'Tracks user activity and events on the server side. Use Solidus Admin Insights to build reports of user activity.'
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.author    = ["Nimish Mehta", "Tanmay Sinha", "+ Vinsol Team"]
+  s.email     = 'info@vinsol.com'
+  s.homepage  = 'http://vinsol.com'
+  s.license = 'BSD-3'
+
+  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'
+
+  solidus_version = '~> 2.1'
+
+  s.add_dependency 'solidus_core', solidus_version
+
+  s.add_development_dependency 'shoulda-matchers', '~> 2.6.2'
+  s.add_development_dependency 'rspec-activemodel-mocks'
+
+  s.add_development_dependency 'capybara', '~> 2.5'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl', '~> 4.5'
+  s.add_development_dependency 'ffaker',  '~> 2.2.0'
+  s.add_development_dependency 'rspec-rails',  '~> 3.4'
+  s.add_development_dependency 'sass-rails', '~> 5.0.0'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/controllers/spree/checkout_controller_decorator_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Spree::CheckoutController do
+
+  let(:order) { mock_model(Spree::Order, remaining_total: 1000, state: 'cart') }
+  let(:user) { mock_model(Spree.user_class, store_credits_total: 500) }
+  let(:checkout_event) { mock_model(Spree::CheckoutEvent) }
+
+  before do
+    allow(user).to receive(:orders).and_return(Spree::Order.all)
+    allow(controller).to receive(:track_activity).and_return(checkout_event)
+    allow(controller).to receive(:ensure_order_not_completed).and_return(true)
+    allow(controller).to receive(:ensure_checkout_allowed).and_return(true)
+    allow(controller).to receive(:ensure_sufficient_stock_lines).and_return(true)
+    allow(controller).to receive(:ensure_valid_state).and_return(true)
+    allow(controller).to receive(:associate_user).and_return(true)
+    allow(controller).to receive(:check_authorization).and_return(true)
+    allow(controller).to receive(:current_order).and_return(order)
+    allow(controller).to receive(:setup_for_current_state).and_return(true)
+    allow(controller).to receive(:spree_current_user).and_return(user)
+    allow(order).to receive(:can_go_to_state?).and_return(false)
+  end
+
+  describe '#edit' do
+
+    def send_request(state)
+      get :edit, state: state
+    end
+
+    before do
+      allow(order).to receive(:state=).and_return("address")
+    end
+
+    context 'when previous state is different than next state' do
+
+      describe 'expects to receive' do
+        it { expect(user).to receive(:orders).and_return(Spree::Order.all) }
+        it { expect(controller).to receive(:track_activity).and_return(checkout_event) }
+        it { expect(controller).to receive(:ensure_order_not_completed).and_return(true) }
+        it { expect(controller).to receive(:ensure_checkout_allowed).and_return(true) }
+        it { expect(controller).to receive(:ensure_sufficient_stock_lines).and_return(true) }
+        it { expect(controller).to receive(:ensure_valid_state).and_return(true) }
+        it { expect(controller).to receive(:associate_user).and_return(true) }
+        it { expect(controller).to receive(:check_authorization).and_return(true) }
+        it { expect(controller).to receive(:current_order).and_return(order) }
+        it { expect(controller).to receive(:setup_for_current_state).and_return(true) }
+        it { expect(controller).to receive(:spree_current_user).and_return(user) }
+        it { expect(order).to receive(:can_go_to_state?).and_return(false) }
+        it { expect(order).to receive(:state=).and_return("address") }
+
+        after { send_request('address') }
+      end
+
+      describe 'response' do
+        before { send_request('address') }
+        it { expect(response).to have_http_status(200) }
+      end
+
+      describe 'assigns' do
+        before { send_request('address') }
+        it { expect(controller.track_activity).to be_instance_of(Spree::CheckoutEvent) }
+      end
+
+    end
+
+    context 'when previous state is same as next state' do
+      before { request.env['HTTP_REFERER'] = 'test/cart' }
+
+      describe 'response' do
+        before { send_request('cart') }
+        it { expect(response).to have_http_status(200) }
+      end
+
+      describe 'expect not to receive' do
+        it { expect(controller).not_to receive(:track_activity) }
+        after { send_request('cart') }
+      end
+    end
+
+  end
+
+  describe '#update' do
+
+    def send_request
+      patch :update, state: order.state
+    end
+
+    before do
+      allow(order).to receive(:assign_attributes).and_return(order)
+      allow(order).to receive(:save).and_return(true)
+      allow(order).to receive(:temporary_address=).and_return(true)
+      allow(order).to receive(:state=).and_return("complete")
+      allow(order).to receive(:next).and_return(true)
+      allow(order).to receive(:completed?).and_return(true)
+      allow(order).to receive(:shipments).and_return([])
+      request.env['HTTP_REFERER'] = 'test/confirm'
+    end
+
+    describe 'expects to receive' do
+      it { expect(user).to receive(:orders).and_return(Spree::Order.all) }
+      it { expect(controller).to receive(:track_activity).and_return(checkout_event) }
+      it { expect(controller).to receive(:ensure_order_not_completed).and_return(true) }
+      it { expect(controller).to receive(:ensure_checkout_allowed).and_return(true) }
+      it { expect(controller).to receive(:ensure_sufficient_stock_lines).and_return(true) }
+      it { expect(controller).to receive(:ensure_valid_state).and_return(true) }
+      it { expect(controller).to receive(:associate_user).and_return(true) }
+      it { expect(controller).to receive(:check_authorization).and_return(true) }
+      it { expect(controller).to receive(:current_order).and_return(order) }
+      it { expect(controller).to receive(:setup_for_current_state).and_return(true) }
+      it { expect(controller).to receive(:spree_current_user).and_return(user) }
+      it { expect(order).to receive(:can_go_to_state?).and_return(false) }
+      it { expect(order).to receive(:temporary_address=).and_return(true) }
+      it { expect(order).to receive(:state=).and_return("complete") }
+      it { expect(order).to receive(:next).and_return(true) }
+      it { expect(order).to receive(:completed?).and_return(true) }
+
+      after { send_request }
+    end
+
+    describe 'assigns' do
+      before { send_request }
+      it { expect(controller.track_activity).to be_instance_of(Spree::CheckoutEvent) }
+    end
+
+    describe 'response' do
+      before { send_request }
+      it { expect(response).to have_http_status(302) }
+    end
+
+  end
+
+end

data/spec/controllers/spree/orders_controller_decorator_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe Spree::OrdersController do
+
+  let(:order) { mock_model(Spree::Order, remaining_total: 1000, state: 'cart') }
+  let(:user) { mock_model(Spree.user_class, store_credits_total: 500) }
+  let(:checkout_event) { mock_model(Spree::CheckoutEvent) }
+
+  before do
+    allow(user).to receive(:orders).and_return(Spree::Order.all)
+    allow(controller).to receive(:track_activity).and_return(checkout_event)
+    allow(controller).to receive(:check_authorization).and_return(true)
+    allow(controller).to receive(:current_order).and_return(order)
+    allow(controller).to receive(:associate_user).and_return(true)
+    allow(controller).to receive(:spree_current_user).and_return(user)
+    allow(controller).to receive(:current_order).and_return(order)
+  end
+
+  describe '#edit' do
+
+    def send_request
+      get :edit, id: order.number
+    end
+
+    describe 'when return to cart' do
+
+      context 'when return from a checkout step' do
+        before do
+          @checkout_steps = double('checkout_steps')
+          allow(order).to receive(:checkout_steps).and_return(@checkout_steps)
+          allow(@checkout_steps).to receive(:include?).and_return(true)
+          request.env['HTTP_REFERER'] = 'test/address'
+        end
+
+        describe 'expects to receive' do
+          it { expect(user).to receive(:orders).and_return(Spree::Order.all) }
+          it { expect(controller).to receive(:track_activity).and_return(checkout_event) }
+          it { expect(controller).to receive(:check_authorization).and_return(true) }
+          it { expect(controller).to receive(:current_order).and_return(order) }
+          it { expect(controller).to receive(:spree_current_user).and_return(user) }
+          it { expect(controller).to receive(:current_order).and_return(order) }
+          it { expect(controller).to receive(:associate_user).and_return(true) }
+          it { expect(order).to receive(:checkout_steps).and_return(@checkout_steps) }
+          it { expect(@checkout_steps).to receive(:include?).and_return(true) }
+
+          after { send_request }
+        end
+
+        describe 'response' do
+          before { send_request }
+          it { expect(response).to have_http_status(200) }
+        end
+
+        describe 'assigns' do
+          before { send_request }
+          it { expect(controller.track_activity).to be_instance_of(Spree::CheckoutEvent) }
+        end
+
+      end
+
+      context 'when a product is added' do
+        before do
+          checkout_steps = double('checkout_steps')
+          allow(order).to receive(:checkout_steps).and_return(checkout_steps)
+          allow(checkout_steps).to receive(:include?).and_return(false)
+          request.env['HTTP_REFERER'] = 'test/my_test_product'
+        end
+
+        describe 'response' do
+          before { send_request }
+          it { expect(response).to have_http_status(200) }
+        end
+
+        describe 'assigns' do
+          before { send_request }
+          it { expect(controller.track_activity).to be_instance_of(Spree::CheckoutEvent) }
+        end
+      end
+
+      context 'when return to cart from cart itself' do
+        before do
+          checkout_steps = double('checkout_steps')
+          allow(order).to receive(:checkout_steps).and_return(checkout_steps)
+          allow(checkout_steps).to receive(:include?).and_return(true)
+          request.env['HTTP_REFERER'] = 'test/cart'
+        end
+
+        describe 'response' do
+          before { send_request }
+          it { expect(response).to have_http_status(200) }
+        end
+
+        describe 'expect to not receive' do
+          it { expect(controller).not_to receive(:track_activity) }
+          after { send_request }
+        end
+      end
+
+    end
+  end
+
+  describe '#empty' do
+    def send_request
+      put :empty
+    end
+
+    before do
+      allow(order).to receive(:empty!)
+      request.env['HTTP_REFERER'] = 'test/cart'
+    end
+
+    describe 'expects to receive' do
+      it { expect(user).to receive(:orders).and_return(Spree::Order.all) }
+      it { expect(controller).to receive(:track_activity).and_return(checkout_event) }
+      it { expect(controller).to receive(:check_authorization).and_return(true) }
+      it { expect(controller).to receive(:current_order).and_return(order) }
+      it { expect(controller).to receive(:spree_current_user).and_return(user) }
+      it { expect(controller).to receive(:current_order).and_return(order) }
+      it { expect(order).to receive(:empty!) }
+
+      after { send_request }
+    end
+
+
+    describe 'assigns' do
+      before { send_request }
+      it { expect(controller.track_activity).to be_instance_of(Spree::CheckoutEvent) }
+    end
+
+    describe 'response' do
+      before { send_request }
+      it { expect(response).to have_http_status(302) }
+    end
+  end
+
+end