optionsful 0.1.7 → 0.1.8

data/README.textile

@@ -20,7 +20,7 @@ HTTP/1.1 204 No Content
 Allow: GET, POST
 Connection: close
 Date: Thu, 22 Jul 2010 17:20:27 GMT
-Link: <http://localhost:3000/opts/posts>; type=text/html; rel=help
+Link: <http://localhost:3000/optionsful/posts>; type=text/html; rel=help
 
 OPTIONS /posts/1 HTTP/1.1
 Host: http://localhost:3000
@@ -29,7 +29,7 @@ HTTP/1.1 204 No Content
 Allow: GET, PUT, DELETE
 Connection: close
 Date: Thu, 22 Jul 2010 18:14:24 GMT
-Link: <http://localhost:3000/opts/posts/1/>; type=text/html; rel=help
+Link: <http://localhost:3000/optionsful/posts/1/>; type=text/html; rel=help
 
 OPTIONS /posts/1/comments HTTP/1.1
 Host: http://localhost:3000
@@ -38,7 +38,7 @@ HTTP/1.1 204 No Content
 Allow: GET, POST
 Connection: close
 Date: Thu, 22 Jul 2010 18:12:43 GMT
-Link: <http://localhost:3000/opts/posts/1/comments>; type=text/html; rel=help
+Link: <http://localhost:3000/optionsful/posts/1/comments>; type=text/html; rel=help
 
 </pre>
 ~Note the empty line which is part of the HTTP protocol.~
@@ -46,7 +46,7 @@ Link: <http://localhost:3000/opts/posts/1/comments>; type=text/html; rel=help
 h3.   Retrieving the resource/service documentation right from your browser:
 
 * Access the given Link header through your preferable browser. Yeah, via an HTTP GET request. 
-* @http://localhost:3000/opts/posts/1/comments@ for instance.
+* @http://localhost:3000/optionsful/posts/1/comments@ for instance.
 * Try up adding some RDoc-like comments above your actions definitions on the appropriate controllers.
 * Refresh the page and your documentation and have fun!
 * There's a lot of helpful things we can do with this extracted 'on-the-fly' information (metadata).

data/lib/baurets/optionsful/config.rb

@@ -1,35 +1,49 @@
 module Baurets
   module Optionsful
-
     class Config
 
-      def initialize
-        # Initialize default settings- May be overriden if RAILS_ROOT/config/optionsful.yml exists.
-        @config = { :http => {:base_path => "/optionsful"} } 
+      def initialize(options = {})
+        @config = configure_options(options)
         setup
+        self
+      end
+
+      def base_path
+        @config[:http][:base_path]
+      end
+
+      private
+
+      def configure_options(options = {})
+        default_opts = { :http => { :base_path => "/optionsful"},  :file => "", :environment => "development" }
+        conf = {}
+        if defined? RAILS_ROOT
+          conf = default_opts.merge!({:file => (File.join(RAILS_ROOT, 'config', 'optionsful.yml'))})
+        else
+          conf = default_opts.merge!({ :http => { :base_path => "/optionsful"} })
+        end
+        conf = conf.merge!(options) unless options.empty?
+        conf
       end
 
       def setup
         require "yaml"
+        yaml_file = @config[:file]
         begin
-          yaml_file = File.join(RAILS_ROOT, "config", "optionsful.yml")
           if File.exist? yaml_file
-            conf = YAML::load_file(yaml_file)[RAILS_ENV].symbolize_keys
+            conf = YAML::load_file(yaml_file)[@config[:environment]].symbolize_keys
             configure(conf) if conf
           end
         rescue
         end
       end
+
       def configure(conf)
-        @config[:http][:base_path] = conf[:http][:base_path] if (conf[:http] && conf[:http][:base_path])
+        @config[:http][:base_path] = conf[:http]["base_path"] if (conf[:http] && conf[:http]["base_path"])
+        @config[:file] = conf[:file] if conf[:file] 
+        @config[:environment] = conf[:environment] if conf[:environment]
       end
 
-
-      def base_path
-        @config[:http][:base_path]
-      end
-      
     end
-
   end
 end

data/lib/baurets/optionsful/documentator.rb

@@ -4,19 +4,16 @@ module Baurets
 
       def initialize(app)  
         @app = app
-        @config = ::Baurets::Optionsful::Config.new
+        @config = Baurets::Optionsful::Config.new
       end  
 
       def call(env) 
-        unless env["PATH_INFO"].index(@config.base_path) == 0
-          @app.call(env)
+        unless env["PATH_INFO"].index(@config.base_path) == 0  
+          response = @app.call(env)
         else
-          begin
-            return extract_documentation(env)
-          rescue => e
-            [500, {}, e.backtrace.join("\n")]
-          end
+          response = extract_documentation(env)
         end
+        response
       end
 
       private
@@ -25,6 +22,10 @@ module Baurets
       require 'yaml'
       require 'RedCloth'
 
+      def verify_path(env)
+
+      end
+
       def extract_documentation(env)
         path = env["PATH_INFO"]
         path = path.gsub(@config.base_path, '')
@@ -43,40 +44,47 @@ module Baurets
           controller_actions << [verb, relate_action_to_method(path_parts, verb)]
         end
         controller_actions.delete_if {|pair| pair[1].empty? }
-
-        controller_name = ::Baurets::Optionsful::Introspections.discover_controller_name(path_parts) + "_controller"
-        file = File.join(RAILS_ROOT, "app", "controllers", controller_name + ".rb")
-        controller_class = controller_name.camelize
-
-        service_doc = extract_comments_above(file, find_line_for(file, controller_class, :class))
-
-        methods_docs = []
-        controller_actions.each do |info|
-          methods_docs << [info, extract_comments_above(file, find_line_for(file, info[1], :method)).join("\n")]
+        controller_name = (::Baurets::Optionsful::Introspections.discover_controller_name(path_parts) + "_controller" ) if ::Baurets::Optionsful::Introspections.discover_controller_name(path_parts)
+        file = ""
+        file = File.join(RAILS_ROOT, "app", "controllers", controller_name + ".rb") if controller_name
+        if File.exist? file
+          controller_class = controller_name.camelize
+          service_doc = extract_comments_above(file, find_line_for(file, controller_class, :class))
+          methods_docs = []
+          controller_actions.each do |info|
+            methods_docs << [info, extract_comments_above(file, find_line_for(file, info[1], :method)).join("\n")]
+          end
+          body = build_html(service_doc, methods_docs)
+          [200, {"Content-Type" => "text/html"},  body]
+        else
+          [404, {}, "    "]
         end
-
-        body = build_html(service_doc, methods_docs)
-
-        [200, {"Content-Type" => "text/html"},  body]
       end
 
-
-      def build_html(comment, methods)
-        comments = comment.join("\n").gsub(/^#+\s/, '')
-        resource = YAML::parse(comments)
+      def build_html(srvc, methods)
         html = "<html><head></head><body>"
-        resource_title = resource["resource"]["title"].value
-
-        title = "h1. " + resource_title.to_s if resource_title
-
-        html += RedCloth.new(title).to_html
-        
-        html += RedCloth.new("#{resource["resource"]["description"].value}").to_html
-
-        methods.each do |meth|
-          meth_verb = meth[0][0]
-          #TODO
-          html += RedCloth.new("*" + meth_verb).to_html
+        comments = srvc.join("\n").gsub(/^#+\s/, '')
+        srvc_doc = YAML::parse(comments)
+        if srvc_doc && srvc_doc["service"]
+          resource_title = srvc_doc["service"]["title"].value
+          title = "h1. " + resource_title.to_s if resource_title
+          html += RedCloth.new(title).to_html
+          html += RedCloth.new("#{srvc_doc["service"]["description"].value}").to_html
+          html += "\n<link rel=\"replies\" href=\"\" </link>"
+          methods.each do |meth|
+            meth_verb = meth[0][0]
+            method_comms = meth[1].gsub(/^#+\s/, '') unless meth[1].empty?
+            resource = YAML::parse(method_comms)
+            html += RedCloth.new("h2. " + meth_verb).to_html
+            if resource && resource["resource"] 
+              html += RedCloth.new(resource["resource"]["title"].value).to_html
+              html += RedCloth.new(resource["resource"]["identifier"].value).to_html
+            else
+              html += RedCloth.new("Could not find or understand any annotated metadata related to method #{meth_verb}.").to_html 
+            end
+          end
+        else
+          html += RedCloth.new("Could not understand anything.").to_html
         end
         html += "</body></html>"
         html

data/lib/baurets/optionsful/server.rb

@@ -22,7 +22,7 @@ module Baurets
         if allows.empty?
           [404, {}, "Not found."] 
         else
-          [204, {"Allow" => allows, "Link" => build_help_link(env)}, ""]  
+          [204, {"Allow" => allows, "Link" => "\"#{build_help_link(env)}\""}, ""]  
         end
       end
 

data/lib/baurets/optionsful/version.rb

@@ -4,7 +4,7 @@ module Baurets
 
       MAJOR = 0
       MINOR = 1
-      TINY  = 7
+      TINY  = 8
 
       def self.to_s
         "#{MAJOR}.#{MINOR}.#{TINY}"

data/spec/fixtures/optionsful.yml

@@ -0,0 +1,11 @@
+development:
+  http: 
+    base_path: /blopts
+    
+test:
+  http: 
+    base_path: /test
+
+production:
+  http: 
+    base_path: /blopts

data/spec/optionsful_config_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe Baurets::Optionsful::Config do
+
+  include Rack::Test::Methods
+
+  describe "Config carries specific settings" do
+
+    describe "by default, try to find the custom configuration file" do
+
+      it "if the custom configuration file exist, try to load settings from it" do
+        config = Baurets::Optionsful::Config.new( {:file => File.join(File.dirname(__FILE__), 'fixtures', 'optionsful.yml'), :environment => "test" })
+        config.base_path.should == "/test"
+      end
+      
+      it "if the custom configuration file exist and is not valid, keep the default settings" do
+        config = Baurets::Optionsful::Config.new( {:file => File.join(File.dirname(__FILE__), 'fixtures', 'optionsful_bug.yml'), :environment => "test" })
+        config.base_path.should == "/optionsful"
+      end
+
+      it "if no configuration file is informed or found, do load the default settings" do
+        config = Baurets::Optionsful::Config.new
+        config.base_path.should == "/optionsful"
+      end
+      
+      it "if RAILS_ROOT is defined, look for the custom configuration file on its config folder" do
+        Baurets::Optionsful::Config.const_set(:RAILS_ROOT, File.dirname(__FILE__))
+        config = Baurets::Optionsful::Config.new
+        config.base_path.should == "/optionsful" 
+      end
+
+    end
+
+    describe "if a custom configuration file is informed "
+
+    it "and does not exist, keep default settings" do
+      config = Baurets::Optionsful::Config.new( {:file => File.join(File.dirname(__FILE__), 'fixtures', 'optionsful_xxx.yml'), :environment => "test" })
+      config.base_path.should == "/optionsful"
+    end
+
+  end
+
+end

data/spec/optionsful_documentator_spec.rb

@@ -5,8 +5,9 @@ describe Baurets::Optionsful::Documentator do
 
   include Rack::Test::Methods
 
-config = ::Baurets::Optionsful::Config.new
-  path = config.base_path
+  Baurets::Optionsful::Documentator.send(:remove_const, :RAILS_ROOT) if Baurets::Optionsful::Documentator.const_defined?(:RAILS_ROOT)
+  Baurets::Optionsful::Documentator.const_set(:RAILS_ROOT, File.join(File.dirname(__FILE__), 'samples' ) )
+  base_path = ::Baurets::Optionsful::Config.new.base_path
 
   describe "as a Rack middleware" do
 
@@ -14,13 +15,19 @@ config = ::Baurets::Optionsful::Config.new
       assert ::Baurets::Optionsful::Documentator.new(app).respond_to? :call
     end
 
+    before do
+      ActionController::Routing::Routes.draw do |map| 
+        map.resources :posts, :has_many => :comments
+      end
+    end
+
     it "takes exactly one argument, (the environment) and returns an Array;" do
-      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => path}))
+      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => (base_path + "/posts")}))
       assert response.kind_of?(Array)
     end
 
     it "the returned Array must have exactly three values: the status, the headers and the body;" do
-      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => path}))
+      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => (base_path + "/posts")}))
       assert response.size.should == 3
       assert response[0].kind_of? Fixnum 
       assert response[1].kind_of? Hash
@@ -37,4 +44,74 @@ config = ::Baurets::Optionsful::Config.new
 
   end
 
+  describe "extracts metadata information about a resource" do
+
+    describe "MUST override Rails routing recognition successfully" do 
+
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.resources :posts, :has_many => :comments
+          map.resources :notes
+          map.resources :stuff
+          map.resources :trips
+          map.resources :teams
+        end
+      end
+
+      it "may let the request go through if base path doesn't match" do
+        pending
+        # req_path =  "/xyz"
+        #         response = http_get_request(req_path)
+        #         assert response[0].kind_of? Fixnum
+        #         assert response[0].should_not == 500
+      end
+
+
+      it "MAY find proper structured information and build an html response" do
+        Baurets::Optionsful::Documentator.send(:remove_const, :RAILS_ROOT) if Baurets::Optionsful::Documentator.const_defined?(:RAILS_ROOT)
+        Baurets::Optionsful::Documentator.const_set(:RAILS_ROOT, File.join(File.dirname(__FILE__), 'samples' ) )
+        req_path = base_path + "/posts"
+        response = http_get_request(req_path)
+
+        assert response[0].kind_of? Fixnum
+        assert response[0].should == 200
+      end
+
+      it "MAY NOT find proper structured information and build an html response" do
+        req_path = base_path + "/notes"
+        response = http_get_request(req_path)
+        assert response.kind_of?(Array)
+        assert response[0].kind_of? Fixnum
+      end
+      
+      it "MAY NOT find controller file and build an html response" do
+        req_path = base_path + "/stuff"
+        response = http_get_request(req_path)
+        assert response.kind_of?(Array)
+        assert response[0].kind_of? Fixnum
+      end
+      
+      it "MAY NOT understand anything" do
+        req_path = base_path + "/trips"
+        response = http_get_request(req_path)
+        assert response.kind_of?(Array)
+        assert response[0].kind_of? Fixnum
+      end
+      
+      it "MAY NOT understand anything" do
+        req_path = base_path + "/teams"
+        response = http_get_request(req_path)
+        assert response.kind_of?(Array)
+        assert response[0].kind_of? Fixnum
+      end
+
+
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
+
+    end
+
+  end
+
 end

data/spec/optionsful_server_spec.rb

@@ -5,13 +5,6 @@ describe Baurets::Optionsful::Server do
 
   include Rack::Test::Methods
 
-  before(:all) do
-    ActionController::Routing::Routes.draw do |map| 
-      map.resources :posts, :has_many => :comments
-    end
-  end
-
-
   describe "as a Rack middleware" do
 
     it "is a Ruby object that responds to call;" do
@@ -31,6 +24,12 @@ describe Baurets::Optionsful::Server do
       assert response[2].kind_of? String
     end
 
+    before do
+      ActionController::Routing::Routes.draw do |map| 
+        map.resources :posts, :has_many => :comments
+      end
+    end
+
     it "must be nice, acting somewhere on a Rack middleware stack." do
       response = fake_opts_app.call(mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => "/posts"}))
       assert response.size.should == 3
