lotus-router 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37d48dce216b9c22c8472e65075ef3e591cdd347
-  data.tar.gz: 49906b3a4e85f0fc632eef8a6b00f27c4165d9d8
+  metadata.gz: ff45eb9a0d8db10815f562e9d5af4e5cf2649b7a
+  data.tar.gz: 3a6e353ac3840fc2bab5a0324ec50294493efa20
 SHA512:
-  metadata.gz: 5541516f19802d8e34b1daeebec19ceb4f75672a59f8de12dec86a8c0855195fc6d68ee0a3d46346e47f983190aee527bb706c762751e9f9c1220b5e5b38c617
-  data.tar.gz: e449094e8eb2583434924e269f484942011cc641dc0c017afa03aefe7ddaba382bfbe6c2418d7b3be70e4daf07ab49e2849428a7ba373f0095b6f2bffbf98d08
+  metadata.gz: 5aba74771a3578cb3654a687b428e9fdca6bbdc2cc186dc1777ff28b9862a4a9f50d7daa9de80fbfc191bcf67ca3ab35eabfdcdbffedfb9d0043aa62601d8b72
+  data.tar.gz: e0d18ad2c7e1cdb275a58871a321cd635b383c1c6308635cfeab29bfe5859e62eeeab0c728414ba118601787855a3b3e01fc602120ddf0c45304af63b20d84e4

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: RWmBgbtOIElBQus1VYqcrDotPcgtz1Seu

data/.gitignore

@@ -1,17 +1,9 @@
 *.gem
-*.rbc
+.devnotes
+.greenbar
 .bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
+.yardoc
 doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+coverage/
+tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+script: 'bundle exec rake'
+rvm:
+  - 2.0.0
+  - 2.1.0

data/.yardopts

@@ -0,0 +1,3 @@
+-
+LICENSE.txt
+lib/**/*.rb

data/Gemfile

@@ -1,4 +1,11 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in lotus-router.gemspec
+source 'http://rubygems.org'
 gemspec
+
+unless ENV['TRAVIS']
+  gem 'debugger',    require: false, platforms: :ruby
+  gem 'yard',        require: false
+  gem 'simplecov',   require: false
+  gem 'lotus-utils', require: false, path: '../lotus-utils'
+end
+
+gem 'coveralls', require: false

data/README.md

@@ -1,29 +1,493 @@
 # Lotus::Router
 
-TODO: Write a gem description
+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)
+
+## Contact
+
+* Home page: 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
+
+## Rubies
+
+__Lotus::Router__ supports Ruby (MRI) 2+
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'lotus-router'
+```ruby
+gem 'lotus-router'
+```
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install lotus-router
+```shell
+$ gem install lotus-router
+```
+
+## Getting Started
+
+```ruby
+require 'lotus/router'
+
+app = Lotus::Router.new do
+  get '/', to: ->(env) { [200, {}, ['Welcome to Lotus::Router!']] }
+end
+
+Rack::Server.start app: app, Port: 2306
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+__Lotus::Router__ is designed to work as a standalone framework or within a
+context of a [Lotus](http://lotusrb.org) application.
+
+For the standalone usage, it supports neat features:
+
+### A Beautiful DSL:
+
+```ruby
+Lotus::Router.new do
+  get '/', to: ->(env) { [200, {}, ['Hi!']] }
+  get '/dashboard',   to: DashboardController::Index
+  get '/rack-app',    to: RackApp.new
+  get '/flowers',     to: 'flowers#index'
+  get '/flowers/:id', to: 'flowers#show'
+
+  redirect '/legacy', to: '/'
+
+  namespace 'admin' do
+    get '/users', to: UsersController::Index
+  end
+
+  resource 'identity' do
+    member do
+      get '/avatar'
+    end
+
+    collection do
+      get '/api_keys'
+    end
+  end
+
+  resources 'robots' do
+    member do
+      patch '/activate'
+    end
+
+    collection do
+      get '/search'
+    end
+  end
+end
+```
+
+
+
+### Fixed string matching:
+
+```ruby
+router = Lotus::Router.new
+router.get '/lotus', to: ->(env) { [200, {}, ['Hello from Lotus!']] }
+```
+
+
+
+### String matching with variables:
+
+```ruby
+router = Lotus::Router.new
+router.get '/flowers/:id', to: ->(env) { [200, {}, ["Hello from Flower no. #{ env['router.params'][:id] }!"]] }
+```
+
+
+
+### Variables Constraints:
+
+```ruby
+router = Lotus::Router.new
+router.get '/flowers/:id', id: /\d+/, to: ->(env) { [200, {}, [":id must be a number!"]] }
+```
+
+
+
+### String matching with globbling:
+
+```ruby
+router = Lotus::Router.new
+router.get '/*', to: ->(env) { [200, {}, ["This is catch all: #{ env['router.params'].inspect }!"]] }
+```
+
+
+
+### String matching with optional tokens:
+
+```ruby
+router = Lotus::Router.new
+router.get '/lotus(.:format)' to: ->(env) { [200, {}, ["You've requested #{ env['router.params'][:format] }!"]] }
+```
+
+
+
+### Support for the most common HTTP methods:
+
+```ruby
+router   = Lotus::Router.new
+endpoint = ->(env) { [200, {}, ['Hello from Lotus!']] }
+
+router.get    '/lotus', to: endpoint
+router.post   '/lotus', to: endpoint
+router.put    '/lotus', to: endpoint
+router.patch  '/lotus', to: endpoint
+router.delete '/lotus', to: endpoint
+router.trace  '/lotus', to: endpoint
+```
+
+
+
+### Redirect:
+
+```ruby
+router = Lotus::Router.new
+router.get '/redirect_destination', to: ->(env) { [200, {}, ['Redirect destination!']] }
+router.redirect '/legacy', to: '/redirect_destination'
+```
+
+
+
+### Named routes:
+
+```ruby
+router = Lotus::Router.new(scheme: 'https', host: 'lotusrb.org')
+router.get '/lotus', to: ->(env) { [200, {}, ['Hello from Lotus!']] }, as: :lotus
+
+router.path(:lotus) # => "/lotus"
+router.url(:lotus)  # => "https://lotusrb.org/lotus"
+```
+
+
+
+### Namespaced routes:
+
+```ruby
+router = Lotus::Router.new
+router.namespace 'animals' do
+  namespace 'mammals' do
+    get '/cats', to: ->(env) { [200, {}, ['Meow!']] }, as: :cats
+  end
+end
+
+# or
+
+router.get '/cats', prefix: '/animals/mammals', to:->(env) { [200, {}, ['Meow!']] }, as: :cats
+
+# and it generates:
+
+router.path(:animals_mammals_cats) # => "/animals/mammals/cats"
+```
+
+
+
+### Duck typed endpoints:
+
+Everything that responds to `#call` is invoked as it is:
+
+```ruby
+router = Lotus::Router.new
+router.get '/lotus',      to: ->(env) { [200, {}, ['Hello from Lotus!']] }
+router.get '/middleware', to: Middleware
+router.get '/rack-app',   to: RackApp.new
+router.get '/method',     to: ActionControllerSubclass.action(:new)
+```
+
+
+If it's a string, it tries to instantiate a class from it:
+
+```ruby
+class RackApp
+  def call(env)
+    # ...
+  end
+end
+
+router = Lotus::Router.new
+router.get '/lotus', to: 'rack_app' # it will map to RackApp.new
+```
+
+It also supports Controller + Action syntax:
+
+```ruby
+class FlowersController
+  class Index
+    def call(env)
+      # ...
+    end
+  end
+end
+
+router = Lotus::Router.new
+router.get '/flowers', to: 'flowers#index' # it will map to FlowersController::Index.new
+```
+
+
+
+### Implicit Not Found (404):
+
+```ruby
+router = Lotus::Router.new
+router.call(Rack::MockRequest.env_for('/unknown')).status # => 404
+```
+
+
+
+### RESTful Resource:
+
+```ruby
+router = Lotus::Router.new
+router.resource 'identity'
+```
+
+It will map:
+
+<table>
+  <tr>
+    <th>Verb</th>
+    <th>Path</th>
+    <th>Action</th>
+    <th>Name</th>
+    <th>Named Route</th>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/identity</td>
+    <td>IdentityController::Show</td>
+    <td>:show</td>
+    <td>:identity</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/identity/new</td>
+    <td>IdentityController::New</td>
+    <td>:new</td>
+    <td>:new_identity</td>
+  </tr>
+  <tr>
+    <td>POST</td>
+    <td>/identity</td>
+    <td>IdentityController::Create</td>
+    <td>:create</td>
+    <td>:identity</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/identity/edit</td>
+    <td>IdentityController::Edit</td>
+    <td>:edit</td>
+    <td>:edit_identity</td>
+  </tr>
+  <tr>
+    <td>PATCH</td>
+    <td>/identity</td>
+    <td>IdentityController::Update</td>
+    <td>:update</td>
+    <td>:identity</td>
+  </tr>
+  <tr>
+    <td>DELETE</td>
+    <td>/identity</td>
+    <td>IdentityController::Destroy</td>
+    <td>:destroy</td>
+    <td>:identity</td>
+  </tr>
+</table>
+
+If you don't need all the default endpoints, just do:
+
+```ruby
+router = Lotus::Router.new
+router.resource 'identity', only: [:edit, :update]
+
+# which is equivalent to:
+
+router.resource 'identity', except: [:show, :new, :create, :destroy]
+```
+
+
+If you need extra endpoints:
+
+```ruby
+router = Lotus::Router.new
+router.resource 'identity' do
+  member do
+   get '/avatar'            # maps to IdentityController::Avatar
+  end
+
+  collection do
+    get '/authorizations'   # maps to IdentityController::Authorizations
+  end
+end
+
+router.path(:avatar_identity)         # => /identity/avatar
+router.path(:authorizations_identity) # => /identity/authorizations
+```
+
+
+
+### RESTful Resources:
+
+```ruby
+router = Lotus::Router.new
+router.resources 'flowers'
+```
+
+It will map:
+
+<table>
+  <tr>
+    <th>Verb</th>
+    <th>Path</th>
+    <th>Action</th>
+    <th>Name</th>
+    <th>Named Route</th>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/flowers</td>
+    <td>FlowersController::Index</td>
+    <td>:index</td>
+    <td>:flowers</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/flowers/:id</td>
+    <td>FlowersController::Show</td>
+    <td>:show</td>
+    <td>:flowers</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/flowers/new</td>
+    <td>FlowersController::New</td>
+    <td>:new</td>
+    <td>:new_flowers</td>
+  </tr>
+  <tr>
+    <td>POST</td>
+    <td>/flowers</td>
+    <td>FlowersController::Create</td>
+    <td>:create</td>
+    <td>:flowers</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/flowers/:id/edit</td>
+    <td>FlowersController::Edit</td>
+    <td>:edit</td>
+    <td>:edit_flowers</td>
+  </tr>
+  <tr>
+    <td>PATCH</td>
+    <td>/flowers/:id</td>
+    <td>FlowersController::Update</td>
+    <td>:update</td>
+    <td>:flowers</td>
+  </tr>
+  <tr>
+    <td>DELETE</td>
+    <td>/flowers/:id</td>
+    <td>FlowersController::Destroy</td>
+    <td>:destroy</td>
+    <td>:flowers</td>
+  </tr>
+</table>
+
+
+```ruby
+router.path(:flowers)              # => /flowers
+router.path(:flowers, id: 23)      # => /flowers/23
+router.path(:edit_flowers, id: 23) # => /flowers/23/edit
+```
+
+
+
+If you don't need all the default endpoints, just do:
+
+```ruby
+router = Lotus::Router.new
+router.resources 'flowers', only: [:new, :create, :show]
+
+# which is equivalent to:
+
+router.resources 'flowers', except: [:index, :edit, :update, :destroy]
+```
+
+
+If you need extra endpoints:
+
+```ruby
+router = Lotus::Router.new
+router.resources 'flowers' do
+  member do
+    get '/toggle' # maps to FlowersController::Toggle
+  end
+  collection do
+    get '/search' # maps to FlowersController::Search
+  end
+end
+
+router.path(:toggle_flowers, id: 23)  # => /flowers/23/toggle
+router.path(:search_flowers)          # => /flowers/search
+```
+
+## Testing
+
+```ruby
+require 'lotus/router'
+require 'rack/request'
+
+router = Lotus::Router.new do
+  get '/', to: ->(env) { [200, {}, ['Hi!']] }
+end
+
+app = Rack::MockRequest.new(router)
+app.get('/') # => #<Rack::MockResponse:0x007fc4540dc238 ...>
+```
+
+## Versioning
+
+__Lotus::Router__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/lotus-router/fork )
+1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Acknowledgements
+
+Thanks to Joshua Hull ([@joshbuddy](https://github.com/joshbuddy)) for his
+[http_router](http://rubygems.org/gems/http_router).
+
+## Copyright
+
+Copyright 2014 Luca Guidi – Released under MIT License