autometal-piwik 0.2.3 → 0.3.0

data/README.rdoc

@@ -24,6 +24,11 @@ this API in a Ruby-friendly way. For example:
   => #<Piwik::Site:0xb74bf994 @name="Example.com", @config={:auth_token=>"some_auth_key", :piwik_url=>"http://your.piwi.install"}, @id=1, @main_url="http://www.example.com", @created_at=Tue Jul 15 18:55:40 -0300 2008>
   site.pageviews(:month, Date.today)
   => 88
+  
+  user = Piwik::User.load(1, 'http://your.piwi.install', 'some_auth_key')
+  => #<Piwik::User:0xb66bf544 @login="Example.com", @config={:auth_token=>"some_auth_key", :piwik_url=>"http://your.piwi.install"}, @id=1, @main_url="http://www.example.com", @created_at=Tue Jul 15 18:55:40 -0300 2008>
+  site.pageviews(:month, Date.today)
+  => 88
 
 Currently, only Piwik::Site simple new / create / save / update methods have been implemented.
 
@@ -43,6 +48,8 @@ RubyGems and the following gems (installed automatically if necessary):
   sudo gem install autometal-piwik --source=http://gemcutter.org
 
 == CHANGELOG:
+ * 0.3.0
+   UsersManager CRUD implementation, with tests
  * 0.2.3
    Started adding some tests
  * 0.2.0

data/autometal-piwik.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{autometal-piwik}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Achillefs Charmpilas"]
-  s.date = %q{2011-01-17}
+  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", "spec/piwik_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "test/test_helper.rb"]
+  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.post_install_message = %q{
 For more information on piwik, see http://piwik.rubyforge.org or 

data/lib/piwik.rb

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

data/lib/piwik/base.rb

@@ -23,33 +23,63 @@ piwik_url:
 auth_token: 
 EOF
       
-    private
-      # Checks for the config, creates it if not found
-      def self.load_config_from_file
-        config = {}
+  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 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 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=xml&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"
+      xml = RestClient.get(url)
+      $VERBOSE = verbose_obj_save
+      if xml =~ /error message=/
+        result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+        raise ApiError, result['error']['message'] if result['error']
+      end
+      xml
+    end
+    
+    # Checks for the config, creates it if not found
+    def self.load_config_from_file
+      config = {}
+      if defined?(RAILS_ROOT) and RAILS_ROOT != nil
+        home =  RAILS_ROOT
+        filename = "config/piwik.yml"
+      else
+        home =  ENV['HOME'] || ENV['USERPROFILE'] || ENV['HOMEPATH'] || "."
+        filename = ".piwik"
+      end
+      temp_config = if File.exists?(File.join(home,filename))
+        YAML::load(open(File.join(home,filename)))
+      else
+        open(File.join(home,filename),'w') { |f| f.puts @@template }
+        YAML::load(@@template)
+      end
+      temp_config.each { |k,v| config[k.to_sym] = v } if temp_config
+      if config[:piwik_url] == nil || config[:auth_token] == nil
         if defined?(RAILS_ROOT) and RAILS_ROOT != nil
-          home =  RAILS_ROOT
-          filename = "config/piwik.yml"
+          raise MissingConfiguration, "Please edit ./config/piwik.yml to include your piwik url and auth_key"
         else
-          home =  ENV['HOME'] || ENV['USERPROFILE'] || ENV['HOMEPATH'] || "."
-          filename = ".piwik"
-        end
-        temp_config = if File.exists?(File.join(home,filename))
-          YAML::load(open(File.join(home,filename)))
-        else
-          open(File.join(home,filename),'w') { |f| f.puts @@template }
-          YAML::load(@@template)
-        end
-        temp_config.each { |k,v| config[k.to_sym] = v } if temp_config
-        if config[:piwik_url] == nil || config[:auth_token] == nil
-          if defined?(RAILS_ROOT) and RAILS_ROOT != nil
-            raise MissingConfiguration, "Please edit ./config/piwik.yml to include your piwik url and auth_key"
-          else
-            raise MissingConfiguration, "Please edit ~/.piwik to include your piwik url and auth_key"
-          end
-          
+          raise MissingConfiguration, "Please edit ~/.piwik to include your piwik url and auth_key"
         end
-        config
+        
       end
+      config
+    end
   end
 end

data/lib/piwik/site.rb

@@ -7,8 +7,8 @@ module Piwik
     # 
     # 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).
+    # 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
@@ -64,7 +64,12 @@ module Piwik
       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})
-      @id = result["result"].to_i
+      case result.class
+      when Hash
+        @id = result["result"].to_i
+      else
+        @id = result.to_i
+      end
       @created_at = Time.current
       id && id > 0 ? true : false
     end
@@ -182,15 +187,6 @@ module Piwik
     alias_method :pageviews, :actions
     
     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
-    
       # Loads the attributes in the instance variables.
       def load_attributes(attributes)
         @id = attributes[:id]
@@ -212,27 +208,6 @@ module Piwik
         result['success'] ? true : false
       end
 
-      # 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 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=xml&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"
-        xml = RestClient.get(url)
-        $VERBOSE = verbose_obj_save
-        if xml =~ /error message=/
-          result = XmlSimple.xml_in(xml, {'ForceArray' => false})
-          raise ApiError, result['error']['message'] if result['error']
-        end
-        xml
-      end
-
       # Returns a hash with the attributes of the supplied site, identified 
       # by it's Id in <tt>site_id</tt>.
       # 

data/lib/piwik/user.rb

@@ -1,5 +1,131 @@
 module Piwik
   class User < Piwik::Base
-    #TODO
+    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?
+      
+      xml = call('UsersManager.addUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
+      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      @created_at = Time.current
+      result["success"]["message"] == "ok" ? true : false
+    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?
+      
+      xml = call('UsersManager.updateUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
+      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      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?
+      xml = call('UsersManager.deleteUser', :userLogin => login)
+      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      freeze
+      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)
+      xml = call('UsersManager.getUser', {:userLogin => user_login}, piwik_url, auth_token)
+      result = XmlSimple.xml_in(xml, {'ForceArray' => false})
+      
+      puts result.inspect
+      
+      attributes = {
+        :login => result['row']['login'],
+        :user_alias => result['row']['alias'],
+        :email => result['row']['email'],
+        :created_at => Time.parse(result['row']['date_registered']),
+      }
+      attributes
+    end
   end
 end

data/test/files/config/piwik.yml

@@ -1,2 +1,2 @@
-auth_token: testme
-piwik_url: http://piwik.mysite.com
+auth_token: 95b15f2ef6dfdc40b5604fb4d453b69b
+piwik_url: http://analytics.product-wave.com

data/test/piwik_test.rb

@@ -2,7 +2,39 @@ require File.join(File.dirname(__FILE__),"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_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
+  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_and_destroy_user
+    @user.save
+    assert_equal true, @user.destroy
   end
   
   def test_can_read_standalone_config
@@ -12,6 +44,7 @@ class PiwikTest < Test::Unit::TestCase
     end
   end
   
+  
   def test_can_read_rails_config
     stub_rails_env do
       assert_nothing_raised do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: autometal-piwik
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Achillefs Charmpilas
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 +01:00
+date: 2011-01-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency