StatsCollect 0.1.1.20101220 → 0.2.0.20110830

data/lib/StatsCollect/StatsProxy.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2010 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -17,7 +17,7 @@ module StatsCollect
     attr_reader :UnrecoverableOrders
 
     # List of statistics to add
-    #   list< Time, Object, Category, Value >
+    #   list< CheckExistenceBeforeAdd?, Time, Location, Object, Category, Value >
     attr_reader :StatsToAdd
 
     # Constructor
@@ -25,8 +25,10 @@ module StatsCollect
     # 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)
-    def initialize(iLstObjects, iLstCategories)
-      @LstObjects, @LstCategories = iLstObjects, iLstCategories
+    # * *iBackend* (_Object_): The backend
+    # * *iLocation* (_String_): Name of the default location
+    def initialize(iLstObjects, iLstCategories, iBackend, iLocation)
+      @LstObjects, @LstCategories, @Backend, @Location = iLstObjects, iLstCategories, iBackend, iLocation
       @RecoverableOrders = []
       @UnrecoverableOrders = []
       @StatsToAdd = []
@@ -74,15 +76,30 @@ module StatsCollect
     # * *iObject* (_String_): The object
     # * *iCategory* (_String_): The category
     # * *iValue* (_Object_): The value
-    def addStat(iObject, iCategory, iValue)
+    # * *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 = {})
+      lTimestamp = (iOptions[:Timestamp] || DateTime.now)
+      lLocation = (iOptions[:Location] || @Location)
       @StatsToAdd << [
-        DateTime.now,
+        (iOptions[:Timestamp] != nil),
+        lTimestamp,
+        lLocation,
         iObject,
         iCategory,
         iValue
       ]
     end
 
+    # Add a stats list
+    #
+    # Parameters:
+    # * *iLstStats* (<em>list<[...]></em>): List of stats. See :StatsToAdd property for internal fields to set.
+    def addStatsList(iLstStats)
+      @StatsToAdd.concat(iLstStats)
+    end
+
     # Add a new recoverable order
     #
     # Parameters:
@@ -101,6 +118,30 @@ module StatsCollect
       @UnrecoverableOrders << [ iLstObjects, iLstCategories ]
     end
 
+    # Get the list of categories
+    #
+    # Return:
+    # * <em>map<String,[Integer,Integer]></em>: The list of categories and their associated ID and value type
+    def getCategories
+      return @Backend.getKnownCategories
+    end
+
+    # Get the list of objects
+    #
+    # Return:
+    # * <em>map<String,Integer></em>: The list of objects and their associated ID
+    def getObjects
+      return @Backend.getKnownObjects
+    end
+
+    # Get the list of locations
+    #
+    # Return:
+    # * <em>map<String,Integer></em>: The list of locations and their associated ID
+    def getLocations
+      return @Backend.getKnownLocations
+    end
+
   end
 
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: StatsCollect
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 40221571
+  prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  - 20101220
-  version: 0.1.1.20101220
+  - 2
+  - 0
+  - 20110830
+  version: 0.2.0.20110830
 platform: ruby
 authors: 
 - Muriel Salvan
@@ -15,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 +01:00
-default_executable: 
+date: 2011-08-30 00:00:00 Z
 dependencies: []
 
 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).
@@ -35,25 +35,29 @@ files:
 - lib/StatsCollect/Backends/MySQL.rb
 - lib/StatsCollect/Backends/Terminal.rb
 - lib/StatsCollect/Locations/AddThis.rb
+- lib/StatsCollect/Locations/CSV.rb
 - lib/StatsCollect/Locations/Facebook.rb
 - lib/StatsCollect/Locations/FacebookArtist.rb
 - lib/StatsCollect/Locations/FacebookLike.rb
+- lib/StatsCollect/Locations/GoogleGroup.rb
 - lib/StatsCollect/Locations/GoogleSearch.rb
 - lib/StatsCollect/Locations/MySpace.rb
+- lib/StatsCollect/Locations/RB.rb
 - lib/StatsCollect/Locations/ReverbNation.rb
 - lib/StatsCollect/Locations/Tweets.rb
 - lib/StatsCollect/Locations/Twitter.rb
 - lib/StatsCollect/Locations/Youtube.rb
+- lib/StatsCollect/Notifiers/Custom.rb
+- lib/StatsCollect/Notifiers/LogFile.rb
 - lib/StatsCollect/Notifiers/None.rb
 - lib/StatsCollect/Notifiers/SendMail.rb
 - lib/StatsCollect/Stats.rb
+- lib/StatsCollect/StatsOrdersProxy.rb
 - lib/StatsCollect/StatsProxy.rb
 - LICENSE
 - README
 - ReleaseInfo
 - StatsCollect.conf.rb.example
-- TODO
-has_rdoc: true
 homepage: http://statscollect.sourceforge.net/
 licenses: []
 
@@ -67,6 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -75,13 +80,14 @@ 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.3.7
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Command line tool gathering statistics from external sources.

data/TODO

@@ -1,2 +0,0 @@
-* MySpace: Get the user ID by parsing the Profile URL and remove :MySpaceName configuration option.
-* Get all the orders at once, and merge them to call Locations just once per execution.