carbon 0.2.2 → 0.2.3

data/README.rdoc

@@ -44,11 +44,11 @@ In order to calculate carbon emissions, we need to map the car's relevant attrib
       end
     end
 
-When you want to calculate emissions, simply call <tt>RentalCar#emission</tt>.
+When you want to calculate emissions, simply call <tt>RentalCar#emission_estimate</tt>.
 
     > my_car = RentalCar.new([...])
     => #<RentalCar [...]>
-    > my_emission = my_car.emission
+    > my_emission = my_car.emission_estimate
     => #<Carbon::EmissionEstimate [...]>
     > my_emission.to_f
     => 4919.2
@@ -75,9 +75,9 @@ Let's say <tt>RentalCar#make</tt> returns a <tt>Make</tt> object. You should def
 
 == A note on asynchronous queries
 
-To request an emission estimate asynchronously, simply pass an URL as the <tt>:callback</tt> option to <tt>#emission</tt>:
+To request an emission estimate asynchronously, simply pass an URL as the <tt>:callback</tt> option to <tt>#emission_estimate</tt>:
 
-    > RentalCar.new.emission :callback => http://example.com/my/callback/handler
+    > RentalCar.new.emission_estimate :callback => http://example.com/my/callback/handler
 
 A good way to test this is to set up a {PostBin}[http://postbin.org].
 
@@ -86,7 +86,7 @@ A good way to test this is to set up a {PostBin}[http://postbin.org].
 Since this gem connects to a web service, you need to be ready for network problems and latency. For example:
 
     begin
-      my_emission = my_car.emission
+      my_emission = my_car.emission_estimate
     rescue ::SocketError, ::Timeout::Error, ::Errno::ETIMEDOUT, ::Errno::ENETUNREACH, ::Errno::ECONNRESET, ::Errno::ECONNREFUSED
       # These are general network errors raised by Net::HTTP.
       # Your internet connection might be down, or our servers might be down.

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/carbon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{carbon}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Derek Kastner", "Seamus Abshere", "Andy Rossmeissl"]
-  s.date = %q{2010-07-21}
+  s.date = %q{2010-07-22}
   s.description = %q{Carbon is a Ruby API wrapper for the Brighter Planet emission estimate web service (http://carbon.brighterplanet.com). By querying the web service, it can estimate the carbon emissions of many real-life objects, such as cars and houses, based on particular attributes that they may have.}
   s.email = %q{derek.kastner@brighterplanet.com}
   s.extra_rdoc_files = [

data/lib/carbon.rb

@@ -35,7 +35,7 @@ require 'carbon/emission_estimate'
 # * A rental car emits carbon like an "automobile", which is one of Brighter Planet's recognized emitter classes.
 # * Your implementation can provide up to three data points about a rental car: its make, its model, and its model year (but not necessarily all of them, all the time.)
 #
-# Once you've mixed in <tt>Carbon</tt>, you get the method <tt>emission</tt>, which you can call at any time to request an emission estimate.
+# Once you've mixed in <tt>Carbon</tt>, you get the method <tt>emission_estimate</tt>, which you can call at any time to request an emission estimate.
 module Carbon
   def self.included(klass) # :nodoc:
     klass.cattr_accessor :carbon_base
@@ -73,7 +73,7 @@ module Carbon
       self.carbon_base ||= ::Carbon::Base.new self, emitter_common_name
       ::Blockenspiel.invoke block, carbon_base
     end
-    # japanese-style preferred
+    # Third-person singular preferred.
     alias :emits_as :emit_as
   end
 
@@ -82,10 +82,10 @@ module Carbon
   # Note: please see the README about <b>exceptions that you should watch out for</b>.
   # 
   # You can use it like a number...
-  #   > my_car.emission + 5.1
+  #   > my_car.emission_estimate + 5.1
   #   => 415.39
   # Or you can get information about the response
-  #   > my_car.emission.methodology
+  #   > my_car.emission_estimate.methodology
   #   => 'http://carbon.brighterplanet.com/automobiles.html?[...]'
   #
   # === Options:
@@ -99,5 +99,4 @@ module Carbon
     @emission_estimate.take_options options
     @emission_estimate
   end
-  alias :emission :emission_estimate
 end

data/lib/carbon/base.rb

@@ -50,7 +50,7 @@ module Carbon
       # translation_table[:make] = 'epa_code'
       translation_table[characteristic] = options[:key]
     end
-    # japanese-style preferred
+    # Third-person singular preferred.
     alias :provides :provide
   end
 end

data/lib/carbon/emission_estimate.rb

@@ -6,11 +6,9 @@ module Carbon
   #
   # If you ask for a callback, on the other hand, you can't use them as numbers.
   #
-  # So, you can just say <tt>my_car.emission</tt> and you'll get something like <tt>4308.29</tt>.
+  # So, you can just say <tt>my_car.emission_estimate.to_s</tt> and you'll get something like <tt>"4308.29"</tt>.
   #
-  # At the same time, they contain all the data you get back from the emission estimate web service. For example, you could say <tt>puts my_donut_factor.emission.oven_count</tt> (see the tests) and you'd get back the oven count used in the calculation, if any.
-  # 
-  # Note: <b>you need to take care of storing emission estimates to local variables!</b> The gem doesn't cache these for you. Every time you call <tt>emission</tt> it will send another query to the server!
+  # At the same time, they contain all the data you get back from the emission estimate web service. For example, you could say <tt>puts my_donut_factor.emission_estimate.oven_count</tt> (see the tests) and you'd get back the oven count used in the calculation, if any.
   class EmissionEstimate
     def initialize(emitter)
       @emitter = emitter
@@ -37,7 +35,7 @@ module Carbon
     # This is useful for characteristics that are unique to an emitter.
     #
     # For example:
-    #   > my_car.emission.model
+    #   > my_car.emission_estimate.model
     #   => 'Ford Taurus'
     def method_missing(method_id, *args, &blk)
       if !block_given? and args.empty? and response.data.has_key? method_id.to_s
@@ -95,7 +93,7 @@ module Carbon
       response.data['errors']
     end
     # The URL of the methodology report indicating how this estimate was calculated.
-    #   > my_car.emission.methodology
+    #   > my_car.emission_estimate.methodology
     #   => 'http://carbon.brighterplanet.com/automobiles.html?[...]'
     def methodology
       response.data['methodology']

data/spec/lib/carbon_spec.rb

@@ -55,8 +55,8 @@ describe Carbon do
     c.model = 'Acura'
     c.model_year = 2003
     c.fuel_economy = 32
-    c.emission.should == 134.599
-    c.emission.emission_units.should == 'kilograms'
+    c.emission_estimate.should == 134.599
+    c.emission_estimate.emission_units.should == 'kilograms'
   end
   
   describe 'caching' do
@@ -65,10 +65,10 @@ describe Carbon do
       c.model = 'Acura'
       c.model_year = 2003
       c.fuel_economy = 32
-      c.emission.should == 134.599
-      first_raw_request = c.emission.response.raw_request
-      c.emission.should == 134.599
-      c.emission.response.raw_request.object_id.should == first_raw_request.object_id
+      c.emission_estimate.should == 134.599
+      first_raw_request = c.emission_estimate.response.raw_request
+      c.emission_estimate.should == 134.599
+      c.emission_estimate.response.raw_request.object_id.should == first_raw_request.object_id
     end
     
     it "should recalculate if parameters change" do
@@ -76,11 +76,11 @@ describe Carbon do
       c.model = 'Acura'
       c.model_year = 2003
       c.fuel_economy = 32
-      c.emission.should == 134.599
-      first_raw_request = c.emission.response.raw_request
+      c.emission_estimate.should == 134.599
+      first_raw_request = c.emission_estimate.response.raw_request
       c.model = 'Honda'
-      c.emission.should == 134.599
-      c.emission.response.raw_request.object_id.should_not == first_raw_request.object_id
+      c.emission_estimate.should == 134.599
+      c.emission_estimate.response.raw_request.object_id.should_not == first_raw_request.object_id
     end
     
     it "should recalculate if parameters change (though the options hash)" do
@@ -88,19 +88,19 @@ describe Carbon do
       c.model = 'Acura'
       c.model_year = 2003
       c.fuel_economy = 32
-      c.emission.should == 134.599
-      first_raw_request = c.emission.response.raw_request
-      c.emission(:timeframe => Timeframe.new(:year => 2009)).should == 134.599
-      c.emission.response.raw_request.object_id.should_not == first_raw_request.object_id
+      c.emission_estimate.should == 134.599
+      first_raw_request = c.emission_estimate.response.raw_request
+      c.emission_estimate(:timeframe => Timeframe.new(:year => 2009)).should == 134.599
+      c.emission_estimate.response.raw_request.object_id.should_not == first_raw_request.object_id
     end
     
     it "should recalculate if the callback changes" do
       c = RentalCar.new
       c.model = 'Acura'
-      c.emission.should == 134.599
-      first_raw_request = c.emission.response.raw_request
-      c.emission.callback = CALLBACK_URL
-      c.emission.response.raw_request.object_id.should_not == first_raw_request.object_id
+      c.emission_estimate.should == 134.599
+      first_raw_request = c.emission_estimate.response.raw_request
+      c.emission_estimate.callback = CALLBACK_URL
+      c.emission_estimate.response.raw_request.object_id.should_not == first_raw_request.object_id
     end
   end
   
@@ -108,115 +108,115 @@ describe Carbon do
     it 'should send simple params' do
       d = DonutFactory.new
       d.oven_count = 12_000
-      d.emission.request.body.should =~ /oven_count=12000/
+      d.emission_estimate.request.body.should =~ /oven_count=12000/
     end
     
     it 'send complex params' do
       d = DonutFactory.new
       d.mixer.upc = 123
-      d.emission.request.body.should include({:mixer => { :upc => 123 }}.to_query)
+      d.emission_estimate.request.body.should include({:mixer => { :upc => 123 }}.to_query)
     end
   
     it 'should not send attributes that are blank' do
       d = DonutFactory.new
       d.mixer.upc = 123
-      d.emission.request.body.should_not =~ /oven_count/
-      d.emission.request.body.should_not =~ /timeframe/
+      d.emission_estimate.request.body.should_not =~ /oven_count/
+      d.emission_estimate.request.body.should_not =~ /timeframe/
     end
     
     it 'should send attributes that are false' do
       d = DonutFactory.new
       d.mixer.upc = false
-      d.emission.request.body.should include({:mixer => { :upc => 'false' }}.to_query)
+      d.emission_estimate.request.body.should include({:mixer => { :upc => 'false' }}.to_query)
     end
   
     it 'should send the key' do
       d = DonutFactory.new
-      d.emission.request.body.should =~ /key=valid/
+      d.emission_estimate.request.body.should =~ /key=valid/
     end
     
     it 'should override defaults' do
       d = DonutFactory.new
       key = 'ADifferentOne'
-      d.emission.key.should == 'valid'
-      d.emission.key = key
-      d.emission.key.should == key
+      d.emission_estimate.key.should == 'valid'
+      d.emission_estimate.key = key
+      d.emission_estimate.key.should == key
     end
   
     it 'should accept timeframes' do
       c = RentalCar.new
       t = Timeframe.new(:year => 2009)
-      c.emission.timeframe = t
-      c.emission.request.body.should include(t.to_query(:timeframe))
+      c.emission_estimate.timeframe = t
+      c.emission_estimate.request.body.should include(t.to_query(:timeframe))
     end
     
     it 'should accept timeframes inline' do
       c = RentalCar.new
       t = Timeframe.new(:year => 2009)
-      c.emission(:timeframe => t)
-      c.emission.request.body.should include(t.to_query(:timeframe))
+      c.emission_estimate(:timeframe => t)
+      c.emission_estimate.request.body.should include(t.to_query(:timeframe))
     end
     
     it 'should read active subtimeframes back from calculations' do
       c = RentalCar.new
-      c.emission.active_subtimeframe.should == Timeframe.new(:year => 2008)
+      c.emission_estimate.active_subtimeframe.should == Timeframe.new(:year => 2008)
     end
   
     it 'should not generate post bodies with lots of empty params' do
       c = RentalCar.new
-      c.emission :timeframe => Timeframe.new(:year => 2009)
-      c.emission.request.body.should_not include('&&')
-      c.emission.request.body.should_not =~ /=[^a-z0-9]/i
+      c.emission_estimate :timeframe => Timeframe.new(:year => 2009)
+      c.emission_estimate.request.body.should_not include('&&')
+      c.emission_estimate.request.body.should_not =~ /=[^a-z0-9]/i
     end
   end
   
   describe 'asynchronous (queued) requests' do
     it 'should post a message to SQS' do
       c = RentalCar.new
-      c.emission.callback = CALLBACK_URL
-      c.emission.request.url.should =~ /queue.amazonaws.com/
+      c.emission_estimate.callback = CALLBACK_URL
+      c.emission_estimate.request.url.should =~ /queue.amazonaws.com/
     end
     
     it 'should have nil data in its response' do
       c = RentalCar.new
-      c.emission.callback = CALLBACK_URL
-      c.emission.emission_value.should be_nil
-      c.emission.emission_units.should be_nil
-      c.emission.methodology.should be_nil
+      c.emission_estimate.callback = CALLBACK_URL
+      c.emission_estimate.emission_value.should be_nil
+      c.emission_estimate.emission_units.should be_nil
+      c.emission_estimate.methodology.should be_nil
     end
     
     it "should not compare itself to numbers" do
       c = RentalCar.new
-      c.emission.callback = CALLBACK_URL
-      c.emission.should_not == 0.0
+      c.emission_estimate.callback = CALLBACK_URL
+      c.emission_estimate.should_not == 0.0
     end
     
     it 'should not allow itself to be treated as a number' do
       c = RentalCar.new
-      c.emission.callback = CALLBACK_URL
+      c.emission_estimate.callback = CALLBACK_URL
       lambda {
-        c.emission + 5
+        c.emission_estimate + 5
       }.should raise_error(::Carbon::TriedToUseAsyncResponseAsNumber)
       lambda {
-        c.emission.to_f
+        c.emission_estimate.to_f
       }.should raise_error(::Carbon::TriedToUseAsyncResponseAsNumber)
     end
   end
   
   describe 'internally' do
-    it "should ignore invalid options passed to #emission" do
+    it "should ignore invalid options passed to #emission_estimate" do
       c = RentalCar.new
       t = Timeframe.new(:year => 2009)
-      c.emission :timeframe => t, :method_missing => 'helo there', :response => 'foo'
-      c.emission.instance_variable_get(:@timeframe).object_id.should == t.object_id
-      c.emission.instance_variable_get(:@method_missing).should be_nil
-      c.emission.instance_variable_get(:@response).should be_nil
+      c.emission_estimate :timeframe => t, :method_missing => 'helo there', :response => 'foo'
+      c.emission_estimate.instance_variable_get(:@timeframe).object_id.should == t.object_id
+      c.emission_estimate.instance_variable_get(:@method_missing).should be_nil
+      c.emission_estimate.instance_variable_get(:@response).should be_nil
     end
     
     it "should raise an error on EmissionEstimate if method isn't found" do
       c = RentalCar.new
       lambda {
-        c.emission.foobar
+        c.emission_estimate.foobar
       }.should raise_error(NoMethodError, /EmissionEstimate/)
     end
     
@@ -226,7 +226,7 @@ describe Carbon do
         d.mixer.to_param
       }.should raise_error(RuntimeError, /instead please/)
       lambda {
-        d.emission.to_f
+        d.emission_estimate.to_f
       }.should_not raise_error
     end
   end
@@ -236,7 +236,7 @@ end
 # it 'should actually do a request!' do
 #   FakeWeb.clean_registry
 #   c = RentalCar.new
-#   c.emission.to_i.should be_close(5500, 500)
-#   c.emission.emission_units.should == 'kilograms'
+#   c.emission_estimate.to_i.should be_close(5500, 500)
+#   c.emission_estimate.emission_units.should == 'kilograms'
 # end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: carbon
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Derek Kastner
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-21 00:00:00 -05:00
+date: 2010-07-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency