spree_piwik 0.0.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmM0NWQ2NmY5ZTQ5YmUzZjU0MzViYzYxYzA4ZTZlMWY3Nzc4MWQxMA==
+    M2U5ZGU3MmIzMzA5MjcwMDQ1MGVjNmQzNWFmNzBlMDJlYjBhNDQyYQ==
   data.tar.gz: !binary |-
-    MjI0OWI2ZTJiZWNjNGFiZjE3ZGI3M2ZkNWY4NzZjOGM0ODVhNGJjOQ==
+    NDI0NzM1NGU4M2ExMzZjMzVjMjc4YzZlOWI3ZDFmOTI1NDgzZWU0OA==
 SHA512:
   metadata.gz: !binary |-
-    ZDg4MmJmZjI2ZDQyNmVkNmRmMDVjMDFhMjJjNjk0MzAzNTliNTFkYjY4Yjgx
-    NzYyOWEzMzNkMTYzYWRkNWNiZGM5N2QwMThhNzJlYzg2OTkwYWMxNjVkZDQz
-    MzliZjI3Mzg4MGRmODIxNjVmMjFlZTdiN2M5ZTFiODY0MjQzYWI=
+    ZDg0ZjI5NDQ3MzBmYjM1ODJiNTM2ZDQyYmQ1MDdiZDdhZjcxZGY4OGRiNmE1
+    YmY4MWE1NTczMGVkNDZhYTBiOWMzM2Y0MWVhMDdhZTU0ZTNhMjg0YjJhMGJh
+    MzExYzMyZDU1ZjM3MWQ4NzU5NzQ1ODlhOGY2ZWVlNTExMmQwNDY=
   data.tar.gz: !binary |-
-    YmZlYTBiNGRjYzM3OTBlY2ZjOTVkMWU1MTRmYmI0NzE3MDVmNDJkNzJlZmQx
-    M2EwOWVlMjljNThhZmNkMWNkODc4ZWI1YTU2MWI4OGZjNTMzZGQ3OGQwYTk1
-    ZDJhOTRkMDQwOGU4OTUxODBmNGMwM2MwNjE0ZWU3ZDc3NTA1ZDM=
+    NmQwMWMxNmM5OGI5ZTlkNDE0MzNlODVhODQxOTg1YjVhNzcxODQzZWYzYzY2
+    Zjk3YzYyMTlmZGY4YjJmNmJiY2I2MjgyMjNjNjJhM2YxYTYyZWQ0NjI2N2Rm
+    MTJjMDdkNmU5MzNhMGVhMTRiZmFlMzk0MjAzMTA1OGFmZGRiYzI=

data/README.md

@@ -25,6 +25,23 @@ bundle
 bundle exec rails g spree_piwik:install
 ```
 
+Add your Piwik URL and site-id to the `config/initializers/spree_piwik.rb`
+
+For example:
+```ruby
+Spree::Piwik::Config[:piwik_url] = "piwik.example.com"
+Spree::Piwik::Config[:piwik_id] =  1337
+
+```
+Will use http(s)://piwik.example.com/ as url for your Piwik. And track
+stats for the site that has the id 1337 in Piwik.
+
+
+Screenshot
+----------
+
+![Screenshot of the Ecommerce functionality in action with this extension](doc/spree_piwik.png).
+
 Testing
 -------
 
@@ -38,4 +55,8 @@ 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
+
+License
+-------
+
+SpreePiwik is released under the [New BSD License](https://github.com/spree/spree/blob/master/license.md) similar to Spree.

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

@@ -18,11 +18,22 @@ module Spree
       end
 
       def ecommerce_items
-        @order.line_items.map { |li| LineItem.from_product_ish(li) }
+        @order.line_items.map do |li|
+          Spree::Piwik::LineItem.from_product_ish(li)
+        end
       end
 
       def track_cart_update?
-        !@order.nil? && @order.cart?
+        order? && @order.cart?
+      end
+
+      def track_ecommerce_order?
+        order? && @order.complete?
+      end
+
+      private
+      def order?
+        !@order.nil?
       end
     end
   end

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

@@ -0,0 +1,8 @@
+_paq.push(['trackEcommerceOrder',
+  '<%= order.number %>',
+  <%= order.total %>,
+  <%= order.item_total %>,
+  <%= order.tax_total %>,
+  <%= order.ship_total %>,
+  false
+  ]);

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

@@ -7,9 +7,14 @@
   <%- if piwik_client.product %>
     <%= render partial: 'spree/ecommerce_view', locals: { product: piwik_client.product } %>
   <% end %>
-  <% if piwik_client.track_cart_update? %>
+  <% if piwik_client.order %>
     <%= render :partial => 'spree/ecommerce_item', :collection => piwik_client.ecommerce_items %>
+  <% end %>
+  <% if piwik_client.track_cart_update? %>
     _paq.push(['trackEcommerceCartUpdate', <%= piwik_client.order.total %>]);
+  <% end %>
+  <% if piwik_client.track_ecommerce_order? %>
+    <%= render :partial => 'spree/ecommerce_order', locals: { order:  piwik_client.order } %>
   <% end %>
     _paq.push(['trackPageView']);
     _paq.push(['enableLinkTracking']);

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

@@ -2,30 +2,12 @@
 module SpreePiwik
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../templates", __FILE__)
 
       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
+      def copy_initializer
+        template "spree_piwik.rb", "config/initializers/spree_piwik.rb"
       end
     end
   end

data/lib/generators/templates/spree_piwik.rb

@@ -0,0 +1,4 @@
+# Configure Spree
+# Uncomment these lines and provide your own values.
+# Spree::Piwik::Config[:piwik_url] = "piwik.example.com"
+# Spree::Piwik::Config[:piwik_id] =  1337

data/spec/features/order_process_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+feature "OrderProcess", type: :feature do
+  scenario "An anonymous gets a checkout confirmation" do
+    @order = create(:completed_order_with_totals, number: 'R1337', line_items_count: 2)
+    @order.products.first.update_attributes(name: "RoR Shirt")
+    @order.products.second.update_attributes(name: "RoR Sticker")
+
+    # FactoryGirl is not very suited for these setups.
+    # So we stick with the default of 100 for shipment 0 for tax.
+    # Sanity check.
+    expect(@order.ship_total).to eq 100.0
+    expect(@order.tax_total).to eq 0.0
+
+    visit "orders/#{@order.number}/token/#{@order.guest_token}"
+
+    tag_component = PiwikTagComponent.new
+    expect(tag_component.as_ecma).to eq fixture("completed_order.js")
+  end
+end

data/spec/features/visit_product_page_spec.rb

@@ -6,9 +6,7 @@ feature "TrackingTagForProduct", type: :feature do
   # 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)
+    visit "/products/#{@product.slug}"
 
     # Sanity check
     expect(page).to have_content @product.name
@@ -30,12 +28,7 @@ feature "TrackingTagForProduct", type: :feature do
     ]
     @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
+    visit "/products/#{@product.slug}"
 
     tag_component = PiwikTagComponent.new
     expect(tag_component).to be_in_html

data/spec/fixtures/completed_order.js

@@ -0,0 +1,30 @@
+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',
+  [],
+  10.0,
+  1
+  ]);
+_paq.push(['addEcommerceItem',
+  'SKU-2',
+  'RoR Sticker',
+  [],
+  10.0,
+  1
+  ]);
+_paq.push(['trackEcommerceOrder',
+  'R1337',
+  120.0,
+  20.0,
+  0.0,
+  100.0,
+  false
+  ]);
+_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/models/spree/piwik/client_spec.rb

@@ -68,4 +68,25 @@ describe Spree::Piwik::Client, type: :model do
       end
     end
   end
+
+  describe "#track_ecommerce_order?" do
+    context 'when order with state complete is set' do
+      it 'is true' do
+        order = double(:order, complete?: true)
+        expect(Spree::Piwik::Client.new(order: order).track_ecommerce_order?).to eq true
+      end
+    end
+
+    context 'when order state is not complete' do
+      it 'is false' do
+        order = double(:order, complete?: false)
+        expect(Spree::Piwik::Client.new(order: order).track_ecommerce_order?).to eq false
+      end
+    end
+    context 'when order is empty' do
+      it 'is false' do
+        expect(subject.track_ecommerce_order?).to eq false
+      end
+    end
+  end
 end

data/spree_piwik.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_piwik'
-  s.version     = '0.0.1'
+  s.version     = '1.0.0'
   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'
@@ -10,26 +10,27 @@ Gem::Specification.new do |s|
   s.author    = 'Bèr Kessels'
   s.email     = 'ber@berk.es'
   s.homepage  = 'http://berk.es'
+  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'
 
-  s.add_dependency 'spree_core', '~> 2.3.6'
+  s.add_dependency 'spree_core', '~> 2.3'
 
-  s.add_development_dependency 'therubyracer'
+  s.add_development_dependency 'therubyracer', '~> 0.12'
   s.add_development_dependency 'capybara', '~> 2.4'
-  s.add_development_dependency 'coffee-rails'
-  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'coffee-rails', '~> 4.1'
+  s.add_development_dependency 'database_cleaner', '~> 1.4'
   s.add_development_dependency 'factory_girl', '~> 4.5'
-  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'ffaker', '~> 1'
   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'
+  s.add_development_dependency 'spring-commands-rspec', '~> 1'
+  s.add_development_dependency 'rkelly-remix', '~> 0'
+  s.add_development_dependency 'launchy', '~> 2.4'
+  s.add_development_dependency 'sass-rails', '~> 4.0'
+  s.add_development_dependency 'selenium-webdriver', '~> 2.44'
+  s.add_development_dependency 'simplecov', '~> 0'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_piwik
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Bèr Kessels
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-22 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.6
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.6
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: therubyracer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -56,30 +56,30 @@ dependencies:
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,16 @@ dependencies:
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -126,100 +126,100 @@ dependencies:
   name: spring-commands-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rkelly-remix
   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: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.2
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.44'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.44'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 description: ! 'SpreePiwik
 
   ==========
@@ -265,6 +265,34 @@ description: ! 'SpreePiwik
   ```
 
 
+  Add your Piwik URL and site-id to the `config/initializers/spree_piwik.rb`
+
+
+  For example:
+
+  ```ruby
+
+  Spree::Piwik::Config[:piwik_url] = "piwik.example.com"
+
+  Spree::Piwik::Config[:piwik_id] =  1337
+
+
+  ```
+
+  Will use http(s)://piwik.example.com/ as url for your Piwik. And track
+
+  stats for the site that has the id 1337 in Piwik.
+
+
+
+  Screenshot
+
+  ----------
+
+
+  ![Screenshot of the Ecommerce functionality in action with this extension](doc/spree_piwik.png).
+
+
   Testing
 
   -------
@@ -290,7 +318,14 @@ description: ! 'SpreePiwik
   Simply add this require statement to your spec_helper:
 
 
-  Copyright (c) 2015 Bèr Kessels
+
+  License
+
+  -------
+
+
+  SpreePiwik is released under the [New BSD License](https://github.com/spree/spree/blob/master/license.md)
+  similar to Spree.
 
 '
 email: ber@berk.es
@@ -315,6 +350,7 @@ files:
 - app/models/spree/piwik_configuration.rb
 - app/overrides/add_piwik_tracking_tag_to_layout.rb
 - app/views/spree/_ecommerce_item.html.erb
+- app/views/spree/_ecommerce_order.html.erb
 - app/views/spree/_ecommerce_view.html.erb
 - app/views/spree/_piwik.html.erb
 - bin/rails
@@ -322,12 +358,16 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - config/spring.rb
+- doc/spree_piwik.png
 - lib/generators/spree_piwik/install/install_generator.rb
+- lib/generators/templates/spree_piwik.rb
 - lib/spree/piwik/engine.rb
 - lib/spree_piwik.rb
 - spec/features/interact_with_cart_spec.rb
+- spec/features/order_process_spec.rb
 - spec/features/visit_home_pages_spec.rb
 - spec/features/visit_product_page_spec.rb
+- spec/fixtures/completed_order.js
 - spec/fixtures/empty_cart.js
 - spec/fixtures/index_example_com.js
 - spec/fixtures/multiple_products_in_cart.js
@@ -344,7 +384,8 @@ files:
 - spec/support/helpers/fixture_helpers.rb
 - spree_piwik.gemspec
 homepage: http://berk.es
-licenses: []
+licenses:
+- BSD-3
 metadata: {}
 post_install_message: 
 rdoc_options: []