rackful 0.1.4 → 0.2.0

data/lib/rackful/http_status.rb

@@ -1,285 +0,0 @@
-# Required for parsing:
-require 'rackful/resource.rb'
-require 'rackful/serializer.rb'
-
-# Required for running
-require 'rexml/rexml'
-
-
-module Rackful
-
-=begin markdown
-Exception which represents an HTTP Status response.
-@abstract
-=end
-class HTTPStatus < RuntimeError
-
-
-  include Resource
-  
-  
-  attr_reader :status, :headers, :to_rackful
-
-
-=begin markdown
-@param [Symbol, Integer] status e.g. `404` or `:not_found`
-@param [String] message XHTML
-@param [ { Symbol => Object }, { String => String } ] info
-    *   If the Hash is indexed by {Symbol}s, then the values will be returned in
-        the response body.
-    *   If the Hash is indexed by {String}s, the +key => value+ pairs are returned
-        as response headers.
-=end
-  def initialize status, message = nil, info = {}
-    self.path = Request.current.path
-    @status = status_code status
-    raise "Wrong status: #{status}" if 0 === @status
-    message ||= ''
-    @headers = {}
-    @to_rackful = {}
-    info.each do
-      |k, v|
-      if k.kind_of? Symbol then @to_rackful[k] = v
-      else @headers[k] = v end
-    end
-    @to_rackful = nil if @to_rackful.empty?
-    begin
-      REXML::Document.new \
-        '<?xml version="1.0" encoding="UTF-8" ?>' +
-        "<div>#{message}</div>"
-    rescue
-      message = Rack::Utils.escape_html(message)
-    end
-    super message
-    if 500 <= @status
-      errors = Request.current.env['rack.errors']
-      errors.puts self.inspect
-      errors.puts "Headers: #{@headers.inspect}"
-      errors.puts "Info: #{@to_rackful.inspect}"
-    end
-  end
-  
-  
-  def title
-    "#{status} #{HTTP_STATUS_CODES[status]}"
-  end
-
-
-  class XHTML < ::Rackful::XHTML
-
-
-    def header
-      super + <<EOS
-<h1>HTTP/1.1 #{Rack::Utils.escape_html(resource.title)}</h1>
-<div id="rackful_description">#{resource.message}</div>
-EOS
-    end
-
-
-    def headers; self.resource.headers; end
-    
-    
-  end # class HTTPStatus::XHTML
-
-
-  #~ class JSON < ::Rackful::JSON
-#~ 
-#~ 
-    #~ def headers; self.resource.headers; end
-#~ 
-#~ 
-    #~ def each &block
-      #~ super( [ self.resource.message, self.resource.to_rackful ], &block )
-    #~ end
-#~ 
-#~ 
-  #~ end # class HTTPStatus::XHTML
-
-
-  add_serializer XHTML, 1.0
-
-
-end # class Rackful::HTTPStatus
-
-
-=begin markdown
-@abstract Base class for HTTP status codes with only a simple text message, or
-  no message at all.
-=end
-class HTTPSimpleStatus < HTTPStatus
-
-  def initialize message = nil
-    /HTTP(\d\d\d)\w+\z/ === self.class.to_s
-    status = $1.to_i
-    super( status, message )
-  end
-
-end
-
-
-class HTTP201Created < HTTPStatus
-
-  def initialize locations
-    locations = [ locations ] unless locations.kind_of? Array
-    locations = locations.collect { |l| l.to_path }
-    rf = Request.current.resource_factory
-    if locations.size > 1
-      locations = locations.collect {
-        |l|
-        resource = rf[l]
-        { :location => l }.merge( resource.default_headers )
-        rf.uncache l if rf.respond_to? :uncache
-      }
-      super(
-        201, 'New resources were created:', :locations => locations
-      )
-    else
-      location = locations[0]
-      resource = rf[location]
-      super(
-        201, 'A new resource was created:', {
-          :location => location,
-          'Location' => location
-        }.merge( resource.default_headers )
-      )
-    end
-  end
-
-end # class HTTP201Created
-
-
-class HTTP202Accepted < HTTPStatus
-
-  def initialize location = nil
-    if location
-      super(
-        202, '', {
-          :'Job status location:' => Path.new(locations),
-          'Location' => locations
-        }
-      )
-    else
-      super 202
-    end
-  end
-
-end # class HTTP202Accepted
-
-
-class HTTP301MovedPermanently < HTTPStatus
-
-  def initialize location
-    super(
-      301, '', {
-        :'New location:' => Path.new(location),
-        'Location' => location
-      }
-    )
-  end
-
-end
-
-
-class HTTP303SeeOther < HTTPStatus
-
-  def initialize location
-    super(
-      303, '', {
-        :'See:' => Path.new(location),
-        'Location' => location
-      }
-    )
-  end
-
-end
-
-
-class HTTP304NotModified < HTTPStatus
-
-  def initialize
-    super( 304 )
-  end
-
-end
-
-
-class HTTP307TemporaryRedirect < HTTPStatus
-
-  def initialize location
-    super(
-      301, '', {
-        :'Current location:' => Path.new(location),
-        'Location' => location
-      }
-    )
-  end
-
-end
-
-
-class HTTP400BadRequest < HTTPSimpleStatus; end
-
-class HTTP403Forbidden < HTTPSimpleStatus; end
-
-class HTTP404NotFound < HTTPSimpleStatus; end
-
-
-class HTTP405MethodNotAllowed < HTTPStatus
-
-  def initialize methods
-    super 405, '', 'Allow' => methods.join(', '),
-          :'Allowed methods:' => methods
-  end
-
-end
-
-
-class HTTP406NotAcceptable < HTTPStatus
-
-  def initialize content_types
-    super 406, '',
-          :'Available content-type(s):' => content_types
-  end
-
-end
-
-
-class HTTP409Conflict < HTTPSimpleStatus; end
-
-class HTTP410Gone < HTTPSimpleStatus; end
-
-class HTTP411LengthRequired < HTTPSimpleStatus; end
-
-
-class HTTP412PreconditionFailed < HTTPStatus
-
-  def initialize header = nil
-    info =
-      if header
-        { header.to_sym => Request.current.env[ 'HTTP_' + header.gsub('-', '_').upcase ] }
-      else
-        {}
-      end
-    super 412, 'Failed precondition:', info
-  end
-
-end
-
-
-class HTTP415UnsupportedMediaType < HTTPStatus
-
-  def initialize media_types
-    super 415, '',
-          :'Supported media-type(s):' => media_types
-  end
-
-end
-
-
-class HTTP422UnprocessableEntity < HTTPSimpleStatus; end
-
-class HTTP501NotImplemented < HTTPSimpleStatus; end
-
-class HTTP503ServiceUnavailable < HTTPSimpleStatus; end
-
-end # module Rackful

data/lib/rackful/middleware/header_spoofing.rb

@@ -1,72 +0,0 @@
-# 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'
-
-=begin markdown
-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 Rackful::HeaderSpoofing
-
-def initialize app
-  @app = app
-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[1..-1]
-        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
-
-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 # Rackful::HeaderSpoofing

data/lib/rackful/middleware/method_spoofing.rb

@@ -1,101 +0,0 @@
-# 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'
-
-=begin markdown
-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 Rackful::MethodSpoofing
-
-def initialize app
-  @app = app
-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
-  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