rakwik 0.0.2 → 0.1.0

data/README.md

@@ -2,7 +2,7 @@
 
 *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.
+tracking, so it tries to keep the time low that is needed to count a particular request.
 
 ![Server-side tracking](https://github.com/datenimperator/rakwik/wiki/server-side_tracking.png)
 
@@ -49,6 +49,45 @@ The `:token_auth` is needed since Rakwik will tell Piwik to record hits from ano
 than its own. The token_auth must be either the Super User token_auth, or a user with
 "admin" permission for this website ID.
 
+### Action names
+
+Piwik allows to set a custom action name which will be used in reports instead of the original
+URL. To use it from your Rails application, include it into your controller like such:
+
+    require 'rakwik/helpers'
+
+    class ApplicationController < ActionController::Base
+      # ...
+      include Rakwik::Helpers
+    end
+
+In the particular controller activate it by using the `action_name` class method:
+
+    class BooksController < ApplicationController
+      action_name :page_title
+      
+      # GET /books
+      # GET /books.xml
+      def index
+        @books = Book.all
+        @page_title = "Books"
+    
+        respond_with @books
+      end
+    end
+    
+Currently, `action_name` points to a instance variable.
+
+## TODO
+
+*  ~~Handle tracking cookies~~ no way to do this asynchronously
+*  Implement a helper to set the action title ~~from the controller~~ or view
+*  Implement a way to provide custom variables from the controller or view
+*  Implement a way to detect client capabilities without a separate request
+*  Detect [Warden](/hassox/warden) based credentials, eg. from [Devise](/plataformatec/devise)
+*  ~~Track 404 responses~~
+*  Implement meaningful specs
+
 ## Reference
 
 *  http://piwik.org/docs/tracking-api/reference/

data/lib/rakwik/helpers.rb

@@ -0,0 +1,28 @@
+module Rakwik
+  module Helpers
+    def self.included(base)
+      base.extend ClassMethods
+      base.send(:include, InstanceMethods)
+      base.class_eval do
+        after_filter :set_action_name
+      end
+    end
+    
+    module ClassMethods
+      def rakwik
+        @rakwik ||= {}
+      end
+      
+      def action_name(var_name)
+        rakwik[:action_name] = var_name
+      end
+    end
+    
+    module InstanceMethods
+      def set_action_name
+        return if self.class.rakwik[:action_name].nil?
+        request.env['rakwik.action_name'] = instance_variable_get("@#{self.class.rakwik[:action_name]}")
+      end
+    end
+  end
+end

data/lib/rakwik/tracker.rb

@@ -1,12 +1,13 @@
 require 'em-http'
-require 'pp'
 
 module Rakwik
   class Tracker
   
     include Rack::Response::Helpers
     
-    DEFAULT = {}
+    DEFAULT = {
+      :track_404 => true
+    }
 
     def initialize(app, options = {})
       @app, @options = app, DEFAULT.merge(options)
@@ -16,11 +17,15 @@ module Rakwik
 
     def call(env)
       @status, @headers, @body = @app.call(env)
-      track Rack::Request.new(env) if ok?
+      track Rack::Request.new(env) if track?
       [@status, @headers, @body]
     end
 
     private
+    
+    def track?
+      ok? || (not_found? && @options[:track_404] === true)
+    end
 
     def piwik_url
       @options[:piwik_url]
@@ -33,23 +38,40 @@ module Rakwik
     def token_auth
       @options[:token_auth]
     end
-
-    def track(request)
+    
+    def extract(request)
       header = {
-        'User-Agent' => request.user_agent,
-        'Accept-Language' => request.env["HTTP_ACCEPT_LANGUAGE"]
+        'User-Agent' => request.user_agent
       }
+      header['Accept-Language'] = request.env['HTTP_ACCEPT_LANGUAGE'] unless request.env['HTTP_ACCEPT_LANGUAGE'].nil?
+      header['DNT'] = request.env['HTTP_DNT'] unless request.env['HTTP_DNT'].nil?
       data = {
         'idsite'     => piwik_id,
         'token_auth' => token_auth,
         'rec'        => 1,
         'url'        => request.url,
         'cip'        => request.ip,
+        'rand'       => rand(1000000),
         'apiv'       => 1
       }
+      data['action_name'] = request.env['rakwik.action_name'] unless request.env['rakwik.action_name'].nil?
       data['urlref'] = request.referer unless request.referer.nil?
+      
+      if not_found? && @options[:track_404] === true
+        data['action_name'] = "404/URL = #{data['url'].gsub(/\//, '%2f')}/From = #{data['urlref'].gsub(/\//, '%2f')}"
+      end
+      
+      [header, data]
+    end
+
+    def track(request)
+      h, d = extract(request)
       EventMachine.schedule do
-        http = connection(piwik_url).get :head => header, :query => data
+        http = connection(piwik_url).get :head => h, :query => d
+        http.errback {
+          time = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+          request.env['rack.errors'].puts "[#{time}] ERROR Rakwik::Tracker: #{http.error}"
+        }
       end
     end
 

data/lib/rakwik/version.rb

@@ -1,3 +1,3 @@
 module Rakwik
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Christian Aust
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-19 00:00:00 Z
+date: 2012-06-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
@@ -78,6 +78,7 @@ files:
 - README.md
 - Rakefile
 - lib/rakwik.rb
+- lib/rakwik/helpers.rb
 - lib/rakwik/tracker.rb
 - lib/rakwik/version.rb
 - rakwik.gemspec