tenable-ruby-sdk 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6d43ebf62504ff612798c1da4e1b9ab3139fce82074ba5c45030d8369106cfd
-  data.tar.gz: 919847851066083b7cf95d137b0eb7b376b522333ca4866a004337cdf0d32cc1
+  metadata.gz: 86589e9deaec4440aa70b20ecfeba69a3416a89e1bf878bcb487b64b89fcf718
+  data.tar.gz: cebd719560c8d982d71a0306ffa310da52af29a430b6943fd962b8301f467cf9
 SHA512:
-  metadata.gz: fa1c0b19a4921747e86d7e5a5eb884ac3842b1db46cf1b7289920b026f55328536fe3ba6fbaddecd7b0bafce920dc1e6268fc54fd660ab797c32d8a5d9eb8b31
-  data.tar.gz: d58116b3a1d534878c8dc0c10f6081bb686b64bb663744595472daee50429364cce5dd9221ab0edd83267485b7ac608bbeb90290c46ec2ef23c3dffe85636e1b
+  metadata.gz: c54b804d1fd9f24b320c6c645c552b7cdafe6eb6600fb8289500629c1d18a3fb525181655ad7b40f142fd6c95367398ccd79c5cc70c1ddce3c9ad1c504d2e539
+  data.tar.gz: c7060d7a71ad818ef898f1687694d81e22ac409c2b5e68a3feb0cb63bd1cb8e4e16b51e0dc09678f3a60e058d4be37238ad11c437a7672e8fced715f6907d444

data/lib/tenable/resources/scans.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'uri'
+
 module Tenable
   module Resources
     # Provides access to the Tenable.io scan management endpoints.
     class Scans < Base
       # Supported scan export formats.
-      SUPPORTED_EXPORT_FORMATS = %w[pdf csv nessus].freeze
+      SUPPORTED_EXPORT_FORMATS = %w[nessus html pdf csv db].freeze
 
       # @return [Integer] default seconds between export status polls
       DEFAULT_EXPORT_POLL_INTERVAL = 5
@@ -163,20 +165,21 @@ module Tenable
       # Initiates a scan report export.
       #
       # @param scan_id [Integer, String] the scan ID
-      # @param format [String] export format — one of "pdf", "csv", or "nessus"
+      # @param format [String, Symbol] export format — one of "nessus", "html", "pdf", "csv", or "db"
+      # @param history_id [Integer, nil] optional scan history ID query parameter; required for "db" exports
       # @param body [Hash] additional export parameters (e.g., +chapters+ for PDF)
       # @return [Hash] response containing the file ID under +"file"+ key
-      # @raise [ArgumentError] if the format is not supported
+      # @raise [ArgumentError] if required parameters are missing or format is not supported
       #
       # @example
       #   client.scans.export_request(123, format: 'pdf', chapters: 'vuln_hosts_summary')
-      def export_request(scan_id, format:, **body)
+      def export_request(scan_id, format:, history_id: nil, **body)
         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(', ')}"
-        end
+        format = normalize_export_format(format)
+        validate_export_format!(format)
+        validate_export_request!(format, history_id: history_id, body: body)
 
-        post("/scans/#{scan_id}/export", body.merge(format: format))
+        post(export_request_path(scan_id, history_id), body.merge(format: format))
       end
 
       # Retrieves the status of a scan export.
@@ -222,7 +225,7 @@ module Tenable
       # Convenience method: requests an export, waits for completion, and downloads the result.
       #
       # @param scan_id [Integer, String] the scan ID
-      # @param format [String] export format — one of "pdf", "csv", or "nessus"
+      # @param format [String, Symbol] export format — one of "nessus", "html", "pdf", "csv", or "db"
       # @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.
@@ -251,6 +254,49 @@ module Tenable
           content
         end
       end
+
+      private
+
+      def normalize_export_format(format)
+        format.to_s
+      end
+
+      def validate_export_format!(format)
+        return if SUPPORTED_EXPORT_FORMATS.include?(format)
+
+        raise ArgumentError, "Unsupported format '#{format}'. Must be one of: #{SUPPORTED_EXPORT_FORMATS.join(', ')}"
+      end
+
+      def validate_export_request!(format, history_id:, body:)
+        validate_chapters_requirement!(format, body[:chapters])
+        validate_db_requirements!(format, history_id: history_id, body: body)
+      end
+
+      def validate_chapters_requirement!(format, chapters)
+        return unless %w[pdf html].include?(format)
+        return unless blank_value?(chapters)
+
+        raise ArgumentError, "chapters is required when format is '#{format}'"
+      end
+
+      def validate_db_requirements!(format, history_id:, body:)
+        return unless format == 'db'
+
+        raise ArgumentError, "history_id is required when format is 'db'" if history_id.nil?
+        raise ArgumentError, "asset_id is required when format is 'db'" if blank_value?(body[:asset_id])
+        raise ArgumentError, "password is required when format is 'db'" if blank_value?(body[:password])
+      end
+
+      def export_request_path(scan_id, history_id)
+        path = "/scans/#{scan_id}/export"
+        return path if history_id.nil?
+
+        "#{path}?#{URI.encode_www_form(history_id: history_id)}"
+      end
+
+      def blank_value?(value)
+        value.nil? || value.to_s.strip.empty?
+      end
     end
   end
 end

data/lib/tenable/version.rb

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

metadata

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