optimizely-sdk 1.5.0 → 2.0.0.beta

data/lib/optimizely/helpers/validator.rb

@@ -87,11 +87,6 @@ module Optimizely
 
         logger.respond_to?(:log)
       end
-
-      def string_numeric?(str)
-        Float(str) != nil rescue false
-      end
-      
     end
   end
 end

data/lib/optimizely/project_config.rb

@@ -38,8 +38,6 @@ module Optimizely
     attr_reader :groups
     attr_reader :parsing_succeeded
     attr_reader :project_id
-    # Boolean - denotes if Optimizely should remove the last block of visitors' IP address before storing event data
-    attr_reader :anonymize_ip
     attr_reader :revision
     attr_reader :rollouts
     attr_reader :version
@@ -58,12 +56,6 @@ module Optimizely
     attr_reader :variation_id_to_variable_usage_map
     attr_reader :variation_key_map
 
-    # Hash of user IDs to a Hash
-    # of experiments to variations. This contains all the forced variations
-    # set by the user by calling setForcedVariation (it is not the same as the
-    # whitelisting forcedVariations data structure in the Experiments class).
-    attr_reader :forced_variation_map
-
     def initialize(datafile, logger, error_handler)
       # ProjectConfig init method to fetch and set project config data
       #
@@ -88,7 +80,6 @@ module Optimizely
       @feature_flags = config.fetch('featureFlags', [])
       @groups = config.fetch('groups', [])
       @project_id = config['projectId']
-      @anonymize_ip = (config.has_key? 'anonymizeIP')? config['anonymizeIP'] :false
       @revision = config['revision']
       @rollouts = config.fetch('rollouts', [])
 
@@ -107,7 +98,6 @@ module Optimizely
       @audience_id_map = generate_key_map(@audiences, 'id')
       @variation_id_map = {}
       @variation_key_map = {}
-      @forced_variation_map = {}
       @variation_id_to_variable_usage_map = {}
       @variation_id_to_experiment_map = {}
       @experiment_key_map.each do |key, exp|
@@ -256,12 +246,12 @@ module Optimizely
       nil
     end
 
-    def get_whitelisted_variations(experiment_key)
-      # Retrieves whitelisted variations for a given experiment Key
+    def get_forced_variations(experiment_key)
+      # Retrieves forced variations for a given experiment Key
       #
       # experiment_key - String Key representing the experiment
       #
-      # Returns whitelisted variations for the experiment or nil
+      # Returns forced variations for the experiment or nil
 
       experiment = @experiment_key_map[experiment_key]
       return experiment['forcedVariations'] if experiment
@@ -269,100 +259,6 @@ module Optimizely
       @error_handler.handle_error InvalidExperimentError
     end
 
-    def get_forced_variation(experiment_key, user_id)
-      # Gets the forced variation for the given user and experiment.
-      #
-      # experiment_key - String Key for experiment.
-      # user_id - String ID for user
-      #
-      # Returns Variation The variation which the given user and experiment should be forced into.
-
-      # check for nil and empty string user ID
-      if user_id.nil? or user_id.empty?
-        @logger.log(Logger::DEBUG, "User ID is invalid")
-        return nil
-      end
-
-      unless @forced_variation_map.has_key? (user_id)
-        @logger.log(Logger::DEBUG, "User '#{user_id}' is not in the forced variation map.")
-        return nil
-      end
-
-      experimentToVariationMap = @forced_variation_map[user_id]
-      experiment = get_experiment_from_key(experiment_key)
-      experiment_id = experiment["id"] if experiment
-      # check for nil and empty string experiment ID
-      if experiment_id.nil? or experiment_id.empty?
-        # this case is logged in get_experiment_from_key
-        return nil
-      end
-
-      unless experimentToVariationMap.has_key? (experiment_id)
-        @logger.log(Logger::DEBUG, "No experiment '#{experiment_key}' mapped to user '#{user_id}' in the forced variation map.")
-        return nil
-      end
-
-      variation_id = experimentToVariationMap[experiment_id]
-      variation_key = ""
-      variation = get_variation_from_id(experiment_key,variation_id)
-      variation_key = variation["key"] if variation
-
-      # check if the variation exists in the datafile
-      if variation_key.empty?
-        # this case is logged in get_variation_from_id
-        return nil
-      end
-
-      @logger.log(Logger::DEBUG, "Variation '#{variation_key}' is mapped to experiment '#{experiment_key}' and user '#{user_id}' in the forced variation map")
-      
-      variation
-    end
-
-    def set_forced_variation(experiment_key, user_id, variation_key)
-      # Sets a Hash of user IDs to a Hash of experiments to forced variations.
-      #
-      # experiment_key - String Key for experiment.
-      # user_id - String ID for user.
-      # variation_key - String Key for variation. If null, then clear the existing experiment-to-variation mapping.
-      #
-      # Returns a boolean value that indicates if the set completed successfully.
-
-      #  check for null and empty string user ID
-      if user_id.nil? or user_id.empty?
-        @logger.log(Logger::DEBUG, "User ID is invalid")
-        return false
-      end
-
-      experiment = get_experiment_from_key(experiment_key)
-      experiment_id = experiment["id"] if experiment
-      #  check if the experiment exists in the datafile
-      if experiment_id.nil? or experiment_id.empty?
-        return false
-      end
-
-      #  clear the forced variation if the variation key is null
-      if variation_key.nil? or variation_key.empty?
-        @forced_variation_map[user_id].delete(experiment_id) if @forced_variation_map.has_key? (user_id)
-        @logger.log(Logger::DEBUG, "Variation mapped to experiment '#{experiment_key}' has been removed for user '#{user_id}'.")
-        return true
-      end
-
-      variation_id = get_variation_id_from_key(experiment_key, variation_key)
-
-      #  check if the variation exists in the datafile
-      unless variation_id
-        #  this case is logged in get_variation_id_from_key
-        return false
-      end
-
-      unless @forced_variation_map.has_key? user_id 
-        @forced_variation_map[user_id] = {}
-      end
-      @forced_variation_map[user_id][experiment_id] = variation_id
-      @logger.log(Logger::DEBUG, "Set variation '#{variation_id}' for experiment '#{experiment_id}' and user '#{user_id}' in the forced variation map.")
-      return true
-    end
-
     def get_attribute_id(attribute_key)
       attribute = @attribute_key_map[attribute_key]
       return attribute['id'] if attribute
