carbon 2.2.3 → 3.0.0

data/CHANGELOG

@@ -1,3 +1,18 @@
+3.0.0 / 2012-06-08
+
+* Breaking changes
+
+  * Ruby 1.9 only because it uses celluloid / fibers. Use ~2 if you are on Ruby 1.8
+
+* Bug fixes
+
+  * Make sure #as_impact_query includes API key if it's been set globally
+
+* Enhancements
+
+  * When doing multiple queries, use Celluloid [worker] pools instead of creating new threads and using a homegrown futures class
+	* Use RSpec as the API testing framework
+
 2.2.3 / 2012-04-12
 
 * Enhancements

data/Gemfile

@@ -1,13 +1,3 @@
 source :rubygems
 
 gemspec
-
-# dev deps
-gem 'minitest'
-gem 'minitest-reporters'
-gem 'timeframe'
-gem 'webmock'
-gem 'aruba'
-gem 'cucumber'
-gem 'yard'
-gem 'avro'

data/Rakefile

@@ -1,13 +1,12 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
 
-require 'rake'
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test => :spec
 
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new
@@ -17,7 +16,7 @@ YARD::Rake::YardocTask.new do |y|
   y.options << '--no-private' << '--title' << "Brighter Planet CM1 client for Ruby"
 end
 
-task :default => [:test, :cucumber]
+task :default => [:spec, :cucumber]
 
 namespace :avro do
   task :setup do
@@ -33,12 +32,12 @@ namespace :avro do
     $stdout.write ary.sort.join("\n")
   end
   task :json => 'avro:setup' do
-    $stdout.write MultiJson.encode(@cm1.avro_response_schema)
+    $stdout.write MultiJson.dump(@cm1.avro_response_schema)
   end
   task :example => 'avro:setup' do
     require 'tempfile'
     file = Tempfile.new('com.brighterplanet.Cm1.example.avr')
-    parsed_schema = Avro::Schema.parse(MultiJson.encode(@cm1.avro_response_schema))
+    parsed_schema = Avro::Schema.parse(MultiJson.dump(@cm1.avro_response_schema))
     writer = Avro::IO::DatumWriter.new(parsed_schema)
     dw = Avro::DataFile::Writer.new(file, writer, parsed_schema)
     dw << AvroHelper.recursively_stringify_keys(@cm1.example)

data/carbon.gemspec

@@ -16,12 +16,24 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'activesupport'
-  s.add_runtime_dependency 'multi_json'
-  s.add_runtime_dependency 'hashie'
-  s.add_runtime_dependency 'cache_method'
-
-  # CLI
   s.add_runtime_dependency 'bombshell'
-  s.add_runtime_dependency 'conversions'
   s.add_runtime_dependency 'brighter_planet_metadata'
+  s.add_runtime_dependency 'cache_method'
+  s.add_runtime_dependency 'celluloid', '>=0.11.0'
+  s.add_runtime_dependency 'conversions'
+  s.add_runtime_dependency 'hashie'
+  s.add_runtime_dependency 'multi_json'
+
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'avro'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'timeframe'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'yard'
+  if RUBY_PLATFORM == 'java'
+    s.add_development_dependency 'jruby-openssl'
+  end
 end

data/lib/carbon.rb

@@ -1,7 +1,8 @@
 require 'active_support/core_ext'
 
+require 'carbon/query'
+require 'carbon/query_pool'
 require 'carbon/registry'
-require 'carbon/future'
 
 module Carbon
   DOMAIN = 'http://impact.brighterplanet.com'.freeze
@@ -135,63 +136,7 @@ module Carbon
   #   end
   def Carbon.query(*args)
     raise ::ArgumentError, "Don't pass a block directly - instead use Carbon.query(array).each (for example)." if block_given?
-    case Carbon.method_signature(*args)
-    when :plain_query
-      plain_query = args
-      future = Future.wrap plain_query
-      future.result
-    when :obj
-      obj = args.first
-      future = Future.wrap obj
-      future.result
-    when :array
-      array = args.first
-      futures = array.map do |obj|
-        future = Future.wrap obj
-        future.multi!
-        future
-      end
-      Future.multi(futures).inject({}) do |memo, future|
-        memo[future.object] = future.result
-        memo
-      end
-    else
-      raise ::ArgumentError, "You must pass one plain query, or one object that responds to #as_impact_query, or an array of such objects. Please check the docs!"
-    end
-  end
-
-  # Determine if a variable is a +[emitter, param]+ style "query"
-  # @private
-  def Carbon.is_plain_query?(query)
-    return false unless query.is_a?(::Array)
-    return false unless query.first.is_a?(::String) or query.first.is_a?(::Symbol)
-    return true if query.length == 1
-    return true if query.length == 2 and query.last.is_a?(::Hash)
-    false
-  end
-
-  # Determine what method signature/overloading/calling style is being used
-  # @private
-  def Carbon.method_signature(*args)
-    first_arg = args.first
-    case args.length
-    when 1
-      if is_plain_query?(args)
-        # query('Flight')
-        :plain_query
-      elsif first_arg.respond_to?(:as_impact_query)
-        # query(my_flight)
-        :obj
-      elsif first_arg.is_a?(::Array) and first_arg.all? { |obj| obj.respond_to?(:as_impact_query) or is_plain_query?(obj) }
-        # query([my_flight, my_flight])
-        :array
-      end
-    when 2
-      if is_plain_query?(args)
-        # query('Flight', :origin_airport => 'LAX')
-        :plain_query
-      end
-    end
+    Query.perform(*args)
   end
 
   # Called when you +include Carbon+ and adds the class method +emit_as+.
@@ -277,7 +222,11 @@ module Carbon
       end
       memo
     end
-    [ registration.emitter, params.merge(extra_params) ]
+    params.merge! extra_params
+    if Carbon.key and not params.has_key?(:key)
+      params[:key] = Carbon.key
+    end
+    [ registration.emitter, params ]
   end
 
   # Get an impact estimate from Brighter Planet CM1; high-level convenience method that requires a {Carbon::ClassMethods#emit_as} block.
@@ -308,7 +257,6 @@ module Carbon
   #   => "http://impact.brighterplanet.com/flights?[...]"
   def impact(extra_params = {})
     plain_query = as_impact_query extra_params
-    future = Future.wrap plain_query
-    future.result
+    Carbon.query(*plain_query)
   end
 end

data/lib/carbon/query.rb

@@ -0,0 +1,140 @@
+require 'uri'
+require 'net/http'
+require 'multi_json'
+require 'hashie/mash'
+require 'cache_method'
+
+module Carbon
+  # @private
+  class Query
+    def Query.pool
+      @pool || Thread.exclusive do
+        @pool ||= QueryPool.pool(:size => CONCURRENCY)
+      end
+    end
+
+    def Query.perform(*args)
+      case method_signature(*args)
+      when :plain_query, :obj
+        new(*args).result
+      when :array
+        queries = args.first.map do |plain_query_or_obj|
+          query = new(*plain_query_or_obj)
+          pool.perform! query
+          query
+        end
+        ticks = 0
+        begin
+          sleep(0.1*(2**ticks)) # exponential wait
+          ticks += 1
+        end until queries.all? { |query| query.done? }
+        queries.inject({}) do |memo, query|
+          memo[query.object] = query.result
+          memo
+        end
+      else
+        raise ::ArgumentError, "You must pass one plain query, or one object that responds to #as_impact_query, or an array of such objects. Please check the docs!"
+      end
+    end
+
+    # Determine if a variable is a +[emitter, param]+ style "query"
+    # @private
+    def Query.is_plain_query?(query)
+      return false unless query.is_a?(Array)
+      return false unless query.first.is_a?(String) or query.first.is_a?(Symbol)
+      return true if query.length == 1
+      return true if query.length == 2 and query.last.is_a?(Hash)
+      false
+    end
+
+    # Determine what method signature/overloading/calling style is being used
+    # @private
+    def Query.method_signature(*args)
+      first_arg = args.first
+      case args.length
+      when 1
+        if is_plain_query?(args)
+          # query('Flight')
+          :plain_query
+        elsif first_arg.respond_to?(:as_impact_query)
+          # query(my_flight)
+          :obj
+        elsif first_arg.is_a?(::Array) and first_arg.all? { |obj| obj.respond_to?(:as_impact_query) or is_plain_query?(obj) }
+          # query([my_flight, my_flight])
+          :array
+        end
+      when 2
+        if is_plain_query?(args)
+          # query('Flight', :origin_airport => 'LAX')
+          :plain_query
+        end
+      end
+    end
+
+    attr_reader :emitter
+    attr_reader :params
+    attr_reader :domain
+    attr_reader :uri
+    attr_reader :object
+
+    def initialize(*args)
+      case Query.method_signature(*args)
+      when :plain_query
+        @object = args
+        @emitter, @params = *args
+      when :obj
+        @object = args.first
+        @emitter, @params = *object.as_impact_query
+      else
+        raise ArgumentError, "Carbon::Query.new must be called with a plain query or an object that responds to #as_impact_query"
+      end
+      @params ||= {}
+      @domain = params.delete(:domain) || Carbon.domain
+      if Carbon.key and not params.has_key?(:key)
+        params[:key] = Carbon.key
+      end
+      @uri = URI.parse("#{domain}/#{emitter.underscore.pluralize}.json")
+    end
+
+    def done?
+      not @result.nil? or cache_method_cached?(:result)
+    end
+
+    def result(extra_params = {})
+      @result ||= get_result(extra_params)
+    end
+    cache_method :result, 3_600 # one hour
+
+    def as_cache_key
+      [ @domain, @emitter, @params ]
+    end
+
+    def hash
+      as_cache_key.hash
+    end
+
+    def eql?(other)
+      as_cache_key == other.as_cache_key
+    end
+    alias :== :eql?
+
+    private
+
+    def get_result(extra_params = {})
+      raw = Net::HTTP.post_form uri, params.merge(extra_params)
+      code = raw.code.to_i
+      body = raw.body
+      memo = Hashie::Mash.new
+      memo.code = code
+      case code
+      when (200..299)
+        memo.success = true
+        memo.merge! MultiJson.load(body)
+      else
+        memo.success = false
+        memo.errors = [body]
+      end
+      memo
+    end
+  end
+end

