rackful 0.1.1 → 0.1.2

data/RACKFUL.md

@@ -143,9 +143,9 @@ response body, the server kindly points out exactly which precondition.
 Further reading
 ---------------
 *   {Rackful::Server#initialize} for more information about your Resource Factory.
-*   {Rackful::Resource#get_etag} and {Rackful::Resource#get_last_modified} for more information on
+*   {Rackful::Resource#get\_etag} and {Rackful::Resource#get\_last\_modified} for more information on
     conditional requests.
-*   {Rackful::Resource#do_METHOD} for more information about writing your own request
+*   {Rackful::Resource#do\_METHOD} for more information about writing your own request
     handlers.
 *   {Rackful::RelativeLocation} for more information about this piece of Rack middleware
     which allows you to return relative and absolute paths in the `Location:`
@@ -155,5 +155,5 @@ 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
+Licensed under the {file:LICENSE.md Apache License 2.0}. You should have received a copy of the
 license as part of this distribution.

data/lib/rackful_path.rb

@@ -49,6 +49,13 @@ class Path < String
 
   # An alias for Rack::Utils.unescape
   def unescape( encoding = Encoding::UTF_8 ); Rack::Utils.unescape(self, encoding); end
+  
+  # @return [Array<String>] An array of unencoded segments
+  def segments
+    r = self.split('/').collect { |s| Rack::Utils.unescape( s, Encoding::UTF_8 ) }
+    r.shift
+    r
+  end
 
 end # class Path
 
@@ -106,7 +113,7 @@ class URI::Generic
   end
 
 end # class ::URI::Generic
-=end comment
+=end
 
 
 

data/lib/rackful_resource.rb

@@ -31,17 +31,15 @@ module Resource
   module ClassMethods
 
 
-=begin markdown
-Meta-programmer method.
-@example Have your resource rendered in XML and JSON
-  class MyResource
-    add_serializer MyResource2XML
-    add_serializer MyResource2JSON, 0.5
-  end
-@param serializer [Serializer]
-@param quality [Float]
-@return [self]
-=end
+    #Meta-programmer method.
+    #@example Have your resource rendered in XML and JSON
+    #  class MyResource
+    #    add_serializer MyResource2XML
+    #    add_serializer MyResource2JSON, 0.5
+    #  end
+    #@param serializer [Serializer]
+    #@param quality [Float]
+    #@return [self]
     def add_serializer serializer, quality = 1.0
       quality = quality.to_f
       quality = 1.0 if quality > 1.0
@@ -74,17 +72,15 @@ Meta-programmer method.
     end
 
 
-=begin markdown
-Meta-programmer method.
-@example Have your resource accept XML and JSON in `PUT` requests
-  class MyResource
-    add_parser XML2MyResource, :PUT
-    add_parser JSON2MyResource, :PUT
-  end
-@param parser [Parser]
-@param method [#to_sym]
-@return [self]
-=end
+    #Meta-programmer method.
+    #@example Have your resource accept XML and JSON in `PUT` requests
+    #  class MyResource
+    #    add_parser XML2MyResource, :PUT
+    #    add_parser JSON2MyResource, :PUT
+    #  end
+    #@param parser [Parser]
+    #@param method [#to_sym]
+    #@return [self]
     def add_media_type media_type, method = :PUT
       method = method.to_sym
       self.media_types[method] ||= []
@@ -146,18 +142,16 @@ The best media type for the response body, given the current HTTP request.
     end
 
 
-# =begin markdown
-# @param content_type [String]
-# @param method [#to_s]
-# @return [Serializer]
-# =end
-    # def parser request
-      # method = request.request_method.upcase.to_sym
-      # if !parsers[method] || !parsers[method][request.media_type]
-        # raise HTTP415UnsupportedMediaType, ( parsers[method] ? parsers[method].keys : [] )
-      # end
-      # parsers[method][request.media_type].new( request )
-    # end
+    #~ # @param content_type [String]
+    #~ # @param method [#to_s]
+    #~ # @return [Serializer]
+    #~ def parser request
+      #~ method = request.request_method.upcase.to_sym
+      #~ if !parsers[method] || !parsers[method][request.media_type]
+        #~ raise HTTP415UnsupportedMediaType, ( parsers[method] ? parsers[method].keys : [] )
+      #~ end
+      #~ parsers[method][request.media_type].new( request )
+    #~ end
 
 
   end # module ClassMethods
@@ -178,22 +172,21 @@ The best media type for the response body, given the current HTTP request.
 @return [#to_json, #each_pair]
 =end
 
-=begin markdown
-@!method do_METHOD( Request, Rack::Response )
-HTTP/1.1 method handler.
-
-To handle certain HTTP/1.1 request methods, resources must implement methods
-called `do_<HTTP_METHOD>`.
-@example Handling `PATCH` requests
-  def do_PATCH request, response
-    response['Content-Type'] = 'text/plain'
-    response.body = [ 'Hello world!' ]
-  end
-@abstract
-@return [void]
-@raise [HTTPStatus, RuntimeError]
-@since 0.0.1
-=end
+
+# @!method do_METHOD( Request, Rack::Response )
+# HTTP/1.1 method handler.
+#
+# To handle certain HTTP/1.1 request methods, resources must implement methods
+# called `do_<HTTP_METHOD>`.
+# @example Handling `PATCH` requests
+#   def do_PATCH request, response
+#     response['Content-Type'] = 'text/plain'
+#     response.body = [ 'Hello world!' ]
+#   end
+# @abstract
+# @return [void]
+# @raise [HTTPStatus, RuntimeError]
+# @since 0.0.1
 
 
 =begin markdown
@@ -206,7 +199,7 @@ The path of this resource.
 
 
   def path= path
-    @path = Path.new(path.to_s)
+    @path = path.to_s.to_path
   end
 
 

data/lib/rackful_serializer.rb

@@ -36,6 +36,7 @@ class Serializer
 Every serializer must implement this method.
 @abstract
 @since 0.1.0
+@yield [data] the entity body 
 =end
   def each
     raise HTTP500InternalServerError, "Class #{self.class} doesn't implement #each()."

data/lib/rackful_server.rb

@@ -41,7 +41,7 @@ If there's no resource at the given path, but you'd still like to respond to
 
 
 =begin markdown
-{include:Server#resource_factory}
+@param resource_factory [#[]] see Server#resource_factory
 @since 0.0.1
 =end
   def initialize(resource_factory)

data/mkdoc.sh

@@ -2,5 +2,5 @@
 
 cd "`dirname "$0"`"
 
-rm -rf docs/* .yardoc/
+rm -rf doc/* .yardoc/
 exec yard "$@"

data/rackful.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
 
   # Required properties:
   s.name        = 'rackful'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   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

@@ -1,85 +1,88 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: rackful
-version: !ruby/object:Gem::Version
-  version: 0.1.1
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.1.2
 platform: ruby
-authors:
+authors: 
 - Pieter van Beek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-05 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-10-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rack
-  requirement: &70177120280540 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.4'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.4"
   type: :runtime
-  prerelease: false
-  version_requirements: *70177120280540
-description: ! 'Rackful provides a minimal interface for developing ReSTful web services
-  with
-
-  Rack and Ruby. Instead of writing HTTP method handlers, you''ll implement
-
+  version_requirements: *id001
+description: |
+  Rackful provides a minimal interface for developing ReSTful web services with
+  Rack and Ruby. Instead of writing HTTP method handlers, you'll implement
   resource objects, which expose their state at URLs.
-
-
+  
   This version is NOT backward compatible with versions 0.0.x.
 
-'
 email: rackful@djinnit.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- CHANGES.md
-- LICENSE.md
+
+files: 
 - RACKFUL.md
 - README.md
-- example/config.ru
+- LICENSE.md
+- CHANGES.md
 - example/config2.ru
-- lib/rackful/header_spoofing.rb
+- example/config.ru
+- lib/rackful_request.rb
+- lib/rackful_path.rb
 - lib/rackful/method_spoofing.rb
+- lib/rackful/header_spoofing.rb
 - lib/rackful/relative_location.rb
-- lib/rackful.rb
 - lib/rackful_http_status.rb
-- lib/rackful_path.rb
-- lib/rackful_request.rb
+- lib/rackful_server.rb
+- lib/rackful.rb
 - lib/rackful_resource.rb
 - lib/rackful_serializer.rb
-- lib/rackful_server.rb
 - rackful.gemspec
 - mkdoc.sh
 homepage: http://pieterb.github.com/Rackful/
-licenses:
+licenses: 
 - Apache License 2.0
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Library for building ReSTful web services with Rack
 test_files: []
+
 has_rdoc: