webmachine 1.2.2 → 1.3.0

data/lib/webmachine/adapters/webrick.rb

@@ -1,9 +1,11 @@
+require 'webmachine/adapter'
 require 'webrick'
-require 'webmachine/version'
+require 'webmachine/constants'
 require 'webmachine/headers'
+require 'webmachine/adapters/lazy_request_body'
 require 'webmachine/request'
 require 'webmachine/response'
-require 'webmachine/dispatcher'
+require 'webmachine/version'
 
 module Webmachine
   module Adapters
@@ -15,22 +17,19 @@ module Webmachine
       # Starts the WEBrick adapter
       def run
         options = DEFAULT_OPTIONS.merge({
-          :Port => configuration.port,
-          :BindAddress => configuration.ip
-        }).merge(configuration.adapter_options)
-        @server = Server.new(dispatcher, options)
-        trap("INT") { shutdown }
+          :Port => application.configuration.port,
+          :BindAddress => application.configuration.ip,
+          :application => application
+        }).merge(application.configuration.adapter_options)
+        @server = Server.new(options)
         @server.start
       end
 
-      def shutdown
-        @server.shutdown if @server
-      end
-
       # WEBRick::HTTPServer that is run by the WEBrick adapter.
       class Server < ::WEBrick::HTTPServer
-        def initialize(dispatcher, options)
-          @dispatcher = dispatcher
+
+        def initialize(options)
+          @application = options[:application]
           super(options)
         end
 
@@ -42,8 +41,9 @@ module Webmachine
                                             wreq.request_uri,
                                             header,
                                             LazyRequestBody.new(wreq))
+
           response = Webmachine::Response.new
-          @dispatcher.dispatch(request, response)
+          @application.dispatcher.dispatch(request, response)
           wres.status = response.code.to_i
 
           headers = response.headers.flattened.reject { |k,v| k == 'Set-Cookie' }
@@ -52,12 +52,12 @@ module Webmachine
           cookies = [response.headers['Set-Cookie'] || []].flatten
           cookies.each { |c| wres.cookies << c }
 
-          wres['Server'] = [Webmachine::SERVER_STRING, wres.config[:ServerSoftware]].join(" ")
+          wres[SERVER] = [Webmachine::SERVER_STRING, wres.config[:ServerSoftware]].join(" ")
           case response.body
           when String
             wres.body << response.body
           when Enumerable
-            wres.chunked = response.headers['Transfer-Encoding'] == 'chunked'
+            wres.chunked = response.headers[TRANSFER_ENCODING] == 'chunked'
             response.body.each {|part| wres.body << part }
           else
             if response.body.respond_to?(:call)

data/lib/webmachine/application.rb

@@ -8,7 +8,7 @@ module Webmachine
   #
   #   MyApp = Webmachine::Application.new do |app|
   #     app.routes do
-  #       add ['*'], AssetResource
+  #       add [:*], AssetResource
   #     end
   #
   #     app.configure do |config|
@@ -56,7 +56,7 @@ module Webmachine
     # @return an instance of the configured web-server adapter
     # @see Adapters
     def adapter
-      @adapter ||= adapter_class.new(configuration, dispatcher)
+      @adapter ||= adapter_class.new(self)
     end
 
     # @return an instance of the configured web-server adapter

data/lib/webmachine/chunked_body.rb

@@ -1,3 +1,5 @@
+require 'webmachine/constants'
+
 module Webmachine
   # {ChunkedBody} is used to wrap an {Enumerable} object (like an enumerable
   # {Response#body}) so it yields proper chunks for chunked transfer encoding.
@@ -13,11 +15,8 @@ module Webmachine
   #
   # This is needed for Ruby webservers which don't do the chunking themselves.
   class ChunkedBody
-    # Delimiter for chunked encoding
-    CRLF = "\r\n"
-
     # Final chunk in any chunked-encoding response
-    FINAL_CHUNK = "0#{CRLF}#{CRLF}"
+    FINAL_CHUNK = "0#{CRLF}#{CRLF}".freeze
 
     # Creates a new {ChunkedBody} from the given {Enumerable}.
     # @param [Enumerable] body the enumerable response body

data/lib/webmachine/constants.rb

