contrast-agent 5.3.0 → 6.1.1

data/lib/contrast/config/agent_configuration.rb

@@ -9,61 +9,54 @@ require 'contrast/config/api_configuration'
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # core functionality of the Agent.
-    class AgentConfiguration < BaseConfiguration
-      attr_accessor :enable, :omit_body, :start_bundled_service, :api
-      attr_writer :ruby, :service, :logger, :heap_dump
+    # Common Configuration settings. Those in this section pertain to the core functionality of the Agent.
+    class AgentConfiguration
+      include Contrast::Config::BaseConfiguration
+
+      # @return [Boolean, nil]
+      attr_accessor :enable
+      # @return [Boolean, nil]
+      attr_accessor :omit_body
+      # @return [Contrast::Config::RubyConfiguration]
+      attr_writer :ruby
+      # @return [Contrast::Config::ServiceConfiguration]
+      attr_writer :service
+      # @return [ Contrast::Config::LoggerConfiguration]
+      attr_writer :logger
+      # @return [Contrast::Config::HeapDumpConfiguration]
+      attr_writer :heap_dump
 
       def initialize hsh = {}
-        @enable = traverse_config(hsh, :enable)
-        @start_bundled_service = traverse_config(hsh, :start_bundled_service)
-        @omit_body = traverse_config(hsh, :omit_body)
-        @service = Contrast::Config::ServiceConfiguration.new(traverse_config(hsh, :service))
-        @logger = Contrast::Config::LoggerConfiguration.new(traverse_config(hsh, :logger))
-        @ruby = Contrast::Config::RubyConfiguration.new(traverse_config(hsh, :ruby))
-        @heap_dump = Contrast::Config::HeapDumpConfiguration.new(traverse_config(hsh, :heap_dump))
-        @configuration_map = {}
-        build_configuration_map
+        return unless hsh
+
+        @enable = hsh[:enable]
+        @start_bundled_service = hsh[:start_bundled_service]
+        @omit_body = hsh[:omit_body]
+        @service = Contrast::Config::ServiceConfiguration.new(hsh[:service])
+        @logger = Contrast::Config::LoggerConfiguration.new(hsh[:logger])
+        @ruby = Contrast::Config::RubyConfiguration.new(hsh[:ruby])
+        @heap_dump = Contrast::Config::HeapDumpConfiguration.new(hsh[:heap_dump])
+      end
+
+      # @return [Boolean, true]
+      def start_bundled_service
+        @start_bundled_service.nil? ? true : @start_bundled_service
       end
 
       def service
-        @service ||= Contrast::Config::ServiceConfiguration.new({})
+        @service ||= Contrast::Config::ServiceConfiguration.new
       end
 
       def logger
-        @logger ||= Contrast::Config::LoggerConfiguration.new({})
+        @logger ||= Contrast::Config::LoggerConfiguration.new
       end
 
       def ruby
-        @ruby ||= Contrast::Config::RubyConfiguration.new({})
+        @ruby ||= Contrast::Config::RubyConfiguration.new
       end
 
       def heap_dump
-        @heap_dump ||= Contrast::Config::HeapDumpConfiguration.new({})
-      end
-
-      # Traverse the given entity to build out the configuration graph.
-      #
-      # The values will be either a hash, indicating internal nodes to
-      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
-      # leaf node.
-      #
-      # The spec_key are the Contrast defined keys based on the instance variables of
-      # a given configuration.
-      def traverse_config values, spec_key
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
-        val == EMPTY_VALUE ? nil : val
-      end
-
-      def build_configuration_map
-        instance_variables.each do |key|
-          str_key = key.to_s.tr('@', '')
-          next if str_key == 'configuration_map'
-
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
+        @heap_dump ||= Contrast::Config::HeapDumpConfiguration.new
       end
     end
   end

data/lib/contrast/config/api_configuration.rb

@@ -8,26 +8,29 @@ require 'contrast/config/request_audit_configuration'
 module Contrast
   module Config
     # Api keys configuration
-    class ApiConfiguration < BaseConfiguration
+    class ApiConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String]
-      attr_reader :api_key
+      attr_accessor :api_key
       # @return [String]
-      attr_reader :user_name
+      attr_accessor :user_name
       # @return [String]
-      attr_reader :service_key
+      attr_accessor :service_key
+      attr_writer :url, :proxy, :request_audit, :certificate
 
       DEFAULT_URL = 'https://app.contrastsecurity.com/Contrast'
 
       def initialize hsh = {}
-        @api_key = traverse_config(hsh, :api_key)
-        @url = traverse_config(hsh, :url)
-        @user_name = traverse_config(hsh, :user_name)
-        @service_key = traverse_config(hsh, :service_key)
-        @proxy = Contrast::Config::ApiProxyConfiguration.new(traverse_config(hsh, :proxy))
-        @request_audit = Contrast::Config::RequestAuditConfiguration.new(traverse_config(hsh, :request_audit))
-        @certificate = Contrast::Config::CertificationConfiguration.new(traverse_config(hsh, :certificate))
-        @configuration_map = {}
-        build_configuration_map
+        return unless hsh
+
+        @api_key = hsh[:api_key]
+        @url = hsh[:url]
+        @user_name = hsh[:user_name]
+        @service_key = hsh[:service_key]
+        @proxy = Contrast::Config::ApiProxyConfiguration.new(hsh[:proxy])
+        @request_audit = Contrast::Config::RequestAuditConfiguration.new(hsh[:request_audit])
+        @certificate = Contrast::Config::CertificationConfiguration.new(hsh[:certificate])
       end
 
       def url
@@ -48,68 +51,6 @@ module Contrast
       def certificate
         @certificate ||= Contrast::Config::CertificationConfiguration.new
       end
-
-      def api_key= value
-        self['api_key'] = value
-      end
-
-      def url= value
-        self['url'] = value
-      end
-
-      def user_name= value
-        self['user_name'] = value
-      end
-
-      def service_key= value
-        self['service_key'] = value
-      end
-
-      def proxy= value
-        self['proxy'] = value
-      end
-
-      def request_audit= value
-        self['request_audit'] = value
-      end
-
-      def certificate= value
-        self['certificate'] = value
-      end
-
-      # TODO: RUBY-1493 MOVE TO BASE CONFIG
-
-      def []= key, value
-        instance_variable_set("@#{ key }".to_sym, value)
-        @configuration_map[key] = value
-      end
-
-      def [] key
-        send(key.to_sym)
-      end
-
-      # Traverse the given entity to build out the configuration graph.
-      #
-      # The values will be either a hash, indicating internal nodes to
-      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
-      # leaf node.
-      #
-      # The spec_key are the Contrast defined keys based on the instance variables of
-      # a given configuration.
-      def traverse_config values, spec_key
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
-        val == EMPTY_VALUE ? nil : val
-      end
-
-      def build_configuration_map
-        instance_variables.each do |key|
-          str_key = key.to_s.tr('@', '')
-          next if str_key == 'configuration_map'
-
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
-      end
     end
   end
 end

data/lib/contrast/config/api_proxy_configuration.rb

@@ -4,63 +4,24 @@
 module Contrast
   module Config
     # Api Proxy keys configuration
-    class ApiProxyConfiguration < BaseConfiguration
+    class ApiProxyConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String] proxy url
-      attr_reader :url
+      attr_accessor :url
+      attr_writer :enable
 
       def initialize hsh = {}
-        @enable = traverse_config(hsh, :enable)
-        @url = traverse_config(hsh, :url)
-        @configuration_map = {}
-        build_configuration_map
+        return unless hsh
+
+        @enable = hsh[:enable]
+        @url = hsh[:url]
       end
 
       # @return [Boolean, false]
       def enable
         @enable.nil? ? false : @enable
       end
-
-      def enable= value
-        self['enable'] = value
-      end
-
-      def url= value
-        self['url'] = value
-      end
-
-      # TODO: RUBY-1493 MOVE TO BASE CONFIG
-
-      def []= key, value
-        instance_variable_set("@#{ key }".to_sym, value)
-        @configuration_map[key] = value
-      end
-
-      def [] key
-        send(key.to_sym)
-      end
-
-      # Traverse the given entity to build out the configuration graph.
-      #
-      # The values will be either a hash, indicating internal nodes to
-      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
-      # leaf node.
-      #
-      # The spec_key are the Contrast defined keys based on the instance variables of
-      # a given configuration.
-      def traverse_config values, spec_key
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
-        val == EMPTY_VALUE ? nil : val
-      end
-
-      def build_configuration_map
-        instance_variables.each do |key|
-          str_key = key.to_s.tr('@', '')
-          next if str_key == 'configuration_map'
-
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
-      end
     end
   end
 end

data/lib/contrast/config/application_configuration.rb

@@ -7,37 +7,40 @@ module Contrast
   module Config
     # Common Configuration settings. Those in this section pertain to the
     # application identification functionality of the Agent.
-    class ApplicationConfiguration < BaseConfiguration
+    class ApplicationConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String]
-      attr_reader :name
+      attr_accessor :name
       # @return [String]
-      attr_reader :version
+      attr_accessor :version
       # @return [String]
-      attr_reader :language
+      attr_accessor :language
       # @return [String]
-      attr_reader :path
+      attr_accessor :path
       # @return [String]
-      attr_reader :group
+      attr_accessor :group
       # @return [String]
-      attr_reader :tags
+      attr_accessor :tags
       # @return [String]
-      attr_reader :code
+      attr_accessor :code
       # @return [String]
-      attr_reader :metadata
+      attr_accessor :metadata
+      attr_writer :session_id, :session_metadata
 
       def initialize hsh = {}
-        @name = traverse_config(hsh, :name)
-        @version = traverse_config(hsh, :version)
-        @language = traverse_config(hsh, :language)
-        @path = traverse_config(hsh, :path)
-        @group = traverse_config(hsh, :group)
-        @tags = traverse_config(hsh, :tags)
-        @code = traverse_config(hsh, :code)
-        @metadata = traverse_config(hsh, :metadata)
-        @session_id = traverse_config(hsh, :session_id)
-        @session_metadata = traverse_config(hsh, :session_metadata)
-        @configuration_map = {}
-        build_configuration_map
+        return unless hsh
+
+        @name = hsh[:name]
+        @version = hsh[:version]
+        @language = hsh[:language]
+        @path = hsh[:path]
+        @group = hsh[:group]
+        @tags = hsh[:tags]
+        @code = hsh[:code]
+        @metadata = hsh[:metadata]
+        @session_id = hsh[:session_id]
+        @session_metadata = hsh[:session_metadata]
       end
 
       # @return [String, Contrast::Utils::ObjectShare::EMPTY_STRING]
@@ -49,80 +52,6 @@ module Contrast
       def session_metadata
         @session_metadata ||= Contrast::Utils::ObjectShare::EMPTY_STRING
       end
-
-      def name= value
-        self['name'] = value
-      end
-
-      def version= value
-        self['version'] = value
-      end
-
-      def language= value
-        self['language'] = value
-      end
-
-      def path= value
-        self['path'] = value
-      end
-
-      def group= value
-        self['group'] = value
-      end
-
-      def tags= value
-        self['tags'] = value
-      end
-
-      def code= value
-        self['code'] = value
-      end
-
-      def metadata= value
-        self['metadata'] = value
-      end
-
-      def session_id= value
-        self['session_id'] = value
-      end
-
-      def session_metadata= value
-        self['session_metadata'] = value
-      end
-
-      # TODO: RUBY-1493 MOVE TO BASE CONFIG
-
-      def []= key, value
-        instance_variable_set("@#{ key }".to_sym, value)
-        @configuration_map[key] = value
-      end
-
-      def [] key
-        send(key.to_sym)
-      end
-
-      # Traverse the given entity to build out the configuration graph.
-      #
-      # The values will be either a hash, indicating internal nodes to
-      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
-      # leaf node.
-      #
-      # The spec_key are the Contrast defined keys based on the instance variables of
-      # a given configuration.
-      def traverse_config values, spec_key
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
-        val == EMPTY_VALUE ? nil : val
-      end
-
-      def build_configuration_map
-        instance_variables.each do |key|
-          str_key = key.to_s.tr('@', '')
-          next if str_key == 'configuration_map'
-
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
-      end
     end
   end
 end

data/lib/contrast/config/assess_configuration.rb

@@ -5,27 +5,28 @@ module Contrast
   module Config
     # Common Configuration settings. Those in this section pertain to the
     # assess functionality of the Agent.
-    class AssessConfiguration < BaseConfiguration
+    class AssessConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String, nil]
-      attr_reader :tags
+      attr_accessor :tags
+      # @return [Boolean, nil]
+      attr_accessor :enable
+      attr_writer :enable_scan_response, :enable_dynamic_sources, :sampling, :rules, :stacktraces
 
       DEFAULT_STACKTRACES = 'ALL'
 
       def initialize hsh = {}
-        @enable = traverse_config(hsh, :enable)
-        @tags = traverse_config(hsh, :tags)
-        @enable_scan_response = traverse_config(hsh, :enable_scan_response)
-        @enable_dynamic_sources = traverse_config(hsh, :enable_dynamic_sources)
-        @sampling = Contrast::Config::SamplingConfiguration.new(traverse_config(hsh, :sampling))
-        @rules = Contrast::Config::AssessRulesConfiguration.new(traverse_config(hsh, :rules))
-        @stacktraces = traverse_config(hsh, :stacktraces)
-        @configuration_map = {}
-        build_configuration_map
-      end
+        return unless hsh
 
-      # @return [Boolean, true]
-      def enable
-        @enable.nil? ? true : @enable
+        @enable = hsh[:enable]
+        @tags = hsh[:tags]
+        @enable_scan_response = hsh[:enable_scan_response]
+        @enable_dynamic_sources = hsh[:enable_dynamic_sources]
+        @enable_original_object = hsh[:enable_original_object]
+        @sampling = Contrast::Config::SamplingConfiguration.new(hsh[:sampling])
+        @rules = Contrast::Config::AssessRulesConfiguration.new(hsh[:rules])
+        @stacktraces = hsh[:stacktraces]
       end
 
       # @return [Boolean, true]
@@ -38,6 +39,11 @@ module Contrast
         @enable_dynamic_sources.nil? ? true : @enable_dynamic_sources
       end
 
+      # @return [Boolean, true]
+      def enable_original_object
+        @enable_original_object.nil? ? true : @enable_original_object
+      end
+
       # @return [Contrast::Config::SamplingConfiguration]
       def sampling
         @sampling ||= Contrast::Config::SamplingConfiguration.new
@@ -52,67 +58,6 @@ module Contrast
       def stacktraces
         @stacktraces ||= DEFAULT_STACKTRACES
       end
-
-      def enable= value
-        self['enable'] = value
-      end
-
-      def tags= value
-        self['tags'] = value
-      end
-
-      def enable_scan_response= value
-        self['enable_scan_response'] = value
-      end
-
-      def enable_dynamic_sources= value
-        self['enable_dynamic_sources'] = value
-      end
-
-      def sampling= value
-        self['sampling'] = value
-      end
-
-      def rules= value
-        self['rules'] = value
-      end
-
-      def stacktraces= value
-        self['stacktraces'] = value
-      end
-      # TODO: RUBY-1493 MOVE TO BASE CONFIG
-
-      def []= key, value
-        instance_variable_set("@#{ key }".to_sym, value)
-        @configuration_map[key] = value
-      end
-
-      def [] key
-        send(key.to_sym)
-      end
-
-      # Traverse the given entity to build out the configuration graph.
-      #
-      # The values will be either a hash, indicating internal nodes to
-      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
-      # leaf node.
-      #
-      # The spec_key are the Contrast defined keys based on the instance variables of
-      # a given configuration.
-      def traverse_config values, spec_key
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
-        val == EMPTY_VALUE ? nil : val
-      end
-
-      def build_configuration_map
-        instance_variables.each do |key|
-          str_key = key.to_s.tr('@', '')
-          next if str_key == 'configuration_map'
-
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
-      end
     end
   end
 end

data/lib/contrast/config/assess_rules_configuration.rb

@@ -5,52 +5,27 @@ module Contrast
   module Config
     # Common Configuration settings. Those in this section pertain to the
     # disabled assess rule functionality of the Agent.
-    class AssessRulesConfiguration < BaseConfiguration
+    class AssessRulesConfiguration
+      include Contrast::Config::BaseConfiguration
+
+      SPEC_KEY = :disabled_rules.cs__freeze
       # @return [Array, nil] list of disabled assess rules
-      attr_reader :disabled_rules
+      attr_accessor :disabled_rules
 
       def initialize hsh = {}
-        @disabled_rules = traverse_config(hsh, :disabled_rules)
-        @configuration_map = {}
-        build_configuration_map
-      end
-
-      def disabled_rules= value
-        self['disabled_rules'] = value
-      end
+        return unless hsh
 
-      # TODO: RUBY-1493 MOVE TO BASE CONFIG
-
-      def []= key, value
-        instance_variable_set("@#{ key }".to_sym, value)
-        @configuration_map[key] = value
-      end
-
-      def [] key
-        send(key.to_sym)
+        @disabled_rules = cast_disabled_rules(hsh)
       end
 
-      # Traverse the given entity to build out the configuration graph.
-      #
-      # The values will be either a hash, indicating internal nodes to
-      # traverse, or a value to set or the EMPTY_VALUE symbol, indicating a
-      # leaf node.
-      #
-      # The spec_key are the Contrast defined keys based on the instance variables of
-      # a given configuration.
-      def traverse_config values, spec_key
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        val = internal_nodes ? value_from_key_config(spec_key, values) : nil
-        val == EMPTY_VALUE ? nil : val
-      end
+      private
 
-      def build_configuration_map
-        instance_variables.each do |key|
-          str_key = key.to_s.tr('@', '')
-          next if str_key == 'configuration_map'
+      def cast_disabled_rules hsh
+        return unless hsh
+        return unless hsh.key?(SPEC_KEY)
+        return hsh[SPEC_KEY] if hsh[SPEC_KEY].cs__is_a?(Array)
 
-          @configuration_map[str_key] = send(str_key.to_sym)
-        end
+        hsh[SPEC_KEY].split(',').map(&:strip) if hsh[SPEC_KEY].cs__is_a?(String)
       end
     end
   end