optimizely-sdk 5.0.0 → 5.1.0

data/lib/optimizely/helpers/date_time_utils.rb

@@ -1,30 +1,30 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2019, 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.
-#
-module Optimizely
-  module Helpers
-    module DateTimeUtils
-      module_function
-
-      def create_timestamp
-        # Returns Integer current UTC timestamp
-        utc = Time.now.getutc
-        (utc.to_f * 1000).to_i
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, 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.
+#
+module Optimizely
+  module Helpers
+    module DateTimeUtils
+      module_function
+
+      def create_timestamp
+        # Returns Integer current UTC timestamp
+        utc = Time.now.getutc
+        (utc.to_f * 1000).to_i
+      end
+    end
+  end
+end

data/lib/optimizely/helpers/event_tag_utils.rb

@@ -1,132 +1,132 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2017-2018, 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'
-require 'optimizely/helpers/validator'
-
-module Optimizely
-  module Helpers
-    module EventTagUtils
-      module_function
-
-      REVENUE_EVENT_METRIC_NAME = 'revenue'
-      NUMERIC_EVENT_METRIC_NAME = 'value'
-
-      def get_revenue_value(event_tags, logger)
-        # Grab the revenue value from the event tags. "revenue" is a reserved keyword.
-        # The value will be parsed to an integer if possible.
-        # Example:
-        #   4.0 or "4.0" will be parsed to int(4).
-        #   4.1 will not be parsed and the method will return nil.
-        # event_tags - Hash representing metadata associated with the event.
-        # logger - Optional component which provides a log method to log messages.
-        #
-        # Returns revenue value as an integer number
-        # Returns nil if revenue can't be retrieved from the event tags.
-
-        if event_tags.nil?
-          logger.log(Logger::DEBUG, 'Event tags is undefined.')
-          return nil
-        end
-
-        unless Helpers::Validator.event_tags_valid?(event_tags)
-          logger.log(Logger::DEBUG, 'Event tags is not a hash.')
-          return nil
-        end
-
-        unless event_tags.key?(REVENUE_EVENT_METRIC_NAME)
-          logger.log(Logger::DEBUG, 'The revenue key is not defined in the event tags.')
-          return nil
-        end
-
-        if event_tags[REVENUE_EVENT_METRIC_NAME].nil?
-          logger.log(Logger::DEBUG, 'The revenue key is nil.')
-          return nil
-        end
-
-        raw_value = event_tags[REVENUE_EVENT_METRIC_NAME]
-
-        unless Helpers::Validator.string_numeric?(raw_value)
-          logger.log(Logger::WARN, 'Revenue value is not an integer or float, or is not a numeric string.')
-          return nil
-        end
-
-        raw_value = raw_value.to_f if raw_value.is_a? String
-
-        unless raw_value == raw_value.to_i
-          logger.log(Logger::WARN, "Failed to parse revenue value #{raw_value} from event tags.")
-          return nil
-        end
-
-        logger.log(Logger::INFO, "Parsed revenue value #{raw_value.to_i} from event tags.")
-        raw_value.to_i
-      end
-
-      def get_numeric_value(event_tags, logger)
-        # Grab the numeric event value from the event tags. "value" is a reserved keyword.
-        # The value of 'value' can be a float or a numeric string
-        #
-        # event_tags - +Hash+ representing metadata associated with the event.
-        # logger - Optional component which provides a log method to log messages.
-        # Returns  +Number+ | +nil+ if value can't be retrieved from the event tags.
-
-        if event_tags.nil?
-          logger.log(Logger::DEBUG, 'Event tags is undefined.')
-          return nil
-        end
-
-        unless Helpers::Validator.event_tags_valid?(event_tags)
-          logger.log(Logger::DEBUG, 'Event tags is not a dictionary.')
-          return nil
-        end
-
-        unless event_tags.key?(NUMERIC_EVENT_METRIC_NAME)
-          logger.log(Logger::DEBUG, 'The numeric metric key is not defined in the event tags.')
-          return nil
-        end
-
-        if event_tags[NUMERIC_EVENT_METRIC_NAME].nil?
-          logger.log(Logger::DEBUG, 'The numeric metric key is null.')
-          return nil
-        end
-
-        raw_value = event_tags[NUMERIC_EVENT_METRIC_NAME]
-
-        if raw_value.is_a?(TrueClass) || raw_value.is_a?(FalseClass)
-          logger.log(Logger::DEBUG, 'Provided numeric value is a boolean, which is an invalid format.')
-          return nil
-        end
-
-        if raw_value.is_a?(Array) || raw_value.is_a?(Hash) || raw_value.to_f.nan? || raw_value.to_f.infinite?
-          logger.log(Logger::DEBUG, 'Provided numeric value is in an invalid format.')
-          return nil
-        end
-
-        unless Helpers::Validator.string_numeric?(raw_value)
-          logger.log(Logger::DEBUG, 'Provided numeric value is not a numeric string.')
-          return nil
-        end
-
-        raw_value = raw_value.to_f
-
-        logger.log(Logger::INFO, "The numeric metric value #{raw_value} will be sent to results.")
-
-        raw_value
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2017-2018, 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'
+require 'optimizely/helpers/validator'
+
+module Optimizely
+  module Helpers
+    module EventTagUtils
+      module_function
+
+      REVENUE_EVENT_METRIC_NAME = 'revenue'
+      NUMERIC_EVENT_METRIC_NAME = 'value'
+
+      def get_revenue_value(event_tags, logger)
+        # Grab the revenue value from the event tags. "revenue" is a reserved keyword.
+        # The value will be parsed to an integer if possible.
+        # Example:
+        #   4.0 or "4.0" will be parsed to int(4).
+        #   4.1 will not be parsed and the method will return nil.
+        # event_tags - Hash representing metadata associated with the event.
+        # logger - Optional component which provides a log method to log messages.
+        #
+        # Returns revenue value as an integer number
+        # Returns nil if revenue can't be retrieved from the event tags.
+
+        if event_tags.nil?
+          logger.log(Logger::DEBUG, 'Event tags is undefined.')
+          return nil
+        end
+
+        unless Helpers::Validator.event_tags_valid?(event_tags)
+          logger.log(Logger::DEBUG, 'Event tags is not a hash.')
+          return nil
+        end
+
+        unless event_tags.key?(REVENUE_EVENT_METRIC_NAME)
+          logger.log(Logger::DEBUG, 'The revenue key is not defined in the event tags.')
+          return nil
+        end
+
+        if event_tags[REVENUE_EVENT_METRIC_NAME].nil?
+          logger.log(Logger::DEBUG, 'The revenue key is nil.')
+          return nil
+        end
+
+        raw_value = event_tags[REVENUE_EVENT_METRIC_NAME]
+
+        unless Helpers::Validator.string_numeric?(raw_value)
+          logger.log(Logger::WARN, 'Revenue value is not an integer or float, or is not a numeric string.')
+          return nil
+        end
+
+        raw_value = raw_value.to_f if raw_value.is_a? String
+
+        unless raw_value == raw_value.to_i
+          logger.log(Logger::WARN, "Failed to parse revenue value #{raw_value} from event tags.")
+          return nil
+        end
+
+        logger.log(Logger::INFO, "Parsed revenue value #{raw_value.to_i} from event tags.")
+        raw_value.to_i
+      end
+
+      def get_numeric_value(event_tags, logger)
+        # Grab the numeric event value from the event tags. "value" is a reserved keyword.
+        # The value of 'value' can be a float or a numeric string
+        #
+        # event_tags - +Hash+ representing metadata associated with the event.
+        # logger - Optional component which provides a log method to log messages.
+        # Returns  +Number+ | +nil+ if value can't be retrieved from the event tags.
+
+        if event_tags.nil?
+          logger.log(Logger::DEBUG, 'Event tags is undefined.')
+          return nil
+        end
+
+        unless Helpers::Validator.event_tags_valid?(event_tags)
+          logger.log(Logger::DEBUG, 'Event tags is not a dictionary.')
+          return nil
+        end
+
+        unless event_tags.key?(NUMERIC_EVENT_METRIC_NAME)
+          logger.log(Logger::DEBUG, 'The numeric metric key is not defined in the event tags.')
+          return nil
+        end
+
+        if event_tags[NUMERIC_EVENT_METRIC_NAME].nil?
+          logger.log(Logger::DEBUG, 'The numeric metric key is null.')
+          return nil
+        end
+
+        raw_value = event_tags[NUMERIC_EVENT_METRIC_NAME]
+
+        if raw_value.is_a?(TrueClass) || raw_value.is_a?(FalseClass)
+          logger.log(Logger::DEBUG, 'Provided numeric value is a boolean, which is an invalid format.')
+          return nil
+        end
+
+        if raw_value.is_a?(Array) || raw_value.is_a?(Hash) || raw_value.to_f.nan? || raw_value.to_f.infinite?
+          logger.log(Logger::DEBUG, 'Provided numeric value is in an invalid format.')
+          return nil
+        end
+
+        unless Helpers::Validator.string_numeric?(raw_value)
+          logger.log(Logger::DEBUG, 'Provided numeric value is not a numeric string.')
+          return nil
+        end
+
+        raw_value = raw_value.to_f
+
+        logger.log(Logger::INFO, "The numeric metric value #{raw_value} will be sent to results.")
+
+        raw_value
+      end
+    end
+  end
+end

data/lib/optimizely/helpers/group.rb

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2016-2017, 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.
-#
-module Optimizely
-  module Helpers
-    module Group
-      OVERLAPPING_POLICY = 'overlapping'
-      RANDOM_POLICY = 'random'
-
-      module_function
-
-      def random_policy?(group)
-        group['policy'] == RANDOM_POLICY
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2016-2017, 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.
+#
+module Optimizely
+  module Helpers
+    module Group
+      OVERLAPPING_POLICY = 'overlapping'
+      RANDOM_POLICY = 'random'
+
+      module_function
+
+      def random_policy?(group)
+        group['policy'] == RANDOM_POLICY
+      end
+    end
+  end
+end

data/lib/optimizely/helpers/http_utils.rb

@@ -1,68 +1,68 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2020, 2022, 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 'net/http'
-require_relative '../exceptions'
-
-module Optimizely
-  module Helpers
-    module HttpUtils
-      module_function
-
-      def make_request(url, http_method, request_body = nil, headers = {}, read_timeout = nil, proxy_config = nil) # rubocop:disable Metrics/ParameterLists
-        # makes http/https GET/POST request and returns response
-        #
-        uri = URI.parse(url)
-
-        raise HTTPUriError unless uri.respond_to?(:request_uri)
-
-        case http_method
-        when :get
-          request = Net::HTTP::Get.new(uri.request_uri)
-        when :post
-          request = Net::HTTP::Post.new(uri.request_uri)
-          request.body = request_body if request_body
-        else
-          return nil
-        end
-
-        # set headers
-        headers&.each do |key, val|
-          request[key] = val
-        end
-
-        # do not try to make request with proxy unless we have at least a host
-        http_class = if proxy_config&.host
-                       Net::HTTP::Proxy(
-                         proxy_config.host,
-                         proxy_config.port,
-                         proxy_config.username,
-                         proxy_config.password
-                       )
-                     else
-                       Net::HTTP
-                     end
-
-        http = http_class.new(uri.host, uri.port)
-        http.read_timeout = read_timeout if read_timeout
-        http.use_ssl = uri.scheme == 'https'
-        http.request(request)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2020, 2022, 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 'net/http'
+require_relative '../exceptions'
+
+module Optimizely
+  module Helpers
+    module HttpUtils
+      module_function
+
+      def make_request(url, http_method, request_body = nil, headers = {}, read_timeout = nil, proxy_config = nil) # rubocop:disable Metrics/ParameterLists
+        # makes http/https GET/POST request and returns response
+        #
+        uri = URI.parse(url)
+
+        raise HTTPUriError unless uri.respond_to?(:request_uri)
+
+        case http_method
+        when :get
+          request = Net::HTTP::Get.new(uri.request_uri)
+        when :post
+          request = Net::HTTP::Post.new(uri.request_uri)
+          request.body = request_body if request_body
+        else
+          return nil
+        end
+
+        # set headers
+        headers&.each do |key, val|
+          request[key] = val
+        end
+
+        # do not try to make request with proxy unless we have at least a host
+        http_class = if proxy_config&.host
+                       Net::HTTP::Proxy(
+                         proxy_config.host,
+                         proxy_config.port,
+                         proxy_config.username,
+                         proxy_config.password
+                       )
+                     else
+                       Net::HTTP
+                     end
+
+        http = http_class.new(uri.host, uri.port)
+        http.read_timeout = read_timeout if read_timeout
+        http.use_ssl = uri.scheme == 'https'
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/optimizely/helpers/sdk_settings.rb

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2022, 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'
-
-module Optimizely
-  module Helpers
-    class OptimizelySdkSettings
-      attr_accessor :odp_disabled, :segments_cache_size, :segments_cache_timeout_in_secs, :odp_segments_cache, :odp_segment_manager,
-                    :odp_event_manager, :fetch_segments_timeout, :odp_event_timeout, :odp_flush_interval
-
-      # Contains configuration used for Optimizely Project initialization.
-      #
-      # @param disable_odp - Set this flag to true (default = false) to disable ODP features.
-      # @param segments_cache_size - The maximum size of audience segments cache (optional. default = 10,000). Set to zero to disable caching.
-      # @param segments_cache_timeout_in_secs - The timeout in seconds of audience segments cache (optional. default = 600). Set to zero to disable timeout.
-      # @param odp_segments_cache - A custom odp segments cache. Required methods include: `save(key, value)`, `lookup(key) -> value`, and `reset()`
-      # @param odp_segment_manager - A custom odp segment manager. Required method is: `fetch_qualified_segments(user_key, user_value, options)`.
-      # @param odp_event_manager - A custom odp event manager. Required method is: `send_event(type:, action:, identifiers:, data:)`
-      # @param odp_segment_request_timeout - Time to wait in seconds for fetch_qualified_segments (optional. default = 10).
-      # @param odp_event_request_timeout - Time to wait in seconds for send_odp_events (optional. default = 10).
-      # @param odp_event_flush_interval - Time to wait in seconds for odp events to accumulate before sending (optional. default = 1).
-      def initialize(
-        disable_odp: false,
-        segments_cache_size: Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_CAPACITY],
-        segments_cache_timeout_in_secs: Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_TIMEOUT_SECONDS],
-        odp_segments_cache: nil,
-        odp_segment_manager: nil,
-        odp_event_manager: nil,
-        odp_segment_request_timeout: nil,
-        odp_event_request_timeout: nil,
-        odp_event_flush_interval: nil
-      )
-        @odp_disabled = disable_odp
-        @segments_cache_size = segments_cache_size
-        @segments_cache_timeout_in_secs = segments_cache_timeout_in_secs
-        @odp_segments_cache = odp_segments_cache
-        @odp_segment_manager = odp_segment_manager
-        @odp_event_manager = odp_event_manager
-        @fetch_segments_timeout = odp_segment_request_timeout
-        @odp_event_timeout = odp_event_request_timeout
-        @odp_flush_interval = odp_event_flush_interval
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2022, 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'
+
+module Optimizely
+  module Helpers
+    class OptimizelySdkSettings
+      attr_accessor :odp_disabled, :segments_cache_size, :segments_cache_timeout_in_secs, :odp_segments_cache, :odp_segment_manager,
+                    :odp_event_manager, :fetch_segments_timeout, :odp_event_timeout, :odp_flush_interval
+
+      # Contains configuration used for Optimizely Project initialization.
+      #
+      # @param disable_odp - Set this flag to true (default = false) to disable ODP features.
+      # @param segments_cache_size - The maximum size of audience segments cache (optional. default = 10,000). Set to zero to disable caching.
+      # @param segments_cache_timeout_in_secs - The timeout in seconds of audience segments cache (optional. default = 600). Set to zero to disable timeout.
+      # @param odp_segments_cache - A custom odp segments cache. Required methods include: `save(key, value)`, `lookup(key) -> value`, and `reset()`
+      # @param odp_segment_manager - A custom odp segment manager. Required method is: `fetch_qualified_segments(user_key, user_value, options)`.
+      # @param odp_event_manager - A custom odp event manager. Required method is: `send_event(type:, action:, identifiers:, data:)`
+      # @param odp_segment_request_timeout - Time to wait in seconds for fetch_qualified_segments (optional. default = 10).
+      # @param odp_event_request_timeout - Time to wait in seconds for send_odp_events (optional. default = 10).
+      # @param odp_event_flush_interval - Time to wait in seconds for odp events to accumulate before sending (optional. default = 1).
+      def initialize(
+        disable_odp: false,
+        segments_cache_size: Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_CAPACITY],
+        segments_cache_timeout_in_secs: Constants::ODP_SEGMENTS_CACHE_CONFIG[:DEFAULT_TIMEOUT_SECONDS],
+        odp_segments_cache: nil,
+        odp_segment_manager: nil,
+        odp_event_manager: nil,
+        odp_segment_request_timeout: nil,
+        odp_event_request_timeout: nil,
+        odp_event_flush_interval: nil
+      )
+        @odp_disabled = disable_odp
+        @segments_cache_size = segments_cache_size
+        @segments_cache_timeout_in_secs = segments_cache_timeout_in_secs
+        @odp_segments_cache = odp_segments_cache
+        @odp_segment_manager = odp_segment_manager
+        @odp_event_manager = odp_event_manager
+        @fetch_segments_timeout = odp_segment_request_timeout
+        @odp_event_timeout = odp_event_request_timeout
+        @odp_flush_interval = odp_event_flush_interval
+      end
+    end
+  end
+end