optionsful 0.1.5 → 0.1.6

data/README.textile

@@ -8,29 +8,50 @@ 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:
+
 <pre>
   
-$ telnet kayaman.baurets.net 3000 
-OPTIONS /notes HTTP/1.1
-Host: kayaman.baurets.net
+$ telnet localhost 3000 
+OPTIONS /posts HTTP/1.1
+Host: http://localhost:3000
 
 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
+Connection: close
+Date: Thu, 22 Jul 2010 17:20:27 GMT
+Link: <http://localhost:3000/opts/posts>; type=text/html; rel=help
 
-OPTIONS /notes/1 HTTP/1.1
-Host: kayaman.baurets.net
+OPTIONS /posts/1 HTTP/1.1
+Host: http://localhost:3000
 
 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
+Connection: close
+Date: Thu, 22 Jul 2010 18:14:24 GMT
+Link: <http://localhost:3000/opts/posts/1/>; type=text/html; rel=help
 
-</pre>
+OPTIONS /posts/1/comments HTTP/1.1
+Host: http://localhost:3000
+
+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
 
+</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/opts/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).
+
+
 h2. INSTALLATION:
 
 # Change directory to your Ruby on Rails web application,

data/Rakefile

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

data/lib/baurets/optionsful/config.rb

@@ -0,0 +1,35 @@
+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"} } 
+        setup
+      end
+
+      def setup
+        require "yaml"
+        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
+            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])
+      end
+
+
+      def base_path
+        @config[:http][:base_path]
+      end
+      
+    end
+
+  end
+end

data/lib/baurets/optionsful/documentator.rb

@@ -0,0 +1,127 @@
+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
+          @app.call(env)
+        else
+          begin
+            return extract_documentation(env)
+          rescue => e
+            [500, {}, e.backtrace.join("\n")]
+          end
+        end
+      end
+      
+      private
+
+      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"
+        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)).join("\n")
+
+        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 = "\n\nService: \n" + service_doc + "\n" 
+        methods_docs.each do |md|
+          body += "\n\nMethod: #{md[0][0]} \n Action: #{md[0][1]} \n Metadata: \n #{md[1]}\n\n-- end ---\n"
+        end
+
+        [200, {}, "Under development!!! \n  #{body}"]
+      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.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

data/lib/baurets/optionsful/introspections.rb

@@ -0,0 +1,79 @@
+module Baurets
+  module Optionsful
+    module Introspections
+
+      def self.is_part_static?(routes, index, value)
+        routes.each do |route|
+          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.routes.each do |route|
+            static_path = []
+            route.segments.each do |segment|
+              route_requirements = route.requirements #TODO validate 
+              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)
+                static_path << :dynamic unless (segment.respond_to?(:key) && segment.key == :format)   
+              end
+            end
+            routes << [static_path, [route.conditions[:method].to_s.upcase, route_requirements[:action]], route_requirements] unless route.conditions[:method].nil?
+          end
+        end
+      end
+
+      def self.guess_route(routes, path)
+        guess = []
+        parts = prepare_request_path(path)
+        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 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 + "|" 
+          end
+        end
+        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_parts.delete("")
+        path_parts
+      end
+
+    end
+  end
+end

data/lib/baurets/optionsful/server.rb

@@ -0,0 +1,47 @@
+module Baurets
+  module Optionsful
+    class Server
+
+      def initialize(app)  
+        @app = app
+        @config = ::Baurets::Optionsful::Config.new
+      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)
+        allows = extract_allowed_methods(env)
+        if allows.empty?
+          [404, {}, "Not found."] 
+        else
+          [204, {"Allow" => allows, "Link" => build_help_link(env)}, ""]  
+        end
+      end
+
+      def extract_allowed_methods(env)
+        # do routing introspection:
+        routes = ::Baurets::Optionsful::Introspections.do_routing_introspection
+        # do request path investigation
+        path = env["PATH_INFO"]
+        route_guess = ::Baurets::Optionsful::Introspections.guess_route(routes, path)
+        # do the matches:
+        allow = ::Baurets::Optionsful::Introspections.do_the_matches(routes, route_guess)
+      end
+
+      def build_help_link(env)
+        server_name = env["SERVER_NAME"]
+        server_port = env["SERVER_PORT"]
+        "<http://#{server_name}:#{server_port}" + @config.base_path + "#{env["PATH_INFO"]}>; type=text/html; rel=help"
+      end
+
+    end
+  end
+end

data/lib/baurets/optionsful/version.rb

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

data/lib/optionsful.rb

@@ -1,57 +1,11 @@
-require File.join(File.dirname(__FILE__), 'introspections.rb')
+$:.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'
 
-class Optionsful  
-
+module Optionsful
+  
   
-  def initialize(app)  
-    @app = app
-    @doc = {:controller => nil, :actions => [] } # { :action => "index", :method => "GET" }, { :action => "create", :method => "POST" }
-  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(env)}, ""]  
-  end
-
-  def extract_allowed_methods(env)
-    # do routing introspection:
-    routes = Introspections.do_routing_introspection
-    # do request path investigation
-    route_guess = Introspections.guess_route(routes, env["PATH_INFO"])
-    # do the matches:
-    allow = do_the_matches(routes, route_guess)
-  end
-
-  private
-
-  def do_the_matches(routes, route_guess)
-    allow = ""
-    routes.each do |route|
-      if route.first == route_guess
-        allow += route[1][0].to_s.upcase + "|" 
-        @doc[:controller] = route[2][:controller]
-        @doc[:actions] << { :action => (route[2][:action]), :method => (route[1].to_s.upcase!) }
-      end
-    end
-    allow = allow.split("|").join(", ")
-  end
-
-  def build_help_link(env)
-    server_name = env["SERVER_NAME"]
-    server_port = env["SERVER_PORT"]
-    "<http://#{server_name}:#{server_port}/opts#{env["PATH_INFO"]}>; type=text/html; rel=help"
-  end
-
-
-
 end

data/rails/init.rb

@@ -1,15 +1,3 @@
 # Adding Optionsful to the Rack middleware stack:
-ActionController::Dispatcher.middleware.use Optionsful
-ActionController::Dispatcher.middleware.use OptionsfulDocs
-
-
-require 'rubygems'
-require 'yard'
-YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'
-
-# Define custom tags
-YARD::Tags::Library.define_tag("URL for Service", :url)
-YARD::Tags::Library.define_tag("Topic for Service", :topic)
-YARD::Tags::Library.define_tag("Arguments", :argument, :with_types_and_name)
-YARD::Tags::Library.define_tag("Example Responses", :example_response)
-YARD::Tags::Library.define_tag("Response Fields", :response_field, :with_name)
+ActionController::Dispatcher.middleware.use Baurets::Optionsful::Server
+ActionController::Dispatcher.middleware.use Baurets::Optionsful::Documentator

data/spec/{optionsful_docs_spec.rb → optionsful_documentator_spec.rb}

@@ -1,24 +1,26 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 
-describe "OptionsfulDocs" do
+describe Baurets::Optionsful::Documentator do
 
   include Rack::Test::Methods
 
+config = ::Baurets::Optionsful::Config.new
+  path = config.base_path
 
   describe "as a Rack middleware" do
 
     it "is a Ruby object that responds to call;" do
-      assert OptionsfulDocs.new(app).respond_to? :call
+      assert ::Baurets::Optionsful::Documentator.new(app).respond_to? :call
     end
 
     it "takes exactly one argument, (the environment) and returns an Array;" do
-      response = OptionsfulDocs.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => "/opts/"}))
+      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => path}))
       assert response.kind_of?(Array)
     end
 
     it "the returned Array must have exactly three values: the status, the headers and the body;" do
-      response = OptionsfulDocs.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => "/opts/"}))
+      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => path}))
       assert response.size.should == 3
       assert response[0].kind_of? Fixnum 
       assert response[1].kind_of? Hash
@@ -26,7 +28,7 @@ describe "OptionsfulDocs" do
     end
 
     it "must be nice, acting somewhere on a Rack middleware stack." do
-      response = fake_docs_app.call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => "/opts/"}))
+      response = fake_docs_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

data/spec/{optionsful_spec.rb → optionsful_server_spec.rb}

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 
-describe "Optionsful," do
+describe Baurets::Optionsful::Server do
 
   include Rack::Test::Methods
 
@@ -15,16 +15,16 @@ describe "Optionsful," do
   describe "as a Rack middleware" do
 
     it "is a Ruby object that responds to call;" do
-      assert Optionsful.new(app).respond_to? :call
+      assert ::Baurets::Optionsful::Server.new(app).respond_to? :call
     end
 
     it "takes exactly one argument, (the environment) and returns an Array;" do
-      response = Optionsful.new(app).call(mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => "/posts"}))
+      response = ::Baurets::Optionsful::Server.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 = Optionsful.new(app).call(mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => "/posts"}))
+      response = ::Baurets::Optionsful::Server.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
@@ -90,6 +90,16 @@ describe "Optionsful," 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
+        
+        it "not finding a path, pretend you're dead and.. let it goes through" do
+          pending
+        end
 
       end
 

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
-require File.join(File.dirname(__FILE__), '..', 'lib','optionsful.rb')
-require File.join(File.dirname(__FILE__), '..', 'lib','optionsful_docs.rb')
+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
 
 require 'rubygems' 
 require 'sinatra' 
@@ -41,7 +44,7 @@ DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "
       app = Rack::Builder.new {
         use Rack::CommonLogger
         use Rack::ShowExceptions
-        use Optionsful
+        use Baurets::Optionsful::Server
         map "/lobster" do
           use Rack::Lint
           run Rack::Lobster.new
@@ -53,7 +56,7 @@ DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "
       app = Rack::Builder.new {
         use Rack::CommonLogger
         use Rack::ShowExceptions
-        use OptionsfulDocs
+        use Baurets::Optionsful::Documentator
         map "/lobster" do
           use Rack::Lint
           run Rack::Lobster.new
@@ -67,7 +70,7 @@ DEFAULT_ENV = { "rack.version" => Rack::VERSION, "rack.input" => StringIO.new, "
 
     def http_options_request(path)
       complex_env = mock_env({"REQUEST_METHOD" => "OPTIONS", "PATH_INFO" => path })
-      response = Optionsful.new(app).call(complex_env)
+      response = Baurets::Optionsful::Server.new(app).call(complex_env)
     end
     
     def allows?(headers, method)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: optionsful
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Marco Antonio Gonzalez Junior
@@ -30,17 +30,19 @@ extra_rdoc_files: []
 files: 
 - README.textile
 - MIT-LICENSE
-- lib/optionsful.rb
+- lib/baurets/optionsful/server.rb
 - rails/init.rb
 - lib/tasks/optionsful.rake
 - Rakefile
-- spec/optionsful_spec.rb
+- spec/optionsful_server_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- lib/optionsful_docs.rb
-- lib/introspections.rb
+- lib/baurets/optionsful/documentator.rb
+- lib/baurets/optionsful/introspections.rb
 - lib/baurets/optionsful/version.rb
-- spec/optionsful_docs_spec.rb
+- lib/baurets/optionsful/config.rb
+- lib/optionsful.rb
+- spec/optionsful_documentator_spec.rb
 has_rdoc: true
 homepage: http://optionsful.rubyforge.org
 licenses: []

data/lib/introspections.rb

@@ -1,94 +0,0 @@
-
-module Introspections
-
-
-
-  def self.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 self.is_part_static?(routes, index, value)
-    routes.each do |route|
-      if route[0][index] == value
-        return true
-      end
-    end
-    return false
-  end
-
-  def self.do_routing_introspection
-    routes = []
-    route_requirements = nil
-    ActionController::Routing::Routes.routes.each do |route|
-      static_path = []
-      route.segments.each do |segment|
-        route_requirements = route.requirements #TODO validate 
-        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)
-          static_path << :dynamic unless (segment.respond_to?(:key) && segment.key == :format)   
-        end
-      end
-      routes << [static_path, [route.conditions[:method].to_s.upcase, route_requirements[:action]], route_requirements] unless route.conditions[:method].nil?
-    end
-    routes
-  end
-
-  def self.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 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 + "|" 
-      end
-    end
-    allow = allow.split("|").join(", ")
-  end
-
-  def self.prepare_request_path(path)
-    unless path.kind_of? Array
-      path = path[0..(path.rindex('.')-1)] if path.include?('.')
-      path_parts = path.split("/")
-    else
-      path_parts = path
-    end
-    path_parts.delete("")
-    path_parts
-  end
-end

data/lib/optionsful_docs.rb

@@ -1,129 +0,0 @@
-require 'rubygems'
-require 'yard'
-require 'rdoc/rdoc'
-require 'fileutils'
-require File.join(File.dirname(__FILE__), 'introspections.rb')
-
-class OptionsfulDocs
-
-
-  def initialize(app)  
-    @app = app
-  end  
-
-  def call(env) 
-    unless env["PATH_INFO"].index("/opts/") == 0
-      @app.call(env)
-    else
-      extract_documentation(env)
-    end
-  end
-
-  def extract_documentation(env)
-
-    parts = env["PATH_INFO"].split("/")
-    parts.delete("")
-    parts.delete("opts")
-    # do routing introspection:
-    routes = Introspections.do_routing_introspection
-    # do request path investigation
-    path = parts.join("/")
-    puts "\n #{path} \n"
-    route_guess = Introspections.guess_route(routes,path)
-    # do the matches:
-    allow = Introspections.do_the_matches(routes, route_guess)
-    http_methods = allow.split(", ")
-
-    controller_actions = []
-    http_methods.each do |verb|
-      controller_actions << [verb, relate_action_to_method(parts, verb)]
-    end
-
-    controller_actions.delete_if {|pair| pair[1].empty? }
-    puts "controller_actions: #{controller_actions.inspect}"
-    controller_name = Introspections.discover_controller_name(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)).join("\n")
-
-    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 = "\n\nService: \n" + service_doc + "\n" 
-    methods_docs.each do |md|
-      body += "\n\nMethod: #{md[0][0]} \n Action: #{md[0][1]} \n Metadata: \n #{md[1]}\n\n-- end ---\n"
-    end
-
-    [200, {}, "Under development!!! \n  #{body}"]
-  end
-
-  def relate_action_to_method(path, verb)
-    action = ""
-    routes = Introspections.do_routing_introspection
-    route_guess = 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.reverse
-    puts doc.inspect
-    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
-  end
-
-end