brighter_planet_metadata 0.2.0 → 0.2.1

data/Rakefile

@@ -10,3 +10,21 @@ Rake::TestTask.new(:test) do |test|
 end
 
 task :default => :test
+
+task :fallbacks do
+  require_relative 'lib/brighter_planet_metadata'
+  fallbacks = BrighterPlanet::Metadata::LIVE_URL.inject({}) do |memo, (k, _)|
+    if BrighterPlanet.metadata.respond_to?(k)
+      memo[k] = BrighterPlanet.metadata.send k
+    else
+      parts = k.split('_') # rail_trips_options => rail, trips, options
+      method_id = parts.pop
+      arg = parts.join('_')
+      memo[k] = BrighterPlanet.metadata.send method_id, arg
+    end
+    memo
+  end
+  File.open(File.expand_path('../lib/brighter_planet_metadata/fallbacks.json', __FILE__), 'w') do |f|
+    f.write MultiJson.encode(fallbacks)
+  end
+end

data/lib/brighter_planet_metadata/fallbacks.json

@@ -0,0 +1 @@
+{"datasets":["AutomobileIndustry","FlightIndustry"],"emitters":["Automobile","AutomobileTrip","BusTrip","Computation","Diet","ElectricityUse","Flight","FuelPurchase","Lodging","Meeting","Motorcycle","Pet","Purchase","RailTrip","Residence","Shipment"],"certified_emitters":["AutomobileTrip","BusTrip","Flight","Lodging","Meeting","RailTrip"],"resources":["AirConditionerUse","Aircraft","Airline","Airport","AutomobileFuel","AutomobileMake","AutomobileMakeModel","AutomobileMakeModelYear","AutomobileMakeModelYearVariant","AutomobileMakeYear","AutomobileMakeYearFleet","AutomobileModel","AutomobileSizeClass","AutomobileSizeClassYear","AutomobileTypeFuelControl","AutomobileTypeFuelYear","AutomobileTypeFuelYearAge","AutomobileTypeFuelYearControl","AutomobileTypeYear","AutomobileYear","Breed","BreedGender","BtsAircraft","BusClass","BusFuel","BusFuelControl","BusFuelYearControl","Carrier","CarrierMode","CbecsEnergyIntensity","CensusDivision","CensusRegion","ClimateDivision","ClothesMachineUse","CommercialBuildingEnergyConsumptionSurveyResponse","ComputationCarrier","ComputationCarrierInstanceClass","ComputationCarrierRegion","Country","CountryLodgingClass","CountryRailClass","CountryRailTraction","CountryRailTractionClass","DietClass","DishwasherUse","EgridCountry","EgridRegion","EgridSubregion","FlightDistanceClass","FlightDistanceClassSeatClass","FlightSeatClass","FlightSegment","FoodGroup","Fuel","FuelPrice","FuelType","FuelYear","Gender","GreenhouseGas","Industry","LodgingClass","MecsEnergy","MecsRatio","Naics2002","Naics2002Naics2007Concordance","Naics2002Sic1987Concordance","Naics2007","NationalTransitDatabaseCompany","NationalTransitDatabaseMode","NationalTransitDatabaseRecord","PetroleumAdministrationForDefenseDistrict","RailClass","RailCompany","RailFuel","RailTraction","ResidenceAppliance","ResidenceClass","ResidenceFuelPrice","ResidenceFuelType","ResidentialEnergyConsumptionSurveyResponse","ShipmentMode","Sic1987","Species","State","Urbanity","ZipCode"],"protocols":{"ghg_protocol_scope_3":"Greenhouse Gas Protocol Scope 3","iso":"ISO 14064-1","tcr":"The Climate Registry","ghg_protocol_scope_1":"Greenhouse Gas Protocol Scope 1"},"automobiles_options":["make","model","year","size_class","automobile_fuel","country","acquisition","retirement","hybridity","urbanity","speed","daily_duration","daily_distance","weekly_distance","annual_distance","fuel_efficiency","fuel_use"],"automobile_trips_options":["make","model","year","size_class","automobile_fuel","country","date","hybridity","urbanity","speed","duration","origin","destination","distance","fuel_efficiency","fuel_use"],"bus_trips_options":["bus_class","date","duration","distance"],"computations_options":["carrier","carrier_region","carrier_instance_class","zip_code","date","duration","electricity_intensity","power_usage_effectiveness"],"diets_options":["diet_class","red_meat_share","poultry_share","fish_share","eggs_share","nuts_share","dairy_share","cereals_and_grains_share","fruit_share","vegetables_share","oils_and_sugars_share","size","proximity","conventionality","start_date","end_date","intensity"],"electricity_uses_options":["zip_code","state","country","date","energy"],"flights_options":["origin_airport","destination_airport","aircraft","airline","fuel","distance_class","seat_class","date","segments_per_trip","trips","load_factor","seats","distance_estimate"],"fuel_purchases_options":["fuel_type","zip_code","state","petroleum_administration_for_defense_district","volume","cost","price","date"],"lodgings_options":["zip_code","state","country","lodging_class","property","date","rooms","duration","city","heating_degree_days","cooling_degree_days","property_rooms","floors","construction_year","ac_coverage","refrigerator_coverage","hot_tubs","outdoor_pools","indoor_pools"],"meetings_options":["zip_code","state","date","area","duration"],"motorcycles_options":["fuel_efficiency","annual_distance_estimate","weekly_distance_estimate","acquisition","retirement"],"pets_options":["species","breed","gender","weight","acquisition","retirement"],"purchases_options":["merchant","merchant_category","sic_industry","industry","cost","purchase_amount","tax","date"],"rail_trips_options":["country","rail_company","rail_class","rail_traction","date","origin","destination","distance","duration"],"residences_options":["residence_class","urbanity","dishwasher_use","air_conditioner_use","clothes_machine_use","zip_code","ownership","residents","refrigerator_count","freezer_count","lighting_efficiency","floorspace_estimate","floors","bathrooms","bedrooms","full_bathrooms","half_bathrooms","acquisition","retirement","construction_year","occupation","annual_fuel_oil_volume_estimate","annual_fuel_oil_cost","monthly_natural_gas_volume_estimate","monthly_natural_gas_cost","monthly_electricity_use_estimate","monthly_electricity_cost","green_electricity","annual_propane_volume_estimate","annual_propane_cost","annual_wood_volume_estimate","annual_kerosene_volume_estimate","annual_coal_volume_estimate"],"shipments_options":["carrier","mode","weight","package_count","segment_count","origin","destination","origin_zip_code","destination_zip_code","distance"],"automobiles_committees":["carbon","co2_emission","co2_biogenic_emission","ch4_emission","n2o_emission","hfc_emission","energy","fuel_use","distance","annual_distance","automobile_fuel","speed","fuel_efficiency","hybridity_multiplier","urbanity","safe_country","active_subtimeframe","acquisition","retirement","make_model_year","make_year","make_model"],"automobile_trips_committees":["carbon","co2_emission","co2_biogenic_emission","ch4_emission","n2o_emission","hfc_emission","energy","automobile_fuel","fuel_use","distance","destination_location","origin_location","speed","fuel_efficiency","hybridity_multiplier","urbanity","safe_country","make_model_year","make_year","make_model","date"],"bus_trips_committees":["carbon","co2_emission","co2_biogenic_emission","ch4_emission","n2o_emission","hfc_emission","fuel_uses","distance_per_passenger","distance","speed","passengers","bus_class","date"],"computations_committees":["carbon","co2_emission","co2_biogenic_emission","ch4_emission","n2o_emission","co2_emission_factor","co2_biogenic_emission_factor","ch4_emission_factor","n2o_emission_factor","electricity_use","electricity_loss_factor","egrid_region","egrid_subregion","power_usage_effectiveness","electricity_intensity","carrier_instance_class","carrier","duration","date"],"diets_committees":["carbon","intensity","size","diet_class","active_subtimeframe","start_date","end_date"],"electricity_uses_committees":["carbon","emission_factor","loss_factor","energy","country","egrid_subregion","state","date"],"flights_committees":["carbon","ghg_emission_factor","aviation_multiplier","energy","fuel_use","fuel_per_segment","seat_class_multiplier","distance_class_seat_class","distance_class","adjusted_distance_per_segment","adjusted_distance","distance","route_inefficiency_factor","dogleg_factor","fuel_use_coefficients","fuel","passengers","seats","load_factor","freight_share","trips","country","cohort","segments_per_trip","date"],"fuel_purchases_committees":["carbon","emission_factor","volume","price","petroleum_administration_for_defense_district","state"],"lodgings_committees":["carbon","electricity_emission_factor","natural_gas_use","fuel_oil_use","electricity_use","district_heat_use","adjusted_fuel_intensities","outdoor_pool_adjustment","indoor_pool_adjustment","hot_tub_adjustment","refrigerator_adjustment","fuel_intensities","occupancy_rate","outdoor_pools","indoor_pools","hot_tubs","refrigerator_coverage","ac_coverage","construction_year","floors","property_rooms","heating_degree_days","cooling_degree_days","egrid_subregion","country","state","city","climate_division","room_nights","duration","rooms","date"],"meetings_committees":["carbon","emission_factor","natural_gas_intensity","fuel_oil_intensity","electricity_intensity","district_heat_intensity","egrid_subregion","census_division","state","area","duration","date"],"motorcycles_committees":["carbon","fuel_consumed","emission_factor","distance","fuel_efficiency","fuel","annual_distance","active_subtimeframe","acquisition","retirement"],"pets_committees":["carbon","diet_emission_intensity","diet_size","marginal_dietary_requirement","fixed_dietary_requirement","weight","active_subtimeframe","acquisition","retirement"],"purchases_committees":["carbon","impacts","direct_emissions","impact_vectors","economic_flows","sector_direct_requirements","sector_shares","industry_sector_shares","industry_sector_ratios","industry_ratios","industry_product_ratios","product_line_industry_product_ratios","product_line_ratios","non_trade_industry_ratios","trade_industry_ratios","merchant_category_industries","merchant_category","adjusted_cost","cost","date"],"rail_trips_committees":["carbon","co2_emission_factor","diesel_consumption","electricity_consumption","diesel_intensity","electricity_intensity","distance","speed","rail_company_traction_class","rail_company_traction","country_rail_traction_class","country_rail_class","country_rail_traction","country","destination_location","origin_location","date"],"residences_committees":["carbon","fuel_oil_consumed","natural_gas_consumed","propane_consumed","biomass_consumed","kerosene_consumed","coal_consumed","dirty_electricity_generated","green_electricity","electricity_generated","electricity_used","missing_annual_energy","electricity_loss_rate","electricity_emission_factor","egrid_region","egrid_subregion","occupation","residents","air_conditioner_use","predicted_fuel_shares","predicted_annual_energy_consumption","reported_annual_fuel_oil_consumption","predicted_annual_fuel_oil_consumption","reported_annual_natural_gas_consumption","predicted_annual_natural_gas_consumption","reported_annual_propane_consumption","predicted_annual_propane_consumption","reported_annual_kerosene_consumption","predicted_annual_kerosene_consumption","reported_annual_biomass_consumption","predicted_annual_biomass_consumption","reported_annual_coal_consumption","predicted_annual_coal_consumption","reported_annual_electricity_use","predicted_annual_electricity_use","active_subtimeframe","acquisition","retirement","floorspace_estimate","cohort","bathrooms","census_region","census_division","state","floorspace","heating_degree_days","cooling_degree_days","climate_division"],"shipments_committees":["carbon","corporate_emission","transport_emission","corporate_emission_factor","transport_emission_factor","adjusted_distance","dogleg_factor","route_inefficiency_factor","distance","carrier_mode","segment_count","destination_location","destination","origin_location","origin","package_count","weight"]}

