rackful 0.0.1

data/LICENSE.md

@@ -0,0 +1,230 @@
+<big>Apache License</big>
+
+Version 2.0, January 2004  
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+============================================================
+
+Definitions
+--------------
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means
+
+1.  the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or
+2.  ownership of fifty percent (50%) or more of the
+    outstanding shares, or
+3.  beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+Grant of Copyright License
+-----------------------------
+
+Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+Grant of Patent License
+--------------------------
+
+Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+Redistribution
+-----------------
+
+You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+1.  You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+2.  You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+3.  You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+4.  If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+Submission of Contributions
+------------------------------
+
+Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+Trademarks
+-------------
+
+This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+Disclaimer of Warranty
+-------------------------
+
+Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+Limitation of Liability
+--------------------------
+
+In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+Accepting Warranty or Additional Liability
+---------------------------------------------
+
+While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+APPENDIX: How to apply the Apache License to your work
+======================================================
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included
+on the same "printed page" as the copyright notice for easier identification
+within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+        http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/README.md

@@ -0,0 +1,2 @@
+All documentation is available
+[here, as GitHub pages](http://pieterb.github.com/Rackful/).

data/example/config.ru

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../lib/rackful.rb'
+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
+  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
+
+run Rackful::Server.new ResourceFactory.new

data/lib/rackful/header_spoofing.rb

@@ -0,0 +1,66 @@
+# Copyright ©2011-2012 Pieter van Beek <pieterb@sara.nl>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Rackful
+
+=begin
+Rack middleware that provides header spoofing.
+
+If you use this middleware, then clients are allowed to spoof an HTTP header
+by specifying a `_http_SOME_HEADER=...` request parameter, for example:
+
+    http://example.com/some_resource?_http_DEPTH=infinity
+
+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
+=end
+  class HeaderSpoofing
+
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      before_call env
+      @app.call env
+      # after_call env
+    end
+
+    def handle_header_spoofing 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
+      end
+    end
+
+  end
+
+end

data/lib/rackful/method_spoofing.rb

@@ -0,0 +1,104 @@
+# Copyright ©2011-2012 Pieter van Beek <pieterb@sara.nl>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rackful'
+
+module Rackful
+
+=begin
+Rack middleware that provides method spoofing.
+
+If you use this middleware, then clients are allowed to spoof an HTTP method
+by specifying a `_method=...` request parameter, for example:
+
+    http://example.com/some_resource?_method=DELETE
+
+This can be useful if you want to perform `PUT` and `DELETE` requests from
+within a browser, of when you want to perform a `GET` requests with (too)
+many parameters, exceeding the maximum URI length in your client or server.
+In that case, you can put the parameters in a `POST` body, like this:
+
+    POST /some_resource HTTP/1.1
+    Host: example.com
+    Content-Type: application/x-www-form-urlencoded
+    Content-Length: 123456789
+
+    param_1=hello&param_2=world&param_3=...
+@example Using this middleware
+  use Rackful::MethodSpoofing
+=end
+  class MethodSpoofing
+
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      before_call env
+      @app.call env
+      after_call env
+    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
+      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'
+      end
+    end
+
+  end
+
+end

data/lib/rackful/relative_location.rb

@@ -0,0 +1,58 @@
+# Copyright ©2011-2012 Pieter van Beek <pieterb@sara.nl>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'rack/request'
+
+module Rackful
+
+=begin markdown
+Rack middleware, inspired by {Rack::RelativeRedirect}.
+
+This middleware allows you to return a relative or absolute path your +Location:+
+response header.
+This was common practice in HTTP/1.0, but HTTP/1.1 requires a full URI in the
++Location:+ header.
+This middleware automatically translates your path to a full URI.
+
+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.
+=end
+class RelativeLocation
+
+  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
+    end
+    res
+  end
+
+end # RelativeLocation
+
+end # Rackful