Merge branch 'master' into mng/pr-122

Author: Mike Ng

.rubocop.yml

@@ -3,19 +3,19 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.3
 
-Metrics/AbcSize:
-  Enabled: false
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
 
-Metrics/CyclomaticComplexity:
+Metrics/AbcSize:
   Enabled: false
 
-Metrics/PerceivedComplexity:
+Metrics/BlockLength:
   Enabled: false
 
 Metrics/ClassLength:
   Enabled: false
 
-Metrics/BlockLength:
+Metrics/CyclomaticComplexity:
   Enabled: false
 
 Metrics/LineLength:
@@ -27,17 +27,17 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   Enabled: false
 
-Style/Documentation:
+Metrics/PerceivedComplexity:
   Enabled: false
 
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
 Naming/VariableNumber:
   Enabled: false
 
-Lint/RescueWithoutErrorClass:
+Style/Documentation:
+  Enabled: false
+
+Style/RescueStandardError:
    Enabled: false
+
+Style/SignalException:
+  Enabled: false

lib/optimizely.rb

@@ -64,17 +64,13 @@ def initialize(datafile, event_dispatcher = nil, logger = nil, error_handler = n
 
       begin
         @config = ProjectConfig.new(datafile, @logger, @error_handler)
-      rescue
+      rescue StandardError => e
         @is_valid = false
         @logger = SimpleLogger.new
-        @logger.log(Logger::ERROR, InvalidInputError.new('datafile').message)
-        return
-      end
-
-      unless @config.parsing_succeeded?
-        @is_valid = false
-        @logger = SimpleLogger.new
-        @logger.log(Logger::ERROR, InvalidDatafileVersionError.new.message)
+        error_msg = e.class == InvalidDatafileVersionError ? e.message : InvalidInputError.new('datafile').message
+        error_to_handle = e.class == InvalidDatafileVersionError ? InvalidDatafileVersionError : InvalidInputError
+        @logger.log(Logger::ERROR, error_msg)
+        @error_handler.handle_error error_to_handle
         return
       end
 

lib/optimizely/event_builder.rb

@@ -153,7 +153,7 @@ def create_conversion_event(event_key, user_id, attributes, event_tags, experime
 
       event_params = get_common_params(user_id, attributes)
       conversion_params = get_conversion_params(event_key, event_tags, experiment_variation_map)
-      event_params[:visitors][0][:snapshots] = conversion_params
+      event_params[:visitors][0][:snapshots] = [conversion_params]
 
       Event.new(:post, ENDPOINT, event_params, POST_HEADERS)
     end
@@ -195,43 +195,38 @@ def get_conversion_params(event_key, event_tags, experiment_variation_map)
       # event_tags -               +Hash+ Values associated with the event.
       # experiment_variation_map - +Hash+ Map of experiment IDs to bucketed variation IDs
       #
-      # Returns +Hash+ Impression event params
-
-      conversion_event_params = []
+      # Returns +Hash+ Conversion event params
 
+      single_snapshot = {}
+      single_snapshot[:decisions] = []
       experiment_variation_map.each do |experiment_id, variation_id|
-        single_snapshot = {
-          decisions: [{
-            campaign_id: @config.experiment_id_map[experiment_id]['layerId'],
-            experiment_id: experiment_id,
-            variation_id: variation_id
-          }],
-          events: []
-        }
-
-        event_object = {
-          entity_id: @config.event_key_map[event_key]['id'],
-          timestamp: create_timestamp,
-          uuid: create_uuid,
-          key: event_key
-        }
-
-        if event_tags
-          revenue_value = Helpers::EventTagUtils.get_revenue_value(event_tags, @logger)
-          event_object[:revenue] = revenue_value if revenue_value
+        next unless variation_id
+        single_snapshot[:decisions].push(
+          campaign_id: @config.experiment_id_map[experiment_id]['layerId'],
+          experiment_id: experiment_id,
+          variation_id: variation_id
+        )
+      end
 
-          numeric_value = Helpers::EventTagUtils.get_numeric_value(event_tags, @logger)
-          event_object[:value] = numeric_value if numeric_value
+      event_object = {
+        entity_id: @config.event_key_map[event_key]['id'],
+        timestamp: create_timestamp,
+        uuid: create_uuid,
+        key: event_key
+      }
 
-          event_object[:tags] = event_tags
-        end
+      if event_tags
+        revenue_value = Helpers::EventTagUtils.get_revenue_value(event_tags, @logger)
+        event_object[:revenue] = revenue_value if revenue_value
 
-        single_snapshot[:events] = [event_object]
+        numeric_value = Helpers::EventTagUtils.get_numeric_value(event_tags, @logger)
+        event_object[:value] = numeric_value if numeric_value
 
-        conversion_event_params.push(single_snapshot)
+        event_object[:tags] = event_tags unless event_tags.empty?
       end
 
-      conversion_event_params
+      single_snapshot[:events] = [event_object]
+      single_snapshot
     end
 
     def create_timestamp

lib/optimizely/exceptions.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.
@@ -85,9 +85,8 @@ def initialize(aborted_method)
   class InvalidDatafileVersionError < Error
     # Raised when a datafile with an unsupported version is provided
 
-    def initialize(msg = 'Provided datafile is an unsupported version. Please use SDK version 1.1.2 or earlier '\
-                  'for datafile version 1.')
-      super
+    def initialize(version)
+      super("This version of the Ruby SDK does not support the given datafile version: #{version}.")
     end
   end
 

lib/optimizely/helpers/constants.rb

@@ -321,6 +321,12 @@ module Constants
         'BUCKETING_ID' => '$opt_bucketing_id',
         'USER_AGENT' => '$opt_user_agent'
       }.freeze
+
+      SUPPORTED_VERSIONS = {
+        'v2' => '2',
+        'v3' => '3',
+        'v4' => '4'
+      }.freeze
     end
   end
 end

lib/optimizely/notification_center.rb

@@ -42,7 +42,6 @@ def initialize(logger, error_handler)
 
     def add_notification_listener(notification_type, notification_callback)
       return nil unless notification_type_valid?(notification_type)
-
       unless notification_callback
         @logger.log Logger::ERROR, 'Callback can not be empty.'
         return nil

lib/optimizely/project_config.rb

@@ -19,10 +19,6 @@
 require_relative 'helpers/validator'
 
 module Optimizely
-  V1_CONFIG_VERSION = '1'
-
-  UNSUPPORTED_VERSIONS = [V1_CONFIG_VERSION].freeze
-
   class ProjectConfig
     # Representation of the Optimizely project config.
     RUNNING_EXPERIMENT_STATUS = ['Running'].freeze
@@ -39,7 +35,6 @@ class ProjectConfig
     attr_reader :experiments
     attr_reader :feature_flags
     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
@@ -75,12 +70,11 @@ def initialize(datafile, logger, error_handler)
 
       config = JSON.parse(datafile)
 
-      @parsing_succeeded = false
       @error_handler = error_handler
       @logger = logger
       @version = config['version']
 
-      return if UNSUPPORTED_VERSIONS.include?(@version)
+      raise InvalidDatafileVersionError, @version unless Helpers::Constants::SUPPORTED_VERSIONS.value?(@version)
 
       @account_id = config['accountId']
       @attributes = config.fetch('attributes', [])
@@ -147,7 +141,6 @@ def initialize(datafile, logger, error_handler)
       @feature_flag_key_map.each do |key, feature_flag|
         @feature_variable_key_map[key] = generate_key_map(feature_flag['variables'], 'key')
       end
-      @parsing_succeeded = true
     end
 
     def experiment_running?(experiment)
@@ -389,14 +382,6 @@ def get_attribute_id(attribute_key)
       nil
     end
 
-    def parsing_succeeded?
-      # Helper method to determine if parsing the datafile was successful.
-      #
-      # Returns Boolean depending on whether parsing the datafile succeeded or not.
-
-      @parsing_succeeded
-    end
-
     def variation_id_exists?(experiment_id, variation_id)
       # Determines if a given experiment ID / variation ID pair exists in the datafile
       #

optimizely-sdk.gemspec

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 require_relative 'lib/optimizely/version'
@@ -18,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.51.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58.0'
 
   spec.add_runtime_dependency 'httparty', '~> 0.11'
   spec.add_runtime_dependency 'json-schema', '~> 2.6'

spec/bucketing_spec.rb

@@ -57,7 +57,7 @@ def get_bucketing_key(bucketing_id, entity_id = nil)
     expect(bucketer.send(:generate_bucket_value, get_bucketing_key(
                                                    'a very very very very very very very very very very very very '\
                                                    'very very very long ppd string'
-    ))).to eq(6128)
+                                                 ))).to eq(6128)
   end
 
   it 'should return the proper variation for a user in a mutually exclusive grouped experiment' do

spec/event_builder_spec.rb

@@ -525,4 +525,23 @@
     expect(conversion_event.url).to eq(@expected_endpoint)
     expect(conversion_event.http_verb).to eq(:post)
   end
+
+  describe 'multiple_experiments_event' do
+    it 'should create_conversion_event when Event is used in multiple experiments' do
+      @expected_conversion_params[:visitors][0][:snapshots][0][:decisions] = [{
+        campaign_id: '1',
+        experiment_id: '111127',
+        variation_id: '111128'
+      }, {
+        campaign_id: '4',
+        experiment_id: '122230',
+        variation_id: '122231'
+      }]
+
+      conversion_event = @event_builder.create_conversion_event('test_event', 'test_user', nil, nil, '111127' => '111128', '122230' => '122231')
+      expect(conversion_event.params).to eq(@expected_conversion_params)
+      expect(conversion_event.url).to eq(@expected_endpoint)
+      expect(conversion_event.http_verb).to eq(:post)
+    end
+  end
 end