tronprint 0.0.6 → 0.0.7

data/README.rdoc

@@ -20,7 +20,8 @@ is used.
 
 If you haven't already, go to http://keys.brighterplanet.com and sign up for an
 API key. Non-commercial use of CM1 is free, but commercial use is 
-{charged}[http://carbon.brighterplanet.com/pricing] per-query.
+{charged}[http://carbon.brighterplanet.com/pricing] per-query. Heroku users are 
+charged per-month.
 
 === Rails
 
@@ -44,20 +45,25 @@ to minimize the number of API requests made to CM1.
 
 ==== Heroku
 
+Tronprint is available as a Heroku add-on. Add tronprint to your app, and 
+your app will have an environment variable provided: `ENV['TRONPRINT_API_KEY']`.
+
+The tronprint gem will handle API key setup for you, but you will still 
+need to configure your app to store statistics in MongoDB.
+
 The easiest way to get started on Heroku is to sign up for a free MongoHQ 
 account to be used for the Tronprint::Aggregator. Since Heroku doesn't 
 allow access to the filesystem, Tronprint::Aggregator's default YAML 
-storage option will not work. Once you have MongoDB set up, change 
-config/tronprint.yml to:
-
-  --- 
-  :aggregator_options: 
-    :adapter: :mongodb
-    :host: example.mongohq.com
-    :port: 1234
-    :db: tronprint
-    :collection: tronprint
-  :application_name: my_app
+storage option will not work. Once you have MongoDB set up, configure 
+tronprint with a Rails initializer:
+
+1. Open a new file, config/initializers/tronprint.rb
+1. In it, write: 
+  Tronprint.aggregator_options = {
+    :adapter => :mongodb,
+    :uri => ENV['MONGOHQ_URL'],
+    :collection => 'tronprint'
+  }
 
 === Other Ruby Apps
 
@@ -73,12 +79,6 @@ 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 
 methodology statement used to derive the estimate.
 
-=== Aggregator Configuration Notes
-
-If you want to hide your aggregator configuration, you can leave the :aggregator_options 
-item blank in config/tronprint.yml. In your application, manually set 
-Tronprint.aggregator_options to the values you desire.
-
 == Configuration
 
 There are several properties of Tronprint that can be configured. The configuration
@@ -88,7 +88,24 @@ can be set:
 :zip_code:: The ZIP code where the server or host computer resides.
 :brighter_planet_key:: Your Brighter Planet CM1 key. Get one from {keys.brighterplanet.com}[http://keys.brighterplanet.com].
 :application_name:: The name of your application.
-:aggregator_options:: A hash of options to send to the aggregator. A sub-option of :adapter is required. This corresponds to the name of an adapter supported by {moneta}[http://github.com/wycats/moneta]. All other sub-options given are passed on to the moneta adapter's initializer.
+:aggregator_options:: A hash of options to send to the aggregator. A sub-option of :adapter is required. This corresponds to the name of an adapter supported by {moneta}[http://github.com/dkastner/moneta]. All other sub-options given are passed on to the moneta adapter's initializer.
+
+=== Configuring the aggregator
+
+Tronprint needs to write the statistics it collects to a persistent data 
+store. There are two ways to configure this.
+
+The first way is to edit config/tronprint.yml as mentioned above.
+
+The second way is to manually set the aggregator options before Tronprint.run is called. 
+In Rails, this can be done with an initializer. Just set Tronprint.aggregator_options to
+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.
+The live example is at http://yaktrak.org
 
 == Note on Patches/Pull Requests
 

data/tronprint.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name = 'tronprint'
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.authors = ['Derek Kastner']
-  s.date = "2011-01-21"
+  s.date = "2011-01-26"
   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}
@@ -35,6 +35,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency   'sandbox'
   s.add_runtime_dependency   'carbon', '~> 1.0.3'
   s.add_runtime_dependency 'i18n'
-  s.add_runtime_dependency 'moneta'
+  s.add_runtime_dependency 'dkastner-moneta'
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Derek Kastner
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-21 00:00:00 -05:00
+date: 2011-01-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -114,7 +114,7 @@ dependencies:
   prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: moneta
+  name: dkastner-moneta
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -176,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 845450671
+      hash: -124500141
       segments: 
       - 0
       version: "0"
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 845450671
+      hash: -124500141
       segments: 
       - 0
       version: "0"