piwik-tracker 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jens Krämer
+
+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,15 @@
+Piwik-Tracker
+=============
+
+http://github.com/jkraemer/piwik-tracker
+
+Ruby client library for the [Piwik](http://piwik.org) opensource web
+analytics application.
+
+With Piwik-Tracker you can record visits, page views and goal conversions
+in a Piwik server from within any ruby application.
+
+Think of it as a Ruby version of the piwik.js standard Tracking API.
+For more information, see http://piwik.org/docs/tracking-api/
+
+Inspired by the PiwikTracker.php script that comes with Piwik.

data/lib/piwik_tracker/piwik.rb

@@ -0,0 +1,205 @@
+require 'uri'
+require 'json'
+require 'patron'
+
+module PiwikTracker
+  
+  # Piwik HTTP client
+  # piwik = Piwik.new('http://yoursite.com/piwik', 6)
+  # piwik.request(auth_token).
+  #   url('http://yoursite.com/some-page.html').
+  #   custom_variable(:foobar, 'value').
+  #   track_page_view('Page Title')
+  class Piwik
+
+    MAX_INT = 2 ** ((['foo'].pack('p').size * 8) - 1) - 1  	
+    
+    HTTP_TIMEOUT = 20
+    USER_AGENT = "piwik-tracker/#{PiwikTracker::VERSION}"
+    
+    attr_accessor :debug
+    
+    # base_uri - the location of your Piwik installation, i.e. 'http://yoursite.com/piwik'.
+    # site_id  - Id of the site to be tracked
+    def initialize(base_uri, site_id)
+      @base_uri = base_uri
+      @site_id = site_id
+    end
+    
+    # sends a tracking request
+    def track(params)
+      send_request params.merge( 'idsite' => @site_id,
+                                 'rec'    => 1,
+                                 'rand'   => rand(MAX_INT) )
+    end
+    
+    protected
+    
+    def send_request(params)
+      headers = { 'Accept-Language' => params.delete(:browser_language) }
+      headers['User-Agent'] = params.delete(:user_agent) if params.key?(:user_agent)
+      url = "piwik.php?#{hash_to_querystring(params)}"
+      puts "#{url} / #{headers.inspect}" if @debug
+      http.get url, headers
+    end
+    
+    def http
+      @http ||= connect
+    end
+
+    def hash_to_querystring(hash)
+      (keys = hash.keys).inject('') do |query_string, key|
+        query_string << '&' unless key == keys.first
+        query_string << "#{URI.encode(key.to_s)}=#{URI.encode(hash[key].to_s)}"
+      end
+    end
+    
+    def connect
+      Patron::Session.new.tap do |session|
+        session.timeout = HTTP_TIMEOUT
+        session.base_url = @base_uri
+        session.headers['User-Agent'] = USER_AGENT
+      end
+    end
+
+
+    public
+    
+    class Request
+      
+      # Piwik API version
+      VERSION = 1
+      
+      # length of Piwik visitor ids
+      VISITOR_ID_LENGTH = 16
+      
+      def initialize(piwik, auth_token = nil)
+        @piwik = piwik
+        @custom_variables = []
+        @data = {}
+        @data[:token_auth] = auth_token if auth_token
+      end
+      
+      # Chainable attribute setters
+      ########################### 
+      
+      # Sets the current URL being tracked
+      def url(url)
+        @data[:url] = url
+        self
+      end
+      
+      # Sets the URL referrer used to track Referrers details for new visits.
+      def referrer(url)
+        @data[:urlref] = url
+        self
+      end
+      
+      # Sets the attribution information to the visit, so that subsequent Goal conversions are 
+      # properly attributed to the right Referrer URL, timestamp, Campaign Name & Keyword.
+      # info - 4 element array of [campaign name, campaign keyword, Timestamp at which the referrer was set, Referrer URL]
+      def attribution_info(info)
+        info = JSON.parse(info) if String === info
+        @data[:_rcn], @data[:_rck], @data[:_refts], @data[:_ref] = info
+        self
+      end
+      
+      # Sets Visit Custom Variable.
+      # See http://piwik.org/docs/custom-variables/
+      # slot_id - Custom variable slot ID from 1-5
+      # name - Custom variable name
+      # value - Custom variable value
+      def custom_variable(slot_id, name, value)
+        raise "invalid slot id, has to be between 1 and 5" unless (1..5).include?(slot_id)
+        @custom_variables[slot_id - 1] = [name, value]
+        self
+      end
+      
+      def browser_language(lang)
+        @data[:browser_language] = lang
+        self
+      end
+      
+      def user_agent(name)
+        @data[:user_agent] = name
+        self
+      end
+      
+      # Overrides server date and time for the tracking requests. 
+      # By default Piwik will track requests for the "current datetime" but this function allows you 
+      # to track visits in the past.
+      # time - ruby Time instance
+      def forced_date_time(time)
+        @data[:cdt] = time.utc.to_i
+        self
+      end
+      
+      # Overrides IP address
+      # client_ip - IP address string
+      def ip(client_ip)
+        @data[:cip] = client_ip
+        self
+      end
+      
+      # Forces the requests to be recorded for the specified Visitor ID
+      # rather than using the heuristics based on IP and other attributes.
+      # id - 16 hexadecimal characters visitor ID, eg. "33c31e01394bdc63"
+      def visitor_id(id)
+        raise "visitor_id must be exactly #{VISITOR_ID_LENGTH} characters long" unless id.to_s.length == VISITOR_ID_LENGTH
+        @data[:cid] = id
+        self
+      end
+      
+      
+      
+      # Tracking functions
+      ########################### 
+    
+      # Tracks a page view
+      # document_title is the page title as it will appear in the Actions > Page titles report
+      def track_pageview(document_title)
+        @piwik.track request_params.merge(:action_name => document_title)
+      end
+    
+      # Records a Goal conversion
+      # goal_id - Id of the goal to record
+      # revenue - revenue for this conversion
+      def track_goal(goal_id, revenue = nil)
+        params = request_params.merge :idgoal => goal_id
+        params[:revenue] = revenue if revenue
+        @piwik.track params
+      end
+    
+      # Tracks a download or outlink
+      # action_url - URL of the download or outlink
+      # action_type Type of the action: :download or :link
+      def track_action(action_url, action_type)
+        @piwik.track request_params.merge(action_type => action_url, :redirect => '0')
+      end
+    
+      protected
+      
+      def request_params
+        @data.dup.tap do |params|
+          params[:_cvar] = @custom_variables.to_json if @custom_variables.any?
+        end
+      end
+    
+    end
+    
+    
+    # generates a new request object.
+    # 
+    # Some Tracking API functionnality requires express authentication, using either the 
+    # Super User token_auth, or a user with 'admin' access to the website.
+    # 
+    # The following features require access:
+    # - force the visitor IP
+    # - force the date & time of the tracking requests rather than track for the current datetime
+    # - force Piwik to track the requests to a specific VisitorId rather than use the standard visitor matching heuristic
+    def request(auth_token = nil)
+      Request.new self, auth_token
+    end
+  end
+  
+end

data/lib/piwik_tracker/version.rb

@@ -0,0 +1,3 @@
+module PiwikTracker
+  VERSION = "0.1.0"
+end

data/lib/piwik_tracker.rb

@@ -0,0 +1,2 @@
+require "piwik_tracker/version"
+require "piwik_tracker/piwik"

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: piwik-tracker
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Jens Kr\xC3\xA4mer"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-13 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: 
+- jk@jkraemer.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/piwik_tracker/piwik.rb
+- lib/piwik_tracker/version.rb
+- lib/piwik_tracker.rb
+- LICENSE
+- CHANGELOG.md
+- README.md
+has_rdoc: true
+homepage: http://github.com/jkraemer/piwik-tracker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: piwik-tracker
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Record visits, page views, Goals, in a Piwik server
+test_files: []
+