Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Rapid7 Nexpose API client library written in Ruby
Ruby

Update README.markdown

Fixed community link and updated API versions, wiki and issues links
latest commit a1e752b9c8
@gschneider-r7 gschneider-r7 authored
Failed to load latest commit information.
examples Moving to scripts/ directory.
lib Bump version for next release
scripts Fixed call to delete_device (method name changed)
spec Use Site#included_addresses over Site#included_scan_targets[:addresses]
test Refactors Site for usability.
.gitignore Ignoring IDE file artifacts.
.hound.yml Add .rubocop.yml and .hound.yml
.pullreview.yml Enable PullReview comments on pull requests
.rubocop.yml Update .rubocop.yml
.travis.yml Remove Ruby 1.9.3 support, require Ruby 2.1.5
CONTRIBUTING.md Putting the file it the proper place.
COPYING Be explicit about the license on this gem
Gemfile Use bundler for gem tasks
README.markdown Update README.markdown
Rakefile Use bundler for gem tasks
nexpose.gemspec

README.markdown

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.

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.

Something went wrong with that request. Please try again.