contrast-agent 5.2.0 → 6.1.0

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

data/lib/contrast/config/base_configuration.rb

@@ -6,25 +6,19 @@ require 'contrast/utils/object_share'
 
 module Contrast
   module Config
-    # This is the base for our configuration classes. It is intended to
-    # facilitate the translation of the Common Configuration settings to usable
-    # Ruby classes.
-    class BaseConfiguration
+    # This is the base for our configuration classes. It is intended to facilitate the translation of the Common
+    # Configuration settings to usable Ruby classes.
+    module BaseConfiguration
       extend Forwardable
 
-      attr_reader :configuration_map
-
-      alias_method :to_hash, :configuration_map
-      def_delegators :@configuration_map, :empty?, :key?, :delete, :fetch,
-                     :[], :[]=, :each, :each_pair, :each_key, :each_value
-
-      EMPTY_VALUE = :EMPTY_VALUE
-
-      def initialize hsh = {}, keys = {}
-        # holds configuration key value pairs
-        # each configuration class can contain nested BaseConfigurations
-        @configuration_map = {}
-        traverse_config(hsh, keys)
+      def to_hash
+        hsh = {}
+        instance_variables.each do |iv|
+          # strip the '@' to get the key
+          key = iv.to_s[1..]
+          hsh[key] = send(key.to_sym)
+        end
+        hsh
       end
 
       def assign_value_to_path_array dot_path_array, value
@@ -39,65 +33,6 @@ module Contrast
         end
         nil
       end
-
-      def nil?
-        @configuration_map.empty?
-      end
-
-      private
-
-      # 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_keys are the Contrast defined keys used to access a given
-      # configuration. Each child of this class maintains its own set of keys,
-      # as well as Objects to which those keys map.
-      def traverse_config values, spec_keys
-        internal_nodes = values.cs__respond_to?(:has_key?)
-        spec_keys.each_pair do |spec_key, spec_value|
-          user_provided_value = internal_nodes ? value_from_key_config(spec_key, values) : EMPTY_VALUE
-          define_methods(spec_key, spec_value, user_provided_value)
-        end
-      end
-
-      def define_methods spec_key, spec_value, user_provided_value
-        str_key = spec_key.to_s
-        assign_config_value(str_key, spec_value, user_provided_value)
-        define_getter(str_key)
-        define_setter(str_key)
-      end
-
-      def assign_config_value str_key, spec_value, user_provided_value
-        @configuration_map[str_key] = if spec_value.is_a?(Class) && spec_value <= Contrast::Config::BaseConfiguration
-                                        spec_value.new(user_provided_value)
-                                      elsif user_provided_value == EMPTY_VALUE
-                                        spec_value
-                                      else
-                                        user_provided_value
-                                      end
-      end
-
-      def value_from_key_config key, config_hash
-        return config_hash[key] if config_hash.key?(key)
-        return config_hash.fetch(key.to_sym, EMPTY_VALUE) if key.is_a?(String)
-
-        config_hash.fetch(key.to_s, EMPTY_VALUE)
-      end
-
-      def define_getter str_key
-        define_singleton_method str_key.to_sym do
-          @configuration_map[str_key] == EMPTY_VALUE ? nil : @configuration_map[str_key]
-        end
-      end
-
-      def define_setter str_key
-        define_singleton_method "#{ str_key }=".to_sym do |new_value|
-          @configuration_map[str_key] = new_value
-        end
-      end
     end
   end
 end

data/lib/contrast/config/certification_configuration.rb

@@ -4,82 +4,29 @@
 module Contrast
   module Config
     # Certificate Configuration
-    class CertificationConfiguration < BaseConfiguration
+    class CertificationConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [String] path to CA Cert file
-      attr_reader :ca_file
+      attr_accessor :ca_file
       # @return [String] path to Certification file
-      attr_reader :cert_file
+      attr_accessor :cert_file
       # @return [String] path to Certification Key file
-      attr_reader :key_file
+      attr_accessor :key_file
+      attr_writer :enable
 
       def initialize hsh = {}
-        @enable = traverse_config(hsh, :enable)
-        @ca_file = traverse_config(hsh, :ca_file)
-        @cert_file = traverse_config(hsh, :cert_file)
-        @key_file = traverse_config(hsh, :key_file)
-        @configuration_map = {}
-        build_configuration_map
-      end
-
-      # GETTERS
-
-      # @return [Boolean]
-      def enable
-        return false if @enable.nil?
-
-        @enable
-      end
-
-      # SETTERS
-
-      def enable= value
-        self['enable'] = value
-      end
-
-      def ca_file= value
-        self['ca_file'] = value
-      end
+        return unless hsh
 
-      def cert_file= value
-        self['cert_file'] = value
+        @enable = hsh[:enable]
+        @ca_file = hsh[:ca_file]
+        @cert_file = hsh[:cert_file]
+        @key_file = hsh[:key_file]
       end
 
-      def key_file= value
-        self['key_file'] = 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
+      # @return [Boolean, false]
+      def enable
+        @enable.nil? ? false : @enable
       end
     end
   end

data/lib/contrast/config/exception_configuration.rb

@@ -3,72 +3,28 @@
 
 module Contrast
   module Config
-    # Common Configuration settings. Those in this section pertain to the
-    # exception handling in Ruby, allowing for the override of Response Code
-    # and Message when Security Exceptions are raised.
-    class ExceptionConfiguration < BaseConfiguration
+    # Common Configuration settings. Those in this section pertain to the exception handling in Ruby, allowing for the
+    # override of Response Code and Message when Security Exceptions are raised.
+    class ExceptionConfiguration
+      include Contrast::Config::BaseConfiguration
+
       # @return [Integer] the HTTP status code override
-      attr_reader :override_status
+      attr_accessor :override_status
       # @return [String] the message text override
-      attr_reader :override_message
+      attr_accessor :override_message
+      attr_writer :capture
 
       def initialize hsh = {}
-        @capture = traverse_config(hsh, :capture)
-        @override_status = traverse_config(hsh, :override_status)
-        @override_message = traverse_config(hsh, :override_message)
-        @configuration_map = {}
-        build_configuration_map
-      end
-
-      # @return [Boolean] default: false
-      def capture
-        @capture.nil? ? false : @capture
-      end
-
-      def capture= value
-        self['capture'] = value
-      end
-
-      def override_status= value
-        self['override_status'] = value
-      end
+        return unless hsh
 
-      def override_message= value
-        self['override_message'] = value
+        @capture = hsh[:capture]
+        @override_status = hsh[:override_status]
+        @override_message = hsh[:override_message]
       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
+      # @return [Boolean, false]
+      def capture
+        !!@capture
       end
     end
   end