Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anthonator/rosebud
Rails API parameter validation
https://github.com/anthonator/rosebud
Last synced: 17 days ago
JSON representation
Rails API parameter validation
- Host: GitHub
- URL: https://github.com/anthonator/rosebud
- Owner: anthonator
- License: mit
- Created: 2013-11-22T03:09:43.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-01-18T15:46:04.000Z (almost 6 years ago)
- Last Synced: 2024-04-25T16:02:33.889Z (7 months ago)
- Language: Ruby
- Homepage:
- Size: 39.1 KB
- Stars: 6
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rosebud
Rails API parameter validation
[](https://travis-ci.org/anthonator/rosebud) [](https://coveralls.io/r/anthonator/rosebud?branch=master) [](https://codeclimate.com/github/anthonator/rosebud)
## Installation
Add this line to your application's Gemfile:
gem 'rosebud'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rosebud
## Usage
### Getting Started
Just include ```Rosebud``` in your Rails controller.
```ruby
class Api::V1::SomeController < Api::V1::ApplicationController
include Rosebud
end
```
### Validating Parameters
To validate parameters specify a ```params``` block and choose whether the params are required or optional.
```ruby
class Api::V1::SomeController < Api::V1::ApplicationController
include Rosebud
params do
requires :name
optional :phone_number, regex: /\d{10}/, default: '5555555555'
end
...
end
```
It's also possible to define validations for a specific action.
```ruby
class Api::V1::SomeController < Api::V1::ApplicationController
include Rosebud
params :create do
...
end
def create
...
end
end
```
### Rendering Errors
When a parameter error is raised a JSON response will be rendered.
```ruby
{
"error": "missing_parameter",
"description": "missing parameter: name"
}
```
### Custom Validators
Currently the only validators that ship with Rosebud are ```presence```, ```regex``` and ```type```. If you need other validators you can create your own.
```ruby
class MyLengthValidator < Rosebud::Validator
def validate_param(name, value, options)
if value.length <= options
error!(:length, param: name, length: value.length, max_length: options)
end
end
end
Rosebud::Validations.register_validator!(:length, MyLengthValidator)
```
Rosebud uses the [Errawr::Rails](http://www.github.com/anthonator/errawr-rails) gem to raise and render localised errors. Add your custom error message to your locale file.
```yaml
en:
errawr:
length:
message: %{length} characters is too long for %{param}, should be less than or equal to %{max_length}
http_status: 400
metadata:
additional_info: Kick him in the shins!
```
Add a validation using your custom validator:
```ruby
class Api::V1::SomeController < Api::V1::ApplicationController
include Rosebud
params :create do
requires :name, length: 2
end
def create
...
end
end
```
The following error will be rendered for the ```name``` parameter when provided with a value of ```abc```:
```json
{
"error": "length",
"description": "3 characters is too long for name, should be less than or equal to 2",
"additional_info": "Kick him in the shins!"
}
```
## Contributing
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
## Credits
[](http://www.sticksnleaves.com)
Rosebud is maintained and funded by [Sticksnleaves](http://www.sticksnleaves.com)
Thanks to all of our [contributors](https://github.com/anthonator/rosebud/graphs/contributors)