optionsful 0.2.3 → 0.3.0

data/.autotest

@@ -0,0 +1,23 @@
+require "autotest/growl"
+require 'autotest/fsevent'
+require 'autotest/timestamp'
+require 'autotest/autoupdate'
+require 'autotest/once'
+require 'autotest/restart'
+require 'redgreen'
+
+Autotest::Growl::show_modified_files = true
+
+Autotest.add_hook :initialize do |autotest|
+  %w{.git .svn .hg .DS_Store ._* vendor tmp log doc coverage}.each do |exception|
+    autotest.add_exception(exception)
+  end
+end
+
+Autotest.add_hook :run_command do |at|
+  system "export RSPEC=true"
+  system "export AUTOFEATURE=true"
+end
+
+require 'autotest/rcov'
+# Autotest::RCov.command = 'rcov_info'

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.rvmrc
+.yardoc
+doc
+log
+tmp
+## PROJECT::SPECIFIC

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Marco Antonio Gonzalez Junior (kayaman@baurets.net).
+Copyright (c) 2010 Marco Antonio Gonzalez Junior
 
 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
@@ -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.rdoc

@@ -0,0 +1,17 @@
+= optionsful3
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Marco Antonio Gonzalez Junior. See LICENSE for details.

data/Rakefile

@@ -1,11 +1,66 @@
-require 'metric_fu'
 require 'rubygems'
+require 'rake'
+require 'fileutils'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "optionsful"
+    gem.summary = %Q{Support HTTP OPTIONS verb on your Rails 3 app.}
+    gem.description = %Q{Help building RESTful web services by supporting the HTTP OPTIONS verb on Ruby on Rails applications.}
+    gem.email = "kayaman@baurets.net"
+    gem.homepage = "http://github.com/kayaman/optionsful3"
+    gem.authors = ["Marco Antonio Gonzalez Junior"]
+    gem.rubyforge_project = "optionsful3"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_dependency "rails", ">= 3.0.0"
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "yardoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
 require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts << '--color --format specdoc'
+  spec.verbose = true
+  spec.warning = false
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
 
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = Dir.glob( File.dirname(__FILE__) + '/spec/**/*_spec.rb' )
-  t.spec_opts << '--color --format specdoc'
-  t.rcov = true
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
 end
 
 task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/config/optionsful.yml

@@ -0,0 +1,18 @@
+
+development:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false
+    
+test:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false
+
+production:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false

data/features/optionsful.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'optionsful'
+
+require 'spec/expectations'

data/lib/baurets/optionsful/config.rb

@@ -2,48 +2,53 @@ module Baurets
   module Optionsful
     class Config
 
-      def initialize(options = {})
-        @config = configure_options(options)
-        setup
-        self
-      end
+      DEFAULT = { :link => false, :host => 'auto', :base_path =>  "/optionsful", :propagate => true }
 
-      def base_path
-        @config[:http][:base_path]
+      def initialize(file = nil, options = {})
+        unless file.nil?
+          @config = load_from_file(file, get_env)
+        else
+          begin
+            if (defined? Rails && File.exist?(File.join(Rails.root, 'config', 'optionsful.yml')))
+              envs = YAML::load_file(File.join(Rails.root, 'config', 'optionsful.yml')).symbolize_keys
+              @config = envs[get_env].symbolize_keys
+            end
+          rescue
+          end
+        end
+        @config = DEFAULT if @config.nil?
+        @config
       end
 
-      private
-
-      def configure_options(options = {})
-        default_opts = { :http => { :base_path => "/optionsful"},  :file => "", :environment => "development" }
-        conf = {}
-        if defined? RAILS_ROOT
-          conf = default_opts.merge!({:file => (File.join(RAILS_ROOT, 'config', 'optionsful.yml'))})
+      def get_env
+        if defined? Rails
+          env = :test if Rails.env.test?
+          env = :development if Rails.env.development?
+          env = :production if Rails.env.production?
         else
-          conf = default_opts.merge!({ :http => { :base_path => "/optionsful"} })
+          env = :development
         end
-        conf = conf.merge!(options) unless options.empty?
-        conf
+        env
       end
 
-      def setup
-        require "yaml"
-        yaml_file = @config[:file]
-        begin
-          if File.exist? yaml_file
-            conf = YAML::load_file(yaml_file)[@config[:environment]].symbolize_keys
-            configure(conf) if conf
+      def load_from_file(file, environment)
+        config = nil
+        require 'yaml'
+        if File.exist?(file)
+          begin
+            envs = YAML::load_file(file).symbolize_keys
+            config = envs[environment].symbolize_keys
+          rescue => e
+            puts e.backtrace
           end
-        rescue
         end
+        config
       end
 
-      def configure(conf)
-        @config[:http][:base_path] = conf[:http]["base_path"] if (conf[:http] && conf[:http]["base_path"])
-        @config[:file] = conf[:file] if conf[:file] 
-        @config[:environment] = conf[:environment] if conf[:environment]
+      def method_missing(name, *args)
+        return @config[name.to_sym] 
       end
 
     end
   end
-end
+end

data/lib/baurets/optionsful/introspections.rb

@@ -2,71 +2,23 @@ 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.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|
-              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.do_the_matches(routes, route_guess)
+      def self.do_the_matches(path_info)
+        routes = Rails.application.routes.routes if defined? Rails # Rails major = 3
+        routes.reject!{ |r| r.path == "/rails/info/properties" } # skip the route if it's internal info route
         allow = ""
         routes.each do |route|
-          if route.first == route_guess
-            allow += (route[1][0].to_s.upcase + "|") unless allow.include?(route[1][0].to_s.upcase)
+          if path_info =~ route.conditions[:path_info] 
+            if route.verb
+              allow += (route.verb.to_s.upcase + "|") unless allow.include?(route.verb.to_s.upcase)
+            else
+              # TODO - return 'ANY' doesn't sound ANY good ;p
+              allow = "GET"
+            end
           end
         end
         allow = allow.split("|").join(", ") 
       end
 