@@ -394,6 +290,7 @@ module Optimizely
         return true if variation
         @logger.log Logger::ERROR, "Variation ID '#{variation_id}' is not in datafile."
         @error_handler.handle_error InvalidVariationError
+        return false
       end
 
       false

data/lib/optimizely/version.rb

@@ -14,8 +14,5 @@
 #    limitations under the License.
 #
 module Optimizely
-  
- CLIENT_ENGINE = 'ruby-sdk'.freeze
- VERSION = '1.5.0'.freeze
-  
+  VERSION = '2.0.0.beta'.freeze
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0.beta
 platform: ruby
 authors:
+- Andrew Delikat
+- Haley Bash
 - Optimizely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +132,6 @@ files:
 - lib/optimizely/helpers/validator.rb
 - lib/optimizely/helpers/variable_type.rb
 - lib/optimizely/logger.rb
-- lib/optimizely/notification_center.rb
 - lib/optimizely/params.rb
 - lib/optimizely/project_config.rb
 - lib/optimizely/user_profile_service.rb
@@ -150,12 +151,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Optimizely's testing framework

data/lib/optimizely/notification_center.rb

@@ -1,148 +0,0 @@
-#
-#    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 NotificationCenter
-    attr_reader :notifications
-    attr_reader :notification_id
-
-    NOTIFICATION_TYPES = {
-      ACTIVATE: 'ACTIVATE: experiment, user_id, attributes, variation, event',
-      TRACK: 'TRACK: event_key, user_id, attributes, event_tags, event'
-    }.freeze
-
-    def initialize(logger, error_handler)
-      @notification_id = 1
-      @notifications = {}
-      NOTIFICATION_TYPES.values.each { |value| @notifications[value] = [] }
-      @logger = logger
-      @error_handler = error_handler
-    end
-
-    def add_notification_listener(notification_type, notification_callback)
-      # Adds notification callback to the notification center
-
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-      #  notification_callback: function to call when the event is sent
-
-      # Returns:
-      #  notification ID used to remove the notification
-
-      return nil unless notification_type_valid?(notification_type)
-
-      unless notification_callback
-        @logger.log Logger::ERROR, 'Callback can not be empty.'
-        return nil
-      end
-
-      unless notification_callback.is_a? Method
-        @logger.log Logger::ERROR, 'Invalid notification callback given.'
-        return nil
-      end
-
-      @notifications[notification_type].each do |notification|
-        return -1 if notification[:callback] == notification_callback
-      end
-      @notifications[notification_type].push(notification_id: @notification_id, callback: notification_callback)
-      notification_id = @notification_id
-      @notification_id += 1
-      notification_id
-    end
-
-    def remove_notification_listener(notification_id)
-      # Removes previously added notification callback
-
-      # Args:
-      #  notification_id:
-      # Returns:
-      #  The function returns true if found and removed, false otherwise
-      unless notification_id
-        @logger.log Logger::ERROR, 'Notification ID can not be empty.'
-        return nil
-      end
-      @notifications.each do |key, _array|
-        @notifications[key].each do |notification|
-          if notification_id == notification[:notification_id]
-            @notifications[key].delete(notification_id: notification_id, callback: notification[:callback])
-            return true
-          end
-        end
-      end
-      false
-    end
-
-    def clear_notifications(notification_type)
-      # Removes notifications for a certain notification type
-      #
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-
-      return nil unless notification_type_valid?(notification_type)
-
-      @notifications[notification_type] = []
-      @logger.log Logger::INFO, "All callbacks for notification type #{notification_type} have been removed."
-    end
-
-    def clean_all_notifications
-      # Removes all notifications
-      @notifications.keys.each { |key| @notifications[key] = [] }
-    end
-
-    def send_notifications(notification_type, *args)
-      # Sends off the notification for the specific event.  Uses var args to pass in a
-      # arbitrary list of parameters according to which notification type was sent
-
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-      #  args: list of arguments to the callback
-      return nil unless notification_type_valid?(notification_type)
-
-      @notifications[notification_type].each do |notification|
-        begin
-          notification_callback = notification[:callback]
-          notification_callback.call(*args)
-          @logger.log Logger::INFO, "Notification #{notification_type} sent successfully."
-        rescue => e
-          @logger.log(Logger::ERROR, "Problem calling notify callback. Error: #{e}")
-          return nil
-        end
-      end
-    end
-
-    private
-
-    def notification_type_valid?(notification_type)
-      # Validates notification type
-
-      # Args:
-      #  notification_type: one of the constants in NOTIFICATION_TYPES
-
-      # Returns true if notification_type is valid,  false otherwise
-
-      unless notification_type
-        @logger.log Logger::ERROR, 'Notification type can not be empty.'
-        return false
-      end
-
-      unless @notifications.include?(notification_type)
-        @logger.log Logger::ERROR, 'Invalid notification type.'
-        @error_handler.handle_error InvalidNotificationType
-        return false
-      end
-      true
-    end
-  end
-end