autometal-piwik 0.4.4 → 0.6.1

data/lib/piwik/trackable.rb

@@ -57,22 +57,23 @@ module Piwik
     @@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
 
+    def self.url
+      Piwik.piwik_url
+    end
+
 =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?
+      raise Piwik::MissingConfiguration if self.url.blank?
       environments.include?(Rails.env) && formats.include?(format.to_sym)
     end
   end

data/lib/piwik/user.rb

@@ -18,7 +18,7 @@ module Piwik
     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
+        self.class.load_config
       else
         {:piwik_url => piwik_url, :auth_token => auth_token}
       end
@@ -47,11 +47,12 @@ module Piwik
       raise ArgumentError, "Email can not be blank" if email.blank?
       user_alias = login if user_alias.blank?
       
-      xml = call('UsersManager.addUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
-      result = parse_xml(xml)
+      result = call('UsersManager.addUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
       @created_at = Time.current
-      if result["success"]
-        result["success"]["message"] == "ok" ? true : false
+      #puts "\n create #{result} \n"
+        
+      if result["result"]
+        result['message'] == 'ok' ? true : false
       else
         false
       end
@@ -67,9 +68,8 @@ module Piwik
       raise ArgumentError, "Email can not be blank" if email.blank?
       user_alias = login if user_alias.blank?
       
-      xml = call('UsersManager.updateUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
-      result = parse_xml(xml)
-      result['success'] ? true : false
+      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.
@@ -77,10 +77,9 @@ module Piwik
     # Equivalent Piwik API call: UsersManager.deleteUser (userLogin)
     def destroy
       raise UnknownUser, "User not existent in Piwik yet, call 'save' first" if new?
-      xml = call('UsersManager.deleteUser', :userLogin => login)
-      result = parse_xml(xml)
+      result = call('UsersManager.deleteUser', :userLogin => login)
       freeze
-      result['success'] ? true : false
+      result['result'] == 'success' ? true : false
     end
     
     # Returns an instance of <tt>Piwik::User</tt> representing the user identified by 
@@ -95,7 +94,7 @@ module Piwik
     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
+        load_config
       else
         {:piwik_url => piwik_url, :auth_token => auth_token}
       end
@@ -118,14 +117,14 @@ 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 = parse_xml(xml)
+      result = call('UsersManager.getUser', {:userLogin => user_login}, piwik_url, auth_token)
+      #puts "\n get_user_attributes_by_login #{result} \n"
       attributes = {
-        :login => result['row']['login'],
-        :user_alias => result['row']['alias'],
-        :email => result['row']['email'],
-        :password => result['row']['password'],
-        :created_at => Time.parse(result['row']['date_registered'])
+        :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

data/script/console

@@ -5,6 +5,6 @@ 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'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/simple-piwik.rb'}"
 puts "Loading piwik gem"
 exec "#{irb} #{libs} --simple-prompt"

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/piwik_test.rb

@@ -1,4 +1,5 @@
-require File.join(File.dirname(__FILE__),"test_helper")
+#require File.join(File.expand_path(File.dirname(__FILE__)),"test_helper")
+require 'test_helper'
 
 class PiwikTest < Test::Unit::TestCase
   def setup
@@ -50,19 +51,78 @@ class PiwikTest < Test::Unit::TestCase
     assert_equal true, @user.destroy
   end
   
+  def test_unknown_site
+    assert_raises Piwik::UnknownSite do
+      Piwik::Site.load(0)
+    end
+  end
+  
+  def test_get_javascript_tag
+    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
+    assert_equal 0, reloaded.get_javascript_tag =~ /^<!-- Piwik -->/
+    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_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
-      Piwik::Base.load_config_from_file
+      Piwik::Base.load_config
     end
   end
   
-  
   def test_can_read_rails_config
     stub_rails_env do
       assert_nothing_raised do
-        Piwik::Base.load_config_from_file
+        Piwik::Base.load_config
+      end
+    end
+  end
+
+  def test_can_be_configured
+    stub_rails_env do
+      #configuring manualy overrides the config file settings, if any
+      Piwik.piwik_url  = "url"
+      Piwik.auth_token = "token"
+      assert_equal true, Piwik.is_configured?
+      assert_nothing_raised do
+        Piwik::Base.load_config
+        assert_equal "url", Piwik.piwik_url 
+        assert_equal "token", Piwik.auth_token
       end
+      Piwik.piwik_url  = nil
+      Piwik.auth_token = nil
     end
   end
+
 end

data/test/test_helper.rb

@@ -1,9 +1,12 @@
-%W[ stringio test/unit open-uri #{File.dirname(__FILE__)}/../lib/piwik ].each { |r| require r }
+require 'rubygems'
+require 'test/unit'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'piwik'
 
 class Test::Unit::TestCase
   def stub_rails_env &block
     Object.const_set("RAILS_ROOT", File.join(File.dirname(__FILE__),"files"))
     yield
-    Object.const_set("RAILS_ROOT",nil)
   end
-end
+end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: autometal-piwik
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 4
-  version: 0.4.4
+  - 6
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Achillefs Charmpilas
+- mihael
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 +02:00
+date: 2013-01-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,34 +27,18 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 21
         segments: 
-        - 2
         - 3
-        - 8
-        version: 2.3.8
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: xml-simple
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
         - 0
-        - 11
-        version: 1.0.11
+        - 9
+        version: 3.0.9
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -65,58 +50,38 @@ dependencies:
         - 1
         version: 1.6.1
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: json
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 11
         segments: 
-        - 2
-        - 0
+        - 1
         - 4
-        version: 2.0.4
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 2
         - 6
-        - 2
-        version: 2.6.2
-  type: :development
-  version_requirements: *id005
-description: 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.
-email: 
-- ac@humbuckercode.co.uk
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id003
+description: Provides simple access to the Piwik API.
+email: ac@humbuckercode.co.uk
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- License.txt
-- Manifest.txt
-- PostInstall.txt
-- Todo.txt
+- LICENSE
+- README.md
 files: 
-- License.txt
-- Manifest.txt
-- PostInstall.txt
-- README.rdoc
+- .document
+- LICENSE
+- README.md
 - Rakefile
-- Todo.txt
+- VERSION
 - autometal-piwik.gemspec
 - lib/piwik.rb
 - lib/piwik/base.rb
@@ -124,25 +89,16 @@ files:
 - lib/piwik/trackable.rb
 - lib/piwik/user.rb
 - script/console
-- script/destroy
-- script/generate
-- script/txt2html
-- setup.rb
-- test/files/config/piwik.yml
+- test/files/config/example_piwik.yml
 - test/piwik_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://github.com/Achillefs/tree/master
+homepage: https://github.com/Achillefs/autometal-piwik
 licenses: []
 
-post_install_message: |+
-  
-  For more information on piwik, see http://piwik.rubyforge.org or 
-  http://github.com/Achillefs/piwik/
-  
-rdoc_options: 
-- --main
-- README.rdoc
+post_install_message: 
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -165,10 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: autometal-piwik
-rubygems_version: 1.4.2
+rubyforge_project: 
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
-summary: A simple Ruby client for the Piwik API
-test_files: 
-- test/test_helper.rb
+summary: A ruby client for the Piwik API.
+test_files: []
+

data/License.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2011 Achillefs Charmpilas - Humbucker Ltd (http://humbuckercode.co.uk/licks)
-
-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/Manifest.txt

@@ -1,20 +0,0 @@
-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