StatsCollect 0.2.0.20110830 → 0.3.0.20120314

data/lib/StatsCollect/StatsOrdersProxy.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2010 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -20,14 +20,14 @@ module StatsCollect
 
     # Add a new stats order
     #
-    # Parameters:
+    # Parameters::
     # * *iID* (_Integer_): An ID identifying uniquely this stats order. It will be used to tell which stats orders have to be dequeued later.
     # * *iTimeStamp* (_DateTime_): Time stamp
     # * *iLstLocations* (<em>list<String></em>): List of locations
     # * *iLstObjects* (<em>list<String></em>): List of objects
     # * *iLstCategories* (<em>list<String></em>): List of categories
     # * *iStatus* (_Integer_): Status
-    def addStatsOrder(iID, iTimeStamp, iLstLocations, iLstObjects, iLstCategories, iStatus)
+    def add_stats_order(iID, iTimeStamp, iLstLocations, iLstObjects, iLstCategories, iStatus)
       lLstSortedLocations = iLstLocations.sort.uniq
       lLstSortedObjects = iLstObjects.sort.uniq
       lLstSortedCategories = iLstCategories.sort.uniq

data/lib/StatsCollect/StatsProxy.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2010 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -22,7 +22,7 @@ module StatsCollect
 
     # Constructor
     # 
-    # Parameters:
+    # Parameters::
     # * *iLstObjects* (<em>list<String></em>): List of objects to filter (can be empty for all)
     # * *iLstCategories* (<em>list<String></em>): List of categories to filter (can be empty for all)
     # * *iBackend* (_Object_): The backend
@@ -36,11 +36,11 @@ module StatsCollect
 
     # Check if a specific object is included in the filter
     #
-    # Parameters:
+    # Parameters::
     # * *iObjectName* (_String_): The object to check
-    # Return:
+    # Return::
     # * _Boolean_: Is the object included in the filter ?
-    def isObjectIncluded?(iObjectName)
+    def is_object_included?(iObjectName)
       rIncluded = false
 
       if (@LstObjects.empty?)
@@ -54,11 +54,11 @@ module StatsCollect
 
     # Check if a specific category is included in the filter
     #
-    # Parameters:
+    # Parameters::
     # * *iCategoryName* (_String_): The category to check
-    # Return:
+    # Return::
     # * _Boolean_: Is the category included in the filter ?
-    def isCategoryIncluded?(iCategoryName)
+    def is_category_included?(iCategoryName)
       rIncluded = false
 
       if (@LstCategories.empty?)
@@ -72,14 +72,14 @@ module StatsCollect
 
     # Add a new stat
     #
-    # Parameters:
+    # Parameters::
     # * *iObject* (_String_): The object
     # * *iCategory* (_String_): The category
     # * *iValue* (_Object_): The value
     # * *iOptions* (<em>map<Symbol,Object></em>): Additional options [optional = {}]:
-    # ** *:Timestamp* (_DateTime_): Time stamp of this stat [optional = DateTime.now]
-    # ** *:Location* (_String_): Location of this stat [optional = <PluginName>]
-    def addStat(iObject, iCategory, iValue, iOptions = {})
+    #   * *:Timestamp* (_DateTime_): Time stamp of this stat [optional = DateTime.now]
+    #   * *:Location* (_String_): Location of this stat [optional = <PluginName>]
+    def add_stat(iObject, iCategory, iValue, iOptions = {})
       lTimestamp = (iOptions[:Timestamp] || DateTime.now)
       lLocation = (iOptions[:Location] || @Location)
       @StatsToAdd << [
@@ -94,52 +94,52 @@ module StatsCollect
 
     # Add a stats list
     #
-    # Parameters:
-    # * *iLstStats* (<em>list<[...]></em>): List of stats. See :StatsToAdd property for internal fields to set.
-    def addStatsList(iLstStats)
+    # Parameters::
+    # * *iLstStats* (<em>list< [...] ></em>): List of stats. See :StatsToAdd property for internal fields to set.
+    def add_stats_list(iLstStats)
       @StatsToAdd.concat(iLstStats)
     end
 
     # Add a new recoverable order
     #
-    # Parameters:
+    # Parameters::
     # * *iLstObjects* (<em>list<String></em>): The failing objects
     # * *iLstCategories* (<em>list<String></em>): The failing categories
-    def addRecoverableOrder(iLstObjects, iLstCategories)
+    def add_recoverable_order(iLstObjects, iLstCategories)
       @RecoverableOrders << [ iLstObjects, iLstCategories ]
     end
 
     # Add a new unrecoverable order
     #
-    # Parameters:
+    # Parameters::
     # * *iLstObjects* (<em>list<String></em>): The failing objects
     # * *iLstCategories* (<em>list<String></em>): The failing categories
-    def addUnrecoverableOrder(iLstObjects, iLstCategories)
+    def add_unrecoverable_order(iLstObjects, iLstCategories)
       @UnrecoverableOrders << [ iLstObjects, iLstCategories ]
     end
 
     # Get the list of categories
     #
-    # Return:
+    # Return::
     # * <em>map<String,[Integer,Integer]></em>: The list of categories and their associated ID and value type
-    def getCategories
-      return @Backend.getKnownCategories
+    def get_categories
+      return @Backend.get_known_categories
     end
 
     # Get the list of objects
     #
-    # Return:
+    # Return::
     # * <em>map<String,Integer></em>: The list of objects and their associated ID
-    def getObjects
-      return @Backend.getKnownObjects
+    def get_objects
+      return @Backend.get_known_objects
     end
 
     # Get the list of locations
     #
-    # Return:
+    # Return::
     # * <em>map<String,Integer></em>: The list of locations and their associated ID
-    def getLocations
-      return @Backend.getKnownLocations
+    def get_locations
+      return @Backend.get_known_locations
     end
 
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: StatsCollect
 version: !ruby/object:Gem::Version 
-  hash: 40221571
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  - 20110830
-  version: 0.2.0.20110830
+  - 20120314
+  version: 0.3.0.20120314
 platform: ruby
 authors: 
 - Muriel Salvan
@@ -16,11 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-30 00:00:00 Z
-dependencies: []
-
+date: 2012-03-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rUtilAnts
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
 description: StatsCollect is a little framework gathering statistics from external sources (social networks, web sites...), stored in pluggable backends. It can be very easily extended thanks to its plugins (currently include Facebook, Myspace, Youtube, Google).
-email: murielsalvan@users.sourceforge.net
+email: muriel@x-aeon.com
 executables: 
 - StatsCollect.rb
 extensions: []
@@ -58,6 +71,7 @@ files:
 - README
 - ReleaseInfo
 - StatsCollect.conf.rb.example
+has_rdoc: true
 homepage: http://statscollect.sourceforge.net/
 licenses: []
 
@@ -71,7 +85,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -80,14 +93,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: statscollect
-rubygems_version: 1.8.9
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Command line tool gathering statistics from external sources.