Skip to content

Red5d/nexpose-client

This branch is 1 commit ahead of, 242 commits behind rapid7/nexpose-client:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c929221 · May 31, 2016
Feb 25, 2013
May 20, 2016
Nov 7, 2013
Apr 8, 2016
Oct 16, 2012
Mar 20, 2015
Feb 12, 2015
Mar 25, 2015
Mar 17, 2015
Aug 7, 2015
Jan 5, 2015
Mar 12, 2014
Nov 3, 2014
Jul 16, 2015
Nov 3, 2014
Dec 5, 2015

Repository files navigation

Nexpose-Client

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, 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.

About

Rapid7 Nexpose API client library written in Ruby

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%