Nessus6 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fd4cdfa535bfd5f763074b2364aec98c58c128b
-  data.tar.gz: ea9e76b76ec8b8944933bd4258cd6460b3daac07
+  metadata.gz: 80b280c90c8525f396797ee7a8ede1eaafee968e
+  data.tar.gz: bb9bba8b28e74ffde223f0e88f2a15c7b285bd7a
 SHA512:
-  metadata.gz: aa72aa5257c78b7751279ff72cf953e46c3a8b05b71d419988059245e772ecd5c75b3e8937c1a811c3d329ab41a067037dc8391578f4a9e63ab22cac264d01d4
-  data.tar.gz: 3c7d133ebdc754dcff55b64e57a31129abc4a28cc2286176e0f393253c343ced1e294c831bc23373a5df781d571e923e103deb7670ca031802a938902dd196b1
+  metadata.gz: adca72a28588ee39fc1ccaee35eb9d78783637eaf136f702b984b62f88c7b3b61ff61e686a1153a2aeb907750723896bfa9bf494ca12e11bf7a7c8ee7f7c001a
+  data.tar.gz: 8ec5723e60ea92f8220dd9357b0359edd4d5074dccca9c394bce984c7870e8221a839cd3ae4848410e9a413d3928149dd7f164190ce5530ffc72c89858576880

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Kevin Kirsche
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Nessus6.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "yard", "~> 0.8"
   spec.add_runtime_dependency "hurley", "~> 0.1"
 end

data/lib/Nessus6/folders/methods.rb

@@ -12,16 +12,31 @@ module Nessus6
       @client = client
     end
 
+    # Creates a new folder for the current user. This request requires
+    # read-only user permissions.
+    #
+    # @param name [String] The name of the folder.
+    # @return [Hash]
     def create(name)
       response = @client.post('folders', name: name)
       verify_create response
     end
 
+    # Deletes a folder. This request requires read-only user permissions.
+    #
+    # @param folder_id [String, Fixnum] The id of the folder to delete.
+    # @return [Hash]
     def delete(folder_id)
       response = @client.delete("folders/#{folder_id}")
       verify_delete response
     end
 
+    # Rename a folder for the current user. This request requires read-only
+    # user permissions.
+    #
+    # @param folder_id [String, Fixnum] The id of the folder to edit.
+    # @param name [String] The name of the folder.
+    # @return [Hash]
     def edit(folder_id, name)
       response = @client.put("folders/#{folder_id}", name: name)
       verify_edit response
@@ -29,6 +44,9 @@ module Nessus6
 
     alias_method :rename, :edit
 
+    # Returns the current user's scan folders.
+    #
+    # @return [Hash] { "folders": [folder Resource] }
     def list
       response = @client.get('folders')
       verify_list response

data/lib/Nessus6/groups/methods.rb

@@ -12,26 +12,53 @@ module Nessus6
       @client = client
     end
 
+    # Add a user to the group. This request requires administrator user
+    # permissions.
+    #
+    # @param group_id [String, Fixnum] The unique id of the group.
+    # @param user_id [String, Fixnum] The unique id of the user.
+    # @return [Hash]
     def add_user(group_id, user_id)
       response = @client.post("groups/#{group_id}/users/#{user_id}")
       verify_add_user response
     end
 
+    # Create a group. This request requires administrator user
+    # permissions.
+    #
+    # @param name [String, Fixnum] The name of the group.
+    # @return [Hash]
     def create(name)
       response = @client.post('groups', name: name)
       verify_create response
     end
 
+    # Delete a group. This request requires administrator user
+    # permissions.
+    #
+    # @param group_id [String, Fixnum] The unique id of the group.
+    # @return [Hash]
     def delete(group_id)
       response = @client.delete("groups/#{group_id}")
       verify_delete response
     end
 
+    # Deletes a user from the group. This request requires administrator user
+    # permissions.
+    #
+    # @param group_id [String, Fixnum] The unique id of the group.
+    # @param user_id [String, Fixnum] The unique id of the user.
+    # @return [Hash]
     def delete_user(group_id, user_id)
       response = @client.delete("groups/#{group_id}/users/#{user_id}")
       verify_delete_user response
     end
 
+    # Edit a group. This request requires administrator user permissions.
+    #
+    # @param group_id [String, Fixnum] The unique id of the group.
+    # @param name [String] The name of the group.
+    # @return [Hash]
     def edit(group_id, name)
       response = @client.put("groups/#{group_id}", name: name)
       verify_edit response
@@ -39,11 +66,19 @@ module Nessus6
 
     alias_method :rename, :edit
 
+    # Returns the group list. This request requires read-only user permissions.
+    #
+    # @return [Hash]
     def list
       response = @client.get('groups')
       verify_list response
     end
 
+    # Return the group user list. This request requires administrator user
+    # permissions.
+    #
+    # @param group_id [String, Fixnum] The unique id of the group.
+    # @return [Hash]
     def list_users(group_id)
       response = @client.get("groups/#{group_id}/users")
       verify_list_users response

data/lib/Nessus6/permissions/methods.rb

@@ -10,12 +10,24 @@ module Nessus6
       @client = client
     end
 
+    # Changes the permissions for an object.
+    #
+    # @param object_type [String] The type of object.
+    # @param object_id [String, Fixnum] The unique id of the object.
+    # @param permissions [String] An array of permission resources to apply
+    #   to the object.
+    # @return [Hash]
     def change(object_type, object_id, permissions)
       response = @client.put("permissions/#{object_type}/#{object_id}",
                              body: permissions)
       verify_change response
     end
 
+    # Returns the current object's permissions.
+    #
+    # @param object_type [String] The type of object.
+    # @param object_id [String, Fixnum] The unique id of the object.
+    # @return [Hash]
     def list(object_type, object_id)
       response = @client.get("permissions/#{object_type}/#{object_id}")
       verify_list response

data/lib/Nessus6/scans/methods.rb

@@ -12,6 +12,13 @@ module Nessus6
       @client = client
     end
 
+    # Launches a scan.
+    #
+    # @param scan_id [String, Fixnum] The id of the scan to launch.
+    # @param alt_targets [Array] If specified, these targets will be scanned
+    #   instead of the default. Value can be an array where each index is a
+    #   target, or an array with a single index of comma separated targets.
+    # @return [Hash] The scan UUID or throws an error
     def launch(scan_id, alt_targets = nil)
       if alt_targets.is_a? Array
         response = @client.post "scans/#{scan_id}/launch",
@@ -23,16 +30,27 @@ module Nessus6
       verify_launch response
     end
 
+    # Returns the scan list.
+    #
+    # @return [Hash] Returns the scan list.
     def list
       response = @client.get 'scans'
       JSON.parse response.body
     end
 
+    # Pauses a scan.
+    #
+    # @param scan_id [String, Fixnum] The id of the scan to pause.
+    # @return [Hash] The scan UUID or throws an error
     def pause(scan_id)
       response = @client.post "scans/#{scan_id}/pause"
       verify_pause response
     end
 
+    # Stops a scan.
+    #
+    # @param scan_id [String, Fixnum] The id of the scan to stop.
+    # @return [Hash] The scan UUID or throws an error
     def stop(scan_id)
       response = @client.post "scans/#{scan_id}/stop"
       verify_stop response

data/lib/Nessus6/version.rb

@@ -1,3 +1,3 @@
 module Nessus6
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Nessus6
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kevin Kirsche
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: hurley
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +90,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - Nessus6.gemspec
 - README.md
 - Rakefile
@@ -123,3 +138,4 @@ signing_key:
 specification_version: 4
 summary: "[Under Construction] Nessus 6 API Gem"
 test_files: []
+has_rdoc: