DEPRECATED: Rapid7 Nexpose API client library written in Ruby
Ruby

README.markdown

DEPRECATED

The RESTful API for the Nexpose/InsightVM Security Console has rendered this library obsolete. If you require a Ruby library for that API you can use a generated client. Clients for other languages can be generated from the Swagger specification. Note that generated clients are not officially supported or maintained by Rapid7.

While this project is no longer under active development, it is still maintained by Rapid7 for internal testing needs. Pull requests will continue to be reviewed and accepted, and new versions published as requested.

Nexpose-Client

No Maintenance Intended Gem Version Build Status Test Coverage Inline docs Code Climate

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

For assistance with using the gem or to discuss different approaches, please open an issue. To share or discuss scripts which use the gem head over to the Nexpose Resources project.

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.

Install the gem with Rubygems: gem install nexpose

Release Notes

Release notes are available on the Releases page.

The full Changelog is available as well, on the Changelog 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.

Full usage examples or task-oriented scripts should be submitted to the Nexpose Resources project. Smaller examples can be added to the wiki.

License

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

Credits

Rapid7, Inc.