rakwik 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rakwik.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christian Aust
+
+MIT License
+
+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.md

@@ -0,0 +1,62 @@
+# Rakwik
+
+*Server-side* integration of web tracking methods does not require Javascript snippets
+or tracking images to be includd in the actual frontend. Rakwik implements asynchronous
+tracking, so it tries to keep the time low, needed to count a particular request.
+
+![Server-side tracking](https://github.com/datenimperator/rakwik/wiki/server-side_tracking.png)
+
+Unlike client-side tracking, server-side tracking can be used independently of frontend
+encryption. Your application requires SSL encryption, but your installation of Piwik
+does not support it? That's what Rakwik ist built for: It can track a request using http
+while the original request came in over https, without the browser having to warn the
+user about mixed content.
+
+## Pros and cons
+
+Using server-side tracking, you can track all kinds of information that are visible to
+your server. Most certainly the URL, IP address and referrer are used, also session
+information to identify subsequent requests from the same client.
+
+However, it's hard to track client-specific information like screen resolution and plugin
+support since the server has no way to detect details like such.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rakwik'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rakwik
+
+## Usage
+
+Rakwik comes as a Rack-compatible middleware which needs to be added to your application's
+middleware stack on startup.
+
+    config.middleware.use Rakwik::Tracker,
+        :piwik_url  => 'http://your.piwik.host/piwik.php',
+        :site_id    => 'your_site_id', # eg. 1
+        :token_auth => 'yoursecrettoken'
+
+The `:token_auth` is needed since Rakwik will tell Piwik to record hits from another IP
+than its own. The token_auth must be either the Super User token_auth, or a user with
+"admin" permission for this website ID.
+
+## Reference
+
+*  http://piwik.org/docs/tracking-api/reference/
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/rakwik/tracker.rb

@@ -0,0 +1,58 @@
+require 'em-http'
+require 'pp'
+
+module Rakwik
+  class Tracker
+    DEFAULT = {}
+
+    def initialize(app, options = {})
+      @app, @options = app, DEFAULT.merge(options)
+      missing = [:piwik_url, :site_id, :token_auth].detect{ |e| @options[e].nil? }
+      raise "Missing config value: :#{missing}" if missing
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+      track Rack::Request.new(env)
+      [status, headers, response]
+    end
+
+    private
+
+    def piwik_url
+      @options[:piwik_url]
+    end
+
+    def piwik_id
+      @options[:site_id]
+    end
+
+    def token_auth
+      @options[:token_auth]
+    end
+
+    def track(request)
+      header = {
+        'User-Agent' => request.user_agent,
+        'Accept-Language' => request.env["HTTP_ACCEPT_LANGUAGE"]
+      }
+      data = {
+        'idsite'     => piwik_id,
+        'token_auth' => token_auth,
+        'rec'        => 1,
+        'url'        => request.url,
+        'cip'        => request.ip,
+        'apiv'       => 1
+      }
+      data['urlref'] = request.referer unless request.referer.nil?
+      EventMachine.schedule do
+        http = connection(piwik_url).get :head => header, :query => data
+      end
+    end
+
+    def connection(url)
+      EventMachine::HttpRequest.new(url)
+    end
+
+  end
+end

data/lib/rakwik/version.rb

@@ -0,0 +1,3 @@
+module Rakwik
+  VERSION = "0.0.1"
+end

data/lib/rakwik.rb

@@ -0,0 +1,39 @@
+require "rakwik/tracker"
+
+module Rakwik
+  # Taken from http://www.hiringthing.com/2011/11/04/eventmachine-with-rails.html
+  # Thanks Joshua!
+  def self.start
+    if defined?(PhusionPassenger)
+      PhusionPassenger.on_event(:starting_worker_process) do |forked|
+      # for passenger, we need to avoid orphaned threads
+        if forked && EM.reactor_running?
+          EM.stop
+        end
+        Thread.new {
+          EM.run do
+            puts "=> EventMachine started"
+          end
+        }
+        die_gracefully_on_signal
+      end
+    else
+      # faciliates debugging
+      Thread.abort_on_exception = true
+      # just spawn a thread and start it up
+      Thread.new {
+        EM.run do
+          puts "=> EventMachine started"
+        end
+      } unless defined?(Thin)
+      # Thin is built on EventMachine, doesn't need this thread
+    end
+  end
+
+  def self.die_gracefully_on_signal
+    Signal.trap("INT")  { EM.stop }
+    Signal.trap("TERM") { EM.stop }
+  end
+end
+
+Rakwik.start

data/rakwik.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rakwik/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christian Aust"]
+  gem.email         = ["github@kontakt.software-consultant.net"]
+  gem.description   = %q{Rakwik is a server-side tracker integration for the Piwik opensource
+web statistics software. It's easy to integrate into rack-based applications and does not require
+frontend Javascript inclusion.}
+  gem.summary       = %q{Rack-based server-side asynchronous Piwik tracker integration.}
+  gem.homepage      = "https://github.com/datenimperator/rakwik"
+  gem.licenses      = ["MIT"]
+
+  gem.add_dependency "rack"
+  gem.add_dependency "em-http-request"
+
+  gem.add_development_dependency "rspec"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rakwik"
+  gem.require_paths = ["lib"]
+  gem.version       = Rakwik::VERSION
+  gem.platform      = Gem::Platform::RUBY
+end

data/spec/lib/rakwik/tracker_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Rakwik::Tracker do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'rspec'
+require 'rack'
+require 'rakwik'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: rakwik
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Christian Aust
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  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: em-http-request
+  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
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: |-
+  Rakwik is a server-side tracker integration for the Piwik opensource
+  web statistics software. It's easy to integrate into rack-based applications and does not require
+  frontend Javascript inclusion.
+email: 
+- github@kontakt.software-consultant.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rakwik.rb
+- lib/rakwik/tracker.rb
+- lib/rakwik/version.rb
+- rakwik.gemspec
+- spec/lib/rakwik/tracker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/datenimperator/rakwik
+licenses: 
+- MIT
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Rack-based server-side asynchronous Piwik tracker integration.
+test_files: 
+- spec/lib/rakwik/tracker_spec.rb
+- spec/spec_helper.rb