tronprint 0.0.16 → 1.0.0

data/README.rdoc

@@ -43,6 +43,20 @@ In order to display your application's footprint, you can use Tronprint's
 built-in view helper: TronprintHelper. Feel free to cache your footprint 
 to minimize the number of API requests made to CM1.
 
+In whichever controller(s) that will use TronprintHelper (or in `ApplicationController`), simply require the helper:
+
+  class FoosController
+    helper TronprintHelper
+  end
+
+==== Helper Methods
+
+TronprintHelper comes with a few helper methods:
+
+* footprint_badge - A badge that displays total footprint and current rate of emissions for your app.
+* cm1_badge - Displays a CM1 badge
+* footprint_methodology - A URL for a live methodology statement reporting how your total footprint was calculated. {Example}[http://carbon.brighterplanet.com/computations?duration=128372]
+
 ==== Heroku
 
 Tronprint is available as a Heroku add-on. Add tronprint to your app, and 
@@ -72,14 +86,14 @@ config/initializers/tronprint.rb:
 
     Tronprint.aggregator_options = { :adapter => :active_record }
 
-Before you get started with Tronprint on ActiveRecord and you're using a 
-relational database, (e.g., mysql) then you need to create the table 
-Tronprint will use for storage. The easiest way to do this is add to 
-your Rakefile:
+Tronprint automatically creates a storage table, `moneta_store` the next time your app
+is run.
+
+If you need to create the table manually, add to your Rakefile:
 
     require 'tronprint/rake_tasks/active_record'
 
-Then, run `rake tronprint:moneta`.
+And run `rake tronprint:moneta`
 
 === Other Ruby Apps
 
@@ -89,7 +103,7 @@ When your application has started, all you have to do is make a call to
 Tronprint.run. This starts up a thread that collects statistics at a 
 certain interval and stores the results in a key/value store.
 
-To retrieve the footprint, make a call to Tronprint.emission_estimate. This 
+To retrieve the footprint, make a call to Tronprint.statistics.emission_estimate. This 
 returns an instance of {Carbon::EmissionEstimate}[http://rubydoc.info/gems/carbon/Carbon/EmissionEstimate].
 It can be converted to a float for the amount in kilograms or other 
 methods, such as EmissionEstimate#methodology can provide a link to the 
@@ -120,7 +134,7 @@ the options you would normally set in config/tronprint.yml.
 == Examples
 
 You can see an example Rails app using tronprint at http://github.com/brighterplanet/yaktrak.
-Files of note: config/initializers/tronprint.rb, Gemfile, app/views/trackings/_form.html.rb.
+Files of note: `config/initializers/tronprint.rb`, `Gemfile`, `app/views/trackings/_form.html.rb`.
 The live example is at http://yaktrak.org
 
 == Note on Patches/Pull Requests

data/lib/tronprint/aggregator.rb

@@ -9,6 +9,8 @@ module Tronprint
   # {moneta}[http://github.com/wycats/moneta] will work.
   class Aggregator < Delegator
 
+    attr_accessor :adapter
+
     # Initialize the Aggregator with the following options:
     # +adapter+:: The underscore-ized name of the moneta class to use.
     # 
@@ -16,17 +18,17 @@ module Tronprint
     # You'll have to read {moneda's source code}[https://github.com/wycats/moneta/tree/master/lib/moneta/adapters]
     # for options needed by your desired adapter.
     def initialize(options = {})
-      adapter_underscored = options.delete :adapter
-      adapter_underscored ||= 'pstore'
-      adapter_underscored = adapter_underscored.to_s.downcase
+      self.adapter = options.delete :adapter
+      self.adapter ||= 'pstore'
+      self.adapter = self.adapter.to_s.downcase
       begin
-        require "moneta/#{adapter_underscored}"
-        klass = Moneta.const_get adapter_constant(adapter_underscored)
+        require "moneta/#{self.adapter}"
+        klass = Moneta.const_get adapter_constant
       rescue LoadError # Bundler hack
-        require "moneta/adapters/#{adapter_underscored}"
-        klass = Moneta::Adapters.const_get adapter_constant(adapter_underscored)
+        require "moneta/adapters/#{self.adapter}"
+        klass = Moneta::Adapters.const_get adapter_constant
       end
-      args = adapter_underscored == 'memory' ? [] : [options]
+      args = self.adapter == 'memory' ? [] : [options]
       instance = klass.new(*args)
       __setobj__ instance  # required in Ruby 1.8.7
       super instance
@@ -40,19 +42,97 @@ module Tronprint
     end
 
     # The class name of the desired moneta adapter
-    def adapter_constant(adapter_underscored)
-      case adapter_underscored
+    def adapter_constant
+      case self.adapter
       when 'pstore' then 'PStore'
       when 'yaml' then 'YAML'
       when 'mongodb' then 'MongoDB'
       else
-        adapter_underscored.split('_').map(&:capitalize).join('')
+        self.adapter.split('_').map(&:capitalize).join('')
       end
     end
 
     # Increment the total statistic by the given +value+, 
     # specified by the given +key+.
     def update(key, value)
+      update_total(key, value)
+      update_yearly(key, value)
+      update_monthly(key, value)
+      update_daily(key, value)
+      update_hourly(key, value)
+    end
+
+    def path(*args)
+      args.join('/')
+    end
+
+    def range_total(key, from, to)
+      raise "Invalid range" if from > to
+      total = 0
+      current = from
+      while current <= to
+        hourly_key = hourly_path(key, year(current), month(current), day(current), hour(current))
+        total += self[hourly_key].to_f
+        current = current + 3600
+      end
+
+      total
+    end
+
+  private
+
+    def year(time)
+      time.year.to_s
+    end
+    def current_year
+      year(Time.now)
+    end
+    def month(time)
+      sprintf('%02d', time.month)
+    end
+    def current_month
+      month(Time.now)
+    end
+    def day(time)
+      sprintf('%02d', time.day)
+    end
+    def current_day
+      day(Time.now)
+    end
+    def hour(time)
+      sprintf('%02d', time.hour)
+    end
+    def current_hour
+      hour(Time.now)
+    end
+
+    def update_total(key, value)
+      update_entry key, value
+    end
+
+    def update_yearly(key, value)
+      update_entry path(key, 'by_date', current_year), value
+    end
+
+    def update_monthly(key, value)
+      update_entry path(key, 'by_date', current_year, current_month), value
+    end
+
+    def update_daily(key, value)
+      update_entry path(key, 'by_date', current_year, current_month, current_day), value
+    end
+
+    def hourly_path(key, year, month, day, hour)
+      path(key, 'by_date', year, month, day, hour)
+    end
+    def update_hourly(key, value)
+      update_entry hourly_path(key, current_year, current_month,
+                        current_day, current_hour),
+                   value
+      update_entry path(key, 'hourly', current_hour), value
+    end
+
+    def update_entry(key, value)
       old_value = self[key]
       new_value = old_value ? old_value + value : value
       self[key] = new_value

data/lib/tronprint/app.rb

@@ -0,0 +1,13 @@
+module Tronprint
+  class App
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Tronprint.traffic_monitor.increment
+
+      @app.call(env)
+    end
+  end
+end

data/lib/tronprint/rails/tronprint_helper.rb

@@ -1,19 +1,42 @@
+require 'tronprint/statistics_formatter'
+
 # Rails helper for displaying footprint data.
 module TronprintHelper
+  include Tronprint::StatisticsFormatter
 
   # The total amount of CO2e generated by the application.
   def total_footprint
-    emission_estimate.to_f
+    total_estimate.to_f
+  end
+
+  # The total amount of electricity used by the application.
+  def total_electricity
+    total_estimate.electricity_use.to_f
   end
+
   # A URL for the methodology statement of the emissions calculation.
   def footprint_methodology
-    emission_estimate.methodology
+    Tronprint.statistics.total_footprint_methodology
   end
 
-  # The Carbon::EmissionEstimate object representing the 
-  # estimate processed by CM1.
-  def emission_estimate
-    @emission_estimate ||= Tronprint.emission_estimate
+  # An informational badge displaying total energy, footprint, CO2/minute
+  def footprint_badge
+    footprint = pounds_with_precision total_estimate
+
+    two_hr_emissions = Tronprint.statistics.
+      emission_estimate(Time.now - 7200, Time.now).to_f
+    rate = two_hr_emissions / 120  # kgs CO2 per minute over last 2 hours
+    rate = rate < 0.0001 ? "< 0.0001" : pounds_with_precision(rate)
+
+    text = <<-HTML
+      <p class="cm1-footprint">
+        <span class="cm1-total-footprint">Total footprint: #{total_electricity.to_i}W, #{footprint}lbs CO<sub>2</sub>e</span>
+        |
+        <span class="cm1-current-footprint">Current footprint: #{rate}lbs CO<sub>2</sub>e/min</span>
+      </p>
+    HTML
+
+    text.html_safe
   end
 
   # Let the world know that your app is powered by CM1
@@ -21,4 +44,8 @@ module TronprintHelper
     %q{<script type="text/javascript" src="http://carbon.brighterplanet.com/badge.js"></script>}.
       html_safe
   end
+  
+  def total_estimate
+    @total_estimate ||= Tronprint.statistics.emission_estimate
+  end
 end

data/lib/tronprint/rails.rb

@@ -1,12 +1,20 @@
 require 'rails'
 require 'tronprint/rails/tronprint_helper'
+require 'tronprint/app'
 
 module Tronprint
 
   # Rails plugin class.
   class Railtie < Rails::Railtie
+    initializer 'tronprint.configure' do |app|
+      app.config.middleware.use Tronprint::App
+    end
+
     config.after_initialize do
-      Tronprint.run # if Rails.env.production?
+      if Tronprint.aggregator.adapter == 'active_record' && !Moneta::Adapters::ActiveRecord::Store.table_exists?
+        Tronprint.aggregator.migrate
+      end
+      Tronprint.run
     end
 
     generators do

data/lib/tronprint/rake_tasks/active_record.rb

@@ -1,5 +1,5 @@
 namespace :tronprint do
-  desc 'Set up ActiveRecord datastore for Tronprint'
+  desc 'Manually set up ActiveRecord datastore for Tronprint'
   task :moneta => :environment do
     adapter_options = Tronprint.aggregator_options
     ar = Moneta::Adapters::ActiveRecord.new
@@ -7,5 +7,3 @@ namespace :tronprint do
     puts 'Ensured that Moneta::Adapters::ActiveRecord::Store exists'
   end
 end
-
-task 'db:migrate' => 'tronprint:moneta'

data/lib/tronprint/statistics.rb

@@ -0,0 +1,49 @@
+module Tronprint
+  # The Statistics class is your gateway to fetching statistics about 
+  # the energy usage and footprint of your app.
+  class Statistics
+
+    attr_accessor :aggregator, :cpu_monitor
+
+    def initialize(aggregator, cpu_monitor)
+      self.aggregator = aggregator
+      self.cpu_monitor = cpu_monitor
+    end
+
+    # Fetch the total amount of CPU time (in hours) used by the application.
+    def total_duration
+      aggregator[cpu_monitor.key] / 3600
+    end
+
+    # Fetch total CPU time for a given range
+    def range_duration(from, to)
+      aggregator.range_total cpu_monitor.key, from, to
+    end
+
+    # Calculate emissions using aggregated data. A call is made to 
+    # Brighter Planet's CM1 emission estimate service. Specifically,
+    # the call is made to the {computation emitter}[http://carbon.brighterplanet.com/models/computation]
+    def emission_estimate(from = nil, to = nil)
+      duration = from.nil? ? total_duration : range_duration(from, to)
+
+      app = Application.new :zip_code => Tronprint.zip_code, :duration => duration, 
+        :brighter_planet_key => Tronprint.brighter_planet_key
+      app.emission_estimate
+    end
+
+    # The total amount of CO2e generated by the application.
+    def total_footprint
+      emission_estimate.to_f
+    end
+
+    # The total amount of electricity used by the application.
+    def total_electricity
+      emission_estimate.electricity_use.to_f
+    end
+    
+    # A URL for the methodology statement of the total_footprint calculation.
+    def total_footprint_methodology
+      emission_estimate.methodology
+    end
+  end
+end

data/lib/tronprint/statistics_formatter.rb

@@ -0,0 +1,11 @@
+module Tronprint
+  module StatisticsFormatter
+    def pounds_with_precision(number, precision = nil)
+      if precision.nil?
+        precision = number < 100 ? 4 : 0
+      end
+
+      number_with_precision(number * 2.2046, :precision => precision)
+    end
+  end
+end

data/lib/tronprint/traffic_monitor.rb

@@ -0,0 +1,29 @@
+module Tronprint
+
+  # Tronprint::CPUMonitor is a thread that monitors aggregate CPU usage.
+  class TrafficMonitor
+    attr_accessor :aggregator, :application_name
+
+    # Parameters:
+    # +aggregator+:: A Tronprint::Aggregator instance.
+    # +application_name+:: A unique application name.
+    def initialize(aggregator, application_name)
+      self.aggregator = aggregator
+      self.application_name = application_name
+    end
+
+    # The key used to store number of requests in the Aggregator.
+    def key
+      [application_name, 'requests'].join('/')
+    end
+
+    # Increment the total number of requests
+    def increment
+      aggregator.update key, 1
+    end
+
+    def requests
+      aggregator[key] || 0
+    end
+  end
+end

data/lib/tronprint/version.rb

@@ -1,3 +1,3 @@
 module Tronprint
-  VERSION = "0.0.16"
+  VERSION = "1.0.0"
 end

data/lib/tronprint.rb

@@ -2,6 +2,8 @@ require 'yaml'
 require 'tronprint/aggregator'
 require 'tronprint/application'
 require 'tronprint/cpu_monitor'
+require 'tronprint/traffic_monitor'
+require 'tronprint/statistics'
 
 if defined?(Rails)
   require 'tronprint/rails'
@@ -72,9 +74,14 @@ module Tronprint
     @cpu_monitor ||= CPUMonitor.new aggregator, application_name
   end
 
-  # Fetch the total amount of CPU time (in hours) used by the application.
-  def total_duration
-    aggregator[cpu_monitor.key] / 3600
+  # The Tronprint::TrafficMonitor instance
+  def traffic_monitor
+    @traffic_monitor ||= TrafficMonitor.new aggregator, application_name
+  end
+
+  # The Tronprint::Statistics interface
+  def statistics
+    @statistics ||= Statistics.new aggregator, cpu_monitor
   end
 
   # The current configuration.
@@ -117,13 +124,4 @@ module Tronprint
     }
     @default_config
   end
-
-  # Calculate emissions using aggregated data. A call is made to 
-  # Brighter Planet's CM1 emission estimate service. Specifically,
-  # the call is made to the {computation emitter}[http://carbon.brighterplanet.com/models/computation]
-  def emission_estimate
-    app = Application.new :zip_code => zip_code, :duration => total_duration, 
-      :brighter_planet_key => brighter_planet_key
-    app.emission_estimate
-  end
 end

data/spec/tronprint/aggregator_spec.rb

@@ -1,18 +1,102 @@
 require 'spec_helper'
 require 'sandbox'
+require 'time'
+require 'timecop'
 
 describe Tronprint::Aggregator do
   let(:aggregator) { Tronprint::Aggregator.new :adapter => :memory }
 
   describe '#update' do
-    it 'should write statistics to an uninitailzed key' do
+    let(:now) { Time.parse('2011-06-02 13:45:12') }
+    before do
+      Timecop.freeze now
+    end
+    after do
+      Timecop.return
+    end
+
+    it 'writes statistics to an uninitailzed key' do
       aggregator.update('foo/bar', 22.1)
       aggregator['foo/bar'].should == 22.1
     end
-    it 'should cumulatively update statistics' do
+    it 'cumulatively updates statistics' do
       aggregator.update('foo/bar', 22.1)
       aggregator.update('foo/bar', 44.2)
       aggregator['foo/bar'].should be_within(0.01).of(66.3)
+      aggregator['foo/bar/by_date/2011'].should be_within(0.01).of(66.3)
+      aggregator['foo/bar/by_date/2011/06'].should be_within(0.01).of(66.3)
+      aggregator['foo/bar/by_date/2011/06/02'].should be_within(0.01).of(66.3)
+      aggregator['foo/bar/by_date/2011/06/02/13'].should be_within(0.01).of(66.3)
+      aggregator['foo/bar/hourly/13'].should be_within(0.01).of(66.3)
+    end
+    it 'stores by_date statistics in separate entries for each day, month, and year' do
+      aggregator.update('foo/bar', 22.1)
+      aggregator.update('foo/bar', 23.1)
+      aggregator['foo/bar/by_date/2011'].should be_within(0.01).of(45.2)
+      aggregator['foo/bar/by_date/2011/06'].should be_within(0.01).of(45.2)
+      aggregator['foo/bar/by_date/2011/06/02'].should be_within(0.01).of(45.2)
+      aggregator['foo/bar/by_date/2011/06/02/13'].should be_within(0.01).of(45.2)
+      aggregator['foo/bar/hourly/13'].should be_within(0.01).of(45.2)
+
+      Timecop.freeze Time.parse('2011-06-03 11:45:12')
+      aggregator.update('foo/bar', 33.1)
+      aggregator['foo/bar/by_date/2011'].should be_within(0.01).of(78.3)
+      aggregator['foo/bar/by_date/2011/06'].should be_within(0.01).of(78.3)
+      aggregator['foo/bar/by_date/2011/06/03'].should be_within(0.01).of(33.1)
+      aggregator['foo/bar/by_date/2011/06/03/11'].should be_within(0.01).of(33.1)
+      aggregator['foo/bar/hourly/11'].should be_within(0.01).of(33.1)
+
+      Timecop.freeze Time.parse('2011-05-03 11:45:12')
+      aggregator.update('foo/bar', 44.1)
+      aggregator['foo/bar/by_date/2011'].should be_within(0.01).of(122.4)
+      aggregator['foo/bar/by_date/2011/05'].should be_within(0.01).of(44.1)
+      aggregator['foo/bar/by_date/2011/06'].should be_within(0.01).of(78.3)
+      aggregator['foo/bar/by_date/2011/05/03'].should be_within(0.01).of(44.1)
+      aggregator['foo/bar/by_date/2011/05/03/11'].should be_within(0.01).of(44.1)
+      aggregator['foo/bar/hourly/11'].should be_within(0.01).of(77.2)
+
+      Timecop.freeze Time.parse('2012-05-03 00:45:12')
+      aggregator.update('foo/bar', 55.1)
+      aggregator['foo/bar/by_date/2012'].should be_within(0.01).of(55.1)
+      aggregator['foo/bar/by_date/2012/05'].should be_within(0.01).of(55.1)
+      aggregator['foo/bar/by_date/2012/05/03'].should be_within(0.01).of(55.1)
+      aggregator['foo/bar/by_date/2012/05/03/00'].should be_within(0.01).of(55.1)
+      aggregator['foo/bar/hourly/00'].should be_within(0.01).of(55.1)
+
+      Timecop.freeze Time.parse('2012-05-03 00:57:02')
+      aggregator.update('foo/bar', 55.1)
+      aggregator['foo/bar/by_date/2012'].should be_within(0.01).of(110.2)
+      aggregator['foo/bar/by_date/2012/05'].should be_within(0.01).of(110.2)
+      aggregator['foo/bar/by_date/2012/05/03'].should be_within(0.01).of(110.2)
+      aggregator['foo/bar/by_date/2012/05/03/00'].should be_within(0.01).of(110.2)
+      aggregator['foo/bar/hourly/00'].should be_within(0.01).of(110.2)
+    end
+  end
+
+  describe '#range_total' do
+    before :each do
+      [
+        '2011-06-02 13:01:00','2011-06-02 14:01:00','2011-06-02 15:01:00',
+        '2011-06-02 16:01:00','2011-06-02 18:01:00','2011-06-02 19:01:00',
+        '2011-06-02 19:01:00','2011-06-02 20:01:00','2011-06-02 21:01:00',
+      ].each do |time|
+        Timecop.freeze Time.parse(time)
+        aggregator.update('foozle', 1)
+      end
+      Timecop.return
+    end
+
+    it 'returns a total for a given range' do
+      result = aggregator.range_total('foozle', Time.parse('2011-06-02 18:01:00'), Time.parse('2011-06-02 20:01:00'))
+      result.should == 4
+    end
+    it 'counts missing hours as 0' do
+      result = aggregator.range_total('foozle', Time.parse('2011-06-02 01:01:00'), Time.parse('2011-06-02 04:01:00'))
+      result.should == 0
+    end
+    it 'counts missing hours as 0 when a range has partial data' do
+      result = aggregator.range_total('foozle', Time.parse('2011-06-02 16:01:00'), Time.parse('2011-06-02 18:01:00'))
+      result.should == 2
     end
   end
 end

data/spec/tronprint/application_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 
 describe Tronprint::Application do
-  let(:application) { Tronprint::Application.new }
-
-  describe '#duration' do
-
+  it 'reports emission esimates for application-related activity' do
+    app = Tronprint::Application.new :duration => 72831, :zip_code => 48915
+    app.should respond_to(:emission_estimate)
   end
 end
 

data/spec/tronprint/cpu_monitor_spec.rb

@@ -8,11 +8,11 @@ describe Tronprint::CPUMonitor do
     before :each do
       cpu_monitor.stub!(:elapsed_cpu_time).and_return 23.87
     end
-    it 'should write the elapsed time to the aggregate statistics' do
+    it 'writes the elapsed time to the aggregate statistics' do
       cpu_monitor.monitor
       aggregator['my_app/application/cpu_time'].should == 23.87
     end
-    it 'should increment the toal recorded cpu time' do
+    it 'increments the toal recorded cpu time' do
       cpu_monitor.stub!(:elapsed_cpu_time).and_return 9.0
       cpu_monitor.monitor
       cpu_monitor.total_recorded_cpu_time.should == 9.0
@@ -23,12 +23,12 @@ describe Tronprint::CPUMonitor do
   end
 
   describe '#elapsed_cpu_time' do
-    it 'should return the total CPU time on the first run' do
+    it 'returns the total CPU time on the first run' do
       cpu_monitor.stub!(:total_recorded_cpu_time).and_return 0
       cpu_monitor.stub!(:total_cpu_time).and_return 9.0
       cpu_monitor.elapsed_cpu_time.should == 9.0
     end
-    it 'should return the amount of CPU time used since the last check' do
+    it 'returns the amount of CPU time used since the last check' do
       cpu_monitor.stub!(:total_recorded_cpu_time).and_return 23.0
       cpu_monitor.stub!(:total_cpu_time).and_return 36.0
       cpu_monitor.elapsed_cpu_time.should == 13.0
@@ -36,17 +36,17 @@ describe Tronprint::CPUMonitor do
   end
 
   describe '#total_cpu_time' do
-    it 'should return the total user and system time of the process' do
+    it 'returns the total user and system time of the process' do
       Process.stub!(:times).and_return [10.1, 12.3]
       cpu_monitor.total_cpu_time.should == 22.4
     end
   end
 
   describe '#total_recorded_cpu_time' do
-    it 'should return 0 by default' do
+    it 'returns 0 by default' do
       cpu_monitor.total_recorded_cpu_time.should == 0
     end
-    it 'should return total recorded time' do
+    it 'returns total recorded time' do
       cpu_monitor.total_recorded_cpu_time = 3
       cpu_monitor.total_recorded_cpu_time.should == 3
     end

data/spec/tronprint/rails/tronprint_helper_spec.rb

@@ -9,8 +9,8 @@ describe TronprintHelper do
   end
 
   describe '#total_footprint' do
-    it 'should return the total footprint' do
-      helper.stub!(:emission_estimate).and_return 89.4
+    it 'returns the total footprint' do
+      Tronprint.statistics.stub!(:emission_estimate).and_return mock(Object, :to_f => 89.4)
       helper.total_footprint.should == 89.4
     end
   end

data/spec/tronprint/statistics_formatter_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'tronprint/statistics_formatter'
+require 'action_view'
+
+class StatisticsFormatterHarness
+  include ActionView::Helpers
+  include Tronprint::StatisticsFormatter
+end
+
+describe Tronprint::StatisticsFormatter do
+  let(:formatter) { StatisticsFormatterHarness.new }
+
+  describe '#pounds_with_precision' do
+    it 'converts kilograms to pounds' do
+      formatter.pounds_with_precision(1).should == '2.2046'
+    end
+    it 'uses a precision of 4 if the number is less than 100' do
+      formatter.pounds_with_precision(8).should == '17.6368'
+    end
+    it 'uses a precision of 4 if the number is 0' do
+      formatter.pounds_with_precision(0).should == '0.0000'
+    end
+    it 'uses a precision of 0 if the number is at least 100' do
+      formatter.pounds_with_precision(60).should == '132.2760'
+    end
+  end
+end
+

data/spec/tronprint/statistics_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Tronprint::Statistics do
+  let(:aggregator) { Tronprint::Aggregator.new :adapter => :memory }
+  let(:cpu_monitor) { mock Tronprint::CPUMonitor, :total_recorded_cpu_time => 27.2,
+                          :key => 'myapp' }
+  let(:statistics) { Tronprint::Statistics.new aggregator, cpu_monitor }
+  
+  before do
+    Tronprint.zip_code = 48915
+    Tronprint.brighter_planet_key = 'ABC123'
+    Tronprint.application_name = 'groove'
+  end
+
+  after do
+    aggregator.clear
+  end
+
+  describe '#emission_estimate' do
+    it 'sends uses total duration if no range is given' do
+      statistics.stub!(:total_duration).and_return 28.7
+      Tronprint::Application.should_receive(:new).
+        with(:zip_code => 48915, :duration => 28.7, :brighter_planet_key => 'ABC123').
+        and_return mock(Object, :emission_estimate => nil)
+      statistics.emission_estimate
+    end
+    it 'sends a duration range if given' do
+      statistics.stub!(:range_duration).and_return 18.7
+      Tronprint::Application.should_receive(:new).
+        with(:zip_code => 48915, :duration => 18.7, :brighter_planet_key => 'ABC123').
+        and_return mock(Object, :emission_estimate => nil)
+      statistics.emission_estimate(Time.now - 7200, Time.now)
+    end
+  end
+
+  describe '#total_duration' do
+    it 'looks up the total for the application and return number of hours' do
+      mock_cpu = mock Tronprint::CPUMonitor, :key => 'groove/application/cpu_time'
+      statistics.instance_variable_set :@cpu_monitor, mock_cpu
+      statistics.aggregator.update 'groove/application/cpu_time', 5.0
+      statistics.total_duration.should be_within(0.00001).of(0.00138)
+    end
+  end
+end
+

data/spec/tronprint/traffic_monitor_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'timecop'
+
+describe Tronprint::TrafficMonitor do
+  let(:aggregator) { Tronprint::Aggregator.new :adapter => :memory }
+  let(:traffic_monitor) { Tronprint::TrafficMonitor.new aggregator, 'my_app' }
+
+  describe '#increment' do
+    it 'increments the user count for each time slice' do
+      Timecop.freeze Time.parse('2011-06-02 13:23:01')
+      2.times { traffic_monitor.increment }
+      aggregator['my_app/requests'].should == 2
+      aggregator['my_app/requests/by_date/2011'].should == 2
+      aggregator['my_app/requests/by_date/2011/06'].should == 2
+      aggregator['my_app/requests/by_date/2011/06/02'].should == 2
+      aggregator['my_app/requests/by_date/2011/06/02/13'].should == 2
+      aggregator['my_app/requests/hourly/13'].should == 2
+      Timecop.return
+    end
+    it 'increments the toal recorded requests' do
+      traffic_monitor.increment
+      traffic_monitor.requests.should == 1
+      traffic_monitor.increment
+      traffic_monitor.requests.should == 2
+    end
+  end
+
+  describe '#requests' do
+    it 'returns 0 on the first run' do
+      traffic_monitor.requests.should == 0
+    end
+    it 'returns the total number of requests' do
+      aggregator['my_app/requests'] = 13
+      traffic_monitor.requests.should == 13
+    end
+  end
+end
+

data/spec/tronprint_spec.rb

@@ -8,39 +8,27 @@ describe Tronprint do
   end
 
   describe '.run' do
-    it 'should start up each monitor' do
+    it 'starts up each monitor' do
       Tronprint.should_receive :cpu_monitor
       Tronprint.run
     end
   end
 
   describe '.cpu_monitor' do
-    it 'should start the CPU monitor' do
+    it 'starts the CPU monitor' do
+      Tronprint.instance_variable_set :@cpu_monitor, nil
       Tronprint::CPUMonitor.should_receive(:new).and_return mock_cpu
       Tronprint.cpu_monitor
     end
-    it 'should return the CPU monitor instance' do
+    it 'returns the CPU monitor instance' do
       Tronprint.instance_variable_set :@cpu_monitor, nil
       Tronprint::CPUMonitor.stub!(:new).and_return mock_cpu
       Tronprint.cpu_monitor.should == mock_cpu
     end
   end
 
-  describe '.emission_estimate' do
-    it 'should send the zip code and total duration to the application' do
-      Tronprint.instance_variable_set(:@emission_estimate, nil)
-      Tronprint.zip_code = 48915
-      Tronprint.brighter_planet_key = 'ABC123'
-      Tronprint.stub!(:total_duration).and_return 28.7
-      Tronprint::Application.should_receive(:new).
-        with(:zip_code => 48915, :duration => 28.7, :brighter_planet_key => 'ABC123').
-        and_return mock(Object, :emission_estimate => nil)
-      Tronprint.emission_estimate
-    end
-  end
-
   describe '.brighter_planet_key' do
-    it 'should return the brighter_planet_key config option' do
+    it 'returns the brighter_planet_key config option' do
       Tronprint.instance_variable_set :@brighter_planet_key, nil
       Tronprint.stub!(:config).and_return({ :brighter_planet_key => 'aaa' })
       Tronprint.brighter_planet_key.should == 'aaa'
@@ -48,11 +36,11 @@ describe Tronprint do
   end
 
   describe '.config' do
-    it 'should return a configuration loaded from disk' do
+    it 'returns a configuration loaded from disk' do
       Tronprint.stub!(:load_config).and_return :foo => :bar
       Tronprint.config.should include(:foo => :bar)
     end
-    it 'should return a default configuration if no config file exists' do
+    it 'returns a default configuration if no config file exists' do
       Tronprint.stub!(:default_config).and_return :foo => :bar
       Tronprint.config.should include(:foo => :bar)
     end
@@ -62,14 +50,14 @@ describe Tronprint do
     before :each do
       Tronprint.instance_variable_set :@loaded_config, nil
     end
-    it 'should load a config file from cwd/config/tronprint.yml if it exists' do
+    it 'loads a config file from cwd/config/tronprint.yml if it exists' do
       Dir.stub!(:pwd).and_return '/some/dir'
       File.stub!(:exist?).and_return true
       YAML.should_receive(:load_file).with('/some/dir/config/tronprint.yml').
         and_return :my => :config
       Tronprint.load_config.should == { :my => :config }
     end
-    it 'should return nil if no config file exists' do
+    it 'returns nil if no config file exists' do
       Tronprint.instance_variable_set :@loaded_config, nil
       Dir.stub!(:pwd).and_return '/some/dir'
       File.stub!(:exist?).and_return false
@@ -85,27 +73,17 @@ describe Tronprint do
       ENV['TRONPRINT_API_KEY'] = nil
       ENV['MONGOHQ_URL'] = nil
     end
-    it 'should return a default configuration' do
+    it 'returns a default configuration' do
       Tronprint.default_config.should be_an_instance_of(Hash)
     end
-    it 'should set the brighter_planet_key if ENV["TRONPRINT_API_KEY"] is set' do
+    it 'sets the brighter_planet_key if ENV["TRONPRINT_API_KEY"] is set' do
       ENV['TRONPRINT_API_KEY'] = 'abc123'
       Tronprint.default_config[:brighter_planet_key].should == 'abc123'
     end
-    it 'should use MongoHQ if ENV["MONGOHQ_URL"] is set' do
+    it 'uses MongoHQ if ENV["MONGOHQ_URL"] is set' do
       ENV['MONGOHQ_URL'] = 'mongodb://foo.com/bar'
       Tronprint.default_config[:aggregator_options][:adapter].should == :mongodb
       Tronprint.default_config[:aggregator_options][:uri].should == 'mongodb://foo.com/bar'
     end
   end
-
-  describe '.total_duration' do
-    it 'should look up the total for the application and return number of hours' do
-      mock_cpu = mock Tronprint::CPUMonitor, :key => 'groove/application/cpu_time'
-      Tronprint.instance_variable_set :@cpu_monitor, mock_cpu
-      Tronprint.application_name = 'groove'
-      Tronprint.aggregator.update 'groove/application/cpu_time', 5.0
-      Tronprint.total_duration.should be_within(0.00001).of(0.00138)
-    end
-  end
 end

data/tronprint.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version = Tronprint::VERSION
 
   s.authors = ['Derek Kastner']
-  s.date = "2011-02-03"
+  s.date = "2011-06-15"
   s.description = %q{A gem for monitoring the carbon footprint of your ruby app}
   s.email = %q{dkastner@gmail.com}
   s.homepage = %q{http://github.com/brighterplanet/tronprint}
@@ -30,13 +30,16 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby process carbon footprinter}
 
+  s.add_development_dependency 'actionpack', '~> 3'
+  s.add_development_dependency 'activesupport', '~> 3'
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'bueller', '~> 0.0.2'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 2.0'
-  s.add_development_dependency   'sandbox'
+  s.add_development_dependency 'sandbox'
+  s.add_development_dependency 'timecop'
   s.add_runtime_dependency   'carbon', '~> 1.0.3'
   s.add_runtime_dependency 'i18n'
-  s.add_runtime_dependency 'dkastner-moneta', '~> 1.0.3'
+  s.add_runtime_dependency 'dkastner-moneta', '~> 1.0.5'
 end
 

metadata

@@ -1,150 +1,156 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tronprint
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 16
-  version: 0.0.16
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Derek Kastner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-03 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-06-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &2157410400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: *2157410400
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2157409500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: *2157409500
+- !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2157409100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157409100
+- !ruby/object:Gem::Dependency
   name: bueller
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2157408560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 0
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.0.2
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157408560
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2157408040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157408040
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &2157407300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157407300
+- !ruby/object:Gem::Dependency
   name: sandbox
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &2157406680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157406680
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2157400260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157400260
+- !ruby/object:Gem::Dependency
   name: carbon
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &2157399320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 3
+      - !ruby/object:Gem::Version
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157399320
+- !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &2157397400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2157397400
+- !ruby/object:Gem::Dependency
   name: dkastner-moneta
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &2157366380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 3
-        version: 1.0.3
+      - !ruby/object:Gem::Version
+        version: 1.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *id008
+  version_requirements: *2157366380
 description: A gem for monitoring the carbon footprint of your ruby app
 email: dkastner@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - lib/tronprint/aggregator.rb
+- lib/tronprint/app.rb
 - lib/tronprint/application.rb
 - lib/tronprint/cpu_monitor.rb
 - lib/tronprint/rails/generator.rb
 - lib/tronprint/rails/tronprint_helper.rb
 - lib/tronprint/rails.rb
 - lib/tronprint/rake_tasks/active_record.rb
+- lib/tronprint/statistics.rb
+- lib/tronprint/statistics_formatter.rb
+- lib/tronprint/traffic_monitor.rb
 - lib/tronprint/version.rb
 - lib/tronprint.rb
 - .document
@@ -159,55 +165,55 @@ files:
 - spec/spec_helper.rb
 - spec/tronprint/aggregator_spec.rb
 - spec/tronprint/application_spec.rb
-- spec/tronprint/computer_spec.rb
 - spec/tronprint/cpu_monitor_spec.rb
 - spec/tronprint/rails/tronprint_helper_spec.rb
+- spec/tronprint/statistics_formatter_spec.rb
+- spec/tronprint/statistics_spec.rb
+- spec/tronprint/traffic_monitor_spec.rb
 - spec/tronprint_spec.rb
 - features/step_definitions/tronprint_steps.rb
 - features/support/env.rb
 - features/tronprint.feature
-has_rdoc: true
 homepage: http://github.com/brighterplanet/tronprint
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 839406187484222147
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3534616707855240394
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 839406187484222147
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -3534616707855240394
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Ruby process carbon footprinter
-test_files: 
+test_files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/tronprint/aggregator_spec.rb
 - spec/tronprint/application_spec.rb
-- spec/tronprint/computer_spec.rb
 - spec/tronprint/cpu_monitor_spec.rb
 - spec/tronprint/rails/tronprint_helper_spec.rb
+- spec/tronprint/statistics_formatter_spec.rb
+- spec/tronprint/statistics_spec.rb
+- spec/tronprint/traffic_monitor_spec.rb
 - spec/tronprint_spec.rb
 - features/step_definitions/tronprint_steps.rb
 - features/support/env.rb

data/spec/tronprint/computer_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-describe Tronprint::Application do
-  it 'should report emission esimates for application-related activity' do
-    app = Tronprint::Application.new :duration => 72831, :zip_code => 48915
-    app.should respond_to(:emission_estimate)
-  end
-end
-