rackful 0.0.2 → 0.1.0

data/README.md

@@ -1,2 +1,14 @@
-All documentation is available
-[here, as GitHub pages](http://pieterb.github.com/Rackful/).
+Rackful
+=======
+
+Library for creating Rackful web services
+
+The latest documentation is always available
+[here, as GitHub pages](http://pieterb.github.com/Rackful/).
+
+Licensing
+---------
+Copyright ©2011-2012 Pieter van Beek <pieterb@sara.nl>
+
+Licensed under the Apache License 2.0. You should have received a copy of the
+license as part of this distribution.

data/example/config.ru

@@ -1,26 +1,28 @@
-require File.dirname(__FILE__) + '/../lib/rackful.rb'
+require 'rackful'
+require 'rackful/header_spoofing'
+require 'rackful/method_spoofing'
+require 'rackful/relative_location'
 require 'digest/md5'
 
 # The class of the object we're going to serve:
 class Root
   include Rackful::Resource
-  def initialize *args
-    super
-    @content = 'Hello world!'
-  end
-  def do_GET request, response
-    response['Content-Type'] = 'text/plain'
-    response.write @content
+  attr_reader :to_rackful
+  def initialize
+    self.path = '/'
+    @to_rackful = 'Hello world!'
   end
   def do_PUT request, response
-    @content = request.body.read
-    response.status = status_code :no_content
+    @to_rackful = request.body.read.encode( Encoding::UTF_8 )
   end
-  def etag
-    '"' + Digest::MD5.new.update(@content).to_s + '"'
+  def get_etag
+    '"' + Digest::MD5.new.update(to_rackful).to_s + '"'
   end
+  add_serializer Rackful::XHTML, 1.0
+  add_serializer Rackful::JSON, 1.0
+  add_media_type 'text/plain'
 end
-$root_resource = Root.new '/'
+$root_resource = Root.new
 
 # Rackful::Server needs a resource factory which can map URIs to resource objects:
 class ResourceFactory
@@ -32,4 +34,8 @@ class ResourceFactory
   end
 end
 
+use Rackful::MethodSpoofing
+use Rackful::HeaderSpoofing
+use Rackful::RelativeLocation
+
 run Rackful::Server.new ResourceFactory.new

data/example/config2.ru

@@ -0,0 +1,41 @@
+require 'rack'
+require 'rackful/header_spoofing'
+require 'rackful/method_spoofing'
+require 'rackful/relative_location'
+
+# The class of the object we're going to serve:
+class Root
+  include Rackful::Resource
+  def initialize *args
+    super
+    @content = 'Hello world!'
+  end
+  def do_GET request, response
+    response['Content-Type'] = 'text/plain'
+    response.write @content
+  end
+  def do_PUT request, response
+    @content = request.body.read
+    response.status = status_code :no_content
+  end
+  def etag
+    '"' + Digest::MD5.new.update(@content).to_s + '"'
+  end
+end
+$root_resource = Root.new '/'
+
+# Rackful::Server needs a resource factory which can map URIs to resource objects:
+class ResourceFactory
+  def [] uri
+    case uri
+    when '/';   $root_resource
+    else;       nil
+    end
+  end
+end
+
+use Rackful::MethodSpoofing
+use Rackful::HeaderSpoofing
+use Rackful::RelativeLocation
+
+run Rackful::Server.new ResourceFactory.new

data/lib/rackful/header_spoofing.rb

@@ -12,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module Rackful
+require 'rackful'
 
-=begin
+=begin markdown
 Rack middleware that provides header spoofing.
 
 If you use this middleware, then clients are allowed to spoof an HTTP header
@@ -26,41 +26,48 @@ This can be useful if you want to specify certain request headers from within
 a normal web browser.
 @example Using this middleware
   use Rackful::HeaderSpoofing
+@since 0.0.1
 =end
-  class HeaderSpoofing
+class Rackful::HeaderSpoofing
 
-    def initialize app
-      @app = app
-    end
+def initialize app
+  @app = app
+end
 
-    def call env
-      before_call env
-      @app.call env
-      # after_call env
-    end
+def call env
+  before_call env
+  r = @app.call env
+  after_call env
+  r
+end
 
-    def before_call env
-      original_query_string = env['QUERY_STRING']
-      env['QUERY_STRING'] = original_query_string.
-        split('&', -1).
-        collect { |s| s.split('=', -1) }.
-        select {
-          |p|
-          if  /\A_http_([a-z]+(?:[\-_][a-z]+)*)\z/i === p[0]
-            header_name = p.shift.gsub('-', '_').upcase
-            env[header_name] = p.join('=')
-            false
-          else
-            true
-          end
-        }.
-        collect { |p| p.join('=') }.
-        join('&')
-      if original_query_string != env['QUERY_STRING']
-        env['rackful.header_spoofing.query_string'] ||= original_query_string
+def before_call env
+  original_query_string = env['QUERY_STRING']
+  env['QUERY_STRING'] = original_query_string.
+    split('&', -1).
+    collect { |s| s.split('=', -1) }.
+    select {
+      |p|
+      if  /\A_http_([a-z]+(?:[\-_][a-z]+)*)\z/i === p[0]
+        header_name = p.shift.gsub('-', '_').upcase[1..-1]
+        env[header_name] = p.join('=')
+        false
+      else
+        true
       end
-    end
+    }.
+    collect { |p| p.join('=') }.
+    join('&')
+  if original_query_string != env['QUERY_STRING']
+    env['rackful.header_spoofing.query_string'] ||= original_query_string
+  end
+end
 
+def after_call env
+  if original_query_string = env['rackful.header_spoofing.query_string']
+    env['rackful.header_spoofing.query_string'] = env['QUERY_STRING']
+    env['QUERY_STRING'] = original_query_string
   end
+end
 
-end
+end # Rackful::HeaderSpoofing

data/lib/rackful/method_spoofing.rb

@@ -14,9 +14,7 @@
 
 require 'rackful'
 
-module Rackful
-
-=begin
+=begin markdown
 Rack middleware that provides method spoofing.
 
 If you use this middleware, then clients are allowed to spoof an HTTP method
@@ -37,68 +35,68 @@ In that case, you can put the parameters in a `POST` body, like this:
     param_1=hello&param_2=world&param_3=...
 @example Using this middleware
   use Rackful::MethodSpoofing
+@since 0.0.1
 =end
-  class MethodSpoofing
+class Rackful::MethodSpoofing
 
-    def initialize app
-      @app = app
-    end
+def initialize app
+  @app = app
+end
 
-    def call env
-      before_call env
-      @app.call env
-      after_call env
-    end
+def call env
+  before_call env
+  r = @app.call env
+  after_call env
+  r
+end
 
-    def before_call env
-      return unless ['GET', 'POST'].include? env['REQUEST_METHOD']
-      original_query_string = env['QUERY_STRING']
-      new_method = nil
-      env['QUERY_STRING'] = original_query_string.
-        split('&', -1).
-        collect { |s| s.split('=', -1) }.
-        select {
-          |p|
-          if  /_method/i   === p[0] &&
-              /\A[A-Z]+\z/ === ( method = p[1..-1].join('=').upcase ) &&
-              ! new_method
-            new_method = method
-            false
-          else
-            true
-          end
-        }.
-        collect { |p| p.join('=') }.
-        join('&')
-      if new_method
-        if  'GET' == new_method &&
-            'POST' == env['REQUEST_METHOD'] &&
-            'application/x-www-form-urlencoded' == env['CONTENT_TYPE']
-          unless env['QUERY_STRING'].empty
-            env['QUERY_STRING'] = env['QUERY_STRING'] + '&'
-          end
-          begin
-            env['QUERY_STRING'] = env['QUERY_STRING'] + env['rack.input'].read
-            env['rack.input'].rewind
-          end
-          env['rackful.method_spoofing.input'] = env['rack.input']
-          env.delete 'rack.input'
-          env.delete 'CONTENT_TYPE'
-          env.delete 'CONTENT_LENGTH' if env.key? 'CONTENT_LENGTH'
-        end
-        env['rackful.method_spoofing.QUERY_STRING'] ||= original_query_string
-        env['rackful.method_spoofing.REQUEST_METHOD'] = env['REQUEST_METHOD']
-        env['REQUEST_METHOD'] = new_method
+def before_call env
+  return unless ['GET', 'POST'].include? env['REQUEST_METHOD']
+  original_query_string = env['QUERY_STRING']
+  new_method = nil
+  env['QUERY_STRING'] = original_query_string.
+    split('&', -1).
+    collect { |s| s.split('=', -1) }.
+    select {
+      |p|
+      if  /_method/i   === p[0] &&
+          /\A[A-Z]+\z/ === ( method = p[1..-1].join('=').upcase ) &&
+          ! new_method
+        new_method = method
+        false
+      else
+        true
       end
-    end
-
-    def after_call env
-      if env.key? 'rackful.method_spoofing.input'
-        env['rack.input'] = env['rackful.method_spoofing.input']
-        env.delete 'rackful.input'
+    }.
+    collect { |p| p.join('=') }.
+    join('&')
+  if new_method
+    if  'GET' == new_method &&
+        'POST' == env['REQUEST_METHOD'] &&
+        'application/x-www-form-urlencoded' == env['CONTENT_TYPE']
+      unless env['QUERY_STRING'].empty
+        env['QUERY_STRING'] = env['QUERY_STRING'] + '&'
+      end
+      begin
+        env['QUERY_STRING'] = env['QUERY_STRING'] + env['rack.input'].read
+        env['rack.input'].rewind
       end
+      env['rackful.method_spoofing.input'] = env['rack.input']
+      env.delete 'rack.input'
+      env.delete 'CONTENT_TYPE'
+      env.delete 'CONTENT_LENGTH' if env.key? 'CONTENT_LENGTH'
     end
-
+    env['rackful.method_spoofing.QUERY_STRING'] ||= original_query_string
+    env['rackful.method_spoofing.REQUEST_METHOD'] = env['REQUEST_METHOD']
+    env['REQUEST_METHOD'] = new_method
   end
+end
 
+def after_call env
+  if env.key? 'rackful.method_spoofing.input'
+    env['rack.input'] = env['rackful.method_spoofing.input']
+    env.delete 'rackful.method_spoofing.input'
+  end
 end
+
+end # Rackful::MethodSpoofing

data/lib/rackful/relative_location.rb

@@ -12,11 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
+require 'rackful'
 require 'rack/request'
 
-module Rackful
-
 =begin markdown
 Rack middleware, inspired by {Rack::RelativeRedirect}.
 
@@ -31,28 +29,44 @@ Differences with {Rack::RelativeRedirect}:
 -   uses Rack::Request::base_url for creating absolute URIs.
 -   the `Location:` header, if present, is always rectified, independent of the
     HTTP status code.
+@since 0.0.1
 =end
-class RelativeLocation
+class Rackful::RelativeLocation
 
-  def initialize(app)
-    @app = app
-  end
+def initialize(app)
+  @app = app
+end
 
-  def call(env)
-    res = @app.call(env)
-    if ( location = res[1]['Location'] ) and
-       ! %r{\A[a-z]+://}.match(location)
-      request = Rack::Request.new env
-      unless '/' == location[0, 1]
-        path = request.path.dup
-        path[ %r{[^/]*\z} ] = ''
-        location = File.expand_path( location, path )
-      end
-      res[1]['Location'] = request.base_url + location
+def call_old(env)
+  res = @app.call(env)
+  if ( location = res[1]['Location'] ) and
+     ! %r{\A[a-z]+://}.match(location)
+    request = Rack::Request.new env
+    unless '/' == location[0, 1]
+      path = ( res[1]['Content-Location'] || request.path ).dup
+      path[ %r{[^/]*\z} ] = ''
+      location = File.expand_path( location, path )
     end
-    res
+    if '/' == location[0, 1]
+      location = request.base_url + location
+    end
+    res[1]['Location'] = location
   end
+  res
+end
 
-end # RelativeLocation
+def call(env)
+  res = @app.call(env)
+  request = nil
+  ['Location', 'Content-Location'].each do
+    |header|
+    if  ( location = res[1][header] ) and
+        '/' == location[0,1]
+      request ||= Rack::Request.new env
+      res[1][header] = request.base_url + location
+    end
+  end
+  res
+end
 
-end # Rackful
+end # Rackful::RelativeLocation