vanity-source 0.3 → 0.4

data/CHANGELOG

@@ -1,3 +1,15 @@
+2010-08-19 v0.4 Metrics that set and increment
+
+Revised setup method to change special values metric.name and metric.columns
+(was name and column).
+
+There are two types of metrics, those that collect totals and those that
+collect daily/hourly values. The setup method indicates that by setting the
+value metric.total (defaults to false).
+
+Revised update method to allow either setting current value (:set) or
+incrementing current value (:inc).
+
 2010-08-11 v0.3 Always be sending changes
 
 Changed: Collector update methods accepts inc and timestamp arguments (but set

data/Gemfile

@@ -1,4 +1,5 @@
 source "http://rubygems.org/"
+gemspec
 
 group :development do
   gem "rake"

data/lib/vanity/source.rb

@@ -27,11 +27,17 @@ module Vanity
   # is a Hash that can store basic Ruby values (nil, String, boolean, Numeric,
   # Array and Hash).
   #
-  # In particular, #setup must set two special values: name and columns. The
-  # first is the name for the collector, e.g. our Twitter source might produce
-  # the name "Twitter Mentions of @vanitydash". The second denotes all the
-  # columns that could be used in a metric. This value is an array, where each
-  # item describes a single column with a hash using the following keys:
+  # In particular, #setup must set specific values for each collector:
+  # * metric.name -- The name of the metric, e.g. Twitter source might pick the
+  #   name "Twitter mentions of @vanitydash".
+  # * metric.columns -- Specifies the columns (at least one) that make up this
+  #   metric. The value if an array where each item describes a single column,
+  #   see below for more details.
+  # * metric.totals -- True if this metric collects totals (life-time values,
+  #   e.g. downloads, user accounts), false if it only collects daily values
+  #   (e.g. average response time, number of instances in cluster).
+  #
+  # For metric.columns, each item can use the following keys:
   # * id -- Column identifier (if missing, derived from column name)
   # * name -- Column name (required)
   #
@@ -53,6 +59,9 @@ module Vanity
   # of times with any combination of arguments.
   #
   # The named arguments are:
+  # * set -- Columns to set (metric). Records the most recent value for this
+  #   metric. This is a hash where the keys are column ids (or indexes), the
+  #   values are integers or floats.
   # * inc -- Columns to increment (metric). Records a change in value which may
   #   be positive or negative. This is a hash where the keys are column ids (or
   #   indexes), the values are integers or floats.

data/lib/vanity/sources/ruby_gems.rb

@@ -23,8 +23,9 @@ module Vanity
 
       def setup(context, params)
         gem_name = params["gem_name"].to_s.strip
-        context["name"] = "RubyGems: #{gem_name}"
-        context["columns"] = [{ id: "downloads", label: "Downloads" }]
+        context["metric.name"] = "RubyGems: #{gem_name}"
+        context["metric.columns"] = [{ id: "downloads", label: "Downloads" }]
+        context["metric.totals"] = true
         context["gem_name"] = gem_name
       end
 
@@ -40,9 +41,7 @@ module Vanity
           json = JSON.parse(response.body)
           context["version"] = json["version"]
           context.update json.slice(*%w{homepage_uri project_uri info authors info})
-          current, previous = json["downloads"], context["downloads"] 
-          yield :inc=>{ :downloads=>(current - previous) } if previous && current > previous
-          context["downloads"] = current
+          yield :set=>{ :downloads=>json["downloads"] }
         when Net::HTTPNotFound
           raise "Could not find the Gem \"#{context["gem_name"]}\""
         end
@@ -53,7 +52,6 @@ module Vanity
           { text: context["info"] },
           { title: "Version", text: context["version"] },
           { title: "Authors", text: context["authors"] },
-          { title: "Downloads", text: context["downloads"] },
           { title: "Source", text: "RubyGems", url: context["project_uri"] } ]
       end
 

data/vanity-source.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = "vanity-source"
-  spec.version        = "0.3"
+  spec.version        = "0.4"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://vanitydash.com"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: vanity-source
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 3
-  version: "0.3"
+  - 4
+  version: "0.4"
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-11 00:00:00 -07:00
+date: 2010-08-18 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -43,7 +43,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Vanity::Source 0.3
+- Vanity::Source 0.4
 - --main
 - README.rdoc
 - --webcvs