optimizely-sdk 5.0.0.pre.beta → 5.0.0

data/lib/optimizely/config_manager/http_project_config_manager.rb

@@ -102,11 +102,6 @@ module Optimizely
     end
 
     def start!
-      if @stopped
-        @logger.log(Logger::WARN, 'Not starting. Already stopped.')
-        return
-      end
-
       @async_scheduler.start!
       @stopped = false
     end
@@ -146,7 +141,7 @@ module Optimizely
     end
 
     def optimizely_config
-      @optimizely_config = OptimizelyConfig.new(@config).config if @optimizely_config.nil?
+      @optimizely_config = OptimizelyConfig.new(@config, @logger).config if @optimizely_config.nil?
 
       @optimizely_config
     end
@@ -268,6 +263,13 @@ module Optimizely
         return
       end
 
+      if polling_interval < 30
+        @logger.log(
+          Logger::WARN,
+          'Polling intervals below 30 seconds are not recommended.'
+        )
+      end
+
       @polling_interval = polling_interval
     end
 

data/lib/optimizely/config_manager/static_project_config_manager.rb

@@ -41,12 +41,13 @@ module Optimizely
         error_handler,
         skip_json_validation
       )
+      @logger = logger
       @sdk_key = @config&.sdk_key
       @optimizely_config = nil
     end
 
     def optimizely_config
-      @optimizely_config = OptimizelyConfig.new(@config).config if @optimizely_config.nil?
+      @optimizely_config = OptimizelyConfig.new(@config, @logger).config if @optimizely_config.nil?
 
       @optimizely_config
     end

data/lib/optimizely/event/event_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019-2020, 2022, Optimizely and contributors
+#    Copyright 2019-2020, 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.
@@ -72,7 +72,7 @@ module Optimizely
 
       def build_attribute_list(user_attributes, project_config)
         visitor_attributes = []
-        user_attributes&.keys&.each do |attribute_key|
+        user_attributes&.each_key do |attribute_key|
           # Omit attribute values that are not supported by the log endpoint.
           attribute_value = user_attributes[attribute_key]
           next unless Helpers::Validator.attribute_valid?(attribute_key, attribute_value)

data/lib/optimizely/event_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2019, 2022, Optimizely and contributors
+#    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.
@@ -62,20 +62,20 @@ module Optimizely
 
       visitor_attributes = []
 
-      attributes&.keys&.each do |attribute_key|
+      attributes&.each_key do |attribute_key|
         # Omit attribute values that are not supported by the log endpoint.
         attribute_value = attributes[attribute_key]
-        if Helpers::Validator.attribute_valid?(attribute_key, attribute_value)
-          attribute_id = project_config.get_attribute_id attribute_key
-          if attribute_id
-            visitor_attributes.push(
-              entity_id: attribute_id,
-              key: attribute_key,
-              type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
-              value: attribute_value
-            )
-          end
-        end
+        next unless Helpers::Validator.attribute_valid?(attribute_key, attribute_value)
+
+        attribute_id = project_config.get_attribute_id attribute_key
+        next unless attribute_id
+
+        visitor_attributes.push(
+          entity_id: attribute_id,
+          key: attribute_key,
+          type: CUSTOM_ATTRIBUTE_FEATURE_TYPE,
+          value: attribute_value
+        )
       end
       # Append Bot Filtering Attribute
       if project_config.bot_filtering == true || project_config.bot_filtering == false

data/lib/optimizely/exceptions.rb

@@ -42,16 +42,28 @@ module Optimizely
   class InvalidAudienceError < Error
     # Raised when an invalid audience is provided
 
-    def initialize(msg = 'Provided audience is not in datafile.')
-      super
+    attr_reader :audience_id
+
+    def initialize(audience_id)
+      raise ArgumentError, 'audience_id must be provided' if audience_id.nil?
+
+      super("Audience id '#{audience_id}' is not in datafile.")
+
+      @audience_id = audience_id
     end
   end
 
   class InvalidAttributeError < Error
     # Raised when an invalid attribute is provided
 
-    def initialize(msg = 'Provided attribute is not in datafile.')
-      super
+    attr_reader :attribute_key
+
+    def initialize(attribute_key)
+      raise ArgumentError, 'attribute_key must be provided' if attribute_key.nil?
+
+      super("Attribute key '#{attribute_key}' is not in datafile.")
+
+      @attribute_key = attribute_key
     end
   end
 
@@ -74,24 +86,56 @@ module Optimizely
   class InvalidExperimentError < Error
     # Raised when an invalid experiment key is provided
 
-    def initialize(msg = 'Provided experiment is not in datafile.')
-      super
+    attr_reader :experiment_id, :experiment_key
+
+    def initialize(experiment_id: nil, experiment_key: nil)
+      raise ArgumentError, 'Either experiment_id or experiment_key must be provided.' if experiment_id.nil? && experiment_key.nil?
+      raise ArgumentError, 'Cannot provide both experiment_id and experiment_key.' if !experiment_id.nil? && !experiment_key.nil?
+
+      if experiment_id.nil?
+        @experiment_key = experiment_key
+        identifier = "key '#{@experiment_key}'"
+      else
+        @experiment_id = experiment_id
+        identifier = "id '#{@experiment_id}'"
+      end
+
+      super("Experiment #{identifier} is not in datafile.")
     end
   end
 
   class InvalidEventError < Error
     # Raised when an invalid event key is provided
 
-    def initialize(msg = 'Provided event is not in datafile.')
-      super
+    attr_reader :event_key
+
+    def initialize(event_key)
+      raise ArgumentError, 'event_key must be provided.' if event_key.nil?
+
+      super("Event key '#{event_key}' is not in datafile.")
+
+      @event_key = event_key
     end
   end
 
   class InvalidVariationError < Error
     # Raised when an invalid variation key or ID is provided
 
-    def initialize(msg = 'Provided variation is not in datafile.')
-      super
+    attr_reader :variation_id, :variation_key
+
+    def initialize(variation_id: nil, variation_key: nil)
+      raise ArgumentError, 'Either variation_id or variation_key must be provided.' if variation_id.nil? && variation_key.nil?
+      raise ArgumentError, 'Cannot provide both variation_id and variation_key.' if !variation_id.nil? && !variation_key.nil?
+
+      if variation_id.nil?
+        identifier = "key '#{variation_key}'"
+        @variation_key = variation_key
+      else
+        identifier = "id '#{variation_id}'"
+        @variation_id = variation_id
+      end
+
+      super("Variation #{identifier} is not in datafile.")
     end
   end
 

data/lib/optimizely/helpers/validator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2019, 2022, Optimizely and contributors
+#    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.
@@ -190,14 +190,13 @@ module Optimizely
         # segments_cache - custom cache to be validated.
         #
         # Returns boolean depending on whether cache has required methods.
-        (
-          segments_cache.respond_to?(:reset) &&
+
+        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)
@@ -206,13 +205,12 @@ module Optimizely
         # 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?(: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)

data/lib/optimizely/optimizely_config.rb

@@ -19,8 +19,9 @@ module Optimizely
   require 'json'
   class OptimizelyConfig
     include Optimizely::ConditionTreeEvaluator
-    def initialize(project_config)
+    def initialize(project_config, logger = nil)
       @project_config = project_config
+      @logger = logger || NoOpLogger.new
       @rollouts = @project_config.rollouts
       @audiences = []
       audience_id_lookup_dict = {}
@@ -91,6 +92,7 @@ module Optimizely
 
     def experiments_map
       experiments_id_map.values.reduce({}) do |experiments_key_map, experiment|
+        @logger.log(Logger::WARN, "Duplicate experiment keys found in datafile: #{experiment['key']}") if experiments_key_map.key? experiment['key']
         experiments_key_map.update(experiment['key'] => experiment)
       end
     end

data/lib/optimizely/optimizely_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2019, 2022, Optimizely and contributors
+#    Copyright 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.
@@ -103,7 +103,7 @@ module Optimizely
       )
 
       Optimizely::Project.new(
-        datafile, nil, logger, error_handler, nil, nil, sdk_key, config_manager, notification_center
+        datafile: datafile, logger: logger, error_handler: error_handler, sdk_key: sdk_key, config_manager: config_manager, notification_center: notification_center
       )
     end
 
@@ -111,7 +111,7 @@ module Optimizely
     #
     # @param config_manager - Required ConfigManagerInterface Responds to 'config' method.
     def self.default_instance_with_config_manager(config_manager)
-      Optimizely::Project.new(nil, nil, nil, nil, nil, nil, nil, config_manager)
+      Optimizely::Project.new(config_manager: config_manager)
     end
 
     # Returns a new optimizely instance.
@@ -167,19 +167,17 @@ module Optimizely
       )
 
       Optimizely::Project.new(
-        datafile,
-        event_dispatcher,
-        logger,
-        error_handler,
-        skip_json_validation,
-        user_profile_service,
-        sdk_key,
-        config_manager,
-        notification_center,
-        event_processor,
-        [],
-        {},
-        settings
+        datafile: datafile,
+        event_dispatcher: event_dispatcher,
+        logger: logger,
+        error_handler: error_handler,
+        skip_json_validation: skip_json_validation,
+        user_profile_service: user_profile_service,
+        sdk_key: sdk_key,
+        config_manager: config_manager,
+        notification_center: notification_center,
+        event_processor: event_processor,
+        settings: settings
       )
     end
   end

data/lib/optimizely/version.rb

@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '5.0.0-beta'
+  VERSION = '5.0.0'
 end

data/lib/optimizely.rb

@@ -70,20 +70,20 @@ module Optimizely
     # @param event_processor_options: Optional hash of options to be passed to the default batch event processor.
     # @param settings: Optional instance of OptimizelySdkSettings for sdk configuration.
 
-    def initialize( # rubocop:disable Metrics/ParameterLists
-      datafile = nil,
-      event_dispatcher = nil,
-      logger = nil,
-      error_handler = nil,
-      skip_json_validation = false, # rubocop:disable Style/OptionalBooleanParameter
-      user_profile_service = nil,
-      sdk_key = nil,
-      config_manager = nil,
-      notification_center = nil,
-      event_processor = nil,
-      default_decide_options = [],
-      event_processor_options = {},
-      settings = nil
+    def initialize(
+      datafile: nil,
+      event_dispatcher: nil,
+      logger: nil,
+      error_handler: nil,
+      skip_json_validation: false,
+      user_profile_service: nil,
+      sdk_key: nil,
+      config_manager: nil,
+      notification_center: nil,
+      event_processor: nil,
+      default_decide_options: [],
+      event_processor_options: {},
+      settings: nil
     )
       @logger = logger || NoOpLogger.new
       @error_handler = error_handler || NoOpErrorHandler.new
@@ -889,7 +889,7 @@ module Optimizely
       if @config_manager.respond_to?(:optimizely_config)
         @config_manager.optimizely_config
       else
-        OptimizelyConfig.new(project_config).config
+        OptimizelyConfig.new(project_config, @logger).config
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.0.pre.beta
+  version: 5.0.0
 platform: ruby
 authors:
 - Optimizely
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-28 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,14 +98,14 @@ dependencies:
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
@@ -204,12 +204,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key: