carbon 3.0.0 → 3.0.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+gemfile: 'Gemfile.ci'

data/CHANGELOG

@@ -1,3 +1,11 @@
+3.0.1 / 2012-06-20
+
+* Enhancements
+
+  * Provide "quick decisions" shortcuts
+    - result.decisions.carbon.object.value -> result.carbon
+    - result.decisions.energy.object.value -> result.energy
+
 3.0.0 / 2012-06-08
 
 * Breaking changes

data/Gemfile.ci

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'json'

data/carbon.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'multi_json'
 
   s.add_development_dependency 'aruba'
-  s.add_development_dependency 'avro'
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'fakeweb'
   s.add_development_dependency 'rake'

data/lib/carbon/query.rb

@@ -25,7 +25,7 @@ module Carbon
         end
         ticks = 0
         begin
-          sleep(0.1*(2**ticks)) # exponential wait
+          Kernel.sleep(0.1*(2**ticks)) # exponential wait
           ticks += 1
         end until queries.all? { |query| query.done? }
         queries.inject({}) do |memo, query|
@@ -71,6 +71,8 @@ module Carbon
       end
     end
 
+    QUICK_DECISIONS = [:carbon, :energy]
+
     attr_reader :emitter
     attr_reader :params
     attr_reader :domain
@@ -130,6 +132,11 @@ module Carbon
       when (200..299)
         memo.success = true
         memo.merge! MultiJson.load(body)
+        QUICK_DECISIONS.each do |decision|
+          if node = memo.decisions[decision]
+            memo[decision] = node.object.value
+          end
+        end
       else
         memo.success = false
         memo.errors = [body]

data/lib/carbon/version.rb

@@ -1,3 +1,3 @@
 module Carbon
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/spec/carbon_spec.rb

@@ -20,6 +20,18 @@ describe Carbon do
           result.decisions.carbon.object.value.should be_within(50).of(200)
         end
       end
+      it "provides #carbon helper method to return carbon emission in kg" do
+        VCR.use_cassette 'Flight', :record => :once do
+          result = Carbon.query('Flight')
+          result.carbon.should == result.decisions.carbon.object.value
+        end
+      end
+      it "provides #energy helper method to return energy usage in MJ" do
+        VCR.use_cassette 'Flight', :record => :once do
+          result = Carbon.query('Flight')
+          result.energy.should == result.decisions.energy.object.value
+        end
+      end
       it "can be used on an object that responds to #as_impact_query" do
         VCR.use_cassette '2006 Altima', :record => :once do
           Carbon.query(MyNissanAltima.new(2006)).decisions.should == MyNissanAltima.new(2006).impact.decisions
@@ -60,9 +72,9 @@ describe Carbon do
         end
       end
       it "allows choosing domain" do
-        VCR.use_cassette 'carbon.bp.com flight', :record => :once do
-          result = Carbon.query('Flight', :domain => 'http://carbon.brighterplanet.com')
-          result.carbon.value.should > 0
+        VCR.use_cassette 'staging flight', :record => :once do
+          Carbon.query('Flight', :domain => 'http://impact-staging.brighterplanet.com')
+          # todo how to distinguish?
         end
       end
       it "raises ArgumentError if args are bad" do

data/spec/cassettes/staging_flight.yml

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://impact-staging.brighterplanet.com/flights.json
+    body:
+      encoding: US-ASCII
+      string: key=carbon_test
+    headers:
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      content-type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Wed, 20 Jun 2012 18:47:53 GMT
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      status:
+      - 200 OK
+    body:
+      encoding: US-ASCII
+      string: ! '{"compliance":[],"decisions":{"carbon":{"description":"1083.7 kg","object":{"value":1083.698273768567,"units":"kilograms"},"methodology":"from
+        fuel use and greenhouse gas emission factor"},"ghg_emission_factor":{"description":"5.15214","object":5.15214,"methodology":"from
+        fuel and aviation multiplier"},"aviation_multiplier":{"description":"2.0","object":2.0,"methodology":"default"},"energy":{"description":"7914.4
+        MJ","object":{"value":7914.379236124745,"units":"megajoules"},"methodology":"from
+        fuel use and fuel"},"fuel_use":{"description":"210.3394460881434","object":210.3394460881434,"methodology":"from
+        fuel per segment, segments per trip, trips, freight_share, passengers, seat
+        class multiplier, fuel, date, and timeframe"},"fuel_per_segment":{"description":"8445.966049630008","object":8445.966049630008,"methodology":"from
+        adjusted distance per segment and fuel use coefficients"},"seat_class_multiplier":{"description":"1.0","object":1.0,"methodology":"default"},"distance_class":{"description":"short
+        haul","object":{"flight_distance_class":{"distance":1108.0,"distance_units":"kilometres","max_distance":3700.0,"max_distance_units":"kilometres","min_distance":0.0,"min_distance_units":"kilometres","name":"short
+        haul"}},"methodology":"from adjusted distance per segment"},"adjusted_distance_per_segment":{"description":"960.3994767189461","object":960.3994767189461,"methodology":"from
+        adjusted distance and segments per trip"},"adjusted_distance":{"description":"1613.4711208878293","object":1613.4711208878293,"methodology":"from
+        distance, route inefficiency factor, and dogleg factor"},"distance":{"description":"1260.2876865370242","object":1260.2876865370242,"methodology":"default"},"route_inefficiency_factor":{"description":"1.100000023841858","object":1.100000023841858,"methodology":"default"},"dogleg_factor":{"description":"1.1638548181950328","object":1.1638548181950328,"methodology":"from
+        segments per trip"},"fuel_use_coefficients":{"description":"BrighterPlanet::Flight::ImpactModel::FuelUseEquation::Given","object":{"m3":1.0556339103368821e-07,"m2":-0.00015742440317753937,"m1":7.133528077660993,"b":1646.6201427598814},"methodology":"default"},"fuel":{"description":"Jet
+        Fuel","object":{"fuel":{"biogenic_fraction":0.0,"carbon_content":18.672,"carbon_content_units":"grams_per_megajoule","co2_biogenic_emission_factor":0.0,"co2_biogenic_emission_factor_units":"kilograms_per_litre","co2_emission_factor":2.57607,"co2_emission_factor_units":"kilograms_per_litre","density":0.8156,"density_units":"kilograms_per_litre","energy_content":37.6267,"energy_content_units":"megajoules_per_litre","name":"Jet
+        Fuel","oxidation_factor":1.0,"physical_units":null}},"methodology":"default"},"passengers":{"description":"131","object":131,"methodology":"from
+        seats and load factor"},"seats":{"description":"168.86581244109524","object":168.86581244109524,"methodology":"default"},"load_factor":{"description":"0.7737229384911943","object":0.7737229384911943,"methodology":"default"},"freight_share":{"description":"0.06833087336503851","object":0.06833087336503851,"methodology":"default"},"trips":{"description":"1.7","object":1.7,"methodology":"default"},"segments_per_trip":{"description":"1.68","object":1.68,"methodology":"default"},"date":{"description":"2012-01-01","object":"2012-01-01","methodology":"from
+        timeframe"}},"emitter":"Flight","equivalents":{"cars_off_the_road_for_a_year":0.19723308582587923,"cars_off_the_road_for_a_month":2.3646296333630135,"cars_off_the_road_for_a_week":10.246367178481801,"cars_off_the_road_for_a_day":71.92071963692472,"cars_to_priuses_for_a_year":0.39446617165175846,"cars_to_priuses_for_a_month":4.729259266726027,"cars_to_priuses_for_a_week":20.492734356963602,"cars_to_priuses_for_a_day":143.84143927384943,"one_way_domestic_flight":3.522019389747843,"round_trip_domestic_flight":1.7610096948739216,"one_way_cross_country_flight":1.2375834286437037,"round_trip_cross_country_flight":0.6187917143218519,"vegan_meals_instead_of_non_vegan_ones":872.037912824007,"days_of_veganism":290.679304274669,"weeks_of_veganism":41.52515045426395,"months_of_veganism":9.689346265764758,"years_of_veganism":0.7965182312198968,"barrels_of_petroleum":2.520682184785687,"canisters_of_bbq_propane":45.154455973114885,"railroad_cars_full_of_coal":0.005418491368842836,"homes_energy_in_a_year":0.10511873255555101,"homes_energy_in_a_month":1.2560062992977694,"homes_energy_in_a_week":5.441249032591975,"homes_energy_in_a_day":38.19711305552069,"homes_electricity_in_a_year":0.15930364624397936,"homes_electricity_in_a_month":1.9062252635589094,"homes_electricity_in_a_week":8.259948242664018,"homes_electricity_in_a_day":57.97677394834457,"homes_with_lowered_thermostat_2_degrees_for_a_winter":5.688332239011209,"homes_with_raised_thermostat_3_degrees_for_a_summer":2.5575279260938184,"replaced_refrigerators":1.0912841616849471,"loads_of_cold_laundry":496.9428478158617,"lightbulbs_for_a_year":2.000507013376775,"lightbulbs_for_a_month":24.34528172021086,"lightbulbs_for_a_week":104.33630240189011,"lightbulbs_for_a_day":730.3573679080521,"lightbulbs_for_an_evening":4382.145291146586,"lightbulbs_to_CFLs_for_a_day":12431.618738777546,"lightbulbs_to_CFLs_for_a_week":1775.945224483,"lightbulbs_to_CFLs_for_a_month":414.38779701844595,"lightbulbs_to_CFLs_for_a_year":34.05955304627229,"days_with_lightbulbs_to_CFLs":276.2585313456307,"weeks_with_lightbulbs_to_CFLs":39.46504003582991,"months_with_lightbulbs_to_CFLs":9.208184232211513,"years_with_lightbulbs_to_CFLs":0.7564213950904599,"recycled_kgs_of_trash":747.3779329958612,"recycled_bags_of_trash":414.1190398465514},"methodology":"http://impact.brighterplanet.com/flights?timeframe=2012-01-01%2F2013-01-01","scope":"The
+        flight greenhouse gas emission is the anthropogenic greenhouse gas emissions
+        attributed to a single passenger on this flight. It includes CO2 emissions
+        from combustion of non-biogenic fuel and extra forcing effects of high-altitude
+        fuel combustion.","timeframe":"2012-01-01/2013-01-01","characteristics":{},"errors":["API
+        key \"carbon_test\" could not be verified. Please register at http://keys.brighterplanet.com"]}'
+    http_version: '1.1'
+  recorded_at: Wed, 20 Jun 2012 18:47:53 GMT
+recorded_with: VCR 2.2.2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carbon
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-08 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -155,22 +155,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: avro
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -294,9 +278,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - .yardopts
 - CHANGELOG
 - Gemfile