-      def self.prepare_request_path(path)
-        path_parts = []
-        path = path[0..(path.rindex('.')-1)] if path.include?('.')
-        path_parts = path.split("/")
-        path_parts.delete("")
-        path_parts
-      end
-
     end
   end
-end
+end

data/lib/baurets/optionsful/server.rb

@@ -4,49 +4,63 @@ module Baurets
 
       def initialize(app)  
         @app = app
-        @config = ::Baurets::Optionsful::Config.new
+        @config = Config.new
       end  
 
       def call(env) 
         unless env["REQUEST_METHOD"] == "OPTIONS"
           @app.call(env)
         else
-          extract_options_information(env)
+          @env = env
+          build_response
         end
       end
 
       private
 
-      def extract_options_information(env)
-        allows = extract_allowed_methods(env)
-        if allows.empty?
-          [404, {}, "Not found."] 
+      def build_response
+        allows = extract_options_information
+        headers = {}
+        status = 500
+        body = ""
+        unless allows.empty?
+          headers.merge!({"Allow" => allows})
+          status = 204
+          if @config.link
+            headers.merge!({"Link" => build_link_header})
+          end
         else
-          [204, {"Allow" => allows, "Link" => "\"#{build_help_link(env)}\""}, ""]  
+          status = 404
+          body = "Not found"
         end
+        [status, headers, body]
       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)
-        
-         puts "\nPATH: \n #{path}\n"
-                   puts "\nROUTES: \n #{routes.inspect}\n"
-                   puts "\nGUESS: \n #{route_guess.inspect}\n"
+      
+      def build_link_header
+        link = ""
+        if @config.host == "auto"
+          server_name = @env["SERVER_NAME"]
+          server_port = @env["SERVER_PORT"]
+          link = "\"<http://#{server_name}:#{server_port}"
+        else
+          link = "\"<http://#{@config.host}"
+        end
+        unless @config.base_path.empty?
+          link += @config.base_path unless @config.base_path == "/"
+        end
+        if @config.propagate == true
+          link += @env["PATH_INFO"]
+        end
         
-        # do the matches:
-        allow = ::Baurets::Optionsful::Introspections.do_the_matches(routes, route_guess)
+        link += ">; type=text/html; rel=help\""
+        link
       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"
+      def extract_options_information
+        allows = ::Baurets::Optionsful::Introspections.do_the_matches(@env["PATH_INFO"])
       end
 
     end
   end
-end
+end
+

data/lib/optionsful.rb

@@ -1,10 +1,11 @@
-$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
-
-require 'baurets/optionsful/config'
-require 'baurets/optionsful/introspections'
-require 'baurets/optionsful/server'
-
-module Optionsful
-  
-  
+##
+# Baurets Software
+# kayaman@baurets.net
+#
+module Baurets
+  module Optionsful
+    autoload :Server, 'baurets/optionsful/server'
+    autoload :Introspections, 'baurets/optionsful/introspections'
+    autoload :Config, 'baurets/optionsful/config'
+  end
 end

data/optionsful.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{optionsful}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marco Antonio Gonzalez Junior"]
+  s.date = %q{2010-08-05}
+  s.description = %q{Help building RESTful web services by supporting the HTTP OPTIONS verb on Ruby on Rails applications.}
+  s.email = %q{kayaman@baurets.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+     ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "config/optionsful.yml",
+     "features/optionsful.feature",
+     "features/step_definitions/optionsful3_steps.rb",
+     "features/support/env.rb",
+     "lib/baurets/optionsful/config.rb",
+     "lib/baurets/optionsful/introspections.rb",
+     "lib/baurets/optionsful/server.rb",
+     "lib/optionsful.rb",
+     "lib/tasks/optionsful.rake",
+     "optionsful.gemspec",
+     "rails/init.rb",
+     "spec/config/optionsful.yml",
+     "spec/config/optionsful_host_auto.yml",
+     "spec/config/optionsful_link_false.yml",
+     "spec/fake_app.rb",
+     "spec/optionsful_config_spec.rb",
+     "spec/optionsful_server_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kayaman/optionsful3}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{optionsful3}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Support HTTP OPTIONS verb on your Rails 3 app.}
+  s.test_files = [
+    "spec/fake_app.rb",
+     "spec/optionsful_config_spec.rb",
+     "spec/optionsful_server_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 3.0.0"])
+  end
+end
+

data/rails/init.rb

@@ -1,9 +1,5 @@
-# Adding Optionsful to the Rack middleware stack:
-ActionController::Dispatcher.middleware.use Baurets::Optionsful::Server
 
-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
+unless defined? Rails
+  puts "This requires Rails 3. Please look for 'optionsful2'."
+end

data/spec/config/optionsful.yml

@@ -0,0 +1,18 @@
+
+development:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false
+    
+test:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false
+
+production:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false

data/spec/config/optionsful_host_auto.yml

@@ -0,0 +1,18 @@
+
+development:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false
+    
+test:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false
+
+production:
+  link: true
+  host: auto
+  base_path: /blopts
+  propagate: false

data/spec/config/optionsful_link_false.yml

@@ -0,0 +1,18 @@
+
+development:
+  link: false
+  host: auto
+  base_path: /blopts
+  propagate: false
+    
+test:
+  link: false
+  host: auto
+  base_path: /blopts
+  propagate: false
+
+production:
+  link: false
+  host: auto
+  base_path: /blopts
+  propagate: false

data/spec/fake_app.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'rails'
+
+class FakeApp < Rails::Application
+
+end