lotus-router 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff45eb9a0d8db10815f562e9d5af4e5cf2649b7a
-  data.tar.gz: 3a6e353ac3840fc2bab5a0324ec50294493efa20
+  metadata.gz: 7ded3effb55d8697f3a45666539825d205771161
+  data.tar.gz: ac9b49d12b41b64e694998e4c663895f81279921
 SHA512:
-  metadata.gz: 5aba74771a3578cb3654a687b428e9fdca6bbdc2cc186dc1777ff28b9862a4a9f50d7daa9de80fbfc191bcf67ca3ab35eabfdcdbffedfb9d0043aa62601d8b72
-  data.tar.gz: e0d18ad2c7e1cdb275a58871a321cd635b383c1c6308635cfeab29bfe5859e62eeeab0c728414ba118601787855a3b3e01fc602120ddf0c45304af63b20d84e4
+  metadata.gz: 1542eba77ef0f590dd88f9abe472760f09e14375796867dd031bd360bf2e19b4056c8b89c03b32bb45542a23616f6c502df2382a8dc19441b16b5eb0dc657223
+  data.tar.gz: ea54e84f9c8507fd70d0c5c3e7f946930444d612dfc89012215d56a7ab55518658599dd0707dbb4da2358f1904d2717b27165f1ce9f77c9f40fdfc1626adb44e

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+## v0.1.1
+### Jun 23, 2014
+
+6f0ea8b 2014-06-12 **Luca Guidi** Introduced Lotus::Router#mount
+8457e1c 2014-06-08 **Luca Guidi** Use composition over inheritance for Lotus::Routing::Resource::Options
+9426099 2014-05-13 **Luca Guidi** Let specify a pattern for Lotus::Routing::EndpointResolver
+340ce17 2014-05-10 **Luca Guidi** Enable Ruby 2.1.2 on Travis CI
+42b83b8 2014-02-24 **Luca Guidi** Added support for Ruby 2.1.1
+6a5daf9 2014-02-15 **Luca Guidi** Make Lotus::Routing::Endpoint::EndpointNotFound to inherit from StandardError, instead of Exception. This make it compatible with Rack::ShowExceptions.
+
+## v0.1.0
+### Jan 23, 2014
+
+594e332 2014-01-23 **Luca Guidi** Added support for OPTIONS HTTP verb
+10af04b 2014-01-17 **Luca Guidi** Added Lotus::Routing::EndpointNotFound when a lazy endpoint can't be found
+72165e5 2014-01-17 **Luca Guidi** Make action separator customizable via Lotus::Router options.
+ca7ea8d 2014-01-17 **Luca Guidi** Catch http_router exceptions and re-raise them with names under Lotus::Routing. This helps to have a stable public API.
+3d678e3 2014-01-16 **Luca Guidi** Lotus::Router now encapsulates Lotus::Routing::HttpRouter, instead of directly inherit from HttpRouter. This will protect our public API against HttpRouter changes.
+8e8f7f9 2014-01-16 **Luca Guidi** Lotus::Routing::Resource::CollectionAction use configurable controller and action name separator over the hardcoded value
+0bc8e54 2014-01-10 **Luca Guidi** Implemented Lotus::Routing::Namespace#resource
+e134e5c 2014-01-08 **Luca Guidi** Simplify Lotus::Router public API: removed .draw and let .new to accept a block
+815391a 2014-01-07 **Luca Guidi** When resetting the router, allow the default values for scheme, host and port to be reinitialized as http_router does
+bc763a8 2013-08-07 **Luca Guidi** Lotus::Routing::EndpointResolver now accepts options to inject namespace and suffix
+153047f 2013-08-07 **Luca Guidi** Allow resolver and route class to be injected via options. Added options argument to .draw
+cd1128f 2013-08-07 **Luca Guidi** Lotus::EndpointResolver => Lotus::Routing::EndpointResolver
+96a67c1 2013-07-09 **Luca Guidi** Return 404 for not found and 405 for unacceptable HTTP method
+7450883 2013-07-05 **Luca Guidi** Allow non-finished Rack responses to be used
+aa92524 2013-06-24 **Luca Guidi** Ensure .draw to always return a Lotus::Router instance
+30029af 2013-06-22 **Luca Guidi** Implemented lazy loading for endpoints
+962fbdf 2013-06-21 **Luca Guidi** Implemented Lotus::Router.draw
+982d95a 2013-06-20 **Luca Guidi** Gemified
+bac478a 2013-06-20 **Luca Guidi** Massive cleanup
+aaf46a1 2013-06-20 **Luca Guidi** Add support for resource
+41ee67d 2013-06-20 **Luca Guidi** Drastically reduced LOCs :heart_eyes:
+6b245bf 2013-06-19 **Luca Guidi** Support for resource's member and collection
+727e997 2013-06-19 **Luca Guidi** Add support for namespaces
+4950777 2013-06-18 **Luca Guidi** Added support for RESTful resources
+c494c85 2013-06-18 **Luca Guidi** Add support for POST, DELETE, PUT, PATCH, TRACE
+71fb4a1 2013-06-17 **Luca Guidi** Routes constraints
+86d696a 2013-06-17 **Luca Guidi** Named urls
+423cf2c 2013-06-17 **Luca Guidi** Ensure redirect works properly
+1ee662a 2013-06-17 **Luca Guidi** Run all the test suite
+e2382a0 2013-06-16 **Luca Guidi** Add support for Procs:
+f397aac 2013-06-16 **Luca Guidi** Implemented redirect
+dded0c5 2013-06-14 **Luca Guidi** Initial mess