@@ -0,0 +1,75 @@
+module Webmachine
+  # Universal HTTP delimiter
+  CRLF = "\r\n".freeze
+
+  # HTTP Content-Type
+  CONTENT_TYPE = 'Content-Type'.freeze
+
+  # Default Content-Type
+  TEXT_HTML = 'text/html'.freeze
+
+  # HTTP Date
+  DATE = 'Date'.freeze
+
+  # HTTP Transfer-Encoding
+  TRANSFER_ENCODING = 'Transfer-Encoding'.freeze
+
+  # HTTP Content-Length
+  CONTENT_LENGTH = 'Content-Length'.freeze
+
+  # A underscore
+  UNDERSCORE = '_'.freeze
+
+  # A dash
+  DASH = '-'.freeze
+
+  # A Slash
+  SLASH = '/'.freeze
+
+  MATCHES_ALL = '*/*'.freeze
+
+  GET_METHOD     = "GET"
+  HEAD_METHOD    = "HEAD"
+  POST_METHOD    = "POST"
+  PUT_METHOD     = "PUT"
+  DELETE_METHOD  = "DELETE"
+  OPTIONS_METHOD = "OPTIONS"
+  TRACE_METHOD   = "TRACE"
+  CONNECT_METHOD = "CONNECT"
+
+  STANDARD_HTTP_METHODS = [
+                           GET_METHOD, HEAD_METHOD, POST_METHOD,
+                           PUT_METHOD, DELETE_METHOD, TRACE_METHOD,
+                           CONNECT_METHOD, OPTIONS_METHOD
+                          ].map!(&:freeze)
+  STANDARD_HTTP_METHODS.freeze
+
+  # A colon
+  COLON = ':'.freeze
+
+  # http string
+  HTTP = 'http'.freeze
+
+  # Host string
+  HOST = 'Host'.freeze
+
+  # HTTP Content-Encoding
+  CONTENT_ENCODING = 'Content-Encoding'.freeze
+
+  # Charset string
+  CHARSET = 'Charset'.freeze
+
+  # Semicolon split match
+  SPLIT_SEMI = /\s*,\s*/.freeze
+
+  # Star Character
+  STAR = '*'.freeze
+
+  # HTTP Location
+  LOCATION = 'Location'.freeze
+
+  # identity Encoding
+  IDENTITY = 'identity'.freeze
+
+  SERVER = 'Server'.freeze
+end

data/lib/webmachine/decision/conneg.rb

@@ -1,3 +1,4 @@
+require 'webmachine/constants'
 require 'webmachine/translation'
 require 'webmachine/media_type'
 
@@ -13,7 +14,8 @@ module Webmachine
       # appropriate media type.
       # @api private
       def choose_media_type(provided, header)
-        requested = MediaTypeList.build(header.split(/\s*,\s*/))
+        types = Array(header).map{|h| h.split(SPLIT_SEMI) }.flatten
+        requested = MediaTypeList.build(types)
         provided = provided.map do |p| # normalize_provided
           MediaType.parse(p)
         end
@@ -30,9 +32,9 @@ module Webmachine
       # @api private
       def choose_encoding(provided, header)
         encodings = provided.keys
-        if encoding = do_choose(encodings, header, "identity")
-          response.headers['Content-Encoding'] = encoding unless encoding == 'identity'
-          metadata['Content-Encoding'] = encoding
+        if encoding = do_choose(encodings, header, IDENTITY)
+          response.headers[CONTENT_ENCODING] = encoding unless encoding == IDENTITY
+          metadata[CONTENT_ENCODING] = encoding
         end
       end
 
@@ -43,7 +45,7 @@ module Webmachine
         if provided && !provided.empty?
           charsets = provided.map {|c| c.first }
           if charset = do_choose(charsets, header, HAS_ENCODING ? Encoding.default_external.name : kcode_charset)
-            metadata['Charset'] = charset
+            metadata[CHARSET] = charset
           end
         else
           true
@@ -55,8 +57,8 @@ module Webmachine
       # @api private
       def choose_language(provided, header)
         if provided && !provided.empty?
-          requested = PriorityList.build(header.split(/\s*,\s*/))
-          star_priority = requested.priority_of("*")
+          requested = PriorityList.build(header.split(SPLIT_SEMI))
+          star_priority = requested.priority_of(STAR)
           any_ok = star_priority && star_priority > 0.0
           accepted = requested.find do |priority, range|
             if priority == 0.0
@@ -97,9 +99,9 @@ module Webmachine
       # @api private
       def do_choose(choices, header, default)
         choices = choices.dup.map {|s| s.downcase }
-        accepted = PriorityList.build(header.split(/\s*,\s*/))
+        accepted = PriorityList.build(header.split(SPLIT_SEMI))
         default_priority = accepted.priority_of(default)
-        star_priority = accepted.priority_of("*")
+        star_priority = accepted.priority_of(STAR)
         default_ok = (default_priority.nil? && star_priority != 0.0) || default_priority
         any_ok = star_priority && star_priority > 0.0
         chosen = accepted.find do |priority, acceptable|
@@ -117,7 +119,7 @@ module Webmachine
 
       private
       # Matches acceptable items that include 'q' values
-      CONNEG_REGEX = /^\s*(\S+);\s*q=(\S*)\s*$/
+      CONNEG_REGEX = /^\s*(\S+);\s*q=(\S*)\s*$/.freeze
 
       # Matches the requested media type (with potential modifiers)
       # against the provided types (with potential modifiers).

data/lib/webmachine/decision/flow.rb

@@ -1,5 +1,7 @@
-require 'time'
+require 'time'
 require 'digest/md5'
+require 'base64'
+require 'webmachine/constants'
 require 'webmachine/decision/conneg'
 require 'webmachine/decision/falsey'
 require 'webmachine/translation'
@@ -16,6 +18,8 @@ module Webmachine
     # of the chart.
     # @see https://raw.github.com/wiki/basho/webmachine/images/http-headers-status-v3.png
     module Flow
+      include Base64
+
       # Version of the flow diagram
       VERSION = 3
 
@@ -81,7 +85,7 @@ module Webmachine
           response.body = "Content-MD5 header does not match request body."
           400
         else # not_validated
-          if request.content_md5 == Digest::MD5.hexdigest(request.body)
+          if decode64(request.content_md5) == Digest::MD5.hexdigest(request.body)
             :b9b
           else
             response.body = "Content-MD5 header does not match request body."
@@ -116,9 +120,10 @@ module Webmachine
         decision_test(resource.forbidden?, 403, :b6)
       end
 
+      CONTENT = /content-/.freeze
       # Okay Content-* Headers?
       def b6
-        decision_test(resource.valid_content_headers?(request.headers.grep(/content-/)), :b5,  501)
+        decision_test(resource.valid_content_headers?(request.headers.grep(CONTENT)), :b5,  501)
       end
 
       # Known Content-Type?
@@ -144,7 +149,7 @@ module Webmachine
       # Accept exists?
       def c3
         if !request.accept
-          metadata['Content-Type'] = MediaType.parse(resource.content_types_provided.first.first)
+          metadata[CONTENT_TYPE] = MediaType.parse(resource.content_types_provided.first.first)
           :d4
         else
           :c4
@@ -158,7 +163,7 @@ module Webmachine
         if !chosen_type
           406
         else
-          metadata['Content-Type'] = chosen_type
+          metadata[CONTENT_TYPE] = chosen_type
           :d4
         end
       end
@@ -166,7 +171,7 @@ module Webmachine
       # Accept-Language exists?
       def d4
         if !request.accept_language
-          if language = choose_language(resource.languages_provided, "*")
+          if language = choose_language(resource.languages_provided, STAR)
             resource.language_chosen(language)
             :e5
           else
@@ -190,7 +195,7 @@ module Webmachine
       # Accept-Charset exists?
       def e5
         if !request.accept_charset
-          choose_charset(resource.charsets_provided, "*") ? :f6 : 406
+          choose_charset(resource.charsets_provided, STAR) ? :f6 : 406
         else
           :e6
         end
@@ -204,11 +209,11 @@ module Webmachine
       # Accept-Encoding exists?
       # (also, set content-type header here, now that charset is chosen)
       def f6
-        chosen_type = metadata['Content-Type']
-        if chosen_charset = metadata['Charset']
+        chosen_type = metadata[CONTENT_TYPE]
+        if chosen_charset = metadata[CHARSET]
           chosen_type.params['charset'] = chosen_charset
         end
-        response.headers['Content-Type'] = chosen_type.to_s
+        response.headers[CONTENT_TYPE] = chosen_type.to_s
         if !request.accept_encoding
           choose_encoding(resource.encodings_provided, "identity;q=1.0,*;q=0.5") ? :g7 : 406
         else
@@ -240,13 +245,13 @@ module Webmachine
 
       # ETag in If-Match
       def g11
-        request_etags = request.if_match.split(/\s*,\s*/).map {|etag| ETag.new(etag) }
+        request_etags = request.if_match.split(SPLIT_SEMI).map {|etag| ETag.new(etag) }
         request_etags.include?(ETag.new(resource.generate_etag)) ? :h10 : 412
       end
 
       # If-Match exists?
       def h7
-        (request.if_match && unquote(request.if_match) == '*') ? 412 : :i7
+        (request.if_match && unquote(request.if_match) == STAR) ? 412 : :i7
       end
 
       # If-Unmodified-Since exists?
@@ -273,7 +278,7 @@ module Webmachine
       def i4
         case uri = resource.moved_permanently?
         when String, URI
-          response.headers["Location"] = uri.to_s
+          response.headers[LOCATION] = uri.to_s
           301
         when Fixnum
           uri
@@ -306,7 +311,7 @@ module Webmachine
       def k5
         case uri = resource.moved_permanently?
         when String, URI
-          response.headers["Location"] = uri.to_s
+          response.headers[LOCATION] = uri.to_s
           301
         when Fixnum
           uri
@@ -322,15 +327,20 @@ module Webmachine
 
       # Etag in if-none-match?
       def k13
-        request_etags = request.if_none_match.split(/\s*,\s*/).map {|etag| ETag.new(etag) }
-        request_etags.include?(ETag.new(resource.generate_etag)) ? :j18 : :l13
+        request_etags = request.if_none_match.split(SPLIT_SEMI).map {|etag| ETag.new(etag) }
+        resource_etag = resource.generate_etag
+        if resource_etag && request_etags.include?(ETag.new(resource_etag))
+           :j18
+        else
+          :l13
+        end
       end
 
       # Moved temporarily?
       def l5
         case uri = resource.moved_temporarily?
         when String, URI
-          response.headers["Location"] = uri.to_s
+          response.headers[LOCATION] = uri.to_s
           307
         when Fixnum
           uri
@@ -410,7 +420,7 @@ module Webmachine
             base_uri = resource.base_uri || request.base_uri
             new_uri = URI.join(base_uri.to_s, uri)
             request.disp_path = new_uri.path
-            response.headers['Location'] = new_uri.to_s
+            response.headers[LOCATION] = new_uri.to_s
             result = accept_helper
             return result if Fixnum === result
           end
@@ -425,7 +435,7 @@ module Webmachine
           end
         end
         if response.is_redirect?
-          if response.headers['Location']
+          if response.headers[LOCATION]
             303
           else
             raise InvalidResource, t('do_redirect')
@@ -460,7 +470,7 @@ module Webmachine
       def o18
         if request.get? || request.head?
           add_caching_headers
-          content_type = metadata['Content-Type']
+          content_type = metadata[CONTENT_TYPE]
           handler = resource.content_types_provided.find {|ct, _| content_type.type_matches?(MediaType.parse(ct)) }.last
           result = resource.send(handler)
           if Fixnum === result
@@ -497,7 +507,7 @@ module Webmachine
 
       # New resource?
       def p11
-        !response.headers["Location"] ? :o20 : 201
+        !response.headers[LOCATION] ? :o20 : 201
       end
 
     end # module Flow

data/lib/webmachine/decision/fsm.rb

@@ -1,5 +1,7 @@
-require 'webmachine/decision/helpers'
+require 'webmachine/decision/helpers'
+require 'webmachine/trace'
 require 'webmachine/translation'
+require 'webmachine/constants'
 
 module Webmachine
   module Decision
@@ -8,6 +10,7 @@ module Webmachine
     class FSM
       include Flow
       include Helpers
+      include Trace::FSM
       include Translation
 
       attr_reader :resource, :request, :response, :metadata
@@ -15,7 +18,7 @@ module Webmachine
       def initialize(resource, request, response)
         @resource, @request, @response = resource, request, response
         @metadata = {}
-        initialize_tracing
+        super
       end
 
       # Processes the request, iteratively invoking the decision methods in {Flow}.
@@ -35,7 +38,7 @@ module Webmachine
             raise InvalidResource, t('fsm_broke', :state => state, :result => result.inspect)
           end
         end
-      rescue Exception => e
+      rescue => e
         Webmachine.render_error(500, request, response, :message => e.message)
       ensure
         trace_response(response)
@@ -48,7 +51,7 @@ module Webmachine
       rescue MalformedRequest => e
         Webmachine.render_error(400, request, response, :message => e.message)
         400
-      rescue Exception => e
+      rescue => e
         resource.handle_exception(e)
         500
       end
@@ -60,7 +63,7 @@ module Webmachine
         when 404
           Webmachine.render_error(code, request, response)
         when 304
-          response.headers.delete('Content-Type')
+          response.headers.delete(CONTENT_TYPE)
           add_caching_headers
         end
 
@@ -69,19 +72,8 @@ module Webmachine
           response.code
         end
 
-        ensure_content_length
-        ensure_date_header
-      end
-
-      # When tracing is disabled, this does nothing.
-      def trace_decision(state); end
-      # When tracing is disabled, this does nothing.
-      def trace_request(request); end
-      # When tracing is disabled, this does nothing.
-      def trace_response(response); end
-
-      def initialize_tracing
-        extend Trace::FSM if Trace.trace?(resource)
+        ensure_content_length(response)
+        ensure_date_header(response)
       end
     end # class FSM
   end # module Decision