data/lib/brighter_planet_metadata/metadata.rb

@@ -43,16 +43,31 @@ module BrighterPlanet
       'rail_trips_options'       => 'http://impact.brighterplanet.com/rail_trips/options.json',
       'residences_options'       => 'http://impact.brighterplanet.com/residences/options.json',
       'shipments_options'        => 'http://impact.brighterplanet.com/shipments/options.json',
+
+      'automobiles_committees'      => 'http://impact.brighterplanet.com/automobiles/committees.json',
+      'automobile_trips_committees' => 'http://impact.brighterplanet.com/automobile_trips/committees.json',
+      'bus_trips_committees'        => 'http://impact.brighterplanet.com/bus_trips/committees.json',
+      'computations_committees'     => 'http://impact.brighterplanet.com/computations/committees.json',
+      'diets_committees'            => 'http://impact.brighterplanet.com/diets/committees.json',
+      'electricity_uses_committees' => 'http://impact.brighterplanet.com/electricity_uses/committees.json',
+      'flights_committees'          => 'http://impact.brighterplanet.com/flights/committees.json',
+      'fuel_purchases_committees'   => 'http://impact.brighterplanet.com/fuel_purchases/committees.json',
+      'lodgings_committees'         => 'http://impact.brighterplanet.com/lodgings/committees.json',
+      'meetings_committees'         => 'http://impact.brighterplanet.com/meetings/committees.json',
+      'motorcycles_committees'      => 'http://impact.brighterplanet.com/motorcycles/committees.json',
+      'pets_committees'             => 'http://impact.brighterplanet.com/pets/committees.json',
+      'purchases_committees'        => 'http://impact.brighterplanet.com/purchases/committees.json',
+      'rail_trips_committees'       => 'http://impact.brighterplanet.com/rail_trips/committees.json',
+      'residences_committees'       => 'http://impact.brighterplanet.com/residences/committees.json',
+      'shipments_committees'        => 'http://impact.brighterplanet.com/shipments/committees.json',
     }.freeze
