spree_piwik 0.0.1

data/spec/fixtures/empty_cart.js

@@ -0,0 +1,9 @@
+var _paq = _paq || [];
+(function(){ var u=(('https:' == document.location.protocol) ? 'https://example.com/' : 'http://example.com/');
+_paq.push(['setSiteId', 0]);
+_paq.push(['setTrackerUrl', u+'piwik.php']);
+_paq.push(['trackEcommerceCartUpdate', 0.0]);
+_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); })();

data/spec/fixtures/index_example_com.js

@@ -0,0 +1,8 @@
+var _paq = _paq || [];
+(function(){ var u=(('https:' == document.location.protocol) ? 'https://piwik.example.com/' : 'http://piwik.example.com/');
+_paq.push(['setSiteId', 1337]);
+_paq.push(['setTrackerUrl', u+'piwik.php']);
+_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); })();

data/spec/fixtures/multiple_products_in_cart.js

@@ -0,0 +1,23 @@
+var _paq = _paq || [];
+(function(){ var u=(('https:' == document.location.protocol) ? 'https://example.com/' : 'http://example.com/');
+_paq.push(['setSiteId', 0]);
+_paq.push(['setTrackerUrl', u+'piwik.php']);
+_paq.push(['addEcommerceItem',
+  'SKU-1',
+  'RoR Shirt',
+  [],
+  19.99,
+  1
+  ]);
+_paq.push(['addEcommerceItem',
+  'SKU-2',
+  'RoR Sticker',
+  [],
+  0.99,
+  1
+  ]);
+_paq.push(['trackEcommerceCartUpdate', 20.98]);
+_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); })();

data/spec/fixtures/one_product_in_cart.js

@@ -0,0 +1,16 @@
+var _paq = _paq || [];
+(function(){ var u=(('https:' == document.location.protocol) ? 'https://example.com/' : 'http://example.com/');
+_paq.push(['setSiteId', 0]);
+_paq.push(['setTrackerUrl', u+'piwik.php']);
+_paq.push(['addEcommerceItem',
+  'SKU-1',
+  'RoR Shirt',
+  [],
+  19.99,
+  1
+  ]);
+_paq.push(['trackEcommerceCartUpdate', 19.99]);
+_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); })();

data/spec/fixtures/product_example_com.js

@@ -0,0 +1,14 @@
+var _paq = _paq || [];
+(function(){ var u=(('https:' == document.location.protocol) ? 'https://example.com/' : 'http://example.com/');
+_paq.push(['setSiteId', 0]);
+_paq.push(['setTrackerUrl', u+'piwik.php']);
+_paq.push(['setEcommerceView',
+  'SKU-1',
+  'RoR Shirt',
+  [],
+  19.99
+  ]);
+_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); })();

data/spec/fixtures/product_with_categories.js

@@ -0,0 +1,14 @@
+ var _paq = _paq || [];
+ (function(){ var u=(('https:' == document.location.protocol) ? 'https://example.com/' : 'http://example.com/');
+ _paq.push(['setSiteId', 0]);
+ _paq.push(['setTrackerUrl', u+'piwik.php']);
+ _paq.push(['setEcommerceView',
+   'SKU-1',
+   'RoR Shirt',
+   ["shirts","ror","webdev"],
+   19.99
+   ]);
+ _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); })();

data/spec/helpers/spree/base_helper_decorator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Spree::BaseHelper, type: :helper do
+  describe "#piwik_client" do
+    it 'returns a PiwikClient' do
+      expect(helper.piwik_client).to be_an_instance_of(Spree::Piwik::Client)
+    end
+
+    it 'memoizes the piwik_client' do
+      expect(helper.piwik_client).to be helper.piwik_client
+    end
+
+    context 'when there is an @product' do
+      before { @product = assign(:product, double(:product)) }
+      it 'passes in @product' do
+        expect(Spree::Piwik::Client).to receive(:new).with(hash_including(product: @product))
+        helper.piwik_client
+      end
+    end
+
+    context 'when there is no @product' do
+      it 'passes in nil' do
+        expect(helper.piwik_client.product).to be_nil
+      end
+    end
+
+    context 'when there is an @order' do
+      before { @order = assign(:order, double(:order)) }
+      it 'passes in the order' do
+        expect(Spree::Piwik::Client).to receive(:new).with(hash_including(order: @order))
+        helper.piwik_client
+      end
+    end
+  end
+end

data/spec/models/spree/piwik/client_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Spree::Piwik::Client, type: :model do
+  it 'fetches the url from preferences' do
+    allow(Spree::Piwik::Config).to receive(:preferred_piwik_url).and_return 'piwik.example.com'
+    expect(subject.url).to eq 'piwik.example.com'
+  end
+
+  it 'fetches the piwik_id from preferences' do
+    allow(Spree::Piwik::Config).to receive(:preferred_piwik_id).and_return 1337
+    expect(subject.site_id).to eq 1337
+  end
+
+  describe '#product' do
+    context 'when it has a product' do
+      before { subject.product = double(:product, sku: 'sku', name: nil, price: nil, taxons: []) }
+      it 'is an line_item with that product' do
+        expect(subject.product).to be_a_kind_of Spree::Piwik::LineItem
+        expect(subject.product.sku).to eq 'sku'
+      end
+    end
+
+    context 'when it has no product' do
+      before { subject.product = nil }
+      it 'is nil' do
+        expect(subject.product).to be_nil
+      end
+    end
+  end
+
+  describe '#order' do
+    it 'can be set on initialisation' do
+      order = double(:order)
+      expect(Spree::Piwik::Client.new(order: order).order).to eq order
+    end
+  end
+
+  describe '#ecommerce_items' do
+    context 'when order is set' do
+      it 'has the ine_items in the order' do
+        product = double(:product, sku: 'sku', name: 'name', price: 'price', quantity: 1)
+        subject.order = double(:order, line_items: [product])
+        expect(subject.ecommerce_items.first).to be_a_kind_of Spree::Piwik::LineItem
+        expect(subject.ecommerce_items.first.sku).to eq 'sku'
+        expect(subject.ecommerce_items.first.quantity).to eq 1
+      end
+    end
+  end
+
+  describe '#track_cart_update?' do
+    context 'when order with state cart is set' do
+      it 'is true' do
+        order = double(:order, cart?: true)
+        expect(Spree::Piwik::Client.new(order: order).track_cart_update?).to eq true
+      end
+    end
+
+    context 'when order state is not cart' do
+      it 'is false' do
+        order = double(:order, cart?: false)
+        expect(Spree::Piwik::Client.new(order: order).track_cart_update?).to eq false
+      end
+    end
+
+    context 'when order is empty' do
+      it 'is false' do
+        expect(subject.track_cart_update?).to eq false
+      end
+    end
+  end
+end

data/spec/models/spree/piwik/line_item_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Spree::Piwik::LineItem, type: :model do
+  describe '.from_product_ish' do
+    let(:product) { double(:product, sku: 'sku', name: 'name', price: 'price', quantity: 'quantity', taxons: []) }
+    let(:line_item) { Spree::Piwik::LineItem.from_product_ish(product) }
+
+    it 'instantiates self from a line_item-ish item' do
+      expect(line_item).to be_a_kind_of Spree::Piwik::LineItem
+      expect(line_item.sku).to eq 'sku'
+      expect(line_item.name).to eq 'name'
+      expect(line_item.price).to eq 'price'
+      expect(line_item.quantity).to eq 'quantity'
+      expect(line_item.categories).to eq []
+    end
+
+    describe '#categories' do
+      let(:taxon) { double(:taxon, name: 'shirts') }
+      context 'when it has a product with taxons' do
+        before { allow(product).to receive(:taxons).and_return([taxon]) }
+        it 'returns the name of the taxons of the product' do
+          expect(line_item.categories).to match_array ['shirts']
+        end
+      end
+
+      context 'when it has a product with more then 5 taxons' do
+        before { allow(product).to receive(:taxons).and_return(Array.new(6, taxon)) }
+        it 'limits the categories to five items' do
+          expect(line_item.categories.length).to eq 5
+        end
+      end
+
+      context 'when it has a product with no taxons' do
+        before { allow(product).to receive(:taxons).and_return([]) }
+        it 'returns an empty array' do
+          expect(line_item.categories).to eq []
+        end
+      end
+    end
+  end
+
+  describe '#sku' do
+    it { expect(subject).to respond_to :sku }
+    it { expect(subject).to respond_to :sku= }
+  end
+  describe '#name' do
+    it { expect(subject).to respond_to :name }
+    it { expect(subject).to respond_to :name= }
+  end
+  describe '#price' do
+    it { expect(subject).to respond_to :price }
+    it { expect(subject).to respond_to :price= }
+  end
+  describe '#quantity' do
+    it { expect(subject).to respond_to :quantity }
+    it { expect(subject).to respond_to :quantity= }
+  end
+
+end

