Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willnet/committee-rails
rails and committee are good friends
https://github.com/willnet/committee-rails
json-schema rails
Last synced: 3 days ago
JSON representation
rails and committee are good friends
- Host: GitHub
- URL: https://github.com/willnet/committee-rails
- Owner: willnet
- License: mit
- Created: 2016-09-07T11:33:16.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-27T08:53:59.000Z (9 months ago)
- Last Synced: 2024-08-23T21:17:54.541Z (3 months ago)
- Topics: json-schema, rails
- Language: Ruby
- Homepage:
- Size: 95.7 KB
- Stars: 114
- Watchers: 2
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Committee::Rails
[](https://github.com/willnet/committee-rails/actions/workflows/test.yml)
[](https://badge.fury.io/rb/committee-rails)
You can use `assert_request_schema_confirm`, `assert_response_schema_confirm` or `assert_schema_conform` in rails.
## Looking for maintainers!
If interested, please contact @willnet
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'committee-rails'
```
And then execute:
$ bundle
If you use committee prior to 5.1.0, you have to use committee-rails 0.7.x. Please see below.
[0.7 (0-7-stable) documentation](https://github.com/willnet/committee-rails/tree/0-7-stable)
If you use committee prior to 5.0.0, you have to use committee-rails 0.6.x. Please see below.
[0.6 (0-6-stable) documentation](https://github.com/willnet/committee-rails/tree/0-6-stable)
If you use committee prior to 4.4.0, you have to use committee-rails 0.5.x. Please see below.
[0.5 (0-5-stable) documentation](https://github.com/willnet/committee-rails/tree/0-5-stable)
If you use committee prior to 3.0, you have to use committee-rails 0.4.x. Please see below.
[0.4 (0-4-stable) documentation](https://github.com/willnet/committee-rails/tree/0-4-stable)
If you use committee prior to 2.4, you have to use committee-rails 0.3.x. Please see below.
[0.3 (0-3-stable) documentation](https://github.com/willnet/committee-rails/tree/0-3-stable)
If you use committee prior to 2.0, you have to use committee-rails 0.1.x. Please see below.
[0.1 (0-1-stable) documentation](https://github.com/willnet/committee-rails/tree/0-1-stable)
## Usage
### normal usage
```ruby
describe 'request spec' do
include Committee::Rails::Test::Methods
def committee_options
@committee_options ||= { schema_path: Rails.root.join('schema', 'schema.json').to_s }
end
describe 'GET /' do
it 'conforms to schema with 200 response code' do
get '/'
assert_schema_conform(200)
end
it 'conforms to request schema' do
get '/'
assert_request_schema_confirm
end
it 'conforms to response schema with 200 response code' do
get '/'
assert_response_schema_confirm(200)
end
end
end
```
### rspec setting
If you use rspec, you can use very simple.
```ruby
RSpec.configure do |config|
config.add_setting :committee_options
config.committee_options = { schema_path: Rails.root.join('schema', 'schema.json').to_s }
end
```
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/willnet/committee-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).