RubyGems - webmachine - Versions diffs - 0.1.0 → 0.2.0 - Mend

webmachine 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (63) hide show

data/Gemfile +11 -3
data/README.md +55 -27
data/lib/webmachine/adapters/mongrel.rb +84 -0
data/lib/webmachine/adapters/webrick.rb +12 -3
data/lib/webmachine/adapters.rb +1 -7
data/lib/webmachine/configuration.rb +30 -0
data/lib/webmachine/decision/conneg.rb +7 -72
data/lib/webmachine/decision/flow.rb +13 -11
data/lib/webmachine/decision/fsm.rb +1 -9
data/lib/webmachine/decision/helpers.rb +27 -7
data/lib/webmachine/errors.rb +1 -0
data/lib/webmachine/headers.rb +12 -3
data/lib/webmachine/locale/en.yml +2 -2
data/lib/webmachine/media_type.rb +117 -0
data/lib/webmachine/resource/callbacks.rb +9 -0
data/lib/webmachine/streaming.rb +3 -3
data/lib/webmachine/version.rb +1 -1
data/lib/webmachine.rb +3 -1
data/pkg/webmachine-0.1.0/Gemfile +16 -0
data/pkg/webmachine-0.1.0/Guardfile +11 -0
data/pkg/webmachine-0.1.0/README.md +90 -0
data/pkg/webmachine-0.1.0/Rakefile +31 -0
data/pkg/webmachine-0.1.0/examples/webrick.rb +19 -0
data/pkg/webmachine-0.1.0/lib/webmachine/adapters/webrick.rb +74 -0
data/pkg/webmachine-0.1.0/lib/webmachine/adapters.rb +15 -0
data/pkg/webmachine-0.1.0/lib/webmachine/decision/conneg.rb +304 -0
data/pkg/webmachine-0.1.0/lib/webmachine/decision/flow.rb +502 -0
data/pkg/webmachine-0.1.0/lib/webmachine/decision/fsm.rb +79 -0
data/pkg/webmachine-0.1.0/lib/webmachine/decision/helpers.rb +80 -0
data/pkg/webmachine-0.1.0/lib/webmachine/decision.rb +12 -0
data/pkg/webmachine-0.1.0/lib/webmachine/dispatcher/route.rb +85 -0
data/pkg/webmachine-0.1.0/lib/webmachine/dispatcher.rb +40 -0
data/pkg/webmachine-0.1.0/lib/webmachine/errors.rb +37 -0
data/pkg/webmachine-0.1.0/lib/webmachine/headers.rb +16 -0
data/pkg/webmachine-0.1.0/lib/webmachine/locale/en.yml +28 -0
data/pkg/webmachine-0.1.0/lib/webmachine/request.rb +56 -0
data/pkg/webmachine-0.1.0/lib/webmachine/resource/callbacks.rb +362 -0
data/pkg/webmachine-0.1.0/lib/webmachine/resource/encodings.rb +36 -0
data/pkg/webmachine-0.1.0/lib/webmachine/resource.rb +48 -0
data/pkg/webmachine-0.1.0/lib/webmachine/response.rb +49 -0
data/pkg/webmachine-0.1.0/lib/webmachine/streaming.rb +27 -0
data/pkg/webmachine-0.1.0/lib/webmachine/translation.rb +11 -0
data/pkg/webmachine-0.1.0/lib/webmachine/version.rb +4 -0
data/pkg/webmachine-0.1.0/lib/webmachine.rb +19 -0
data/pkg/webmachine-0.1.0/spec/spec_helper.rb +13 -0
data/pkg/webmachine-0.1.0/spec/tests.org +57 -0
data/pkg/webmachine-0.1.0/spec/webmachine/decision/conneg_spec.rb +152 -0
data/pkg/webmachine-0.1.0/spec/webmachine/decision/flow_spec.rb +1030 -0
data/pkg/webmachine-0.1.0/spec/webmachine/dispatcher/route_spec.rb +109 -0
data/pkg/webmachine-0.1.0/spec/webmachine/dispatcher_spec.rb +34 -0
data/pkg/webmachine-0.1.0/spec/webmachine/headers_spec.rb +19 -0
data/pkg/webmachine-0.1.0/spec/webmachine/request_spec.rb +24 -0
data/pkg/webmachine-0.1.0/webmachine.gemspec +44 -0
data/pkg/webmachine-0.1.0.gem +0 -0
data/spec/webmachine/configuration_spec.rb +27 -0
data/spec/webmachine/decision/conneg_spec.rb +18 -11
data/spec/webmachine/decision/flow_spec.rb +2 -0
data/spec/webmachine/decision/helpers_spec.rb +105 -0
data/spec/webmachine/errors_spec.rb +13 -0
data/spec/webmachine/headers_spec.rb +2 -1
data/spec/webmachine/media_type_spec.rb +78 -0
data/webmachine.gemspec +4 -1
metadata +69 -11

data/Gemfile CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'rbconfig'
 source :rubygems
 gemspec
@@ -6,9 +8,15 @@ gem 'bundler'
 unless ENV['TRAVIS']
   gem 'guard-rspec'
-  gem 'rb-fsevent'
-  gem 'growl'
-  gem 'growl_notify'
+  case RbConfig::CONFIG['host_os']
+  when /darwin/
+    gem 'rb-fsevent'
+    gem 'growl_notify'
+  when /linux/
+    gem 'rb-inotify'
+    gem 'libnotify'
+  end
 end
 platforms :jruby do

data/README.md CHANGED Viewed

@@ -26,25 +26,25 @@ Webmachine is very young, but it's still easy to construct an
 application for it!
 ```ruby
-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)
-# Start the server, binds to port 3000 using WEBrick
-Webmachine.run
+    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)
+    # Start the server, binds to port 3000 using WEBrick
+    Webmachine.run
 ```
 Your resource will look something like this:
 ```ruby
-class MyResource < Webmachine::Resource
-  def to_html
-    "<html><body>Hello, world!</body></html>"
-  end
-end
+    class MyResource < Webmachine::Resource
+      def to_html
+        "<html><body>Hello, world!</body></html>"
+      end
+    end
 ```
 Run the first file and your application is up. That's all there is to
@@ -54,15 +54,15 @@ might want to enable "gzip" compression on your resource, for which
 you can simply add an `encodings_provided` callback method:
 ```ruby
-class MyResource < Webmachine::Resource
-  def encodings_provided
-    {"gzip" => :encode_gzip, "identity" => :encode_identity}
-  end
-  def to_html
-    "<html><body>Hello, world!</body></html>"
-  end
-end
+    class MyResource < Webmachine::Resource
+      def encodings_provided
+        {"gzip" => :encode_gzip, "identity" => :encode_identity}
+      end
+      def to_html
+        "<html><body>Hello, world!</body></html>"
+      end
+    end
 ```
 There are many other HTTP features exposed to your resource through
@@ -75,15 +75,43 @@ callbacks. Give them a try!
 * Most callbacks can interrupt the decision flow by returning an
   integer response code. You generally only want to do this when new
   information comes to light, requiring a modification of the response.
-* Currently supports WEBrick. Other host servers are planned.
+* Supports WEBrick and Mongrel (1.2pre+). Other host servers are being
+  investigated.
 * Streaming/chunked response bodies are permitted as Enumerables or Procs.
+* Unlike the Erlang original, it does real Language negotiation.
 ## Problems/TODOs
 * Support streamed responses as Fibers.
-* Configuration, command-line tools, and general polish.
-* An effort has been made to make the code feel as Ruby-ish as
-  possible, but there is still work to do.
+* Command-line tools, and general polish.
 * Tracing is exposed as an Array of decisions visited on the response
   object. You should be able to turn this off and on, and visualize
   the decisions on the sequence diagram.
+## Changelog
+### 0.2.0 September 11, 2011
+0.2.0 includes an adapter for Mongrel and a central place for
+configuration as well as numerous bugfixes. Added Ian Plosker and
+Bernd Ahlers as committers. Thank you for your contributions!
+* Acceptable media types are matched less strictly, which has
+  implications on both responses and PUT requests. See the
+  [discussion on the commit](https://github.com/seancribbs/webmachine-ruby/commit/3686d0d9ff77fc98aff59f89478e9c6c18844ca1).
+* Resources now receive a callback after the language has been
+  negotiated, so they can decide what to do with it.
+* Added `Webmachine::Configuration` so we can more easily support more
+  than one host server/adapter.
+* Added Mongrel adapter, supporting 1.2pre+.
+* Media type headers are more lax about whitespace following
+  semicolons.
+* Fix some problems with callable response bodies.
+* Make sure String response bodies get a Content-Length header added
+  and streaming responses get chunked encoding.
+* Numerous refactorings, including extracting `MediaType` into its own
+  top-level class.
+### 0.1.0 August 25, 2011
+This is the initial release. Most things work, but only WEBrick is supported.

data/lib/webmachine/adapters/mongrel.rb ADDED Viewed

@@ -0,0 +1,84 @@
+require 'mongrel'
+require 'webmachine/version'
+require 'webmachine/headers'
+require 'webmachine/request'
+require 'webmachine/response'
+require 'webmachine/dispatcher'
+module Webmachine
+  module Adapters
+    # Connects Webmachine to Mongrel.
+    module Mongrel
+      # Starts the Mongrel adapter
+      def self.run
+        c = Webmachine.configuration
+        options = {
+          :port => c.port,
+          :host => c.ip
+        }.merge(c.adapter_options)
+        config = ::Mongrel::Configurator.new(options) do
+          listener do
+            uri '/', :handler => Webmachine::Adapters::Mongrel::Handler.new
+          end
+          trap("INT") { stop }
+          run
+        end
+        config.join
+      end
+      class Handler < ::Mongrel::HttpHandler
+        def process(wreq, wres)
+          header = http_headers(wreq.params, Webmachine::Headers.new)
+          request = Webmachine::Request.new(wreq.params["REQUEST_METHOD"],
+                                            URI.parse(wreq.params["REQUEST_URI"]),
+                                            header,
+                                            wreq.body || StringIO.new(''))
+          response = Webmachine::Response.new
+          Webmachine::Dispatcher.dispatch(request, response)
+          begin
+            wres.status = response.code.to_i
+            wres.send_status(nil)
+            response.headers.each { |k, vs|
+              vs.split("\n").each { |v|
+                wres.header[k] = v
+              }
+            }
+            wres.header['Server'] = [Webmachine::SERVER_STRING, "Mongrel/#{::Mongrel::Const::MONGREL_VERSION}"].join(" ")
+            wres.send_header
+            case response.body
+            when String
+              wres.write response.body
+              wres.socket.flush
+            when Enumerable
+              response.body.each { |part|
+                wres.write part
+                wres.socket.flush
+              }
+            else
+              if response.body.respond_to?(:call)
+                wres.write part
+                wres.socket.flush
+              end
+            end
+          ensure
+            response.body.close if response.body.respond_to? :close
+          end
+        end
+        def http_headers(env, headers)
+          env.inject(headers) do |h,(k,v)|
+            if k =~ /^HTTP_(\w+)$/
+              h[$1.tr("_", "-")] = v
+            end
+            h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webmachine/adapters/webrick.rb CHANGED Viewed

@@ -11,7 +11,12 @@ module Webmachine
     module WEBrick
       # Starts the WEBrick adapter
       def self.run
-        server = Webmachine::Adapters::WEBrick::Server.new :Port => 3000
+        c = Webmachine.configuration
+        options = {
+          :Port => c.port,
+          :BindAddress => c.ip
+        }.merge(c.adapter_options)
+        server = Webmachine::Adapters::WEBrick::Server.new options
         trap("INT"){ server.shutdown }
         Thread.new { server.start }.join
       end
@@ -35,9 +40,13 @@ module Webmachine
           when String
             wres.body << response.body
           when Enumerable
+            wres.chunked = true
             response.body.each {|part| wres.body << part }
-          when response.body.respond_to?(:call)
-            wres.body << response.body.call
+          else
+            if response.body.respond_to?(:call)
+              wres.chunked = true
+              wres.body << response.body.call
+            end
           end
         end
       end

data/lib/webmachine/adapters.rb CHANGED Viewed

@@ -4,12 +4,6 @@ module Webmachine
   # Contains classes and modules that connect Webmachine to Ruby
   # application servers.
   module Adapters
+    autoload :Mongrel, 'webmachine/adapters/mongrel'
   end
-  class << self
-    # @return [Symbol] the current webserver adapter
-    attr_accessor :adapter
-  end
-  self.adapter = :WEBrick
 end

data/lib/webmachine/configuration.rb ADDED Viewed

@@ -0,0 +1,30 @@
+module Webmachine
+  # A simple configuration container for items that are used across
+  # multiple web server adapters. Typically set using
+  # {Webmachine::configure}. If not set by your application, the
+  # defaults will be filled in when {Webmachine::run} is called.
+  # @attr [String] ip the interface to bind to, defaults to "0.0.0.0"
+  #    (all interfaces)
+  # @attr [Fixnum] port the port to bind to, defaults to 8080
+  # @attr [Symbol] adapter the adapter to use, defaults to :WEBrick
+  # @attr [Hash] adapter_options adapter-specific options, defaults to {}
+  Configuration = Struct.new(:ip, :port, :adapter, :adapter_options)
+  class << self
+    # @return [Configuration] the current configuration
+    attr_accessor :configuration
+  end
+  # Sets configuration for the web server via the passed
+  # block. Returns Webmachine so you can chain it with
+  # Webmachine.run.
+  # @yield [config] a block in which to set configuration values
+  # @yieldparam [Configuration] config the Configuration instance
+  # @return [Webmachine]
+  def self.configure
+    @configuration ||= Configuration.new("0.0.0.0", 8080, :WEBrick, {})
+    yield @configuration if block_given?
+    self
+  end
+end

data/lib/webmachine/decision/conneg.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 require 'webmachine/translation'
+require 'webmachine/media_type'
 module Webmachine
   module Decision
@@ -14,7 +15,7 @@ module Webmachine
       def choose_media_type(provided, header)
         requested = MediaTypeList.build(header.split(/\s*,\s*/))
         provided = provided.map do |p| # normalize_provided
-          MediaType.new(*Array(p))
+          MediaType.parse(p)
         end
         # choose_media_type1
         chosen = nil
@@ -79,7 +80,8 @@ module Webmachine
         end
       end
-      # RFC2616, section 14.14:
+      # Implements language-negotation matching as described in
+      # RFC2616, section 14.14.
       #
       # A language-range matches a language-tag if it exactly
       # equals the tag, or if it exactly equals a prefix of the
@@ -116,74 +118,6 @@ module Webmachine
       # Matches acceptable items that include 'q' values
       CONNEG_REGEX = /^\s*(\S+);\s*q=(\S*)\s*$/
-      # Matches sub-type parameters
-      PARAMS_REGEX = /;([^=]+)=([^;=\s]+)/
-      # Matches valid media types
-      MEDIA_TYPE_REGEX = /^\s*([^;\s]+)\s*((?:;\S+\s*)*)\s*$/
-      # Encapsulates a MIME media type, with logic for matching types.
-      class MediaType
-        # Creates a new MediaType by parsing its string representation.
-        def self.parse(str)
-          if str =~ MEDIA_TYPE_REGEX
-            type, raw_params = $1, $2
-            params = Hash[raw_params.scan(PARAMS_REGEX)]
-            new(type, params)
-          end
-        end
-        # @return [String] the MIME media type
-        attr_accessor :type
-        # @return [Hash] any type parameters, e.g. charset
-        attr_accessor :params
-        def initialize(type, params={})
-          @type, @params = type, params
-        end
-        # Detects whether the {MediaType} represents an open wildcard
-        # type, that is, "*/*" without any {#params}.
-        def matches_all?
-          @type == "*/*" && @params.empty?
-        end
-        def ==(other)
-          other = self.class.parse(other) if String === other
-          other.type == type && other.params == params
-        end
-        # Detects whether this {MediaType} matches the other {MediaType},
-        # taking into account wildcards.
-        def match?(other)
-          type_matches?(other) && other.params == params
-        end
-        # Reconstitutes the type into a String
-        def to_s
-          [type, *params.map {|k,v| "#{k}=#{v}" }].join(";")
-        end
-        # @return [String] The major type, e.g. "application", "text", "image"
-        def major
-          type.split("/").first
-        end
-        # @return [String] the minor or sub-type, e.g. "json", "html", "jpeg"
-        def minor
-          type.split("/").last
-        end
-        def type_matches?(other)
-          if ["*", "*/*", type].include?(other.type)
-            true
-          else
-            other.major == major && other.minor == "*"
-          end
-        end
-      end
       # Matches the requested media type (with potential modifiers)
       # against the provided types (with potential modifiers).
       # @param [MediaType] requested the requested media type
@@ -291,10 +225,11 @@ module Webmachine
         # {MediaType} items instead of Strings.
         # @see PriorityList#add_header_val
         def add_header_val(c)
-          if mt = MediaType.parse(c)
+          begin
+            mt = MediaType.parse(c)
             q = mt.params.delete('q') || 1.0
             add(q.to_f, mt)
-          else
+          rescue ArgumentError
             raise MalformedRequest, t('invalid_media_type', :type => c)
           end
         end

data/lib/webmachine/decision/flow.rb CHANGED Viewed

@@ -163,7 +163,12 @@ module Webmachine
       # Accept-Language exists?
       def d4
         if !request.accept_language
-          choose_language(resource.languages_provided, "*") ? :e5 : 406
+          if language = choose_language(resource.languages_provided, "*")
+            resource.language_chosen(language)
+            :e5
+          else
+            406
+          end
         else
           :d5
         end
@@ -171,7 +176,12 @@ module Webmachine
       # Acceptable language available?
       def d5
-        choose_language(resource.languages_provided, request.accept_language) ? :e5 : 406
+        if language = choose_language(resource.languages_provided, request.accept_language)
+          resource.language_chosen(language)
+          :e5
+        else
+          406
+        end
       end
       # Accept-Charset exists?
@@ -449,15 +459,7 @@ module Webmachine
       # Also where body generation for GET and HEAD is done.
       def o18
         if request.method =~ /^(GET|HEAD)$/
-          if etag = resource.generate_etag
-            response.headers['ETag'] = ensure_quoted_header(etag)
-          end
-          if last_modified = resource.last_modified
-            response.headers['Last-Modified'] = last_modified.httpdate
-          end
-          if expires = resource.expires
-            response.headers['Expires'] = expires.httpdate
-          end
+          add_caching_headers
           content_type = metadata['Content-Type']
           handler = resource.content_types_provided.find {|ct, _| content_type.type_matches?(MediaType.parse(ct)) }.last
           result = resource.send(handler)