rack-piwik 0.1.3 → 0.2.0

data/README.md

@@ -29,6 +29,7 @@ This middleware *should* be thread safe. Although my experience in such areas is
 
 ## Change Log
 
+* 0.2.0  Use asynchronous JS tracking code by default
 * 0.1.0  Initial Release
 
 

data/lib/rack/piwik.rb

@@ -8,7 +8,7 @@ module Rack
 
     def initialize(app, options = {})
       raise ArgumentError, "piwik_url must be present" unless options[:piwik_url] and !options[:piwik_url].empty?
-      raise ArgumentError, "piwik_id must be present" unless options[:piwik_id] and !options[:piwik_id].empty?
+      raise ArgumentError, "piwik_id must be present" unless options[:piwik_id] and !options[:piwik_id].to_s.empty?
       @app, @options = app, DEFAULT.merge(options)
     end
 
@@ -27,7 +27,7 @@ module Rack
     def html?; @headers['Content-Type'] =~ /html/; end
 
     def inject(response)
-      file = 'async' 
+      file = 'async'
       @template ||= ::ERB.new ::File.read ::File.expand_path("../templates/#{file}.erb",__FILE__)
       response.gsub(%r{</body>}, @template.result(binding) + "</body>")
     end

data/lib/rack/templates/async.erb

@@ -1,21 +1,29 @@
 <!-- Piwik -->
 <script type="text/javascript">
-    var pkBaseURL = (("https:" == document.location.protocol) ? "https://<%= @options[:piwik_url]%>/" : "http://<%= @options[:piwik_url]%>/");
-    document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
-</script><script type="text/javascript">
-try {
-    var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", <%= @options[:piwik_id]%>);
+    var _paq = _paq || [];
 
-    <%# If this is a 404 page, provide additional information to Piwik %>
+    <%# If this is a 404 page, provide additional information to Piwik - see http://piwik.org/faq/how-to/#faq_60 %>
     <% if @status.equal?(404) %>
-        piwikTracker.setDocumentTitle('404/URL = ' +
-                String(document.location.pathname + document.location.search).replace(/\//g,"%2f") +
-                '/From = ' + String(document.referrer).replace(/\//g,"%2f"));
+        _paq.push(['setDocumentTitle', '404/URL = ' +
+                String(document.location.pathname+document.location.search).replace(/\//g,"%2f") +
+                '/From = ' + String(document.referrer).replace(/\//g,"%2f")]);
     <% end %>
 
-    piwikTracker.trackPageView();
-    piwikTracker.enableLinkTracking();
-} catch( err ) {}
+    _paq.push(["trackPageView"]);
+    _paq.push(["enableLinkTracking"]);
+
+    (function() {
+        var u=(("https:" == document.location.protocol) ? "https" : "http") + "://<%= @options[:piwik_url] %>/";
+        _paq.push(["setTrackerUrl", u+"piwik.php"]);
+        _paq.push(["setSiteId", "<%= @options[:piwik_id] %>"]);
+        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>
-<noscript><img src="http://<%= @options[:piwik_url]%>/piwik.php?idsite=<%= @options[:piwik_id]%>" alt="" /></noscript>
-<!-- End Piwik Code -->
+
+<!-- Image Tracker -->
+<noscript>
+  <%# TODO set protocol (HTTP or HTTPS) based on the current protocol according to rack logic %>
+  <img src="http://<%= @options[:piwik_url] %>/piwik.php?idsite=<%= @options[:piwik_id] %>&amp;rec=1" style="border:0" alt="" />
+</noscript>
+<!-- End Piwik -->

data/lib/rack/templates/sync.erb

@@ -0,0 +1,26 @@
+<!-- Piwik -->
+<script type="text/javascript">
+    var pkBaseURL = (("https:" == document.location.protocol) ? "https://<%= @options[:piwik_url]%>/" : "http://<%= @options[:piwik_url]%>/");
+    document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
+</script><script type="text/javascript">
+try {
+    var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", <%= @options[:piwik_id]%>);
+
+    <%# If this is a 404 page, provide additional information to Piwik %>
+    <% if @status.equal?(404) %>
+        piwikTracker.setDocumentTitle('404/URL = ' +
+                String(document.location.pathname + document.location.search).replace(/\//g,"%2f") +
+                '/From = ' + String(document.referrer).replace(/\//g,"%2f"));
+    <% end %>
+
+    piwikTracker.trackPageView();
+    piwikTracker.enableLinkTracking();
+} catch( err ) {}
+</script>
+
+<!-- Image Tracker -->
+<noscript>
+  <%# TODO set protocol (HTTP or HTTPS) based on the current protocol according to rack logic %>
+  <img src="http://<%= @options[:piwik_url] %>/piwik.php?idsite=<%= @options[:piwik_id] %>&amp;rec=1" style="border:0" alt="" />
+</noscript>
+<!-- End Piwik -->

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-piwik
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-21 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies: []
-description: Simple Rack middleware for implementing piwik Analytics racking in your
+description: Simple Rack middleware for implementing Piwik Analytics tracking in your
   Ruby-Rack based project.
 email:
 - maxwell@joindiaspora.com
@@ -20,6 +20,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rack/piwik.rb
+- lib/rack/templates/sync.erb
 - lib/rack/templates/async.erb
 - README.md
 - LICENSE
@@ -43,10 +44,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rack middleware to inject the Piwik tracking code into outgoing responses.
   Adapted from rack-google-analytics
 test_files: []
-has_rdoc: