optionsful 0.4.1 → 0.4.2

data/README.textile

@@ -1,4 +1,4 @@
-h1. *O p t i o n s f u l*
+h1. [+*O p t i o n s f u l*+]
 
 Provide HTTP OPTIONS support for the Ruby on Rails framework.
 
@@ -10,7 +10,7 @@ Provide HTTP OPTIONS support for the Ruby on Rails framework.
 
 h1. "-No! No! No! *-Show me the code!*" 
 
-h3. Retrieving an HTTP OPTIONS request via telnet:
+h2. Playing HTTP OPTIONS via telnet:
 
 <pre>
 $ telnet localhost 3000 
@@ -42,7 +42,7 @@ Date: Thu, 22 Jul 2010 18:12:43 GMT
 Link: "<http://localhost:3000/api/posts/1/comments>; type=text/html; rel=help"
 
 </pre>
-~Note the empty line which is part of the HTTP protocol.~
+~*Note the empty line which is part of the HTTP protocol.*~
 
 h3. I agree. Telnet is the geekest way.. ;-) 
 
@@ -52,7 +52,7 @@ h3. I agree. Telnet is the geekest way.. ;-)
 
 h1. INSTALLATION:
 
-# Change directory to your Ruby on Rails web application,
+# Change directory to your Ruby on Rails web application
 # Add gem dependency to @Gemfile@:
 <pre>gem 'optionsful'</pre>
 # Add it to the stack at @config/application.rb@:
@@ -63,6 +63,8 @@ h1. INSTALLATION:
 <pre>$ gem install optionsful</pre>
 # Enjoy! And give feedback! :)
 
+h1. CONFIGURATION
+
 h2. Setting up the @Link@ header
 
 * To enable and setup the response's @Link@ header, install and edit the configuration file:
@@ -75,28 +77,32 @@ h2. Setting up the @Link@ header
  base_path: /api
  propagate: true</pre>
 
-h3. Possible values and effects: (the bold values are the default ones)
+h2. Possible values and effects: (the underline values are the default ones)
 
 * @link@
-** *false*: Do not include any "Link" header in the response.
-** true: Do include it. Build the URI based on the 'host', 'base_path', and 'propagate' values, explained below.
+** [+false+]: Do not include the "Link" in the response headers. 
+*** some other settings are then ignored
+** true: Do include it! 
+*** build the *URI* based on the *host*, *base_path*, and *propagate* values, explained below.
 
 * @host@
-** *auto*: Use the application's own address and port.
-** private.mycompany.com: point it to another location. For instance: www.baurets.net. (Do not include http://).
-
+** [+auto+]: Use the application's own address and port.
+** custom URI: point it to another location
+*** Example: www.baurets.net
+*** *Note: do not include 'http://'*
 
 * @base_path@
-** the path to be appended to the host. Default is */api*. 
-** to disable it, use @/@
-** Example: /my_company/my_project/resources/api
+** the path to be appended to the host. 
+*** Default is [+*/api*+]. 
+*** To disable it, use @/@
+*** Example: /my_company_private_area/our_big_project/resources/api
 
 * @propagate@
 ** false: Do not append the request's path info to the URI.
-** *true*: Do append it, as it is. 
+** [+true+]: Do append it, as it is. 
 
 * Generated Link example:
-(*link: true*, *host: auto*)
+  (*link: true*, *host: auto*, *base_path: /api*, *propagate: true*)
 <pre>Link: "<http://localhost:3000/api/posts/1/comments>; type=text/html; rel=help"</pre>
 
 * *Note*: @Allow@ *and* @Link@ *are expected headers on a response to an HTTP OPTIONS request.*
@@ -110,7 +116,6 @@ h2. Development notes
 * To bleed on the edge, at your Rails 3 application's @Gemfile@:
 <pre>gem 'optionsful', :path => "~/your_workspace/optionsful/"</pre>
 
-
 h2. Get involved
 * Mailing list: http://groups.google.com/group/optionsful
 * Bug tracker : http://kayaman.lighthouseapp.com/projects/56438-optionsful/overview
@@ -119,4 +124,4 @@ h2. CONTRIBUTORS
 * Me, myself and I, so far.
 * You are welcome, do it. ;-)
 
-Copyright (c) 2010 Marco Antonio Gonzalez Junior, kayaman@baurets.net, released under the MIT license.
+Copyright (c) 2010 Marco Antonio Gonzalez Junior, kayaman@baurets.net, released under the MIT license.

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "yard", ">= 0"
     gem.add_development_dependency "cucumber", ">= 0"
