Sha256: fa756ffd8443180588819205dcedd1e54ecdc047728491684ae9f6fea7609f68
Contents?: true
Size: 1.95 KB
Versions: 3
Compression:
Stored size: 1.95 KB
Contents
## Passages ![Build Status](https://travis-ci.org/yez/passages.svg?branch=master) ## Purpose This Rails Engine adds the ability to search over different attributes of Ruby on Rails routes within an application. For example, an internal (or very permissive external) API can now expose a single page that will answer simple questions like: *"What was the HTTP verb for the `/users/clear_password` route?"* or *"Does a v2 or v3 version for this route exist?"*. ## Demo ![Demo](demo.gif) ## Install In your `Gemfile` ```ruby source 'https://rubygems.org' gem 'passages' ``` `bundle install` By default, the `Passages` Engine must be mounted in your `routes.rb` file. Example: *routes.rb* ```ruby Rails.application.routes.draw do mount Passages::Engine, at: '/passages' end ``` *Alternatively*, an initializer can be created that will allow the `Passages` Engine to mount itself. Create a new file: `initializers/passages.rb` and add the following: ```ruby Passages.configure do |config| config.automount = true end ``` With the Engine mounted at `/passages`, the rendered page will display a search box and list of all known routes within the application. ## Authorization Since there are no environment dependent checks, the `/passages` page uses configurable http basic authentication. To set a `username` and `password` in the `Passages` Engine, add an `ENV` variable for each value. `ENV['passages_username']` should be the desired `username` and `ENV['passages_password']` should be the desired `password` By default these values are: username: **username** password: **password** `ENV` variables can prefix a Ruby server command from the command line interface, set with a helper `.ENV` file for systems like `foreman` or set through a web interface on platforms like `heroku`. ## Contributing Please feel free to fork and contribute your own changes to the Passages project. Single commits are preferred with a description of why the contribution is useful.
Version data entries
3 entries across 3 versions & 1 rubygems
Version | Path |
---|---|
passages-1.3.0 | README.md |
passages-1.2.0 | README.md |
passages-1.1.0 | README.md |