optionsful 0.1.0 → 0.1.1

data/README.textile

@@ -34,9 +34,13 @@ Link: <http://baurets.net/api/resources>; type=text/html; rel=help
 h2. INSTALLATION:
 
 # Change directory to your Ruby on Rails web application,
-# Run:
+# Add gem dependency to @config/environment.rb@:
 <pre>
-  $ script/plugin install git://github.com/kayaman/optionsful.git
+  config.gem "optionsful"
+</pre>
+# To install it, run:
+<pre>
+  $ gem install optionsful
 </pre>
 # Have fun!
 

data/Rakefile

@@ -0,0 +1,11 @@
+require 'metric_fu'
+require 'rubygems'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = Dir.glob('spec/**/*_spec.rb')
+  t.spec_opts << '--format specdoc'
+  t.rcov = true
+end
+
+task :default => :spec

data/lib/baurets/optionsful.rb

@@ -0,0 +1,93 @@
+module Baurets
+
+  class Optionsful  
+
+    def initialize(app)  
+      @app = app  
+    end  
+
+    def call(env) 
+      unless env["REQUEST_METHOD"] == "OPTIONS"
+        @app.call(env)
+      else
+        extract_options_information(env)
+      end
+    end
+
+    private
+
+    def extract_options_information(env)
+      [204, {"Allow" => extract_allowed_methods(env), "Link" => build_help_link}, ""]  
+    end
+
+    def extract_allowed_methods(env)
+      # do routing introspection:
+      routes = do_routing_introspection
+      # do request path investigation
+      route_guess = guess_route(routes, env["PATH_INFO"])
+      allows = ""
+      # do the matches:
+      routes.each do |route|
+        if route.first == route_guess
+          allows += route[1].to_s.upcase! + "|" 
+        end
+      end
+      allows = allows.split("|").join(", ")
+    end
+
+    def build_help_link
+      #PENDING
+      "<http://baurets.net/api/resources>; type=text/html; rel=help"
+    end
+
+    def guess_route(routes, path)
+      parts = prepare_request_path(path)
+      guess = []
+      index = 0
+      parts.each do |part|
+        if is_part_static?(routes, index, part)
+          guess << part
+        else
+          guess << :dynamic
+        end
+        index += 1
+      end
+      guess
+    end
+
+    def is_part_static?(routes, index, value)
+      routes.each do |route|
+        if route[0][index] == value
+          return true
+        end
+      end
+      return false
+    end
+
+    def do_routing_introspection
+      routes = []
+      ActionController::Routing::Routes.routes.each do |route|
+        static_path = []
+        route.segments.each do |segment|
+          if segment.kind_of?(ActionController::Routing::StaticSegment)
+            static_path << segment.value if (segment.respond_to?(:value) && segment.value != "/")
+          elsif segment.kind_of?(ActionController::Routing::DynamicSegment)
+            #TODO ignoring (.:format), think about it:
+            static_path << :dynamic unless (segment.respond_to?(:key) && segment.key == :format)   
+          end
+        end
+        routes << [static_path, route.conditions[:method]] unless route.conditions[:method].nil?
+      end
+      routes
+    end
+
+    def prepare_request_path(path)
+      path = path[0..(path.rindex('.')-1)] if path.include?('.') #TODO ignoring (.:format), think about it
+      path_parts = path.split("/")
+      path_parts.delete("")
+      path_parts
+    end
+
+  end
+
+end

data/lib/tasks/optionsful.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :optionsful do
+#   # Task goes here
+# end

data/rails/init.rb

@@ -1,2 +1,2 @@
 # Adding Optionsful to the Rack middleware stack:
-ActionController::Dispatcher.middleware.use "Optionsful"
+ActionController::Dispatcher.middleware.use Baurets::Optionsful

