tenable-ruby-sdk 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d7ece5c94106a90e943a28de1d89b61b926611e9986266a97a3bae855ab6f9f
-  data.tar.gz: 1c142a0070888b29363449c7c6aa17c7fe0d8a080650238645f94b3a38c030bc
+  metadata.gz: b6d43ebf62504ff612798c1da4e1b9ab3139fce82074ba5c45030d8369106cfd
+  data.tar.gz: 919847851066083b7cf95d137b0eb7b376b522333ca4866a004337cdf0d32cc1
 SHA512:
-  metadata.gz: 18c6a1706e9ed1d3f26afc751a1b8b327dae909d31a56f6fc24014f15eaef652998d5a6c13c5913e47284e1981e7167af8caf3070bac5aefa4338231c02ec40d
-  data.tar.gz: e3134b47b1e1bf14a32f68e9193e2cad657af925502955522270c41d997d48d81513aa956d289064545591980ebe1899e294fec584999650f853042253d3dbab
+  metadata.gz: fa1c0b19a4921747e86d7e5a5eb884ac3842b1db46cf1b7289920b026f55328536fe3ba6fbaddecd7b0bafce920dc1e6268fc54fd660ab797c32d8a5d9eb8b31
+  data.tar.gz: d58116b3a1d534878c8dc0c10f6081bb686b64bb663744595472daee50429364cce5dd9221ab0edd83267485b7ac608bbeb90290c46ec2ef23c3dffe85636e1b

data/lib/tenable/connection.rb

@@ -23,15 +23,24 @@ module Tenable
     def build_connection
       Faraday.new(url: @config.base_url) do |f|
         f.headers['Accept'] = 'application/json'
-        f.use Middleware::Authentication,
-              access_key: @config.access_key,
-              secret_key: @config.secret_key
-        f.use Middleware::Retry, max_retries: @config.max_retries
-        f.use Middleware::Logging, logger: @config.logger
-        f.options.timeout = @config.timeout
-        f.options.open_timeout = @config.open_timeout
+        f.request :json
+        configure_middleware(f)
+        configure_timeouts(f)
         f.adapter Faraday.default_adapter
       end
     end
+
+    def configure_middleware(faraday)
+      faraday.use Middleware::Authentication,
+                  access_key: @config.access_key,
+                  secret_key: @config.secret_key
+      faraday.use Middleware::Retry, max_retries: @config.max_retries
+      faraday.use Middleware::Logging, logger: @config.logger
+    end
+
+    def configure_timeouts(faraday)
+      faraday.options.timeout = @config.timeout
+      faraday.options.open_timeout = @config.open_timeout
+    end
   end
 end

data/lib/tenable/resources/base.rb

@@ -38,10 +38,7 @@ module Tenable
       # @raise [ApiError] on other non-2xx responses
       # @raise [ParseError] if the response is not valid JSON
       def post(path, body = nil)
-        response = @connection.faraday.post(path) do |req|
-          req.headers['Content-Type'] = 'application/json'
-          req.body = JSON.generate(body) if body
-        end
+        response = @connection.faraday.post(path, body)
         handle_response(response)
       end
 
@@ -51,10 +48,7 @@ module Tenable
       # @param body [Hash, nil] request body (serialized to JSON)
       # @return [Hash, Array, nil] parsed JSON response
       def put(path, body = nil)
-        response = @connection.faraday.put(path) do |req|
-          req.headers['Content-Type'] = 'application/json'
-          req.body = JSON.generate(body) if body
-        end
+        response = @connection.faraday.put(path, body)
         handle_response(response)
       end
 
@@ -64,10 +58,7 @@ module Tenable
       # @param body [Hash, nil] request body (serialized to JSON)
       # @return [Hash, Array, nil] parsed JSON response
       def patch(path, body = nil)
-        response = @connection.faraday.patch(path) do |req|
-          req.headers['Content-Type'] = 'application/json'
-          req.body = JSON.generate(body) if body
-        end
+        response = @connection.faraday.patch(path, body)
         handle_response(response)
       end
 

data/lib/tenable/resources/scans.rb

@@ -127,14 +127,13 @@ module Tenable
         put("/scans/#{scan_id}/schedule", params)
       end
 
-      # Retrieves the scan history.
+      # Retrieves the scan history from the scan details endpoint.
       #
       # @param scan_id [Integer, String] the scan ID
-      # @param params [Hash] optional query parameters (e.g., +limit+, +offset+, +sort+)
-      # @return [Hash] history data including an array of history records
-      def history(scan_id, **params)
-        validate_path_segment!(scan_id, name: 'scan_id')
-        get("/scans/#{scan_id}/history", params)
+      # @return [Array<Hash>] array of history records
+      def history(scan_id)
+        data = details(scan_id)
+        data['history'] || []
       end
 
       # Retrieves details for a specific host within a scan.

data/lib/tenable/resources/web_app_scans.rb

@@ -6,8 +6,17 @@ module Tenable
     class WebAppScans < Base
       TERMINAL_STATUSES = %w[completed failed cancelled error].freeze
 
+      # Supported scan export formats and their MIME types.
+      FORMAT_CONTENT_TYPES = {
+        'json' => 'application/json',
+        'csv' => 'text/csv',
+        'xml' => 'application/xml',
+        'html' => 'text/html',
+        'pdf' => 'application/pdf'
+      }.freeze
+
       # Supported scan export formats.
-      SUPPORTED_EXPORT_FORMATS = %w[json csv xml html pdf].freeze
+      SUPPORTED_EXPORT_FORMATS = FORMAT_CONTENT_TYPES.keys.freeze
 
       # @return [Integer] default seconds between status polls
       DEFAULT_POLL_INTERVAL = 2
@@ -34,8 +43,6 @@ module Tenable
         post('/was/v2/configs', { 'name' => name, 'target' => target })
       end
 
-      # Retrieves a scan configuration by ID.
-      #
       # @param config_id [String] the scan configuration ID
       # @return [Hash] the configuration data
       def get_config(config_id)
@@ -43,8 +50,6 @@ module Tenable
         get("/was/v2/configs/#{config_id}")
       end
 
-      # Updates a scan configuration.
-      #
       # @param config_id [String] the scan configuration ID
       # @param params [Hash] configuration parameters to update
       # @return [Hash] the updated configuration data
@@ -53,8 +58,6 @@ module Tenable
         put("/was/v2/configs/#{config_id}", params)
       end
 
-      # Deletes a scan configuration.
-      #
       # @param config_id [String] the scan configuration ID
       # @return [Hash, nil] parsed response or nil
       def delete_config(config_id)
@@ -62,8 +65,6 @@ module Tenable
         delete("/was/v2/configs/#{config_id}")
       end
 
-      # Searches scan configurations.
-      #
       # @param params [Hash] search parameters
       # @return [Hash] search results with items and pagination
       def search_configs(**params)
@@ -157,8 +158,6 @@ module Tenable
         post("/was/v2/configs/#{config_id}/scans/search", params)
       end
 
-      # Searches WAS vulnerabilities.
-      #
       # @param params [Hash] search parameters
       # @return [Hash] search results with items and pagination
       def search_vulnerabilities(**params)
@@ -176,18 +175,19 @@ module Tenable
 
       # Initiates a report export for a specific WAS scan.
       #
+      # The format is specified via the Content-Type header per the Tenable API.
+      #
       # @param scan_id [String] the scan ID
       # @param format [String] export format — one of "json", "csv", "xml", "html", or "pdf"
-      # @param body [Hash] additional export parameters
       # @return [Hash] export initiation response
       # @raise [ArgumentError] if the format is not supported
-      def export_scan(scan_id, format:, **body)
+      def export_scan(scan_id, format:)
         validate_path_segment!(scan_id, name: 'scan_id')
-        unless SUPPORTED_EXPORT_FORMATS.include?(format)
-          raise ArgumentError, "Unsupported format '#{format}'. Must be one of: #{SUPPORTED_EXPORT_FORMATS.join(', ')}"
+        content_type = validate_export_format!(format)
+        response = @connection.faraday.put("/was/v2/scans/#{scan_id}/report") do |req|
+          req.headers['Content-Type'] = content_type
         end
-
-        put("/was/v2/scans/#{scan_id}/report", body.merge('format' => format))
+        handle_response(response)
       end
 
       # Checks the status of a WAS scan report by attempting to fetch it.
@@ -196,10 +196,15 @@ module Tenable
       # indicates the report is still being generated.
       #
       # @param scan_id [String] the scan ID
+      # @param format [String] export format — one of "json", "csv", "xml", "html", or "pdf"
       # @return [Hash] status data with +"status"+ key ("ready" or "loading")
-      def export_scan_status(scan_id)
+      def export_scan_status(scan_id, format:)
         validate_path_segment!(scan_id, name: 'scan_id')
-        response = @connection.faraday.get("/was/v2/scans/#{scan_id}/report")
+        content_type = validate_export_format!(format)
+        response = @connection.faraday.get("/was/v2/scans/#{scan_id}/report") do |req|
+          req.headers['Accept'] = content_type
+          req.headers['Content-Type'] = content_type
+        end
         if response.status == 404
           { 'status' => 'loading' }
         else
@@ -211,23 +216,32 @@ module Tenable
       # Downloads a completed WAS scan export as raw binary data.
       #
       # @param scan_id [String] the scan ID
+      # @param format [String] export format — one of "json", "csv", "xml", "html", or "pdf"
       # @return [String] raw binary content of the export
-      def download_scan_export(scan_id)
+      def download_scan_export(scan_id, format:)
         validate_path_segment!(scan_id, name: 'scan_id')
-        get_raw("/was/v2/scans/#{scan_id}/report")
+        content_type = validate_export_format!(format)
+        response = @connection.faraday.get("/was/v2/scans/#{scan_id}/report") do |req|
+          req.headers['Accept'] = content_type
+          req.headers['Content-Type'] = content_type
+        end
+        raise_for_status(response)
+        response.body
       end
 
       # Polls until a WAS scan export is ready for download.
       #
       # @param scan_id [String] the scan ID
+      # @param format [String] export format — one of "json", "csv", "xml", "html", or "pdf"
       # @param timeout [Integer] maximum seconds to wait (default: 600)
       # @param poll_interval [Integer] seconds between status checks (default: 5)
       # @return [Hash] the final status data when export is ready
       # @raise [Tenable::TimeoutError] if the export does not become ready within the timeout
-      def wait_for_scan_export(scan_id, timeout: DEFAULT_EXPORT_TIMEOUT, poll_interval: DEFAULT_EXPORT_POLL_INTERVAL)
+      def wait_for_scan_export(scan_id, format:, timeout: DEFAULT_EXPORT_TIMEOUT,
+                               poll_interval: DEFAULT_EXPORT_POLL_INTERVAL)
         validate_path_segment!(scan_id, name: 'scan_id')
         poll_until(timeout: timeout, poll_interval: poll_interval, label: "WAS scan export for #{scan_id}") do
-          status_data = export_scan_status(scan_id)
+          status_data = export_scan_status(scan_id, format: format)
           status_data if status_data['status'] == 'ready'
         end
       end
@@ -235,26 +249,25 @@ module Tenable
       # Convenience method: requests an export, waits for completion, and downloads the result.
       #
       # @param scan_id [String] the scan ID
-      # @param format [String] export format — one of "pdf", "csv", or "nessus"
+      # @param format [String] export format — one of "json", "csv", "xml", "html", or "pdf"
       # @param save_path [String, nil] if provided, writes binary content to this file path.
       #   The caller is responsible for ensuring the path is safe and writable.
       #   This value is used as-is with +File.binwrite+ — no sanitization is performed.
       # @param timeout [Integer] maximum seconds to wait (default: 600)
       # @param poll_interval [Integer] seconds between status checks (default: 5)
-      # @param body [Hash] additional export parameters
       # @return [String] the save_path if given, otherwise the raw binary content
       #
       # @example Download PDF to disk
       #   client.web_app_scans.export('scan-123', format: 'pdf', save_path: '/tmp/report.pdf')
       #
       # @example Get raw binary content
-      #   binary = client.web_app_scans.export('scan-123', format: 'nessus')
+      #   binary = client.web_app_scans.export('scan-123', format: 'csv')
       def export(scan_id, format:, save_path: nil, timeout: DEFAULT_EXPORT_TIMEOUT,
-                 poll_interval: DEFAULT_EXPORT_POLL_INTERVAL, **body)
+                 poll_interval: DEFAULT_EXPORT_POLL_INTERVAL)
         validate_path_segment!(scan_id, name: 'scan_id')
-        export_scan(scan_id, format: format, **body)
-        wait_for_scan_export(scan_id, timeout: timeout, poll_interval: poll_interval)
-        content = download_scan_export(scan_id)
+        export_scan(scan_id, format: format)
+        wait_for_scan_export(scan_id, format: format, timeout: timeout, poll_interval: poll_interval)
+        content = download_scan_export(scan_id, format: format)
 
         if save_path
           File.binwrite(save_path, content)
@@ -300,6 +313,14 @@ module Tenable
         validate_path_segment!(export_uuid, name: 'export_uuid')
         post("/was/v1/export/vulns/#{export_uuid}/cancel")
       end
+
+      private
+
+      def validate_export_format!(format)
+        FORMAT_CONTENT_TYPES.fetch(format) do
+          raise ArgumentError, "Unsupported format '#{format}'. Must be one of: #{SUPPORTED_EXPORT_FORMATS.join(', ')}"
+        end
+      end
     end
   end
 end

data/lib/tenable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tenable
-  VERSION = '0.2.0'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tenable-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - vudx00