optionsful 0.1.8 → 0.2.3

data/MIT-LICENSE

@@ -12,4 +12,4 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL
 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
+DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -1,6 +1,6 @@
-h1. Rails OPTIONSful
+h1. *Optionsful*
 
-Provide dynamic information about resources via the OPTIONS' HTTP method on a RESTful design over the Ruby on Rails framework.
+Provide HTTP OPTIONS support for the Ruby on Rails framework.
 
 * Note for the impatient: installation instructions below.
 * Note for the dummies: change host names and paths properly.
@@ -8,7 +8,7 @@ Provide dynamic information about resources via the OPTIONS' HTTP method on a RE
 
 h2. "-No! No! No! *-Show me the code!*" 
 
-h3.   Retrieving an HTTP OPTIONS request via telnet:
+h3. Retrieving an HTTP OPTIONS request via telnet:
 
 <pre>
   
@@ -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/optionsful/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/optionsful/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,19 +38,12 @@ HTTP/1.1 204 No Content
 Allow: GET, POST
 Connection: close
 Date: Thu, 22 Jul 2010 18:12:43 GMT
-Link: <http://localhost:3000/optionsful/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.~
 
-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/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).
-
+h3. Telnet is the geek way. You would like better to use an HTTP client software. I use "HTTP Client":http://ditchnet.org/httpclient/ on Mac OS X.
 
 h2. INSTALLATION:
 
@@ -59,21 +52,38 @@ h2. INSTALLATION:
 <pre>
   config.gem "optionsful"
 </pre>
-# To install it, run:
+# To install it, run @rake gems:install@ or:
 <pre>
   $ gem install optionsful
 </pre>
-# Have fun!
+# Enjoy! And give feedback! :)
+
+h2. Link header WARNING
+
+To enable the Link URI on your application, check the "Wisdomful":http://github.com/kayaman/wisdomful project!
 
-h2. TODO & WHISH-LIST
-* -Make the installation easier.-
-* -Create tests! (Oh no! Psst! Don't tell anyone!)-
+h3. Link base path (Note: _Work in Progress_)
 
+* To change the generated URI base path, install and edit the configuration file:
+** run @rake optionsful:yml@
+** edit the 'optionsful.yml' file at your application's 'config' folder.
+* Example:
+<pre>
+development:
+  http: 
+    base_path: /blopts
+</pre>
+
+* Note: @Allow@ and @Link@ are expected headers on a response to an HTTP OPTIONS request. I will think about some features to add more flexibility on the @Link@ generation pretty soon. 
 
 h2. KNOWN ISSUES
-* -Rails route recognition need hard work-
+* Rails route recognition still need some work
 * Platform: ruby 1.8.7, rails 2.3.8, rack 1.2.1
 
+h2. Get involved
+* Mailing list: http://groups.google.com/group/optionsful
+* Bug tracker : http://kayaman.lighthouseapp.com/projects/56438-optionsful/overview
+
 h2. CONTRIBUTORS
 * Me, myself and I, so far.
 * You are welcome, do it. ;-)

data/Rakefile

@@ -4,7 +4,7 @@ require 'spec/rake/spectask'
 
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = Dir.glob( File.dirname(__FILE__) + '/spec/**/*_spec.rb' )
-  t.spec_opts << '--format specdoc'
+  t.spec_opts << '--color --format specdoc'
   t.rcov = true
 end
 

data/lib/baurets/optionsful/introspections.rb

@@ -7,11 +7,18 @@ module Baurets
           return true if route[0][index] == value
         end
         return false
+
       end
 
+
       def self.do_routing_introspection
         returning Array.new do |routes|
           route_requirements = nil
+          ActionController::Routing::Routes.named_routes.map.each do |named_route|
+            name = named_route[0].to_s
+            routes << [[name], ["GET", named_route[1].requirements[:action]], {:controller => named_route[1].requirements[:controller], :action => named_route[1].requirements[:action]}]
+            #TODO ANY ?!?
+          end
           ActionController::Routing::Routes.routes.each do |route|
             static_path = []
             route.segments.each do |segment|
@@ -42,34 +49,20 @@ module Baurets
         guess
       end
 
-      def self.discover_controller_name(path)
-        routes = do_routing_introspection
-        guess = guess_route(routes, path)
-        routes.each do |route|
-          if route[0] == guess
-            return route[2][:controller]
-          end
-        end
-      end
-
       def self.do_the_matches(routes, route_guess)
         allow = ""
         routes.each do |route|
           if route.first == route_guess
-            allow += route[1][0].to_s.upcase + "|" 
+            allow += (route[1][0].to_s.upcase + "|") unless allow.include?(route[1][0].to_s.upcase)
           end
         end
-        allow = allow.split("|").join(", ")
+        allow = allow.split("|").join(", ") 
       end
 
       def self.prepare_request_path(path)
         path_parts = []
-        unless path.kind_of? Array
-          path = path[0..(path.rindex('.')-1)] if path.include?('.')
-          path_parts = path.split("/")
-        else
-          path_parts = path
-        end
+        path = path[0..(path.rindex('.')-1)] if path.include?('.')
+        path_parts = path.split("/")
         path_parts.delete("")
         path_parts
       end

data/lib/baurets/optionsful/server.rb

@@ -32,6 +32,11 @@ module Baurets
         # do request path investigation
         path = env["PATH_INFO"]
         route_guess = ::Baurets::Optionsful::Introspections.guess_route(routes, path)
+        
+         puts "\nPATH: \n #{path}\n"
+                   puts "\nROUTES: \n #{routes.inspect}\n"
+                   puts "\nGUESS: \n #{route_guess.inspect}\n"
+        
         # do the matches:
         allow = ::Baurets::Optionsful::Introspections.do_the_matches(routes, route_guess)
       end

data/lib/baurets/optionsful/version.rb

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

data/lib/optionsful.rb

@@ -3,7 +3,6 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
 require 'baurets/optionsful/config'
 require 'baurets/optionsful/introspections'
 require 'baurets/optionsful/server'
-require 'baurets/optionsful/documentator'
 
 module Optionsful
   

data/lib/tasks/optionsful.rake

@@ -1,4 +1,8 @@
-# desc "Explaining what the task does"
-# task :optionsful do
-#   # Task goes here
-# end
+require 'fileutils'
+
+namespace :optionsful do
+  desc "Install 'config/optionsful.yml'"
+  task :yml do
+    puts File.dirname(__FILE__)
+  end
+end

data/rails/init.rb

@@ -1,3 +1,9 @@
 # Adding Optionsful to the Rack middleware stack:
 ActionController::Dispatcher.middleware.use Baurets::Optionsful::Server
-ActionController::Dispatcher.middleware.use Baurets::Optionsful::Documentator
+
+puts "Gem.searcher.find('optionsful').full_gem_path = #{Gem.searcher.find('optionsful').full_gem_path}"
+
+Dir["#{Gem.searcher.find('optionsful').full_gem_path}/**/tasks/*.rake"].each do |ext|
+   puts "Loading: #{ext}"
+   load ext 
+ end

data/samples/optionsful.yml

@@ -0,0 +1,14 @@
+development:
+  introspection: enabled
+  http: 
+    base_path: /blopts
+    
+test:
+  introspection: enabled
+  http: 
+    base_path: /blopts
+
+production:
+  introspection: enabled
+  http: 
+    base_path: /blopts

data/spec/optionsful_config_spec.rb

@@ -1,19 +1,18 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-
 describe Baurets::Optionsful::Config do
 
   include Rack::Test::Methods
 
-  describe "Config carries specific settings" do
+  context "Config carries specific settings" do
 
-    describe "by default, try to find the custom configuration file" do
+    describe "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"
@@ -23,22 +22,19 @@ describe Baurets::Optionsful::Config 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
 
-    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