simple-piwik 0.5.6 → 0.5.7

data/README.rdoc

@@ -34,13 +34,5 @@ activesupport, rest-client, json
 
 == INSTALL:
 
-  sudo gem install simple-piwik --source=http://gemcutter.org
-
-== 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.
+  gem install simple-piwik
+

data/VERSION

@@ -1 +1 @@
-0.5.6
+0.5.7

data/lib/piwik/base.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-#require 'cgi'
+require 'cgi'
 require 'active_support/all'
 require 'json/ext'
 require 'rest_client'

data/lib/piwik/site.rb

@@ -112,7 +112,8 @@ module Piwik
       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 
@@ -175,8 +176,7 @@ module Piwik
     end
     alias_method :pageviews, :actions
 
-    # Returns a string with the javascript tracking code for the supplied site, identified 
-    # by it's Id in <tt>site_id</tt>.
+    # Returns a string with the javascript tracking code for the current site.
     # 
     # Equivalent Piwik API call: SitesManager.getJavascriptTag (idSite)
     def get_javascript_tag
@@ -186,6 +186,19 @@ module Piwik
       result['value']
     end    
 
+    # Returns a big Array of Hashes with all page titles along with standard Actions metrics for each row, for the current site.
+    #
+    # Example result:
+    # => [{"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='')
+      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)
+      #puts "get_page_titles: #{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.6"
+  s.version = "0.5.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{mihael}]
-  s.date = %q{2011-08-16}
+  s.date = %q{2011-08-18}
   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

@@ -57,7 +57,7 @@ class PiwikTest < Test::Unit::TestCase
     end
   end
   
-  def test_site_javascript_tag
+  def test_get_javascript_tag
     assert_equal nil, @site.id
     @site.save
     assert_not_equal 0, @site.id
@@ -68,6 +68,20 @@ class PiwikTest < Test::Unit::TestCase
     assert_equal true, reloaded.destroy
   end  
   
+  def test_get_page_titles
+    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_titles!=nil
+    assert_equal true, reloaded.get_page_titles.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.6
+  version: 0.5.7
 platform: ruby
 authors: 
 - mihael
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-16 00:00:00 Z
+date: 2011-08-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport