nexpose 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a5335ef79b8475f47962eef38d900a725884a17
-  data.tar.gz: 8900b1a1479b53be0f51856592f1630b6522a3b1
+  metadata.gz: e40ad91293e896ed8c7f1e9604857dc9d6bf6dd0
+  data.tar.gz: e362c3ca4411485a1230605a5a06685059911ed8
 SHA512:
-  metadata.gz: c6e77bc50a09f1daacef6ac5709e813736dc53816f3d52fe35568e7102f2cc8a59d764e21f3a7343517d6a54a2d3b6313c83b03d0a218ba60287bbcd05388e0f
-  data.tar.gz: 670ca7fe9660f3f98d6a7b7e562ef47a6112d53dcee5f7b0d1b8973c586ca3e2020dea25506d704f7914a9e1d7f2c6e75af85627586e0ad4236a907b523733fd
+  metadata.gz: f0ea6ca4789118697c035a466306dfaff611417227ba5f1c545d296c9c8916d5c97347b206eb320a59e63ce371aba1d21966020e98ec771b7df2cf7ab23d3571
+  data.tar.gz: 80b82688cce211cf4268aaafe085635d6f20195e9e4f9afb28a5bcfb5066059c41bf8681d525529064ff786a6e9203f44cb69d312ca8e052eddbd5b912184457

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    nexpose (0.9.6)
+      rex (= 2.0.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.7)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    multi_json (1.10.1)
+    parser (2.2.0.3)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.0)
+    rainbow (2.0.0)
+    rex (2.0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubocop (0.29.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.1)
+    safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  codeclimate-test-reporter (~> 0.4.6)
+  nexpose!
+  rspec (~> 3.2)
+  rubocop (~> 0.29.0)
+  simplecov (~> 0.9.1)
+  vcr (~> 2.9.3)
+  webmock (~> 1.20.4)

data/README.markdown

@@ -1,4 +1,5 @@
 # Nexpose-Client
+[![Gem Version](https://badge.fury.io/rb/nexpose.svg)](http://badge.fury.io/rb/nexpose) [![Build Status](https://travis-ci.org/rapid7/nexpose-client.svg?branch=master)](https://travis-ci.org/rapid7/nexpose-client) [![Test Coverage](https://codeclimate.com/github/rapid7/nexpose-client/badges/coverage.svg)](https://codeclimate.com/github/rapid7/nexpose-client) [![Inline docs](http://inch-ci.org/github/rapid7/nexpose-client.svg?branch=master)](http://inch-ci.org/github/rapid7/nexpose-client) [![Code Climate](https://codeclimate.com/github/rapid7/nexpose-client/badges/gpa.svg)](https://codeclimate.com/github/rapid7/nexpose-client)
 
 This is the official gem package for the Ruby Nexpose API.
 

data/lib/nexpose.rb

@@ -103,7 +103,6 @@ require 'nexpose/version'
 
 module Nexpose
 
-  # ==== Description
   # Echos the last XML API request and response for the specified object.  (Useful for debugging)
   def self.print_xml(object)
     puts 'request: ' + object.request_xml.to_s

data/lib/nexpose/device.rb

@@ -64,7 +64,7 @@ module Nexpose
 
     # Get a list of all assets currently associated with a group.
     #
-    # @param [Fixnum] dev_id Unique identifier of a device (asset).
+    # @param [Fixnum] group_id Unique identifier of an asset group.
     # @return [Array[FilteredAsset]] List of group assets.
     #
     def group_assets(group_id)

data/lib/nexpose/manage.rb

@@ -66,7 +66,7 @@ module Nexpose
     # API call. Then upload the archive using HTTPS to a URL that is specified
     # as an API parameter.
     #
-    # @param url Upload server to send the support log package to.
+    # @param uri Upload server to send the support log package to.
     #
     def send_log(uri = 'https://support.rapid7.com')
       url = REXML::Element.new('URL')

data/lib/nexpose/pool.rb

@@ -93,7 +93,7 @@ module Nexpose
     #
     # @param [Connection] connection Connection to console where site exists.
     # @param [String] name The name of the engine pool.
-    # @param [String] silo The silo of the engine pool.
+    # @param [String] scope The silo of the engine pool.
     # @return [EnginePool] Engine pool configuration object.
     #
     def self.load(connection, name, scope = 'silo')

data/lib/nexpose/scan.rb

@@ -401,7 +401,7 @@ module Nexpose
 
     # Parse a response from a Nexpose console into a valid ScanSummary object.
     #
-    # @param [REXML::Document] rexml XML document to parse.
+    # @param [REXML::Document] xml XML document to parse.
     # @return [ScanSummary] Scan summary represented by the XML.
     #
     def self.parse(xml)

data/lib/nexpose/scan_template.rb

@@ -200,7 +200,7 @@ module Nexpose
     end
 
     # Add custom UDP ports to scan for services
-    # @param [Array] posts to scan
+    # @param [Array] ports to scan
     def udp_service_ports=(ports)
       service_ports = REXML::XPath.first(@xml, 'ScanTemplate/ServiceDiscovery/UDPPortScan')
       service_ports.attributes['mode'] = "custom"

data/lib/nexpose/site.rb

@@ -251,6 +251,46 @@ module Nexpose
       end
     end
 
+    # Adds an asset to this site's exclude list, resolving whether an IP or 
+    # hostname is provided.
+    #
+    # @param [String] asset Identifier of an asset, either IP or host name.
+    #
+    def exclude_asset(asset)
+      @exclude << HostOrIP.convert(asset)
+    end
+
+    alias_method :exclude_host, :exclude_asset
+    alias_method :exclude_ip, :exclude_asset
+
+    # Remove an asset from this site's exclude list, resolving whether an IP 
+    # or hostname is provided.
+    #
+    # @param [String] asset Identifier of an asset, either IP or host name.
+    #
+    def remove_excluded_asset(asset)
+      @exclude.reject! { |existing_asset| existing_asset == HostOrIP.convert(asset) }
+    end
+
+    alias_method :remove_excluded_host, :remove_excluded_asset
+    alias_method :remove_excluded_ip, :remove_excluded_asset
+
+    # Adds assets to this site's exclude list by IP address range.
+    #
+    # @param [String] from Beginning IP address of a range.
+    # @param [String] to Ending IP address of a range.
+    def exclude_ip_range(from, to)
+      @exclude << IPRange.new(from, to)
+    end
+
+    # Remove assets from this site's exclude list by IP address range.
+    #
+    # @param [String] from Beginning IP address of a range.
+    # @param [String] to Ending IP address of a range.
+    def remove_excluded_ip_range(from, to)
+      @exclude.reject! { |asset| asset == IPRange.new(from, to) }
+    end
+
     # Load an existing configuration from a Nexpose instance.
     #
     # @param [Connection] connection Connection to console where site exists.
@@ -375,7 +415,6 @@ module Nexpose
     # Retrieve the currrent filter criteria used by a dynamic site.
     #
     # @param [Connection] nsc Connection to a console.
-    # @param [Fixnum] site_id ID of an existing site.
     # @return [Criteria] Current criteria for the site.
     #
     def load_dynamic_attributes(nsc)
@@ -614,9 +653,36 @@ module Nexpose
     # End of range *Optional (If nil then IPRange is a single IP Address)
     attr_accessor :to
 
+    # @overload initialize(ip)
+    #   @param [#to_s] from the IP single IP address.
+    #   @example
+    #     Nexpose::IPRange.new('192.168.1.0')
+    #
+    # @overload initialize(start_ip, end_ip)
+    #   @param [#to_s] from the IP to start the range with.
+    #   @param [#to_s] to the IP to end the range with.
+    #   @example
+    #     Nexpose::IPRange.new('192.168.1.0', '192.168.1.255')
+    #
+    # @overload initialize(cidr_range)
+    #   @param [#to_s] from the CIDR notation IP address range.
+    #   @example
+    #     Nexpose::IPRange.new('192.168.1.0/24')
+    #   @note The range will not be stripped of reserved IP addresses (such as
+    #     x.x.x.0 and x.x.x.255).
+    #
+    # @return [IPRange] an IP address range of one or more addresses.
     def initialize(from, to = nil)
       @from = from
       @to = to unless from == to
+
+      return unless @to.nil?
+
+      range = IPAddr.new(@from.to_s).to_range
+      unless range.one?
+        @from = range.first.to_s
+        @to = range.last.to_s
+      end
     end
 
     # Size of the IP range. The total number of IP addresses represented

data/lib/nexpose/tag.rb

@@ -239,7 +239,7 @@ module Nexpose
     # Retrieve detailed description of a single tag
     #
     # @param [Connection] connection Nexpose connection
-    # @param [Fixnum] ID of tag to retrieve
+    # @param [Fixnum] tag_id ID of tag to retrieve
     # @return [Tag] requested tag
     #
     def self.load(connection, tag_id)

data/lib/nexpose/version.rb

@@ -1,4 +1,4 @@
 module Nexpose
   # The latest version of the Nexpose gem
-  VERSION = '0.9.5'
+  VERSION = '0.9.6'
 end

data/nexpose.gemspec

@@ -18,7 +18,13 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9'
   s.platform              = 'ruby'
 
-  s.add_runtime_dependency('rex', '~> 2.0.5', '>= 2.0.5')
+  s.add_runtime_dependency('rex', '2.0.7')
 
   s.add_development_dependency('bundler', '~> 1.3')
+  s.add_development_dependency('codeclimate-test-reporter', '~> 0.4.6')
+  s.add_development_dependency('simplecov', '~> 0.9.1')
+  s.add_development_dependency('rspec', '~> 3.2')
+  s.add_development_dependency('rubocop', '~> 0.29.0')
+  s.add_development_dependency('webmock', '~> 1.20.4')
+  s.add_development_dependency('vcr', '~> 2.9.3')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - HD Moore
@@ -13,28 +13,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rex
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.5
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 2.0.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -49,6 +43,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
 description: This gem provides a Ruby API to the Nexpose vulnerability management
   product by Rapid7.
 email:
@@ -66,6 +144,7 @@ files:
 - CONTRIBUTING.md
 - COPYING
 - Gemfile
+- Gemfile.lock
 - README.markdown
 - Rakefile
 - lib/README.md
@@ -139,4 +218,3 @@ signing_key:
 specification_version: 4
 summary: Ruby API for Rapid7 Nexpose
 test_files: []
-has_rdoc: