dblessing/rundeck-ruby

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Rundeck Ruby Gem

[Official Website](http://dblessing.github.io/rundeck-ruby) with examples,
documentation, and links to the RDoc technical documentation.

**Note: Although the git repository is called 'rundeck-ruby', the gem is called
'rundeck' on Rubygems.org. There is another gem called 'rundeck-ruby' on Rubygems.org and
it is not affiliated with this project.**

[![Gem Version](https://badge.fury.io/rb/rundeck.svg)](http://badge.fury.io/rb/rundeck)
[![Build Status](https://travis-ci.org/dblessing/rundeck-ruby.svg?branch=master)](https://travis-ci.org/dblessing/rundeck-ruby)
[![Dependency Status](https://gemnasium.com/dblessing/rundeck-ruby.svg)](https://gemnasium.com/dblessing/rundeck-ruby)
[![Code Climate](https://codeclimate.com/github/dblessing/rundeck-ruby/badges/gpa.svg)](https://codeclimate.com/github/dblessing/rundeck-ruby)
[![Test Coverage](https://codeclimate.com/github/dblessing/rundeck-ruby/badges/coverage.svg)](https://codeclimate.com/github/dblessing/rundeck-ruby)

A Ruby wrapper around the Rundeck API.  

This library will strive to achieve reliable coverage of the Rundeck API.
Please submit an issue if you find a bug and feel
free to submit a pull request to contribute fixes or new features.

Initial versions of this gem to not achieve 100% coverage of the Rundeck API.
Each release will include more and more endpoint support until there is 100%
coverage.

The layout and the code in this library is inspired by
https://github.com/NARKOZ/gitlab. NARKOZ does a fantastic job of keeping code
simple and achieving API feature parity.

See http://dblessing.github.io/rundeck-ruby for documentation

## 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

## License

Released under the BSD 2-clause license. See LICENSE.txt for details.