RubyGems - rackful - Versions diffs - 0.2.0 → 0.2.1 - Mend

rackful 0.2.0 → 0.2.1

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 (16) hide show

checksums.yaml +4 -4
data/example/config.ru +11 -10
data/lib/rackful.rb +9 -5
data/lib/rackful/global.rb +12 -0
data/lib/rackful/httpstatus.rb +50 -51
data/lib/rackful/middleware.rb +5 -0
data/lib/rackful/middleware/headerspoofing.rb +7 -1
data/lib/rackful/middleware/methodoverride.rb +8 -2
data/lib/rackful/parser.rb +80 -101
data/lib/rackful/request.rb +100 -129
data/lib/rackful/resource.rb +263 -207
data/lib/rackful/serializer.rb +46 -17
data/lib/rackful/server.rb +25 -33
data/lib/rackful/uri.rb +8 -0
data/rackful.gemspec +1 -1
metadata +3 -2

data/lib/rackful/serializer.rb CHANGED Viewed

@@ -1,17 +1,26 @@
 # encoding: utf-8
+# Required for parsing:
+require 'rackful/global.rb'
-module Rackful
+# Required for running:
+module Rackful
 # Base class for all serializers.
 #
 # The serializers {Serializer::XHTML} and {Serializer::JSON} defined in this
 # library depend on the presence of method
 # {Rackful::Resource#to_rackful resource.to_rackful}.
-# @abstract Subclasses must implement method `#each` end define constant
-#   `CONTENT_TYPES`
+# @abstract Subclasses must implement method `#each` and call {::produces}
+# @example Create a new Serializer subclass:
+#   class MySerializer < Rackful::Serializer
+#     produces 'text/plain'
+#     def each
+#       yield 'Hello world!'
+#     end
+#   end
 # @!attribute [r] request
 #   @return [Request]
 # @!attribute [r] resource
@@ -22,7 +31,35 @@ module Rackful
 class Serializer
+  class << self
+    def content_types
+      @content_types ||= begin
+        retval = rackful_serializer_content_types
+        if superclass.respond_to?(:content_types)
+          retval += superclass.content_types
+        end
+        retval.uniq
+      end
+    end
+    # @overload parses( media_type, ... )
+    #   @param media_type [String]
+    def produces *args
+      rackful_serializer_content_types.unshift(
+        *( args.map { |ct| ct.to_s }.reverse )
+      )
+      rackful_serializer_content_types.uniq!
+      self
+    end
+    private
+    def rackful_serializer_content_types
+      @rackful_serializer_content_types ||= []
+    end
+  end # class << self # Rackful::Serializer
   include Enumerable
+  include StatusCodes
   attr_reader :request, :resource, :content_type
@@ -63,12 +100,10 @@ class Serializer::XHTML < Serializer
   # The content types served by this serializer.
   # @see Serializer::CONTENT_TYPES
-  CONTENT_TYPES = [
-    'application/xml; charset=UTF-8',
-    'text/xml; charset=UTF-8',
-    'text/html; charset=UTF-8',
-    'application/xhtml+xml; charset=UTF-8',
-  ]
+  produces  'application/xml; charset=UTF-8',
+            'text/xml; charset=UTF-8',
+            'text/html; charset=UTF-8',
+            'application/xhtml+xml; charset=UTF-8'
   # @api private
   # @return [URI::HTTP]
@@ -86,9 +121,7 @@ class Serializer::XHTML < Serializer
     tmp = ''
     # The XML header is only sent for XML media types:
     if /xml/ === self.content_type
-      tmp += <<EOS
-<?xml version="1.0" encoding="UTF-8"?>
-EOS
+      tmp += "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
     end
     tmp += <<EOS
 <!DOCTYPE html>
@@ -271,10 +304,7 @@ end # class Serializer::XHTML
 class Serializer::JSON < Serializer
-  CONTENT_TYPES = [
-    'application/json',
-    'application/x-json'
-  ]
+  produces 'application/json', 'application/x-json'
   # @yield [json]
@@ -312,5 +342,4 @@ class Serializer::JSON < Serializer
 end # class Serializer::JSON
 end # module Rackful

data/lib/rackful/server.rb CHANGED Viewed

@@ -1,7 +1,17 @@
+# encoding: utf-8
+# Required for parsing:
+require 'rackful/global.rb'
+# Required for running:
 module Rackful
 # Rack compliant server class for implementing RESTful web services.
-class Server
+class Rackful::Server
+  include StatusCodes
   # Constructor.
@@ -21,57 +31,36 @@ class Server
   # @yieldparam uri [URI::Generic] The {URI::Generic::normalize! normalized}
   #   URI of the requested resource.
   # @yieldreturn [Resource] A (possibly {Resource#empty? empty}) resource, or nil.
-  def initialize( &resource_registry )
+  def initialize &resource_registry
     @resource_registry = resource_registry
   end
-  # Calls the code block passed to the {#initialize constructor}.
-  # @param uri [URI::HTTP, String]
-  # @return [Resource]
-  # @raise [HTTP404NotFound]
-  def resource_at(uri)
-    uri = URI(uri) unless uri.kind_of?( URI::Generic )
-    retval = @resource_registry.call( uri.normalize )
-    raise HTTP404NotFound unless retval
-    retval
-  end
   # As required by the Rack specification.
   #
-  # For thread safety, this method clones `self`, which handles the request in
-  # {#call!}.
-  # For reentrancy, the clone is stored in the environment.
   # @param env [{String => Mixed}]
   # @return [(status_code, response_headers, response_body)]
   def call( env )
-    ( env['rackful.server'] ||= self.dup ).call!( env )
-  end
-  # @see #call
-  # @return [(status_code, response_headers, response_body)]
-  def call!( env )
+    env['rackful.resource_registry'] ||= @resource_registry
     request = Request.new( env )
     response = Rack::Response.new
     begin
-      resource = resource_at( request.url )
-      request.canonical_uri = resource.uri
+      resource = request.resource
       if request.url != request.canonical_uri.to_s
         if %w{HEAD GET}.include?( request.request_method )
+          raise HTTP404NotFound if resource.empty?
           raise HTTP301MovedPermanently, request.canonical_uri
         end
         response.header['Content-Location'] = request.canonical_uri.to_s
       end
-      request.assert_if_headers resource
-      if %w{HEAD GET OPTIONS PUT DELETE}.include?( request.request_method )
+      request.assert_if_headers
+      if %w{HEAD GET OPTIONS PATCH POST PUT DELETE}.include?( request.request_method )
         resource.__send__( :"http_#{request.request_method}", request, response )
       else
         resource.http_method request, response
       end
     rescue HTTPStatus => e
-      serializer = e.serializer(request)
+      serializer = e.serializer(request, false)
       response = Rack::Response.new
       response['Content-Type'] = serializer.content_type
       response.status = e.status
@@ -88,22 +77,25 @@ class Server
     begin
       if  201 == response.status &&
           ( location = response['Location'] ) &&
-          ( new_resource = resource_at( location ) ) &&
+          ( new_resource = request.resource_at( location ) ) &&
           ! new_resource.empty? \
       or  ( (200...300) === response.status ||
              304        ==  response.status ) &&
           ! response['Location'] &&
-          ( new_resource = resource_at( request.canonical_uri ) ) &&
+          ( new_resource = request.resource_at( request.canonical_uri ) ) &&
           ! new_resource.empty?
         response.headers.merge! new_resource.default_headers
       end
+      # Make sure the Location: response header contains an absolute URI:
+      if  response['Location'] and response['Location'][0] == ?/
+        response['Location'] = request.canonical_uri + response['Location']
+      end
     rescue HTTP404NotFound => e
     end
     response.finish
   end
-end # class Server
+end # class Rackful::Server
 end # module Rackful

data/lib/rackful/uri.rb CHANGED Viewed

@@ -1,3 +1,11 @@
+# encoding: utf-8
+# This file is required by `src/global.rb`.
+# Required for parsing:
+require 'uri'
+# Required for running:
 # Extension and monkeypatch of Ruby’s StdLib URI::Generic class.
 class URI::Generic

data/rackful.gemspec CHANGED Viewed

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   # Required properties:
   s.name        = 'rackful'
-  s.version     = '0.2.0'
+  s.version     = '0.2.1'
   s.summary     = "Library for building ReSTful web services with Rack"
   s.description = <<EOS
 Rackful provides a minimal interface for developing ReSTful web services with

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rackful
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Pieter van Beek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -55,6 +55,7 @@ files:
 - README.md
 - example/config.ru
 - lib/rackful.rb
+- lib/rackful/global.rb
 - lib/rackful/httpstatus.rb
 - lib/rackful/middleware.rb
 - lib/rackful/middleware/headerspoofing.rb