tom 0.2.1 → 0.2.2

data/README.md

@@ -49,6 +49,8 @@ This class basically does what is pictured in the flow above:
 
 To add APIs or change the behavior of Tom, you don't have to touch this class, though. `Adapter` and `Merger` is what you're looking for.
 
+Adapters are optional, so it's completely valid for a route to only have a merger. If, however, there is no merger registered for a given route, a 404 will be emitted.
+
 ## Tom::Adapter
 
 The `Adapter` class comes with the class methods:
@@ -115,6 +117,7 @@ Same goes for mergers.
 
 # Todo
 
+- document special headers we inject (e.g. which adapters were used, etc)
 - handle adapter errors/states in mergers
 - use Goliath::Rack::Heartbeat
 - think about consensus protocols

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/dispatcher.rb

@@ -11,21 +11,18 @@ module Tom
     #
     # @return [Array] Whatever {Tom::Dispatcher.merge} had to say
     def self.dispatch(env)
-      route, method = route_and_method(env)
-      adapters = Tom::Routes.adapters_for_route(route, method)
-      return [404, {}, '{reason: "No adapters for this route"}'] if adapters.empty?
 
-      # Hit APIs. All at the same time. Oh, mygodd!
-      responses = {}
+      # 1. hit APIs. All at the same time. Oh, mygodd!
       Tom::LOG.info "#{env['REQUEST_METHOD'].upcase} #{env['REQUEST_URI']}"
-      Tom::LOG.info "Dispatching to:"
-      EM::Synchrony::FiberIterator.new(adapters, adapters.count).map do |clazz|
-        Tom::LOG.info "  -> #{clazz}"
-        (responses[clazz] ||= []) <<  clazz.new.handle(env)
-      end
+      responses = parallel_adapter_dispatch(env)
 
+      # 2. merge
       merged = merge(env, responses)
+
+      # 3. ???
       Tom::LOG.info "-------------------------------------------------------n"
+
+      # 4. profit
       merged
     end
 
@@ -42,10 +39,15 @@ module Tom
     #   [200, {}, "Hi!"]
     def self.merge(env, responses)
       route, method = route_and_method(env)
-      merger = Tom::Routes.merger_for_route(route, method)
-      Tom::LOG.info "Merging with:"
-      Tom::LOG.info "  -> #{merger}"
-      merger.new.merge env, responses
+      if merger = Tom::Routes.merger_for_route(route, method)
+        Tom::LOG.info "Merging with:"
+        Tom::LOG.info "  -> #{merger}"
+        merged = merger.new.merge(env, responses)
+      else
+        merged = [404, {}, ""]
+      end
+      merged[1]["Adapters-Used"] = responses.keys.join(",")
+      merged
     end
 
 
@@ -61,5 +63,28 @@ module Tom
        env["REQUEST_METHOD"].downcase.to_sym]
     end
 
+    private
+
+    # Uses a EM::Synchrony::FiberIterator to call all adapters that registered
+    # for this route at the same time.
+    #
+    # @param env [Hash] A rack env object
+    #
+    # @return [Hash] Keys are the adapter classes, values are arrays of responses
+    #   they generated (the [status_code, headers, body] triplets)
+    def self.parallel_adapter_dispatch(env)
+      responses = {}
+      route, method = route_and_method(env)
+      adapters = Tom::Routes.adapters_for_route(route, method)
+      return responses if adapters.empty?
+
+      Tom::LOG.info "Dispatching to:"
+      EM::Synchrony::FiberIterator.new(adapters, adapters.count).map do |clazz|
+        Tom::LOG.info "  -> #{clazz}"
+        (responses[clazz] ||= []) <<  clazz.new.handle(env)
+      end
+      responses
+    end
+
   end
 end

data/lib/http.rb

@@ -30,7 +30,7 @@ module Tom
 
     def self.handle_errors(method, url, result)
       result.errback do
-        raise "Tom::Adapter.forward_request error #{method} #{url}"
+        raise "Tom::Adapter.forward_request error '#{result.error}' for #{method} #{url}"
       end
       return unless result.response_header.status == 0
       raise "EM::HttpRequest returned response code 0 for #{url} - timeout?"

data/lib/tom/routes.rb

@@ -122,7 +122,7 @@ module Tom
         next unless reg_route.match(route)
         return mergers.first
       end
-      raise "Found no merger for route #{route}"
+      nil
     end
 
     #

data/spec/lib/dispatcher_spec.rb

@@ -12,9 +12,6 @@ class APIAdapter2 <  Tom::Adapter
 end
 APIAdapter2.host = 'http://api_host_2.com'
 
-class Merger < Tom::Merger
-  register_route ".*"
-end
 
 describe Tom do
 
@@ -22,9 +19,16 @@ describe Tom do
 
   end
 
-  it "emits a 404 when there are no adapters for the route" do
+  it "emits a 200 even when there are no adapters for the route" do
     with_api(Tom::GoliathAPI) do
       request = get_request(:path => '/walruses/5')
+      request.response_header.status.should == 200
+    end
+  end
+
+  it "emits a 404 when there are no mergers for the route" do
+    with_api(Tom::GoliathAPI) do
+      request = get_request(:path => '/')
       request.response_header.status.should == 404
     end
   end

data/spec/spec_helper.rb

@@ -35,6 +35,6 @@ end
 require_relative '../lib/tom'
 
 class Merger < Tom::Merger
-  register_route ".*"
+  register_route "^/.+$"
   def merge(a,b);[200, {}, ""]; end
 end

data/tom.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "tom"
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jannis Hermanns"]
-  s.date = "2011-12-07"
+  s.date = "2011-12-09"
   s.description = " Tom uses Goliath to dispatch HTTP requests to multiple other APIs (via Adapters) in parallel. In a next step, a Merger merges the result and responds to the clients request."
   s.email = "jannis@gmail.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tom
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-07 00:00:00.000000000Z
+date: 2011-12-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
-  requirement: &70109120203120 !ruby/object:Gem::Requirement
+  requirement: &70294091681900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109120203120
+  version_requirements: *70294091681900
 - !ruby/object:Gem::Dependency
   name: em-synchrony
-  requirement: &70109120202620 !ruby/object:Gem::Requirement
+  requirement: &70294091681320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109120202620
+  version_requirements: *70294091681320
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70109120202140 !ruby/object:Gem::Requirement
+  requirement: &70294091680840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109120202140
+  version_requirements: *70294091680840
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70109120201560 !ruby/object:Gem::Requirement
+  requirement: &70294091680220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109120201560
+  version_requirements: *70294091680220
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70109120201040 !ruby/object:Gem::Requirement
+  requirement: &70294091679620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *70109120201040
+  version_requirements: *70294091679620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70109120200460 !ruby/object:Gem::Requirement
+  requirement: &70294091679080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70109120200460
+  version_requirements: *70294091679080
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70109120199960 !ruby/object:Gem::Requirement
+  requirement: &70294091678600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70109120199960
+  version_requirements: *70294091678600
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70109120199420 !ruby/object:Gem::Requirement
+  requirement: &70294091677960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109120199420
+  version_requirements: *70294091677960
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70109120198820 !ruby/object:Gem::Requirement
+  requirement: &70294091677440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109120198820
+  version_requirements: *70294091677440
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70109120198220 !ruby/object:Gem::Requirement
+  requirement: &70294091676940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109120198220
+  version_requirements: *70294091676940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70109120197620 !ruby/object:Gem::Requirement
+  requirement: &70294091667620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109120197620
+  version_requirements: *70294091667620
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70109120197020 !ruby/object:Gem::Requirement
+  requirement: &70294091667000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109120197020
+  version_requirements: *70294091667000
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70109120196420 !ruby/object:Gem::Requirement
+  requirement: &70294091666380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109120196420
+  version_requirements: *70294091666380
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70109120195780 !ruby/object:Gem::Requirement
+  requirement: &70294091665740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109120195780
+  version_requirements: *70294091665740
 description: ! ' Tom uses Goliath to dispatch HTTP requests to multiple other APIs
   (via Adapters) in parallel. In a next step, a Merger merges the result and responds
   to the clients request.'
@@ -212,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1267034355888235248
+      hash: -4134106071848066876
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: