customized_piwik_analytics 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7855a538599330537096331cb4d37acc084ec363
+  data.tar.gz: 1f1fde77b4cca3b10681924ea34a6963bc090e3e
+SHA512:
+  metadata.gz: 91cef5ba9ae82f5d435db5018296963cd4cadaaaae62c8e58ebee850a1dde9b3b3c8eee79b615e25e3b9246022837e9257594eb1e9d9deec27ec74976a4da667
+  data.tar.gz: b07fbe742cf2917f18fefd2bc9248ea242d8808b5a5fda88e77dc441741330ad2a8e092d2547c389b5b4e74677f028a2c2ab6625b057eef52b1c4b4d3d1d64fa

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea/*
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - ree
+gemfile: Gemfile

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Fabian Becker
+
+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,39 @@
+{<img src="https://travis-ci.org/halfdan/piwik_analytics.png?branch=master" alt="Build Status" />}[https://travis-ci.org/halfdan/piwik_analytics]
+
+= PiwikAnalytics
+
+<b>Note:</b> This Gem has undergone a major rewrite in 1.x compared to 0.9.x.
+
+The customized_piwik_analytics gem provides an easy way to include Piwik into your application.
+By default it will output the synchronous piwik tracking code for every page
+(given that it is configured correctly).
+In this version added option for specify protocol (http/https/etc) for Piwik requests.
+
+== Installation
+
+Add `customized_piwik_analytics` to Gemfile:
+
+    gem 'customized_piwik_analytics', '~> 1.0.0'
+
+Run the generator:
+
+    rails g piwik_analytics:install
+
+This will install a piwik.yml configuration file into the `config` directory
+of your application.
+
+
+== Configuration
+
+Open up `config/piwik.yml` and edit the settings. Each setting is described in
+the config file itself.
+Additionally there is a 'protocol' option. It allows to set differ protocol for
+analytical requests. By default it work the same way as parent variant of the gem.
+
+== Usage
+
+Inside your `application.html.erb` (or haml, slim) simply add
+
+    <%= piwik_tracking_tag %>
+
+Enjoy :)

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+desc 'Generate documentation for the customized_piwik_analytics plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CustomizedPiwikAnalytics'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/views/piwik_analytics/piwik_tracking_tag.html.erb

@@ -0,0 +1,22 @@
+<!-- Piwik -->
+<script type="text/javascript">
+  <% if protocol.present? %>
+    var protocol = "<%= protocol %>";
+  <% else %>
+    var protocol = ("https:" == document.location.protocol) ? "https" : "http";
+  <% end %>
+  var pkBaseURL = protocol + "://<%= 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", <%= id_site %>);
+    piwikTracker.trackPageView();
+    piwikTracker.enableLinkTracking();
+  } catch( err ) {}
+</script>
+<!-- End Piwik Tag -->
+<!-- Piwik Image Tracker -->
+<noscript>
+  <p><img src="//<%= url %>/piwik.php?idsite=<%= id_site %>&amp;rec=1" style="border:0" alt="" /></p>
+</noscript>
+<!-- End Piwik -->

data/app/views/piwik_analytics/piwik_tracking_tag_async.html.erb

@@ -0,0 +1,31 @@
+<!-- Piwik -->
+<script type="text/javascript">
+  var _paq = _paq || [];
+  _paq.push(["trackPageView"]);
+  _paq.push(["enableLinkTracking"]);
+
+  (function() {
+      <% if protocol.present? %>
+        var protocol = '<%= protocol %>';
+      <% else %>
+        var protocol = ("https:" == document.location.protocol) ? "https" : "http";
+      <% end %>
+    var u = protocol + "://<%= url %>/";
+    _paq.push(["setTrackerUrl", u+"piwik.php"]);
+    _paq.push(["setSiteId", <%= id_site %>]);
+    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 -->
+<!-- Piwik Image Tracker -->
+<noscript>
+  <p><img src="//<%= url %>/piwik.php?idsite=<%= id_site %>&amp;rec=1" style="border:0" alt="" /></p>
+</noscript>
+<!-- End Piwik -->

data/customized_piwik_analytics.gemspec

@@ -0,0 +1,27 @@
+spec = Gem::Specification.new do |s|
+  s.name              = 'customized_piwik_analytics'
+  s.version           = '1.0.4'
+  s.date              = Time.now.strftime "%Y-%m-%d"
+  s.author            = 'Fabian Becker, Ivan Zabrovskiy'
+  s.email             = 'halfdan@xnorfz.de'
+  s.homepage          = 'https://github.com/Loriowar/piwik-ruby-tracking'
+  s.summary           = "[Rails] Easily include Piwik tracking in your Rails application."
+
+  s.description = <<-DESC
+    The customized_piwik_analytics gem provides an easy way to include Piwik into your application.
+    By default it will output the synchronous piwik tracking code for every page
+    (given that it is configured correctly).
+    In this version add option for specify protocol (http/https/etc) for Piwik requests.
+  DESC
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'rails', '>= 3.0.0'
+  s.add_dependency 'actionpack'
+  s.add_dependency 'activesupport'
+
+  s.add_development_dependency "rspec", "~> 2.12.0"
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/lib/customized_piwik_analytics"

data/lib/customized_piwik_analytics.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), 'piwik_analytics', 'configuration')
+
+module PiwikAnalytics
+  require 'piwik_analytics/engine' if defined?(Rails)
+
+  class <<self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= PiwikAnalytics::Configuration.new
+    end
+  end
+end

data/lib/generators/piwik_analytics.rb

@@ -0,0 +1,7 @@
+module PiwikAnalytics
+  module Generators
+    class Base < Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'piwik_analytics', generator_name, 'templates'))
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module PiwikAnalytics
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+      def copy_config_file
+        template 'config/piwik.yml'
+      end
+    end
+  end
+end

data/lib/generators/piwik_analytics/install/templates/config/piwik.yml

@@ -0,0 +1,35 @@
+# Configuration:
+#
+# disabled
+#   false if tracking tag should be shown
+# use_async
+#   Set to true if you want to use asynchronous tracking
+# url
+#   The url of your piwik instance (e.g. localhost/piwik/)
+# id_site
+#   The id of your website inside Piwik
+# protocol
+#   The protocol for requests to the Piwik (e.g. http)
+#
+production:
+  piwik:
+    id_site: 1
+    url: localhost
+    disabled: false
+    use_async: false
+
+development:
+  piwik:
+    id_site: 1
+    url: localhost
+    disabled: true
+    use_async: false
+    hostname: localhost
+
+test:
+  piwik:
+    id_site: 1
+    url: localhost
+    disabled: true
+    use_async: false
+    hostname: localhost

data/lib/piwik_analytics/configuration.rb

@@ -0,0 +1,81 @@
+module PiwikAnalytics
+  class Configuration
+
+    #
+    # The url of the Piwik instance
+    # Defaults to localhost
+    #
+    def url
+      @url ||= (user_configuration_from_key('url') || 'localhost')
+    end
+
+    #
+    # The protocol for requests to the Piwik
+    # Defaults to nil
+    #
+    def protocol
+      @protocol ||= user_configuration_from_key('protocol')
+    end
+
+    #
+    # The ID of the tracked website
+    # Defaults to 1
+    #
+    def id_site
+      @id_site ||= (user_configuration_from_key('id_site') || 1)
+    end
+
+    #
+    # Whether or not to use the async tracking
+    # Defaults to false
+    #
+    def use_async?
+      @use_async ||= (user_configuration_from_key('use_async') || false)
+    end
+
+    #
+    # Whether or not to disable Piwik.
+    # Defaults to false.
+    #
+    def disabled?
+      @disabled ||= (user_configuration_from_key('disabled') || false)
+    end
+
+    private
+
+    # 
+    # return a specific key from the user configuration in config/piwik.yml
+    #
+    # ==== Returns
+    #
+    # Mixed:: requested_key or nil
+    #
+    def user_configuration_from_key( *keys )
+      keys.inject(user_configuration) do |hash, key|
+        hash[key] if hash
+      end
+    end
+
+    #
+    # Memoized hash of configuration options for the current Rails environment
+    # as specified in config/piwik.yml
+    #
+    # ==== Returns
+    #
+    # Hash:: configuration options for current environment
+    #
+    def user_configuration
+      @user_configuration ||= begin
+        path = File.join(::Rails.root, 'config', 'piwik.yml')
+        if File.exist?(path)
+          File.open(path) do |file|
+            processed = ERB.new(file.read).result
+            YAML.load(processed)[::Rails.env]['piwik']
+          end
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/piwik_analytics/engine.rb

@@ -0,0 +1,20 @@
+# PiwikAnalytics
+require 'active_support'
+
+module PiwikAnalytics
+
+  class Piwik < Rails::Engine
+    engine_name :piwik_analytics
+
+    paths["app/views"]
+
+    generators do
+      load "generators/piwik_analytics.rb"
+    end
+
+    initializer "piwik_analytics.init", :before=> :load_config_initializers do
+      require "piwik_analytics/helpers"
+      load "piwik_analytics/init.rb"
+    end
+  end
+end

data/lib/piwik_analytics/helpers.rb

@@ -0,0 +1,20 @@
+module PiwikAnalytics
+  module Helpers
+    def piwik_tracking_tag
+      config = PiwikAnalytics.configuration
+      return if config.disabled?
+
+      if config.use_async?
+        file = "piwik_analytics/piwik_tracking_tag_async"
+      else
+        file = "piwik_analytics/piwik_tracking_tag"
+      end
+      render({
+        file: file,
+        locals: {url: config.url,
+                 id_site: config.id_site,
+                 protocol: config.protocol}
+      })
+    end
+  end
+end

data/lib/piwik_analytics/init.rb

@@ -0,0 +1 @@
+ActionView::Base.send :include, PiwikAnalytics::Helpers

data/spec/configuration_spec.rb

@@ -0,0 +1,27 @@
+require "piwik_analytics/configuration"
+
+describe PiwikAnalytics::Configuration do
+  before(:each) do
+    conf_mock = {
+      "id_site"   => 4,
+      "url"       => "example.com",
+      "use_async" => true,
+      "disabled"  => true
+    }
+
+    @config = PiwikAnalytics::Configuration.new
+    @config.stub(:user_configuration).and_return(conf_mock)
+  end
+  it "returns a id_site" do
+    @config.id_site.should eq 4
+  end
+  it "returns a url" do
+    @config.url.should eq "example.com"
+  end
+  it "has a use_async? flag" do
+    @config.use_async?.should be_true
+  end
+  it "has a disabled? flag" do
+    @config.disabled?.should be_true
+  end
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,50 @@
+require "piwik_analytics/helpers"
+
+class HelpersDouble
+  include PiwikAnalytics::Helpers
+end
+
+describe PiwikAnalytics::Helpers do
+  describe "#piwik_tracking_tag" do
+    before(:each) do
+      @config = mock("Configuration").as_null_object
+      @double = HelpersDouble.new
+    end
+
+    context "disabled" do
+      it 'should return nil if disabled' do
+        @config.stub(:disabled?).and_return true
+        PiwikAnalytics.stub(:configuration).and_return @config
+        @double.piwik_tracking_tag.should be_nil
+      end
+    end
+
+    context "enabled" do
+      before(:each) do
+        @config.stub(:disabled?).and_return false
+      end
+
+      it 'should render' do
+        PiwikAnalytics.stub(:configuration).and_return @config
+        @double.should_receive(:render)
+        @double.piwik_tracking_tag
+      end
+
+      it 'should use file piwik_tracking_tag_async when async' do
+        @config.stub(:use_async?).and_return true
+        PiwikAnalytics.stub(:configuration).and_return @config
+
+        @double.should_receive(:render).with(hash_including(:file => 'piwik_analytics/piwik_tracking_tag_async'))
+        @double.piwik_tracking_tag
+      end
+
+      it 'should use file piwik_tracking_tag when not async' do
+        @config.stub(:use_async?).and_return false
+        PiwikAnalytics.stub(:configuration).and_return @config
+
+        @double.should_receive(:render).with(hash_including(:file => 'piwik_analytics/piwik_tracking_tag'))
+        @double.piwik_tracking_tag
+      end
+    end
+  end
+end

data/spec/views/piwik_tracking_tag.html.erb_spec.rb

@@ -0,0 +1,20 @@
+require "erb"
+
+describe "views/piwik_tracking_tag.html.erb" do
+  before(:each) do
+    filename = File.join(File.dirname(__FILE__), '..', '..', 'app', 'views', 'piwik_analytics', 'piwik_tracking_tag.html.erb')
+    @template = ERB.new(File.read(filename))
+  end
+
+  it "should render url" do
+    url = "example.com"
+    id_site = nil
+    @template.result(binding).should =~ /:\/\/example.com/
+  end
+
+  it "should render id_site" do
+    url = nil
+    id_site = 4
+    @template.result(binding).should =~ /"piwik\.php", 4/
+  end
+end

data/spec/views/piwik_tracking_tag_async.html.erb_spec.rb

@@ -0,0 +1,21 @@
+require "erb"
+
+describe "views/piwik_tracking_tag_async.html.erb" do
+  before(:each) do
+    filename = File.join(File.dirname(__FILE__), '..', '..', 'app', 'views', 'piwik_analytics', 'piwik_tracking_tag_async.html.erb')
+    @template = ERB.new(File.read(filename))
+  end
+
+  it "should render url" do
+    url = "example.com"
+    id_site = nil
+    @template.result(binding).should =~ /:\/\/example.com/
+  end
+
+  it "should render id_site" do
+    url = nil
+    id_site = 4
+    @template.result(binding).should =~ /"setSiteId", 4/
+  end
+end
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: customized_piwik_analytics
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Fabian Becker, Ivan Zabrovskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: |2
+      The customized_piwik_analytics gem provides an easy way to include Piwik into your application.
+      By default it will output the synchronous piwik tracking code for every page
+      (given that it is configured correctly).
+      In this version add option for specify protocol (http/https/etc) for Piwik requests.
+email: halfdan@xnorfz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/views/piwik_analytics/piwik_tracking_tag.html.erb
+- app/views/piwik_analytics/piwik_tracking_tag_async.html.erb
+- customized_piwik_analytics.gemspec
+- init.rb
+- lib/customized_piwik_analytics.rb
+- lib/generators/piwik_analytics.rb
+- lib/generators/piwik_analytics/install/install_generator.rb
+- lib/generators/piwik_analytics/install/templates/config/piwik.yml
+- lib/piwik_analytics/configuration.rb
+- lib/piwik_analytics/engine.rb
+- lib/piwik_analytics/helpers.rb
+- lib/piwik_analytics/init.rb
+- spec/configuration_spec.rb
+- spec/helpers_spec.rb
+- spec/views/piwik_tracking_tag.html.erb_spec.rb
+- spec/views/piwik_tracking_tag_async.html.erb_spec.rb
+homepage: https://github.com/Loriowar/piwik-ruby-tracking
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: '[Rails] Easily include Piwik tracking in your Rails application.'
+test_files: []
+has_rdoc: