StatsCollect 0.1.0.20101220

data/lib/StatsCollect/StatsProxy.rb

@@ -0,0 +1,106 @@
+#--
+# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module StatsCollect
+
+  # The stats proxy, used by plugins to populate stats
+  class StatsProxy
+
+    # List of recoverable orders as stated by the plugin (objects, categories)
+    #   list< [ list<String>, list<String> ] >
+    attr_reader :RecoverableOrders
+
+    # List of unrecoverable orders as stated by the plugin (objects, categories)
+    #   list< [ list<String>, list<String> ] >
+    attr_reader :UnrecoverableOrders
+
+    # List of statistics to add
+    #   list< Time, Object, Category, Value >
+    attr_reader :StatsToAdd
+
+    # Constructor
+    # 
+    # 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
+      @RecoverableOrders = []
+      @UnrecoverableOrders = []
+      @StatsToAdd = []
+    end
+
+    # Check if a specific object is included in the filter
+    #
+    # Parameters:
+    # * *iObjectName* (_String_): The object to check
+    # Return:
+    # * _Boolean_: Is the object included in the filter ?
+    def isObjectIncluded?(iObjectName)
+      rIncluded = false
+
+      if (@LstObjects.empty?)
+        rIncluded = true
+      else
+        rIncluded = @LstObjects.include?(iObjectName)
+      end
+
+      return rIncluded
+    end
+
+    # Check if a specific category is included in the filter
+    #
+    # Parameters:
+    # * *iCategoryName* (_String_): The category to check
+    # Return:
+    # * _Boolean_: Is the category included in the filter ?
+    def isCategoryIncluded?(iCategoryName)
+      rIncluded = false
+
+      if (@LstCategories.empty?)
+        rIncluded = true
+      else
+        rIncluded = @LstCategories.include?(iCategoryName)
+      end
+
+      return rIncluded
+    end
+
+    # Add a new stat
+    #
+    # Parameters:
+    # * *iObject* (_String_): The object
+    # * *iCategory* (_String_): The category
+    # * *iValue* (_Object_): The value
+    def addStat(iObject, iCategory, iValue)
+      @StatsToAdd << [
+        DateTime.now,
+        iObject,
+        iCategory,
+        iValue
+      ]
+    end
+
+    # Add a new recoverable order
+    #
+    # Parameters:
+    # * *iLstObjects* (<em>list<String></em>): The failing objects
+    # * *iLstCategories* (<em>list<String></em>): The failing categories
+    def addRecoverableOrder(iLstObjects, iLstCategories)
+      @RecoverableOrders << [ iLstObjects, iLstCategories ]
+    end
+
+    # Add a new unrecoverable order
+    #
+    # Parameters:
+    # * *iLstObjects* (<em>list<String></em>): The failing objects
+    # * *iLstCategories* (<em>list<String></em>): The failing categories
+    def addUnrecoverableOrder(iLstObjects, iLstCategories)
+      @UnrecoverableOrders << [ iLstObjects, iLstCategories ]
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: StatsCollect
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  - 20101220
+  version: 0.1.0.20101220
+platform: ruby
+authors: 
+- Muriel Salvan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-20 00:00:00 +01:00
+default_executable: 
+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).
+email: murielsalvan@users.sourceforge.net
+executables: 
+- StatsCollect.rb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- AUTHORS
+- bin/StatsCollect.rb
+- ChangeLog
+- Credits
+- lib/StatsCollect/Backends/MySQL.rb
+- lib/StatsCollect/Backends/Terminal.rb
+- lib/StatsCollect/Locations/AddThis.rb
+- lib/StatsCollect/Locations/Facebook.rb
+- lib/StatsCollect/Locations/FacebookArtist.rb
+- lib/StatsCollect/Locations/FacebookLike.rb
+- lib/StatsCollect/Locations/GoogleSearch.rb
+- lib/StatsCollect/Locations/MySpace.rb
+- lib/StatsCollect/Locations/ReverbNation.rb
+- lib/StatsCollect/Locations/Tweets.rb
+- lib/StatsCollect/Locations/Twitter.rb
+- lib/StatsCollect/Locations/Youtube.rb
+- lib/StatsCollect/Notifiers/None.rb
+- lib/StatsCollect/Notifiers/SendMail.rb
+- lib/StatsCollect/Stats.rb
+- lib/StatsCollect/StatsProxy.rb
+- LICENSE
+- README
+- ReleaseInfo
+- StatsCollect.conf.rb.example
+- TODO
+has_rdoc: true
+homepage: http://statscollect.sourceforge.net/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: statscollect
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Command line tool gathering statistics from external sources.
+test_files: []
+