/rambo

RAML in, RSpec out

Primary LanguageRubyMIT LicenseMIT

Rambo

Build Status Code Climate Dependency Status Coverage Status

Rambo is a gem that generates API contract tests from API docs in RAML.

Usage

You can install Rambo using: 

gem install rambo
You can also add it to your project's Gemfile: 
group :development, :test do
gem 'rambo', '~> 0.0.1'
end
To run Rambo, from the root directory of your project, run: 
rambo foobar.raml
Rambo will create spec/contract directory, a spec/spec_helper.rb file if they don't exist, and will create a spec/contract/foobar_spec.rb file. The latter will overwrite any existing spec file by the same name. This is intentional behavior and will not change in future versions.

Rambo is being developed to test APIs complying with standard REST practices. Mileage may vary with other architectures, but I'm happy to consider pull requests.

Contributing

Rambo is a new project and any contributions are much appreciated. All pull requests should include comprehensive test coverage and, where appropriate, documentation. If you're not sure where to get started, contact me through Github and I'll be glad to chat.

Additional information for contributors is available in the wiki. Beginning or first-time contributors are welcome and encouraged!

More Information