optimizely-sdk 2.0.0.beta → 2.0.0.beta1

data/lib/optimizely/helpers/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 #    Copyright 2016-2017, Optimizely and contributors
 #
@@ -16,7 +18,6 @@
 module Optimizely
   module Helpers
     module Constants
-
       JSON_SCHEMA_V2 = {
         'type' => 'object',
         'properties' => {
@@ -49,9 +50,9 @@ module Optimizely
                         'type' => 'integer'
                       }
                     },
-                    'required' => [
-                      'entityId',
-                      'endOfRange'
+                    'required' => %w[
+                      entityId
+                      endOfRange
                     ]
                   }
                 },
@@ -84,9 +85,9 @@ module Optimizely
                               'type' => 'string'
                             }
                           },
-                          'required' => [
-                            'id',
-                            'key'
+                          'required' => %w[
+                            id
+                            key
                           ]
                         }
                       },
@@ -102,9 +103,9 @@ module Optimizely
                               'type' => 'integer'
                             }
                           },
-                          'required' => [
-                            'entityId',
-                            'endOfRange'
+                          'required' => %w[
+                            entityId
+                            endOfRange
                           ]
                         }
                       },
@@ -118,24 +119,24 @@ module Optimizely
                         'type' => 'object'
                       }
                     },
-                    'required' => [
-                      'id',
-                      'layerId',
-                      'key',
-                      'status',
-                      'variations',
-                      'trafficAllocation',
-                      'audienceIds',
-                      'forcedVariations'
+                    'required' => %w[
+                      id
+                      layerId
+                      key
+                      status
+                      variations
+                      trafficAllocation
+                      audienceIds
+                      forcedVariations
                     ]
                   }
                 }
               },
-              'required' => [
-                'id',
-                'policy',
-                'trafficAllocation',
-                'experiments'
+              'required' => %w[
+                id
+                policy
+                trafficAllocation
+                experiments
               ]
             }
           },
@@ -168,9 +169,9 @@ module Optimizely
                         'type' => 'string'
                       }
                     },
-                    'required' => [
-                      'id',
-                      'key'
+                    'required' => %w[
+                      id
+                      key
                     ]
                   }
                 },
@@ -186,9 +187,9 @@ module Optimizely
                         'type' => 'integer'
                       }
                     },
-                    'required' => [
-                      'entityId',
-                      'endOfRange'
+                    'required' => %w[
+                      entityId
+                      endOfRange
                     ]
                   }
                 },
@@ -202,15 +203,15 @@ module Optimizely
                   'type' => 'object'
                 }
               },
-              'required' => [
-                'id',
-                'key',
-                'variations',
-                'trafficAllocation',
-                'audienceIds',
-                'forcedVariations',
-                'status',
-                'layerId'
+              'required' => %w[
+                id
+                key
+                variations
+                trafficAllocation
+                audienceIds
+                forcedVariations
+                status
+                layerId
               ]
             }
           },
@@ -232,10 +233,10 @@ module Optimizely
                   'type' => 'string'
                 }
               },
-              'required' => [
-                'key',
-                'experimentIds',
-                'id'
+              'required' => %w[
+                key
+                experimentIds
+                id
               ]
             }
           },
@@ -254,10 +255,10 @@ module Optimizely
                   'type' => 'string'
                 }
               },
-              'required' => [
-                'id',
-                'name',
-                'conditions'
+              'required' => %w[
+                id
+                name
+                conditions
               ]
             }
           },
@@ -271,11 +272,11 @@ module Optimizely
                 },
                 'key' => {
                   'type' => 'string'
-                },
+                }
               },
-              'required' => [
-                'id',
-                'key',
+              'required' => %w[
+                id
+                key
               ]
             }
           },
@@ -286,25 +287,25 @@ module Optimizely
             'type' => 'string'
           }
         },
-        'required' => [
-          'projectId',
-          'accountId',
-          'experiments',
-          'events',
-          'groups',
-          'audiences',
-          'attributes',
-          'version',
-          'revision'
+        'required' => %w[
+          projectId
+          accountId
+          experiments
+          events
+          groups
+          audiences
+          attributes
+          version
+          revision
         ]
-      }
+      }.freeze
 
       VARIABLE_TYPES = {
         'BOOLEAN' => 'boolean',
         'DOUBLE' => 'double',
         'INTEGER' => 'integer',
         'STRING' => 'string'
-      }
+      }.freeze
     end
   end
 end

data/lib/optimizely/helpers/event_tag_utils.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-#    Copyright 2017, Optimizely and contributors
+#    Copyright 2017-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.
@@ -21,35 +23,108 @@ module Optimizely
     module EventTagUtils
       module_function
 
-      def get_revenue_value(event_tags)
+      REVENUE_EVENT_METRIC_NAME = 'revenue'
+      NUMERIC_EVENT_METRIC_NAME = 'value'
+
+      def get_revenue_value(event_tags, logger)
         # Grab the revenue value from the event tags. "revenue" is a reserved keyword.
-        #
+        # The value will be parsed to an integer if possible.
+        # Example:
+        #   4.0 or "4.0" will be parsed to int(4).
+        #   4.1 will not be parsed and the method will return nil.
         # event_tags - Hash representing metadata associated with the event.
+        # logger - Optional component which provides a log method to log messages.
+        #
         # Returns revenue value as an integer number
         # Returns nil if revenue can't be retrieved from the event tags.
 
-        if event_tags.nil? or !Helpers::Validator.attributes_valid?(event_tags)
+        if event_tags.nil?
+          logger.log(Logger::DEBUG, 'Event tags is undefined.')
+          return nil
+        end
+
+        unless Helpers::Validator.event_tags_valid?(event_tags)
+          logger.log(Logger::DEBUG, 'Event tags is not a hash.')
           return nil
         end
 
-        unless event_tags.has_key?('revenue')
+        unless event_tags.key?(REVENUE_EVENT_METRIC_NAME)
+          logger.log(Logger::DEBUG, 'The revenue key is not defined in the event tags.')
           return nil
         end
 
-        logger = SimpleLogger.new
-        raw_value = event_tags['revenue']
+        if event_tags[REVENUE_EVENT_METRIC_NAME].nil?
+          logger.log(Logger::DEBUG, 'The revenue key is nil.')
+          return nil
+        end
 
-        unless raw_value.is_a? Numeric
-          logger.log(Logger::WARN, "Failed to parse revenue value #{raw_value} from event tags.")
+        raw_value = event_tags[REVENUE_EVENT_METRIC_NAME]
+
+        unless Helpers::Validator.string_numeric?(raw_value)
+          logger.log(Logger::WARN, 'Revenue value is not an integer or float, or is not a numeric string.')
           return nil
         end
 
-        if raw_value.is_a? Float
+        raw_value = raw_value.to_f if raw_value.is_a? String
+
+        unless raw_value == raw_value.to_i
           logger.log(Logger::WARN, "Failed to parse revenue value #{raw_value} from event tags.")
           return nil
         end
 
-        logger.log(Logger::INFO, "Parsed revenue value #{raw_value} from event tags.")
+        logger.log(Logger::INFO, "Parsed revenue value #{raw_value.to_i} from event tags.")
+        raw_value.to_i
+      end
+
+      def get_numeric_value(event_tags, logger)
+        # Grab the numeric event value from the event tags. "value" is a reserved keyword.
+        # The value of 'value' can be a float or a numeric string
+        #
+        # event_tags - +Hash+ representing metadata associated with the event.
+        # logger - Optional component which provides a log method to log messages.
+        # Returns  +Number+ | +nil+ if value can't be retrieved from the event tags.
+
+        if event_tags.nil?
+          logger.log(Logger::DEBUG, 'Event tags is undefined.')
+          return nil
+        end
+
+        unless Helpers::Validator.event_tags_valid?(event_tags)
+          logger.log(Logger::DEBUG, 'Event tags is not a dictionary.')
+          return nil
+        end
+
+        unless event_tags.key?(NUMERIC_EVENT_METRIC_NAME)
+          logger.log(Logger::DEBUG, 'The numeric metric key is not defined in the event tags.')
+          return nil
+        end
+
+        if event_tags[NUMERIC_EVENT_METRIC_NAME].nil?
+          logger.log(Logger::DEBUG, 'The numeric metric key is null.')
+          return nil
+        end
+
+        raw_value = event_tags[NUMERIC_EVENT_METRIC_NAME]
+
+        if raw_value.is_a?(TrueClass) || raw_value.is_a?(FalseClass)
+          logger.log(Logger::DEBUG, 'Provided numeric value is a boolean, which is an invalid format.')
+          return nil
+        end
+
+        if raw_value.is_a?(Array) || raw_value.is_a?(Hash) || raw_value.to_f.nan? || raw_value.to_f.infinite?
+          logger.log(Logger::DEBUG, 'Provided numeric value is in an invalid format.')
+          return nil
+        end
+
+        unless Helpers::Validator.string_numeric?(raw_value)
+          logger.log(Logger::DEBUG, 'Provided numeric value is not a numeric string.')
+          return nil
+        end
+
+        raw_value = raw_value.to_f
+
+        logger.log(Logger::INFO, "The numeric metric value #{raw_value} will be sent to results.")
+
         raw_value
       end
     end

data/lib/optimizely/helpers/group.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-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.

data/lib/optimizely/helpers/validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 #    Copyright 2016-2017, Optimizely and contributors
 #
@@ -50,7 +52,7 @@ module Optimizely
         # Returns boolean depending on validity of datafile.
 
         begin
-          datafile = JSON.load(datafile)
+          datafile = JSON.parse(datafile)
         rescue
           return false
         end
@@ -87,6 +89,12 @@ module Optimizely
 
         logger.respond_to?(:log)
       end
+
+      def string_numeric?(str)
+        !Float(str).nil?
+      rescue
+        false
+      end
     end
   end
 end

data/lib/optimizely/helpers/variable_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 #    Copyright 2017, Optimizely and contributors
 #
@@ -30,26 +32,28 @@ module Optimizely
         return_value = nil
 
         case variable_type
-        when "boolean"
-          return_value = value == "true"
-        when "double"
+        when 'boolean'
+          return_value = value == 'true'
+        when 'double'
           begin
             return_value = Float(value)
           rescue => e
-            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type '#{variable_type}': #{e.message}.")
+            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
+                                      "'#{variable_type}': #{e.message}.")
           end
-        when "integer"
+        when 'integer'
           begin
             return_value = Integer(value)
           rescue => e
-            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type '#{variable_type}': #{e.message}.")
+            logger.log(Logger::ERROR, "Unable to cast variable value '#{value}' to type "\
+                                      "'#{variable_type}': #{e.message}.")
           end
         else
           # default case is string
           return_value = value
         end
 
-        return return_value
+        return_value
       end
     end
   end

data/lib/optimizely/logger.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 #
-#    Copyright 2016, Optimizely and contributors
+#    Copyright 2016-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.
@@ -19,15 +21,13 @@ module Optimizely
   class BaseLogger
     # Class encapsulating logging functionality. Override with your own logger providing log method.
 
-    def log(_level, _message)
-    end
+    def log(_level, _message); end
   end
 
   class NoOpLogger < BaseLogger
     # Class providing log method which logs nothing.
 
-    def log(_level, _message)
-    end
+    def log(_level, _message); end
   end
 
   class SimpleLogger < BaseLogger