data/README.md

@@ -4,11 +4,12 @@ Rack compatible, lightweight and fast HTTP Router for [Lotus](http://lotusrb.org
 
 ## Status
 
-[![Gem Version](https://badge.fury.io/rb/lotus-router.png)](http://badge.fury.io/rb/lotus-router)
-[![Build Status](https://secure.travis-ci.org/lotus/router.png?branch=master)](http://travis-ci.org/lotus/router?branch=master)
-[![Coverage](https://coveralls.io/repos/lotus/router/badge.png?branch=master)](https://coveralls.io/r/lotus/router)
-[![Code Climate](https://codeclimate.com/github/lotus/router.png)](https://codeclimate.com/github/lotus/router)
-[![Dependencies](https://gemnasium.com/lotus/router.png)](https://gemnasium.com/lotus/router)
+[![Gem Version](http://img.shields.io/gem/v/lotus-router.svg)](https://badge.fury.io/rb/lotus-router)
+[![Build Status](http://img.shields.io/travis/lotus/router/master.svg)](https://travis-ci.org/lotus/router?branch=master)
+[![Coverage](http://img.shields.io/coveralls/lotus/router/master.svg)](https://coveralls.io/r/lotus/router)
+[![Code Climate](http://img.shields.io/codeclimate/github/lotus/router.svg)](https://codeclimate.com/github/lotus/router)
+[![Dependencies](http://img.shields.io/gemnasium/lotus/router.svg)](https://gemnasium.com/lotus/router)
+[![Inline docs](http://inch-ci.org/github/lotus/router.png)](http://inch-ci.org/github/lotus/router)
 
 ## Contact
 
@@ -16,7 +17,8 @@ Rack compatible, lightweight and fast HTTP Router for [Lotus](http://lotusrb.org
 * Mailing List: http://lotusrb.org/mailing-list
 * API Doc: http://rdoc.info/gems/lotus-router
 * Bugs/Issues: https://github.com/lotus/router/issues
-* Support: http://stackoverflow.com/questions/tagged/lotusrb
+* Support: http://stackoverflow.com/questions/tagged/lotus-ruby
+* Chat: https://gitter.im/lotus/chat
 
 ## Rubies
 
@@ -74,6 +76,8 @@ Lotus::Router.new do
 
   redirect '/legacy', to: '/'
 
+  mount Api::App, to: '/api'
+
   namespace 'admin' do
     get '/users', to: UsersController::Index
   end
@@ -129,7 +133,7 @@ router.get '/flowers/:id', id: /\d+/, to: ->(env) { [200, {}, [":id must be a nu
 
 
 
-### String matching with globbling:
+### String matching with globbing:
 
 ```ruby
 router = Lotus::Router.new
@@ -206,6 +210,26 @@ router.path(:animals_mammals_cats) # => "/animals/mammals/cats"
 
 
 
+### Mount Rack applications:
+
+```ruby
+Lotus::Router.new do
+  mount RackOne,                             at: '/rack1'
+  mount RackTwo,                             at: '/rack2'
+  mount RackThree.new,                       at: '/rack3'
+  mount ->(env) {[200, {}, ['Rack Four']]},  at: '/rack4'
+  mount 'dashboard#index',                   at: '/dashboard'
+end
+```
+
+1. `RackOne` is used as it is (class), because it respond to `.call`
+2. `RackTwo` is initialized, because it respond to `#call`
+3. `RackThree` is used as it is (object), because it respond to `#call`
+4. That Proc is used as it is, because it respond to `#call`
+5. That string is resolved as `DashboardController::Index` ([Lotus::Controller](https://github.com/lotus/controller) integration)
+
+
+
 ### Duck typed endpoints:
 
 Everything that responds to `#call` is invoked as it is:
@@ -325,7 +349,7 @@ If you don't need all the default endpoints, just do:
 router = Lotus::Router.new
 router.resource 'identity', only: [:edit, :update]
 
-# which is equivalent to:
+#### which is equivalent to:
 
 router.resource 'identity', except: [:show, :new, :create, :destroy]
 ```
@@ -434,7 +458,7 @@ If you don't need all the default endpoints, just do:
 router = Lotus::Router.new
 router.resources 'flowers', only: [:new, :create, :show]
 
-# which is equivalent to:
+#### which is equivalent to:
 
 router.resources 'flowers', except: [:index, :edit, :update, :destroy]
 ```

data/lib/lotus/router.rb

@@ -75,6 +75,15 @@ module Lotus
   #
   #   # This isn't mandatory for the default route class (`Lotus::Routing::Route`),
   #   # This behavior can be changed by passing a custom route to `Lotus::Router#initialize`
+  #
+  # @example Mount an application
+  #   require 'lotus/router'
+  #
+  #   router = Lotus::Router.new do
+  #     mount Api::App, at: '/api'
+  #   end
+  #
+  #   # All the requests starting with "/api" will be forwarded to Api::App
   class Router
     # Initialize the router.
     #
@@ -688,6 +697,95 @@ module Lotus
       Routing::Resources.new(self, name, options.merge(separator: @router.action_separator), &blk)
     end
 
+    # Mount a Rack application at the specified path.
+    # All the requests starting with the specified path, will be forwarded to
+    # the given application.
+    #
+    # All the other methods (eg #get) support callable objects, but they
+    # restrict the range of the acceptable HTTP verb. Mounting an application
+    # with #mount doesn't apply this kind of restriction at the router level,
+    # but let the application to decide.
+    #
+    # @param app [#call] a class or an object that responds to #call
+    # @param options [Hash] the options to customize the mount
+    # @option options [:at] the path prefix where to mount the app
+    #
+    # @since 0.1.1
+    #
+    # @example Basic usage
+    #   require 'lotus/router'
+    #
+    #   Lotus::Router.new do
+    #     mount Api::App.new, at: '/api'
+    #   end
+    #
+    #   # Requests:
+    #   #
+    #   # GET  /api          # => 200
+    #   # GET  /api/articles # => 200
+    #   # POST /api/articles # => 200
+    #   # GET  /api/unknown  # => 404
+    #
+    # @example Difference between #get and #mount
+    #   require 'lotus/router'
+    #
+    #   Lotus::Router.new do
+    #     get '/rack1',      to: RackOne.new
+    #     mount RackTwo.new, at: '/rack2'
+    #   end
+    #
+    #   # Requests:
+    #   #
+    #   # # /rack1 will only accept GET
+    #   # GET  /rack1        # => 200 (RackOne.new)
+    #   # POST /rack1        # => 405
+    #   #
+    #   # # /rack2 accepts all the verbs and delegate the decision to RackTwo
+    #   # GET  /rack2        # => 200 (RackTwo.new)
+    #   # POST /rack2        # => 200 (RackTwo.new)
+    #
+    # @example Types of mountable applications
+    #   require 'lotus/router'
+    #
+    #   class RackOne
+    #     def self.call(env)
+    #     end
+    #   end
+    #
+    #   class RackTwo
+    #     def call(env)
+    #     end
+    #   end
+    #
+    #   class RackThree
+    #     def call(env)
+    #     end
+    #   end
+    #
+    #   class DashboardController
+    #     class Index
+    #       def call(env)
+    #       end
+    #     end
+    #   end
+    #
+    #   Lotus::Router.new do
+    #     mount RackOne,                             at: '/rack1'
+    #     mount RackTwo,                             at: '/rack2'
+    #     mount RackThree.new,                       at: '/rack3'
+    #     mount ->(env) {[200, {}, ['Rack Four']]},  at: '/rack4'
+    #     mount 'dashboard#index',                   at: '/dashboard'
+    #   end
+    #
+    #   # 1. RackOne is used as it is (class), because it respond to .call
+    #   # 2. RackTwo is initialized, because it respond to #call
+    #   # 3. RackThree is used as it is (object), because it respond to #call
+    #   # 4. That Proc is used as it is, because it respond to #call
+    #   # 5. That string is resolved as DashboardController::Index (Lotus::Controller)
+    def mount(app, options)
+      @router.mount(app, options)
+    end
+
     # Resolve the given Rack env to a registered endpoint and invoke it.
     #
     # @param env [Hash] a Rack env instance

data/lib/lotus/router/version.rb

@@ -1,5 +1,5 @@
 module Lotus
   class Router
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/lotus/routing/endpoint.rb

@@ -7,7 +7,7 @@ module Lotus
     # This is raised when the router fails to load an endpoint at the runtime.
     #
     # @since 0.1.0
-    class EndpointNotFound < ::Exception
+    class EndpointNotFound < ::StandardError
     end
 
     # Routing endpoint

data/lib/lotus/routing/endpoint_resolver.rb

@@ -26,7 +26,7 @@ module Lotus
       #   end
       #
       #   # That string is transformed into "Articles(::Controller::|Controller::)Show"
-      #   # because the risolver is able to lookup (in the given order) for:
+      #   # because the resolver is able to lookup (in the given order) for:
       #   #
       #   #  * Articles::Controller::Show
       #   #  * ArticlesController::Show
@@ -65,6 +65,11 @@ module Lotus
       # @option options [String] :suffix the suffix appended to the controller
       #   name during the lookup. (defaults to `SUFFIX`)
       #
+      # @option options [String] :pattern the string to interpolate in order
+      #   to return an action name. Please note that this option override
+      #   :suffix. This string SHOULD contain `'%{controller}'` and `'%{action}'`,
+      #   all the other keys will be ignored. See the examples below.
+      #
       # @option options [String] :action_separator the sepatator between controller and
       #   action name. (defaults to `ACTION_SEPARATOR`)
       #
@@ -114,6 +119,18 @@ module Lotus
       #
       #
       #
+      # @example Specify custom simple pattern
+      #   require 'lotus/router'
+      #
+      #   resolver = Lotus::Routing::EndpointResolver.new(pattern: 'Controllers::%{controller}::%{action}')
+      #   router   = Lotus::Router.new(resolver: resolver)
+      #
+      #   router.get('/', to: 'articles#show')
+      #   # => Will look for:
+      #   #  * Controllers::Articles::Show
+      #
+      #
+      #
       # @example Specify custom controller-action separator
       #   require 'lotus/router'
       #
@@ -127,8 +144,9 @@ module Lotus
       def initialize(options = {})
         @endpoint_class   = options[:endpoint]         || Endpoint
         @namespace        = options[:namespace]        || Object
-        @suffix           = options[:suffix]           || SUFFIX
         @action_separator = options[:action_separator] || ACTION_SEPARATOR
+        @pattern          = options[:pattern]          ||
+          "%{controller}#{options[:suffix] || SUFFIX}%{action}"
       end
 
       # Resolve the given set of HTTP verb, path, endpoint and options.
@@ -229,6 +247,8 @@ module Lotus
       def resolve_callable(callable)
         if callable.respond_to?(:call)
           @endpoint_class.new(callable)
+        elsif callable.is_a?(Class) && callable.instance_methods.include?(:call)
+          @endpoint_class.new(callable.new)
         end
       end
 
@@ -243,7 +263,7 @@ module Lotus
       def resolve_action(string)
         if string.match(action_separator)
           controller, action = string.split(action_separator).map {|token| classify(token) }
-          controller + @suffix + action
+          @pattern % {controller: controller, action: action}
         end
       end
     end

data/lib/lotus/routing/http_router.rb

@@ -93,6 +93,18 @@ module Lotus
         add_with_request_method(path, :options, options, &blk)
       end
 
+      # Allow to mount a Rack app
+      #
+      # @see Lotus::Router#mount
+      #
+      # @since 0.1.1
+      # @api private
+      def mount(app, options)
+        add("#{ options.fetch(:at) }*").to(
+          @resolver.resolve(to: app)
+        )
+      end
+
       # @api private
       def reset!
         uncompile

data/lib/lotus/routing/resource/options.rb

@@ -8,7 +8,7 @@ module Lotus
       #
       # @see Lotus::Router#resource
       # @see Lotus::Router#resources
-      class Options < Hash
+      class Options
         # @api private
         # @since 0.1.0
         attr_reader :actions
@@ -40,7 +40,32 @@ module Lotus
           except   = Array(options.delete(:except))
           @actions = ( actions & only ) - except
 
-          merge! options
+          @options = options
+        end
+
+        # Return the option for the given key
+        #
+        # @param key [Symbol] the key that should be searched
+        #
+        # @return [Object,nil] returns the object associated to the given key
+        #   or nil, if missing.
+        #
+        # @api private
+        # @since 0.1.1
+        def [](key)
+          @options[key]
+        end
+
+        # Merge the current options with the given hash, without mutating self.
+        #
+        # @param hash [Hash] the hash to be merged
+        #
+        # @return [Hash] the result of the merging operation
+        #
+        # @api private
+        # @since 0.1.1
+        def merge(hash)
+          @options.merge(hash)
         end
       end
     end

data/lotus-router.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'http://lotusrb.org'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md lotus-router.gemspec`.split($/)
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus-router
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_router
@@ -87,21 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- Gemfile
-- LICENSE.txt
+- CHANGELOG.md
+- LICENSE.md
 - README.md
-- Rakefile
-- benchmarks/callable
-- benchmarks/named_routes
-- benchmarks/resource
-- benchmarks/resources
-- benchmarks/routes
-- benchmarks/run.sh
-- benchmarks/utils.rb
 - lib/lotus-router.rb
 - lib/lotus/router.rb
 - lib/lotus/router/version.rb
@@ -116,20 +104,6 @@ files:
 - lib/lotus/routing/resources/action.rb
 - lib/lotus/routing/route.rb
 - lotus-router.gemspec
-- test/fixtures.rb
-- test/integration/client_error_test.rb
-- test/integration/pass_on_response_test.rb
-- test/named_routes_test.rb
-- test/namespace_test.rb
-- test/new_test.rb
-- test/redirect_test.rb
-- test/resource_test.rb
-- test/resources_test.rb
-- test/routing/endpoint_resolver_test.rb
-- test/routing/resource/options_test.rb
-- test/routing_test.rb
-- test/test_helper.rb
-- test/version_test.rb
 homepage: http://lotusrb.org
 licenses:
 - MIT
@@ -150,23 +124,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby HTTP Router for Lotus
-test_files:
-- test/fixtures.rb
-- test/integration/client_error_test.rb
-- test/integration/pass_on_response_test.rb
-- test/named_routes_test.rb
-- test/namespace_test.rb
-- test/new_test.rb
-- test/redirect_test.rb
-- test/resource_test.rb
-- test/resources_test.rb
-- test/routing/endpoint_resolver_test.rb
-- test/routing/resource/options_test.rb
-- test/routing_test.rb
-- test/test_helper.rb
-- test/version_test.rb
+test_files: []
 has_rdoc: