tenable-ruby 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f85505c10cdfc20f73c9c3206b6f98bb542be031
-  data.tar.gz: aa55193ae8ec7bd0093e920c964a9de427f9a7db
+  metadata.gz: 5f2e3e353e286812317bb2f0d1837d1b1ac363ff
+  data.tar.gz: 336caa8a143f5e107c180d4ebc92632c2b037988
 SHA512:
-  metadata.gz: b0cb391e04eba5f1bc14ef2d008dc56782371204373134479f5b4557f80569bcfcd10d7afe7495f23be1cc92132ae1f902e9ad197adfbb7c637ac42a43dd8a3d
-  data.tar.gz: aa21fee4bc24e24dcc3a86cb07c98b74dc7fd6576e1cd1a32adf75e5f36cf8045a47130d412e91a61e44e894587228917dcaca12eafadec66b17f349a8a012f5
+  metadata.gz: 0d266ca215327a5c9b11fb2ad0d677455813f0e415af909306d5fae9640b4f2d480380b970a01cd309ae47294530df8711cfd2477d7dcd85dd86dee7b46e3618
+  data.tar.gz: 4dbb9564288833ef473988b313130a7cd9466863a9122c47023efe2a0e94d91db3a58c090981e7b25ca4960da9fc51295ab0116a6dd13d09000bb6bb01a8e84d

data/lib/tenable-ruby.rb

@@ -109,7 +109,7 @@ module TenableRuby
     # Returns the server version and other properties
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/server/properties
+    # https://developer.tenable.com/reference#server-properties
     def get_server_properties
       http_get(:uri => "/server/properties", :fields => header)
     end
@@ -117,7 +117,7 @@ module TenableRuby
     # Creates a new user
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/users/create
+    # https://developer.tenable.com/reference#users-create
     def user_add(username, password, permissions, type)
       payload = {
         :username => username,
@@ -132,7 +132,7 @@ module TenableRuby
     # Deletes a user
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/users/delete
+    # https://developer.tenable.com/reference#users-delete
     def user_delete(user_id)
       response = http_delete(:uri => "/users/#{user_id}", :fields => header)
       response.code
@@ -141,7 +141,7 @@ module TenableRuby
     # Changes the password for the given user
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/users/password
+    # https://developer.tenable.com/reference#users-password
     def user_chpasswd(user_id, password)
       payload = {
         :password => password,
@@ -154,7 +154,7 @@ module TenableRuby
     # Logs the current user out and destroys the session
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/session/destroy
+    # https://developer.tenable.com/reference#session-destroy
     def user_logout
       response = http_delete(:uri => "/session", :fields => header)
       response.code
@@ -163,7 +163,7 @@ module TenableRuby
     # Returns the policy list
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/policies/list
+    # https://developer.tenable.com/reference#policies-list
     def list_policies
       http_get(:uri => "/policies", :fields => header)
     end
@@ -171,15 +171,15 @@ module TenableRuby
     # Returns the user list
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/users/list
+    # https://developer.tenable.com/reference#users-list
     def list_users
       http_get(:uri => "/users", :fields => header)
     end
 
     # Returns the current user's scan folders
     #
-    # Reference:
-    # https://cloud.tenable.com/api#/resources/folders/list
+    # Reference:    #
+    # https://developer.tenable.com/reference#folders-list
     def list_folders
       http_get(:uri => "/folders", :fields => header)
     end
@@ -187,7 +187,7 @@ module TenableRuby
     # Returns the scanner list
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scanners/list
+    # https://developer.tenable.com/reference#scanners-list
     def list_scanners
       http_get(:uri => "/scanners", :fields => header)
     end
@@ -195,7 +195,7 @@ module TenableRuby
     # Returns the list of plugin families
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/plugins/families
+    # https://developer.tenable.com/reference#plugins-families
     def list_families
       http_get(:uri => "/plugins/families", :fields => header)
     end
@@ -203,7 +203,7 @@ module TenableRuby
     # Returns the list of plugins in a family
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/plugins/family-details
+    # https://developer.tenable.com/reference#plugins-family-details
     def list_plugins(family_id)
       http_get(:uri => "/plugins/families/#{family_id}", :fields => header)
     end
@@ -211,7 +211,7 @@ module TenableRuby
     # Returns the template list
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/editor/list
+    # https://developer.tenable.com/reference#editor-list-templates
     def list_templates(type)
       http_get(:uri => "/editor/#{type}/templates", :fields => header)
     end
@@ -219,7 +219,7 @@ module TenableRuby
     # Returns details for the given template
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/editor/template-details
+    # https://developer.tenable.com/reference#editor-template-details
     def editor_templates (type, uuid)
       http_get(:uri => "/editor/#{type}/templates/#{uuid}", :fields => header)
     end
@@ -227,7 +227,7 @@ module TenableRuby
     # Returns details for a given plugin
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/plugins/plugin-details
+    # https://developer.tenable.com/reference#plugins-plugin-details
     def plugin_details(plugin_id)
       http_get(:uri => "/plugins/plugin/#{plugin_id}", :fields => header)
     end
@@ -235,7 +235,7 @@ module TenableRuby
     # Returns the server status
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/server/status
+    # https://developer.tenable.com/reference#server-status
     def server_status
       http_get(:uri => "/server/status", :fields => header)
     end
@@ -288,7 +288,7 @@ module TenableRuby
     # Creates a scan
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/create
+    # https://developer.tenable.com/reference#scans-create
     def scan_create(uuid, settings)
       payload = {
         :uuid => uuid,
@@ -301,7 +301,7 @@ module TenableRuby
     # Launches a scan
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/launch
+    # https://developer.tenable.com/reference#scans-launch
     def scan_launch(scan_id)
       http_post(:uri => "/scans/#{scan_id}/launch", :fields => header)
     end
@@ -309,7 +309,7 @@ module TenableRuby
     # Get List of Scans
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/list
+    # https://developer.tenable.com/reference#scans-list
     def scan_list
       http_get(:uri => "/scans", :fields => header)
     end
@@ -317,7 +317,7 @@ module TenableRuby
     # Returns details for the given scan
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/details
+    # https://developer.tenable.com/reference#scans-details
     def scan_details(scan_id)
       http_get(:uri => "/scans/#{scan_id}", :fields => header)
     end
@@ -325,7 +325,7 @@ module TenableRuby
     # Pauses a scan
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/pause
+    # https://developer.tenable.com/reference#scans-pause
     def scan_pause(scan_id)
       http_post(:uri => "/scans/#{scan_id}/pause", :fields => header)
     end
@@ -333,7 +333,7 @@ module TenableRuby
     # Resumes a scan
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/resume
+    # https://developer.tenable.com/reference#scans-resume
     def scan_resume(scan_id)
       http_post(:uri => "/scans/#{scan_id}/resume", :fields => header)
     end
@@ -341,7 +341,7 @@ module TenableRuby
     # Stops a scan
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/stop
+    # https://developer.tenable.com/reference#scans-stop
     def scan_stop(scan_id)
       http_post(:uri => "/scans/#{scan_id}/stop", :fields => header)
     end
@@ -350,7 +350,7 @@ module TenableRuby
     # upon receiving a "ready" status from the export status method.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/export-request
+    # https://developer.tenable.com/reference#scans-export-request
     def scan_export(scan_id, format)
       payload = {
         :format => format
@@ -363,7 +363,7 @@ module TenableRuby
     # using the export download endpoint.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/export-status
+    # https://developer.tenable.com/reference#scans-export-status
     def scan_export_status(scan_id, file_id)
       http_get(:uri => "/scans/#{scan_id}/export/#{file_id}/status", :fields => header)
     end
@@ -371,16 +371,15 @@ module TenableRuby
     # Deletes a scan. NOTE: Scans in running, paused or stopping states can not be deleted.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/delete
+    # https://developer.tenable.com/reference#scans-delete
     def scan_delete(scan_id)
-      response = http_delete(:uri => "/scans/#{scan_id}", :fields => header)
-      return response.code == 200
+      http_delete(:uri => "/scans/#{scan_id}", :fields => header)
     end
 
     # Returns details for the given host
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/host-details
+    # https://developer.tenable.com/reference#scans-host-details
     def host_details(scan_id, host_id, history_id: nil)
       uri = "/scans/#{scan_id}/hosts/#{host_id}"
       unless history_id.nil?
@@ -392,7 +391,7 @@ module TenableRuby
     # Download an exported scan
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/export-download
+    # https://developer.tenable.com/reference#scans-export-download
     def report_download(scan_id, file_id)
       http_get(:uri => "/scans/#{scan_id}/export/#{file_id}/download", :raw_content => true, :fields => header)
     end
@@ -400,7 +399,7 @@ module TenableRuby
     # Returns details for the given policy
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/scans/host-details
+    # https://developer.tenable.com/reference#policies-details
     def policy_details(policy_id)
       http_get(:uri => "/policies/#{policy_id}", :fields => header)
     end
@@ -408,7 +407,7 @@ module TenableRuby
     # Creates a policy
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/policies/create
+    # https://developer.tenable.com/reference#policies-create
     def policy_create(template_id, plugins, settings)
       options = {
         :uri => "/policies/",
@@ -428,7 +427,7 @@ module TenableRuby
     # Copy a policy
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/policies/copy
+    # https://developer.tenable.com/reference#policies-copy
     def policy_copy(policy_id)
       options = {
         :uri => "/policies/#{policy_id}/copy",
@@ -441,7 +440,7 @@ module TenableRuby
     # Changes the parameters of a policy
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/policies/configure
+    # https://developer.tenable.com/reference#policies-configure
     def policy_configure(policy_id, template_id, plugins, settings)
       options = {
         :uri => "/policies/#{policy_id}",
@@ -461,7 +460,7 @@ module TenableRuby
     # Delete a policy
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/policies/delete
+    # https://developer.tenable.com/reference#policies-delete
     def policy_delete(policy_id)
       response = http_delete(:uri => "/policies/#{policy_id}", :fields => header)
       response.code
@@ -592,7 +591,7 @@ module TenableRuby
     # Returns a list of all containers.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-containers/list-containers
+    # https://developer.tenable.com/reference#container-security-containers-list-containers
     def list_containers()
       http_get(:uri => "/container-security/api/v1/container/list", :fields => header)
     end
@@ -600,7 +599,7 @@ module TenableRuby
     # Returns an inventory of an image by ID.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-containers/image-inventory
+    # https://developer.tenable.com/reference#container-security-containers-image-inventory
     def image_inventory(image_id)
       http_get(:uri => "/container-security/api/v1/container/#{policy_id}/status", :fields => header)
     end
@@ -608,7 +607,7 @@ module TenableRuby
     # Returns the status of a job that you specify by ID to determine if the job is still queued, in progress, or has completed.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-jobs/job-status
+    # https://developer.tenable.com/reference#container-security-jobs-job-status
     def job_status(job_id)
       http_get(:uri => "/container-security/api/v1/jobs/status?job_id=#{job_id}", :fields => header)
     end
@@ -616,7 +615,7 @@ module TenableRuby
     # Returns the status of a job by specifying an image ID to determine if the job is still queued, in progress, or has completed.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-jobs/job-status-by-image-id
+    # https://developer.tenable.com/reference#container-security-jobs-job-status-by-image-id
     def image_status(image_id)
       http_get(:uri => "/container-security/api/v1/jobs/image_status?image_id=#{image_id}", :fields => header)
     end
@@ -624,7 +623,7 @@ module TenableRuby
     # Returns the status of a job by specifying an image digest to determine if the job is still queued, in progress, or has completed.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-jobs/job-status-by-image-digest
+    # https://developer.tenable.com/reference#container-security-jobs-job-status-by-image-digest
     def image_status_digest(image_digest)
       http_get(:uri => "/container-security/api/v1/jobs/image_status_digest?image_digest=#{image_digest}", :fields => header)
     end
@@ -632,7 +631,7 @@ module TenableRuby
     # Returns a list of active Container Security jobs
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-jobs/list-jobs
+    # https://developer.tenable.com/reference#container-security-jobs-list-jobs
     def list_jobs()
       http_get(:uri => "/container-security/api/v1/jobs/list", :fields => header)
     end
@@ -640,7 +639,7 @@ module TenableRuby
     # Checks the compliance of an image that you specify by ID against your policies.
     #
     # Reference: 
-    # https://cloud.tenable.com/api#/resources/container-security-policy/policy-compliance-by-id
+    # https://developer.tenable.com/reference#container-security-policy-policy-compliance-by-id
     def policy_compliance_by_id(image_id)
       http_get(:uri => "/container-security/api/v1/policycompliance?image_id=#{image_id}", :fields => header)
     end
@@ -648,7 +647,7 @@ module TenableRuby
     # Checks the compliance of an image that you specify by name against your policies.
     #
     # Reference: 
-    # https://cloud.tenable.com/api#/resources/container-security-policy/policy-compliance-by-name
+    # https://developer.tenable.com/reference#container-security-policy-policy-compliance-by-name
     def policy_compliance_by_name(image)
       http_get(:uri => "/container-security/api/v1/compliancebyname?image=#{image}", :fields => header)
     end
@@ -656,7 +655,7 @@ module TenableRuby
     # Returns a report in JSON format for a container that you specify by ID. Note: If you do not have the container_id, you can call the list-containers endpoint.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-reports/report-by-container-id
+    # https://developer.tenable.com/reference#container-security-reports-report-by-container-id
     def report_by_container_id(container_id)
       http_get(:uri => "/container-security/api/v1/reports/show?container_id=#{container_id}", :fields => header)
     end
@@ -664,7 +663,7 @@ module TenableRuby
     # Returns a report in JSON format for an image that you specify by ID. Note: If you do not have the image_id, you can call the list-images endpoint.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-reports/report-by-image-id
+    # https://developer.tenable.com/reference#container-security-reports-report-by-image-id
     def report_by_image_id(image_id)
       http_get(:uri => "/container-security/api/v1/reports/by_image?image_id=#{image_id}", :fields => header)
     end
@@ -672,7 +671,7 @@ module TenableRuby
     # Returns a report in JSON format for an image digest.
     #
     # Reference:
-    # https://cloud.tenable.com/api#/resources/container-security-reports/report-by-image-digest
+    # https://developer.tenable.com/reference#container-security-reports-report-by-image-digest
     def report_by_image_digest(image_digest)
       http_get(:uri => "/container-security/api/v1/reports/by_image_digest?image_digest=#{image_digest}", :fields => header)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tenable-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Patrick Craston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Ruby library for communicating with the tenable.io API.