solidus_events_tracker 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5207d6b6f9bdac0e62f5dd4d215fda33e732ca77
-  data.tar.gz: bb4db818202615ad96a2f28c16bd4ab315f5676f
+  metadata.gz: fc9d932b29081cbbb4a1b13d092b2016a85a7211
+  data.tar.gz: 6b6aede72f41dbcc4fb0a399e362e42582fbed1c
 SHA512:
-  metadata.gz: fbcd05b501b6f197f50e6b7aa631345101e0e9c41b6cc7530e99af5fa80099ff26e9c2ea2071b424900da9e6e12d0f00bbd46b2d892ce2941dd2034a7a5b78db
-  data.tar.gz: 38ece47268bddae954490d74d3e86a0fd634a7dc6f87d43c55c377482cb39211d45705aa5ec933865d0d5584acdb53a74dd9b0db5d170248ac806e3e481b071a
+  metadata.gz: 62f76b683cbd06af0b23504b33b7373864907d33c2cc664d5784464d865fc0feed7855885ad72aaedad5817b3fb6cab2687819b4a510f61696207f019a43b0cb
+  data.tar.gz: 5ddefadfa935923d548ab35b044c62f518711de9a82098625ae9cc811c239c1b1e8ff39fa4d41e9cf4871cb87f17cb315dbf7b284a90d185b5dd4d0eaa0fcc8a

data/.gitignore

@@ -0,0 +1,73 @@
+\#*
+*~
+.#*
+*.sassc
+*.DS_Store
+.sass-cache
+coverage
+Gemfile.lock
+.idea
+.project
+nbproject
+.ruby-gemset
+pkg
+*.swp
+spec/dummy
+
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.ruby-version
+/test
+/config/*.yml
+*.log
+/public/test_files
+/public/system/*
+/public/*.json
+.byebug_history
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+*.gem
+/.config
+/InstalledFiles
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/*
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'solidus', '~> 2.1'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2017 [Vinsol & community]
+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,52 @@
+Solidus Events Tracker
+==================
+
+Solidus Port for Spree Events Tracker.
+
+Tracks user activity and events on the server side. Use Solidus Admin Insights to build reports of user activity.
+
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+  ```ruby
+  gem 'solidus_events_tracker'
+  ```
+
+2. Install the gem using Bundler:
+  ```ruby
+  bundle install
+  ```
+
+3. Copy & run migrations
+  ```ruby
+  bundle exec rails g solidus_events_tracker:install
+  ```
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+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 'solidus_events_tracker/factories'
+```
+
+
+Credits
+-------
+
+[![vinsol.com: Ruby on Rails, iOS and Android developers](http://vinsol.com/vin_logo.png "Ruby on Rails, iOS and Android developers")](http://vinsol.com)
+
+Copyright (c) 2017 [vinsol.com](http://vinsol.com "Ruby on Rails, iOS and Android developers"), released under the New MIT License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_events_tracker'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

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

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

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

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

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

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/concerns/spree/checkout_event_tracker.rb

@@ -0,0 +1,28 @@
+module Spree
+  module CheckoutEventTracker
+    extend ActiveSupport::Concern
+
+    def track_activity(attributes)
+      default_attributes = {
+                             referrer: request.referrer,
+                             actor: spree_current_user,
+                             target: @order,
+                             session_id: session.id
+                           }
+      Spree::Checkout::Event::Tracker.new(default_attributes.merge(attributes)).track
+    end
+
+    def next_state
+      @next_state ||= checkout_state(request.url)
+    end
+
+    def previous_state
+      referrer = request.referrer
+      @previous_state ||= (referrer ? checkout_state(referrer) : nil)
+    end
+
+    def checkout_state(request_path)
+      request_path.split('/').last.split('?').first
+    end
+  end
+end

data/app/controllers/concerns/spree/page_tracker.rb

@@ -0,0 +1,55 @@
+module Spree
+  module PageTracker
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def track_actions(actions = [])
+        after_action :track_event, only: actions
+      end
+    end
+
+    def track_event
+      if event_trackable?
+        Spree::Page::Event::Tracker.new(
+          session_id: session.id,
+          referrer: request.referrer,
+          actor: current_spree_user,
+          target: instance_variable_get("@#{ controller_name.singularize }"),
+          activity: get_activity,
+          search_keywords: get_keywords,
+          query_string: request.query_string
+        ).track
+      end
+    end
+
+    def get_activity
+      if index_action?
+        if @searcher && (@searcher.keywords || @searcher.search)
+          Spree::Page::Event::Tracker::EVENTS[:search]
+        else
+          Spree::Page::Event::Tracker::EVENTS[:index]
+        end
+      elsif show_action?
+        if @searcher && @searcher.search
+          Spree::Page::Event::Tracker::EVENTS[:filter]
+        else
+          Spree::Page::Event::Tracker::EVENTS[:show]
+        end
+      end
+    end
+
+    def get_keywords
+      @searcher && (@searcher.search.to_s + @searcher.keywords.to_s)
+    end
+
+    def event_trackable?
+      show_action? || index_action?
+    end
+
+    %w(index show).each do |_action_|
+      define_method("#{ _action_ }_action?") do
+        action_name == _action_
+      end
+    end
+  end
+end

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,22 @@
+Spree::CheckoutController.class_eval do
+
+  include Spree::CheckoutEventTracker
+
+  after_action :track_order_state_change, only: :edit
+  after_action :track_order_completion, only: :update, if: :confirm?
+
+  private
+    def confirm?
+      previous_state == 'confirm'
+    end
+
+    def track_order_completion
+      track_activity(activity: :complete_order, previous_state: previous_state, next_state: 'complete')
+    end
+
+    def track_order_state_change
+      unless previous_state == next_state
+        track_activity(activity: :change_order_state, previous_state: previous_state, next_state: next_state)
+      end
+    end
+end

data/app/controllers/spree/home_controller_decorator.rb

@@ -0,0 +1,4 @@
+Spree::HomeController.class_eval do
+  include Spree::PageTracker
+  track_actions [:index]
+end

data/app/controllers/spree/orders_controller_decorator.rb

@@ -0,0 +1,32 @@
+Spree::OrdersController.class_eval do
+
+  include Spree::CheckoutEventTracker
+
+  after_action :track_return_to_cart, only: :edit, if: :current_order
+  after_action :track_empty_cart_activity, only: :empty
+
+  private
+    def track_empty_cart_activity
+      track_activity(activity: :empty_cart, previous_state: previous_state, next_state: nil)
+    end
+
+    def track_return_to_cart
+      preceeding_state = referred_from_any_checkout_step? ? previous_state : nil
+      unless preceeding_state == next_state
+        track_activity(activity: activity, previous_state: preceeding_state, next_state: next_state)
+      end
+    end
+
+    def activity
+      !(referred_from_any_checkout_step?) ? :initialize_order : :return_to_cart
+    end
+
+    def current_order_includes_previous_state?
+      current_order.checkout_steps.include?(previous_state)
+    end
+
+    def referred_from_any_checkout_step?
+      current_order_includes_previous_state? || previous_state.eql?('cart')
+    end
+
+end

data/app/controllers/spree/products_controller_decorator.rb

@@ -0,0 +1,4 @@
+Spree::ProductsController.class_eval do
+  include Spree::PageTracker
+  track_actions [:show, :index]
+end

data/app/controllers/spree/taxons_controller_decorator.rb

@@ -0,0 +1,4 @@
+Spree::TaxonsController.class_eval do
+  include Spree::PageTracker
+  track_actions [:show]
+end

data/app/models/concerns/spree/order_contents_decorator.rb

@@ -0,0 +1,38 @@
+module Spree
+  module OrderContentsWithTracker
+
+    # Override: since order's line_items were overridden
+    def update_cart(params)
+      if order.update_attributes(params)
+        order.line_items.select(&:quantity_previously_changed?).each do |line_item|
+          Spree::Cart::Event::Tracker.new(
+            actor: order, target: line_item, total: order.total, variant_id: line_item.variant_id
+          ).track
+        end
+        # line_items which have 0 quantity will be lost and couldn't be tracked
+        # so tracking is done before the execution of next statement
+        order.line_items = order.line_items.select { |li| li.quantity > 0 }
+        reload_totals
+        PromotionHandler::Cart.new(order).activate
+        order.ensure_updated_shipments
+        reload_totals
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+    # Override: Add tracking entry after a line_item is added or removed
+    def after_add_or_remove(line_item, options = {})
+      line_item = super
+      Spree::Cart::Event::Tracker.new(
+        actor: order, target: line_item, total: order.total, variant_id: line_item.variant_id
+      ).track
+      line_item
+    end
+  end
+end
+
+Spree::OrderContents.send(:prepend, Spree::OrderContentsWithTracker)

data/app/models/spree/cart_event.rb

@@ -0,0 +1,20 @@
+module Spree
+  class CartEvent < Spree::Base
+
+    belongs_to :actor, polymorphic: true
+    belongs_to :target, polymorphic: true
+    belongs_to :variant
+    has_one :product, through: :variant
+
+    validates :activity,
+              :actor,
+              :quantity,
+              :target,
+              :total,
+              :variant, presence: true
+
+    scope :added,   -> { where(activity: 'add')    }
+    scope :removed, -> { where(activity: 'remove') }
+    scope :updated, -> { where(activity: 'update') }
+  end
+end

data/app/models/spree/checkout_event.rb

@@ -0,0 +1,11 @@
+module Spree
+  class CheckoutEvent < Spree::Base
+
+    belongs_to :actor, polymorphic: true
+    belongs_to :target, polymorphic: true
+
+    validates :activity,
+              :session_id,
+              :target, presence: true
+  end
+end