data/spec/optionsful_spec.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe "Baurets::Optionsful," 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
+      assert Baurets::Optionsful.new(app).respond_to? :call
+    end
+
+    it "takes exactly one argument, (the environment) and returns an Array;" do
+      response = Baurets::Optionsful.new(app).call(mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => "/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.new(app).call(mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => "/posts"}))
+      assert response.size.should == 3
+      assert response[0].kind_of? Fixnum 
+      assert response[1].kind_of? Hash
+      assert response[2].kind_of? String
+    end
+
+    it "must be nice, acting somewhere on a Rack middleware stack." do
+      response = fake_app.call(mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => "/posts"}))
+      assert response.size.should == 3
+      assert response[0].kind_of? Fixnum
+      assert response[0].should == 204
+      assert response[1].kind_of? Hash
+      assert response[1]["Allow"]
+    end
+
+  end
+
+
+  describe "to collect the allowed HTTP methods" do
+
+    describe "overrides Rails routing recognition " do 
+
+      describe "must understand the default Rails resource routing: " do
+
+        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 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 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 
+
+      end
+
+    end
+
+  end
+
+  describe " dispatch the call to the application unless HTTP method equals OPTIONS " do
+
+    it " method GET example" do
+      complex_env = mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => "/lobster" })
+      response = fake_app.call(complex_env)
+      assert response.kind_of?(Array)
+      assert response.size.should == 3
+    end
+
+  end
+
+  after(:all) do
+    ActionController::Routing::Routes.reload!
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'baurets','optionsful.rb')
+
+require 'rubygems' 
+require 'sinatra' 
+require 'rack/test' 
+require 'rack' 
+require 'rack/lobster' 
+require 'spec'
+require 'spec/autorun' 
+require 'spec/interop/test' 
+require 'action_controller' 
+require 'ruby-debug'
+# require 'baurets/optionsful'
+
+# set test environment set :environment, :test set :run, false set :raise_errors, true set :logging, false
+
+DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "rack.errors" => StringIO.new,
+  "rack.multithread" => true, "rack.multiprocess" => true, "rack.run_once" => false, }
+
+  SAMPLE_ENV = {"rack.session"=>{:session_id=>"f66c8af1e89f318775e923159e046e71"}, "SERVER_NAME"=>"localhost",
+  "HTTP_HOST"=>"localhost:3332", "REMOTE_HOST"=>"localhost", "HTTP_USER_AGENT"=>"HTTP%20Client0.9.1
+  CFNetwork/438.14 Darwin/9.8.0 (i386) (MacBook4%2C1)", "rack.url_scheme"=>"http", "REQUEST_PATH"=>"/",
+  "SERVER_PROTOCOL"=>"HTTP/1.1", "rack.errors"=>"", "PATH_INFO"=>"/", "REMOTE_ADDR"=>"127.0.0.1",
+  "SERVER_SOFTWARE"=>"WEBrick/1.3.1 (Ruby/1.8.7/2010-06-23)", "rack.run_once"=>false, "rack.version"=>[1, 1],
+  "SCRIPT_NAME"=>"", "rack.multithread"=>false, "HTTP_VERSION"=>"HTTP/1.1", "REQUEST_URI"=>"",
+  "rack.multiprocess"=>false, "SERVER_PORT"=>"3332", "rack.session.options"=>{:domain=>"nilly", :path=>"/",
+    :key=>"_session_id", :httponly=>true, :expire_after=>300, :id=>"f66c8af1e89f318775e923159e046e71"},
+    "REQUEST_METHOD"=>"HEAD", "GATEWAY_INTERFACE"=>"CGI/1.1", "QUERY_STRING"=>"", "HTTP_CONNECTION"=>"close"}
+
+    FAKE_ENV = SAMPLE_ENV.merge!(DEFAULT_ENV)
+
+    def app
+      app = Rack::Builder.new {
+        use Rack::CommonLogger
+        use Rack::ShowExceptions
+      } 
+    end
+
+
+    def fake_app
+      app = Rack::Builder.new {
+        use Rack::CommonLogger
+        use Rack::ShowExceptions
+        use Baurets::Optionsful
+        map "/lobster" do
+          use Rack::Lint
+          run Rack::Lobster.new
+        end
+      }
+    end
+
+    def mock_env(options = {})
+      FAKE_ENV.merge!(options)
+    end
+
+    def http_options_request(path)
+      complex_env = mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => path })
+      response = Baurets::Optionsful.new(app).call(complex_env)
+      response
+    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: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Marco Antonio Gonzalez Junior
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 -03:00
+date: 2010-07-19 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -30,8 +30,13 @@ extra_rdoc_files: []
 files: 
 - README.textile
 - MIT-LICENSE
-- lib/optionsful.rb
+- lib/baurets/optionsful.rb
 - rails/init.rb
+- lib/tasks/optionsful.rake
+- Rakefile
+- spec/optionsful_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://optionsful.rubyforge.org
 licenses: []

data/lib/optionsful.rb

@@ -1,89 +0,0 @@
-class Optionsful  
-
-  def initialize(app)  
-    @app = app  
-  end  
-
-  def call(env) 
-    unless env["REQUEST_METHOD"] == "OPTIONS"
-      @app.call(env)
-    else
-      extract_options_information(env)
-    end
-  end
-
-  private
-
-  def extract_options_information(env)
-    [204, {"Allow" => extract_allowed_methods(env), "Link" => build_help_link}, ""]  
-  end
-
-  def extract_allowed_methods(env)
-    # do routing introspection:
-    routes = do_routing_introspection
-    # do request path investigation
-    route_guess = guess_route(routes, env["PATH_INFO"])
-    allows = ""
-    # do the matches:
-    routes.each do |route|
-      if route.first == route_guess
-        allows += route[1].to_s.upcase! + "|" 
-      end
-    end
-    allows = allows.split("|").join(", ")
-  end
-
-  def build_help_link
-    #PENDING
-    "<http://baurets.net/api/resources>; type=text/html; rel=help"
-  end
-
-  def guess_route(routes, path)
-    parts = prepare_request_path(path)
-    guess = []
-    index = 0
-    parts.each do |part|
-      if is_part_static?(routes, index, part)
-        guess << part
-      else
-        guess << :dynamic
-      end
-      index += 1
-    end
-    guess
-  end
-
-  def is_part_static?(routes, index, value)
-    routes.each do |route|
-      if route[0][index] == value
-        return true
-      end
-    end
-    return false
-  end
-
-  def do_routing_introspection
-    routes = []
-    ActionController::Routing::Routes.routes.each do |route|
-      static_path = []
-      route.segments.each do |segment|
-        if segment.kind_of?(ActionController::Routing::StaticSegment)
-          static_path << segment.value if (segment.respond_to?(:value) && segment.value != "/")
-        elsif segment.kind_of?(ActionController::Routing::DynamicSegment)
-          #TODO ignoring (.:format), think about it:
-          static_path << :dynamic unless (segment.respond_to?(:key) && segment.key == :format)   
-        end
-      end
-      routes << [static_path, route.conditions[:method]] unless route.conditions[:method].nil?
-    end
-    routes
-  end
-
-  def prepare_request_path(path)
-    path = path[0..(path.rindex('.')-1)] if path.include?('.') #TODO ignoring (.:format), think about it
-    path_parts = path.split("/")
-    path_parts.delete("")
-    path_parts
-  end
-
-end