optimizely-sdk 5.0.0 → 5.1.0

data/lib/optimizely/user_profile_service.rb

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 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
-  class BaseUserProfileService
-    # Class encapsulating user profile service functionality.
-    # Override with your own implementation for storing and retrieving user profiles.
-
-    # Retrieve the Hash user profile associated with a given user ID.
-    #
-    # @param user_id - String user ID
-    # @return [Hash] user profile.
-    def lookup(user_id); end
-
-    # Saves a given user profile.
-    #
-    # @param user_profile - Hash user profile.
-    def save(user_profile); end
-  end
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 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
+  class BaseUserProfileService
+    # Class encapsulating user profile service functionality.
+    # Override with your own implementation for storing and retrieving user profiles.
+
+    # Retrieve the Hash user profile associated with a given user ID.
+    #
+    # @param user_id - String user ID
+    # @return [Hash] user profile.
+    def lookup(user_id); end
+
+    # Saves a given user profile.
+    #
+    # @param user_profile - Hash user profile.
+    def save(user_profile); end
+  end
+end

data/lib/optimizely/user_profile_tracker.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'logger'
+
+module Optimizely
+  class UserProfileTracker
+    attr_reader :user_profile
+
+    def initialize(user_id, user_profile_service = nil, logger = nil)
+      @user_id = user_id
+      @user_profile_service = user_profile_service
+      @logger = logger || NoOpLogger.new
+      @profile_updated = false
+      @user_profile = {
+        user_id: user_id,
+        experiment_bucket_map: {}
+      }
+    end
+
+    def load_user_profile(reasons = [], error_handler = nil)
+      return if reasons.nil?
+
+      begin
+        @user_profile = @user_profile_service.lookup(@user_id) if @user_profile_service
+        if @user_profile.nil?
+          @user_profile = {
+            user_id: @user_id,
+            experiment_bucket_map: {}
+          }
+        end
+      rescue => e
+        message = "Error while looking up user profile for user ID '#{@user_id}': #{e}."
+        reasons << message
+        @logger.log(Logger::ERROR, message)
+        error_handler&.handle_error(e)
+      end
+    end
+
+    def update_user_profile(experiment_id, variation_id)
+      user_id = @user_profile[:user_id]
+      begin
+        @user_profile[:experiment_bucket_map][experiment_id] = {
+          variation_id: variation_id
+        }
+        @profile_updated = true
+        @logger.log(Logger::INFO, "Updated variation ID #{variation_id} of experiment ID #{experiment_id} for user '#{user_id}'.")
+      rescue => e
+        @logger.log(Logger::ERROR, "Error while updating user profile for user ID '#{user_id}': #{e}.")
+      end
+    end
+
+    def save_user_profile(error_handler = nil)
+      return unless @profile_updated && @user_profile_service
+
+      begin
+        @user_profile_service.save(@user_profile)
+        @logger.log(Logger::INFO, "Saved user profile for user '#{@user_profile[:user_id]}'.")
+      rescue => e
+        @logger.log(Logger::ERROR, "Failed to save user profile for user '#{@user_profile[:user_id]}': #{e}.")
+        error_handler&.handle_error(e)
+      end
+    end
+  end
+end

data/lib/optimizely/version.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
-#
-#    Copyright 2016-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.
-#
-module Optimizely
-  CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '5.0.0'
-end
+# frozen_string_literal: true
+
+#
+#    Copyright 2016-2024, 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
+  CLIENT_ENGINE = 'ruby-sdk'
+  VERSION = '5.1.0'
+end