piwik_analytics 0.9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,28 @@
+= PiwikAnalytics
+
+ This plugin enables support for Piwik in your Rails application. By default
+it will output the synchronous piwik tracking code for every page automatically
+(given that it is configured correctly). Configuring this plugin is easy:
+
+    PiwikAnalytics::Config.id_site = <Site ID>
+    PiwikAnalytics::Config.url = <Piwik-URL>
+
+Where the <Site ID> the ID of your website inside Piwik. You can look it up
+under Settings -> Websites. <Piwik-URL> must be replaced by the URL to your
+Piwik installation.
+
+If you want PiwikAnalytics to use the asynchronous tracking code which was
+introduced in Piwik 1.1 you can add the folliwing line:
+
+    PiwikAnalytics::Config.use_async = true
+
+If you want to disable the tracking code for particular controllers simply add
+the following line to those controllers:
+
+    skip_after_filter :add_piwik_analytics_tracking
+
+Enjoy :)
+
+
+= Licence
+Copyright(c) 2010-2011 Fabian Becker, released under MIT licence.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the piwik_analytics plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the piwik_analytics plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PiwikAnalytics'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/piwik_analytics.rb

@@ -0,0 +1,79 @@
+# PiwikAnalytics
+require 'active_support'
+
+module PiwikAnalytics
+  module PiwikAnalyticsMixin
+    def piwik_tracking_js
+      if Config.use_async
+        <<-code
+        <!-- Piwik -->
+        <script type="text/javascript">
+        var _paq = _paq || [];
+        (function(){
+            var u=(("https:" == document.location.protocol) ? "https://#{Config.url}" : "http://#{Config.url}");
+            _paq.push(['setSiteId', #{Config.id_site}]);
+            _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) ? "https://#{Config.url}" : "http://#{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", #{Config.id_site});
+                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 PiwikAnalyticsConfigurationError < StandardError; end
+
+  class Config
+    @@id_site = nil
+    cattr_accessor :id_site
+
+    @@url = nil
+    cattr_accessor :url
+
+    @@use_async = false
+    cattr_accessor :use_async
+
+    @@environments = ["production"]
+    cattr_accessor :environments
+
+    @@formats = [:html, :all]
+    cattr_accessor :formats
+
+    def self.enabled?(format)
+      raise PiwikAnalytics::PiwikAnalsyticsConfigurationError if id_site.blank? || url.blank?
+      environments.include?(Rails.env) && formats.include?(format.to_sym)
+    end
+  end
+end

data/test/piwik_analytics_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PiwikAnalyticsTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: piwik_analytics
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  version: "0.9"
+platform: ruby
+authors: 
+- Fabian Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-30 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: |
+  By default this gem will output piwik analytics code forevery page automatically, if it's configured correctly.This is done by adding:
+  PiwikAnalytics.IdSite = 1
+  PiwikAnalytics.URL = <Piwik-URL>
+
+email: halfdan@xnorfz.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- test/piwik_analytics_test.rb
+- test/test_helper.rb
+- lib/piwik_analytics.rb
+has_rdoc: true
+homepage: https://github.com/halfdan/piwik_analytics/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "[Rails] Easily enable Google Analytics support in your Rails application."
+test_files: []
+