RubyGems - rackful - Versions diffs - 0.1.2 → 0.1.3 - Mend

rackful 0.1.2 → 0.1.3

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

data/example/config.ru +6 -3
data/lib/rackful.rb +6 -6
data/lib/{rackful_http_status.rb → rackful/http_status.rb} +39 -42
data/lib/rackful/middleware.rb +3 -0
data/lib/rackful/{header_spoofing.rb → middleware/header_spoofing.rb} +4 -5
data/lib/rackful/{method_spoofing.rb → middleware/method_spoofing.rb} +0 -1
data/lib/rackful/{relative_location.rb → middleware/relative_location.rb} +0 -1
data/lib/rackful/path.rb +179 -0
data/lib/{rackful_request.rb → rackful/request.rb} +6 -15
data/lib/{rackful_resource.rb → rackful/resource.rb} +125 -101
data/lib/{rackful_serializer.rb → rackful/serializer.rb} +159 -80
data/lib/{rackful_server.rb → rackful/server.rb} +3 -8
data/rackful.gemspec +3 -3
metadata +57 -55
data/example/config2.ru +0 -41
data/lib/rackful_path.rb +0 -119

data/example/config.ru CHANGED Viewed

@@ -1,7 +1,10 @@
+# Load core functionality:
 require 'rackful'
-require 'rackful/header_spoofing'
-require 'rackful/method_spoofing'
-require 'rackful/relative_location'
+# Load extra middlewares: ({Rackful::MethodSpoofing}, {Rackful::HeaderSpoofing},
+# Rackful::RelativeLocation})
+require 'rackful/middleware'
 require 'digest/md5'
 # The class of the object we're going to serve:

data/lib/rackful.rb CHANGED Viewed

@@ -1,6 +1,6 @@
-require 'rackful_path.rb'
-require 'rackful_request.rb'
-require 'rackful_serializer.rb'
-require 'rackful_resource.rb'
-require 'rackful_http_status.rb'
-require 'rackful_server.rb'
+require 'rackful/path.rb'
+require 'rackful/request.rb'
+require 'rackful/serializer.rb'
+require 'rackful/resource.rb'
+require 'rackful/http_status.rb'
+require 'rackful/server.rb'

data/lib/{rackful_http_status.rb → rackful/http_status.rb} RENAMED Viewed

@@ -1,6 +1,6 @@
 # Required for parsing:
-require 'rackful_resource.rb'
-require 'rackful_serializer.rb'
+require 'rackful/resource.rb'
+require 'rackful/serializer.rb'
 # Required for running
 require 'rexml/rexml'
@@ -10,25 +10,30 @@ module Rackful
 =begin markdown
 Exception which represents an HTTP Status response.
-@since 0.1.0
 @abstract
 =end
 class HTTPStatus < RuntimeError
   include Resource
   attr_reader :status, :headers, :to_rackful
 =begin markdown
-@param message [String] XHTML
-@param status [Symbol, Integer] e.g. `404` or `:not_found`
-@param headers [Hash] HTTP response headers
+@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
+    raise "Wrong status: #{status}" if 0 === @status
     message ||= ''
     @headers = {}
     @to_rackful = {}
@@ -53,30 +58,42 @@ class HTTPStatus < RuntimeError
       errors.puts "Info: #{@to_rackful.inspect}"
     end
   end
+  def title
+    "#{status} #{HTTP_STATUS_CODES[status]}"
+  end
   class XHTML < ::Rackful::XHTML
-    HTTP_STATUS_CODES = Rack::Utils::HTTP_STATUS_CODES
     def header
-      <<EOS
-<title>#{self.resource.status} #{HTTP_STATUS_CODES[self.resource.status]}</title>
-</head><body>
-<h1>HTTP/1.1 #{self.resource.status} #{HTTP_STATUS_CODES[self.resource.status]}</h1>
-<div id="rackful_description">#{self.resource.message}</div>
+      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
+    def headers; self.resource.headers; end
+  end # class HTTPStatus::XHTML
-  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
@@ -88,7 +105,6 @@ end # class Rackful::HTTPStatus
 =begin markdown
 @abstract Base class for HTTP status codes with only a simple text message, or
   no message at all.
-@since 0.1.0
 =end
 class HTTPSimpleStatus < HTTPStatus
@@ -101,7 +117,6 @@ class HTTPSimpleStatus < HTTPStatus
 end
-# @since 0.1.0
 class HTTP201Created < HTTPStatus
   def initialize locations
@@ -133,7 +148,6 @@ class HTTP201Created < HTTPStatus
 end # class HTTP201Created
-# @since 0.1.0
 class HTTP202Accepted < HTTPStatus
   def initialize location = nil
@@ -152,7 +166,6 @@ class HTTP202Accepted < HTTPStatus
 end # class HTTP202Accepted
-# @since 0.1.0
 class HTTP301MovedPermanently < HTTPStatus
   def initialize location
@@ -167,7 +180,6 @@ class HTTP301MovedPermanently < HTTPStatus
 end
-# @since 0.1.0
 class HTTP303SeeOther < HTTPStatus
   def initialize location
@@ -182,17 +194,15 @@ class HTTP303SeeOther < HTTPStatus
 end
-# @since 0.1.0
 class HTTP304NotModified < HTTPStatus
-  def initialize location
-    super( 304, nil, self.resource.default_headers )
+  def initialize
+    super( 304 )
   end
 end
-# @since 0.1.0
 class HTTP307TemporaryRedirect < HTTPStatus
   def initialize location
@@ -207,17 +217,13 @@ class HTTP307TemporaryRedirect < HTTPStatus
 end
-# @since 0.1.0
 class HTTP400BadRequest < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP403Forbidden < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP404NotFound < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP405MethodNotAllowed < HTTPStatus
   def initialize methods
@@ -228,7 +234,6 @@ class HTTP405MethodNotAllowed < HTTPStatus
 end
-# @since 0.1.0
 class HTTP406NotAcceptable < HTTPStatus
   def initialize content_types
@@ -239,17 +244,13 @@ class HTTP406NotAcceptable < HTTPStatus
 end
-# @since 0.1.0
 class HTTP409Conflict < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP410Gone < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP411LengthRequired < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP412PreconditionFailed < HTTPStatus
   def initialize header = nil
@@ -265,24 +266,20 @@ class HTTP412PreconditionFailed < HTTPStatus
 end
-# @since 0.1.0
 class HTTP415UnsupportedMediaType < HTTPStatus
   def initialize media_types
-    super 405, '',
+    super 415, '',
           :'Supported media-type(s):' => media_types
   end
 end
-# @since 0.1.0
 class HTTP422UnprocessableEntity < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP501NotImplemented < HTTPSimpleStatus; end
-# @since 0.1.0
 class HTTP503ServiceUnavailable < HTTPSimpleStatus; end
 end # module Rackful

data/lib/rackful/middleware.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'rackful/middleware/header_spoofing.rb'
+require 'rackful/middleware/method_spoofing.rb'
+require 'rackful/middleware/relative_location.rb'

data/lib/rackful/{header_spoofing.rb → middleware/header_spoofing.rb} RENAMED Viewed

@@ -26,7 +26,6 @@ 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 Rackful::HeaderSpoofing
@@ -64,10 +63,10 @@ def before_call env
 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
+  #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/{method_spoofing.rb → middleware/method_spoofing.rb} RENAMED Viewed

@@ -35,7 +35,6 @@ 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 Rackful::MethodSpoofing

data/lib/rackful/{relative_location.rb → middleware/relative_location.rb} RENAMED Viewed

@@ -29,7 +29,6 @@ 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 Rackful::RelativeLocation

data/lib/rackful/path.rb ADDED Viewed

@@ -0,0 +1,179 @@
+# Required for parsing:
+# Required for running:
+require 'rack/utils'
+# A String monkeypatch
+# @private
+class String
+  # @return [Rackful::Path]
+  def to_path; Rackful::Path.new(self); end
+end
+module Rackful
+# Relative URI (a path)
+class Path < String
+  # @return [self]
+  def to_path; self; end
+  # @return [Path] a copy of `self`, with a trailing slash.
+  def slashify
+    r = self.dup
+    r << '/' if '/' != r[-1,1]
+    r
+  end
+  # Adds a trailing slash to `self` if necessary.
+  # @return [self]
+  def slashify!
+    if '/' != self[-1,1]
+      self << '/'
+    else
+      nil
+    end
+    self
+  end
+  # @return [Path]a copy of `self` without a trailing slash.
+  def unslashify
+    r = self.dup
+    r = r.chomp( '/' ) if '/' == r[-1,1]
+    r
+  end
+  # Removes a trailing slash from `self`.
+  # @return [self]
+  def unslashify!
+    if '/' == self[-1,1]
+      self.chomp! '/'
+    else
+      nil
+    end
+    self
+  end
+  # @param [Encoding] encoding the character encoding to presume for `self`
+  # @return [String] the unescaped version of `self`
+  def unescape( encoding = Encoding::UTF_8 ); Rack::Utils.unescape(self, encoding); end
+  # @return [Array<String>] Unencoded segments
+  def segments( encoding = Encoding::UTF_8 )
+    r = self.split('/').collect { |s| Rack::Utils.unescape( s, encoding ) }
+    r.shift
+    r
+  end
+  # Turns a relative URI (starting with `/`) into a relative path (starting with `./`)
+  # @param path [Path]
+  # @return [String] a relative URI
+  def relative base_path = Request.current.base_path
+    case self
+    when base_path
+      # RFC2396, Section 4.2
+      return ''
+    when %r{(?:\A|/)\.\.?(?:/|\z)}
+      # self has abnormal absolute path,
+      # like "/./", "/../", "/x/../", ...
+      return self.dup
+    end
+    src_path = base_path.scan(%r{(?:\A|[^/]+)/})
+    dst_path = self.scan(%r{(?:\A|[^/]+)/?})
+    # discard same parts
+    while !dst_path.empty? && dst_path.first == src_path.first
+      src_path.shift
+      dst_path.shift
+    end
+    tmp = dst_path.join
+    # calculate
+    if src_path.empty?
+      if tmp.empty?
+        return './'
+      elsif dst_path.first.include?(':') # (see RFC2396 Section 5)
+        return './' + tmp
+      else
+        return tmp
+      end
+    end
+    return '../' * src_path.size + tmp
+  end
+end # class Path
+end # module Rackful
+#~ # Monkeypatch to this stdlib class.
+#~ class URI::Generic
+#~
+  #~ # @see http://www.w3.org/TR/html401/struct/links.html#adef-rel the HTML `rel` attribute.
+  #~ attr_accessor :rel
+#~
+  #~ # @see http://www.w3.org/TR/html401/struct/links.html#adef-rev the HTML `rev` attribute.
+  #~ attr_accessor :rev
+#~
+  #~ def to_xhtml base_path, encoding = Encoding::UTF_8
+    #~ retval = "<a href=\"#{self.route_from(base_path)}\"".encode encoding
+    #~ retval << " rel=\"#{self.rel}\"" if self.rel
+    #~ retval << " rev=\"#{self.rev}\"" if self.rev
+    #~ retval << '>'
+    #~ if self.relative? && ! self.query && ! self.fragment
+      #~ retval << Rack::Utils.escape_html(
+                  #~ Rack::Utils.unescape( self.route_from(base_path).to_s, encoding )
+                #~ )
+    #~ else
+      #~ retval << self.to_s
+    #~ end
+    #~ retval << '</a>'
+    #~ retval
+  #~ end
+#~
+  #~ # @return [URI::Generic]
+  #~ def slashify
+    #~ r = self.dup
+    #~ r.path = r.path.unslashify
+    #~ r
+  #~ end
+#~
+  #~ # @return [self, nil]
+  #~ def slashify!
+    #~ self.path.slashify! && self
+  #~ end
+#~
+  #~ # @return [URI::Generic]
+  #~ def unslashify
+    #~ r = self.dup
+    #~ r.path = r.path.unslashify
+    #~ r
+  #~ end
+#~
+  #~ # @return [self, nil]
+  #~ def unslashify!
+    #~ self.path.unslashify! && self
+  #~ end
+#~
+#~ end # class ::URI::Generic