data/spec/models/spree/piwik_configuration_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Spree::PiwikConfiguration do
+  it 'has a default piwik_url example.com' do
+    expect(Spree::Piwik::Config.preferred_piwik_url).to eq 'example.com'
+  end
+
+  it 'has a default piwik_id 0' do
+    expect(Spree::Piwik::Config.preferred_piwik_id).to eq 0
+  end
+end

data/spec/overrides/add_piwik_tracking_tag_to_layout_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe "deface override call" do
+  subject { Deface::Override.find(virtual_path: "spree/layouts/spree_application").first }
+
+  it "triggers on spree_application layout" do
+    expect(subject.name).to eq "add_piwik_tracking_tag_to_layout"
+  end
+
+  it "inserts at the bottom of the body tag" do
+    selector = %([data-hook='body'])
+    expect(subject.selector).to eq selector
+    expect(subject.args[:insert_bottom]).to eq selector
+  end
+
+  it "users spree/piwik partial" do
+    expect(subject.source_argument).to eq :partial
+    expect(subject.args[:partial]).to eq 'spree/piwik'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/dummy'
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'launchy'
+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 and other useful helpers defined in spree_core.
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/capybara_ext'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/factories'
+require 'spree/testing_support/url_helpers'
+require 'spree/testing_support/preferences'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # Infer an example group's spec type from the file location.
+  config.infer_spec_type_from_file_location!
+
+  # == 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
+
+  # Allow resetting of config.
+  config.include Spree::TestingSupport::Preferences
+
+  ## == Fixture Helpers
+  #
+  # Allows access to fixture files
+  config.include FixtureHelpers
+
+  # == 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 = File.join(File.dirname(__FILE__), '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
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = RSpec.current_example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+
+    reset_spree_preferences
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+  config.order = "random"
+end

data/spec/support/components/piwig_tag_component.rb

@@ -0,0 +1,37 @@
+require 'rkelly'
+
+class PiwikTagComponent
+  extend Capybara::DSL
+  include Capybara::DSL
+
+  def in_html?
+    return false if script_tag.empty?
+    page.body.include?('<!-- Piwik -->') && page.body.include?('<!-- End Piwik Code -->')
+  end
+
+  def tracker_url_assigment
+    script_tag.to_s.lines.find { |l| l.match(/var u=/) }.strip
+  end
+
+  def to_s
+    script_tag.to_s
+  end
+
+  def as_ecma
+    parser.parse(script_tag.text).to_ecma
+  end
+
+  private
+
+  def parser
+    @parser ||= RKelly::Parser.new
+  end
+
+  def script_tag
+    doc.xpath('//body/script')
+  end
+
+  def doc
+    Nokogiri::HTML(page.body)
+  end
+end

data/spec/support/helpers/fixture_helpers.rb

@@ -0,0 +1,11 @@
+module FixtureHelpers
+  def fixture(filename)
+    parser.parse(File.read(File.join(fixture_path, filename))).to_ecma
+  end
+
+  private
+
+  def parser
+    @parser ||= RKelly::Parser.new
+  end
+end

data/spree_piwik.gemspec

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_piwik'
+  s.version     = '0.0.1'
+  s.summary     = 'Adds piwik tracking with Ecommerce tracking'
+  s.description = File.read(File.join(File.dirname(__FILE__), 'README.md'))
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Bèr Kessels'
+  s.email     = 'ber@berk.es'
+  s.homepage  = 'http://berk.es'
+
+  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', '~> 2.3.6'
+
+  s.add_development_dependency 'therubyracer'
+  s.add_development_dependency 'capybara', '~> 2.4'
+  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'
+  s.add_development_dependency 'rspec-rails',  '~> 3.1'
+  s.add_development_dependency 'spring-commands-rspec'
+  s.add_development_dependency 'rkelly-remix'
+  s.add_development_dependency 'launchy'
+  s.add_development_dependency 'sass-rails', '~> 4.0.2'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'sqlite3'
+end