energy 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+rdoc/*

data/Gemfile

@@ -0,0 +1,5 @@
+gem 'carbon', :path => ENV['LOCAL_CARBON'] if ENV['LOCAL_CARBON']
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in energy.gemspec
+gemspec

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Brighter Planet, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+=energy
+
+Get energy use estimates for flights, rail trips, and automobile trips (more coming soon!). BETA from Brighter Planet.
+
+==BETA
+
+This is beta software and subject to change at any time.
+
+==Examples
+
+===Fuel used by a Bentley
+
+    ?> Energy::AutomobileTrip.fuel_use(:make => 'Bentley', :distance => 500)
+    => [how many litres of gas a Bentley uses to drive 500km]
+
+===Fuel used by a Continental Airlines flight
+
+    ?> Energy::Flight.fuel_use(:airline => 'Continental Airlines')
+    => [how many litres of aviation fuel a Continental Airlines flight consumes]
+
+===Fuel used by an Amtrak train
+
+    ?> Energy::RailTrip.fuel_use(:rail_class => 'intercity', :distance => 500)
+    => [how many litres of diesel an intercity uses over 500km]
+
+==TODO
+
+* always provide a conversion of, for example, fuel use in litres to energy use in joules to be true to the intent of the gem
+* decide how we expect people to use this gem (maybe it should be more like Carbon and not define its own classes)
+* hit impact.brighterplanet.com or energy.brighterplanet.com directly
+
+Copyright 2011 Brighter Planet, Inc.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'energy'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :test

data/energy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "energy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "energy"
+  s.version     = Energy::VERSION
+  s.authors     = ["Seamus Abshere"]
+  s.email       = ["seamus@abshere.net"]
+  s.homepage    = "https://github.com/brighterplanet/energy"
+  s.summary     = %q{Get energy use estimates for flights, rail trips, and automobile trips (more coming soon!). BETA from Brighter Planet.}
+  s.description = %q{Get energy use estimates for flights, rail trips, and automobile trips (more coming soon!). BETA from Brighter Planet.}
+
+  s.rubyforge_project = "energy"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'rake'
+  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'carbon', '>=1.1.2'
+end

data/lib/energy.rb

@@ -0,0 +1,19 @@
+require "energy/version"
+require 'active_support/core_ext'
+
+module Energy
+  autoload :AutomobileTrip, 'energy/automobile_trip'
+  autoload :Config, 'energy/config'
+  autoload :Consumer, 'energy/consumer'
+  autoload :Flight, 'energy/flight'
+  autoload :RailTrip, 'energy/rail_trip'
+  
+  # Set configuration variables like
+  #
+  #     Energy.config[:key] = '456'
+  #
+  # You can get your key at http://keys.brighterplanet.com
+  def self.config
+    Config.instance
+  end
+end

data/lib/energy/automobile_trip.rb

@@ -0,0 +1,31 @@
+module Energy
+  class AutomobileTrip < Consumer
+    attr_accessor :make
+    attr_accessor :model
+    attr_accessor :distance
+    
+    emit_as :automobile_trip do
+      provide :make
+      provide :model
+      provide :distance
+    end
+    
+    def initialize(attrs = {}) # :nodoc:
+      attrs = attrs.symbolize_keys
+      @make = attrs[:make]
+      @model = attrs[:model]
+      @distance = attrs[:distance]
+    end
+
+    class << self
+      # Estimate the fuel used by an automobile trip given any of the following optional characteristics:
+      # * <tt>make</tt> - "nissan"
+      # * <tt>model</tt> - "altima"
+      # * <tt>distance</tt> - 500 (kilometres)
+      # See http://carbon.brighterplanet.com/models/rail_trip for more details
+      def fuel_use(attrs = {})
+        estimate :fuel_use, attrs
+      end
+    end
+  end
+end

data/lib/energy/config.rb

@@ -0,0 +1,6 @@
+require 'singleton'
+module Energy
+  class Config < ::Hash # :nodoc:
+    include ::Singleton
+  end
+end

data/lib/energy/consumer.rb

@@ -0,0 +1,19 @@
+require 'carbon'
+
+module Energy
+  class Consumer # :nodoc:
+    include ::Carbon
+    class << self
+      private
+      
+      # Use CM1 to get an energy consumption estimate
+      def estimate(k, attrs = {})
+        attrs = attrs.symbolize_keys
+        timeframe = attrs.delete(:timeframe) || ::Timeframe.this_year
+        emitter_instance = new attrs
+        emission_estimate = emitter_instance.emission_estimate(:timeframe => timeframe, :key => Config.instance[:key])
+        emission_estimate.send k
+      end
+    end
+  end
+end

data/lib/energy/flight.rb

@@ -0,0 +1,52 @@
+module Energy
+  class Flight < Consumer
+    attr_accessor :airline
+    attr_accessor :aircraft
+    attr_accessor :origin_airport
+    attr_accessor :destination_airport
+    attr_accessor :segments_per_trip
+    
+    emit_as :flight do
+      provide :airline
+      provide :aircraft
+      provide :origin_airport
+      provide :destination_airport
+      provide :segments_per_trip
+    end
+    
+    def initialize(attrs = {}) # :nodoc:
+      attrs = attrs.symbolize_keys
+      @airline = attrs[:airline]
+      @aircraft = attrs[:aircraft]
+      @origin_airport = attrs[:origin_airport]
+      @destination_airport = attrs[:destination_airport]
+      @segments_per_trip = attrs[:segments_per_trip] || 1
+    end
+    
+    class << self
+      # Estimate the fuel used by a flight given any of the following optional characteristics:
+      # * <tt>airline</tt> - "american eagle"
+      # * <tt>aircraft</tt> - "b747"
+      # * <tt>origin_airport</tt> - "msn"
+      # * <tt>destination_airport</tt> - "iah"
+      # * <tt>segments_per_trip</tt> - 1 (defaults to 1 to force calculation as a one-segment trip)
+      # See http://carbon.brighterplanet.com/models/flight for more details
+      def fuel_use(attrs = {})
+        estimate :fuel_use, attrs
+      end
+
+      # Estimate the fuel efficiency (length / volume, not taking into account passengers) of a flight given any of the following optional characteristics:
+      # * <tt>airline</tt> - "american eagle"
+      # * <tt>aircraft</tt> - "b747"
+      # * <tt>origin_airport</tt> - "msn"
+      # * <tt>destination_airport</tt> - "iah"
+      # * <tt>segments_per_trip</tt> - 1 (defaults to 1 to force calculation as a one-segment trip)
+      # See http://carbon.brighterplanet.com/models/flight for more details      
+      def fuel_efficiency(attrs = {})
+        d = estimate(:distance, attrs)
+        f = estimate(:fuel_use, attrs)
+        d / f
+      end
+    end
+  end
+end

data/lib/energy/rail_trip.rb

@@ -0,0 +1,27 @@
+module Energy
+  class RailTrip < Consumer
+    attr_accessor :distance
+    attr_accessor :rail_class
+    
+    emit_as :rail_trip do
+      provide :distance, :as => :distance_estimate
+      provide :rail_class
+    end
+    
+    def initialize(attrs = {}) # :nodoc:
+      attrs = attrs.symbolize_keys
+      @distance = attrs[:distance]
+      @rail_class = attrs[:rail_class]
+    end
+    
+    class << self
+      # Estimate the diesel consumed by a rail trip given any of the following optional characteristics:
+      # * <tt>distance</tt> - 500 (kilometres)
+      # * <tt>rail_class</tt> - "intercity"
+      # See http://carbon.brighterplanet.com/models/rail_trip for more details
+      def fuel_use(attrs = {})
+        estimate :diesel_consumed, attrs
+      end
+    end
+  end
+end

data/lib/energy/version.rb

@@ -0,0 +1,3 @@
+module Energy
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'test/unit'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'energy'
+class Test::Unit::TestCase
+end

data/test/test_energy.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require 'helper'
+
+Energy.config[:key] = '456'
+
+class TestEnergy < Test::Unit::TestCase
+  def test_001_automobile_trip_fuel_use
+    assert (1.5..3).include?(Energy::AutomobileTrip.fuel_use)
+    assert(Energy::AutomobileTrip.fuel_use(:make => 'Bentley') > Energy::AutomobileTrip.fuel_use(:make => 'Smart'))
+  end
+  
+  def test_002_flight_fuel_use
+    assert (18910..18920).include?(Energy::Flight.fuel_use)
+    assert(Energy::Flight.fuel_use(:origin_airport => 'MSN', :destination_airport =>'IAH') > Energy::Flight.fuel_use(:origin_airport => 'MSN', :destination_airport =>'ORD'))
+  end
+  
+  def test_003_rail_trip_fuel_use
+    assert (1640..1642).include?(Energy::RailTrip.fuel_use(:distance => 400, :rail_class => 'intercity'))
+    assert(Energy::RailTrip.fuel_use(:distance => 400) > Energy::RailTrip.fuel_use(:distance => 300))
+  end
+  
+  def test_004_flight_meta_fuel_efficiency
+    # american eagle's fuel efficiency is higher than continental's because we're not taking passengers into account
+    assert(Energy::Flight.fuel_efficiency(:airline => 'american eagle') > Energy::Flight.fuel_efficiency(:airline => 'continental airlines'))
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: energy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &2157408560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157408560
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157408140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157408140
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2157407720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157407720
+- !ruby/object:Gem::Dependency
+  name: carbon
+  requirement: &2157407220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157407220
+description: Get energy use estimates for flights, rail trips, and automobile trips
+  (more coming soon!). BETA from Brighter Planet.
+email:
+- seamus@abshere.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE.txt
+- README.rdoc
+- Rakefile
+- energy.gemspec
+- lib/energy.rb
+- lib/energy/automobile_trip.rb
+- lib/energy/config.rb
+- lib/energy/consumer.rb
+- lib/energy/flight.rb
+- lib/energy/rail_trip.rb
+- lib/energy/version.rb
+- test/helper.rb
+- test/test_energy.rb
+homepage: https://github.com/brighterplanet/energy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: energy
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Get energy use estimates for flights, rail trips, and automobile trips (more
+  coming soon!). BETA from Brighter Planet.
+test_files:
+- test/helper.rb
+- test/test_energy.rb