autometal-piwik 0.4.1 → 0.4.2

data/README.rdoc

@@ -46,6 +46,8 @@ RubyGems and the following gems (installed automatically if necessary):
   sudo gem install autometal-piwik --source=http://gemcutter.org
 
 == CHANGELOG:
+ * 0.4.2
+   Final fix for inconsistent API outputs caused by Rails using its own version of XmlSimple.
  * 0.4.1
    Quick fixed api result parsing in site creation. The API's responses are inconsistent, but I am not sure why.
  * 0.4.0

data/autometal-piwik.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{autometal-piwik}
-  s.version = "0.4.0"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Achillefs Charmpilas"]
   s.date = %q{2011-01-18}
   s.description = %q{A simple Ruby client for the Piwik API. This gem is based on Rodrigo Tassinari de Oliveira's piwik gem (https://github.com/riopro/piwik). Since it hasn't been updated since 2008, I took the liberty to fork it, and finish it up.}
   s.email = ["ac@humbuckercode.co.uk"]
-  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "Todo.txt"]
-  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "Todo.txt", "autometal-piwik.gemspec", "lib/piwik.rb", "lib/piwik/base.rb", "lib/piwik/site.rb", "lib/piwik/user.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "test/files/config/piwik.yml", "test/piwik_test.rb", "test/test_helper.rb"]
-  s.homepage = %q{http://github.com/riopro/Achillefs/tree/master}
+  s.extra_rdoc_files = ["License.txt", "Manifest.txt", "PostInstall.txt", "Todo.txt"]
+  s.files = ["License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "Todo.txt", "autometal-piwik.gemspec", "lib/piwik.rb", "lib/piwik/base.rb", "lib/piwik/site.rb", "lib/piwik/trackable.rb", "lib/piwik/user.rb", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "test/files/config/piwik.yml", "test/piwik_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://github.com/Achillefs/tree/master}
   s.post_install_message = %q{
 For more information on piwik, see http://piwik.rubyforge.org or 
 http://github.com/Achillefs/piwik/
@@ -30,20 +30,20 @@ http://github.com/Achillefs/piwik/
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3.8"])
       s.add_runtime_dependency(%q<xml-simple>, [">= 1.0.11"])
-      s.add_runtime_dependency(%q<rest-client>, [">= 0.5.1"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.6.1"])
       s.add_development_dependency(%q<rubyforge>, [">= 2.0.4"])
       s.add_development_dependency(%q<hoe>, [">= 2.6.2"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.3.8"])
       s.add_dependency(%q<xml-simple>, [">= 1.0.11"])
-      s.add_dependency(%q<rest-client>, [">= 0.5.1"])
+      s.add_dependency(%q<rest-client>, [">= 1.6.1"])
       s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
       s.add_dependency(%q<hoe>, [">= 2.6.2"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.3.8"])
     s.add_dependency(%q<xml-simple>, [">= 1.0.11"])
-    s.add_dependency(%q<rest-client>, [">= 0.5.1"])
+    s.add_dependency(%q<rest-client>, [">= 1.6.1"])
     s.add_dependency(%q<rubyforge>, [">= 2.0.4"])
     s.add_dependency(%q<hoe>, [">= 2.6.2"])
   end

data/lib/piwik.rb

@@ -6,5 +6,5 @@ require 'piwik/site.rb'
 require 'piwik/user.rb'
 require 'piwik/trackable.rb'
 module Piwik
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/piwik/base.rb

@@ -22,7 +22,16 @@ module Piwik
 piwik_url: 
 auth_token: 
 EOF
-      
+=begin rdoc
+  This is required to normalize the API responses when the Rails XmlSimple version is used
+=end
+  def self.parse_xml xml
+    result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+    result = result['result'] if result['result']
+    result
+  end
+  def parse_xml xml; self.class.parse_xml xml; end
+  
   private
     # Calls the supplied Piwik API method, with the supplied parameters.
     # 

data/lib/piwik/site.rb

@@ -63,13 +63,8 @@ module Piwik
       raise ArgumentError, "Name can not be blank" if name.blank?
       raise ArgumentError, "Main URL can not be blank" if main_url.blank?
       xml = call('SitesManager.addSite', :siteName => name, :urls => main_url)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
-      case result.class.to_s
-      when "Hash"
-        @id = result["result"].to_i
-      else
-        @id = result.to_i
-      end
+      result = parse_xml(xml)
+      @id = result.to_i
       @created_at = Time.current
       id && id > 0 ? true : false
     end
@@ -82,7 +77,7 @@ module Piwik
       raise ArgumentError, "Name can not be blank" if name.blank?
       raise ArgumentError, "Main URL can not be blank" if main_url.blank?
       xml = call('SitesManager.updateSite', :idSite => id, :siteName => name, :urls => main_url)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       result['success'] ? true : false
     end
     
@@ -96,7 +91,7 @@ module Piwik
     def destroy
       raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
       xml = call('SitesManager.deleteSite', :idSite => id)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       freeze
       result['success'] ? true : false
     end
@@ -132,7 +127,7 @@ module Piwik
     def summary(period=:day, date=Date.today)
       raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
       xml = call('VisitsSummary.get', :idSite => id, :period => period, :date => date)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       {
         :visits => result['nb_visits'].to_i,
         :unique_visitors => result['nb_uniq_visitors'].to_i,
@@ -153,7 +148,7 @@ module Piwik
     def visits(period=:day, date=Date.today)
       raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
       xml = call('VisitsSummary.getVisits', :idSite => id, :period => period, :date => date)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       result.to_i
     end
     
@@ -167,7 +162,7 @@ module Piwik
     def unique_visitors(period=:day, date=Date.today)
       raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
       xml = call('VisitsSummary.getUniqueVisitors', :idSite => id, :period => period, :date => date)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       result.to_i
     end
     
@@ -181,7 +176,7 @@ module Piwik
     def actions(period=:day, date=Date.today)
       raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
       xml = call('VisitsSummary.getActions', :idSite => id, :period => period, :date => date)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       result.to_i
     end
     alias_method :pageviews, :actions
@@ -204,7 +199,7 @@ module Piwik
       def give_access_to(access, login)
         raise UnknownSite, "Site not existent in Piwik yet, call 'save' first" if new?
         xml = call('UsersManager.setUserAccess', :idSites => id, :access => access.to_s, :userLogin => login.to_s)
-        result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+        result = parse_xml(xml)
         result['success'] ? true : false
       end
 
@@ -214,12 +209,12 @@ module Piwik
       # Equivalent Piwik API call: SitesManager.getSiteFromId (idSite)
       def self.get_site_attributes_by_id(site_id, piwik_url, auth_token)
         xml = call('SitesManager.getSiteFromId', {:idSite => site_id}, piwik_url, auth_token)
-        result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+        result = parse_xml(xml)
         attributes = {
           :id => result['row']['idsite'].to_i,
           :name => result['row']['name'],
           :main_url => result['row']['main_url'],
-          :created_at => Time.parse(result['row']['ts_created']),
+          :created_at => Time.parse(result['row']['ts_created'])
         }
         attributes
       end

data/lib/piwik/user.rb

@@ -48,7 +48,7 @@ module Piwik
       user_alias = login if user_alias.blank?
       
       xml = call('UsersManager.addUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       @created_at = Time.current
       if result["success"]
         result["success"]["message"] == "ok" ? true : false
@@ -68,7 +68,7 @@ module Piwik
       user_alias = login if user_alias.blank?
       
       xml = call('UsersManager.updateUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       result['success'] ? true : false
     end
     
@@ -78,7 +78,7 @@ module Piwik
     def destroy
       raise UnknownUser, "User not existent in Piwik yet, call 'save' first" if new?
       xml = call('UsersManager.deleteUser', :userLogin => login)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      result = parse_xml(xml)
       freeze
       result['success'] ? true : false
     end
@@ -119,15 +119,12 @@ module Piwik
     # Equivalent Piwik API call: UsersManager.getUser (userLogin)
     def self.get_user_attributes_by_login(user_login, piwik_url, auth_token)
       xml = call('UsersManager.getUser', {:userLogin => user_login}, piwik_url, auth_token)
-      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
-      
-      puts result.inspect
-      
+      result = parse_xml(xml)
       attributes = {
         :login => result['row']['login'],
         :user_alias => result['row']['alias'],
         :email => result['row']['email'],
-        :created_at => Time.parse(result['row']['date_registered']),
+        :created_at => Time.parse(result['row']['date_registered'])
       }
       attributes
     end

data/test/piwik_test.rb

@@ -17,12 +17,18 @@ class PiwikTest < Test::Unit::TestCase
     assert_equal @domain, @site.main_url
   end
   
-  def test_can_save_and_destroy_site
+  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
-    assert_equal true, @site.destroy
+    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
@@ -32,8 +38,15 @@ class PiwikTest < Test::Unit::TestCase
     assert_equal @user_alias, @user.user_alias
   end
   
-  def test_can_save_and_destroy_user
+  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
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: autometal-piwik
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Achillefs Charmpilas