webmachine 0.4.1 → 0.4.2

data/pkg/webmachine-0.4.0/lib/webmachine/decision/flow.rb

@@ -1,503 +0,0 @@
-require 'time'
-require 'digest/md5'
-require 'webmachine/decision/conneg'
-require 'webmachine/translation'
-
-module Webmachine
-  module Decision
-    # This module encapsulates all of the decisions in Webmachine's
-    # flow-chart. These invoke {Webmachine::Resource::Callbacks} methods to
-    # determine the appropriate response code, headers, and body for
-    # the response.    
-    #
-    # This module is included into {FSM}, which drives the processing
-    # of the chart.
-    # @see http://webmachine.basho.com/images/http-headers-status-v3.png
-    module Flow
-      # Version of the flow diagram
-      VERSION = 3
-
-      # The first state in flow diagram
-      START = :b13
-
-      # Separate content-negotiation logic from flow diagram.
-      include Conneg
-
-      # Extract error strings into locale files
-      include Translation
-
-      # Handles standard decisions where halting is allowed
-      def decision_test(test, value, iftrue, iffalse)
-        case test
-        when value
-          iftrue
-        when Fixnum # Allows callbacks to "halt" with a given response code
-          test
-        else
-          iffalse
-        end
-      end
-
-      # Service available?
-      def b13
-        decision_test(resource.service_available?, true, :b12, 503)
-      end
-
-      # Known method?
-      def b12
-        decision_test(resource.known_methods.include?(request.method), true, :b11, 501)
-      end
-
-      # URI too long?
-      def b11
-        decision_test(resource.uri_too_long?(request.uri), true, 414, :b10)
-      end
-
-      # Method allowed?
-      def b10
-        if resource.allowed_methods.include?(request.method)
-          :b9
-        else
-          response.headers["Allow"] = resource.allowed_methods.join(", ")
-          405
-        end
-      end
-
-      # Content-MD5 present?
-      def b9
-        request.content_md5 ? :b9a : :b9b
-      end
-
-      # Content-MD5 valid?
-      def b9a
-        case valid = resource.validate_content_checksum
-        when Fixnum
-          valid
-        when true
-          :b9b
-        when false
-          response.body = "Content-MD5 header does not match request body."
-          400
-        else # not_validated
-          if request.content_md5 == Digest::MD5.hexdigest(request.body)
-            :b9b
-          else
-            response.body = "Content-MD5 header does not match request body."
-            400
-          end
-        end
-      end
-
-      # Malformed?
-      def b9b
-        decision_test(resource.malformed_request?, true, 400, :b8)
-      end
-
-      # Authorized?
-      def b8
-        result = resource.is_authorized?(request.authorization)
-        case result
-        when true
-          :b7
-        when Fixnum
-          result
-        when String
-          response.headers['WWW-Authenticate'] = result
-          401
-        else
-          401
-        end
-      end
-
-      # Forbidden?
-      def b7
-        decision_test(resource.forbidden?, true, 403, :b6)
-      end
-
-      # Okay Content-* Headers?
-      def b6
-        decision_test(resource.valid_content_headers?(request.headers.grep(/content-/)), true, :b5,  501)
-      end
-
-      # Known Content-Type?
-      def b5
-        decision_test(resource.known_content_type?(request.content_type), true, :b4, 415)
-      end
-
-      # Req Entity Too Large?
-      def b4
-        decision_test(resource.valid_entity_length?(request.content_length), true, :b3, 413)
-      end
-
-      # OPTIONS?
-      def b3
-        if request.options?
-          response.headers.merge!(resource.options)
-          200
-        else
-          :c3
-        end
-      end
-
-      # Accept exists?
-      def c3
-        if !request.accept
-          metadata['Content-Type'] = MediaType.parse(resource.content_types_provided.first.first)
-          :d4
-        else
-          :c4
-        end
-      end
-
-      # Acceptable media type available?
-      def c4
-        types = resource.content_types_provided.map {|pair| pair.first }
-        chosen_type = choose_media_type(types, request.accept)
-        if !chosen_type
-          406
-        else
-          metadata['Content-Type'] = chosen_type
-          :d4
-        end
-      end
-
-      # Accept-Language exists?
-      def d4
-        if !request.accept_language
-          if language = choose_language(resource.languages_provided, "*")
-            resource.language_chosen(language)
-            :e5
-          else
-            406
-          end
-        else
-          :d5
-        end
-      end
-
-      # Acceptable language available?
-      def d5
-        if language = choose_language(resource.languages_provided, request.accept_language)
-          resource.language_chosen(language)
-          :e5
-        else
-          406
-        end
-      end
-
-      # Accept-Charset exists?
-      def e5
-        if !request.accept_charset
-          choose_charset(resource.charsets_provided, "*") ? :f6 : 406
-        else
-          :e6
-        end
-      end
-
-      # Acceptable Charset available?
-      def e6
-        choose_charset(resource.charsets_provided, request.accept_charset) ? :f6 : 406
-      end
-
-      # 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.params['charset'] = chosen_charset
-        end
-        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
-          :f7
-        end
-      end
-
-      # Acceptable encoding available?
-      def f7
-        choose_encoding(resource.encodings_provided, request.accept_encoding) ? :g7 : 406
-      end
-
-      # Resource exists?
-      def g7
-        # This is the first place after all conneg, so set Vary here
-        response.headers['Vary'] =  variances.join(", ") if variances.any?
-        decision_test(resource.resource_exists?, true, :g8, :h7)
-      end
-
-      # If-Match exists?
-      def g8
-        request.if_match ? :g9 : :h10
-      end
-
-      # If-Match: * exists?
-      def g9
-        request.if_match == "*" ? :h10 : :g11
-      end
-
-      # ETag in If-Match
-      def g11
-        request_etags = request.if_match.split(/\s*,\s*/).map {|etag| unquote_header(etag) }
-        request_etags.include?(resource.generate_etag) ? :h10 : 412
-      end
-
-      # If-Match exists?
-      def h7
-        (request.if_match && unquote_header(request.if_match) == '*') ? 412 : :i7
-      end
-
-      # If-Unmodified-Since exists?
-      def h10
-        request.if_unmodified_since ? :h11 : :i12
-      end
-
-      # If-Unmodified-Since is valid date?
-      def h11
-        date = Time.httpdate(request.if_unmodified_since)
-        metadata['If-Unmodified-Since'] = date
-      rescue ArgumentError
-        :i12
-      else
-        :h12
-      end
-
-      # Last-Modified > I-UM-S?
-      def h12
-        resource.last_modified > metadata['If-Unmodified-Since'] ? 412 : :i12
-      end
-
-      # Moved permanently? (apply PUT to different URI)
-      def i4
-        case uri = resource.moved_permanently?
-        when String, URI
-          response.headers["Location"] = uri.to_s
-          301
-        when Fixnum
-          uri
-        else
-          :p3
-        end
-      end
-
-      # PUT?
-      def i7
-        request.put? ? :i4 : :k7
-      end
-
-      # If-none-match exists?
-      def i12
-        request.if_none_match ? :i13 : :l13
-      end
-
-      # If-none-match: * exists?
-      def i13
-        request.if_none_match == "*" ? :j18 : :k13
-      end
-
-      # GET or HEAD?
-      def j18
-        (request.get? || request.head?) ? 304 : 412
-      end
-
-      # Moved permanently?
-      def k5
-        case uri = resource.moved_permanently?
-        when String, URI
-          response.headers["Location"] = uri.to_s
-          301
-        when Fixnum
-          uri
-        else
-          :l5
-        end
-      end
-
-      # Previously existed?
-      def k7
-        decision_test(resource.previously_existed?, true, :k5, :l7)
-      end
-
-      # Etag in if-none-match?
-      def k13
-        request_etags = request.if_none_match.split(/\s*,\s*/).map {|etag| unquote_header(etag) }
-        request_etags.include?(resource.generate_etag) ? :j18 : :l13
-      end
-
-      # Moved temporarily?
-      def l5
-        case uri = resource.moved_temporarily?
-        when String, URI
-          response.headers["Location"] = uri.to_s
-          307
-        when Fixnum
-          uri
-        else
-          :m5
-        end
-      end
-
-      # POST?
-      def l7
-        request.post? ? :m7 : 404
-      end
-
-      # If-Modified-Since exists?
-      def l13
-        request.if_modified_since ? :l14 : :m16
-      end
-
-      # IMS is valid date?
-      def l14
-        date = Time.httpdate(request.if_modified_since)
-        metadata['If-Modified-Since'] = date
-      rescue ArgumentError
-        :m16
-      else
-        :l15
-      end
-
-      # IMS > Now?
-      def l15
-        metadata['If-Modified-Since'] > Time.now ? :m16 : :l17
-      end
-
-      # Last-Modified > IMS?
-      def l17
-        resource.last_modified.nil? || resource.last_modified > metadata['If-Modified-Since'] ? :m16 : 304
-      end
-
-      # POST?
-      def m5
-        request.post? ? :n5 : 410
-      end
-
-      # Server allows POST to missing resource?
-      def m7
-        decision_test(resource.allow_missing_post?, true, :n11, 404)
-      end
-
-      # DELETE?
-      def m16
-        request.delete? ? :m20 : :n16
-      end
-
-      # DELETE enacted immediately? (Also where DELETE is forced.)
-      def m20
-        decision_test(resource.delete_resource, true, :m20b, 500)
-      end
-
-      # Did the DELETE complete?
-      def m20b
-        decision_test(resource.delete_completed?, true, :o20, 202)
-      end
-
-      # Server allows POST to missing resource?
-      def n5
-        decision_test(resource.allow_missing_post?, true, :n11, 410)
-      end
-
-      # Redirect?
-      def n11
-        # Stage1
-        if resource.post_is_create?
-          case uri = resource.create_path
-          when nil
-            raise InvalidResource, t('create_path_nil', :class => resource.class)
-          when URI, String
-            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
-            result = accept_helper
-            return result if Fixnum === result
-          end
-        else
-          case result = resource.process_post
-          when true
-            encode_body_if_set
-          when Fixnum
-            return result
-          else
-            raise InvalidResource, t('process_post_invalid', :result => result)
-          end
-        end
-        if response.is_redirect?
-          if response.headers['Location']
-            303
-          else
-            raise InvalidResource, t('do_redirect')
-          end
-        else
-          :p11
-        end
-      end
-
-      # POST?
-      def n16
-        request.post? ? :n11 : :o16
-      end
-
-      # Conflict?
-      def o14
-        if resource.is_conflict?
-          409
-        else
-          res = accept_helper
-          (Fixnum === res) ? res : :p11
-        end
-      end
-
-      # PUT?
-      def o16
-        request.put? ? :o14 : :o18
-      end
-
-      # Multiple representations?
-      # Also where body generation for GET and HEAD is done.
-      def o18
-        if request.get? || request.head?
-          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)
-          if Fixnum === result
-            result
-          else
-            response.body = result
-            encode_body
-            :o18b
-          end
-        else
-          :o18b
-        end
-      end
-
-      # Multiple choices?
-      def o18b
-        decision_test(resource.multiple_choices?, true, 300, 200)
-      end
-
-      # Response includes an entity?
-      def o20
-        has_response_body? ? :o18 : 204
-      end
-
-      # Conflict?
-      def p3
-        if resource.is_conflict?
-          409
-        else
-          res = accept_helper
-          (Fixnum === res) ? res : :p11
-        end
-      end
-
-      # New resource?
-      def p11
-        !response.headers["Location"] ? :o20 : 201
-      end
-
-    end # module Flow
-  end # module Decision
-end # module Webmachine

data/pkg/webmachine-0.4.0/lib/webmachine/decision/fsm.rb

@@ -1,70 +0,0 @@
-require 'webmachine/decision/helpers'
-require 'webmachine/decision/fsm'
-require 'webmachine/translation'
-
-module Webmachine
-  module Decision
-    # Implements the finite-state machine described by the Webmachine
-    # sequence diagram.
-    class FSM
-      include Flow
-      include Helpers
-      include Translation
-
-      attr_reader :resource, :request, :response, :metadata
-
-      def initialize(resource, request, response)
-        @resource, @request, @response = resource, request, response
-        @metadata = {}
-      end
-
-      # Processes the request, iteratively invoking the decision methods in {Flow}.
-      def run
-        state = Flow::START
-        loop do
-          response.trace << state
-          result = send(state)
-          case result
-          when Fixnum # Response code
-            respond(result)
-            break
-          when Symbol # Next state
-            state = result
-          else # You bwoke it
-            raise InvalidResource, t('fsm_broke', :state => state, :result => result.inspect)
-          end
-        end
-      rescue MalformedRequest => malformed
-        Webmachine.render_error(400, request, response, :message => malformed.message)
-        respond(400)
-      rescue => e # Handle all exceptions without crashing the server
-        error_response(e, state)
-      end
-
-      private
-      def respond(code, headers={})
-        response.headers.merge!(headers)
-        end_time = Time.now
-        case code
-        when 404
-          Webmachine.render_error(code, request, response)
-        when 304
-          response.headers.delete('Content-Type')
-          add_caching_headers
-        end
-        response.code = code
-        resource.finish_request
-        # TODO: add logging/tracing
-      end
-
-      # Renders a 500 error by capturing the exception information.
-      def error_response(exception, state)
-        response.error = [exception.message, exception.backtrace].flatten.join("\n    ")
-        response.end_state = state
-        Webmachine.render_error(500, request, response)
-        respond(500)
-      end
-
-    end # class FSM
-  end # module Decision
-end # module Webmachine

data/pkg/webmachine-0.4.0/lib/webmachine/decision/helpers.rb

@@ -1,104 +0,0 @@
-require 'webmachine/streaming'
-require 'webmachine/media_type'
-
-module Webmachine
-  module Decision
-    # Methods that assist the Decision {Flow}.
-    module Helpers
-      # Pattern for quoted headers
-      QUOTED = /^"(.*)"$/
-
-      # Determines if the response has a body/entity set.
-      def has_response_body?
-        !response.body.nil? && !response.body.empty?
-      end
-
-      # If the response body exists, encode it.
-      # @see #encode_body
-      def encode_body_if_set
-        encode_body if has_response_body?
-      end
-
-      # Encodes the body in the selected charset and encoding.
-      def encode_body
-        body = response.body
-        chosen_charset = metadata['Charset']
-        chosen_encoding = metadata['Content-Encoding']
-        charsetter = resource.charsets_provided && resource.charsets_provided.find {|c,_| c == chosen_charset }.last || :charset_nop
-        encoder = resource.encodings_provided[chosen_encoding]
-        response.body = case body
-                        when String # 1.8 treats Strings as Enumerable
-                          resource.send(encoder, resource.send(charsetter, body))
-                        when Fiber
-                          FiberEncoder.new(resource, encoder, charsetter, body)
-                        when Enumerable
-                          EnumerableEncoder.new(resource, encoder, charsetter, body)
-                        else
-                          if body.respond_to?(:call)
-                            CallableEncoder.new(resource, encoder, charsetter, body)
-                          else
-                            resource.send(encoder, resource.send(charsetter, body))
-                          end
-                        end
-        if String === response.body
-          response.headers['Content-Length'] = response.body.respond_to?(:bytesize) ? response.body.bytesize.to_s : response.body.length.to_s
-        else
-          response.headers.delete 'Content-Length'
-          response.headers['Transfer-Encoding'] = 'chunked'
-        end
-      end
-
-      # Ensures that a header is quoted (like ETag)
-      def ensure_quoted_header(value)
-        if value =~ QUOTED
-          value
-        else
-          '"' << value << '"'
-        end
-      end
-
-      # Unquotes request headers (like ETag)
-      def unquote_header(value)
-        if value =~ QUOTED
-          $1
-        else
-          value
-        end
-      end
-
-      # Assists in receiving request bodies
-      def accept_helper
-        content_type = MediaType.parse(request.content_type || 'application/octet-stream')
-        acceptable = resource.content_types_accepted.find {|ct, _| content_type.match?(ct) }
-        if acceptable
-          resource.send(acceptable.last)
-        else
-          415
-        end
-      end
-
-      # Computes the entries for the 'Vary' response header
-      def variances
-        resource.variances.tap do |v|
-          v.unshift "Accept-Language" if resource.languages_provided.size > 1
-          v.unshift "Accept-Charset" if resource.charsets_provided && resource.charsets_provided.size > 1
-          v.unshift "Accept-Encoding" if resource.encodings_provided.size > 1
-          v.unshift "Accept" if resource.content_types_provided.size > 1
-        end
-      end
-
-      # Adds caching-related headers to the response.
-      def add_caching_headers
-        if etag = resource.generate_etag
-          response.headers['ETag'] = ensure_quoted_header(etag)
-        end
-        if expires = resource.expires
-          response.headers['Expires'] = expires.httpdate
-        end
-        if modified = resource.last_modified
-          response.headers['Last-Modified'] = modified.httpdate
-        end
-      end
-    end # module Helpers
-  end # module Decision
-end # module Webmachine

data/pkg/webmachine-0.4.0/lib/webmachine/decision.rb

@@ -1,12 +0,0 @@
-require 'webmachine/decision/helpers'
-require 'webmachine/decision/conneg'
-require 'webmachine/decision/flow'
-require 'webmachine/decision/fsm'
-
-module Webmachine
-  # This module encapsulates the logic related to delivering the
-  # proper HTTP response, given the constraints of the {Request} and
-  # the {Resource} which is being processed.
-  module Decision
-  end
-end