carbon 0.2.5 → 0.2.6

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/carbon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{carbon}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   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-02}
+  s.date = %q{2010-08-18}
   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.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
      "lib/carbon/emission_estimate/request.rb",
      "lib/carbon/emission_estimate/response.rb",
      "lib/carbon/emission_estimate/storage.rb",
+     "spec/lib/carbon/emission_estimate/response_spec.rb",
      "spec/lib/carbon_spec.rb",
      "spec/spec_helper.rb",
      "spec/specwatchr"
@@ -43,7 +44,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Carbon is a Ruby API wrapper for the Brighter Planet emission estimate web service (http://carbon.brighterplanet.com).}
   s.test_files = [
-    "spec/lib/carbon_spec.rb",
+    "spec/lib/carbon/emission_estimate/response_spec.rb",
+     "spec/lib/carbon_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/carbon.rb

@@ -5,6 +5,7 @@ require 'digest/sha1'
 require 'rest'    # provided by nap gem
 gem 'SystemTimer' # >=1.2, so as not to be confused with system_timer 1.0
 require 'system_timer'
+require 'active_support'
 require 'active_support/version'
 %w{
   active_support/core_ext/module/attribute_accessors

data/lib/carbon/base.rb

@@ -10,6 +10,7 @@ module Carbon
       @klass = klass
       @emitter_common_name = emitter_common_name.to_s
     end
+
     # A completed translation table will look like:
     # {[:mixer, :size]=>"mixer_size",
     # :personnel=>:employees,
@@ -19,6 +20,7 @@ module Carbon
     def translation_table # :nodoc:
       @translation_table ||= Hash.new
     end
+
     # Indicate that you will send in a piece of data about the emitter.
     #
     # Two general rules:
@@ -50,6 +52,7 @@ module Carbon
       # translation_table[:make] = 'epa_code'
       translation_table[characteristic] = options[:key]
     end
+
     # Third-person singular preferred.
     alias :provides :provide
   end

data/lib/carbon/emission_estimate.rb

@@ -17,6 +17,15 @@ module Carbon
       data['updated_at'] = ::Time.parse(data['updated_at']) if data.has_key? 'updated_at'
       data
     end
+
+    attr_writer :callback_content_type
+    attr_writer :key
+    attr_writer :timeout
+    attr_writer :defer
+    attr_accessor :callback
+    attr_accessor :timeframe
+    attr_accessor :guid
+    attr_reader :emitter
     
     def initialize(emitter)
       @emitter = emitter
@@ -55,14 +64,7 @@ module Carbon
         super
       end
     end
-    attr_writer :callback_content_type
-    attr_writer :key
-    attr_writer :timeout
-    attr_writer :defer
-    attr_accessor :callback
-    attr_accessor :timeframe
-    attr_accessor :guid
-    attr_reader :emitter
+    
     def data
       if storage.present?
         storage.data
@@ -70,58 +72,74 @@ module Carbon
         response.data
       end
     end
+
     def storage
       @storage ||= {}
       return @storage[guid] if @storage.has_key? guid
       @storage[guid] = Storage.new self
     end
+
     def request
       @request ||= Request.new self
     end
+
     # Here's where caching takes place.
     def response
       current_params = request.params
       @response ||= {}
       return @response[current_params] if @response.has_key? current_params
-      @response[current_params] = Response.new self
+      response_object = Response.new self
+      response_object.load_data
+      @response[current_params] = response_object
     end
+
     def defer?
       @defer == true
     end
+
     def async?
       callback or defer?
     end
+
     def mode
       async? ? :async : :realtime
     end
+
     # Timeout on realtime requests in seconds, if desired.
     def timeout
       @timeout
     end
+
     def callback_content_type
       @callback_content_type || 'application/json'
     end
+
     def key
       @key || ::Carbon.key
     end
+
     # The timeframe being looked at in the emission calculation.
     def active_subtimeframe
       data['active_subtimeframe']
     end
+
     # Another way to access the emission value.
     # Useful if you don't like treating <tt>EmissionEstimate</tt> objects like <tt>Numeric</tt> objects (even though they do quack like numbers...)
     def number
       async? ? nil : data['emission'].to_f.freeze
     end
+
     # The units of the emission.
     def emission_units
       data['emission_units']
     end
+
     # Errors (and warnings) as reported in the response.
     # Note: may contain HTML tags like KBD or A
     def errors
       data['errors']
     end
+
     # The URL of the methodology report indicating how this estimate was calculated.
     #   > my_car.emission_estimate.methodology
     #   => 'http://carbon.brighterplanet.com/automobiles.html?[...]'

data/lib/carbon/emission_estimate/request.rb

@@ -2,15 +2,19 @@ module Carbon
   class EmissionEstimate
     class Request
       attr_reader :parent
+
       def initialize(parent)
         @parent = parent
       end
+
       def body
         params.to_query
       end
+
       def params
         send "#{parent.mode}_params"
       end
+
       def async_params # :nodoc:
         raise ::ArgumentError, "When using :callback you cannot specify :defer" if parent.defer? and parent.callback
         raise ::ArgumentError, "When using :defer => true you must specify :guid" if parent.defer? and parent.guid.blank?
@@ -25,9 +29,11 @@ module Carbon
           :MessageBody => hash.to_query
         }
       end
+
       def realtime_params # :nodoc:
         _params
       end
+
       # Used internally, but you can look if you want.
       #
       # Returns the params hash that will be send to the emission estimate server.
@@ -60,12 +66,15 @@ module Carbon
         hash[:key] = parent.key if parent.key
         hash
       end
+
       def realtime_url # :nodoc:
         "#{::Carbon::REALTIME_URL}/#{parent.emitter.class.carbon_base.emitter_common_name.pluralize}.json"
       end
+
       def async_url # :nodoc:
         ::Carbon::ASYNC_URL
       end
+
       def url
         send "#{parent.mode}_url"
       end

data/lib/carbon/emission_estimate/response.rb

@@ -5,17 +5,23 @@ module Carbon
       attr_reader :data
       attr_reader :raw_request
       attr_reader :raw_response
+
       def initialize(parent)
         @parent = parent
+      end
+
+      def load_data
         send "load_#{parent.mode}_data"
       end
+
+    private
       def load_realtime_data # :nodoc:
         attempts = 0
         response = nil
         begin
           response = perform
-          raise ::Carbon::RateLimited if response.status_code == 403 and response.body =~ /Rate Limit/i
-        rescue ::Carbon::RateLimited
+          raise ::Carbon::RateLimited if response.status_code == 403 and response.body =~ /Rate Limit/i  #TODO: Should we expect an HTTP 402: payment required, instead?
+        rescue ::Carbon::RateLimited, EOFError
           if attempts < 4
             attempts += 1
             sleep 0.2 * attempts
@@ -24,26 +30,29 @@ module Carbon
             raise $!
           end
         end
-        raise ::Carbon::RealtimeEstimateFailed unless response.success?
+        raise ::Carbon::RealtimeEstimateFailed unless response.success? #TODO: should we expect 300s as well as 200s? Also, we may want to include response code and body in our exception.
         @data = ::Carbon::EmissionEstimate.parse response.body
       end
+
       def load_async_data # :nodoc:
         response = perform
-        raise ::Carbon::QueueingFailed unless response.success?
+        raise ::Carbon::QueueingFailed unless response.success? #TODO: should we expect 300s as well as 200s? Also, we may want to include response code and body in our exception.
         @data = {}
       end
+
       def perform # :nodoc:
         response = nil
         if parent.timeout
           ::SystemTimer.timeout_after(parent.timeout) do
-            response = _perform
+            response = perform_request
           end
         else
-          response = _perform
+          response = perform_request
         end
         response
       end
-      def _perform # :nodoc:
+
+      def perform_request # :nodoc:
         @raw_request = ::REST::Request.new :post, ::URI.parse(parent.request.url), parent.request.body, {'Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'}
         @raw_response = raw_request.perform
       end

data/lib/carbon/emission_estimate/storage.rb

@@ -4,15 +4,19 @@ module Carbon
       attr_accessor :parent
       attr_reader :raw_request
       attr_reader :raw_response
+
       def initialize(parent)
         @parent = parent
       end
+
       def url
         "#{::Carbon::STORAGE_URL}/#{::Digest::SHA1.hexdigest(parent.key+parent.guid)}"
       end
+
       def present?
         parent.guid.present? and data.present?
       end
+
       def data
         return @data[0] if @data.is_a? ::Array
         @raw_request = ::REST::Request.new :get, ::URI.parse(url)

data/spec/lib/carbon/emission_estimate/response_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Carbon::EmissionEstimate::Response do
+  let(:parent) { mock(Object, :mode => :realtime) }
+  let(:response) { Carbon::EmissionEstimate::Response.new parent }
+  let(:rest_response) { mock(Object, :success? => true, :status_code => 200,
+                             :body => 'OK') }
+
+  describe '#load_realtime_data' do
+    before do
+      ::Carbon::EmissionEstimate.stub! :parse
+      response.stub! :sleep
+    end
+
+    it 'should retry a request that is rate limited' do
+      response.should_receive(:perform).once.ordered.
+        and_raise ::Carbon::RateLimited
+      response.should_receive(:perform).once.ordered.
+        and_return rest_response
+
+      response.send :load_realtime_data
+    end
+
+    it 'should retry a request that gets cut off (server disappears mid-request)' do
+      response.should_receive(:perform).once.ordered.
+        and_raise EOFError
+      response.should_receive(:perform).once.ordered.
+        and_return rest_response
+
+      response.send :load_realtime_data
+    end
+  end
+end
+

data/spec/lib/carbon_spec.rb

@@ -130,11 +130,11 @@ module Carbon
     attr_accessor :sleep_before_performing
     VALID_OPTIONS.push :sleep_before_performing
     class Response
-      def _perform_with_delay
+      def perform_request_with_delay
         sleep parent.sleep_before_performing if parent.sleep_before_performing
-        _perform_without_delay
+        perform_request_without_delay
       end
-      alias_method_chain :_perform, :delay
+      alias_method_chain :perform_request, :delay
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require 'rubygems'
 require 'rspec'
-begin
-  require 'ruby-debug'
-rescue
-end
+#begin
+#  require 'ruby-debug'
+#rescue
+#end
 
 require 'carbon'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: carbon
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Derek Kastner
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 -04:00
+date: 2010-08-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -158,6 +158,7 @@ files:
 - lib/carbon/emission_estimate/request.rb
 - lib/carbon/emission_estimate/response.rb
 - lib/carbon/emission_estimate/storage.rb
+- spec/lib/carbon/emission_estimate/response_spec.rb
 - spec/lib/carbon_spec.rb
 - spec/spec_helper.rb
 - spec/specwatchr
@@ -196,5 +197,6 @@ 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: 
+- spec/lib/carbon/emission_estimate/response_spec.rb
 - spec/lib/carbon_spec.rb
 - spec/spec_helper.rb