edan/router.lua

A barebones router for Lua. It matches urls and executes lua functions.

router.lua

A very basic router for lua.

Features:

• Allows binding a method and a path to a function
• Parses parameters like /app/services/:service_id
• It's platform-agnostic. It has been tested with openresty.

Usage

Creating a router:

local router = require 'router'

local r = router.new()

Defining routes and actions:

r:get('/hello', function(params)
  print('someone said hello')
end)

-- alternative way:
r:match('get', '/hello', function(params)
  print('someone said hello')
end)

-- route parameters
r:get('/hello/:name', function(params)
  print('hello, ' .. params.name)
end)

-- extra parameters (i.e. from a query or form)
r:post('/app/:id/comments', function(params)
  print('comment ' .. params.comment .. ' created on app ' .. params.id)
end)

-- equivalent to all of the above:
r:match({
  get = {
    ['/hello']       = function(params) print('someone said hello') end,
    ['/hello/:name'] = function(params) print('hello, ' .. params.name) end
  },
  post = {
    ['/app/:id/comments'] = function(params)
      print('comment ' .. params.comment .. ' created on app ' .. params.id)
    end
  }
})

Executing routes:

r:execute('get',  '/hello')
-- someone said hello

r:execute('get',  '/hello/peter')
-- hello peter

r:execute('post', '/app/4/comments', { comment = 'fascinating'})
-- comment fascinating created on app 4

r:execute returns either nil followed by an error message if no routes where found, or true and whatever the matched action returned.

License

MIT license

Specs

This library uses busted for its specs. In order to run the specs, install busted and then do

cd path/to/the/folder/where/the/spec/folder/is
busted