Release 3.4

Author: frwiqueueit

lib/queueit_knownuserv3/integration_config_helpers.rb

@@ -75,22 +75,23 @@ def evaluateTriggerPart(triggerPart, currentPageUrl, request)
 
 	class UrlValidatorHelper
 		def self.evaluate(triggerPart, url)
-			if (!triggerPart.key?("Operator") ||
+			if (triggerPart.nil? || 
+				!triggerPart.key?("Operator") ||
 				!triggerPart.key?("IsNegative") ||
 				!triggerPart.key?("IsIgnoreCase") ||
-				!triggerPart.key?("ValueToCompare") ||
 				!triggerPart.key?("UrlPart"))
-				return false;
+				return false
 			end
-
+			
 			urlPart = UrlValidatorHelper.getUrlPart(triggerPart["UrlPart"], url)
 
 			return ComparisonOperatorHelper.evaluate(
 				triggerPart["Operator"], 
 				triggerPart["IsNegative"], 
 				triggerPart["IsIgnoreCase"], 
 				urlPart, 
-				triggerPart["ValueToCompare"])
+				triggerPart["ValueToCompare"],
+				triggerPart["ValuesToCompare"])
 		end
 
 		def self.getUrlPart(urlPart, url)
@@ -115,12 +116,12 @@ def self.getUrlPart(urlPart, url)
 	class CookieValidatorHelper
 		def self.evaluate(triggerPart, cookieJar)
 			begin
-				if (!triggerPart.key?("Operator") ||
+				if (triggerPart.nil? ||
+					!triggerPart.key?("Operator") ||
 					!triggerPart.key?("IsNegative") ||
 					!triggerPart.key?("IsIgnoreCase") ||
-					!triggerPart.key?("ValueToCompare") ||
 					!triggerPart.key?("CookieName"))
-					return false;
+					return false
 				end
 
 				if(cookieJar.nil?)
@@ -137,7 +138,8 @@ def self.evaluate(triggerPart, cookieJar)
 					triggerPart["IsNegative"], 
 					triggerPart["IsIgnoreCase"], 
 					cookieValue, 
-					triggerPart["ValueToCompare"])
+					triggerPart["ValueToCompare"],
+					triggerPart["ValuesToCompare"])
 			rescue
 				return false
 			end
@@ -147,69 +149,88 @@ def self.evaluate(triggerPart, cookieJar)
 	class UserAgentValidatorHelper
 		def self.evaluate(triggerPart, userAgent)
 			begin
-				if (!triggerPart.key?("Operator") ||
+				if (triggerPart.nil? ||
+					!triggerPart.key?("Operator") ||
 					!triggerPart.key?("IsNegative") ||
-					!triggerPart.key?("IsIgnoreCase") ||
-					!triggerPart.key?("ValueToCompare"))
-					return false;
+					!triggerPart.key?("IsIgnoreCase"))
+					return false
 				end
-
+			
 				return ComparisonOperatorHelper.evaluate(
 					triggerPart["Operator"], 
 					triggerPart["IsNegative"], 
 					triggerPart["IsIgnoreCase"], 
 					userAgent, 
-					triggerPart["ValueToCompare"])
+					triggerPart["ValueToCompare"],
+					triggerPart["ValuesToCompare"])
 			end
 		end
 	end
 
 	class HttpHeaderValidatorHelper
 		def self.evaluate(triggerPart, headers)
-			begin				
+			begin
+				if (triggerPart.nil? || 
+					!triggerPart.key?("Operator") ||
+					!triggerPart.key?("IsNegative") ||
+					!triggerPart.key?("IsIgnoreCase")
+					!triggerPart.key?("HttpHeaderName"))
+					return false
+				end
+
 				headerValue = headers[triggerPart['HttpHeaderName']]
 				return ComparisonOperatorHelper.evaluate(
 					triggerPart["Operator"], 
 					triggerPart["IsNegative"], 
 					triggerPart["IsIgnoreCase"], 
 					headerValue, 
-					triggerPart["ValueToCompare"])				
+					triggerPart["ValueToCompare"],
+					triggerPart["ValuesToCompare"])
 			rescue
 				return false
 			end
 		end
 	end
 
 	class ComparisonOperatorHelper
-		def self.evaluate(opt, isNegative, ignoreCase, left, right)
-			if(left.nil?)
-				left = ''
+		def self.evaluate(opt, isNegative, ignoreCase, value, valueToCompare, valuesToCompare)
+			if (value.nil?)
+				value = ''
+			end
+			
+			if (valueToCompare.nil?) 
+				valueToCompare = ''
 			end
-			if(right.nil?) 
-				right = ''
+			
+			if (valuesToCompare.nil?)
+				valuesToCompare = []
 			end
 
 			case opt		
 				when "Equals"
-					return ComparisonOperatorHelper.equals(left, right, isNegative, ignoreCase)
+					return ComparisonOperatorHelper.equals(value, valueToCompare, isNegative, ignoreCase)
 				when "Contains" 
-					return ComparisonOperatorHelper.contains(left, right, isNegative, ignoreCase)
+					return ComparisonOperatorHelper.contains(value, valueToCompare, isNegative, ignoreCase)
 				when "StartsWith"
-					return ComparisonOperatorHelper.startsWith(left, right, isNegative, ignoreCase)
+					return ComparisonOperatorHelper.startsWith(value, valueToCompare, isNegative, ignoreCase)
 				when "EndsWith"
-					return ComparisonOperatorHelper.endsWith(left, right, isNegative, ignoreCase)
+					return ComparisonOperatorHelper.endsWith(value, valueToCompare, isNegative, ignoreCase)
 				when "MatchesWith"
-					return ComparisonOperatorHelper.matchesWith(left, right, isNegative, ignoreCase)
+					return ComparisonOperatorHelper.matchesWith(value, valueToCompare, isNegative, ignoreCase)
+				when "EqualsAny"
+					return ComparisonOperatorHelper.equalsAny(value, valuesToCompare, isNegative, ignoreCase)
+				when "ContainsAny"
+					return ComparisonOperatorHelper.containsAny(value, valuesToCompare, isNegative, ignoreCase)
 				else
 					return false
 			end
 		end
 
-		def self.equals(left, right, isNegative, ignoreCase)
+		def self.equals(value, valueToCompare, isNegative, ignoreCase)
 			if(ignoreCase)
-				evaluation = left.upcase.eql? right.upcase
+				evaluation = value.upcase.eql? valueToCompare.upcase
 			else
-				evaluation = left.eql? right
+				evaluation = value.eql? valueToCompare
 			end
 
 			if(isNegative)
@@ -219,29 +240,29 @@ def self.equals(left, right, isNegative, ignoreCase)
 			end
 		end
 
-		def self.contains(left, right, isNegative, ignoreCase)
-			if(right.eql? "*")
+		def self.contains(value, valueToCompare, isNegative, ignoreCase)
+			if(valueToCompare.eql? "*")
 				return true
 			end
 
 			if(ignoreCase)
-				left = left.upcase
-				right = right.upcase
+				value = value.upcase
+				valueToCompare = valueToCompare.upcase
 			end
 
-			evaluation = left.include? right
+			evaluation = value.include? valueToCompare
 			if(isNegative)
 				return !evaluation
 			else
 				return evaluation
 			end
 		end
 
-		def self.startsWith(left, right, isNegative, ignoreCase)
+		def self.startsWith(value, valueToCompare, isNegative, ignoreCase)
 			if(ignoreCase)
-				evaluation = left.upcase.start_with? right.upcase
+				evaluation = value.upcase.start_with? valueToCompare.upcase
 			else
-				evaluation = left.start_with? right
+				evaluation = value.start_with? valueToCompare
 			end
 
 			if(isNegative)
@@ -251,11 +272,11 @@ def self.startsWith(left, right, isNegative, ignoreCase)
 			end
 		end
 
-		def self.endsWith(left, right, isNegative, ignoreCase)
+		def self.endsWith(value, valueToCompare, isNegative, ignoreCase)
 			if(ignoreCase)
-				evaluation = left.upcase.end_with? right.upcase
+				evaluation = value.upcase.end_with? valueToCompare.upcase
 			else
-				evaluation = left.end_with? right
+				evaluation = value.end_with? valueToCompare
 			end
 
 			if(isNegative)
@@ -265,19 +286,37 @@ def self.endsWith(left, right, isNegative, ignoreCase)
 			end
 		end
 
-		def self.matchesWith(left, right, isNegative, ignoreCase)
+		def self.matchesWith(value, valueToCompare, isNegative, ignoreCase)
 			if(ignoreCase)
-				pattern = Regexp.new(right, Regexp::IGNORECASE) 
+				pattern = Regexp.new(valueToCompare, Regexp::IGNORECASE) 
 			else
-				pattern = Regexp.new(right)
+				pattern = Regexp.new(valueToCompare)
 			end
 
-			evaluation = pattern.match(left) != nil
+			evaluation = pattern.match(value) != nil
 			if(isNegative)
 				return !evaluation
 			else
 				return evaluation
 			end
 		end
+
+		def self.equalsAny(value, valuesToCompare, isNegative, ignoreCase)
+			valuesToCompare.each do |valueToCompare|
+				if (ComparisonOperatorHelper.equals(value, valueToCompare, false, ignoreCase))
+					return !isNegative
+				end
+			end
+			return isNegative
+		end
+
+		def self.containsAny(value, valuesToCompare, isNegative, ignoreCase)
+			valuesToCompare.each do |valueToCompare|
+				if (ComparisonOperatorHelper.contains(value, valueToCompare, false, ignoreCase))
+					return !isNegative
+				end
+			end
+			return isNegative
+		end
 	end
 end

lib/queueit_knownuserv3/known_user.rb

@@ -226,44 +226,59 @@ def self.validateRequestByIntegrationConfig(currentUrlWithoutQueueITToken, queue
 					return RequestValidationResult.new(nil, nil, nil, nil)
 				end
 
+				# unspecified or 'Queue' specified
 				if(!matchedConfig.key?("ActionType") || Utils.isNilOrEmpty(matchedConfig["ActionType"]) || matchedConfig["ActionType"].eql?(ActionTypes::QUEUE))
-					queueConfig = QueueEventConfig.new
-					queueConfig.eventId = matchedConfig["EventId"]
-					queueConfig.queueDomain = matchedConfig["QueueDomain"]
-					queueConfig.layoutName = matchedConfig["LayoutName"]
-					queueConfig.culture = matchedConfig["Culture"]
-					queueConfig.cookieDomain = matchedConfig["CookieDomain"]
-					queueConfig.extendCookieValidity = matchedConfig["ExtendCookieValidity"]
-					queueConfig.cookieValidityMinute = matchedConfig["CookieValidityMinute"]
-					queueConfig.version = customerIntegration["Version"]
-			
-					case matchedConfig["RedirectLogic"]
-						when "ForcedTargetUrl"
-							targetUrl = matchedConfig["ForcedTargetUrl"]					
-						when "EventTargetUrl"
-							targetUrl = ''
-						else
-							targetUrl = currentUrlWithoutQueueITToken
-					end
-
-					return _resolveQueueRequestByLocalConfig(targetUrl, queueitToken, queueConfig, customerId, secretKey, request, debugEntries)			
-			
-				else # cancel action			
-					cancelConfig = CancelEventConfig.new;
-					cancelConfig.eventId = matchedConfig["EventId"]
-					cancelConfig.queueDomain = matchedConfig["QueueDomain"]
-					cancelConfig.cookieDomain = matchedConfig["CookieDomain"]
-					cancelConfig.version = customerIntegration["Version"]
-            
-					return _cancelRequestByLocalConfig(currentUrlWithoutQueueITToken, queueitToken, cancelConfig, customerId, secretKey, request, debugEntries);
+					handleQueueAction(currentUrlWithoutQueueITToken, queueitToken, customerIntegration, customerId, secretKey, matchedConfig, request, debugEntries)
+				
+				elsif(matchedConfig["ActionType"].eql?(ActionTypes::CANCEL))
+					handleCancelAction(currentUrlWithoutQueueITToken, queueitToken, customerIntegration, customerId, secretKey, matchedConfig, request, debugEntries)
+					
+				# for all unknown types default to 'Ignore'
+				else
+					userInQueueService = getUserInQueueService(request.cookie_jar)
+					userInQueueService.getIgnoreActionResult()
 				end
+
 			rescue StandardError => stdErr
 				raise KnownUserError, "integrationConfiguration text was not valid: " + stdErr.message
 			ensure
 				setDebugCookie(debugEntries, request.cookie_jar)
 			end
 		end
 
+		def self.handleQueueAction(currentUrlWithoutQueueITToken, queueitToken, customerIntegration, customerId, secretKey, matchedConfig, request, debugEntries)
+			queueConfig = QueueEventConfig.new
+			queueConfig.eventId = matchedConfig["EventId"]
+			queueConfig.queueDomain = matchedConfig["QueueDomain"]
+			queueConfig.layoutName = matchedConfig["LayoutName"]
+			queueConfig.culture = matchedConfig["Culture"]
+			queueConfig.cookieDomain = matchedConfig["CookieDomain"]
+			queueConfig.extendCookieValidity = matchedConfig["ExtendCookieValidity"]
+			queueConfig.cookieValidityMinute = matchedConfig["CookieValidityMinute"]
+			queueConfig.version = customerIntegration["Version"]
+			
+			case matchedConfig["RedirectLogic"]
+				when "ForcedTargetUrl"
+					targetUrl = matchedConfig["ForcedTargetUrl"]					
+				when "EventTargetUrl"
+					targetUrl = ''
+				else
+					targetUrl = currentUrlWithoutQueueITToken
+			end
+
+			return _resolveQueueRequestByLocalConfig(targetUrl, queueitToken, queueConfig, customerId, secretKey, request, debugEntries)		
+		end
+
+		def self.handleCancelAction(currentUrlWithoutQueueITToken, queueitToken, customerIntegration, customerId, secretKey, matchedConfig, request, debugEntries)
+			cancelConfig = CancelEventConfig.new;
+			cancelConfig.eventId = matchedConfig["EventId"]
+			cancelConfig.queueDomain = matchedConfig["QueueDomain"]
+			cancelConfig.cookieDomain = matchedConfig["CookieDomain"]
+			cancelConfig.version = customerIntegration["Version"]
+            
+			return _cancelRequestByLocalConfig(currentUrlWithoutQueueITToken, queueitToken, cancelConfig, customerId, secretKey, request, debugEntries);
+		end
+
 		def self.cancelRequestByLocalConfig(targetUrl, queueitToken, cancelConfig, customerId, secretKey, request)
 			debugEntries = Hash.new
 			begin

lib/queueit_knownuserv3/models.rb

@@ -92,5 +92,6 @@ def initialize(message)
 	class ActionTypes
 		CANCEL = "Cancel"
 		QUEUE = "Queue"
+		IGNORE = "Ignore"
 	end
 end

lib/queueit_knownuserv3/user_in_queue_service.rb

@@ -3,7 +3,7 @@
 
 module QueueIt
 	class UserInQueueService
-		SDK_VERSION = "3.3.2"
+		SDK_VERSION = "3.4.0"
 
 		def initialize(userInQueueStateRepository)
 			@userInQueueStateRepository = userInQueueStateRepository
@@ -70,7 +70,7 @@ def getQueueITTokenValidationResult(targetUrl, eventId, config, queueParams,cust
 				!(queueParams.cookieValidityMinute.nil?) ? queueParams.cookieValidityMinute : config.cookieValidityMinute,
 				!Utils::isNilOrEmpty(config.cookieDomain) ? config.cookieDomain : '',
 				secretKey)
-			return RequestValidationResult.new(ActionTypes::QUEUE, config.eventId, queueParams.queueId, nil)        		
+			return RequestValidationResult.new(ActionTypes::QUEUE, config.eventId, queueParams.queueId, nil)
 		end
 
 		def getVaidationErrorResult(customerId, targetUrl, config, qParams, errorCode) 
@@ -112,5 +112,9 @@ def getQueryString(customerId, eventId, configVersion, culture, layoutName)
 		def extendQueueCookie(eventId, cookieValidityMinute, cookieDomain, secretKey) 
 			@userInQueueStateRepository.extendQueueCookie(eventId, cookieValidityMinute, cookieDomain, secretKey)
 		end
+
+		def getIgnoreActionResult()
+			return RequestValidationResult.new(ActionTypes::IGNORE, nil, nil, nil)
+		end
 	end
 end