-    
-    # sabshere 2/4/11 obv these have to be updated with some regularity
-    FALLBACK = {
-      'datasets'            => %w{ AutomobileIndustry FlightIndustry },
-      'emitters'            => %w{ Automobile AutomobileTrip BusTrip Computation Diet ElectricityUse Flight FuelPurchase Lodging Meeting Motorcycle Pet Purchase RailTrip Residence Shipment },
-      'certified_emitters'  => %w{ },
-      'resources'           => %w{ AirConditionerUse Aircraft AircraftClass AircraftFuelUseEquation Airline Airport AutomobileFuel AutomobileMake AutomobileMakeFleetYear AutomobileMakeModel AutomobileMakeModelYear AutomobileMakeModelYearVariant AutomobileMakeYear AutomobileSizeClass AutomobileSizeClassYear AutomobileTypeFuelAge AutomobileTypeFuelControl AutomobileTypeFuelYear AutomobileTypeFuelYearAge AutomobileTypeFuelYearControl AutomobileTypeYear Breed BreedGender BtsAircraft BusClass BusFuel BusFuelControl BusFuelYearControl Carrier CarrierMode CensusDivision CensusRegion ClimateDivision ClothesMachineUse ComputationCarrier ComputationCarrierInstanceClass ComputationCarrierRegion Country DietClass DishwasherUse EgridRegion EgridSubregion FlightDistanceClass FlightSeatClass FlightSegment FoodGroup Fuel FuelPrice FuelType FuelYear Gender GreenhouseGas LodgingClass PetroleumAdministrationForDefenseDistrict RailClass ResidenceAppliance ResidenceClass ResidenceFuelPrice ResidenceFuelType ResidentialEnergyConsumptionSurveyResponse ShipmentMode Species State Urbanity ZipCode },
-      'protocols'           => { 'ghg_protocol_scope_3' => 'Greenhouse Gas Protocol Scope 3', 'iso' => 'ISO 14064-1', 'tcr' => 'The Climate Registry', 'ghg_protocol_scope_1' => 'Greenhouse Gas Protocol Scope 1' },
-    }.freeze
+
+    FALLBACK = begin
+      ::MultiJson.decode(::File.read(::File.expand_path('../fallbacks.json', __FILE__))).freeze
+    rescue
+      $stderr.puts "[brighter_planet_metadata] Error while loading fallbacks. Please reinstall library."
+      {}
+    end
     
     # What resources are available.
     def resources
