optimizely-sdk 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b913b8bcbd2644300fe6517aea21b9cb927519fe
-  data.tar.gz: fab9656efacd4482f667c1b36094d83bcf26ddde
+  metadata.gz: 948c6214e7f77820c80ba9f419260555c17419ba
+  data.tar.gz: 0dfe6752f4194aa537c9364587f292a39125f4f5
 SHA512:
-  metadata.gz: 2f16c84ffb903af5a9fadfbd3abc55ad8b2c88229eef21e908a86455d4bd171420a871192b5d0184e94f4b55863f84154be2beacd88cb20478d452d6588b2840
-  data.tar.gz: 054ef49bf622b8de3802481d4717667c9bdf75b6ff1a9d220402f4517201e5f66b663f21f59e9a26323cc2f8a13905fba9b84d2717b5c8667fedf05d9da39dec
+  metadata.gz: d81fc2852d21a471d14c5a20c80c967baba140ee0387326cb427474b71e215056e51aa4c0d75dba23ceb1024b576c9eef988ff653ab40ea4afd3a74a1cefba1b
+  data.tar.gz: 9010d5770d5b5e446b0494ca7de9f21f91d1e2949acf91958a1afa48492b8fe18aa3255a7b68315918ca3a175f57743f9b2b1eb815ad7d33a0efda42b47acda7

data/lib/optimizely.rb

@@ -105,6 +105,13 @@ module Optimizely
         return nil
       end
 
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          experiment_key: experiment_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
+
       variation_key = get_variation(experiment_key, user_id, attributes)
 
       if variation_key.nil?
@@ -135,10 +142,12 @@ module Optimizely
         return nil
       end
 
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          experiment_key: experiment_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
 
       unless user_inputs_valid?(attributes)
         @logger.log(Logger::INFO, "Not activating user '#{user_id}.")
@@ -196,10 +205,12 @@ module Optimizely
         return nil
       end
 
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          event_key: event_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
 
       return nil unless user_inputs_valid?(attributes, event_tags)
 
@@ -254,15 +265,12 @@ module Optimizely
         return false
       end
 
-      unless feature_flag_key
-        @logger.log(Logger::ERROR, 'Feature flag key cannot be empty.')
-        return false
-      end
-
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return false
-      end
+      return false unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          feature_flag_key: feature_flag_key,
+          user_id: user_id
+        }, @logger, Logger::ERROR
+      )
 
       feature_flag = @config.get_feature_flag_from_key(feature_flag_key)
       unless feature_flag
@@ -312,6 +320,8 @@ module Optimizely
         return enabled_features
       end
 
+      return enabled_features unless Optimizely::Helpers::Validator.inputs_valid?({user_id: user_id}, @logger, Logger::ERROR)
+
       @config.feature_flags.each do |feature|
         enabled_features.push(feature['key']) if is_feature_enabled(
           feature['key'],
@@ -426,20 +436,15 @@ module Optimizely
       # Returns nil if the feature flag or variable or user ID is empty
       #             in case of variable type mismatch
 
-      unless feature_flag_key
-        @logger.log(Logger::ERROR, 'Feature flag key cannot be empty.')
-        return nil
-      end
-
-      unless variable_key
-        @logger.log(Logger::ERROR, 'Variable key cannot be empty.')
-        return nil
-      end
-
-      if user_id.to_s.empty?
-        @logger.log(Logger::ERROR, 'User ID cannot be empty.')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          feature_flag_key: feature_flag_key,
+          variable_key: variable_key,
+          variable_type: variable_type,
+          user_id: user_id
+        },
+        @logger, Logger::ERROR
+      )
 
       feature_flag = @config.get_feature_flag_from_key(feature_flag_key)
       unless feature_flag

data/lib/optimizely/helpers/constants.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-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.
@@ -306,6 +306,15 @@ module Optimizely
         'INTEGER' => 'integer',
         'STRING' => 'string'
       }.freeze
+
+      INPUT_VARIABLES = {
+        'FEATURE_FLAG_KEY' => 'Feature flag key',
+        'EXPERIMENT_KEY' => 'Experiment key',
+        'USER_ID' => 'User ID',
+        'VARIATION_KEY' => 'Variation key',
+        'VARIABLE_KEY' => 'Variable key',
+        'VARIABLE_TYPE' => 'Variable type'
+      }.freeze
     end
   end
 end

data/lib/optimizely/helpers/validator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-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.
@@ -95,6 +95,27 @@ module Optimizely
       rescue
         false
       end
+
+      def inputs_valid?(variables, logger = NoOpLogger.new, level = Logger::ERROR)
+        # Determines if values of variables in given array are non empty string.
+        #
+        # variables - array values to validate.
+        #
+        # logger - logger.
+        #
+        # Returns boolean True if all of the values are valid, False otherwise.
+
+        return false unless variables.respond_to?(:each) && !variables.empty?
+        is_valid = true
+        variables.each do |key, value|
+          next if value.is_a?(String) && !value.empty?
+          is_valid = false
+          if logger_valid?(logger) && level
+            logger.log(level, "#{Optimizely::Helpers::Constants::INPUT_VARIABLES[key.to_s.upcase]} is invalid")
+          end
+        end
+        is_valid
+      end
     end
   end
 end

data/lib/optimizely/project_config.rb

@@ -15,6 +15,7 @@
 #    limitations under the License.
 #
 require 'json'
+require_relative 'helpers/validator'
 
 module Optimizely
   V1_CONFIG_VERSION = '1'
@@ -275,11 +276,12 @@ module Optimizely
       #
       # 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? || user_id.empty?
-        @logger.log(Logger::DEBUG, 'User ID is invalid')
-        return nil
-      end
+      return nil unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          experiment_key: experiment_key,
+          user_id: user_id
+        }, @logger, Logger::DEBUG
+      )
 
       unless @forced_variation_map.key? user_id
         @logger.log(Logger::DEBUG, "User '#{user_id}' is not in the forced variation map.")
@@ -323,11 +325,12 @@ module Optimizely
       #
       # Returns a boolean value that indicates if the set completed successfully.
 
-      #  check for null and empty string user ID
-      if user_id.nil? || user_id.empty?
-        @logger.log(Logger::DEBUG, 'User ID is invalid')
-        return false
-      end
+      return false unless Optimizely::Helpers::Validator.inputs_valid?(
+        {
+          user_id: user_id,
+          experiment_key: experiment_key
+        }, @logger, Logger::DEBUG
+      )
 
       experiment = get_experiment_from_key(experiment_key)
       experiment_id = experiment['id'] if experiment

data/lib/optimizely/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-#    Copyright 2016-2017, Optimizely and contributors
+#    Copyright 2016-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.
@@ -17,5 +17,5 @@
 #
 module Optimizely
   CLIENT_ENGINE = 'ruby-sdk'
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optimizely-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Optimizely
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for Optimizely's testing framework