optionsful 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) 2010 Marco Antonio Gonzalez Junior (kayaman@baurets.net).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+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.

data/README.textile

@@ -0,0 +1,60 @@
+h1. Rails OPTIONSful
+
+Provide dynamic information about resources via the OPTIONS' HTTP method on a RESTful design over the Ruby on Rails framework.
+
+* Note for the impatient: installation instructions below.
+* Note for the dummies: change host names and paths properly.
+* Note for the unfaithful: run @rake routes@ to validate the results.
+
+h2. "-No! No! No! *-Show me the code!*" 
+
+<pre>
+  
+$ telnet kayaman.baurets.net 3000 
+OPTIONS /notes HTTP/1.1
+Host: kayaman.baurets.net
+
+HTTP/1.1 204 No Content 
+Allow: GET, POST
+Date: Sat, 10 Jul 2010 23:46:00 GMT
+Link: <http://baurets.net/api/resources>; type=text/html; rel=help
+
+OPTIONS /notes/1 HTTP/1.1
+Host: kayaman.baurets.net
+
+HTTP/1.1 204 No Content 
+Allow: GET, PUT, DELETE
+Date: Sat, 10 Jul 2010 23:47:47 GMT
+Link: <http://baurets.net/api/resources>; type=text/html; rel=help
+
+</pre>
+
+~Note the empty line which is part of the HTTP protocol.~
+
+h2. INSTALLATION:
+
+# Change directory to your Ruby on Rails web application,
+# Run:
+<pre>
+  $ script/plugin install git://github.com/kayaman/optionsful.git
+</pre>
+# Have fun!
+
+h2. TODO & WHISH-LIST
+* -Make the installation easier.-
+* Create tests! (Oh no! Psst! Don't tell anyone!)
+* Research if there are means to know whether formats (types) each one of available methods can accept and serve - WHY NOT make use of BRUTE FORCE? 8-D - We Will Rock You approach - IT WILL BE ANOTHER PROJECT?
+* Provide on demand human readable documentation (maybe attribute oriented programming) hopefully supporting the _about to be given_ @Link@ HTTP header 
+* -Implement instrumentation, logging - (really needed?)-
+* -Research if there are means to test authorization, if Authorization header provided in the request- OUT_OF_SCOPE
+
+
+h2. KNOWN ISSUES
+* -Rails route recognition need hard work-
+* Platform: ruby 1.8.7, rails 2.3.8, rack 1.2.1
+
+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.

data/lib/optionsful.rb

@@ -0,0 +1,89 @@
+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

data/rails/init.rb

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: optionsful
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Marco Antonio Gonzalez Junior
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-15 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Optionsful provide dynamic information via HTTP's OPTION method.
+email: kayaman@baurets.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- MIT-LICENSE
+- lib/optionsful.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://optionsful.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+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.
+test_files: []
+