@@ -83,6 +98,11 @@ module BrighterPlanet
     def options(emitter)
       deep_copy_of_authoritative_value_or_fallback "#{emitter.to_s.pluralize.downcase}_options"
     end
+
+    # committees (decisions) available for a given emitter
+    def committees(emitter)
+      deep_copy_of_authoritative_value_or_fallback "#{emitter.to_s.pluralize.downcase}_committees"
+    end
     
     # Clear out any cached values
     def refresh
@@ -109,10 +129,16 @@ module BrighterPlanet
         FALLBACK[meta_name]
       else
         begin
-          hsh = ::MultiJson.decode ::Net::HTTP.get(::URI.parse(LIVE_URL[meta_name]))
-          subkey = (meta_name == 'certified_emitters') ? 'emitters' : meta_name # the live certified response will contain an 'emitters' key
-          hsh.key?(subkey) ? hsh[subkey] : hsh
+          actual = ::MultiJson.decode ::Net::HTTP.get(::URI.parse(LIVE_URL[meta_name]))
+          case actual
+          when ::Hash
+            subkey = (meta_name == 'certified_emitters') ? 'emitters' : meta_name # the live certified response will contain an 'emitters' key
+            actual.key?(subkey) ? actual[subkey] : actual
+          else
+            actual
+          end
         rescue ::Exception
