webmachine 0.4.0 → 0.4.1

data/README.md

@@ -29,12 +29,17 @@ application for it!
 require 'webmachine'
 # Require any of the files that contain your resources here
 require 'my_resource' 
- 
-# Point all URIs at the MyResource class
-Webmachine::Dispatcher.add_route(['*'], MyResource)
- 
+
+# Create an application which encompasses routes and configruation
+MyApp = Webmachine::Application.new do |app|
+  app.routes do
+    # Point all URIs at the MyResource class
+    add ['*'], MyResource
+  end
+end
+
 # Start the server, binds to port 8080 using WEBrick
-Webmachine.run 
+MyApp.run
 ```
 
 Your resource will look something like this:
@@ -68,29 +73,31 @@ end
 There are many other HTTP features exposed to your resource through
 {Webmachine::Resource::Callbacks}. Give them a try!
 
-### Configurator
+### Application/Configurator
 
 There's a configurator that allows you to set the ip address and port
 bindings as well as a different webserver adapter.  You can also add
-your routes in a block. Both of these call return the `Webmachine`
-module, so you could chain them if you like.
+your routes in a block (as shown above). Both of these call return the
+`Webmachine::Application` instance, so you could chain them if you
+like. If you don't want to create your own separate application
+object, `Webmachine.application` will return a global one.
 
 ```ruby
 require 'webmachine'
 require 'my_resource'
  
-Webmachine.routes do
+Webmachine.application.routes do
   add ['*'], MyResource
 end
 
-Webmachine.configure do |config|
+Webmachine.application.configure do |config|
   config.ip = '127.0.0.1'
   config.port = 3000
   config.adapter = :Mongrel
 end
  
 # Start the server.
-Webmachine.run
+Webmachine.application.run
 ```
 
 ## Features
@@ -115,6 +122,46 @@ Webmachine.run
 
 ## Changelog
 
+### 0.4.1 February 8, 2012
+
+0.4.1 is a bugfix release that corrects a few minor issues. Added Sam
+Goldman as a contributor. Thank you for your contributions!
+
+* Updated README with `Webmachine::Application` examples.
+* The CGI env vars `CONTENT_LENGTH` and `CONTENT_TYPE` are now being
+  correctly converted into their Webmachine equivalents.
+* The request body given via the Rack and Mongrel adapters now
+  responds to `#to_s` and `#each` so it can be treated like a `String`
+  or `Enumerable` that yields chunks.
+
+### 0.4.0 February 5, 2012
+
+0.4.0 includes some important refactorings, isolating the idea of
+global state into an Application object with its own Dispatcher and
+configuration, and making Adapters into real classes with a consistent
+interface. It also adds some query methods on the Request object for
+the HTTP method and scheme and Route guards (matching predicates).
+Added Michael Maltese, Emmanuel Gomez, and Bernerd Schaefer as
+committers. Thank you for your contributions!
+
+* Fixed `Request#query` to handle nil values for the URI query accessor.
+* `Webmachine::Dispatcher` is a real class rather than a module with
+  state.
+* `Webmachine::Application` is a class that includes its own
+  dispatcher and configuration. The default instance is accessible via
+  `Webmachine.application`.
+* `Webmachine::Adapter` is now the superclass of all implemented
+  adapters so that they have a uniform interface.
+* The Mongrel spec is skipped on JRuby since version 1.2 (pre-release)
+  doesn't work. Direct Mongrel support may be removed in a later
+  release.
+* `Webmachine::Dispatcher::Route` now accepts guards, which may be
+  expressed as lambdas/procs or any object responding to `call`
+  preceding the `Resource` class in the route definition, or as a
+  trailing block. All guards will be passed the `Request` object when
+  matching the route and should return a truthy or falsey value
+  (without side-effects).
+
 ### 0.3.0 November 9, 2011
 
 0.3.0 introduces some new features, refactorings, and now has 100%

data/b/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/b/gpgen

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'gpgen' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('gem_plugin', 'gpgen')

data/b/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/b/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/b/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/b/mongrel_rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'mongrel_rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('mongrel', 'mongrel_rails')

data/b/rackup

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rack', 'rackup')

data/b/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/b/rake2thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake2thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'rake2thor')

data/b/redcarpet

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'redcarpet' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('redcarpet', 'redcarpet')

data/b/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/b/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('thor', 'thor')

data/b/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/b/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/b/yri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yri')

data/lib/webmachine/adapters/mongrel.rb

@@ -31,7 +31,7 @@ module Webmachine
       class Handler < ::Mongrel::HttpHandler
         def initialize(dispatcher)
           @dispatcher = dispatcher
-          super
+          super()
         end
 
         # Processes an individual request from Mongrel through Webmachine.
@@ -41,7 +41,7 @@ module Webmachine
           request = Webmachine::Request.new(wreq.params["REQUEST_METHOD"],
                                             URI.parse(wreq.params["REQUEST_URI"]),
                                             header,
-                                            wreq.body || StringIO.new(''))
+                                            RequestBody.new(wreq))
 
           response = Webmachine::Response.new
           @dispatcher.dispatch(request, response)
@@ -81,6 +81,31 @@ module Webmachine
         end
       end # class Handler
 
+      # Wraps a Mongrel request body so that it can behave like a
+      # String.
+      # @api private
+      class RequestBody
+        # @return the request from Mongrel
+        attr_reader :request
+
+        # @param request the request from Mongrel
+        def initialize(request)
+          @request = request
+        end
+
+        # @return [String] the request body as a string
+        def to_s
+          request.body.rewind
+          request.body.read
+        end
+
+        # @yield [chunk]
+        # @yieldparam [String] chunk a chunk of the request body
+        def each(&block)
+          request.body.each(&block)
+        end
+      end # class RequestBody
+
     end # module Mongrel
   end # module Adapters
 end # module Webmachine

data/lib/webmachine/adapters/rack.rb

@@ -51,7 +51,7 @@ module Webmachine
         request = Webmachine::Request.new(rack_req.request_method,
                                           URI.parse(rack_req.url),
                                           headers,
-                                          rack_req.body)
+                                          RequestBody.new(rack_req))
 
         response = Webmachine::Response.new
         @dispatcher.dispatch(request, response)
@@ -63,6 +63,42 @@ module Webmachine
 
         [response.code.to_i, response.headers, body || []]
       end
+
+      # Wraps the Rack input so it can be treated like a String or
+      # Enumerable.
+      # @api private
+      class RequestBody
+        # @param [Rack::Request] request the Rack request
+        def initialize(request)
+          @request = request
+        end
+
+        # Converts the body to a String so you can work with the entire
+        # thing.
+        # @return [String] the request body as a string
+        def to_s
+          if @value
+            @value.join
+          else
+            @request.body.rewind
+            @request.body.read
+          end
+        end
+
+        # Iterates over the body in chunks. If the body has previously
+        # been read, this method can be called again and get the same
+        # sequence of chunks.
+        # @yield [chunk]
+        # @yieldparam [String] chunk a chunk of the request body
+        def each
+          if @value
+            @value.each {|chunk| yield chunk }
+          else
+            @value = []
+            @request.body.each {|chunk| @value << chunk; yield chunk }
+          end
+        end
+      end # class RequestBody
     end # class Rack
 
   end # module Adapters