@@ -40,14 +39,27 @@ describe Baurets::Optionsful::Server do
       assert response[1]["Allow"]
     end
 
+    it "must let the request go through the stack, if it has nothing to it" do
+      response = fake_opts_app.call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => "/lobster"}))
+      assert response.size.should == 3
+      assert response[0].kind_of? Fixnum
+      assert response[0].should == 200
+      assert response[1].kind_of? Hash
+    end
+
   end
 
+  describe "is intended to provide HTTP OPTIONS calls for Rails RESTful resources" do
 
-  describe "to collect the allowed HTTP methods" do
+    describe "to collect the allowed HTTP methods, it overrides Rails routing recognition, so it must understand" do
 
-    describe "overrides Rails routing recognition " do 
+      describe "the default Rails resource routing: " do
 
-      describe "must understand the default Rails resource routing: " do
+        before(:all) do
+          ActionController::Routing::Routes.draw do |map| 
+            map.resources :posts, :has_many => :comments
+          end
+        end
 
         it "the index action displays a list of all posts in response of a GET request;" do
           response = http_options_request("/posts")
@@ -90,36 +102,68 @@ describe Baurets::Optionsful::Server do
           assert response.kind_of?(Array)
           assert allows?(response[1], "DELETE")
         end 
-        
+
         it "not found a path" do
           response = http_options_request("/sblingers/sblongers")
           assert response.kind_of?(Array)
           assert response[0].should == 404
         end
-        
+
+        # Note that extension relation types are REQUIRED to be absolute URIs
+        # in Link headers, and MUST be quoted if they contain a semicolon (";")
+        # or comma (",") (as these characters are used as delimiters in the
+        # header itself).
+
+        it "the Link header MUST be quoted if it contains a semicolon or comma" do
+          response = http_options_request("/posts")
+          assert response.kind_of?(Array)
+          link = response[1]["Link"]
+
+          assert link.should =~ /\A"{1}.+"\z/ 
+
+        end
+
         it "not finding a path, pretend you're dead and.. let it goes through" do
           pending
         end
 
       end
 
-    end
+      describe "must understand Rails named routes" do
 
-  end
+        before(:each) do
+          ActionController::Routing::Routes.draw do |map| 
+            map.login 'login', :controller => 'accounts', :action => 'login'
+          end
+        end
 
-  describe " dispatch the call to the application unless HTTP method equals OPTIONS " do
+        it "must understand" do
+          pending
+        end
 
-    it " method GET example" do
-      complex_env = mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => "/lobster" })
-      response = fake_opts_app.call(complex_env)
-      assert response.kind_of?(Array)
-      assert response.size.should == 3
-    end
 
-  end
 
-  after(:all) do
-    ActionController::Routing::Routes.reload!
+      end
+
+      describe "Rails custom route" do
+
+      end
+
+      describe "Rails route globbing" do
+
+      end
+
+      describe "Pretty URLs" do
+      end
+
+      describe "Regular Expressions and parameters" do
+      end
+
+    end
+
   end
 
 end
+
+
+

data/spec/samples/app/controllers/comments_controller.rb

@@ -0,0 +1,86 @@
+# --- 
+# service: 
+#   title: Post comments controller
+#   entrypoint: /posts/:post/comments
+#   support: kayaman@baurets.net
+#   description: Comments Service allow you say shit about anything you dislike!
+class CommentsController < ApplicationController
+
+  # --- 
+  # resource: 
+  #   title: list
+  #   identifier: /posts/{:post}/comments
+  #   support: kayaman@baurets.net
+  #   description:  Create new comments over a post instance.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def index
+  end
+
+  # --- 
+  # resource: 
+  #   title: create
+  #   identifier: /
+  #   support: kayaman@baurets.net
+  #   description:  Create new posts.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def show
+  end
+
+
+  def new
+  end
+
+
+  def update
+  end
+
+
+  def delete
+  end
+
+  # --- 
+  # resource: 
+  #   title: create
+  #   identifier: /
+  #   support: kayaman@baurets.net
+  #   description:  Create new posts.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def create
+    @post = Post.find(params[:post_id])
+    @comment = @post.comments.create!(params[:comment])
+    respond_to do |format|
+      format.html { redirect_to @post }
+      format.js
+    end
+  end
+end

data/spec/samples/app/controllers/notes_controller.rb

@@ -0,0 +1,6 @@
+class NotesController < ApplicationController
+  
+  
+  
+  
+end

data/spec/samples/app/controllers/posts_controller.rb

@@ -0,0 +1,185 @@
+# --- 
+# service: 
+#   title: Posts front controller
+#   entrypoint: /posts
+#   support: kayaman@baurets.net
+#   description: The Posts sevices let you list, create, update, and delete Posts from our application.
+class PostsController < ApplicationController
+  before_filter :authenticate, :except => [:index, :show]
+
+  # --- 
+  # resource: 
+  #   title: Listing
+  #   identifier: /
+  #   support: kayaman@baurets.net
+  #   description: List posts.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: cache-control
+  def index
+    @posts = Post.find(:all)
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @posts }
+      format.json { render :json => @posts }
+      format.atom
+    end
+  end
+
+  # --- 
+  # resource: 
+  #   title: Posts front controller
+  #   identifier: /posts
+  #   support: kayaman@baurets.net
+  #   description: Retuns all posts.
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  def show
+    @post = Post.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @post }
+    end
+  end
+
+  # --- 
+  # resource: 
+  #   title: Posts front controller
+  #   identifier: /posts
+  #   support: kayaman@baurets.net
+  #   description: Retuns all posts.
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  def new
+    @post = Post.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @post }
+    end
+  end
+
+  # --- 
+  # resource: 
+  #   title: create
+  #   identifier: /
+  #   support: kayaman@baurets.net
+  #   description:  Create new posts.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def edit
+    @post = Post.find(params[:id])
+  end
+
+  # --- 
+  # resource: 
+  #   title: create
+  #   identifier: /
+  #   support: kayaman@baurets.net
+  #   description:  Create new posts.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def create
+    @post = Post.new(params[:post])
+
+    respond_to do |format|
+      if @post.save
+        flash[:notice] = 'Post was successfully created.'
+        format.html { redirect_to(@post) }
+        format.xml  { render :xml => @post, :status => :created, :location => @post }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @post.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # --- 
+  # resource: 
+  #   title: Posts front controller
+  #   identifier: /posts
+  #   support: kayaman@baurets.net
+  #   description: Retuns all posts.
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  def update
+    @post = Post.find(params[:id])
+
+    respond_to do |format|
+      if @post.update_attributes(params[:post])
+        flash[:notice] = 'Post was successfully updated.'
+        format.html { redirect_to(@post) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @post.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # --- 
+  # resource: 
+  #   title: Posts front controller
+  #   identifier: /posts
+  #   support: kayaman@baurets.net
+  #   description: Retuns all posts.
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  def destroy
+    @post = Post.find(params[:id])
+    @post.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(posts_url) }
+      format.xml  { head :ok }
+    end
+  end
+
+  private
+
+  def authenticate
+    authenticate_or_request_with_http_basic do |name, password|
+      name == "admin" && password == "secret"
+    end
+  end
+end

data/spec/samples/app/controllers/teams_controller.rb

@@ -0,0 +1,33 @@
+# --- 
+# service: 
+#   title: Teams controller
+#   entrypoint: /posts/:post/comments
+#   support: kayaman@baurets.net
+#   description: Comments Service allow you say shit about anything you dislike!
+class TripsController < ApplicationController
+
+  # !! something wrong ? & 
+  # & ^% !@#
+  def index
+  end
+
+  def show
+  end
+
+
+  def new
+  end
+
+
+  def update
+  end
+
+
+  def delete
+  end
+
+
+  def create
+
+  end
+end

data/spec/samples/app/controllers/trips_controller.rb

@@ -0,0 +1,82 @@
+##
+# sjdhsdjhsdhhjdhjjdhsjhsdhsdjhjshdjhsdshd
+class TripsController < ApplicationController
+
+  # --- 
+  # resource: 
+  #   title: list
+  #   identifier: /posts/{:post}/comments
+  #   support: kayaman@baurets.net
+  #   description:  Create new comments over a post instance.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def index
+  end
+
+  # --- 
+  # resource: 
+  #   title: create
+  #   identifier: /
+  #   support: kayaman@baurets.net
+  #   description:  Create new posts.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def show
+  end
+
+
+  def new
+  end
+
+
+  def update
+  end
+
+
+  def delete
+  end
+
+  # --- 
+  # resource: 
+  #   title: create
+  #   identifier: /
+  #   support: kayaman@baurets.net
+  #   description:  Create new posts.
+  #   source-link: research
+  #   alternates:
+  #     - one
+  #     - two
+  # representation:
+  #   media-types: 
+  #     - application/xml
+  #     - application/json
+  #   last-modified: 2010-07-23
+  # control:
+  #   cache: no-cache
+  def create
+    @post = Post.find(params[:post_id])
+    @comment = @post.comments.create!(params[:comment])
+    respond_to do |format|
+      format.html { redirect_to @post }
+      format.js
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -73,6 +73,12 @@ DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "
       response = Baurets::Optionsful::Server.new(app).call(complex_env)
     end
     
+    def http_get_request(path)
+      complex_env = mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => path })
+      response = Baurets::Optionsful::Documentator.new(app).call(complex_env)
+    end
+    
+    
     def allows?(headers, method)
       headers["Allow"].include?(method)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optionsful
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Marco Antonio Gonzalez Junior
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-22 00:00:00 -03:00
+date: 2010-07-26 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 4.2.2
   type: :runtime
   version_requirements: *id001
-description: Optionsful provide dynamic information via HTTP's OPTION method.
+description: Optionsful provide dynamic information and HTTP's OPTION method support.
 email: kayaman@baurets.net
 executables: []
 
@@ -45,21 +45,29 @@ extra_rdoc_files: []
 files: 
 - README.textile
 - MIT-LICENSE
-- lib/baurets/optionsful/server.rb
-- rails/init.rb
-- lib/tasks/optionsful.rake
 - Rakefile
-- spec/optionsful_server_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- lib/optionsful.rb
 - lib/baurets/optionsful/documentator.rb
+- lib/baurets/optionsful/server.rb
 - lib/baurets/optionsful/introspections.rb
-- lib/baurets/optionsful/version.rb
 - lib/baurets/optionsful/config.rb
-- lib/optionsful.rb
+- lib/baurets/optionsful/version.rb
+- lib/tasks/optionsful.rake
+- rails/init.rb
+- spec/fixtures/optionsful.yml
+- spec/fixtures/optionsful_bug.yml
+- spec/samples/app/controllers/comments_controller.rb
+- spec/samples/app/controllers/notes_controller.rb
+- spec/samples/app/controllers/posts_controller.rb
+- spec/samples/app/controllers/teams_controller.rb
+- spec/samples/app/controllers/trips_controller.rb
+- spec/optionsful_server_spec.rb
 - spec/optionsful_documentator_spec.rb
+- spec/optionsful_config_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
-homepage: http://optionsful.rubyforge.org
+homepage: http://github.com/kayaman/optionsful
 licenses: []
 
 post_install_message: 
@@ -91,6 +99,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Optionsful provide dynamic information via HTTP's OPTION method over a Ruby on Rails applications.
+summary: Optionsful gives HTTP's OPTION method support for Ruby on Rails applications. Also extract dynamic information for easily documenting RESTful web services.
 test_files: []