+          $stderr.puts "[brighter_planet_metadata] Rescued from #{$!.inspect} when trying to get #{meta_name}"
           FALLBACK[meta_name]
         end
       end

data/lib/brighter_planet_metadata/version.rb

@@ -1,3 +1,3 @@
 module BrighterPlanetMetadata
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/test/test_fallback.rb

@@ -4,11 +4,7 @@ class TestFallback < Test::Unit::TestCase
   def setup
     super
     [
-      'http://data.brighterplanet.com/datasets.json',
-      'http://impact.brighterplanet.com/emitters.json',
-      'http://certified.impact.brighterplanet.com/emitters.json',
-      'http://data.brighterplanet.com/resources.json',
-      'http://impact.brighterplanet.com/protocols.json',
+      %r{http.*brighterplanet.com.*}
     ].each do |url|
       WebMock.stub_request(:get, url).to_return(:status => 500)
     end
@@ -29,4 +25,16 @@ class TestFallback < Test::Unit::TestCase
   def test_protocols
     assert ::BrighterPlanet.metadata.protocols.values.include? 'The Climate Registry'
   end
+
+  def test_options_flight
+    assert ::BrighterPlanet.metadata.options(:flight).include?('origin_airport')
+  end
+
+  def test_options_electricity_use
+    assert ::BrighterPlanet.metadata.options(:electricity_use).include?('zip_code')
+  end
+
+  def test_committees_flight
+    assert ::BrighterPlanet.metadata.committees(:flight).include?('energy')
+  end
 end

data/test/test_real.rb

@@ -30,10 +30,14 @@ class TestReal < Test::Unit::TestCase
   end
 
   def test_options_flight
-    assert ::BrighterPlanet.metadata.options(:flight).keys.include?('fuel_use_coefficients')
+    assert ::BrighterPlanet.metadata.options(:flight).include?('origin_airport')
   end
 
   def test_options_electricity_use
-    assert ::BrighterPlanet.metadata.options(:electricity_use).keys.include?('zip_code')
+    assert ::BrighterPlanet.metadata.options(:electricity_use).include?('zip_code')
+  end
+
+  def test_committees_flight
+    assert ::BrighterPlanet.metadata.committees(:flight).include?('energy')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brighter_planet_metadata
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-15 00:00:00.000000000Z
+date: 2012-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2166662360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: 2.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *2166662360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2166661940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2166661940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cache_method
-  requirement: &2166661480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2166661480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2166661060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +70,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2166661060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: What emitters (carbon models), resources (data classes), datasets, etc.
   we offer.
 email:
@@ -72,6 +92,7 @@ files:
 - bin/brighter_planet_metadata
 - brighter_planet_metadata.gemspec
 - lib/brighter_planet_metadata.rb
+- lib/brighter_planet_metadata/fallbacks.json
 - lib/brighter_planet_metadata/metadata.rb
 - lib/brighter_planet_metadata/version.rb
 - test/helper.rb
@@ -99,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: brighter_planet_metadata
-rubygems_version: 1.8.11
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Names of Brighter Planet things
@@ -109,3 +130,4 @@ test_files:
 - test/test_live_remote.rb
 - test/test_memory_leak.rb
 - test/test_real.rb
+has_rdoc: