spree_piwik 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmM0NWQ2NmY5ZTQ5YmUzZjU0MzViYzYxYzA4ZTZlMWY3Nzc4MWQxMA==
+  data.tar.gz: !binary |-
+    MjI0OWI2ZTJiZWNjNGFiZjE3ZGI3M2ZkNWY4NzZjOGM0ODVhNGJjOQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZDg4MmJmZjI2ZDQyNmVkNmRmMDVjMDFhMjJjNjk0MzAzNTliNTFkYjY4Yjgx
+    NzYyOWEzMzNkMTYzYWRkNWNiZGM5N2QwMThhNzJlYzg2OTkwYWMxNjVkZDQz
+    MzliZjI3Mzg4MGRmODIxNjVmMjFlZTdiN2M5ZTFiODY0MjQzYWI=
+  data.tar.gz: !binary |-
+    YmZlYTBiNGRjYzM3OTBlY2ZjOTVkMWU1MTRmYmI0NzE3MDVmNDJkNzJlZmQx
+    M2EwOWVlMjljNThhZmNkMWNkODc4ZWI1YTU2MWI4OGZjNTMzZGQ3OGQwYTk1
+    ZDJhOTRkMDQwOGU4OTUxODBmNGMwM2MwNjE0ZWU3ZDc3NTA1ZDM=

data/.gitignore

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

data/.hound.yml

@@ -0,0 +1,2 @@
+java_script:
+  config_file: config/.jshint.json

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,41 @@
+SpreePiwik
+==========
+
+Adds piwik tracking with Ecommerce tracking
+
+Status
+------
+
+[![Build Status](https://travis-ci.org/berkes/spree_piwik.svg?branch=develop)](https://travis-ci.org/berkes/spree_piwik)
+[![Code Climate](https://codeclimate.com/github/berkes/spree_piwik/badges/gpa.svg)](https://codeclimate.com/github/berkes/spree_piwik)
+
+Installation
+------------
+
+Add spree_piwik to your Gemfile:
+
+```ruby
+gem 'spree_piwik'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_piwik:install
+```
+
+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:
+
+Copyright (c) 2015 Bèr Kessels

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'] = 'spree_piwik'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_piwik.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/spree_piwik.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/spree_piwik.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/spree_piwik.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/helpers/spree/base_helper_decorator.rb

@@ -0,0 +1,5 @@
+Spree::BaseHelper.class_eval do
+  def piwik_client
+    @piwik_client ||= Spree::Piwik::Client.new(product: @product, order: @order)
+  end
+end

data/app/models/spree/piwik/client.rb

@@ -0,0 +1,29 @@
+module Spree
+  module Piwik
+    class Client
+      include ActiveModel::Model
+
+      attr_accessor :product, :order
+
+      def product
+        Spree::Piwik::LineItem.from_product_ish(@product) if @product
+      end
+
+      def url
+        Spree::Piwik::Config.preferred_piwik_url
+      end
+
+      def site_id
+        Spree::Piwik::Config.preferred_piwik_id
+      end
+
+      def ecommerce_items
+        @order.line_items.map { |li| LineItem.from_product_ish(li) }
+      end
+
+      def track_cart_update?
+        !@order.nil? && @order.cart?
+      end
+    end
+  end
+end

data/app/models/spree/piwik/line_item.rb

@@ -0,0 +1,44 @@
+module Spree
+  module Piwik
+    class LineItem
+      include ActiveModel::Model
+
+      ATTRIBUTES = [:sku, :name, :price, :quantity, :categories]
+      attr_accessor(*ATTRIBUTES)
+
+      ##
+      # Create a LineItem from a Spree::LinteItem-ish thing (line_items,
+      # products, variants)
+      #
+      # All attributes in ATTRIBUTES will be mapped:
+      #
+      # When we add a (private) method with the name
+      # map_product_ish_sku, this method will be called and get the
+      # product_ish to generate a value for that attribute.
+      #
+      # When the product_ish has the same attribute name and no
+      # mapping-method provided the value, it will simply use the value
+      # from that attribute on product_ish
+      def self.from_product_ish(product_ish)
+        values = ATTRIBUTES.map { |a| [a, product_ish_attr(a, product_ish)] }
+        new(Hash[values])
+      end
+
+      # Private
+      def self.product_ish_attr(attr_name, product_ish)
+        mapping_method = "map_product_ish_#{attr_name}".to_sym
+        if respond_to?(mapping_method)
+          send(mapping_method, product_ish)
+        else
+          product_ish.try(attr_name)
+        end
+      end
+
+      # Private
+      def self.map_product_ish_categories(product_ish)
+        defaulted_taxons = product_ish.try(:taxons) || []
+        defaulted_taxons.map(&:name).first(5)
+      end
+    end
+  end
+end

data/app/models/spree/piwik_configuration.rb

@@ -0,0 +1,4 @@
+class Spree::PiwikConfiguration < Spree::Preferences::Configuration
+  preference :piwik_url, :string, :default => "example.com"
+  preference :piwik_id,  :integer, :default => 0
+end

data/app/overrides/add_piwik_tracking_tag_to_layout.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(
+  :virtual_path => 'spree/layouts/spree_application',
+  :name => 'add_piwik_tracking_tag_to_layout',
+  :insert_bottom => "[data-hook='body']",
+  :partial => 'spree/piwik')

data/app/views/spree/_ecommerce_item.html.erb

@@ -0,0 +1,7 @@
+_paq.push(['addEcommerceItem',
+  '<%= ecommerce_item.sku %>',
+  '<%= ecommerce_item.name %>',
+  <%= raw ecommerce_item.categories.to_json %>,
+  <%= ecommerce_item.price %>,
+  <%= ecommerce_item.quantity %>
+  ]);

data/app/views/spree/_ecommerce_view.html.erb

@@ -0,0 +1,6 @@
+_paq.push(['setEcommerceView',
+  '<%= product.sku %>',
+  '<%= product.name %>',
+  <%= raw product.categories.to_json %>,
+  <%= product.price %>
+]);

data/app/views/spree/_piwik.html.erb

@@ -0,0 +1,19 @@
+<!-- Piwik -->
+<script type="text/javascript">
+    var _paq = _paq || [];
+    (function(){ var u=(('https:' == document.location.protocol) ? 'https://<%= piwik_client.url %>/' : 'http://<%= piwik_client.url %>/');
+    _paq.push(['setSiteId', <%= piwik_client.site_id %>]);
+    _paq.push(['setTrackerUrl', u+'piwik.php']);
+  <%- if piwik_client.product %>
+    <%= render partial: 'spree/ecommerce_view', locals: { product: piwik_client.product } %>
+  <% end %>
+  <% if piwik_client.track_cart_update? %>
+    <%= render :partial => 'spree/ecommerce_item', :collection => piwik_client.ecommerce_items %>
+    _paq.push(['trackEcommerceCartUpdate', <%= piwik_client.order.total %>]);
+  <% end %>
+    _paq.push(['trackPageView']);
+    _paq.push(['enableLinkTracking']);
+    var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=true; g.src=u+'piwik.js';
+    s.parentNode.insertBefore(g,s); })();
+</script>
+<!-- End Piwik Code -->

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_piwik/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/.jshint.json

@@ -0,0 +1,3 @@
+{
+  "maxlen": 110
+}

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/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = File.join('spec', 'dummy')

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

@@ -0,0 +1,32 @@
+# Must be named SpreePiwik because dummygenerator expects it
+module SpreePiwik
+  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/spree_piwik\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_piwik\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_piwik\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_piwik\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_piwik'
+      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/spree/piwik/engine.rb

@@ -0,0 +1,32 @@
+module Spree
+  module Piwik
+  end
+end
+
+
+module Spree
+  module Piwik
+    class Engine < Rails::Engine
+      require 'spree/core'
+      isolate_namespace Spree
+      engine_name 'spree_piwik'
+
+      # use rspec for tests
+      config.generators do |g|
+        g.test_framework :rspec
+      end
+
+      initializer 'spree.piwik.environment', :before => :load_config_initializers do |app|
+        Spree::Piwik::Config = Spree::PiwikConfiguration.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
+end

data/lib/spree_piwik.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree/piwik/engine'

data/spec/features/interact_with_cart_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+feature "InteractWithCart", type: :feature do
+  scenario "An anonymous user adds a product to the cart" do
+    @product = create(:product, sku: "SKU-1", name: "RoR Shirt")
+    visit "products/#{@product.slug}"
+    click_button "Add To Cart"
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component.as_ecma).to eq fixture("one_product_in_cart.js")
+  end
+
+  scenario "An anonymous user adds multiple products to the cart" do
+    @shirt = create(:product, sku: "SKU-1", name: "RoR Shirt")
+    visit "products/#{@shirt.slug}"
+    click_button "Add To Cart"
+    @sticker = create(:product, sku: "SKU-2", name: "RoR Sticker", price: 0.99)
+    visit "products/#{@sticker.slug}"
+    click_button "Add To Cart"
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component.as_ecma).to eq fixture("multiple_products_in_cart.js")
+  end
+
+  scenario "An anonymous user removes a product from cart" do
+    @shirt = create(:product, sku: "SKU-1", name: "RoR Shirt")
+    visit "products/#{@shirt.slug}"
+    click_button "Add To Cart"
+    @sticker = create(:product, sku: "SKU-2", name: "RoR Sticker", price: 0.99)
+    visit "products/#{@sticker.slug}"
+    click_button "Add To Cart"
+
+    fill_in(:order_line_items_attributes_1_quantity, with: 0)
+    click_button "Update"
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component.as_ecma).to eq fixture("one_product_in_cart.js")
+  end
+
+  scenario "An anonymous user empties a cart" do
+    @shirt = create(:product, sku: "SKU-1", name: "RoR Shirt")
+    visit "products/#{@shirt.slug}"
+    click_button "Add To Cart"
+    click_button "Empty Cart"
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component.as_ecma).to eq fixture("empty_cart.js")
+  end
+end

data/spec/features/visit_home_pages_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+feature "TrackingTagForIndex", type: :feature do
+  before do
+    # User has set piwik_url and piwik_id
+    Spree::Piwik::Config.set(piwik_url: "piwik.example.com")
+    Spree::Piwik::Config.set(piwik_id: 1337)
+  end
+
+  scenario "An anonymous user is tracked on the home page" do
+    visit "/"
+
+    # Sanity check
+    expect(page).to have_content "Powered by Spree"
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component).to be_in_html
+    expect(tag_component.tracker_url_assigment).to include("piwik.example.com")
+    expect(tag_component.as_ecma).to eq fixture("index_example_com.js")
+  end
+end

data/spec/features/visit_product_page_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+feature "TrackingTagForProduct", type: :feature do
+  # As a shop-owner
+  # I want to send stats with the product"s attributes to piwik
+  # So that I can allow Piwik to process reports on SKU and products.
+  scenario "An anonymous user is tracked on a product page" do
+    @product = create(:product, sku: "SKU-1", name: "RoR Shirt")
+    # TODO replace with visit "product/slug"
+    visit "/"
+    click_link(@product.name)
+
+    # Sanity check
+    expect(page).to have_content @product.name
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component).to be_in_html
+    expect(tag_component.to_s).to include "setEcommerceView"
+    expect(tag_component.as_ecma).to eq fixture("product_example_com.js")
+  end
+
+  # As a shop-owner
+  # I want to send the categories in a product to piwik
+  # So that can filter stats in Piwik on categories
+  scenario "An anonymous user is tracked on a product page with categories" do
+    taxons = [
+      create(:taxon, name: "shirts"),
+      create(:taxon, name: "ror"),
+      create(:taxon, name: "webdev"),
+    ]
+    @product = create(:product, sku: "SKU-1", name: "RoR Shirt", taxons: taxons)
+
+    # TODO replace with visit "product/slug"
+    visit "/"
+    click_link(@product.name)
+
+    # Sanity check
+    expect(page).to have_content @product.name
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component).to be_in_html
+    expect(tag_component.to_s).to include "setEcommerceView"
+    expect(tag_component.as_ecma).to eq fixture("product_with_categories.js")
+  end
+end