tom 0.1.0 → 0.1.1

data/.rvmrc

@@ -1 +1 @@
-rvm --create use ruby-1.9.2-p290@leonard
+rvm --create use ruby-1.9.2-p290@tom

data/Gemfile

@@ -4,9 +4,8 @@ group :default do
   gem "goliath"
   gem "em-synchrony"
   gem "em-http-request"
-  gem "mp-deployment", "0.0.21"
   gem "json"
-  gem "rake"
+  gem "rake", "~> 0.9.2"
 end
 
 # Add dependencies to develop your gem here.
@@ -20,4 +19,5 @@ group :development do
   gem "rspec"
   gem "webmock"
   gem "yard"
+  gem "rdiscount"
 end

data/Gemfile.lock

@@ -5,14 +5,6 @@ GEM
     archive-tar-minitar (0.5.2)
     async-rack (0.5.1)
       rack (~> 1.1)
-    capistrano (2.5.21)
-      highline
-      net-scp (>= 1.0.0)
-      net-sftp (>= 2.0.0)
-      net-ssh (>= 2.0.14)
-      net-ssh-gateway (>= 1.0.0)
-    capistrano-ext (1.2.1)
-      capistrano (>= 1.0.0)
     columnize (0.3.5)
     crack (0.3.1)
     diff-lcs (1.1.3)
@@ -26,7 +18,6 @@ GEM
     em-synchrony (1.0.0)
       eventmachine (>= 1.0.0.beta.1)
     eventmachine (1.0.0.beta.4)
-    facter (1.6.3)
     git (1.2.5)
     goliath (0.9.4)
       async-rack
@@ -39,8 +30,6 @@ GEM
       rack (>= 1.2.2)
       rack-contrib
       rack-respond_to
-    hashie (1.0.0)
-    highline (1.6.8)
     http_parser.rb (0.5.3)
     http_router (0.9.7)
       rack (>= 1.0.0)
@@ -53,23 +42,7 @@ GEM
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
     log4r (1.1.9)
-    mp-deployment (0.0.21)
-      capistrano (~> 2.5.20)
-      capistrano-ext (~> 1.2.1)
-      facter (~> 1.6.0)
-      hashie (~> 1.0.0)
-      newrelic_rpm (~> 3.3.0)
-      rpm_contrib (~> 2.1.3)
-      rvm (~> 1.6.20)
     multi_json (1.0.3)
-    net-scp (1.0.4)
-      net-ssh (>= 1.99.1)
-    net-sftp (2.0.5)
-      net-ssh (>= 2.0.9)
-    net-ssh (2.2.1)
-    net-ssh-gateway (1.1.0)
-      net-ssh (>= 1.99.1)
-    newrelic_rpm (3.3.0)
     rack (1.3.5)
     rack-accept-media-types (0.9)
     rack-contrib (1.1.0)
@@ -78,9 +51,7 @@ GEM
       rack-accept-media-types (>= 0.6)
     rake (0.9.2.2)
     rcov (0.9.11)
-    rpm_contrib (2.1.6)
-      newrelic_rpm (>= 3.1.1)
-      newrelic_rpm (>= 3.1.1)
+    rdiscount (1.6.8)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -99,7 +70,6 @@ GEM
       ruby-debug-base19 (>= 0.11.19)
     ruby_core_source (0.1.5)
       archive-tar-minitar (>= 0.5.2)
-    rvm (1.6.32)
     shoulda (2.11.3)
     url_mount (0.2.1)
       rack
@@ -118,9 +88,9 @@ DEPENDENCIES
   goliath
   jeweler (~> 1.6.4)
   json
-  mp-deployment (= 0.0.21)
-  rake
+  rake (~> 0.9.2)
   rcov
+  rdiscount
   rspec
   ruby-debug19
   shoulda

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/adapter.rb

@@ -7,14 +7,18 @@ module Tom
       attr_accessor :host
     end
 
+    # Registers a route with the request dispatcher
+    # so that this classes subclass gets called when
+    # a request is made. One that matches the route.
     #
-    #  Registers a route with the request dispatcher
-    #  so that this classes subclass gets called when
-    #  a request is made. One that matches the route.
-    #
-    #  The route can be a string, but it becomes a 
-    #  regular expression in here, followed by methods.
+    # The route can be a string, but it becomes a 
+    # regular expression in here, followed by methods.
     #
+    # @param route [String] The route this Adapter should 
+    #   respond to.
+    # @param methods [Array<Symbol>] Optional array of methods
+    #   that this Adapter is listening to. It defaults to
+    #   all (`:head`, `:get`, `:put`, `:post`, `:delete`)
     def self.register_route(*args)
       route = args[0]
       methods = args[1..-1]
@@ -25,11 +29,12 @@ module Tom
       @request = {}
     end
 
+    # Takes a request from rack and issues the same
+    # request again, just to a different host. This
+    # method is to be used by subclasses.
     #
-    #  Takes a request from rack and issues the same
-    #  request again, just to a different host. This
-    #  method is to be used by subclasses.
-    #
+    # @param env [Array] The incoming (original request) 
+    #   rack env object
     def forward_request(env)
       rewrite_request(env)
       options = http_request_options(env)
@@ -41,14 +46,14 @@ module Tom
       [result.response_header.status, headers, result.response]
     end
 
+    # Takes a request and generates the options for calling
+    # HttpRequest.put (or whatever the the requested
+    # REQUEST_METHOD is).
     #
-    #  Takes a request and generates the options for calling
-    #  HttpRequest.put (or whatever the the requested
-    #  REQUEST_METHOD is).
-    #
-    #  It's content depends on the request method, for PUTs
-    #  and POSTs this will add the request body
+    # It's content depends on the request method, for PUTs
+    # and POSTs this will add the request body
     #
+    # @param env [Array] A rack env object
     def http_request_options(env)
       opts = {}
       if [:put, :post].include? @request[:method]
@@ -57,35 +62,40 @@ module Tom
       opts
     end
 
+    # Extracts the given POT/PUST (hehe) body
     #
-    #  Extracts the given POT/PUST (hehe) body
-    #
+    # @param env [Array] A rack env object
     def extract_request_body(env)
       Rack::Request.new(env).POST.keys.first rescue "{}"
     end
 
+    # Takes a request from rack and extracts the request
+    # method, uri and returns the host this adapter talks
+    # to. Can be overwritten if you want to change stuff
+    # before forwarding it.
     #
-    #  Takes a request from rack and extracts the request
-    #  method, uri and returns the host this adapter talks
-    #  to. Can be overwritten if you want to change stuff
-    #  before forwarding it.
-    #
+    # @param env [Array] A rack env object
     def rewrite_request(env)
       rewritten = rewrite_host(env)
       @request = rewritten.merge(@request)
     end
 
+    # Subclasses must implement this method to handle incoming
+    # requests
+    #
+    # @param env [Array] The incoming (original request) 
+    #   rack env object
     def handle(env)
       raise "Subclass, implement #handle(env)!"
     end
 
     private
 
+    # Returns a hash that can be used as the @request variable,
+    # which is exactly like the given env except for a changed
+    # hostname.
     #
-    #  Returns a hash that can be used as the @request variable,
-    #  which is exactly like the given env except for a changed
-    #  hostname.
-    #
+    # @param env [Array] A rack env object
     def rewrite_host(env)
       { host:   self.class.host,
         uri:    env["REQUEST_URI"],

data/lib/dispatcher.rb

@@ -13,11 +13,12 @@ module Tom
 
   class Dispatcher
 
+    # Dispatches this request to all adapters that registered
+    # for the route and then calls the merger for this route
+    # to compose a response
     #
-    #  Dispatches this request to all adapters that registered
-    #  for the route and then calls the merger for this route
-    #  to compose a response
-    #
+    # @param env [Array] A rack env object
+    # @return (see #merge)
     def self.dispatch(env)
       adapters = adapters_for_route(env)
       return [404, {}, '{reason: "No adapters for this route"}'] if adapters.empty?
@@ -36,13 +37,16 @@ module Tom
       merged
     end
 
+    # Takes a request (rack env) and a couple of responses
+    # generated by api adapters and composes a response for the
+    # client.
     #
-    #  Takes a request (rack env) and a couple of responses
-    #  generated by api adapters and composes a response for the
-    #  client.
-    #
-    #  The merger used depends on the route.
+    # The merger used depends on the route.
     #
+    # @param env [Array] A rack env object
+    # @return [Array] The merged result of all requests
+    #   made as an array of status code, headers and body, e.g.
+    #   `[200, {}, "Hi!"]`
     def self.merge(env, responses)
       merger = merger_for_route(env)
       Tom::LOG.info "Merging with:"
@@ -50,13 +54,17 @@ module Tom
       merger.new.merge env, responses
     end
 
+    # Registers a opts[:adapter] or opts[:merger] for the 
+    # given opts[:route].
     #
-    #  Registers a opts[:adapter] or opts[:merger] for the 
-    #  given opts[:route].
-    #
-    #  This method should not be called directly, use register_route
-    #  in Tom::Adapter or Tom::Merger instead.
+    # This method should not be called directly, use register_route
+    # in Tom::Adapter or Tom::Merger instead.
     #
+    # @param opts [Hash] Needs to have at least `:route` and 
+    #   either `:adapter` or `:merger` set, depending on what you
+    #   are registering. But you don't need to use this method 
+    #   directly, Adapter and Merger provide convenience methods
+    #   for you.
     def self.register(opts)
       return register_adapter(opts) if opts[:adapter]
       return register_merger(opts)  if opts[:merger]

data/lib/http.rb

@@ -1,12 +1,16 @@
 module Tom
   module Http
 
+    # Makes a http request of the given method to the given url.
+    # Passes the options on to EM::HttpRequest.put (or whatever
+    # method has to be called) and does some error handling and
+    # works around some EM:HttpRequest oddities (see handle_errors).
     #
-    #  Makes a http request of the given method to the given url.
-    #  Passes the options on to EM::HttpRequest.put (or whatever
-    #  method has to be called) and does some error handling and
-    #  works around some EM:HttpRequest oddities (see handle_errors).
-    #
+    # @param method [Symbol] Request method, lowercase, you know
+    #   the deal
+    # @param url [String] Full url (e.g. host + path)
+    # @param options [Hash] Options to pass to EM::HttpRequest's 
+    #   get/put/post/delete method
     def self.make_request(method, url, options = {})
       Tom::LOG.info "     curl -X#{method.upcase} -d '#{options[:body]}' #{url}"
 

data/lib/merger.rb

@@ -1,32 +1,37 @@
 module Tom
   class Merger
 
+    # Registers a route with the request dispatcher
+    # so that this classes subclass gets called when
+    # a request is made. One that matches the route.
     #
-    #  Registers a route with the request dispatcher
-    #  so that this classes subclass gets called when
-    #  a request is made. One that matches the route.
-    #
-    #  The route can be a string, but it becomes a 
-    #  regular expression in here. When matching in
-    #  order to find a merger for a request, the first
-    #  one matching wins.
+    # The route can be a string, but it becomes a 
+    # regular expression in here. When matching in
+    # order to find a merger for a request, the first
+    # one matching wins.
     #
+    # @param route [String] The route this Merger should 
+    #   respond to.
+    # @param methods [Array<Symbol>] Optional array of methods
+    #   that this Merger is listening to. It defaults to
+    #   all (`:head`, `:get`, `:put`, `:post`, `:delete`)
     def self.register_route(*args)
       route = args[0]
       methods = args[1..-1]
       Dispatcher.register(route: /#{route}/, merger: self, methods: methods)
     end
 
+    # When the request dispatcher made all the requests,
+    # it will call the merge method of the subclass with
+    # the responses as a hash in the form
     #
-    #  When the request dispatcher made all the requests,
-    #  it will call the merge method of the subclass with
-    #  the responses as a hash in the form
-    #
-    #  {MyAdapter: rack_env, MyOtherAdapter: other_env}
-    #
-    #  Has to return a rack response (for example, something
-    #  like [200, {}, "body"])
-    #
+    # @param env [Array] The incoming (original request) 
+    #   rack env object
+    # @param responses [Hash] Replies from all Adapters that
+    #   got triggered by route and method, e.g.
+    #   `{MyAdapter: rack_env, MyOtherAdapter: other_env}`
+    # @return [Array] A rack response (for example, something
+    #   like [200, {}, "body"])
     def merge(env, responses)
       raise "Subclass, implement #merge(env, responses)!"
     end

data/tom.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = "tom"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jannis Hermanns"]
-  s.date = "2011-12-02"
+  s.date = "2011-12-03"
   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 = [
     "LICENSE.txt",
-    "README.markdown"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.markdown",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/adapter.rb",
@@ -49,9 +49,8 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<goliath>, [">= 0"])
       s.add_runtime_dependency(%q<em-synchrony>, [">= 0"])
       s.add_runtime_dependency(%q<em-http-request>, [">= 0"])
-      s.add_runtime_dependency(%q<mp-deployment>, ["= 0.0.21"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, ["~> 0.9.2"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
@@ -60,13 +59,13 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rdiscount>, [">= 0"])
     else
       s.add_dependency(%q<goliath>, [">= 0"])
       s.add_dependency(%q<em-synchrony>, [">= 0"])
       s.add_dependency(%q<em-http-request>, [">= 0"])
-      s.add_dependency(%q<mp-deployment>, ["= 0.0.21"])
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rake>, ["~> 0.9.2"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<shoulda>, [">= 0"])
@@ -75,14 +74,14 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rdiscount>, [">= 0"])
     end
   else
     s.add_dependency(%q<goliath>, [">= 0"])
     s.add_dependency(%q<em-synchrony>, [">= 0"])
     s.add_dependency(%q<em-http-request>, [">= 0"])
-    s.add_dependency(%q<mp-deployment>, ["= 0.0.21"])
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rake>, ["~> 0.9.2"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<shoulda>, [">= 0"])
@@ -91,6 +90,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rdiscount>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tom
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-02 00:00:00.000000000Z
+date: 2011-12-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
-  requirement: &70256849153920 !ruby/object:Gem::Requirement
+  requirement: &70331478259800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256849153920
+  version_requirements: *70331478259800
 - !ruby/object:Gem::Dependency
   name: em-synchrony
-  requirement: &70256849153340 !ruby/object:Gem::Requirement
+  requirement: &70331478259160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256849153340
+  version_requirements: *70331478259160
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70256849152840 !ruby/object:Gem::Requirement
+  requirement: &70331478258580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,21 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256849152840
-- !ruby/object:Gem::Dependency
-  name: mp-deployment
-  requirement: &70256849152280 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
-        version: 0.0.21
-  type: :runtime
-  prerelease: false
-  version_requirements: *70256849152280
+  version_requirements: *70331478258580
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70256849151680 !ruby/object:Gem::Requirement
+  requirement: &70331478258020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,21 +54,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256849151680
+  version_requirements: *70331478258020
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70256849151080 !ruby/object:Gem::Requirement
+  requirement: &70331478257520 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *70256849151080
+  version_requirements: *70331478257520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70256849150560 !ruby/object:Gem::Requirement
+  requirement: &70331478257040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70256849150560
+  version_requirements: *70331478257040
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70256849150000 !ruby/object:Gem::Requirement
+  requirement: &70331478256480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +87,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70256849150000
+  version_requirements: *70331478256480
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70256849149420 !ruby/object:Gem::Requirement
+  requirement: &70331478255940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256849149420
+  version_requirements: *70331478255940
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70256849148740 !ruby/object:Gem::Requirement
+  requirement: &70331478255420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256849148740
+  version_requirements: *70331478255420
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70256849148120 !ruby/object:Gem::Requirement
+  requirement: &70331478254880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256849148120
+  version_requirements: *70331478254880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70256849147600 !ruby/object:Gem::Requirement
+  requirement: &70331478254360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256849147600
+  version_requirements: *70331478254360
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70256849147020 !ruby/object:Gem::Requirement
+  requirement: &70331478253820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +142,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256849147020
+  version_requirements: *70331478253820
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70256849146400 !ruby/object:Gem::Requirement
+  requirement: &70331478253300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70331478253300
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70331478252780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70256849146400
+  version_requirements: *70331478252780
 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.'
@@ -173,14 +173,14 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.markdown
+- README.md
 files:
 - .document
 - .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.markdown
+- README.md
 - Rakefile
 - VERSION
 - lib/adapter.rb
@@ -208,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4016356889838983520
+      hash: 480202980293159198
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: