optimizely-sdk 5.0.0.pre.beta → 5.0.1

data/lib/optimizely/odp/lru_cache.rb

@@ -1,114 +1,114 @@
-# 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.
-#
-
-module Optimizely
-  class LRUCache
-    # Least Recently Used cache that invalidates entries older than the timeout.
-
-    attr_reader :capacity, :timeout
-
-    def initialize(capacity, timeout_in_secs)
-      # @param capacity - The max size of the cache. If set <= 0, caching is disabled.
-      # @param timeout_in_secs - Seconds until a cache item is considered stale.
-      #                          If set <= 0, items never expire.
-      @cache_mutex = Mutex.new
-      @map = {}
-      @capacity = capacity
-      @timeout = timeout_in_secs
-    end
-
-    # Retrieve the non stale value from the cache corresponding to the provided key
-    # or nil if key is not found
-    # Moves the key/value pair to the end of the cache
-    #
-    # @param key - The key to retrieve
-
-    def lookup(key)
-      return nil if @capacity <= 0
-
-      @cache_mutex.synchronize do
-        return nil unless @map.include?(key)
-
-        element = @map.delete(key)
-        return nil if element.stale?(@timeout)
-
-        @map[key] = element
-
-        element.value
-      end
-    end
-
-    # Save a key/value pair into the cache
-    # Moves the key/value pair to the end of the cache
-    #
-    # @param key - A user key
-    # @param value - A user value
-
-    def save(key, value)
-      return if @capacity <= 0
-
-      @cache_mutex.synchronize do
-        @map.delete(key) if @map.key?(key)
-
-        @map[key] = CacheElement.new(value)
-
-        @map.delete(@map.first[0]) if @map.size > @capacity
-        nil
-      end
-    end
-
-    # Clears the cache
-
-    def reset
-      return if @capacity <= 0
-
-      @cache_mutex.synchronize { @map.clear }
-      nil
-    end
-
-    # Retrieve a value from the cache for a given key or nil if key is not found
-    # Doesn't update the cache
-    #
-    # @param key - The key to retrieve
-
-    def peek(key)
-      return nil if @capacity <= 0
-
-      @cache_mutex.synchronize { @map[key]&.value }
-    end
-  end
-
-  class CacheElement
-    # Individual element for the LRUCache.
-    attr_reader :value, :timestamp
-
-    def initialize(value)
-      @value = value
-      @timestamp = Time.new
-    end
-
-    def stale?(timeout)
-      # Returns true if the provided timeout has passed since the element's timestamp.
-      #
-      # @param timeout - The duration to check against
-      return false if timeout <= 0
-
-      Time.new - @timestamp >= timeout
-    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.
+#
+
+module Optimizely
+  class LRUCache
+    # Least Recently Used cache that invalidates entries older than the timeout.
+
+    attr_reader :capacity, :timeout
+
+    def initialize(capacity, timeout_in_secs)
+      # @param capacity - The max size of the cache. If set <= 0, caching is disabled.
+      # @param timeout_in_secs - Seconds until a cache item is considered stale.
+      #                          If set <= 0, items never expire.
+      @cache_mutex = Mutex.new
+      @map = {}
+      @capacity = capacity
+      @timeout = timeout_in_secs
+    end
+
+    # Retrieve the non stale value from the cache corresponding to the provided key
+    # or nil if key is not found
+    # Moves the key/value pair to the end of the cache
+    #
+    # @param key - The key to retrieve
+
+    def lookup(key)
+      return nil if @capacity <= 0
+
+      @cache_mutex.synchronize do
+        return nil unless @map.include?(key)
+
+        element = @map.delete(key)
+        return nil if element.stale?(@timeout)
+
+        @map[key] = element
+
+        element.value
+      end
+    end
+
+    # Save a key/value pair into the cache
+    # Moves the key/value pair to the end of the cache
+    #
+    # @param key - A user key
+    # @param value - A user value
+
+    def save(key, value)
+      return if @capacity <= 0
+
+      @cache_mutex.synchronize do
+        @map.delete(key) if @map.key?(key)
+
+        @map[key] = CacheElement.new(value)
+
+        @map.delete(@map.first[0]) if @map.size > @capacity
+        nil
+      end
+    end
+
+    # Clears the cache
+
+    def reset
+      return if @capacity <= 0
+
+      @cache_mutex.synchronize { @map.clear }
+      nil
+    end
+
+    # Retrieve a value from the cache for a given key or nil if key is not found
+    # Doesn't update the cache
+    #
+    # @param key - The key to retrieve
+
+    def peek(key)
+      return nil if @capacity <= 0
+
+      @cache_mutex.synchronize { @map[key]&.value }
+    end
+  end
+
+  class CacheElement
+    # Individual element for the LRUCache.
+    attr_reader :value, :timestamp
+
+    def initialize(value)
+      @value = value
+      @timestamp = Time.new
+    end
+
+    def stale?(timeout)
+      # Returns true if the provided timeout has passed since the element's timestamp.
+      #
+      # @param timeout - The duration to check against
+      return false if timeout <= 0
+
+      Time.new - @timestamp >= timeout
+    end
+  end
+end

data/lib/optimizely/odp/odp_config.rb

@@ -1,102 +1,102 @@
-# 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 'optimizely/logger'
-require_relative '../helpers/constants'
-
-module Optimizely
-  class OdpConfig
-    ODP_CONFIG_STATE = Helpers::Constants::ODP_CONFIG_STATE
-    # Contains configuration used for ODP integration.
-    #
-    # @param api_host - The host URL for the ODP audience segments API (optional).
-    # @param api_key - The public API key for the ODP account from which the audience segments will be fetched (optional).
-    # @param segments_to_check - An array of all ODP segments used in the current datafile (associated with api_host/api_key).
-    def initialize(api_key = nil, api_host = nil, segments_to_check = [])
-      @api_key = api_key
-      @api_host = api_host
-      @segments_to_check = segments_to_check
-      @mutex = Mutex.new
-      @odp_state = @api_host.nil? || @api_key.nil? ? ODP_CONFIG_STATE[:UNDETERMINED] : ODP_CONFIG_STATE[:INTEGRATED]
-    end
-
-    # Replaces the existing configuration
-    #
-    # @param api_host - The host URL for the ODP audience segments API (optional).
-    # @param api_key - The public API key for the ODP account from which the audience segments will be fetched (optional).
-    # @param segments_to_check - An array of all ODP segments used in the current datafile (associated with api_host/api_key).
-    #
-    # @return - True if the provided values were different than the existing values.
-
-    def update(api_key = nil, api_host = nil, segments_to_check = [])
-      updated = false
-      @mutex.synchronize do
-        @odp_state = api_host.nil? || api_key.nil? ? ODP_CONFIG_STATE[:NOT_INTEGRATED] : ODP_CONFIG_STATE[:INTEGRATED]
-
-        if @api_key != api_key || @api_host != api_host || @segments_to_check != segments_to_check
-          @api_key = api_key
-          @api_host = api_host
-          @segments_to_check = segments_to_check
-          updated = true
-        end
-      end
-
-      updated
-    end
-
-    # Returns the api host for odp connections
-    #
-    # @return - The api host.
-
-    def api_host
-      @mutex.synchronize { @api_host.clone }
-    end
-
-    # Returns the api key for odp connections
-    #
-    # @return - The api key.
-
-    def api_key
-      @mutex.synchronize { @api_key.clone }
-    end
-
-    # Returns An array of qualified segments for this user
-    #
-    # @return - An array of segments names.
-
-    def segments_to_check
-      @mutex.synchronize { @segments_to_check.clone }
-    end
-
-    # Replace qualified segments with provided segments
-    #
-    # @param segments - An array of segment names
-
-    def segments_to_check=(segments_to_check)
-      @mutex.synchronize { @segments_to_check = segments_to_check.clone }
-    end
-
-    # Returns the state of odp integration (UNDETERMINED, INTEGRATED, NOT_INTEGRATED)
-    #
-    # @return - string
-
-    def odp_state
-      @mutex.synchronize { @odp_state }
-    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 'optimizely/logger'
+require_relative '../helpers/constants'
+
+module Optimizely
+  class OdpConfig
+    ODP_CONFIG_STATE = Helpers::Constants::ODP_CONFIG_STATE
+    # Contains configuration used for ODP integration.
+    #
+    # @param api_host - The host URL for the ODP audience segments API (optional).
+    # @param api_key - The public API key for the ODP account from which the audience segments will be fetched (optional).
+    # @param segments_to_check - An array of all ODP segments used in the current datafile (associated with api_host/api_key).
+    def initialize(api_key = nil, api_host = nil, segments_to_check = [])
+      @api_key = api_key
+      @api_host = api_host
+      @segments_to_check = segments_to_check
+      @mutex = Mutex.new
+      @odp_state = @api_host.nil? || @api_key.nil? ? ODP_CONFIG_STATE[:UNDETERMINED] : ODP_CONFIG_STATE[:INTEGRATED]
+    end
+
+    # Replaces the existing configuration
+    #
+    # @param api_host - The host URL for the ODP audience segments API (optional).
+    # @param api_key - The public API key for the ODP account from which the audience segments will be fetched (optional).
+    # @param segments_to_check - An array of all ODP segments used in the current datafile (associated with api_host/api_key).
+    #
+    # @return - True if the provided values were different than the existing values.
+
+    def update(api_key = nil, api_host = nil, segments_to_check = [])
+      updated = false
+      @mutex.synchronize do
+        @odp_state = api_host.nil? || api_key.nil? ? ODP_CONFIG_STATE[:NOT_INTEGRATED] : ODP_CONFIG_STATE[:INTEGRATED]
+
+        if @api_key != api_key || @api_host != api_host || @segments_to_check != segments_to_check
+          @api_key = api_key
+          @api_host = api_host
+          @segments_to_check = segments_to_check
+          updated = true
+        end
+      end
+
+      updated
+    end
+
+    # Returns the api host for odp connections
+    #
+    # @return - The api host.
+
+    def api_host
+      @mutex.synchronize { @api_host.clone }
+    end
+
+    # Returns the api key for odp connections
+    #
+    # @return - The api key.
+
+    def api_key
+      @mutex.synchronize { @api_key.clone }
+    end
+
+    # Returns An array of qualified segments for this user
+    #
+    # @return - An array of segments names.
+
+    def segments_to_check
+      @mutex.synchronize { @segments_to_check.clone }
+    end
+
+    # Replace qualified segments with provided segments
+    #
+    # @param segments - An array of segment names
+
+    def segments_to_check=(segments_to_check)
+      @mutex.synchronize { @segments_to_check = segments_to_check.clone }
+    end
+
+    # Returns the state of odp integration (UNDETERMINED, INTEGRATED, NOT_INTEGRATED)
+    #
+    # @return - string
+
+    def odp_state
+      @mutex.synchronize { @odp_state }
+    end
+  end
+end

data/lib/optimizely/odp/odp_event.rb

@@ -1,75 +1,75 @@
-# 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 'json'
-require_relative '../helpers/constants'
-
-module Optimizely
-  class OdpEvent
-    # Representation of an odp event which can be sent to the Optimizely odp platform.
-
-    KEY_FOR_USER_ID = Helpers::Constants::ODP_MANAGER_CONFIG[:KEY_FOR_USER_ID]
-
-    def initialize(type:, action:, identifiers:, data:)
-      @type = type
-      @action = action
-      @identifiers = convert_identifiers(identifiers)
-      @data = add_common_event_data(data)
-    end
-
-    def add_common_event_data(custom_data)
-      data = {
-        idempotence_id: SecureRandom.uuid,
-        data_source_type: 'sdk',
-        data_source: 'ruby-sdk',
-        data_source_version: VERSION
-      }
-      data.update(custom_data)
-      data
-    end
-
-    def convert_identifiers(identifiers)
-      # Convert incorrect case/separator of identifier key `fs_user_id`
-      # (ie. `fs-user-id`, `FS_USER_ID`).
-
-      identifiers.clone.each_key do |key|
-        break if key == KEY_FOR_USER_ID
-
-        if ['fs-user-id', KEY_FOR_USER_ID].include?(key.downcase)
-          identifiers[KEY_FOR_USER_ID] = identifiers.delete(key)
-          break
-        end
-      end
-
-      identifiers
-    end
-
-    def to_json(*_args)
-      {
-        type: @type,
-        action: @action,
-        identifiers: @identifiers,
-        data: @data
-      }.to_json
-    end
-
-    def ==(other)
-      to_json == other.to_json
-    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 'json'
+require_relative '../helpers/constants'
+
+module Optimizely
+  class OdpEvent
+    # Representation of an odp event which can be sent to the Optimizely odp platform.
+
+    KEY_FOR_USER_ID = Helpers::Constants::ODP_MANAGER_CONFIG[:KEY_FOR_USER_ID]
+
+    def initialize(type:, action:, identifiers:, data:)
+      @type = type
+      @action = action
+      @identifiers = convert_identifiers(identifiers)
+      @data = add_common_event_data(data)
+    end
+
+    def add_common_event_data(custom_data)
+      data = {
+        idempotence_id: SecureRandom.uuid,
+        data_source_type: 'sdk',
+        data_source: 'ruby-sdk',
+        data_source_version: VERSION
+      }
+      data.update(custom_data)
+      data
+    end
+
+    def convert_identifiers(identifiers)
+      # Convert incorrect case/separator of identifier key `fs_user_id`
+      # (ie. `fs-user-id`, `FS_USER_ID`).
+
+      identifiers.clone.each_key do |key|
+        break if key == KEY_FOR_USER_ID
+
+        if ['fs-user-id', KEY_FOR_USER_ID].include?(key.downcase)
+          identifiers[KEY_FOR_USER_ID] = identifiers.delete(key)
+          break
+        end
+      end
+
+      identifiers
+    end
+
+    def to_json(*_args)
+      {
+        type: @type,
+        action: @action,
+        identifiers: @identifiers,
+        data: @data
+      }.to_json
+    end
+
+    def ==(other)
+      to_json == other.to_json
+    end
+  end
+end