lotus-router 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53b681f4148b22f7bbcd6521eeb8b241673d9253
-  data.tar.gz: 94af70e6ee5f0d7a8e4ebf84c5ddc14a3bdba63d
+  metadata.gz: 385192d4a396ff6a0e91dabff73a8351c55848ed
+  data.tar.gz: efd06ad2632579b10f7cf6229aba7b3d760fbc08
 SHA512:
-  metadata.gz: 98ae99df5474dbde90fc2c9fc8f27f09877cb1327a00a01ed7e3a897d37ce4501af4dce06a45bc78270e3a908fb6ac833d7784d24ea63be56aefa3c79b5a6599
-  data.tar.gz: 6200a6ba3498a91a123161f8f23e0e79e92a2bc903647fe43ac644733564148de73571da35d49f04fada7a34ac278f7dd38ff3b833fdc136e2aebca5c9d66838
+  metadata.gz: a0c1078e04043023b44f1a72189e6890dd8e1ccfa53f966bb6624527f2444fa5825ede6944e17c0b171b2eecf393cb1f39573e65073a74b512813114c37a00e0
+  data.tar.gz: 662945b950952171f02220b318e808b87c44ad44b54034defff58772fd30f92d3ab9036737433888ae06c2b8be07ccbb52d6e4f1f8d739c2f33dffb5e1281d01

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Lotus::Router
 Rack compatible HTTP router for Ruby
 
+## v0.5.0 - 2016-01-12
+### Added
+- [Luca Guidi] Added `Lotus::Router#recognize` as a testing facility. Example `router.recognize('/') # => associated route`
+- [Luca Guidi] Added `Lotus::Router.define` in order to wrap routes definitions in `config/routes.rb` when `Lotus::Router` is used outside of Lotus projects
+- [David Strauß] Make `Lotus::Routing::Parsing::JsonParser` compatible with `application/vnd.api+json` MIME Type
+- [Alfonso Uceda Pompa] Improved exception messages for `Lotus::Router#path` and `#url`
+
+### Fixed
+- [Alfonso Uceda Pompa] Ensure `Lotus::Router#path` and `#url` to generate correct URL for mounted applications
+- [Vladislav Zarakovsky] Ensure Force SSL mode to respect Rack SPEC
+
+### Changed
+- [Alfonso Uceda Pompa] A failure for body parsers raises a `Lotus::Routing::Parsing::BodyParsingError` exception
+- [Karim Tarek] Introduced `Lotus::Router::Error` and let all the framework exceptions to inherit from it.
+
 ## v0.4.3 - 2015-09-30
 ### Added
 - [Luca Guidi] Official support for JRuby 9k+

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2015 Luca Guidi
+Copyright © 2014-2016 Luca Guidi
 
 MIT License
 

data/README.md

@@ -568,18 +568,106 @@ router.path(:new_user_favorites, user_id: 1)         # => /users/1/favorites/new
 router.path(:edit_user_favorites, user_id: 1, id: 2) # => /users/1/favorites/2/edit
 ```
 
+### Body Parsers
+
+Rack ignores request bodies unless they come from a form submission.
+If we have a JSON endpoint, the payload isn't available in the params hash:
+
+```ruby
+Rack::Request.new(env).params # => {}
+```
+
+This feature enables body parsing for specific MIME Types.
+It comes with a built-in JSON parser and allows to pass custom parsers.
+
+#### JSON Parsing
+
+```ruby
+require 'lotus/router'
+
+endpoint = ->(env) { [200, {},[env['router.params'].inspect]] }
+
+router = Lotus::Router.new(parsers: [:json]) do
+  patch '/books/:id', to: endpoint
+end
+```
+
+```shell
+curl http://localhost:2300/books/1    \
+  -H "Content-Type: application/json" \
+  -H "Accept: application/json"       \
+  -d '{"published":"true"}'           \
+  -X PATCH
+
+# => [200, {}, ["{:published=>\"true\",:id=>\"1\"}"]]
+```
+
+If the json can't be parsed an exception is raised:
+
+```ruby
+Lotus::Routing::Parsing::BodyParsingError
+```
+
+#### Custom Parsers
+
+```ruby
+require 'lotus/router'
+
+# See Lotus::Routing::Parsing::Parser
+class XmlParser
+  def mime_types
+    ['application/xml', 'text/xml']
+  end
+
+  # Parse body and return a Hash
+  def parse(body)
+    # parse xml
+  rescue SomeXmlParsingError => e
+    raise Lotus::Routing::Parsing::BodyParsingError.new(e)
+  end
+end
+
+endpoint = ->(env) { [200, {},[env['router.params'].inspect]] }
+
+router = Lotus::Router.new(parsers: [XmlParser.new]) do
+  patch '/authors/:id', to: endpoint
+end
+```
+
+```shell
+curl http://localhost:2300/authors/1 \
+  -H "Content-Type: application/xml" \
+  -H "Accept: application/xml"       \
+  -d '<name>LG</name>'               \
+  -X PATCH
+
+# => [200, {}, ["{:name=>\"LG\",:id=>\"1\"}"]]
+```
+
 ## Testing
 
 ```ruby
 require 'lotus/router'
-require 'rack/request'
 
 router = Lotus::Router.new do
-  get '/', to: ->(env) { [200, {}, ['Hi!']] }
+  get '/books/:id', to: 'books#show', as: :book
 end
 
-app = Rack::MockRequest.new(router)
-app.get('/') # => #<Rack::MockResponse:0x007fc4540dc238 ...>
+route = router.recognize('/books/23')
+route.verb      # "GET"
+route.action    # => "books#show"
+route.params    # => {:id=>"23"}
+route.routable? # => true
+
+route = router.recognize(:book, id: 23)
+route.verb      # "GET"
+route.action    # => "books#show"
+route.params    # => {:id=>"23"}
+route.routable? # => true
+
+route = router.recognize('/books/23', method: :post)
+route.verb      # "POST"
+route.routable? # => false
 ```
 
 ## Versioning
@@ -601,4 +689,4 @@ Thanks to Joshua Hull ([@joshbuddy](https://github.com/joshbuddy)) for his
 
 ## Copyright
 
-Copyright © 2014-2015 Luca Guidi – Released under MIT License
+Copyright © 2014-2016 Luca Guidi – Released under MIT License

data/lib/lotus/router.rb

@@ -1,7 +1,9 @@
+require 'rack/request'
 require 'lotus/routing/http_router'
 require 'lotus/routing/namespace'
 require 'lotus/routing/resource'
 require 'lotus/routing/resources'
+require 'lotus/routing/error'
 
 module Lotus
   # Rack compatible, lightweight and fast HTTP Router.
@@ -71,6 +73,57 @@ module Lotus
   #
   #   # All the requests starting with "/api" will be forwarded to Api::App
   class Router
+    # This error is raised when <tt>#call</tt> is invoked on a non-routable
+    # recognized route.
+    #
+    # @since 0.5.0
+    #
+    # @see Lotus::Router#recognize
+    # @see Lotus::Routing::RecognizedRoute
+    # @see Lotus::Routing::RecognizedRoute#call
+    # @see Lotus::Routing::RecognizedRoute#routable?
+    class NotRoutableEndpointError < Lotus::Routing::Error
+      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+      PATH_INFO      = 'PATH_INFO'.freeze
+
+      def initialize(env)
+        super %(Cannot find routable endpoint for #{ env[REQUEST_METHOD] } "#{ env[PATH_INFO] }")
+      end
+    end
+
+    # Returns the given block as it is.
+    #
+    # When Lotus::Router is used as a standalone gem and the routes are defined
+    # into a configuration file, some systems could raise an exception.
+    #
+    # Imagine the following file into a Ruby on Rails application:
+    #
+    #   get '/', to: 'api#index'
+    #
+    # Because Ruby on Rails in production mode use to eager load code and the
+    # routes file uses top level method calls, it crashes the application.
+    #
+    # If we wrap these routes with <tt>Lotus::Router.define</tt>, the block
+    # doesn't get yielded but just returned to the caller as it is.
+    #
+    # Usually the receiver of this block is <tt>Lotus::Router#initialize</tt>,
+    # which finally evaluates the block.
+    #
+    # @param blk [Proc] a set of route definitions
+    #
+    # @return [Proc] the given block
+    #
+    # @since 0.5.0
+    #
+    # @example
+    #   # apps/web/config/routes.rb
+    #   Lotus::Router.define do
+    #     get '/', to: 'home#index'
+    #   end
+    def self.define(&blk)
+      blk
+    end
+
     # Initialize the router.
     #
     # @param options [Hash] the options to initialize the router
@@ -878,6 +931,125 @@ module Lotus
       @router.call(env)
     end
 
+    # Recognize the given env, path, or name and return a route for testing
+    # inspection.
+    #
+    # If the route cannot be recognized, it still returns an object for testing
+    # inspection.
+    #
+    # @param env [Hash, String, Symbol] Rack env, path or route name
+    # @param options [Hash] a set of options for Rack env or route params
+    # @param params [Hash] a set of params
+    #
+    # @return [Lotus::Routing::RecognizedRoute] the recognized route
+    #
+    # @since 0.5.0
+    #
+    # @see Lotus::Router#env_for
+    # @see Lotus::Routing::RecognizedRoute
+    #
+    # @example Successful Path Recognition
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize('/books/23')
+    #   route.verb      # => "GET" (default)
+    #   route.routable? # => true
+    #   route.params    # => {:id=>"23"}
+    #
+    # @example Successful Rack Env Recognition
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize(Rack::MockRequest.env_for('/books/23'))
+    #   route.verb      # => "GET" (default)
+    #   route.routable? # => true
+    #   route.params    # => {:id=>"23"}
+    #
+    # @example Successful Named Route Recognition
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize(:book, id: 23)
+    #   route.verb      # => "GET" (default)
+    #   route.routable? # => true
+    #   route.params    # => {:id=>"23"}
+    #
+    # @example Failing Recognition For Unknown Path
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize('/books')
+    #   route.verb      # => "GET" (default)
+    #   route.routable? # => false
+    #
+    # @example Failing Recognition For Path With Wrong HTTP Verb
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize('/books/23', method: :post)
+    #   route.verb      # => "POST"
+    #   route.routable? # => false
+    #
+    # @example Failing Recognition For Rack Env With Wrong HTTP Verb
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize(Rack::MockRequest.env_for('/books/23', method: :post))
+    #   route.verb      # => "POST"
+    #   route.routable? # => false
+    #
+    # @example Failing Recognition Named Route With Wrong Params
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize(:book)
+    #   route.verb      # => "GET" (default)
+    #   route.routable? # => false
+    #
+    # @example Failing Recognition Named Route With Wrong HTTP Verb
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new do
+    #     get '/books/:id', to: 'books#show', as: :book
+    #   end
+    #
+    #   route = router.recognize(:book, {method: :post}, {id: 1})
+    #   route.verb      # => "POST"
+    #   route.routable? # => false
+    #   route.params    # => {:id=>"1"}
+    def recognize(env, options = {}, params = nil)
+      require 'lotus/routing/recognized_route'
+
+      env          = env_for(env, options, params)
+      responses, _ = *@router.recognize(env)
+
+      Routing::RecognizedRoute.new(
+        responses.nil? ? responses : responses.first,
+        env, @router)
+    end
+
     # Generate an relative URL for a specified named route.
     # The additional arguments will be used to compose the relative URL - in
     #   case it has tokens to match - and for compose the query string.
@@ -957,5 +1129,36 @@ module Lotus
       require 'lotus/routing/routes_inspector'
       Routing::RoutesInspector.new(@router.routes)
     end
+
+    protected
+
+    # Fabricate Rack env for the given Rack env, path or named route
+    #
+    # @param env [Hash, String, Symbol] Rack env, path or route name
+    # @param options [Hash] a set of options for Rack env or route params
+    # @param params [Hash] a set of params
+    #
+    # @return [Hash] Rack env
+    #
+    # @since 0.5.0
+    # @api private
+    #
+    # @see Lotus::Router#recognize
+    # @see http://www.rubydoc.info/github/rack/rack/Rack%2FMockRequest.env_for
+    def env_for(env, options = {}, params = nil)
+      env = case env
+      when String
+        Rack::MockRequest.env_for(env, options)
+      when Symbol
+        begin
+          url = path(env, params || options)
+          return env_for(url, options)
+        rescue Lotus::Routing::InvalidRouteException
+          {}
+        end
+      else
+        env
+      end
+    end
   end
 end

data/lib/lotus/router/version.rb

@@ -1,6 +1,6 @@
 module Lotus
   class Router
     # @since 0.1.0
-    VERSION = '0.4.3'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/lib/lotus/routing/endpoint.rb

@@ -1,4 +1,5 @@
 require 'delegate'
+require 'lotus/routing/error'
 require 'lotus/utils/class'
 
 module Lotus
@@ -7,7 +8,7 @@ module Lotus
     # This is raised when the router fails to load an endpoint at the runtime.
     #
     # @since 0.1.0
-    class EndpointNotFound < ::StandardError
+    class EndpointNotFound < Lotus::Routing::Error
     end
 
     # Routing endpoint

data/lib/lotus/routing/error.rb

@@ -0,0 +1,7 @@
+module Lotus
+  module Routing
+    # @since 0.5.0
+    class Error < ::StandardError
+    end
+  end
+end

data/lib/lotus/routing/force_ssl.rb

@@ -81,7 +81,7 @@ module Lotus
       # @api private
       IDEMPOTENT_METHODS = ['GET', 'HEAD'].freeze
 
-      EMPTY_BODY = ''.freeze
+      EMPTY_BODY = [].freeze
 
       # Initialize ForceSsl.
       #

data/lib/lotus/routing/http_router.rb

@@ -4,6 +4,7 @@ require 'lotus/routing/endpoint_resolver'
 require 'lotus/routing/route'
 require 'lotus/routing/parsers'
 require 'lotus/routing/force_ssl'
+require 'lotus/routing/error'
 require 'lotus/utils/path_prefix'
 
 Lotus::Utils::IO.silence_warnings do
@@ -17,7 +18,7 @@ module Lotus
     # given arguments.
     #
     # @since 0.1.0
-    class InvalidRouteException < ::StandardError
+    class InvalidRouteException < Lotus::Routing::Error
     end
 
     # HTTP router
@@ -30,6 +31,16 @@ module Lotus
     # @since 0.1.0
     # @api private
     class HttpRouter < ::HttpRouter
+      # Script name - rack enviroment variable
+      #
+      # @since 0.5.0
+      # @api private
+      SCRIPT_NAME = 'SCRIPT_NAME'.freeze
+
+      # @since 0.5.0
+      # @api private
+      attr_reader :namespace
+
       # Initialize the router.
       #
       # @see Lotus::Router#initialize
@@ -39,9 +50,10 @@ module Lotus
       def initialize(options = {}, &blk)
         super(options, &nil)
 
-        @default_scheme   = options[:scheme]   if options[:scheme]
-        @default_host     = options[:host]     if options[:host]
-        @default_port     = options[:port]     if options[:port]
+        @namespace        = options[:namespace] if options[:namespace]
+        @default_scheme   = options[:scheme]    if options[:scheme]
+        @default_host     = options[:host]      if options[:host]
+        @default_port     = options[:port]      if options[:port]
         @route_class      = options[:route]    || Routing::Route
         @resolver         = options[:resolver] || Routing::EndpointResolver.new(options)
         @parsers          = Routing::Parsers.new(options[:parsers])
@@ -145,16 +157,24 @@ module Lotus
         end
       end
 
-      private
-      def add_with_request_method(path, method, opts = {}, &app)
-        super.generate(@resolver, opts, &app)
+      # @api private
+      # @since 0.5.0
+      def rewrite_path_info(env, request)
+        super
+        env[SCRIPT_NAME] = @prefix + env[SCRIPT_NAME]
       end
 
+      private
+
       def _rescue_url_recognition
         yield
       rescue ::HttpRouter::InvalidRouteException,
              ::HttpRouter::TooManyParametersException => e
-        raise Routing::InvalidRouteException.new(e.message)
+        raise Routing::InvalidRouteException.new("#{ e.message } - please check given arguments")
+      end
+
+      def add_with_request_method(path, method, opts = {}, &app)
+        super.generate(@resolver, opts, &app)
       end
 
       def _custom_path(uri_string)

data/lib/lotus/routing/parsing/json_parser.rb

@@ -5,11 +5,22 @@ module Lotus
     module Parsing
       class JsonParser < Parser
         def mime_types
-          ['application/json']
+          ['application/json', 'application/vnd.api+json']
         end
 
+        # Parse a json string
+        #
+        # @param body [String] a json string
+        #
+        # @return [Hash] the parsed json
+        #
+        # @raise [Lotus::Routing::Parsing::BodyParsingError] when the body can't be parsed.
+        #
+        # @since 0.2.0
         def parse(body)
           JSON.parse(body)
+        rescue JSON::ParserError => e
+          raise BodyParsingError.new(e.message)
         end
       end
     end

data/lib/lotus/routing/parsing/parser.rb

@@ -1,16 +1,27 @@
 require 'lotus/utils/class'
 require 'lotus/utils/string'
+require 'lotus/routing/error'
 
 module Lotus
   module Routing
     module Parsing
-      class UnknownParserError < ::StandardError
+      # Body parsing error
+      # This is raised when parser fails to parse the body
+      #
+      # @since 0.5.0
+      class BodyParsingError < Lotus::Routing::Error
+      end
+
+      # @since 0.2.0
+      class UnknownParserError < Lotus::Routing::Error
         def initialize(parser)
           super("Unknown Parser: `#{ parser }'")
         end
       end
 
+      # @since 0.2.0
       class Parser
+        # @since 0.2.0
         def self.for(parser)
           case parser
           when String, Symbol
@@ -20,15 +31,19 @@ module Lotus
           end
         end
 
+        # @since 0.2.0
         def mime_types
           raise NotImplementedError
         end
 
+        # @since 0.2.0
         def parse(body)
           Hash.new
         end
 
         private
+        # @since 0.2.0
+        # @api private
         def self.require_parser(parser)
           require "lotus/routing/parsing/#{ parser }_parser"
 

data/lib/lotus/routing/recognized_route.rb

@@ -0,0 +1,153 @@
+require 'lotus/utils/string'
+
+module Lotus
+  module Routing
+    # Represents a result of router path recognition.
+    #
+    # @since 0.5.0
+    #
+    # @see Lotus::Router#recognize
+    class RecognizedRoute
+      # @since 0.5.0
+      # @api private
+      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
+      # @since 0.5.0
+      # @api private
+      NAMESPACE             = '%s::'.freeze
+
+      # @since 0.5.0
+      # @api private
+      NAMESPACE_REPLACEMENT = ''.freeze
+
+      # @since 0.5.0
+      # @api private
+      ACTION_PATH_SEPARATOR = '/'.freeze
+
+      # @since 0.5.0
+      # @api public
+      attr_reader :params
+
+      # Creates a new instance
+      #
+      # @param response [HttpRouter::Response] raw response of recognition
+      # @param env [Hash] Rack env
+      # @param router [Lotus::Routing::HttpRouter] low level router
+      #
+      # @return [Lotus::Routing::RecognizedRoute]
+      #
+      # @since 0.5.0
+      # @api private
+      def initialize(response, env, router)
+        @env = env
+
+        unless response.nil?
+          @endpoint = response.route.dest
+          @params   = response.params
+        end
+
+        @namespace        = router.namespace
+        @action_separator = router.action_separator
+      end
+
+      # Rack protocol compatibility
+      #
+      # @param env [Hash] Rack env
+      #
+      # @return [Array] serialized Rack response
+      #
+      # @raise [Lotus::Router::NotRoutableEndpointError] if not routable
+      #
+      # @since 0.5.0
+      # @api public
+      #
+      # @see Lotus::Routing::RecognizedRoute#routable?
+      # @see Lotus::Router::NotRoutableEndpointError
+      def call(env)
+        if routable?
+          @endpoint.call(env)
+        else
+          raise Lotus::Router::NotRoutableEndpointError.new(@env)
+        end
+      end
+
+      # HTTP verb (aka method)
+      #
+      # @return [String]
+      #
+      # @since 0.5.0
+      # @api public
+      def verb
+        @env[REQUEST_METHOD]
+      end
+
+      # Action name
+      #
+      # @return [String]
+      #
+      # @since 0.5.0
+      # @api public
+      #
+      # @see Lotus::Router#recognize
+      #
+      # @example
+      #   require 'lotus/router'
+      #
+      #   router = Lotus::Router.new do
+      #     get '/books/:id', to: 'books#show'
+      #   end
+      #
+      #   puts router.recognize('/books/23').action # => "books#show"
+      def action
+        namespace = NAMESPACE % @namespace
+
+        if destination.match(namespace)
+          Lotus::Utils::String.new(
+            destination.sub(namespace, NAMESPACE_REPLACEMENT)
+          ).underscore.rsub(ACTION_PATH_SEPARATOR, @action_separator)
+        else
+          destination
+        end
+      end
+
+      # Check if routable
+      #
+      # @return [TrueClass,FalseClass]
+      #
+      # @since 0.5.0
+      # @api public
+      #
+      # @see Lotus::Router#recognize
+      #
+      # @example
+      #   require 'lotus/router'
+      #
+      #   router = Lotus::Router.new do
+      #     get '/', to: 'home#index'
+      #   end
+      #
+      #   puts router.recognize('/').routable?    # => true
+      #   puts router.recognize('/foo').routable? # => false
+      def routable?
+        !!@endpoint
+      end
+
+      private
+
+      # @since 0.5.0
+      # @api private
+      #
+      # @see Lotus::Routing::Endpoint
+      def destination
+        @destination ||= begin
+          case k = @endpoint.__getobj__
+          when Class
+            k
+          else
+            k.class
+          end.name
+        end
+      end
+    end
+  end
+end

data/lib/lotus/routing/routes_inspector.rb

@@ -18,6 +18,29 @@ module Lotus
       # @api private
       HTTP_METHODS_SEPARATOR = ', '.freeze
 
+      # Default inspector header hash values
+      #
+      # @since 0.5.0
+      # @api private
+      INSPECTOR_HEADER_HASH =  Hash[
+        name:     'Name',
+        methods:  'Method',
+        path:     'Path',
+        endpoint: 'Action'
+      ].freeze
+
+      # Default inspector header name values
+      #
+      # @since 0.5.0
+      # @api private
+      INSPECTOR_HEADER_NAME = 'Name'.freeze
+
+      # Empty line string
+      #
+      # @since 0.5.0
+      # @api private
+      EMPTY_LINE = "\n".freeze
+
       # Instantiate a new inspector
       #
       # @return [Lotus::Routing::RoutesInspector] the new instance
@@ -50,8 +73,10 @@ module Lotus
       #   end
       #
       #   puts router.inspector.to_s
-      #     # =>        GET, HEAD  /                        Home::Index
-      #          login  GET, HEAD  /login                   Sessions::New
+      #     # =>   Name Method     Path                     Action
+      #
+      #                 GET, HEAD  /                        Home::Index
+      #           login GET, HEAD  /login                   Sessions::New
       #                 POST       /login                   Sessions::Create
       #          logout GET, HEAD  /logout                  Sessions::Destroy
       #
@@ -68,7 +93,9 @@ module Lotus
       #   formatter = "| %{methods} | %{name} | %{path} | %{endpoint} |\n"
       #
       #   puts router.inspector.to_s(formatter)
-      #     # => | GET, HEAD |        | /       | Home::Index       |
+      #     # => | Method    | Name   | Path    | Action            |
+      #
+      #          | GET, HEAD |        | /       | Home::Index       |
       #          | GET, HEAD | login  | /login  | Sessions::New     |
       #          | POST      |        | /login  | Sessions::Create  |
       #          | GET, HEAD | logout | /logout | Sessions::Destroy |
@@ -100,10 +127,12 @@ module Lotus
       #   formatter = "| %{methods} | %{name} | %{path} | %{endpoint} |\n"
       #
       #   puts router.inspector.to_s(formatter)
-      #     # => | GET, HEAD |  | /fakeroute                 | Fake::Index     |
-      #          | GET, HEAD |  | /admin/home                | Home::Index     |
-      #          | GET, HEAD |  | /api/posts                 | Posts::Index    |
-      #          | GET, HEAD |  | /api/second_mount/comments | Comments::Index |
+      #     # => | Method    | Name | Path                       | Action          |
+      #
+      #          | GET, HEAD |      | /fakeroute                 | Fake::Index     |
+      #          | GET, HEAD |      | /admin/home                | Home::Index     |
+      #          | GET, HEAD |      | /api/posts                 | Posts::Index    |
+      #          | GET, HEAD |      | /api/second_mount/comments | Comments::Index |
       def to_s(formatter = FORMATTER, base_path = nil)
         base_path = Utils::PathPrefix.new(base_path)
         result    = ''
@@ -119,6 +148,10 @@ module Lotus
           end
         end
 
+        unless result.include?(INSPECTOR_HEADER_NAME)
+          result.insert(0, formatter % INSPECTOR_HEADER_HASH + EMPTY_LINE)
+        end
+
         result
       end
 

data/lotus-router.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'http_router', '~> 0.11'
-  spec.add_dependency 'lotus-utils', '~> 0.5', '>= 0.5.1'
+  spec.add_dependency 'lotus-utils', '~> 0.6'
 
   spec.add_development_dependency 'bundler',  '~> 1.5'
   spec.add_development_dependency 'minitest', '~> 5'
   spec.add_development_dependency 'rake',     '~> 10'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-router
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_router
@@ -32,20 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +82,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: Rack compatible HTTP router for Ruby
 email:
 - me@lucaguidi.com
@@ -105,12 +113,14 @@ files:
 - lib/lotus/router/version.rb
 - lib/lotus/routing/endpoint.rb
 - lib/lotus/routing/endpoint_resolver.rb
+- lib/lotus/routing/error.rb
 - lib/lotus/routing/force_ssl.rb
 - lib/lotus/routing/http_router.rb
 - lib/lotus/routing/namespace.rb
 - lib/lotus/routing/parsers.rb
 - lib/lotus/routing/parsing/json_parser.rb
 - lib/lotus/routing/parsing/parser.rb
+- lib/lotus/routing/recognized_route.rb
 - lib/lotus/routing/resource.rb
 - lib/lotus/routing/resource/action.rb
 - lib/lotus/routing/resource/nested.rb
@@ -140,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Lotus