optimizely-sdk 5.0.0 → 5.1.0

data/lib/optimizely/helpers/validator.rb

@@ -1,236 +1,236 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2016-2019, 2022-2023, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-require_relative 'constants'
-require 'json'
-require 'json-schema'
-
-module Optimizely
-  module Helpers
-    module Validator
-      module_function
-
-      def attributes_valid?(attributes)
-        # Determines if provided attributes are valid.
-        #
-        # attributes - User attributes to be validated.
-        #
-        # Returns boolean depending on validity of attributes.
-
-        attributes.is_a?(Hash)
-      end
-
-      def attribute_valid?(attribute_key, attribute_value)
-        # Determines if provided attribute_key and attribute_value are valid.
-        #
-        # attribute_key - Variable which needs to be validated.
-        # attribute_value - Variable which needs to be validated.
-        #
-        # Returns boolean depending on validity of attribute_key and attribute_value.
-
-        return false unless attribute_key.is_a?(String) || attribute_key.is_a?(Symbol)
-
-        return true if (boolean? attribute_value) || (attribute_value.is_a? String)
-
-        finite_number?(attribute_value)
-      end
-
-      def event_tags_valid?(event_tags)
-        # Determines if provided event tags are valid.
-        #
-        # event_tags - Event tags to be validated.
-        #
-        # Returns boolean depending on validity of event tags.
-
-        event_tags.is_a?(Hash)
-      end
-
-      def datafile_valid?(datafile)
-        # Determines if a given datafile is valid.
-        #
-        # datafile - String JSON representing the project.
-        #
-        # Returns boolean depending on validity of datafile.
-
-        begin
-          datafile = JSON.parse(datafile)
-        rescue
-          return false
-        end
-
-        JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA_V2, datafile)
-      end
-
-      def error_handler_valid?(error_handler)
-        # Determines if a given error handler is valid.
-        #
-        # error_handler - error_handler to be validated.
-        #
-        # Returns boolean depending on whether error_handler has a handle_error method.
-
-        error_handler.respond_to?(:handle_error)
-      end
-
-      def event_dispatcher_valid?(event_dispatcher)
-        # Determines if a given event dispatcher is valid.
-        #
-        # event_dispatcher - event_dispatcher to be validated.
-        #
-        # Returns boolean depending on whether event_dispatcher has a dispatch_event method.
-
-        event_dispatcher.respond_to?(:dispatch_event)
-      end
-
-      def logger_valid?(logger)
-        # Determines if a given logger is valid.
-        #
-        # logger - logger to be validated.
-        #
-        # Returns boolean depending on whether logger has a log method.
-
-        logger.respond_to?(:log)
-      end
-
-      def string_numeric?(str)
-        !Float(str).nil?
-      rescue
-        false
-      end
-
-      def inputs_valid?(variables, logger = NoOpLogger.new, level = Logger::ERROR)
-        # Determines if values of variables in given array are non empty string.
-        #
-        # variables - array values to validate.
-        #
-        # logger - logger.
-        #
-        # Returns boolean True if all of the values are valid, False otherwise.
-
-        return false unless variables.respond_to?(:each) && !variables.empty?
-
-        is_valid = true
-        if variables.include? :user_id
-          # Empty str is a valid user ID.
-          unless variables[:user_id].is_a?(String)
-            is_valid = false
-            logger.log(level, "#{Constants::INPUT_VARIABLES['USER_ID']} is invalid")
-          end
-          variables.delete :user_id
-        end
-
-        if variables.include? :variable_type
-          # Empty variable_type is a valid user ID.
-          unless variables[:variable_type].is_a?(String) || !variables[:variable_type]
-            is_valid = false
-            logger.log(level, "#{Constants::INPUT_VARIABLES['VARIABLE_TYPE']} is invalid")
-          end
-          variables.delete :variable_type
-        end
-
-        variables.each do |key, value|
-          next if value.is_a?(String) && !value.empty?
-
-          is_valid = false
-          next unless logger_valid?(logger) && level
-
-          logger.log(level, "#{Constants::INPUT_VARIABLES[key.to_s.upcase]} is invalid")
-        end
-        is_valid
-      end
-
-      def boolean?(value)
-        # Returns true if given value type is boolean.
-        #         false otherwise.
-
-        value.is_a?(TrueClass) || value.is_a?(FalseClass)
-      end
-
-      def same_types?(value_1, value_2)
-        # Returns true if given values are of same types.
-        #         false otherwise.
-        # Numeric values are considered as same type.
-
-        return true if value_1.is_a?(Numeric) && value_2.is_a?(Numeric)
-
-        return true if boolean?(value_1) && boolean?(value_2)
-
-        value_1.instance_of?(value_2.class)
-      end
-
-      def finite_number?(value)
-        # Returns true if the given value is a number, enforces
-        #   absolute limit of 2^53 and restricts NaN, Infinity, -Infinity.
-        #   false otherwise.
-
-        value.is_a?(Numeric) && value.to_f.finite? && value.abs <= Constants::FINITE_NUMBER_LIMIT
-      end
-
-      def odp_data_types_valid?(data)
-        valid_types = [String, Float, Integer, TrueClass, FalseClass, NilClass]
-        data&.values&.all? { |e| valid_types.member? e.class }
-      end
-
-      def segments_cache_valid?(segments_cache)
-        # Determines if a given segments_cache is valid.
-        #
-        # segments_cache - custom cache to be validated.
-        #
-        # Returns boolean depending on whether cache has required methods.
-
-        segments_cache.respond_to?(:reset) &&
-          segments_cache.method(:reset)&.parameters&.empty? &&
-          segments_cache.respond_to?(:lookup) &&
-          segments_cache.method(:lookup)&.parameters&.length&.positive? &&
-          segments_cache.respond_to?(:save) &&
-          segments_cache.method(:save)&.parameters&.length&.positive?
-      end
-
-      def segment_manager_valid?(segment_manager)
-        # Determines if a given segment_manager is valid.
-        #
-        # segment_manager - custom manager to be validated.
-        #
-        # Returns boolean depending on whether manager has required methods.
-
-        segment_manager.respond_to?(:odp_config) &&
-          segment_manager.respond_to?(:reset) &&
-          segment_manager.method(:reset)&.parameters&.empty? &&
-          segment_manager.respond_to?(:fetch_qualified_segments) &&
-          (segment_manager.method(:fetch_qualified_segments)&.parameters&.length || 0) >= 3
-      end
-
-      def event_manager_valid?(event_manager)
-        # Determines if a given event_manager is valid.
-        #
-        # event_manager - custom manager to be validated.
-        #
-        # Returns boolean depending on whether manager has required method and parameters.
-        return false unless
-          event_manager.respond_to?(:send_event) &&
-          event_manager.respond_to?(:start!) &&
-          (event_manager.method(:start!)&.parameters&.length || 0) >= 1 &&
-          event_manager.respond_to?(:update_config) &&
-          event_manager.respond_to?(:stop!)
-
-        required_parameters = Set[%i[keyreq type], %i[keyreq action], %i[keyreq identifiers], %i[keyreq data]]
-        existing_parameters = event_manager.method(:send_event).parameters.to_set
-
-        existing_parameters & required_parameters == required_parameters
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2016-2019, 2022-2023, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+require_relative 'constants'
+require 'json'
+require 'json-schema'
+
+module Optimizely
+  module Helpers
+    module Validator
+      module_function
+
+      def attributes_valid?(attributes)
+        # Determines if provided attributes are valid.
+        #
+        # attributes - User attributes to be validated.
+        #
+        # Returns boolean depending on validity of attributes.
+
+        attributes.is_a?(Hash)
+      end
+
+      def attribute_valid?(attribute_key, attribute_value)
+        # Determines if provided attribute_key and attribute_value are valid.
+        #
+        # attribute_key - Variable which needs to be validated.
+        # attribute_value - Variable which needs to be validated.
+        #
+        # Returns boolean depending on validity of attribute_key and attribute_value.
+
+        return false unless attribute_key.is_a?(String) || attribute_key.is_a?(Symbol)
+
+        return true if (boolean? attribute_value) || (attribute_value.is_a? String)
+
+        finite_number?(attribute_value)
+      end
+
+      def event_tags_valid?(event_tags)
+        # Determines if provided event tags are valid.
+        #
+        # event_tags - Event tags to be validated.
+        #
+        # Returns boolean depending on validity of event tags.
+
+        event_tags.is_a?(Hash)
+      end
+
+      def datafile_valid?(datafile)
+        # Determines if a given datafile is valid.
+        #
+        # datafile - String JSON representing the project.
+        #
+        # Returns boolean depending on validity of datafile.
+
+        begin
+          datafile = JSON.parse(datafile)
+        rescue
+          return false
+        end
+
+        JSON::Validator.validate(Helpers::Constants::JSON_SCHEMA_V2, datafile)
+      end
+
+      def error_handler_valid?(error_handler)
+        # Determines if a given error handler is valid.
+        #
+        # error_handler - error_handler to be validated.
+        #
+        # Returns boolean depending on whether error_handler has a handle_error method.
+
+        error_handler.respond_to?(:handle_error)
+      end
+
+      def event_dispatcher_valid?(event_dispatcher)
+        # Determines if a given event dispatcher is valid.
+        #
+        # event_dispatcher - event_dispatcher to be validated.
+        #
+        # Returns boolean depending on whether event_dispatcher has a dispatch_event method.
+
+        event_dispatcher.respond_to?(:dispatch_event)
+      end
+
+      def logger_valid?(logger)
+        # Determines if a given logger is valid.
+        #
+        # logger - logger to be validated.
+        #
+        # Returns boolean depending on whether logger has a log method.
+
+        logger.respond_to?(:log)
+      end
+
+      def string_numeric?(str)
+        !Float(str).nil?
+      rescue
+        false
+      end
+
+      def inputs_valid?(variables, logger = NoOpLogger.new, level = Logger::ERROR)
+        # Determines if values of variables in given array are non empty string.
+        #
+        # variables - array values to validate.
+        #
+        # logger - logger.
+        #
+        # Returns boolean True if all of the values are valid, False otherwise.
+
+        return false unless variables.respond_to?(:each) && !variables.empty?
+
+        is_valid = true # rubocop:disable Lint/UselessAssignment
+        if variables.include? :user_id
+          # Empty str is a valid user ID.
+          unless variables[:user_id].is_a?(String)
+            is_valid = false # rubocop:disable Lint/UselessAssignment
+            logger.log(level, "#{Constants::INPUT_VARIABLES['USER_ID']} is invalid")
+          end
+          variables.delete :user_id
+        end
+
+        if variables.include? :variable_type
+          # Empty variable_type is a valid user ID.
+          unless variables[:variable_type].is_a?(String) || !variables[:variable_type]
+            is_valid = false
+            logger.log(level, "#{Constants::INPUT_VARIABLES['VARIABLE_TYPE']} is invalid")
+          end
+          variables.delete :variable_type
+        end
+
+        variables.each do |key, value|
+          next if value.is_a?(String) && !value.empty?
+
+          is_valid = false
+          next unless logger_valid?(logger) && level
+
+          logger.log(level, "#{Constants::INPUT_VARIABLES[key.to_s.upcase]} is invalid")
+        end
+        is_valid
+      end
+
+      def boolean?(value)
+        # Returns true if given value type is boolean.
+        #         false otherwise.
+
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
+      end
+
+      def same_types?(value_1, value_2)
+        # Returns true if given values are of same types.
+        #         false otherwise.
+        # Numeric values are considered as same type.
+
+        return true if value_1.is_a?(Numeric) && value_2.is_a?(Numeric)
+
+        return true if boolean?(value_1) && boolean?(value_2)
+
+        value_1.instance_of?(value_2.class)
+      end
+
+      def finite_number?(value)
+        # Returns true if the given value is a number, enforces
+        #   absolute limit of 2^53 and restricts NaN, Infinity, -Infinity.
+        #   false otherwise.
+
+        value.is_a?(Numeric) && value.to_f.finite? && value.abs <= Constants::FINITE_NUMBER_LIMIT
+      end
+
+      def odp_data_types_valid?(data)
+        valid_types = [String, Float, Integer, TrueClass, FalseClass, NilClass]
+        data&.values&.all? { |e| valid_types.member? e.class }
+      end
+
+      def segments_cache_valid?(segments_cache)
+        # Determines if a given segments_cache is valid.
+        #
+        # segments_cache - custom cache to be validated.
+        #
+        # Returns boolean depending on whether cache has required methods.
+
+        segments_cache.respond_to?(:reset) &&
+          segments_cache.method(:reset)&.parameters&.empty? &&
+          segments_cache.respond_to?(:lookup) &&
+          segments_cache.method(:lookup)&.parameters&.length&.positive? &&
+          segments_cache.respond_to?(:save) &&
+          segments_cache.method(:save)&.parameters&.length&.positive?
+      end
+
+      def segment_manager_valid?(segment_manager)
+        # Determines if a given segment_manager is valid.
+        #
+        # segment_manager - custom manager to be validated.
+        #
+        # Returns boolean depending on whether manager has required methods.
+
+        segment_manager.respond_to?(:odp_config) &&
+          segment_manager.respond_to?(:reset) &&
+          segment_manager.method(:reset)&.parameters&.empty? &&
+          segment_manager.respond_to?(:fetch_qualified_segments) &&
+          (segment_manager.method(:fetch_qualified_segments)&.parameters&.length || 0) >= 3
+      end
+
+      def event_manager_valid?(event_manager)
+        # Determines if a given event_manager is valid.
+        #
+        # event_manager - custom manager to be validated.
+        #
+        # Returns boolean depending on whether manager has required method and parameters.
+        return false unless
+          event_manager.respond_to?(:send_event) &&
+          event_manager.respond_to?(:start!) &&
+          (event_manager.method(:start!)&.parameters&.length || 0) >= 1 &&
+          event_manager.respond_to?(:update_config) &&
+          event_manager.respond_to?(:stop!)
+
+        required_parameters = Set[%i[keyreq type], %i[keyreq action], %i[keyreq identifiers], %i[keyreq data]]
+        existing_parameters = event_manager.method(:send_event).parameters.to_set
+
+        existing_parameters & required_parameters == required_parameters
+      end
+    end
+  end
+end

data/lib/optimizely/helpers/variable_type.rb

@@ -1,67 +1,67 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2017, 2020, Optimizely and contributors
-#
-#    Licensed under the Apache License, Version 2.0 (the "License");
-#    you may not use this file except in compliance with the License.
-#    You may obtain a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the License is distributed on an "AS IS" BASIS,
-#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#    See the License for the specific language governing permissions and
-#    limitations under the License.
-#
-require 'optimizely/logger'
-
-module Optimizely
-  module Helpers
-    module VariableType
-      module_function
-
-      def cast_value_to_type(value, variable_type, logger)
-        # Attempts to cast the given value to the specified type
-        #
-        # value - The string value to cast
-        # variable_type - String variable type
-        #
-        # Returns the cast value or nil if not able to cast
-        return_value = nil
-
-        case variable_type
-        when 'boolean'
-          return_value = value == 'true'
-        when 'double'
-          begin
-            return_value = Float(value)
-          rescue => e
-            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
-                                      "'#{variable_type}': #{e.message}.")
-          end
-        when 'integer'
-          begin
-            return_value = Integer(value)
-          rescue => e
-            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
-                                      "'#{variable_type}': #{e.message}.")
-          end
-        when 'json'
-          begin
-            return_value = JSON.parse(value)
-          rescue => e
-            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
-                                      "'#{variable_type}': #{e.message}.")
-          end
-        else
-          # default case is string
-          return_value = value
-        end
-
-        return_value
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2017, 2020, Optimizely and contributors
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+require 'optimizely/logger'
+
+module Optimizely
+  module Helpers
+    module VariableType
+      module_function
+
+      def cast_value_to_type(value, variable_type, logger)
+        # Attempts to cast the given value to the specified type
+        #
+        # value - The string value to cast
+        # variable_type - String variable type
+        #
+        # Returns the cast value or nil if not able to cast
+        return_value = nil
+
+        case variable_type
+        when 'boolean'
+          return_value = value == 'true'
+        when 'double'
+          begin
+            return_value = Float(value)
+          rescue => e
+            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
+                                      "'#{variable_type}': #{e.message}.")
+          end
+        when 'integer'
+          begin
+            return_value = Integer(value)
+          rescue => e
+            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
+                                      "'#{variable_type}': #{e.message}.")
+          end
+        when 'json'
+          begin
+            return_value = JSON.parse(value)
+          rescue => e
+            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
+                                      "'#{variable_type}': #{e.message}.")
+          end
+        else
+          # default case is string
+          return_value = value
+        end
+
+        return_value
+      end
+    end
+  end
+end