soar_sc-rack-router 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d498fa3bf594aa2b22ca48aa31b8cb8097796c5d
-  data.tar.gz: 8c925e0ddf11b97bb5818aedabba4e0b955b756b
+  metadata.gz: 06db72006f7280dbcdfd881a108d084e9fb67b79
+  data.tar.gz: 4ffcd46d095e341fce59740dad5a6faaa3ed8552
 SHA512:
-  metadata.gz: 3642dec09f7242a7a0475790c2c92262efab5790be0361714c8a42d117a90b9e85ba78d140a3aa729da5812b602de625ee478747ae05b485476e019156a8a1ae
-  data.tar.gz: 8e407af01156f52e78b79144c80cb225e471234c5d0ad608b298dbe389e26e627b37049faa91983a887dc6f4f6e3b60b0bf3e5ad546afae85672c0707ce3fd27
+  metadata.gz: 1962096dc371cc19ce1d25bde13a0724f9d934006bcf0a0c36036f7bc3b762a2154025effb39aa52aa8f90c2b5a024ddf502e22d8683c3f27376e5bfb38122f2
+  data.tar.gz: c7b0b28b6ec325022474b76bff8194de423beb484b185eba8516d7c9549eaaea0a60c16bbbda5a20793ad883663ca2201af1d38116313a3d877426dd30f7bc50

data/README.md

@@ -14,6 +14,11 @@ Because it supports parameterized URLs, it is familiar to users of several Ruby
 into WADL and other service descriptions. The parameter support is compatible with Rack::Request, without pushing a dependency on Rack::Request
 down into the router action API; the only requirement for router actions is that they are rack apps.
 
+Users of Ruby web frameworks like Rails and Sinatra may be surprised that double-slashes in request paths are not normalized.
+In Sinatra, this is actually done by the `rack-protection` middleware, not `sinatra-router`.
+Users of `SoarSc::Rack::Router` definitely should be using the [rack-protection](https://rubygems.org/gems/rack-protection) middleware
+above the router in their stacks.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -74,10 +79,12 @@ stack = Rack::Builder.new do
       use Auditing
       run ->(...)
     end
-
-    run ->(env) { [404, {'Content-Type' => 'text/plain'}, ['Object Not Found']] }
   end
+  
+  run ->(env) { [404, {'Content-Type' => 'text/plain'}, ['Object Not Found']] }
 end
+
+run stack
 ```
 
 An example of parameterized URL support:
@@ -100,6 +107,25 @@ end
 run stack
 ```
 
+Note that, even though the router doesn't break the rack stack by demanding that routing actions receive a `Rack::Request`,
+it's recommended that routing actions use `Rack::Request` internally to retrieve path parameters. The router adds them to rack's
+`env` using `Rack::Request#update_param`, making `Rack::Request#params` the safest way to retrieve them.
+
+Finally, here is a demonstration that doesn't use `Rack::Builder`, just to clarify that it's not a dependency:
+
+```ruby
+require 'soar_sc/rack/router'
+
+index = ->(env) { ... }
+about = ->(env) { ... }
+contact = ->(env) { ...]
+
+run SoarSc::Rack::Router.new(index) do
+  get "/about", about
+  get "/contact", contact
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/soar_sc/rack/router.rb

@@ -1,5 +1,6 @@
 require "soar_sc/rack/router/builder_syntax"
 require "soar_sc/rack/router/errors"
+require "soar_sc/rack/router/http_method"
 require "soar_sc/rack/router/route"
 require "soar_sc/rack/router/version"
 
@@ -11,18 +12,17 @@ module SoarSc
 
       include BuilderSyntax
 
+      EMPTY_STRING = ""
+
       def initialize(app, routes = {}, &block)
         @app = app
-        @static_routes = []
-        @parameterized_routes = []
-        routes.each { |(p, a)| add_route(Route.new('*', p, a)) }
+        @routes = []
+        routes.each { |(p, a)| add_route(Route.new(HttpMethod::ANY, p, a)) }
         instance_eval(&block) if block_given?
       end
 
       def call(env)
-        if route = @static_routes.detect { |r| r.matches?(env) }
-          route.action.call(env)
-        elsif route = @parameterized_routes.detect { |r| r.matches?(env) }
+        if route = @routes.detect { |r| r.matches?(env) }
           update_path_parameters!(env, route.extract_path_parameters(env))
           route.action.call(env)
         else
@@ -34,18 +34,33 @@ module SoarSc
 
       # Called by BuilderSyntax methods
       def add_route(route)
-        if (@static_routes + @parameterized_routes).detect { |r| r.path == route.path and (r.method == route.method or r.method = "*") }
+        if include?(route)
           raise DuplicateRouteError.for_route(route)
-        elsif route.static?
-          @static_routes << route
         else
-          @parameterized_routes << route
+          @routes << route
+        end
+      end
+
+      def include?(route)
+        @routes.detect do |other|
+          route.matches?(env_for_route(other)) or other.matches?(env_for_route(route))
         end
       end
 
+      # Creates a minimal env that would be matched by the given route.
+      def env_for_route(route)
+        {
+          Route::REQUEST_METHOD => (route.method == HttpMethod::ANY ? HttpMethod::GET : route.method),
+          Route::SCRIPT_NAME => route.path,
+          Route::PATH_INFO => EMPTY_STRING
+        }
+      end
+
       def update_path_parameters!(env, params)
-        req = ::Rack::Request.new(env)
-        params.each { |p, v| req.update_param(p, v) }
+        unless params.empty?
+          req = ::Rack::Request.new(env)
+          params.each { |p, v| req.update_param(p, v) }
+        end
       end
 
     end

data/lib/soar_sc/rack/router/builder_syntax.rb

@@ -1,3 +1,5 @@
+require 'soar_sc/rack/router/http_method'
+
 module SoarSc
   module Rack
     class Router
@@ -5,39 +7,39 @@ module SoarSc
       module BuilderSyntax
 
         def map(path, app)
-          add_route(Route.new('*', path, app))
+          add_route(Route.new(HttpMethod::ANY, path, app))
         end
 
         def get(path, app)
-          add_route(Route.new('GET', path, app))
+          add_route(Route.new(HttpMethod::GET, path, app))
         end
 
         def post(path, app)
-          add_route(Route.new('POST', path, app))
+          add_route(Route.new(HttpMethod::POST, path, app))
         end
 
         def put(path, app)
-          add_route(Route.new('PUT', path, app))
+          add_route(Route.new(HttpMethod::PUT, path, app))
         end
 
         def delete(path, app)
-          add_route(Route.new('DELETE', path, app))
+          add_route(Route.new(HttpMethod::DELETE, path, app))
         end
 
         def options(path, app)
-          add_route(Route.new('OPTIONS', path, app))
+          add_route(Route.new(HttpMethod::OPTIONS, path, app))
         end
 
         def head(path, app)
-          add_route(Route.new('HEAD', path, app))
+          add_route(Route.new(HttpMethod::HEAD, path, app))
         end
 
         def trace(path, app)
-          add_route(Route.new('TRACE', path, app))
+          add_route(Route.new(HttpMethod::TRACE, path, app))
         end
 
         def connect(path, app)
-          add_route(Route.new('CONNECT', path, app))
+          add_route(Route.new(HttpMethod::CONNECT, path, app))
         end
 
       end

data/lib/soar_sc/rack/router/http_method.rb

@@ -0,0 +1,19 @@
+module SoarSc
+  module Rack
+    class Router
+      module HttpMethod
+
+        ANY = "*"
+        GET = "GET"
+        POST = "POST"
+        PUT = "PUT"
+        DELETE = "DELETE"
+        HEAD = "HEAD"
+        OPTIONS = "OPTIONS"
+        TRACE = "TRACE"
+        CONNECT = "CONNECT"
+
+      end
+    end
+  end
+end

data/lib/soar_sc/rack/router/route.rb

@@ -1,35 +1,50 @@
+require 'soar_sc/rack/router/http_method'
+
+# TODO Normalize paths (compress runs of slashes)
 module SoarSc
   module Rack
     class Router
 
       class Route
+        PARAMETER_PREFIX = ":"
+        PARAMETER_VALID_REGEXP = /:[a-z_][a-z0-9_]*/
+        REQUEST_METHOD = "REQUEST_METHOD"
+        SCRIPT_NAME = "SCRIPT_NAME"
+        PATH_INFO = "PATH_INFO"
+        EMPTY_HASH = {}.freeze
+
         attr_reader :method, :path, :action
 
         def initialize(method, path, action)
           validate_path(path)
           @method, @path, @action = method, path, action
-        end
-
-        def static?
-          components(path).none? { |c| c.start_with?(":") }
+          @static = components(path).none? { |c| c.start_with?(PARAMETER_PREFIX) }
         end
 
         def matches?(env)
-          return false unless (method == env["REQUEST_METHOD"] or method == "*")
+          return false unless method == env[REQUEST_METHOD] or method == HttpMethod::ANY
+
+          return request_path(env) == path if @static
 
+          route_components = components(path)
           req_components = components(request_path(env))
-          components(path).each_with_index do |c, i|
-            return false unless c.start_with?(":") or c == req_components[i]
+
+          return false unless route_components.size == req_components.size
+
+          route_components.each_with_index do |c, i|
+            return false unless c.start_with?(PARAMETER_PREFIX) or c == req_components[i]
           end
 
           return true
         end
 
         def extract_path_parameters(env)
+          return EMPTY_HASH if @static
+
           req_components = components(request_path(env))
           parameters = {}
           components(path).each_with_index do |c, i|
-            parameters[c[1..-1]] = req_components[i] if c.start_with?(":")
+            parameters[c[1..-1]] = req_components[i] if c.start_with?(PARAMETER_PREFIX)
           end
           parameters
         end
@@ -37,7 +52,7 @@ module SoarSc
         private
 
         def request_path(env)
-          env["SCRIPT_NAME"].to_s + env["PATH_INFO"].to_s
+          env[SCRIPT_NAME] + env[PATH_INFO]
         end
 
         def components(path)
@@ -46,7 +61,7 @@ module SoarSc
 
         def validate_path(path)
           components(path).each do |c|
-            if c.start_with?(":") and c !~ /:[a-z_][a-z0-9_]*+/
+            if c.start_with?(PARAMETER_PREFIX) and c !~ PARAMETER_VALID_REGEXP
               raise InvalidParameterError, "Invalid parameter #{c} in path #{path}"
             end
           end

data/lib/soar_sc/rack/router/version.rb

@@ -1,7 +1,7 @@
 module SoarSc
   module Rack
     class Router
-      VERSION = "0.1.2"
+      VERSION = "1.0.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soar_sc-rack-router
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Sheldon Hearn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -86,6 +86,7 @@ files:
 - lib/soar_sc/rack/router.rb
 - lib/soar_sc/rack/router/builder_syntax.rb
 - lib/soar_sc/rack/router/errors.rb
+- lib/soar_sc/rack/router/http_method.rb
 - lib/soar_sc/rack/router/route.rb
 - lib/soar_sc/rack/router/version.rb
 - soar_sc-rack-router.gemspec