+- Gemfile.ci
 - README.markdown
 - Rakefile
 - bin/carbon
@@ -322,9 +308,9 @@ files:
 - spec/cassettes/Flight_and_Automobile.yml
 - spec/cassettes/LAX-_SFO_flight.yml
 - spec/cassettes/Monkey.yml
-- spec/cassettes/carbon_bp_com_flight.yml
 - spec/cassettes/flight_with_key_1.yml
 - spec/cassettes/flight_with_key_2.yml
+- spec/cassettes/staging_flight.yml
 - spec/cassettes/timeframed_flight.yml
 - spec/helper.rb
 - spec/support/my_nissan_altima.rb
@@ -364,9 +350,9 @@ test_files:
 - spec/cassettes/Flight_and_Automobile.yml
 - spec/cassettes/LAX-_SFO_flight.yml
 - spec/cassettes/Monkey.yml
-- spec/cassettes/carbon_bp_com_flight.yml
 - spec/cassettes/flight_with_key_1.yml
 - spec/cassettes/flight_with_key_2.yml
+- spec/cassettes/staging_flight.yml
 - spec/cassettes/timeframed_flight.yml
 - spec/helper.rb
 - spec/support/my_nissan_altima.rb

data/spec/cassettes/carbon_bp_com_flight.yml

@@ -1,58 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: http://carbon.brighterplanet.com/flights.json
-    body:
-      encoding: US-ASCII
-      string: key=carbon_test
-    headers:
-      accept:
-      - ! '*/*'
-      user-agent:
-      - Ruby
-      content-type:
-      - application/x-www-form-urlencoded
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      server:
-      - nginx
-      date:
-      - Fri, 08 Jun 2012 21:05:43 GMT
-      content-type:
-      - application/json
-      transfer-encoding:
-      - chunked
-      connection:
-      - keep-alive
-      status:
-      - 200 OK
-    body:
-      encoding: US-ASCII
-      string: ! '{"emission":1087.1649532388976,"emitter":"Flight","timeframe":"2012-01-01/2013-01-01","methodology":"http://impact.brighterplanet.com/flights?timeframe=2012-01-01%2F2013-01-01","scope":"The
-        flight greenhouse gas emission is the anthropogenic greenhouse gas emissions
-        attributed to a single passenger on this flight. It includes CO2 emissions
-        from combustion of non-biogenic fuel and extra forcing effects of high-altitude
-        fuel combustion.","complies":[],"equivalents":{"cars_off_the_road_for_a_year":0.19786402148947937,"cars_off_the_road_for_a_month":2.3721939279672744,"cars_off_the_road_for_a_week":10.279144632873777,"cars_off_the_road_for_a_day":72.15078928665267,"cars_to_priuses_for_a_year":0.39572804297895875,"cars_to_priuses_for_a_month":4.744387855934549,"cars_to_priuses_for_a_week":20.558289265747554,"cars_to_priuses_for_a_day":144.30157857330533,"one_way_domestic_flight":3.533286098026417,"round_trip_domestic_flight":1.7666430490132086,"one_way_cross_country_flight":1.2415423765988212,"round_trip_cross_country_flight":0.6207711882994106,"vegan_meals_instead_of_non_vegan_ones":874.8275047269489,"days_of_veganism":291.6091682423163,"weeks_of_veganism":41.657986678208076,"months_of_veganism":9.720341846908983,"years_of_veganism":0.7990662406305897,"barrels_of_petroleum":2.528745681233676,"canisters_of_bbq_propane":45.29890210660515,"railroad_cars_full_of_coal":0.005435824766194489,"homes_energy_in_a_year":0.10545500046417307,"homes_energy_in_a_month":1.2600241808038823,"homes_energy_in_a_week":5.458655230212505,"homes_energy_in_a_day":38.319303106811425,"homes_electricity_in_a_year":0.15981324812611794,"homes_electricity_in_a_month":1.9123231527472209,"homes_electricity_in_a_week":8.286371273586878,"homes_electricity_in_a_day":58.16223783332778,"homes_with_lowered_thermostat_2_degrees_for_a_winter":5.706528839550974,"homes_with_raised_thermostat_3_degrees_for_a_summer":2.5657092896437987,"replaced_refrigerators":1.09477510791157,"loads_of_cold_laundry":498.5325352871354,"lightbulbs_for_a_year":2.006906503679005,"lightbulbs_for_a_month":24.423160674511834,"lightbulbs_for_a_week":104.67006736793459,"lightbulbs_for_a_day":732.6937330704019,"lightbulbs_for_an_evening":4396.1634855873635,"lightbulbs_to_CFLs_for_a_day":12471.386669121135,"lightbulbs_to_CFLs_for_a_week":1781.626356398747,"lightbulbs_to_CFLs_for_a_month":415.7133963143494,"lightbulbs_to_CFLs_for_a_year":34.16850731534531,"days_with_lightbulbs_to_CFLs":277.14226420956624,"weeks_with_lightbulbs_to_CFLs":39.59128610210093,"months_with_lightbulbs_to_CFLs":9.237640607670912,"years_with_lightbulbs_to_CFLs":0.7588411373607507,"recycled_kgs_of_trash":749.7687458259719,"recycled_bags_of_trash":415.44377940594615},"emission_units":"kilograms","execution_id":"UNSUPPORTED","errors":["API
-        key \"carbon_test\" could not be verified. Please register at http://keys.brighterplanet.com"],"reports":[{"committee":{"name":"emission"},"conclusion":{"value":1087.1649532388976,"units":"kilograms"},"quorum":{"name":"from
-        fuel use and greenhouse gas emission factor"}},{"committee":{"name":"ghg_emission_factor"},"conclusion":5.15214,"quorum":{"name":"from
-        fuel and aviation multiplier"}},{"committee":{"name":"aviation_multiplier"},"conclusion":2.0,"quorum":{"name":"default"}},{"committee":{"name":"energy"},"conclusion":{"value":7939.69681453416,"units":"megajoules"},"quorum":{"name":"from
-        fuel use and fuel"}},{"committee":{"name":"fuel_use"},"conclusion":211.0123081358227,"quorum":{"name":"from
-        fuel per segment, segments per trip, trips, freight_share, passengers, seat
-        class multiplier, fuel, date, and timeframe"}},{"committee":{"name":"fuel_per_segment"},"conclusion":8477.788829453548,"quorum":{"name":"from
-        adjusted distance per segment and fuel use coefficients"}},{"committee":{"name":"seat_class_multiplier"},"conclusion":1.0,"quorum":{"name":"default"}},{"committee":{"name":"distance_class"},"conclusion":{"flight_distance_class":{"distance":1108.0,"distance_units":"kilometres","max_distance":3700.0,"max_distance_units":"kilometres","min_distance":0.0,"min_distance_units":"kilometres","name":"short
-        haul"}},"quorum":{"name":"from adjusted distance per segment"}},{"committee":{"name":"adjusted_distance_per_segment"},"conclusion":962.1615428278766,"quorum":{"name":"from
-        adjusted distance and segments per trip"}},{"committee":{"name":"adjusted_distance"},"conclusion":1616.4313919508327,"quorum":{"name":"from
-        distance, route inefficiency factor, and dogleg factor"}},{"committee":{"name":"distance"},"conclusion":1262.599964160848,"quorum":{"name":"default"}},{"committee":{"name":"route_inefficiency_factor"},"conclusion":1.100000023841858,"quorum":{"name":"default"}},{"committee":{"name":"dogleg_factor"},"conclusion":1.1638548181950328,"quorum":{"name":"from
-        segments per trip"}},{"committee":{"name":"fuel_use_coefficients"},"conclusion":{"m3":1.0532072472371498e-07,"m2":-0.00015627733290887285,"m1":7.148223019744806,"b":1650.9061605236384},"quorum":{"name":"default"}},{"committee":{"name":"fuel"},"conclusion":{"fuel":{"biogenic_fraction":0.0,"carbon_content":18.672,"carbon_content_units":"grams_per_megajoule","co2_biogenic_emission_factor":0.0,"co2_biogenic_emission_factor_units":"kilograms_per_litre","co2_emission_factor":2.57607,"co2_emission_factor_units":"kilograms_per_litre","density":0.8156,"density_units":"kilograms_per_litre","energy_content":37.6267,"energy_content_units":"megajoules_per_litre","name":"Jet
-        Fuel","oxidation_factor":1.0,"physical_units":null}},"quorum":{"name":"default"}},{"committee":{"name":"passengers"},"conclusion":131,"quorum":{"name":"from
-        seats and load factor"}},{"committee":{"name":"seats"},"conclusion":169.27798641328772,"quorum":{"name":"default"}},{"committee":{"name":"load_factor"},"conclusion":0.7731146349652108,"quorum":{"name":"default"}},{"committee":{"name":"freight_share"},"conclusion":0.06885888622195808,"quorum":{"name":"default"}},{"committee":{"name":"trips"},"conclusion":1.7,"quorum":{"name":"default"}},{"committee":{"name":"segments_per_trip"},"conclusion":1.68,"quorum":{"name":"default"}},{"committee":{"name":"date"},"conclusion":"2012-01-01","quorum":{"name":"from
-        timeframe"}}],"carbon":{"value":1087.1649532388976,"units":"kilograms"},"ghg_emission_factor":5.15214,"aviation_multiplier":2.0,"energy":{"value":7939.69681453416,"units":"megajoules"},"fuel_use":211.0123081358227,"fuel_per_segment":8477.788829453548,"seat_class_multiplier":1.0,"distance_class":{"flight_distance_class":{"distance":1108.0,"distance_units":"kilometres","max_distance":3700.0,"max_distance_units":"kilometres","min_distance":0.0,"min_distance_units":"kilometres","name":"short
-        haul"}},"adjusted_distance_per_segment":962.1615428278766,"adjusted_distance":1616.4313919508327,"distance":1262.599964160848,"route_inefficiency_factor":1.100000023841858,"dogleg_factor":1.1638548181950328,"fuel_use_coefficients":{"m3":1.0532072472371498e-07,"m2":-0.00015627733290887285,"m1":7.148223019744806,"b":1650.9061605236384},"fuel":{"fuel":{"biogenic_fraction":0.0,"carbon_content":18.672,"carbon_content_units":"grams_per_megajoule","co2_biogenic_emission_factor":0.0,"co2_biogenic_emission_factor_units":"kilograms_per_litre","co2_emission_factor":2.57607,"co2_emission_factor_units":"kilograms_per_litre","density":0.8156,"density_units":"kilograms_per_litre","energy_content":37.6267,"energy_content_units":"megajoules_per_litre","name":"Jet
-        Fuel","oxidation_factor":1.0,"physical_units":null}},"passengers":131,"seats":169.27798641328772,"load_factor":0.7731146349652108,"freight_share":0.06885888622195808,"trips":1.7,"segments_per_trip":1.68,"date":"2012-01-01"}'
-    http_version: '1.1'
-  recorded_at: Fri, 08 Jun 2012 21:05:43 GMT
-recorded_with: VCR 2.2.0