Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fnando/info
Make your Rails app info available through a JSON endpoint.
https://github.com/fnando/info
Last synced: 27 days ago
JSON representation
Make your Rails app info available through a JSON endpoint.
- Host: GitHub
- URL: https://github.com/fnando/info
- Owner: fnando
- License: mit
- Created: 2014-09-13T17:06:55.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-30T11:16:14.000Z (over 8 years ago)
- Last Synced: 2024-10-06T04:27:29.202Z (about 1 month ago)
- Language: Ruby
- Homepage:
- Size: 75.2 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Info
[](https://travis-ci.org/fnando/info)
[](https://codeclimate.com/github/fnando/info)
Info a library that allows you collecting info about your application in a simple JSON endpoint.
## Installation
Just the following line to your Gemfile:
```ruby
gem "info"
```
Now, create a initializer at `config/initializers/info.rb` with the following content:
```ruby
Info.setup do
enable!
end
```
Read more about authorization and how to add collectors below.
## Usage
To add your own collectors, just use the method `Info::Configuration#add`.
```ruby
Info.setup do
add "Rails", Rails.version
end
```
You can also use `Info.add "Rails", Rails.version`.
Info comes with some default information; just load the `info/rails` file. You can do it on a initializer file (`config/initializers/info.rb`) or your Gemfile.
```ruby
gem "info", require: "info/rails"
```
All Rubygems that your app is using can be collected by loading the file `info/rubygems`.
You may need to clear all collectors; in this case just use `Info.collectors.clear`.
To view your collected info, just visit `/application/info`. This endpoint is public, so you can set authorization with two strategies: token and basic auth.
### Authorization
To authorize the endpoint access with basic authentication, just provide a block that requires two arguments.
```ruby
Info.setup do
authorize {|email, password| AdminUser.find_by_email(email).authenticate(password) }
end
```
To authorize the endpoint access with token authentication, just provide a block that requires one argument.
```ruby
Info.setup do
authorize {|token| AdminUser.find_by_token(token).present? }
end
```
You can also use `Info.authorize(&block)`.
## Maintainer
* Nando Vieira ()
## License:
(The MIT License)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.