queueit_knownuserv3 3.3.0 → 3.6.1

data/lib/queueit_knownuserv3/user_in_queue_state_cookie_repository.rb

@@ -12,14 +12,12 @@ module QueueIt
 
 		def cancelQueueCookie(eventId, cookieDomain) 
 			cookieKey = self.class.getCookieKey(eventId)
-			@cookieManager.setCookie(cookieKey, nil, -1, cookieDomain)		
+			@cookieManager.setCookie(cookieKey, nil, -1, cookieDomain)
 		end
 
-		def store(eventId, queueId, isStateExtendable, cookieValidityMinute, cookieDomain, secretKey)
+		def store(eventId, queueId, fixedCookieValidityMinutes, cookieDomain, redirectType, secretKey)
 			cookieKey = self.class.getCookieKey(eventId)
-			expirationTime = (Time.now.getutc.tv_sec + (cookieValidityMinute * 60)).to_s
-			isStateExtendableString = (isStateExtendable) ? 'true' : 'false'
-			cookieValue = createCookieValue(queueId, isStateExtendableString, expirationTime, secretKey)
+			cookieValue = createCookieValue(eventId, queueId, Utils.toString(fixedCookieValidityMinutes), redirectType, secretKey)
 			@cookieManager.setCookie(cookieKey, cookieValue, Time.now + (24*60*60), cookieDomain)
 		end
 
@@ -27,19 +25,22 @@ module QueueIt
 			 return QUEUEIT_DATA_KEY + '_' + eventId
 		end
 
-		def createCookieValue(queueId, isStateExtendable, expirationTime, secretKey) 
-			hashValue = OpenSSL::HMAC.hexdigest('sha256', secretKey, queueId + isStateExtendable + expirationTime) 
-			cookieValue = "QueueId=" + queueId + "&IsCookieExtendable=" + isStateExtendable + "&Expires=" + expirationTime + "&Hash=" + hashValue        
+		def createCookieValue(eventId, queueId, fixedCookieValidityMinutes, redirectType, secretKey) 
+			issueTime = Time.now.getutc.tv_sec.to_s
+			hashValue = generateHash(eventId, queueId, fixedCookieValidityMinutes, redirectType, issueTime, secretKey)
+			
+			fixedCookieValidityMinutesPart = ""
+			if(!Utils.isNilOrEmpty(fixedCookieValidityMinutes))
+				fixedCookieValidityMinutesPart = "&FixedValidityMins=" + fixedCookieValidityMinutes
+			end
+		
+			cookieValue = "EventId=" + eventId + "&QueueId=" + queueId + fixedCookieValidityMinutesPart + "&RedirectType=" + redirectType + "&IssueTime=" + issueTime + "&Hash=" + hashValue		
 			return cookieValue
 		end
     
 		def getCookieNameValueMap(cookieValue) 
 			result = Hash.new 
 			cookieNameValues = cookieValue.split("&")
-			if (cookieNameValues.length != 4) 
-				return result
-			end
-
 			cookieNameValues.each do |item|
 				arr = item.split("=")
 				if(arr.length == 2)
@@ -49,34 +50,72 @@ module QueueIt
 			return result
 		end
 
-		def isCookieValid(cookieNameValueMap, secretKey) 
+		def generateHash(eventId, queueId, fixedCookieValidityMinutes, redirectType, issueTime, secretKey)
+			OpenSSL::HMAC.hexdigest('sha256', secretKey, eventId + queueId + fixedCookieValidityMinutes + redirectType + issueTime)
+		end
+
+		def isCookieValid(secretKey, cookieNameValueMap, eventId, cookieValidityMinutes, validateTime) 
 			begin
-				if (!cookieNameValueMap.key?("IsCookieExtendable")) 
+				if (!cookieNameValueMap.key?("EventId")) 
 					return false
 				end
-				if (!cookieNameValueMap.key?("Expires")) 
+				
+				if (!cookieNameValueMap.key?("QueueId")) 
 					return false
 				end
-				if (!cookieNameValueMap.key?("Hash")) 
+				
+				if (!cookieNameValueMap.key?("RedirectType")) 
 					return false
 				end
-				if (!cookieNameValueMap.key?("QueueId")) 
+				
+				if (!cookieNameValueMap.key?("IssueTime")) 
+					return false
+				end
+				
+				if (!cookieNameValueMap.key?("Hash")) 
 					return false
 				end
-				hashValue = OpenSSL::HMAC.hexdigest('sha256', secretKey, cookieNameValueMap["QueueId"] + cookieNameValueMap["IsCookieExtendable"] + cookieNameValueMap["Expires"]) 
+
+				fixedCookieValidityMinutes = ""
+				if (cookieNameValueMap.key?("FixedValidityMins")) 
+					fixedCookieValidityMinutes = cookieNameValueMap["FixedValidityMins"]
+				end
+				
+				hashValue = generateHash(
+					cookieNameValueMap["EventId"], 
+					cookieNameValueMap["QueueId"],
+					fixedCookieValidityMinutes,
+					cookieNameValueMap["RedirectType"],
+					cookieNameValueMap["IssueTime"],
+					secretKey)
+				
 				if (hashValue != cookieNameValueMap["Hash"]) 
 					return false
-				end		
-				if(Integer(cookieNameValueMap["Expires"]) < Time.now.getutc.tv_sec) 
+				end						
+				
+				if (eventId.upcase != cookieNameValueMap["EventId"].upcase) 
 					return false
 				end
-				return true
+				
+				if(validateTime)
+					validity = cookieValidityMinutes
+					if(!Utils.isNilOrEmpty(fixedCookieValidityMinutes))
+						validity = fixedCookieValidityMinutes.to_i
+					end
+					
+					expirationTime = cookieNameValueMap["IssueTime"].to_i + (validity*60)
+					if(expirationTime < Time.now.getutc.tv_sec)
+						return false
+					end
+				end        		
+				
+				return true			
 			rescue
 				return false
 			end
 		end
 
-		def extendQueueCookie(eventId, cookieValidityMinute, cookieDomain, secretKey)       
+		def reissueQueueCookie(eventId, cookieValidityMinutes, cookieDomain, secretKey)       
 			cookieKey = self.class.getCookieKey(eventId)
 			cookieValue = @cookieManager.getCookie(cookieKey)
 			if (cookieValue.nil?) 
@@ -84,42 +123,70 @@ module QueueIt
 			end
        
 			cookieNameValueMap = getCookieNameValueMap(cookieValue)
-			if (!isCookieValid(cookieNameValueMap, secretKey)) 
+			if (!isCookieValid(secretKey, cookieNameValueMap, eventId, cookieValidityMinutes, true)) 
 				return 
 			end
-			expirationTime = (Time.now.getutc.tv_sec + (cookieValidityMinute * 60)).to_s
-			cookieValue = createCookieValue(cookieNameValueMap["QueueId"], cookieNameValueMap["IsCookieExtendable"], expirationTime, secretKey)
+
+			fixedCookieValidityMinutes = ""
+			if (cookieNameValueMap.key?("FixedValidityMins")) 
+				fixedCookieValidityMinutes = cookieNameValueMap["FixedValidityMins"]
+			end
+
+			cookieValue = createCookieValue(
+				eventId, 
+				cookieNameValueMap["QueueId"], 
+				fixedCookieValidityMinutes, 
+				cookieNameValueMap["RedirectType"], 
+				secretKey)
+			
 			@cookieManager.setCookie(cookieKey, cookieValue, Time.now + (24*60*60), cookieDomain)
 		end
 
-		def getState(eventId, secretKey) 
-			cookieKey = cookieKey = self.class.getCookieKey(eventId)
-			if (@cookieManager.getCookie(cookieKey).nil?) 
-				return StateInfo.new(false, nil, false, 0)
-			end
-			cookieNameValueMap = getCookieNameValueMap(@cookieManager.getCookie(cookieKey))
-			if (!isCookieValid(cookieNameValueMap, secretKey))
-				return StateInfo.new(false, nil, false,0)
+		def getState(eventId, cookieValidityMinutes, secretKey, validateTime) 
+			begin
+				cookieKey = self.class.getCookieKey(eventId)
+				if (@cookieManager.getCookie(cookieKey).nil?) 
+					return StateInfo.new(false, false, nil, nil, nil)
+				end
+				cookieNameValueMap = getCookieNameValueMap(@cookieManager.getCookie(cookieKey))
+				if (!isCookieValid(secretKey, cookieNameValueMap, eventId, cookieValidityMinutes, validateTime))
+					return StateInfo.new(true, false, nil, nil, nil)
+				end
+
+				fixedCookieValidityMinutes = nil
+				if (cookieNameValueMap.key?("FixedValidityMins")) 
+					fixedCookieValidityMinutes = cookieNameValueMap["FixedValidityMins"].to_i
+				end
+
+				return StateInfo.new(
+					true,
+					true, 
+					cookieNameValueMap["QueueId"], 
+					fixedCookieValidityMinutes,
+					cookieNameValueMap["RedirectType"])
+			rescue
+				return StateInfo.new(true, false, nil, nil, nil)
 			end
-			return StateInfo.new(
-				true, 
-				cookieNameValueMap["QueueId"], 
-				cookieNameValueMap["IsCookieExtendable"] == 'true',
-				Integer(cookieNameValueMap["Expires"]))
 		end
 	end
 
 	class StateInfo 
+		attr_reader :isFound
 		attr_reader :isValid
 		attr_reader :queueId
-		attr_reader :isStateExtendable    
-		attr_reader :expires # used just for unit tests
+		attr_reader :fixedCookieValidityMinutes
+		attr_reader :redirectType
 
-		def initialize(isValid, queueId, isStateExtendable, expires) 
+		def initialize(isFound, isValid, queueId, fixedCookieValidityMinutes, redirectType) 
+			@isFound = isFound
 			@isValid = isValid
 			@queueId = queueId
-			@isStateExtendable = isStateExtendable
-			@expires = expires
+			@fixedCookieValidityMinutes = fixedCookieValidityMinutes
+			@redirectType = redirectType
+		end
+
+		def isStateExtendable
+			return @isValid && @fixedCookieValidityMinutes.nil?
 		end
 	end
 end

data/license.txt

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/queueit_knownuserv3.gemspec

@@ -5,7 +5,7 @@ require 'queueit_knownuserv3/user_in_queue_service'
 
 Gem::Specification.new do |spec|
   spec.name          = "queueit_knownuserv3"
-  spec.version       = QueueIt::UserInQueueService::SDK_VERSION
+  spec.version       = QueueIt::UserInQueueService::SDK_VERSION_NO
   spec.authors       = ["Queue-it"]
   spec.email         = ["support@queue-it.com"]
   spec.licenses      = "LGPL-3.0"
@@ -25,7 +25,4 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,43 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: queueit_knownuserv3
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.6.1
+  prerelease: 
 platform: ruby
 authors:
 - Queue-it
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.0'
+date: 2020-06-12 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - support@queue-it.com
@@ -45,40 +18,48 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .devcontainer/Dockerfile
+- .devcontainer/devcontainer.json
+- .gitignore
+- .vscode/launch.json
 - Gemfile
 - Rakefile
 - bin/console
 - bin/setup
+- ci-build.yml
 - lib/queueit_knownuserv3.rb
+- lib/queueit_knownuserv3/connector_diagnostics.rb
 - lib/queueit_knownuserv3/integration_config_helpers.rb
 - lib/queueit_knownuserv3/known_user.rb
 - lib/queueit_knownuserv3/models.rb
 - lib/queueit_knownuserv3/queue_url_params.rb
 - lib/queueit_knownuserv3/user_in_queue_service.rb
 - lib/queueit_knownuserv3/user_in_queue_state_cookie_repository.rb
+- license.txt
 - queueit_knownuserv3.gemspec
 homepage: https://www.queue-it.com/
 licenses:
 - LGPL-3.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Gem for implementing Queue-it KnownUser V3
 test_files: []