optionsful 0.1.8 → 0.2.3

data/spec/optionsful_server_spec.rb

@@ -5,7 +5,7 @@ describe Baurets::Optionsful::Server do
 
   include Rack::Test::Methods
 
-  describe "as a Rack middleware" do
+  context "as a Rack middleware" do
 
     it "is a Ruby object that responds to call;" do
       assert ::Baurets::Optionsful::Server.new(app).respond_to? :call
@@ -30,7 +30,7 @@ describe Baurets::Optionsful::Server do
       end
     end
 
-    it "must be nice, acting somewhere on a Rack middleware stack." do
+    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
       assert response[0].kind_of? Fixnum
@@ -39,7 +39,7 @@ 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
+    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
@@ -49,114 +49,281 @@ describe Baurets::Optionsful::Server do
 
   end
 
-  describe "is intended to provide HTTP OPTIONS calls for Rails RESTful resources" do
+  context "as an interpreter for HTTP OPTIONS requests, MUST recognize the Rails" do
 
-    describe "to collect the allowed HTTP methods, it overrides Rails routing recognition, so it must understand" do
+    describe "default resource routing" do
+      #Sample resource route (maps HTTP verbs to controller actions automatically)
 
-      describe "the default Rails resource routing: " do
-
-        before(:all) do
-          ActionController::Routing::Routes.draw do |map| 
-            map.resources :posts, :has_many => :comments
-          end
+      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")
-          assert response.kind_of?(Array)
-          assert allows?(response[1], "GET")
-        end
+      it "the index action displays a list of all posts in response of a GET request" do
+        response = http_options_request("/posts")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "GET")
+      end
 
-        it "the new action return from a GET request an HTML form for creating a new post;" do
-          response = http_options_request("/posts/new")
-          assert response.kind_of?(Array)
-          assert allows?(response[1], "GET")
-        end
+      it "the new action return from a GET request an HTML form for creating a new post" do
+        response = http_options_request("/posts/new")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "GET")
+      end
 
-        it "the create action uses POST to create a new post instance;" do
-          response = http_options_request("/posts")
-          assert response.kind_of?(Array)
-          assert allows?(response[1], "POST")
-        end
+      it "the create action uses POST to create a new post instance" do
+        response = http_options_request("/posts")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "POST")
+      end
 
-        it "the show action display a specific post in response of a GET request;" do
-          response = http_options_request("/posts/1")
-          assert response.kind_of?(Array)
-          assert allows?(response[1], "GET")
-        end
+      it "the show action display a specific post in response of a GET request" do
+        response = http_options_request("/posts/1")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "GET")
+      end
+
+      it "the edit action return an HTML form for editing a post in response of a GET request" do
+        response = http_options_request("/posts/1/edit")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "GET")
+      end
+
+      it "the update action uses PUT to update a specific post" do
+        response = http_options_request("/posts/1")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "PUT")
+      end
+
+      it "the destroy action uses DELETE to delete a specific post" do
+        response = http_options_request("/posts/1")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "DELETE")
+      end 
+
+      it "not finding a path, return 404 Not Found" do
+        response = http_options_request("/sblingers/sblongers")
+        assert response.kind_of?(Array)
+        assert response[0].should be 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
+
+    end
 
-        it "the edit action return an HTML form for editing a post in response of a GET request;" do
-          response = http_options_request("/posts/1/edit")
-          assert response.kind_of?(Array)
-          assert allows?(response[1], "GET")
+    describe "named routes" do
+
+      before(:each) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.login 'login', :controller => 'accounts', :action => 'login'
         end
+      end
 
-        it "the update action uses PUT to update a specific post;" do
-          response = http_options_request("/posts/1")
-          assert response.kind_of?(Array)
-          assert allows?(response[1], "PUT")
+      it "should work" do
+        response = http_options_request("/login")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "GET") # WTF? return ANY?!? ;p
+      end
+
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
+
+    end
+
+    describe "route globbing" do
+
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.connect '*path' , :controller => 'blog' , :action => 'unrecognized?'
         end
+      end
+
+      it "should work" do
+        pending "What the hell is that?"
+        response = http_options_request("/post/path")
+        assert response.kind_of?(Array)
+        assert response[0].should_not be 404
+      end
+
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
+
+    end
 
-        it "the destroy action uses DELETE to delete a specific post." do
-          response = http_options_request("/posts/1")
-          assert response.kind_of?(Array)
-          assert allows?(response[1], "DELETE")
-        end 
+    describe "route conditions" do
 
-        it "not found a path" do
-          response = http_options_request("/sblingers/sblongers")
-          assert response.kind_of?(Array)
-          assert response[0].should == 404
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.connect 'post/:id', :controller => 'posts', :action => 'show', :conditions => { :method => :get }
+          map.connect 'post/:id', :controller => 'posts', :action => 'create_comment', :conditions => { :method => :post }
         end
+      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 "should work" do
+        response = http_options_request("/post/123")
+        assert response.kind_of?(Array)
+        assert allows?(response[1], "GET")
+        assert allows?(response[1], "POST")
+      end
 
-        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"]
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
+    end
 
-          assert link.should =~ /\A"{1}.+"\z/ 
+    describe "pretty URLs" do
 
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.connect "articles/:year/:month/:day", :controller => 'articles', :action => 'find_by_date', :requirements => { :year => /\d{4}/, :month => /\d{1,2}/, :day => /\d{1,2}/ }
         end
+      end
 
-        it "not finding a path, pretend you're dead and.. let it goes through" do
-          pending
+      it "should work" do
+        response = http_options_request("/articles/2010/07/23")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+      end
+
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
+
+    end
+
+    describe "regular expressions and parameters" do
+
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.geocode 'geocode/:postalcode', :controller => 'geocode', :action => 'show', :requirements => { :postalcode => /\d{5}(-\d{4})?/ }
         end
+      end
 
+      it "should work" do
+        response = http_options_request("/geocode/20100")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "GET")
       end
 
-      describe "must understand Rails named routes" do
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
+    end
 
-        before(:each) do
-          ActionController::Routing::Routes.draw do |map| 
-            map.login 'login', :controller => 'accounts', :action => 'login'
+    describe "resource route within a namespace" do
+
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.namespace :admin do |admin|
+            # Directs /admin/posts/* to Admin::PostsController (app/controllers/admin/posts_controller.rb)
+            admin.resources :posts
           end
         end
+      end
+
+      it "must understand an namespaced path" do
+        response = http_options_request("/admin/posts")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "GET")
+        assert allows?(response[1], "POST")
+      end
 
-        it "must understand" do
-          pending
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
+
+    end
+
+    describe "deal the catch all" do
+
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.resources :posts
+          map.connect ':controller/:action/:id'
         end
+      end
 
+      it "must cheat  :P" do
+        response = http_options_request("/posts")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "GET")
+        assert allows?(response[1], "POST")
+      end
 
+      after(:all) do
+        ActionController::Routing::Routes.reload!
+      end
 
+    end
+    
+    describe "another sample of named route" do
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+        end
       end
 
-      describe "Rails custom route" do
+      it "should work" do
+        response = http_options_request("/products/123/purchase")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "ANY")
+      end
 
+      after(:all) do
+        ActionController::Routing::Routes.reload!
       end
 
-      describe "Rails route globbing" do
+    end
+
+    describe "Sample resource route with options" do
 
+      before(:all) do
+        ActionController::Routing::Routes.draw do |map| 
+          map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+        end
       end
 
-      describe "Pretty URLs" do
+      it "should work" do
+        response = http_options_request("/products/123/toggle")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "POST")
       end
 
-      describe "Regular Expressions and parameters" do
+      it "should work" do
+        response = http_options_request("/products/123/short")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "GET")
+      end
+
+      it "should work" do
+        response = http_options_request("/products/sold")
+        assert response.kind_of?(Array)
+        assert response[0].should be 204
+        assert allows?(response[1], "GET")
+      end
+
+      after(:all) do
+        ActionController::Routing::Routes.reload!
       end
 
     end
@@ -166,4 +333,3 @@ describe Baurets::Optionsful::Server do
 end
 
 
-

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require File.join(File.dirname(__FILE__), '..', 'lib', "baurets", 'optionsful', "config.rb")
 require File.join(File.dirname(__FILE__), '..', 'lib', "baurets", 'optionsful', "server.rb")
-require File.join(File.dirname(__FILE__), '..', 'lib', "baurets", 'optionsful', "documentator.rb")
 require File.join(File.dirname(__FILE__), '..', 'lib', "baurets", 'optionsful', "introspections.rb")
 # TODO ^ this was ugly?! :-S
 
@@ -15,7 +14,11 @@ require 'spec/interop/test'
 require 'action_controller' 
 
 
-# set test environment set :environment, :test set :run, false set :raise_errors, true set :logging, false
+# set test environment 
+set :environment, :test 
+set :run, false 
+set :raise_errors, true 
+set :logging, true
 
 DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "rack.errors" => StringIO.new,
   "rack.multithread" => true, "rack.multiprocess" => true, "rack.run_once" => false, }
@@ -51,18 +54,6 @@ DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "
         end
       }
     end
-    
-    def fake_docs_app
-      app = Rack::Builder.new {
-        use Rack::CommonLogger
-        use Rack::ShowExceptions
-        use Baurets::Optionsful::Documentator
-        map "/lobster" do
-          use Rack::Lint
-          run Rack::Lobster.new
-        end
-      }
-    end
 
     def mock_env(options = {})
       FAKE_ENV.merge!(options)
@@ -72,16 +63,10 @@ DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "
       complex_env = mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => path })
       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: 11
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 8
-  version: 0.1.8
+  - 2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Marco Antonio Gonzalez Junior
@@ -15,26 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-26 00:00:00 -03:00
+date: 2010-07-31 00:00:00 -03:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: RedCloth
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 4
-        - 2
-        - 2
-        version: 4.2.2
-  type: :runtime
-  version_requirements: *id001
-description: Optionsful provide dynamic information and HTTP's OPTION method support.
+dependencies: []
+
+description: Help building RESTful web services enabling HTTP OPTIONS verb on Ruby on Rails applications.
 email: kayaman@baurets.net
 executables: []
 
@@ -47,22 +32,16 @@ files:
 - MIT-LICENSE
 - Rakefile
 - lib/optionsful.rb
-- lib/baurets/optionsful/documentator.rb
 - lib/baurets/optionsful/server.rb
 - lib/baurets/optionsful/introspections.rb
 - lib/baurets/optionsful/config.rb
 - lib/baurets/optionsful/version.rb
 - lib/tasks/optionsful.rake
 - rails/init.rb
+- samples/optionsful.yml
 - 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
@@ -99,6 +78,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Optionsful gives HTTP's OPTION method support for Ruby on Rails applications. Also extract dynamic information for easily documenting RESTful web services.
+summary: Support HTTP OPTIONS verb on your Rails app.
 test_files: []
 

data/lib/baurets/optionsful/documentator.rb

@@ -1,158 +0,0 @@
-module Baurets
-  module Optionsful
-    class Documentator
-
-      def initialize(app)  
-        @app = app
-        @config = Baurets::Optionsful::Config.new
-      end  
-
-      def call(env) 
-        unless env["PATH_INFO"].index(@config.base_path) == 0  
-          response = @app.call(env)
-        else
-          response = extract_documentation(env)
-        end
-        response
-      end
-
-      private
-
-      require 'rubygems'
-      require 'yaml'
-      require 'RedCloth'
-
-      def verify_path(env)
-
-      end
-
-      def extract_documentation(env)
-        path = env["PATH_INFO"]
-        path = path.gsub(@config.base_path, '')
-        # do routing introspection:
-        routes = ::Baurets::Optionsful::Introspections.do_routing_introspection
-        # do request path investigation
-        route_guess = ::Baurets::Optionsful::Introspections.guess_route(routes,path)
-        # do the matches:
-        allow = ::Baurets::Optionsful::Introspections.do_the_matches(routes, route_guess)
-        http_methods = allow.split(", ")
-
-        path_parts = ::Baurets::Optionsful::Introspections.prepare_request_path(path)
-
-        controller_actions = []
-        http_methods.each do |verb|
-          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" ) 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
-      end
-
-      def build_html(srvc, methods)
-        html = "<html><head></head><body>"
-        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
-      end
-
-      def relate_action_to_method(path, verb)
-        action = ""
-        routes = ::Baurets::Optionsful::Introspections.do_routing_introspection
-        route_guess = ::Baurets::Optionsful::Introspections.guess_route(routes, path)
-        routes.each do |route|
-          if ((route.first == route_guess) && (route[1][0] == verb))
-            action = route[1][1] unless route[1][1].empty?
-          end
-        end
-        action
-      end
-
-      def file_lines(file_name)
-        lines = []
-        begin
-          file = File.new(file_name, "r")
-          while (line = file.gets)
-            line = line.strip
-            lines << line unless line.empty?
-          end
-          file.close
-        rescue => err
-          puts "Exception: #{err}"
-          err
-        end
-        lines.delete(nil)
-        lines
-      end  
-
-      def extract_comments_above(file_name, line_number)
-        lines = file_lines(file_name)
-        doc = []
-        line_number = line_number -1
-        while ((line_number = line_number -1) && (line_number >= 0) && (!lines.nil?) && (!lines[line_number].empty?))
-          line = lines[line_number].lstrip
-          if line[0] == 35
-            doc << line
-          else
-            line_number = 0
-          end 
-        end
-        doc = doc.reverse
-        doc
-      end
-
-      def find_line_for(file, name, type) 
-        lines = file_lines(file)
-        signature = ""
-        if type == :class
-          signature = "class " + name
-        elsif type == :method
-          signature = "def " + name
-        end
-        counter = 1;
-        lines.each do |line|
-          if line.include? signature
-            return counter
-          end
-          counter += 1
-        end
-        counter = 0
-      end
-    end
-
-  end
-end