data/lib/carbon/query_pool.rb

@@ -0,0 +1,11 @@
+require 'celluloid'
+
+module Carbon
+  class QueryPool
+    include Celluloid
+
+    def perform(query)
+      query.result
+    end
+  end
+end

data/lib/carbon/shell/emitter.rb

@@ -10,7 +10,7 @@ module Carbon
       class << self
         # @private
         def characteristics(emitter)
-          ::MultiJson.decode ::Net::HTTP.get(::URI.parse("http://impact.brighterplanet.com/#{emitter.underscore.pluralize}/options.json"))
+          ::MultiJson.load ::Net::HTTP.get(::URI.parse("http://impact.brighterplanet.com/#{emitter.underscore.pluralize}/options.json"))
         rescue
           # oops
         end

data/lib/carbon/version.rb

@@ -1,3 +1,3 @@
 module Carbon
-  VERSION = "2.2.3"
+  VERSION = "3.0.0"
 end

data/spec/carbon/query_spec.rb

@@ -0,0 +1,106 @@
+require 'helper'
+require 'carbon/query'
+require 'my_nissan_altima'
+
+describe Carbon::Query do
+  let(:query) { Carbon::Query.new 'Flight' }
+
+  describe '#as_impact_query' do
+    it 'sets up an query to be run by Carbon.query' do
+      a = MyNissanAltima.new(2006)
+      a.as_impact_query.should == ["Automobile", {:make=>"Nissan", :model=>"Altima", :year=>2006, "automobile_fuel[code]"=>"R", :key=>Carbon.key}]
+    end
+    it 'only includes non-nil params' do
+      a = MyNissanAltima.new(2006)
+      a.as_impact_query[1].keys.should include(:year)
+      a.as_impact_query[1].keys.should_not include(:nil_model)
+      a.as_impact_query[1].keys.should_not include(:nil_make)
+    end
+    it 'includes Carbon.key' do
+      begin
+        random_key = rand(1e11)
+        old_carbon_key = Carbon.key
+        Carbon.key = random_key
+        a = MyNissanAltima.new(2006)
+        a.as_impact_query[1][:key].should == random_key
+      ensure
+        Carbon.key = old_carbon_key
+      end
+    end
+    it "allows key to be set" do
+      begin
+        random_key = rand(1e11)
+        old_carbon_key = Carbon.key
+        Carbon.key = random_key
+        a = MyNissanAltima.new(2006)
+        a.as_impact_query(:key => 'i want to use this key!')[1][:key].should == 'i want to use this key!'
+      ensure
+        Carbon.key = old_carbon_key
+      end
+    end
+
+  end
+
+  describe '.method_signature' do
+    it 'recognizes emitter_param' do
+      Carbon::Query.method_signature('Flight').should == :plain_query
+      Carbon::Query.method_signature('Flight', :origin_airport => 'LAX').should == :plain_query
+      Carbon::Query.method_signature(:flight).should == :plain_query
+      Carbon::Query.method_signature(:flight, :origin_airport => 'LAX').should == :plain_query
+    end
+    it 'recognizes an object' do
+      Carbon::Query.method_signature(MyNissanAltima.new(2006)).should == :obj
+    end
+    it 'recognizes an array of signatures' do
+      Carbon::Query.method_signature([MyNissanAltima.new(2001)]).should == :array
+      Carbon::Query.method_signature([['Flight']]).should == :array
+      Carbon::Query.method_signature([['Flight', {:origin_airport => 'LAX'}]]).should == :array
+      Carbon::Query.method_signature([['Flight'], ['Flight']]).should == :array
+      Carbon::Query.method_signature([['Flight', {:origin_airport => 'LAX'}], ['Flight', {:origin_airport => 'LAX'}]]).should == :array
+      [MyNissanAltima.new(2006), ['Flight'], ['Flight', {:origin_airport => 'LAX'}]].permutation.each do |p|
+        Carbon::Query.method_signature(p).should == :array
+      end
+    end
+    it "does not accept splats for concurrent queries" do
+      Carbon::Query.method_signature(['Flight'], ['Flight']).should be_nil
+      Carbon::Query.method_signature(MyNissanAltima.new(2001), MyNissanAltima.new(2001)).should be_nil
+      [MyNissanAltima.new(2006), ['Flight'], ['Flight', {:origin_airport => 'LAX'}]].permutation.each do |p|
+        Carbon::Query.method_signature(*p).should be_nil
+      end
+    end
+    it "does not like weirdness" do
+      Carbon::Query.method_signature('Flight', 'Flight').should be_nil
+      Carbon::Query.method_signature('Flight', ['Flight']).should be_nil
+      Carbon::Query.method_signature(['Flight'], 'Flight').should be_nil
+      Carbon::Query.method_signature(['Flight', 'Flight']).should be_nil
+      Carbon::Query.method_signature(['Flight', ['Flight']]).should be_nil
+      Carbon::Query.method_signature([['Flight'], 'Flight']).should be_nil
+      Carbon::Query.method_signature(MyNissanAltima.new(2001), [MyNissanAltima.new(2001)]).should be_nil
+      Carbon::Query.method_signature([MyNissanAltima.new(2001)], MyNissanAltima.new(2001)).should be_nil
+      Carbon::Query.method_signature([MyNissanAltima.new(2001)], [MyNissanAltima.new(2001)]).should be_nil
+      Carbon::Query.method_signature([MyNissanAltima.new(2001), [MyNissanAltima.new(2001)]]).should be_nil
+      Carbon::Query.method_signature([[MyNissanAltima.new(2001)], MyNissanAltima.new(2001)]).should be_nil
+      Carbon::Query.method_signature([[MyNissanAltima.new(2001)], [MyNissanAltima.new(2001)]]).should be_nil
+    end
+  end
+
+  describe '.perform' do
+    it 'returns a single result for a single query' do
+      VCR.use_cassette 'Flight', :record => :once do
+        Carbon::Query.perform('Flight').should be_a(Hashie::Mash)
+      end
+    end
+    it 'returns a hash of queries and results for multiple queries' do
+      results = nil
+      VCR.use_cassette 'Flight and Automobile', :record => :once do
+        results = Carbon::Query.perform([['Flight'], ['Automobile']])
+      end
+      results.length.should == 2
+      results.keys.should == [['Flight'], ['Automobile']]
+      results.values.each do |val|
+        val.should be_a(Hashie::Mash)
+      end
+    end
+  end
+end
+