autometal-piwik 0.6.2 → 1.0.0

data/lib/piwik/sites_manager.rb

@@ -0,0 +1,70 @@
+module Piwik
+  class SitesManager < ApiModule
+    available_methods %W{
+      getJavascriptTag
+      getSitesFromGroup
+      getSitesGroups
+      getSiteFromId
+      getSiteUrlsFromId
+      getAllSites
+      getAllSitesId
+      getSitesIdWithVisits
+      getSitesWithAdminAccess
+      getSitesWithViewAccess
+      getSitesWithAtLeastViewAccess
+      getSitesIdWithAdminAccess
+      getSitesIdWithViewAccess
+      getSitesIdWithAtLeastViewAccess
+      getSitesIdFromSiteUrl
+      addSite
+      deleteSite
+      addSiteAliasUrls
+      getIpsForRange
+      setGlobalExcludedIps
+      setGlobalSearchParameters
+      getSearchKeywordParametersGlobal
+      getSearchCategoryParametersGlobal
+      getExcludedQueryParametersGlobal
+      getExcludedUserAgentsGlobal
+      setGlobalExcludedUserAgents
+      isSiteSpecificUserAgentExcludeEnabled
+      setSiteSpecificUserAgentExcludeEnabled
+      setGlobalExcludedQueryParameters
+      getExcludedIpsGlobal
+      getDefaultCurrency
+      setDefaultCurrency
+      getDefaultTimezone
+      setDefaultTimezone
+      updateSite
+      getCurrencyList
+      getCurrencySymbols
+      getTimezonesList
+      getUniqueSiteTimezones
+      getPatternMatchSites
+    }
+    
+    def self.get params
+      resp = self.get_site_from_id(params)
+      # Hack. The Piwik API get really weird sometimes
+      raise Piwik::UnknownSite if resp.value == '0'
+      Piwik::Site.new resp
+    end
+    
+    # monkeypatching, as the Piwik API is inconsistent.
+    # not all add methods return the same response type. Boo.
+    def self.add params
+      obj = Piwik::Site.new(params)
+      resp = self.api_call('addSite',params)
+      obj.attributes.idSite = resp
+      obj
+    end
+    
+    def self.save params
+      self.api_call('updateSite',params)
+    end
+    
+    def self.delete params
+      self.api_call('deleteSite',params)
+    end
+  end
+end

data/lib/piwik/transitions.rb

@@ -0,0 +1,28 @@
+module Piwik
+  class Transitions < ApiModule
+    available_methods %W{
+      getTransitionsForPageTitle
+      getTransitionsForPageUrl
+      getTransitionsForAction
+      getTranslations
+    }
+    
+    scoped_methods do
+      def for_title title, params = {}
+        getTransitionsForPageTitle(defaults.merge(params).merge(:pageTitle => title))
+      end
+
+      def for_url url, params = {}
+        getTransitionsForPageUrl(defaults.merge(params).merge(:pageUrl => url))
+      end
+
+      def for_action name, type, params = {}
+        getTransitionsForAction(defaults.merge(params).merge(:actionName => name, :actionType => type, :parts => 'all', :returnNormalizedUrls => ''))
+      end
+
+      def translations
+        getTranslations
+      end
+    end
+  end
+end

data/lib/piwik/typecast.rb

@@ -0,0 +1,19 @@
+module Piwik
+  # used to do basic typecasting to API response values
+  module Typecast
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+    end
+    
+    module InstanceMethods
+      private
+        def typecast(thing)
+          if thing.is_a?(String) and thing =~ /^[0-9]+$/
+            thing.to_i
+          else
+            thing
+          end
+        end
+    end
+  end
+end

data/lib/piwik/user.rb

@@ -1,132 +1,13 @@
 module Piwik
-  class User < Piwik::Base
-    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
-      else
-        {:piwik_url => piwik_url, :auth_token => auth_token}
+  class User < Base
+    class << self
+      def collection
+        Piwik::UsersManager
       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?
-      
-      result = call('UsersManager.addUser', :userLogin => login, :password => password, :email => email, :alias => user_alias)
-      @created_at = Time.current
-      #puts "\n create #{result} \n"
-        
-      if result["result"]
-        result['message'] == 'ok' ? true : false
-      else
-        false
-      end
-    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?
       
-      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.
-    # 
-    # Equivalent Piwik API call: UsersManager.deleteUser (userLogin)
-    def destroy
-      raise UnknownUser, "User not existent in Piwik yet, call 'save' first" if new?
-      result = call('UsersManager.deleteUser', :userLogin => login)
-      freeze
-      result['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
-      else
-        {:piwik_url => piwik_url, :auth_token => auth_token}
+      def id_attr
+        :userLogin
       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)
-      result = call('UsersManager.getUser', {:userLogin => user_login}, piwik_url, auth_token)
-      #puts "\n get_user_attributes_by_login #{result} \n"
-      attributes = {
-        :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
   end
-end
+end

data/lib/piwik/user_country.rb

@@ -0,0 +1,12 @@
+module Piwik
+  class UserCountry < ApiModule
+    available_methods %W{
+      getCountry
+      getContinent
+      getRegion
+      getCity
+      getLocationFromIP
+      getNumberOfDistinctCountries
+    }
+  end
+end

data/lib/piwik/user_settings.rb

@@ -0,0 +1,16 @@
+module Piwik
+  class UserSettings < ApiModule
+    available_methods %W{
+      getResolution
+      getConfiguration
+      getOS
+      getOSFamily
+      getMobileVsDesktop
+      getBrowserVersion
+      getBrowser
+      getBrowserType
+      getWideScreen
+      getPlugin
+    }
+  end
+end

data/lib/piwik/users_manager.rb

@@ -0,0 +1,52 @@
+module Piwik
+  class UsersManager < ApiModule
+    available_methods %W{
+      setUserPreference
+      getUserPreference
+      getUsers
+      getUsersLogin
+      getUsersSitesFromAccess
+      getUsersAccessFromSite
+      getUsersWithSiteAccess
+      getSitesAccessFromUser
+      getUser
+      getUserByEmail
+      addUser
+      updateUser
+      deleteUser
+      userExists
+      userEmailExists
+      setUserAccess
+      getTokenAuth
+    }
+    
+    def self.get params
+      resp = self.get_user(params)
+      raise Piwik::UnknownUser if resp.blank?
+      Piwik::User.new resp
+    end
+    
+    # monkeypatching, as the Piwik API is inconsistent.
+    # not all add methods return the same response type. Boo.
+    def self.add params
+      obj = Piwik::User.new(params)
+      resp = self.api_call('addUser',params)
+      obj
+    end
+    
+    def self.save params
+      self.api_call('updateUser',params)
+    end
+    
+    def self.delete params
+      self.api_call('deleteDelete',params)
+    end
+    
+    # TODO: this one is not working. 
+    # I assume there are other metacoded methods that might throw errors, 
+    # so a bit or hunting down is in ortder sometime
+    def self.user_exists(params)
+      Piwik::UsersManager::UserExists.new(:value => self.api_call('userExists',params))
+    end
+  end
+end

data/lib/piwik/version.rb

@@ -0,0 +1,3 @@
+module Piwik
+  VERSION = "1.0.0"
+end

data/lib/piwik/visit_frequency.rb

@@ -0,0 +1,7 @@
+module Piwik
+  class VisitFrequency < ApiModule
+    available_methods %W{
+      get
+    }
+  end
+end

data/lib/piwik/visit_time.rb

@@ -0,0 +1,9 @@
+module Piwik
+  class VisitTime < ApiModule
+    available_methods %W{
+      getVisitInformationPerLocalTime
+      getVisitInformationPerServerTime
+      getByDayOfWeek
+    }
+  end
+end

data/lib/piwik/visitor_interest.rb

@@ -0,0 +1,10 @@
+module Piwik
+  class VisitorInterest < ApiModule
+    available_methods %W{
+      getNumberOfVisitsPerVisitDuration
+      getNumberOfVisitsPerPage
+      getNumberOfVisitsByDaysSinceLast
+      getNumberOfVisitsByVisitCount
+    }
+  end
+end

data/lib/piwik/visits_summary.rb

@@ -0,0 +1,53 @@
+module Piwik
+  class VisitsSummary < ApiModule
+    available_methods %W{
+      get
+      getVisits
+      getUniqueVisitors
+      getActions
+      getMaxActions
+      getBounceCount
+      getVisitsConverted
+      getSumVisitsLength
+      getSumVisitsLengthPretty
+    }
+  
+    scoped_methods do
+      def converted params = {}
+        getVisitsConverted(defaults.merge(params)).value
+      end
+
+      def summary params = {}
+        get(defaults.merge(params))
+      end
+
+      def count params = {}
+        getVisits(defaults.merge(params)).value
+      end
+
+      def uniques params = {}
+        getUniqueVisitors(defaults.merge(params)).value
+      end
+
+      def actions params = {}
+        getActions(defaults.merge(params)).value
+      end
+
+      def max_actions params = {}
+        getMaxActions(defaults.merge(params)).value
+      end
+
+      def bounces params = {}
+        getBounceCount(defaults.merge(params)).value
+      end
+
+      def length params = {}
+        getSumVisitsLength(defaults.merge(params)).value
+      end
+
+      def pretty_length params = {}
+        getSumVisitsLengthPretty(defaults.merge(params)).value
+      end
+    end
+  end
+end

data/lib/string.rb

@@ -0,0 +1,11 @@
+class String
+  def is_binary_data?
+    self.count( "^ -~", "^\r\n" ).fdiv(self.size) > 0.3 || self.index( "\x00" )
+  end
+  
+  if RUBY_VERSION.to_f < 1.9
+    def force_encoding(enc)
+      self
+    end
+  end
+end