Sha256: c47ae24df8b139578152c5dfd84b259f6476a070bc445128a6f44e11c524ad82

Contents?: true

Size: 1.29 KB

Versions: 7

Compression:

Stored size: 1.29 KB

Contents

# Copyright (c) 2022 Contrast Security, Inc. See https://www.contrastsecurity.com/enduser-terms-0317a for more details.
# frozen_string_literal: true

module Contrast
  module Agent
    module Reporting
      # This is the new FindingEventProperty class which will include all the needed information for the new reporting
      # system to relay this information in the Finding/Trace messages. Events have properties on them which are held
      # as an array of key-value pairs.
      class FindingEventProperty
        # @return [String] the key of the property
        attr_reader :key
        # @return [String] the value of the source
        attr_reader :value

        def initialize key, value
          @key = key
          @value = value
        end

        # Convert the instance variables on the class, and other information, into the identifiers required for
        # TeamServer to process the JSON form of this message.
        #
        # @return [Hash]
        # @raise [ArgumentError]
        def to_controlled_hash
          validate
          {
              key: key,
              value: value
          }
        end

        def validate
          raise(ArgumentError, "#{ self } did not have a proper key. Unable to continue.") unless key && !key.empty?
        end
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
contrast-agent-6.2.0 lib/contrast/agent/reporting/reporting_events/finding_event_property.rb
contrast-agent-6.1.2 lib/contrast/agent/reporting/reporting_events/finding_event_property.rb
contrast-agent-6.1.1 lib/contrast/agent/reporting/reporting_events/finding_event_property.rb
contrast-agent-6.1.0 lib/contrast/agent/reporting/reporting_events/finding_event_property.rb
contrast-agent-6.0.0 lib/contrast/agent/reporting/reporting_events/finding_event_property.rb
contrast-agent-5.3.0 lib/contrast/agent/reporting/reporting_events/finding_event_property.rb
contrast-agent-5.2.0 lib/contrast/agent/reporting/reporting_events/finding_event_property.rb