-    gem.add_dependency "rails", "= 3.0.0.rc"
+    gem.add_dependency "rails", "= 3.0.0.rc2"
   end
   Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new do |rubyforge|

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/optionsful.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{optionsful}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marco Antonio Gonzalez Junior"]
-  s.date = %q{2010-08-07}
+  s.date = %q{2010-08-26}
   s.description = %q{Build RESTful web services supporting the HTTP OPTIONS verb on Ruby on Rails applications.}
   s.email = %q{kayaman@baurets.net}
   s.extra_rdoc_files = [
@@ -67,18 +67,18 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
-      s.add_runtime_dependency(%q<rails>, ["= 3.0.0.rc"])
+      s.add_runtime_dependency(%q<rails>, ["= 3.0.0.rc2"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<cucumber>, [">= 0"])
-      s.add_dependency(%q<rails>, ["= 3.0.0.rc"])
+      s.add_dependency(%q<rails>, ["= 3.0.0.rc2"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<cucumber>, [">= 0"])
-    s.add_dependency(%q<rails>, ["= 3.0.0.rc"])
+    s.add_dependency(%q<rails>, ["= 3.0.0.rc2"])
   end
 end
 

data/spec/optionsful_server_spec.rb

@@ -106,7 +106,6 @@ describe "Optionsful" do
         response[0].should be 404
       end
 
-
       after(:all) do
         Rails.application.reload_routes!
       end
@@ -291,7 +290,7 @@ describe "Optionsful" do
         end
       end
 
-      it "blah" do
+      it "a full flavour should work" do
         response = http_options_request("/products/123/sales/recent.xml")
         validate_response(response)
         response[0].should be 204
@@ -354,7 +353,7 @@ describe "Optionsful" do
         end
       end
 
-      it " / should work" do
+      it "'/' should work" do
         response = http_options_request("/")
         validate_response(response)
         response[0].should be 204
@@ -366,8 +365,29 @@ describe "Optionsful" do
       end
 
     end
+    
+    describe "route globbing" do
+
+      before(:all) do
+        rails_app.routes.draw do
+          match 'photos/*other' => 'photos#unknown' 
+        end
+      end
+
+      it "should work" do
+        response = http_options_request("/photos/chick/show/123.json")
+        validate_response(response)
+        response[0].should be 204
+        response[1]["Allow"].should include "GET"
+      end
+
+      after(:all) do
+        Rails.application.reload_routes!
+      end
+
+    end
 
-    describe "the legacy 'WILD' controller" do
+    describe "the legacy 'wild' controller" do
 
       before(:all) do
         rails_app.routes.draw do
@@ -392,7 +412,7 @@ describe "Optionsful" do
 
   context "the Link header" do
 
-    describe "should not be present" do
+    describe "should NOT be present" do
 
       before(:each) do
         rails_app.routes.draw do
@@ -401,7 +421,7 @@ describe "Optionsful" do
         delete_configuration_file
       end
 
-      it "if no directions were given" do
+      it "if NO directions were given" do
         response = http_options_request("/posts")
         validate_response(response)
         response[0].should be 204
@@ -436,7 +456,7 @@ describe "Optionsful" do
         link.should match /\A\".+\"\z/ 
       end
 
-      it "the Link header may use its very current host" do
+      it "the Link header MAY use its very current host" do
         copy_configuration_file('optionsful_true.yml')
         response = http_options_request("/posts")
         validate_response(response)
@@ -445,7 +465,7 @@ describe "Optionsful" do
         link.should match /\A\"<http:\/\/localhost.+\"\z/ 
       end
 
-      it "the Link header may use a custom host value" do
+      it "the Link header MAY use a custom host value" do
         copy_configuration_file('optionsful_true_custom.yml')
         response = http_options_request("/posts")
         validate_response(response)
@@ -454,7 +474,7 @@ describe "Optionsful" do
         link.should match /\A\"<http:\/\/www.baurets.net.+\"\z/ 
       end
 
-      it "the Link header may use a custom base path value" do
+      it "the Link header MAY use a custom base path value" do
         copy_configuration_file('optionsful_true_custom_base_path.yml')
         response = http_options_request("/posts")
         validate_response(response)
@@ -463,7 +483,7 @@ describe "Optionsful" do
         link.should match /\A\"<http:\/\/www.baurets.net\/private\/api.+\"\z/ 
       end
 
-      it "the Link header may propagate original path info" do
+      it "the Link header MAY propagate original path info" do
         copy_configuration_file('optionsful_true_custom_propagate.yml')
         response = http_options_request("/posts")
         validate_response(response)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optionsful
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Marco Antonio Gonzalez Junior
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-07 00:00:00 -03:00
+date: 2010-08-26 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,13 +70,13 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 7712042
+        hash: 977940607
         segments: 
         - 3
         - 0
         - 0
-        - rc
-        version: 3.0.0.rc
+        - rc2
+        version: 3.0.0.rc2
   type: :runtime
   version_requirements: *id004
 description: Build RESTful web services supporting the HTTP OPTIONS verb on Ruby on Rails applications.