Navigable::Router

Navigable is a family of gems that together provide all the tools you need to build fast, testable, and reliable JSON and/or GraphQL based APIs with isolated, composable business logic. The gems include:

	Navigable A stand-alone tool for isolating business logic from external interfaces and cross-cutting concerns. Navigable composes self-configured command and observer objects to allow you to extend your business logic without modifying it. Navigable is compatible with any Ruby-based application development framework, including Rails, Hanami, and Sinatra.
	Navigable Router *(coming soon)* A simple, highly-performant, Rack-based router.
	Navigable Server *(coming soon)* A Rack-based server for building Ruby and Navigable web applications.
	Navigable API *(coming soon)* An extension of Navigable Server for building restful JSON APIs.
	Navigable GraphQL *(coming soon)* An extension of Navigable Server for building GraphQL APIs.

Installation

Add this line to your application's Gemfile:

gem 'navigable-router'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install navigable-router

Usage

To use Navigable::Router simply instantiate a router and add your routes:

router = Navigable::Router.new
router.get('/ahoy', to: -> (env) { [200, { 'Content-Type' => 'text/html' }, [ 'Ahoy!' ]] })

The destination of the route needs to respond to #call, like the lambda above, or these classes:

router.get('/swabbies', to: ShowSwabbies)
router.get('/swabbies/:id', to: ShowSwabbie)
router.post('/swabbies', to: CreateSwabbie)
router.put('/swabbies/:id', to: UpdateSwabbie)
router.delete('/swabbies/:id', to: DeleteSwabbie)

To run the app, add this to your config.ru:

run router

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/first-try-softare/navigable-router. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Navigable::Router project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.