piwik_analytics_with_user 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 004aacaba24d454a278dac7e88b69e445758c6ac
+  data.tar.gz: 66e111a5c6375b845616f9848b10a83e3760af2c
+SHA512:
+  metadata.gz: 981dd8b428b84af7f20786e321cb12e4f525ce913a223512659fefcad726f0fdf34728dbc6f74cb1e20837f015bfe379466ba8bc622cea9b61a9213738f58345
+  data.tar.gz: 0c0258d9c74552ef7d9b25a2fd28b0ccd7e69c75a2426f5c1f1af08c2ee4c40f3209aff1a990d6f67c3dbba22225dc0f05a4220dbec19aec12fde580f530ae62

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,38 @@
+= PiwikAnalytics
+
+**Note:** This Gem has undergone a major rewrite in 1.x compared to 0.9.x.
+
+The 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).
+
+== Installation
+
+Add `piwik_analytics` to Gemfile:
+
+    gem '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.
+
+== Usage
+
+Inside your `application.html.erb` (or haml, slim) simply add
+
+    <%= piwik_tracking_tag %>
+
+Enjoy :)
+
+
+= Licence
+Copyright(c) 2010-2012 Fabian Becker, released under MIT licence.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+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    = 'PiwikAnalyticsWithUser'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

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

@@ -0,0 +1,15 @@
+<!-- Piwik -->
+<script type="text/javascript">
+  var pkBaseURL = (("https:" == document.location.protocol) ? "https://<%= url %>/" : "http://<%= 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 %>);
+    <% unless id_user.nil? %>
+      piwikTracker.setUserId('<%= id_user %>');
+    <%end%>
+    piwikTracker.trackPageView();
+    piwikTracker.enableLinkTracking();
+  } catch( err ) {}
+</script>
+<!-- End Piwik Tag -->

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

@@ -0,0 +1,22 @@
+<!-- Piwik -->
+<script type="text/javascript">
+  var _paq = _paq || [];
+  <% unless id_user.nil? %>
+    _paq.push(['setUserId', '<%=id_user%>']);
+  <%end%>
+  (function(){
+    var u=(("https:" == document.location.protocol) ? "https://<%= url %>/" : "http://<%= url %>/");
+    _paq.push(['setSiteId', <%= 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 -->

data/init.rb

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

data/lib/generators/piwik_analytics_with_user.rb

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

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

@@ -0,0 +1,12 @@
+module PiwikAnalyticsWithUser
+  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_with_user/install/templates/config/piwik.yml

@@ -0,0 +1,33 @@
+# 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
+#
+production:
+  piwik:
+    id_site: 1
+    url: localhost
+    use_async: false
+    disabled: 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_with_user.rb

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

data/lib/piwik_analytics_with_user/configuration.rb

@@ -0,0 +1,74 @@
+
+module PiwikAnalyticsWithUser
+  class Configuration
+
+    #
+    # The url of the Piwik instance
+    # Defaults to localhost
+    #
+    def url
+      @url ||= (user_configuration_from_key('url') || 'localhost')
+    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_with_user/engine.rb

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

data/lib/piwik_analytics_with_user/helpers.rb

@@ -0,0 +1,18 @@
+module PiwikAnalyticsWithUser
+  module Helpers
+    def piwik_tracking_tag(id_user = nil)
+      config = PiwikAnalyticsWithUser.configuration
+      return if config.disabled?
+
+      if config.use_async?
+        file = "piwik_analytics_with_user/piwik_tracking_tag_async"
+      else
+        file = "piwik_analytics_with_user/piwik_tracking_tag"
+      end
+      render({
+        :file => file,
+        :locals => {:url => config.url, :id_site => config.id_site, :id_user => id_user}
+      })
+    end
+  end
+end

data/lib/piwik_analytics_with_user/init.rb

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

data/piwik_analytics_with_user.gemspec

@@ -0,0 +1,24 @@
+spec = Gem::Specification.new do |s|
+  s.name              = 'piwik_analytics_with_user'
+  s.version           = '1.1'
+  s.date              = Time.now.strftime "%Y-%m-%d"
+  s.author            = 'Pawel Potasiewicz'
+  s.email             = 'web.potasiewicz@gmail.com'
+  s.homepage          = 'https://github.com/ppotasiewicz/piwik_analytics.git'
+  s.summary           = "[Rails] Easily include Piwik tracking with user id in your Rails application."
+
+  s.description = <<-DESC
+    The 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).    
+  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'
+end
+

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: piwik_analytics_with_user
+version: !ruby/object:Gem::Version
+  version: '1.1'
+platform: ruby
+authors:
+- Pawel Potasiewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-27 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'
+description: "    The piwik_analytics gem provides an easy way to include Piwik into
+  your application.\n    By default it will output the synchronous piwik tracking
+  code for every page\n    (given that it is configured correctly).    \n"
+email: web.potasiewicz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/views/piwik_analytics_with_user/piwik_tracking_tag.html.erb
+- app/views/piwik_analytics_with_user/piwik_tracking_tag_async.html.erb
+- init.rb
+- lib/generators/piwik_analytics_with_user.rb
+- lib/generators/piwik_analytics_with_user/install/install_generator.rb
+- lib/generators/piwik_analytics_with_user/install/templates/config/piwik.yml
+- lib/piwik_analytics_with_user.rb
+- lib/piwik_analytics_with_user/configuration.rb
+- lib/piwik_analytics_with_user/engine.rb
+- lib/piwik_analytics_with_user/helpers.rb
+- lib/piwik_analytics_with_user/init.rb
+- piwik_analytics_with_user.gemspec
+- test/test_helper.rb
+homepage: https://github.com/ppotasiewicz/piwik_analytics.git
+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.2.2
+signing_key: 
+specification_version: 4
+summary: "[Rails] Easily include Piwik tracking with user id in your Rails application."
+test_files:
+- test/test_helper.rb