autometal-piwik 0.3.1 → 0.4.0

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Riopro Informática Ltda
+Copyright (c) 2011 Achillefs Charmpilas - Humbucker Ltd (http://humbuckercode.co.uk/licks)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -1,4 +1,3 @@
-History.txt
 License.txt
 Manifest.txt
 PostInstall.txt
@@ -9,6 +8,7 @@ autometal-piwik.gemspec
 lib/piwik.rb
 lib/piwik/base.rb
 lib/piwik/site.rb
+lib/piwik/trackable.rb
 lib/piwik/user.rb
 script/console
 script/destroy

data/README.rdoc

@@ -1,6 +1,6 @@
 = autometal-piwik
 
-* http://github.com/riopro/Achillefs/tree/master
+* http://github.com/Achillefs/tree/master
 * http://humbuckercode.co.uk/licks/gems/piwik
 
 == DESCRIPTION:
@@ -27,10 +27,8 @@ this API in a Ruby-friendly way. For example:
   
   user = Piwik::User.load(1, 'http://your.piwi.install', 'some_auth_key')
   => #<Piwik::User:0xb66bf544 @login="Example.com", @config={:auth_token=>"some_auth_key", :piwik_url=>"http://your.piwi.install"}, @id=1, @main_url="http://www.example.com", @created_at=Tue Jul 15 18:55:40 -0300 2008>
-  site.pageviews(:month, Date.today)
-  => 88
 
-Currently, only Piwik::Site simple new / create / save / update methods have been implemented.
+Currently, only Piwik::Site and Piwik::User simple new / create / save / update methods have been implemented.
 
 For more information on Piwik and it's API, see the Piwik website (http://piwik.org) 
 and the Piwik API reference (http://dev.piwik.org/trac/wiki/API/Reference).
@@ -48,6 +46,8 @@ RubyGems and the following gems (installed automatically if necessary):
   sudo gem install autometal-piwik --source=http://gemcutter.org
 
 == CHANGELOG:
+ * 0.4.0
+   Added Piwik::Trackable controller mixing, pretty much swiped off of halfdan's piwik analytics project (https://github.com/halfdan/piwik_analytics/). The version included in this plugin is not suitable for application tracking, and is instead geared towards tracking multiple websites stored as ActiveRecord models
  * 0.3.0
    UsersManager CRUD implementation, with tests
  * 0.2.3

data/autometal-piwik.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{autometal-piwik}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Achillefs Charmpilas"]

data/lib/piwik.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'piwik/base.rb'
 require 'piwik/site.rb'
 require 'piwik/user.rb'
-
+require 'piwik/trackable.rb'
 module Piwik
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/piwik/trackable.rb

@@ -0,0 +1,77 @@
+module Piwik
+  module Trackable
+    def piwik_tracking_js
+      if Config.use_async
+        <<-code
+        <!-- Piwik -->
+        <script type="text/javascript">
+        var _paq = _paq || [];
+        (function(){
+            var u=(("https:" == document.location.protocol) ? "#{Config.url.sub("http:","https:")}/" : "#{Config.url}/");
+            _paq.push(['setSiteId', #{@site.piwik_id}]);
+            _paq.push(['setTrackerUrl', u+'piwik.php']);
+            _paq.push(['trackPageView']);
+            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 Tag -->
+        code
+      else
+        <<-code
+        <!-- Piwik -->
+        <script type="text/javascript">
+        var pkBaseURL = (("https:" == document.location.protocol) ? "#{Config.url.sub("http:","https:")}/" : "#{Config.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", #{@site.piwik_id});
+                piwikTracker.trackPageView();
+                piwikTracker.enableLinkTracking();
+        } catch( err ) {}
+        </script>
+        <!-- End Piwik Tag -->
+        code
+      end
+    end
+
+    def add_piwik_analytics_tracking
+      if Config.use_async
+        self.response.body = response.body.sub!(/<\/[hH][eE][aA][dD]>/, "#{piwik_tracking_js}</head>") if response.body.respond_to?(:sub!)
+      else
+        self.response.body = response.body.sub!(/<\/[bB][oO][dD][yY]>/, "#{piwik_tracking_js}</body>") if response.body.respond_to?(:sub!)
+      end
+    end
+  end
+
+  class Config
+
+    @@use_async = false
+    cattr_accessor :use_async
+    
+    @@url = Piwik::Base.load_config_from_file[:piwik_url]
+    cattr_accessor :url
+    
+    @@environments = ["production","development"]
+    cattr_accessor :environments
+
+    @@formats = [:html, :all]
+    cattr_accessor :formats
+
+=begin rdoc
+  Checks whether the model can be tracked using piwik by checking for a piwik_id and domain fields.
+  This is a pretty specific use case, a more generic application tracking solution is available here:
+  https://github.com/Achillefs/piwik_analytics/ (this file is actually swiped from that plugin)
+=end
+    def self.enabled?(format)
+      raise Piwik::MissingConfiguration if url.blank?
+      environments.include?(Rails.env) && formats.include?(format.to_sym)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: autometal-piwik
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Achillefs Charmpilas
@@ -106,13 +106,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
 - License.txt
 - Manifest.txt
 - PostInstall.txt
 - Todo.txt
 files: 
-- History.txt
 - License.txt
 - Manifest.txt
 - PostInstall.txt
@@ -123,6 +121,7 @@ files:
 - lib/piwik.rb
 - lib/piwik/base.rb
 - lib/piwik/site.rb
+- lib/piwik/trackable.rb
 - lib/piwik/user.rb
 - script/console
 - script/destroy
@@ -133,7 +132,7 @@ files:
 - test/piwik_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://github.com/riopro/Achillefs/tree/master
+homepage: http://github.com/Achillefs/tree/master
 licenses: []
 
 post_install_message: |+

data/History.txt

@@ -1,9 +0,0 @@
-== 0.0.2 2008-07-22
-
-* Added specs for existing API methods
-* Created RubyForge project at http://rubyforge.org/projects/piwik/
-
-== 0.0.1 2008-07-21
-
-* 1 major enhancement:
-  * Initial release