red5d/nexpose-client

Rapid7 Nexpose API client library written in Ruby

Nexpose-Client

This is the official gem package for the Ruby Nexpose API client library.

For assistance with using the gem, to share your scripts, or to discuss different approaches, please visit the Rapid7 community: https://community.rapid7.com/

Check out the wiki for walk-throughs and other documentation. Submit bugs and feature requests on the issues page.

This gem is heavily used for internal, automated testing of the Nexpose product. It provides calls to the Nexpose XML APIs version 1.1 and 1.2, and JSON API 2.1. It also includes a number of helper methods which are not currently exposed through alternate means.

Since version 1.0 nexpose-client uses Semantic Versioning. This allows for confident use of the pessimistic operator in scripts or larger ruby projects.

Release Notes

Release notes are available on the Releases page.

Contributions

We welcome contributions to this package. Please see CONTRIBUTING for details.

Our coding standards include:

• Favor returning classes over key-value maps. Classes tend to be easier for users to manipulate and use.
• Unless otherwise noted, code should adhere to the Ruby Style Guide: https://github.com/bbatsov/ruby-style-guide
• Use YARDoc comment style to improve the API documentation of the gem.

License

The nexpose-client gem is provided under the 3-Clause BSD License. See COPYING for details.

Credits

Rapid7, Inc.