carbon 1.1.3 → 2.0.0

data/lib/carbon/shell/emitter.rb

@@ -1,21 +1,26 @@
+require 'uri'
+require 'net/http'
+require 'conversions'
+
 module Carbon
   class Shell
+    # @private
     class Emitter < Bombshell::Environment
       include Bombshell::Shell
       include Carbon
       
+      # @private
       def initialize(name, input = {})
-        @emitter = name
+        @emitter = name.to_s.singularize.camelcase
         @input = input
-        characteristics_url = "http://carbon.brighterplanet.com/#{@emitter.to_s.pluralize}/options.json"
-        response = REST.get(characteristics_url)
-        if response.ok?
-          @characteristics = ActiveSupport::JSON.decode response.body
+        response = ::Net::HTTP.get_response(::URI.parse("http://impact.brighterplanet.com/#{@emitter.underscore.pluralize}/options.json"))
+        if (200..299).include?(response.code.to_i)
+          @characteristics = ::MultiJson.decode response.body
           @characteristics.keys.each do |characteristic|
             instance_eval <<-meth
               def #{characteristic}(arg = nil)
                 if arg
-                  @input[:#{characteristic}] = arg
+                  @input[:#{characteristic}] = arg.to_s.strip
                   emission
                 else
                   @input[:#{characteristic}]
@@ -23,19 +28,17 @@ module Carbon
               end
             meth
           end
-          if self.class.carbon_base && self.class.carbon_base.translation_table.any?
-            self.class.carbon_base.reset_translation_table!
-          end
           provisions = @characteristics.keys.map { |k| "provide :#{k}"}.join('; ')
           emit_as_block = "emit_as(:#{name}) { #{provisions} }"
           self.class.class_eval emit_as_block
           emission
         else
-          puts "  => Sorry, characteristics couldn't be retrieved for #{@emitter.to_s.pluralize} (via #{url})"
+          puts "  => Sorry, characteristics couldn't be retrieved for #{@emitter.underscore.pluralize} (via #{url})"
           done
         end
       end
       
+      # @private
       def timeframe(t = nil)
         if t
           @timeframe = t
@@ -47,23 +50,28 @@ module Carbon
         end
       end
       
+      # @private
       def emission
         puts "  => #{emission_in_kilograms} kg CO2e"
       end
       
+      # @private
       def emission_in_kilograms
-        ::Carbon::EmissionEstimate.new(self, :timeframe => @timeframe).to_f
+        impact(:timeframe => @timeframe).decisions.carbon.object.value
       end
       
+      # @private
       def lbs
         puts "  => #{emission_in_kilograms.kilograms.to :pounds} lbs CO2e"
       end
       alias :pounds :lbs
       
+      # @private
       def tons
         puts "  => #{emission_in_kilograms.kilograms.to :tons} lbs CO2e"
       end
       
+      # @private
       def characteristics
         if @input.empty?
           puts "  => (none)"
@@ -80,42 +88,40 @@ module Carbon
         end
       end
       
+      # @private
       def url
-        request = ::Carbon::EmissionEstimate.new(self, :timeframe => @timeframe).request
-        url = request.url
-        if request.body.present?
-          url << '?'
-          url << request.body
-        end
-        puts "  => #{url}"
+        puts "  => #{impact(:timeframe => @timeframe).methodology}"
       end
       
+      # @private
       def methodology
         first = true
-        ::Carbon::EmissionEstimate.new(self, :timeframe => @timeframe).reports.each do |report|
+        impact(:timeframe => @timeframe).decisions.each do |name, report|
           if first
             w = '  => '
             first = false
           else
             w = '     '
           end
-          puts w + "#{report['committee']['name']}: #{report['quorum']['name']}"
+          puts w + "#{name}: #{report.methodology}"
         end
       end
       
+      # @private
       def reports
         first = true
-        ::Carbon::EmissionEstimate.new(self, @timeframe => :timeframe).reports.each do |report|
+        impact(:timeframe => @timeframe).decisions.each do |name, report|
           if first
             w = '  => '
             first = false
           else
             w = '     '
           end
-          puts w + "#{report['committee']['name']}: #{report['conclusion'].inspect}"
+          puts w + "#{name}: #{report.object.inspect}"
         end
       end
       
+      # @private
       def help
         puts "  => #{@characteristics.keys.join ', '}"
       end
@@ -128,30 +134,28 @@ module Carbon
         end
       end
       
+      # @private
       def _name
         @emitter
       end
       
+      # @private
       def _timeframe
         @timeframe
       end
       
+      # @private
       def inspect
-        "<Emitter[#{@emitter}]: #{@input.inspect}>"
+        "#<Emitter[#{@emitter}]: #{@input.inspect}>"
       end
       
+      # @private
       def done
         $emitters[@emitter] ||= []
         $emitters[@emitter] << @input
         puts "  => Saved as #{@emitter} ##{$emitters[@emitter].length - 1}"
         quit
       end
-      
-      class << self
-        def emitter_name
-          @name
-        end
-      end
     end
   end
 end

data/lib/carbon/version.rb

@@ -1,3 +1,3 @@
 module Carbon
-  VERSION = '1.1.3'
+  VERSION = "2.0.0"
 end

data/test/carbon_test.rb

@@ -0,0 +1,167 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'benchmark'
+require 'webmock/minitest'
+WebMock.disable!
+def with_web_mock
+  WebMock.enable!
+  WebMock.disable_net_connect!
+  yield
+ensure
+  WebMock.disable!
+end
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/reporters'
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+require 'timeframe'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'carbon'
+
+Carbon.key = 'carbon_test'
+
+class MyNissan
+  def name
+    'Nissan'
+  end
+  def to_s
+    raise "Not fair!"
+  end
+  alias :inspect :to_s
+end
+
+class MyNissanAltima
+  class << self
+    def all(options)
+      raise unless options == { :order => :year }
+      [ new(2000), new(2001), new(2002), new(2003), new(2004) ]
+    end
+  end
+  def initialize(model_year)
+    @model_year = model_year
+  end
+  def       make; MyNissan.new end
+  def      model; 'Altima'     end
+  def model_year; @model_year  end # what BP knows as "year"
+  def  fuel_type; 'R'          end # what BP knows as "automobile_fuel" and keys on "code"
+  include Carbon
+  emit_as 'Automobile' do
+    provide(:make) { |my_nissan_altima| my_nissan_altima.make.name }
+    provide :model
+    provide :model_year, :as => :year
+    provide :fuel_type, :as => :automobile_fuel, :key => :code
+  end
+end
+
+describe Carbon do
+  # args could be mmm(:post, 'http://impact.brighterplanet.com/monkeys.json').to_return(:status => 500, :body => 'too many monkeys')
+  describe :query do
+    it "calculates flight impact" do
+      response = Carbon.query('Flight', :origin_airport => 'LAX', :destination_airport => 'SFO', :segments_per_trip => 1, :trips => 1)
+      response.decisions.carbon.object.value.must_be_close_to 200, 50
+    end
+    it "gets back characteristics" do
+      response = Carbon.query('Flight', :origin_airport => 'LAX', :destination_airport => 'SFO', :segments_per_trip => 1, :trips => 1)
+      response.characteristics.origin_airport.description.must_match %r{lax}i
+    end
+    it "tells you if the query is successful" do
+      response = Carbon.query('Flight')
+      response.success.must_equal true
+    end
+    it "is gentle about errors" do
+      response = Carbon.query('Monkey')
+      response.success.must_equal false
+    end
+    it "sends timeframe properly" do
+      response = Carbon.query('Flight', :timeframe => Timeframe.new(:year => 2009))
+      response.timeframe.startDate.must_equal '2009-01-01'
+      response.timeframe.endDate.must_equal '2010-01-01'
+    end
+    it "sends key properly" do
+      with_web_mock do
+        WebMock.stub_request(:post, 'http://impact.brighterplanet.com/flights.json').with(:key => 'carbon_test').to_return(:status => 500, :body => 'Good job')
+        response = Carbon.query('Flight')
+        response.error_body.must_equal 'Good job'
+      end
+    end
+  end
+  unless ENV['SKIP_MULTI'] == 'true'
+    describe :multi do
+      before do
+        @queries = []
+        10.times do
+          @queries << ['Flight', {:origin_airport => 'LAX', :destination_airport => 'SFO', :segments_per_trip => 1, :trips => 1}]
+          @queries << ['RailTrip', {:distance => 25}]
+          @queries << ['AutomobileTrip', {:make => 'Nissan', :model => 'Altima'}]
+          @queries << ['Residence']
+          @queries << ['Monkey']
+        end
+        @queries = @queries.sort_by { rand }
+      end
+      it "runs multiple queries at once" do
+        responses = Carbon.multi(@queries)
+        error_count = 0
+        responses.each do |response|
+          if response.success
+            response.decisions.carbon.object.value.must_be :>, 0
+            response.decisions.carbon.object.value.must_be :<, 10_000
+          else
+            error_count += 1
+          end
+        end
+        error_count.must_equal 10
+        @queries.each_with_index do |query, i|
+          reference_response = Carbon.query(*query)
+          if reference_response.success
+            responses[i].decisions.must_equal reference_response.decisions
+          end
+        end
+      end
+      it "is faster than just calling #query over and over" do
+        # dry run
+        @queries.each { |query| Carbon.query(*query) }
+        # --
+        single_threaded_time = ::Benchmark.realtime do
+          @queries.each { |query| Carbon.query(*query) }
+        end
+        multi_threaded_time = ::Benchmark.realtime do
+          Carbon.multi(@queries)
+        end
+        # Carbon::#multi
+        #    PASS test_0001_runs_multiple_queries_at_once (12.10s)
+        #    Multi-threaded was 95% faster
+        #    PASS test_0002_is_faster_than_just_calling_query_over_and_over (23.73s)
+        $stderr.puts "   Multi-threaded was #{((single_threaded_time - multi_threaded_time) / single_threaded_time * 100).round}% faster"
+        multi_threaded_time.must_be :<, single_threaded_time
+      end
+    end
+  end
+  describe "mixin" do
+    describe :emit_as do
+      it "overwrites old emit_as blocks" do
+        eval %{class MyFoo; include Carbon; end}
+        MyFoo.emit_as('Automobile') { provide(:make) }
+        Carbon::Registry.instance['MyFoo'].characteristics.keys.must_equal [:make]
+        MyFoo.emit_as('Automobile') { provide(:model) }
+        Carbon::Registry.instance['MyFoo'].characteristics.keys.must_equal [:model]
+      end
+    end
+    describe '#impact' do
+      it "works" do
+        impact = MyNissanAltima.new(2006).impact
+        impact.decisions.carbon.object.value.must_be :>, 0
+        impact.characteristics.make.description.must_match %r{Nissan}i
+        impact.characteristics.model.description.must_match %r{Altima}i
+        impact.characteristics.year.description.to_i.must_equal 2006
+        impact.characteristics.automobile_fuel.description.must_match %r{regular gasoline}
+      end
+      it "takes timeframe" do
+        impact_2010 = MyNissanAltima.new(2006).impact(:timeframe => Timeframe.new(:year => 2010))
+        impact_2011 = MyNissanAltima.new(2006).impact(:timeframe => Timeframe.new(:year => 2011))
+        impact_2010.timeframe.startDate.must_equal '2010-01-01'
+        impact_2011.timeframe.startDate.must_equal '2011-01-01'
+      end
+    end
+  end
+end

metadata

@@ -1,238 +1,184 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: carbon
-version: !ruby/object:Gem::Version
-  version: 1.1.3
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
-authors:
-- Derek Kastner
+authors: 
 - Seamus Abshere
-- Andy Rossmeissl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-17 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2167482440 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.5
-  type: :runtime
+
+date: 2012-03-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
   prerelease: false
-  version_requirements: *2167482440
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: &2167482000 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
   prerelease: false
-  version_requirements: *2167482000
-- !ruby/object:Gem::Dependency
-  name: nap
-  requirement: &2167481360 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multi_json
   prerelease: false
-  version_requirements: *2167481360
-- !ruby/object:Gem::Dependency
-  name: timeframe
-  requirement: &2167480700 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hashie
   prerelease: false
-  version_requirements: *2167480700
-- !ruby/object:Gem::Dependency
-  name: blockenspiel
-  requirement: &2167480040 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bombshell
   prerelease: false
-  version_requirements: *2167480040
-- !ruby/object:Gem::Dependency
-  name: conversions
-  requirement: &2167479540 !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: conversions
   prerelease: false
-  version_requirements: *2167479540
-- !ruby/object:Gem::Dependency
-  name: brighter_planet_metadata
-  requirement: &2167479120 !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: brighter_planet_metadata
   prerelease: false
-  version_requirements: *2167479120
-- !ruby/object:Gem::Dependency
-  name: bombshell
-  requirement: &2167478680 !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2167478680
-- !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: &2167478180 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167478180
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2167477600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167477600
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: &2167476940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167476940
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2167475940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167475940
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: &2167475060 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167475060
-description: 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.
-email:
-- derek.kastner@brighterplanet.com
-executables:
+  version_requirements: *id007
+description: Brighter Planet API client for Ruby
+email: 
+- seamus@abshere.net
+- dkastner@gmail.com
+- andy@rossmeissl.net
+executables: 
 - carbon
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- CHANGELOG
 - Gemfile
-- MIT-LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - bin/carbon
 - carbon.gemspec
-- doc/INTEGRATION_GUIDE.rdoc
-- doc/examining-response-with-jsonview.png
-- doc/shell_example
-- doc/timeout-error.png
-- doc/with-committee-reports.png
-- doc/without-committee-reports.png
+- developer_notes/MULTI.markdown
+- developer_notes/REDUCE_HTTP_CONNECTIONS.markdown
 - features/shell.feature
 - features/support/env.rb
 - lib/carbon.rb
-- lib/carbon/base.rb
-- lib/carbon/emission_estimate.rb
-- lib/carbon/emission_estimate/request.rb
-- lib/carbon/emission_estimate/response.rb
-- lib/carbon/emission_estimate/storage.rb
 - lib/carbon/registry.rb
 - lib/carbon/shell.rb
 - lib/carbon/shell/emitter.rb
 - lib/carbon/version.rb
-- spec/fixtures/vcr_cassettes/flight.yml
-- spec/fixtures/vcr_cassettes/residence.yml
-- spec/lib/carbon/emission_estimate/request_spec.rb
-- spec/lib/carbon/emission_estimate/response_spec.rb
-- spec/lib/carbon/emission_estimate_spec.rb
-- spec/lib/carbon_spec.rb
-- spec/spec_helper.rb
-- spec/specwatchr
+- test/carbon_test.rb
 homepage: https://github.com/brighterplanet/carbon
 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: Carbon is a Ruby API wrapper for the Brighter Planet emission estimate web
-  service (http://carbon.brighterplanet.com).
-test_files:
+summary: Brighter Planet API client for Ruby
+test_files: 
 - features/shell.feature
 - features/support/env.rb
-- spec/fixtures/vcr_cassettes/flight.yml
-- spec/fixtures/vcr_cassettes/residence.yml
-- spec/lib/carbon/emission_estimate/request_spec.rb
-- spec/lib/carbon/emission_estimate/response_spec.rb
-- spec/lib/carbon/emission_estimate_spec.rb
-- spec/lib/carbon_spec.rb
-- spec/spec_helper.rb
-- spec/specwatchr
+- test/carbon_test.rb
+has_rdoc: