simple-piwik 0.5.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mihael
+
+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,18 @@
+= simple-piwik
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2011 mihael. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "simple-piwik"
+    gem.summary     = %Q{A ruby client for the Piwik API.}
+    gem.description = %Q{Provides simple access to the Piwik API.}
+    gem.email       = "mihael.ploh@gmail.com"
+    gem.homepage    = "http://github.com/mihael/simple-piwik"
+    gem.authors     = ["mihael"]
+    gem.add_dependency "activesupport", ">= 3.0.9"
+    gem.add_dependency "rest-client",   ">= 1.6.1"
+    gem.add_dependency "json",          ">= 1.4.6"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/piwik/base.rb

@@ -0,0 +1,94 @@
+#require 'rubygems'
+#require 'cgi'
+require 'active_support/all'
+require 'json/ext'
+require 'rest_client'
+
+module Piwik
+  class ApiError < StandardError; end
+  class MissingConfiguration < ArgumentError; end
+  class UnknownSite < ArgumentError; end
+  class UnknownUser < ArgumentError; end
+
+  class Base
+    @@template  = <<-EOF
+# .piwik
+# 
+# Please fill in fields like this:
+#
+#  piwik_url: http://your.piwik.site
+#  auth_token: secret
+#
+piwik_url: 
+auth_token: 
+EOF
+
+  def self.on_rails?
+    (defined?(::Rails) && ::Rails.respond_to?(:root)) || (defined?(RAILS_ROOT) && RAILS_ROOT!=nil)
+  end
+
+  def self.config_file
+    if defined?(::Rails) && ::Rails.respond_to?(:root)
+      File.join(::Rails.root, 'config', 'piwik.yml')
+    elsif defined?(RAILS_ROOT) && RAILS_ROOT!=nil
+      File.join(RAILS_ROOT, 'config', 'piwik.yml')
+    else
+      File.join( ENV['HOME'] || ENV['USERPROFILE'] || ENV['HOMEPATH'] || ".", '.piwik' )
+    end
+  end
+
+  def self.parse_json json
+    JSON.parse json
+  end
+  
+  def parse_json json 
+    self.class.parse_json json
+  end
+  
+  private
+    # Calls the supplied Piwik API method, with the supplied parameters.
+    # 
+    # Returns a string containing the XML reply from Piwik, or raises a 
+    # <tt>Piwik::ApiError</tt> exception with the error message returned by Piwik 
+    # in case it receives an error.
+    def call(method, params={})
+      self.class.call(method, params, config[:piwik_url], config[:auth_token])
+    end
+    
+    # Calls the supplied Piwik API method, with the supplied parameters.
+    # 
+    # Returns the object parsed from JSON reply from Piwik, or raises a 
+    # <tt>Piwik::ApiError</tt> exception with the error message returned by Piwik 
+    # in case it receives an error.
+    def self.call(method, params={}, piwik_url=nil, auth_token=nil)
+      raise MissingConfiguration, "Please edit ~/.piwik to include your piwik url and auth_key" if piwik_url.nil? || auth_token.nil?
+      url = "#{piwik_url}/?module=API&format=json&method=#{method}"
+      url << "&token_auth=#{auth_token}" unless auth_token.nil?
+      params.each { |k, v| url << "&#{k}=#{CGI.escape(v.to_s)}" }
+      verbose_obj_save = $VERBOSE
+      $VERBOSE = nil # Suppress "warning: peer certificate won't be verified in this SSL session"
+      json = RestClient.get(url)
+      $VERBOSE = verbose_obj_save
+      result = self.parse_json json
+      if json =~ /error message=/
+        raise ApiError, result['error']['message'] if result['error']
+      end
+      result
+    end
+    
+    # Checks for the config, creates it if not found
+    def self.load_config_from_file
+      config = {}
+      config_file = self.config_file
+      temp_config = if File.exists?(config_file)
+        YAML::load(open(config_file))
+      else
+        open(config_file,'w') { |f| f.puts @@template }
+        YAML::load(@@template)
+      end
+      temp_config.each { |k,v| config[k.to_sym] = v } if temp_config
+      raise MissingConfiguration, "Please edit #{config_file} to include piwik url and auth_key" if config[:piwik_url] == nil || config[:auth_token] == nil
+      config
+    end
+  end
+end

data/lib/piwik/site.rb

@@ -0,0 +1,216 @@
+module Piwik
+  class Site < Piwik::Base
+    attr_accessor :name, :main_url
+    attr_reader :id, :created_at, :config
+    
+    # Initializes a new <tt>Piwik::Site</tt> object, with the supplied attributes. 
+    # 
+    # You can pass the URL for your Piwik install and an authorization token as 
+    # the second and third parameters. If you don't, than it will try to find 
+    # them in a <tt>'~/.piwik'</tt> or <tt>RAILS_ROOT/config/piwik.yml</tt> 
+    # (and create the file with an empty template if it doesn't exists).
+    # 
+    # Valid (and required) attributes are:
+    # * <tt>:name</tt> - the site's name
+    # * <tt>:main_url</tt> - the site's url
+    def initialize(attributes={}, piwik_url=nil, auth_token=nil)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      @config = if piwik_url.nil? || auth_token.nil?
+        self.class.load_config_from_file
+      else
+        {:piwik_url => piwik_url, :auth_token => auth_token}
+      end
+      load_attributes(attributes)
+    end
+  
+    # Returns an instance of <tt>Piwik::Site</tt> representing the site identified by 
+    # the supplied <tt>site_id</tt>. Raises a <tt>Piwik::ApiError</tt> if the site doesn't 
+    # exists or if the user associated with the supplied auth_token does not 
+    # have at least 'view' access to the site.
+    # 
+    # You can pass the URL for your Piwik install and an authorization token as 
+    # the second and third parameters. If you don't, than it will try to find 
+    # them in a <tt>'~/.piwik'</tt> (and create the file with an empty template if it 
+    # doesn't exists).
+    def self.load(site_id, piwik_url=nil, auth_token=nil)
+      raise ArgumentError, "expected a site Id" if site_id.nil?
+      @config = if piwik_url.nil? || auth_token.nil?
+        load_config_from_file
+      else
+        {:piwik_url => piwik_url, :auth_token => auth_token}
+      end
+      attributes = get_site_attributes_by_id(site_id, @config[:piwik_url], @config[:auth_token])
+      new(attributes, @config[:piwik_url], @config[:auth_token])
+    end
+    
+    # Returns <tt>true</tt> if the current site does not exists in the Piwik yet.
+    def new?
+      id.nil? && created_at.nil?
+    end
+    
+    # Saves the current site in Piwik.
+    # 
+    # Calls <tt>create</tt> it it's a new site, <tt>update</tt> otherwise.
+    def save
+      new? ? create : update
+    end
+    
+    # Saves the current new site in Piwik.
+    # 
+    # Equivalent Piwik API call: SitesManager.addSite (siteName, urls)
+    def create
+      raise ArgumentError, "Site already exists in Piwik, call 'update' instead" unless new?
+      raise ArgumentError, "Name can not be blank" if name.blank?
+      raise ArgumentError, "Main URL can not be blank" if main_url.blank?
+      result = call('SitesManager.addSite', :siteName => name, :urls => main_url)
+      @id = result['value'].to_i
+      @created_at = Time.current
+      id && id > 0 ? true : false
+    end
+    
+    # Saves the current site in Piwik, updating it's data.
+    # 
+    # Equivalent Piwik API call: SitesManager.updateSite (idSite, siteName, urls)
+    def update
+      raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+      raise ArgumentError, "Name can not be blank" if name.blank?
+      raise ArgumentError, "Main URL can not be blank" if main_url.blank?
+      result = call('SitesManager.updateSite', :idSite => id, :siteName => name, :urls => main_url)
+      result['result'] == 'success' ? true : false
+    end
+    
+    def reload
+      #TODO
+    end
+    
+    # Deletes the current site from Piwik.
+    # 
+    # Equivalent Piwik API call: SitesManager.deleteSite (idSite)
+    def destroy
+      raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+      result = call('SitesManager.deleteSite', :idSite => id)
+      #puts "\n destroy #{result} \n"
+      freeze
+      result['result'] == 'success' ? true : false
+    end
+    
+    # Gives read access (<tt>'view'</tt>) to the supplied user login for the current
+    # site.
+    def give_view_access_to(login)
+      give_access_to(:view, login)
+    end
+    
+    # Gives read and write access (<tt>'admin'</tt>) for the supplied user login for the 
+    # current site.
+    def give_admin_access_to(login)
+      give_access_to(:admin, login)
+    end
+    
+    # Removes all access (gives an <tt>'noaccess'</tt>) for the supplied user login for 
+    # the current site.
+    def give_no_access_to(login)
+      give_access_to(:noaccess, login)
+    end
+    alias_method :remove_access_from, :give_no_access_to
+    
+    # Returns a hash with a summary of access information for the current site 
+    # (visits, unique visitors, actions / pageviews, maximum actions per visit, 
+    # bounces and total time spent in all visits in seconds), filtered by the 
+    # supplied period and date.
+    # 
+    # * <tt>period</tt> should be one of <tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt> or <tt>:year</tt> (default: <tt>:day</tt>)
+    # * <tt>date</tt> should be a <tt>Date</tt> object (default: <tt>Date.today</tt>)
+    # 
+    # Equivalent Piwik API call: VisitsSummary.get (idSite, period, date)
+    def summary(period=:day, date=Date.today)
+      raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+      result = call('VisitsSummary.get', :idSite => id, :period => period, :date => date)
+      {
+        :visits => result['nb_visits'].to_i,
+        :unique_visitors => result['nb_uniq_visitors'].to_i,
+        :actions => result['nb_actions'].to_i,
+        :max_actions_per_visit => result['max_actions'].to_i,
+        :bounces => result['bounce_count'].to_i,
+        :total_time_spent => result['sum_visit_length'].to_i, # in seconds
+      }
+    end
+    
+    # Returns the amount of visits for the current site, filtered by the 
+    # supplied period and date.
+    # 
+    # * <tt>period</tt> should be one of <tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt> or <tt>:year</tt> (default: <tt>:day</tt>)
+    # * <tt>date</tt> should be a <tt>Date</tt> object (default: <tt>Date.today</tt>)
+    # 
+    # Equivalent Piwik API call: VisitsSummary.getVisits (idSite, period, date)
+    def visits(period=:day, date=Date.today)
+      raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+      result = call('VisitsSummary.getVisits', :idSite => id, :period => period, :date => date)
+      result.to_i
+    end
+    
+    # Returns the amount of unique visitors for the current site, filtered by 
+    # the supplied period and date.
+    # 
+    # * <tt>period</tt> should be one of <tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt> or <tt>:year</tt> (default: <tt>:day</tt>)
+    # * <tt>date</tt> should be a <tt>Date</tt> object (default: <tt>Date.today</tt>)
+    # 
+    # Equivalent Piwik API call: VisitsSummary.getUniqueVisitors (idSite, period, date)
+    def unique_visitors(period=:day, date=Date.today)
+      raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+      result = call('VisitsSummary.getUniqueVisitors', :idSite => id, :period => period, :date => date)
+      result.to_i
+    end
+    
+    # Returns the amount of actions (pageviews) for the current site, filtered 
+    # by the supplied period and date.
+    # 
+    # * <tt>period</tt> should be one of <tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt> or <tt>:year</tt> (default: <tt>:day</tt>)
+    # * <tt>date</tt> should be a <tt>Date</tt> object (default: <tt>Date.today</tt>)
+    # 
+    # Equivalent Piwik API call: VisitsSummary.getActions (idSite, period, date)
+    def actions(period=:day, date=Date.today)
+      raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+      result = call('VisitsSummary.getActions', :idSite => id, :period => period, :date => date)
+      result.to_i
+    end
+    alias_method :pageviews, :actions
+    
+    private
+      # Loads the attributes in the instance variables.
+      def load_attributes(attributes)
+        @id = attributes[:id]
+        @name = attributes[:name]
+        @main_url = attributes[:main_url] ? attributes[:main_url].gsub(/\/$/, '') : nil
+        @created_at = attributes[:created_at]
+      end
+
+      # Gives the supplied access for the supplied user, for the current site.
+      # 
+      # * <tt>access</tt> can be one of <tt>:view</tt>, <tt>:admin</tt> or <tt>:noaccess</tt>
+      # * <tt>login</tt> is the user login on Piwik
+      # 
+      # Equivalent Piwik API call: UsersManager.setUserAccess (userLogin, access, idSites)
+      def give_access_to(access, login)
+        raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+        result = call('UsersManager.setUserAccess', :idSites => id, :access => access.to_s, :userLogin => login.to_s)
+        #result['success'] ? true : false
+        result['result'] == 'success' ? true : false  
+      end
+
+      # Returns a hash with the attributes of the supplied site, identified 
+      # by it's Id in <tt>site_id</tt>.
+      # 
+      # Equivalent Piwik API call: SitesManager.getSiteFromId (idSite)
+      def self.get_site_attributes_by_id(site_id, piwik_url, auth_token)
+        result = call('SitesManager.getSiteFromId', {:idSite => site_id}, piwik_url, auth_token)
+        #puts "get_site_attributes_by_id #{result.to_s}"
+        attributes = {
+          :id => result[0]['idsite'].to_i,
+          :name => result[0]['name'],
+          :main_url => result[0]['main_url'],
+          :created_at => Time.parse(result[0]['ts_created'])
+        }
+        attributes
+      end
+  end
+end

data/lib/piwik/trackable.rb

@@ -0,0 +1,79 @@
+module Piwik
+  module Trackable
+    def piwik_tracking_js
+      if Config.use_async
+        <<-code
+        <!-- Piwik -->
+        <script type="text/javascript">
+        var _paq = _paq || [];
+        (function(){
+            var u=(("https:" == document.location.protocol) ? "#{Config.url.sub("http:","https:")}/" : "#{Config.url}/");
+            _paq.push(['setSiteId', #{@site.piwik_id}]);
+            _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 -->
+        code
+      else
+        <<-code
+        <!-- Piwik -->
+        <script type="text/javascript">
+        var pkBaseURL = (("https:" == document.location.protocol) ? "#{Config.url.sub("http:","https:")}/" : "#{Config.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", #{@site.piwik_id});
+                piwikTracker.trackPageView();
+                piwikTracker.enableLinkTracking();
+        } catch( err ) {}
+        </script>
+        <!-- End Piwik Tag -->
+        code
+      end
+    rescue NoMethodError
+      # ignore
+    end
+
+    def add_piwik_analytics_tracking
+      if Config.use_async
+        self.response.body = response.body.sub!(/<\/[hH][eE][aA][dD]>/, "#{piwik_tracking_js}</head>") if response.body.respond_to?(:sub!)
+      else
+        self.response.body = response.body.sub!(/<\/[bB][oO][dD][yY]>/, "#{piwik_tracking_js}</body>") if response.body.respond_to?(:sub!)
+      end
+    end
+  end
+
+  class Config
+
+    @@use_async = false
+    cattr_accessor :use_async
+    
+    @@url = Piwik::Base.load_config_from_file[:piwik_url]
+    cattr_accessor :url
+    
+    @@environments = ["production","development"]
+    cattr_accessor :environments
+
+    @@formats = [:html, :all]
+    cattr_accessor :formats
+
+=begin rdoc
+  Checks whether the model can be tracked using piwik by checking for a piwik_id and domain fields.
+  This is a pretty specific use case, a more generic application tracking solution is available here:
+  https://github.com/Achillefs/piwik_analytics/ (this file is actually swiped from that plugin)
+=end
+    def self.enabled?(format)
+      raise Piwik::MissingConfiguration if url.blank?
+      environments.include?(Rails.env) && formats.include?(format.to_sym)
+    end
+  end
+end

data/lib/piwik/user.rb

@@ -0,0 +1,132 @@
+module Piwik
+  class User < Piwik::Base
+    attr_accessor :login, :password, :email, :user_alias
+    attr_reader :created_at, :config
+    
+    # Initializes a new <tt>Piwik::User</tt> object, with the supplied attributes. 
+    # 
+    # You can pass the URL for your Piwik install and an authorization token as 
+    # the second and third parameters. If you don't, than it will try to find 
+    # them in a <tt>'~/.piwik'</tt> or <tt>RAILS_ROOT/config/piwik.yml</tt> 
+    # (and create the file with an empty template if it doesn't exists).
+    # 
+    # Valid (and required) attributes are:
+    # * <tt>:login</tt> - the user login
+    # * <tt>:password</tt> - the user password
+    # * <tt>:email</tt> - the user email
+    # * <tt>:alias</tt> - the user alias
+    def initialize(attributes={}, piwik_url=nil, auth_token=nil)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      @config = if piwik_url.nil? || auth_token.nil?
+        self.class.load_config_from_file
+      else
+        {:piwik_url => piwik_url, :auth_token => auth_token}
+      end
+      load_attributes(attributes)
+    end
+    
+    # Returns <tt>true</tt> if the current site does not exists in the Piwik yet.
+    def new?
+      created_at.nil? or created_at.blank?
+    end
+    
+    # Saves the current user in Piwik.
+    # 
+    # Calls <tt>create</tt> it it's a new user, <tt>update</tt> otherwise.
+    def save
+      new? ? create : update
+    end
+    
+    # Saves the current new user in Piwik.
+    # 
+    # Equivalent Piwik API call: UsersManager.addUser (userLogin, password, email, alias)
+    def create
+      raise ArgumentError, "User already exists in Piwik, call 'update' instead" unless new?
+      raise ArgumentError, "Login can not be blank" if login.blank?
+      raise ArgumentError, "Password can not be blank" if password.blank?
+      raise ArgumentError, "Email can not be blank" if email.blank?
+      user_alias = login if user_alias.blank?
+      
+      result = call('UsersManager.addUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
+      @created_at = Time.current
+      #puts "\n create #{result} \n"
+        
+      if result["result"]
+        result['message'] == 'ok' ? true : false
+      else
+        false
+      end
+    end
+    
+    # Saves the current user in Piwik, updating it's data.
+    # 
+    # Equivalent Piwik API call: UsersManager.updateUser (userLogin, password, email, alias)
+    def update
+      raise UnknownUser, "User not existent in Piwik yet, call 'save' first" if new?
+      raise ArgumentError, "Login can not be blank" if login.blank?
+      raise ArgumentError, "Password can not be blank" if password.blank?
+      raise ArgumentError, "Email can not be blank" if email.blank?
+      user_alias = login if user_alias.blank?
+      
+      result = call('UsersManager.updateUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
+      result['result'] == 'success' ? true : false
+    end
+    
+    # Deletes the current user from Piwik.
+    # 
+    # Equivalent Piwik API call: UsersManager.deleteUser (userLogin)
+    def destroy
+      raise UnknownUser, "User not existent in Piwik yet, call 'save' first" if new?
+      result = call('UsersManager.deleteUser', :userLogin => login)
+      freeze
+      result['result'] == 'success' ? true : false
+    end
+    
+    # Returns an instance of <tt>Piwik::User</tt> representing the user identified by 
+    # the supplied <tt>userLogin</tt>. Raises a <tt>Piwik::ApiError</tt> if the user doesn't 
+    # exists or if the user associated with the supplied auth_token does not 
+    # have 'admin' access.
+    # 
+    # You can pass the URL for your Piwik install and an authorization token as 
+    # the second and third parameters. If you don't, than it will try to find 
+    # them in a <tt>'~/.piwik'</tt> or <tt>RAILS_ROOT/config/piwik.yml</tt> 
+    # (and create the file with an empty template if it doesn't exists).
+    def self.load(user_login, piwik_url=nil, auth_token=nil)
+      raise ArgumentError, "expected a user Login" if user_login.nil?
+      @config = if piwik_url.nil? || auth_token.nil?
+        load_config_from_file
+      else
+        {:piwik_url => piwik_url, :auth_token => auth_token}
+      end
+      attributes = get_user_attributes_by_login(user_login, @config[:piwik_url], @config[:auth_token])
+      new(attributes, @config[:piwik_url], @config[:auth_token])
+    end
+    
+  private
+    # Loads the attributes in the instance variables.
+    def load_attributes(attributes)
+      @login = attributes[:login]
+      @password = attributes[:password]
+      @email = attributes[:email]
+      @user_alias = attributes[:user_alias]
+      @created_at = attributes[:created_at]
+    end
+    
+    # Returns a hash with the attributes of the supplied user, identified 
+    # by it's Login in <tt>user_login</tt>.
+    # 
+    # Equivalent Piwik API call: UsersManager.getUser (userLogin)
+    def self.get_user_attributes_by_login(user_login, piwik_url, auth_token)
+      result = call('UsersManager.getUser', {:userLogin => user_login}, piwik_url, auth_token)
+      #puts "\n get_user_attributes_by_login #{result} \n"
+      attributes = {
+        :login => result[0]['login'],
+        :user_alias => result[0]['alias'],
+        :email => result[0]['email'],
+        :password => result[0]['password'],
+        :created_at => Time.parse(result[0]['date_registered'])
+      }
+      attributes
+    end
+  end
+end

data/lib/simple-piwik.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'piwik/base.rb'
+require 'piwik/site.rb'
+require 'piwik/user.rb'
+require 'piwik/trackable.rb'

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/piwik.rb'}"
+puts "Loading piwik gem"
+exec "#{irb} #{libs} --simple-prompt"

data/simple-piwik.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple-piwik}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{mihael}]
+  s.date = %q{2011-08-03}
+  s.description = %q{Provides simple access to the Piwik API.}
+  s.email = %q{mihael.ploh@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/piwik/base.rb",
+    "lib/piwik/site.rb",
+    "lib/piwik/trackable.rb",
+    "lib/piwik/user.rb",
+    "lib/simple-piwik.rb",
+    "script/console",
+    "simple-piwik.gemspec",
+    "test/files/config/example_piwik.yml",
+    "test/simple-piwik_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mihael/simple-piwik}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{A ruby client for the Piwik API.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.9"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.6.1"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.9"])
+      s.add_dependency(%q<rest-client>, [">= 1.6.1"])
+      s.add_dependency(%q<json>, [">= 1.4.6"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.9"])
+    s.add_dependency(%q<rest-client>, [">= 1.6.1"])
+    s.add_dependency(%q<json>, [">= 1.4.6"])
+  end
+end
+

data/test/files/config/example_piwik.yml

@@ -0,0 +1,4 @@
+# Before running rake test, please rename this file to piwik.yml and fill in the fields.
+# See test_helper.stub_rails_env.
+auth_token: yourpiwikauthkey
+piwik_url: http://<yourpiwikdomain>

data/test/simple-piwik_test.rb

@@ -0,0 +1,69 @@
+#require File.join(File.expand_path(File.dirname(__FILE__)),"test_helper")
+require 'test_helper'
+
+class PiwikTest < Test::Unit::TestCase
+  def setup
+    @domain = "http://test.local"
+    @name = "Test Site"
+    @site = Piwik::Site.new(:name => @name, :main_url => @domain)
+    @login = "test_user"
+    @password = "changeme"
+    @email = "test@pwave.com"
+    @user_alias = "Test User"
+    @user = Piwik::User.new(:login => @login, :password => @password, :email => @email, :user_alias => @user_alias)
+  end
+  
+  def test_can_instantiate_site
+    assert_equal @name, @site.name
+    assert_equal @domain, @site.main_url
+  end
+  
+  def test_can_save_load_update_and_destroy_site
+    assert_equal nil, @site.id
+    @site.save
+    assert_not_equal 0, @site.id
+    assert_not_equal nil, @site.id
+    reloaded = Piwik::Site.load(@site.id)
+    assert_equal reloaded.id, @site.id
+    reloaded.name = "Changed Name"
+    reloaded.update
+    reloaded = Piwik::Site.load(@site.id)
+    assert_equal "Changed Name", reloaded.name
+    assert_equal true, reloaded.destroy
+  end
+  
+  def test_can_instantiate_user
+    assert_equal @login, @user.login
+    assert_equal @password, @user.password
+    assert_equal @email, @user.email
+    assert_equal @user_alias, @user.user_alias
+  end
+  
+  def test_can_save_load_update_and_destroy_user
+    @user.save
+    reloaded = Piwik::User.load(@user.login)
+    assert_equal reloaded.login, @user.login
+    reloaded.email = "changed@mail.com"
+    reloaded.password = "changeme"
+    reloaded.update
+    reloaded = Piwik::User.load(@user.login)
+    assert_equal"changed@mail.com", reloaded.email
+    assert_equal true, @user.destroy
+  end
+  
+  def test_can_read_standalone_config
+    File.open(File.join(ENV["HOME"],".piwik"), "w") { p.puts(File.read("./files/config/piwik/yml")) } unless File.join(ENV["HOME"],".piwik")
+    assert_nothing_raised do
+      Piwik::Base.load_config_from_file
+    end
+  end
+  
+  
+  def test_can_read_rails_config
+    stub_rails_env do
+      assert_nothing_raised do
+        Piwik::Base.load_config_from_file
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+#require 'stringio'
+#require 'open-uri'
+#require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple-piwik'
+
+class Test::Unit::TestCase
+  def stub_rails_env &block
+    Object.const_set("RAILS_ROOT", File.join(File.dirname(__FILE__),"files"))
+    yield
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: simple-piwik
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.5.0
+platform: ruby
+authors: 
+- mihael
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id003
+description: Provides simple access to the Piwik API.
+email: mihael.ploh@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/piwik/base.rb
+- lib/piwik/site.rb
+- lib/piwik/trackable.rb
+- lib/piwik/user.rb
+- lib/simple-piwik.rb
+- script/console
+- simple-piwik.gemspec
+- test/files/config/example_piwik.yml
+- test/simple-piwik_test.rb
+- test/test_helper.rb
+homepage: http://github.com/mihael/simple-piwik
+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: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A ruby client for the Piwik API.
+test_files: []
+