simple-piwik 0.5.7 → 0.5.8

data/VERSION

@@ -1 +1 @@
-0.5.7
+0.5.8

data/lib/piwik/site.rb

@@ -192,13 +192,30 @@ module Piwik
     # => [{"label"=>" Izdelava spletnih strani | Spletnik d.o.o.", "nb_visits"=>36, "nb_uniq_visitors"=>35, "nb_hits"=>41, "sum_time_spent"=>240, "entry_nb_uniq_visitors"=>"33", "entry_nb_visits"=>"36", "entry_nb_actions"=>"92", "entry_sum_visit_length"=>"3422", "entry_bounce_count"=>"20", "exit_nb_uniq_visitors"=>"19", "exit_nb_visits"=>"22", "avg_time_on_page"=>7, "bounce_rate"=>"56%", "exit_rate"=>"61%"}]
     #
     # Equivalent Piwik API call: Actions.getPageTitles (idSite, period, date, segment = '', expanded = '', idSubtable = '')
-    def get_page_titles(period=:day, date=Date.today, segment='', expanded='', idSubtable='')
+    def get_page_titles(params={})
       raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
-      result = call('Actions.getPageTitles', :idSite => id, :period => period, :date => date, :segment => segment, :expanded => expanded, :idSubtable => idSubtable)
+      result = call('Actions.getPageTitles', {:idSite => id, :period => :day, :date => Date.today, :segment => '', :expanded => '', :idSubtable => ''}.update(params))
       #puts "get_page_titles: #{result}"
       result
     end
 
+    # Returns a big Array of Hashes with all page urls along with standard Actions metrics for each row, for the current site.
+    #
+    # Example result:
+    # => [{"label"=>"spletnik", "nb_visits"=>69, "nb_hits"=>87, "sum_time_spent"=>4762, "entry_nb_visits"=>40, "entry_nb_actions"=>101, "entry_sum_visit_length"=>6752, "entry_bounce_count"=>26, "exit_nb_visits"=>39, "avg_time_on_page"=>69, "bounce_rate"=>"65%", "exit_rate"=>"57%", "idsubdatatable"=>1}]
+    #
+    # Example call:
+    #  
+    # Piwik::Site.load(203).get_page_urls(:expanded=>1)
+    #
+    # Equivalent Piwik API call: Actions.getPageUrls (idSite, period, date, segment = '', expanded = '', idSubtable = '')
+    def get_page_urls(params={})
+      raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
+      result = call('Actions.getPageUrls', { :idSite => id, :period => :day, :date => Date.today, :segment => '', :expanded => '', :idSubtable => '' }.update(params))
+      #puts "get_page_urls: #{result}"
+      result
+    end
+
     private
       # Loads the attributes in the instance variables.
       def load_attributes(attributes)

data/simple-piwik.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple-piwik}
-  s.version = "0.5.7"
+  s.version = "0.5.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{mihael}]
-  s.date = %q{2011-08-18}
+  s.date = %q{2011-08-19}
   s.description = %q{Provides simple access to the Piwik API.}
   s.email = %q{mihael.ploh@gmail.com}
   s.extra_rdoc_files = [

data/test/simple-piwik_test.rb

@@ -81,7 +81,19 @@ class PiwikTest < Test::Unit::TestCase
     assert_equal true, reloaded.destroy
   end  
   
-  
+  def test_get_page_urls
+    assert_equal nil, @site.id
+    @site.save
+    assert_not_equal 0, @site.id
+    assert_not_equal nil, @site.id
+    #TODO: maybe make an actual website visit here, by calling the Piwik tracking REST api, so that Piwik actually records something and the test can become more accurate
+    reloaded = Piwik::Site.load(@site.id)
+    assert_equal reloaded.id, @site.id
+    assert_equal true, reloaded.get_page_urls!=nil
+    assert_equal true, reloaded.get_page_urls.kind_of?(Array)
+    assert_equal true, reloaded.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

metadata

@@ -2,7 +2,7 @@
 name: simple-piwik
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors: 
 - mihael
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-18 00:00:00 Z
+date: 2011-08-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport