carbon 0.2.7 → 0.3.0

data/Rakefile

@@ -16,6 +16,7 @@ begin
     # This is still only on Rubyforge
     gemspec.add_dependency 'SystemTimer', '>=1.2'
     gemspec.add_dependency 'blockenspiel', '>=0.3.2'
+    gemspec.add_dependency 'conversions', '~>1'
 
     gemspec.add_development_dependency 'fakeweb', '>=1.2.8'
     # sabshere 7/16/10 if you're having trouble running specs, try "rspec spec" and/or "sudo gem install rspec --pre"

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.3.0

data/bin/carbon

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'carbon'
+require 'carbon/cli'
+begin
+  # The dup is to keep ARGV intact, so that tools like ruby-debug can respawn.
+  failure = Carbon::Cli.execute(ARGV.dup)
+  Kernel.exit(failure ? 1 : 0)
+rescue SystemExit => e
+  Kernel.exit(e.status)
+rescue Exception => e
+  STDERR.puts("#{e.message} (#{e.class})")
+  STDERR.puts(e.backtrace.join("\n"))
+  Kernel.exit(1)
+end

data/carbon.gemspec

@@ -5,13 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{carbon}
-  s.version = "0.2.7"
+  s.version = "0.3.0"
 
   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-08-18}
+  s.date = %q{2010-10-01}
+  s.default_executable = %q{carbon}
   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.executables = ["carbon"]
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
@@ -21,14 +23,21 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "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",
      "lib/carbon.rb",
      "lib/carbon/base.rb",
+     "lib/carbon/cli.rb",
+     "lib/carbon/cli/emitter.rb",
+     "lib/carbon/cli/environment.rb",
+     "lib/carbon/cli/irb.rb",
+     "lib/carbon/cli/shell.rb",
      "lib/carbon/emission_estimate.rb",
      "lib/carbon/emission_estimate/request.rb",
      "lib/carbon/emission_estimate/response.rb",
@@ -59,6 +68,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<timeframe>, [">= 0.0.7"])
       s.add_runtime_dependency(%q<SystemTimer>, [">= 1.2"])
       s.add_runtime_dependency(%q<blockenspiel>, [">= 0.3.2"])
+      s.add_runtime_dependency(%q<conversions>, ["~> 1"])
       s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
       s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.17"])
     else
@@ -67,6 +77,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<timeframe>, [">= 0.0.7"])
       s.add_dependency(%q<SystemTimer>, [">= 1.2"])
       s.add_dependency(%q<blockenspiel>, [">= 0.3.2"])
+      s.add_dependency(%q<conversions>, ["~> 1"])
       s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
       s.add_dependency(%q<rspec>, [">= 2.0.0.beta.17"])
     end
@@ -76,6 +87,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<timeframe>, [">= 0.0.7"])
     s.add_dependency(%q<SystemTimer>, [">= 1.2"])
     s.add_dependency(%q<blockenspiel>, [">= 0.3.2"])
+    s.add_dependency(%q<conversions>, ["~> 1"])
     s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
     s.add_dependency(%q<rspec>, [">= 2.0.0.beta.17"])
   end

data/doc/shell_example

@@ -0,0 +1,43 @@
+carbon> key '123abc'
+  => Using key 123abc
+carbon> help
+  => flight, automobile, ...
+carbon> flight
+  => 974 kg CO2e
+flight> lbs
+  => 123 lbs CO2e
+flight> tons
+  => 1 ton CO2e
+flight> help
+  => origin_airport, destination_airport . . .
+flight> origin_airport 'lax'
+  => 1123 kg CO2e
+flight> destination_airport 'jfk'
+  => 1375 kg CO2e
+flight> characteristics
+  => Origin airport: JFK
+     Destination airport: JFK
+flight> methodology
+  => Emission: from foo and bar
+     Foo: from baz
+     Bar: default
+flight> url
+  => http://carbon.brighterplanet.com/flights?key=123abc&origin_airport[iata_code]=lax&destination_airport[iata_code]=jfk
+flight> done
+  => Origin airport: JFK
+     Destination airport: JFK
+     1375 kg CO2e
+     http://carbon.brighterplanet.com/flights?key=123abc&origin_airport[iata_code]=lax&destination_airport[iata_code]=jfk
+     Saved as flight #1
+carbon> flight 1
+  => Origin airport: JFK
+     Destination airport: JFK
+     1375 kg CO2e
+flight> done
+  => Origin airport: JFK
+     Destination airport: JFK
+     1375 kg CO2e
+     http://carbon.brighterplanet.com/flights?key=123abc&origin_airport[iata_code]=lax&destination_airport[iata_code]=jfk
+     Saved as flight #1
+carbon> exit
+$

data/lib/carbon.rb

@@ -75,7 +75,7 @@ module Carbon
     #     provide :make
     #   end
     def emit_as(emitter_common_name, &block)
-      self.carbon_base ||= ::Carbon::Base.new self, emitter_common_name
+      self.carbon_base = ::Carbon::Base.new self, emitter_common_name
       ::Blockenspiel.invoke block, carbon_base
     end
     # Third-person singular preferred.

data/lib/carbon/base.rb

@@ -20,6 +20,10 @@ module Carbon
     def translation_table # :nodoc:
       @translation_table ||= Hash.new
     end
+    
+    def reset_translation_table!
+      @translation_table = Hash.new
+    end
 
     # Indicate that you will send in a piece of data about the emitter.
     #

data/lib/carbon/cli.rb

@@ -0,0 +1,21 @@
+module Carbon
+  module Cli
+    def execute(*)
+      $emitters = {}
+      IRB.start_session(Shell.new.get_binding)
+    end 
+    module_function :execute
+  end
+end
+
+require 'carbon/cli/environment'
+require 'carbon/cli/shell'
+require 'carbon/cli/emitter'
+require 'carbon/cli/irb'
+require 'conversions'
+
+if File.exist?(dotfile = File.join(ENV['HOME'], '.carbon_middleware'))
+  if (key = IO.read(dotfile).strip).present?
+    ::Carbon.key = key
+  end
+end

data/lib/carbon/cli/emitter.rb

@@ -0,0 +1,126 @@
+module Carbon
+  module Cli
+    class Emitter < Environment
+      include Carbon
+      def initialize(name, input = {})
+        @emitter = name
+        @input = input
+        characteristics_url = "http://carbon.brighterplanet.com/#{@emitter.to_s.pluralize}/options.json"
+        response = REST.get(characteristics_url)
+        if response.ok?
+          @characteristics = JSON.parse(response.body)
+          @characteristics.keys.each do |characteristic|
+            instance_eval <<-meth
+              def #{characteristic}(arg = nil)
+                if arg
+                  @input[:#{characteristic}] = arg
+                  emission
+                else
+                  @input[:#{characteristic}]
+                end
+              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})"
+          done
+        end
+      end
+      
+      def emission
+        puts "  => #{emission_in_kilograms} kg CO2e"
+      end
+      
+      def emission_in_kilograms
+        ::Carbon::EmissionEstimate.new(self).to_f
+      end
+      
+      def lbs
+        puts "  => #{emission_in_kilograms.kilograms.to :pounds} lbs CO2e"
+      end
+      alias :pounds :lbs
+      
+      def tons
+        puts "  => #{emission_in_kilograms.kilograms.to :tons} lbs CO2e"
+      end
+      
+      def characteristics
+        if @input.empty?
+          puts "  => (none)"
+        else
+          first = true
+          @input.each_pair do |key, value|
+            if first
+              puts "  => #{key}: #{value}"
+              first = false
+            else
+              puts "     #{key}: #{value}"
+            end
+          end
+        end
+      end
+      
+      def url
+        request = ::Carbon::EmissionEstimate.new(self).request
+        url = request.url
+        if request.body.present?
+          url << '?'
+          url << request.body
+        end
+        puts "  => #{url}"
+      end
+      
+      def methodology
+        first = true
+        ::Carbon::EmissionEstimate.new(self).reports.each do |report|
+          if first
+            w = '  => '
+            first = false
+          else
+            w = '     '
+          end
+          puts w + "#{report['committee']['name']}: #{report['quorum']['name']}"
+        end
+      end
+      
+      def reports
+        first = true
+        ::Carbon::EmissionEstimate.new(self).reports.each do |report|
+          if first
+            w = '  => '
+            first = false
+          else
+            w = '     '
+          end
+          puts w + "#{report['committee']['name']}: #{report['conclusion'].inspect}"
+        end
+      end
+      
+      def help
+        puts "  => #{@characteristics.keys.join ', '}"
+      end
+      
+      def to_s
+        "#{@emitter}*"
+      end
+      
+      def inspect
+        "<Emitter[#{@emitter}]: #{@input.inspect}>"
+      end
+      
+      def done
+        $emitters[@emitter] ||= []
+        $emitters[@emitter] << @input
+        puts "  => Saved as #{@emitter} ##{$emitters[@emitter].length - 1}"
+        throw :IRB_EXIT
+      end
+    end
+  end
+end

data/lib/carbon/cli/environment.rb

@@ -0,0 +1,16 @@
+module Carbon
+  module Cli
+    class Environment
+      instance_methods.each do |m|
+        undef_method(m) if m.to_s !~ /(?:^__|^nil\?$|^send$|^instance_eval$|^define_method$|^class$|^object_id$)/
+      end
+
+      def get_binding() binding end
+      
+      def method_missing(*args)
+        return if [:extend, :respond_to?].include? args.first
+        puts "Unknown command #{args.first}"
+      end
+    end
+  end
+end

data/lib/carbon/cli/irb.rb

@@ -0,0 +1,32 @@
+require 'irb'
+
+module IRB # :nodoc:
+  def self.start_session(binding)
+    unless @__initialized
+      args = ARGV
+      ARGV.replace(ARGV.dup)
+      IRB.setup(nil)
+      ARGV.replace(args)
+      @__initialized = true
+    end
+
+    workspace = WorkSpace.new(binding)
+
+    @CONF[:PROMPT][:CARBON] = {
+      :PROMPT_I => "%m> ",
+      :PROMPT_S => "%m\"> ",
+      :PROMPT_C => "%m…>",
+      :PROMPT_N => "%m→>",
+      :RETURN => ''
+    }
+    @CONF[:PROMPT_MODE] = :CARBON
+
+    irb = Irb.new(workspace)
+
+    @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
+    @CONF[:MAIN_CONTEXT] = irb.context
+    catch(:IRB_EXIT) do
+      irb.eval_input
+    end
+  end
+end

data/lib/carbon/cli/shell.rb

@@ -0,0 +1,42 @@
+module Carbon
+  module Cli
+    class Shell < Environment
+      cattr_accessor :emitters
+      
+      emitters_url = "http://carbon.brighterplanet.com/models.json"
+      response = REST.get(emitters_url)
+      if true || response.ok?
+        self.emitters = JSON.parse(response.body)
+        emitters.each do |e|
+          define_method e.to_sym do |*args|
+            if args.any? and num = args.first and saved = $emitters[e.to_sym][num]
+              emitter e.to_sym, saved
+            else
+              emitter e.to_sym
+            end
+          end
+        end
+      else
+        puts "  => Sorry, emitter types couldn't be retrieved (via #{emitters_url})"
+        done
+      end
+      
+      def help
+        puts "  => #{self.class.emitters.join ', '}"
+      end
+      
+      def to_s
+        'carbon-'
+      end
+      
+      def key(k)
+        ::Carbon.key = k
+        puts "  => Using key #{::Carbon.key}"
+      end
+
+      def emitter(e, saved = {})
+        ::IRB.start_session(Emitter.new(e, saved).get_binding)
+      end
+    end
+  end
+end

data/lib/carbon/emission_estimate.rb

@@ -146,5 +146,9 @@ module Carbon
     def methodology
       data['methodology']
     end
+    
+    def reports
+      data['reports']
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: carbon
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 7
-  version: 0.2.7
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Derek Kastner
@@ -17,8 +17,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 -04:00
-default_executable: 
+date: 2010-10-01 00:00:00 -05:00
+default_executable: carbon
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -99,9 +99,23 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: conversions
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        version: "1"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -113,11 +127,11 @@ dependencies:
         - 8
         version: 1.2.8
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -131,11 +145,11 @@ dependencies:
         - 17
         version: 2.0.0.beta.17
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 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: []
-
+executables: 
+- carbon
 extensions: []
 
 extra_rdoc_files: 
@@ -146,14 +160,21 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- 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
 - lib/carbon.rb
 - lib/carbon/base.rb
+- lib/carbon/cli.rb
+- lib/carbon/cli/emitter.rb
+- lib/carbon/cli/environment.rb
+- lib/carbon/cli/irb.rb
+- lib/carbon/cli/shell.rb
 - lib/carbon/emission_estimate.rb
 - lib/carbon/emission_estimate/request.rb
 - lib/carbon/emission_estimate/response.rb