Preparing release 3.7.0

Author: queue-it

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -149,5 +149,35 @@ def index(request):
         # There was an error validating the request
         # Use your own logging framework to log the error
         # This was a configuration error, so we let the user continue
-        print stdErr.message        
+        print stdErr.message
+```
+
+## Request body trigger (advanced)
+
+The connector supports triggering on request body content. An example could be a POST call with specific item ID where you want end-users to queue up for.
+For this to work, you will need to contact Queue-it support or enable request body triggers in your integration settings in your GO Queue-it platform account.
+Once enabled you will need to update your integration so request body is available for the connector.  
+You need to create a new context provider similar to this one:
+
+```python
+from queueit_knownuserv3.http_context_providers import Django_1_8_Provider
+
+
+class Django_1_8_Provider_WithBody(Django_1_8_Provider):
+    def __init__(self, request, response):
+        super(Django_1_8_Provider_WithBody, self).__init__(request, response)
+
+    def getRequestBodyAsString(self):
+        return self.request.body
+
+```
+
+And then use it instead of `Django_1_8_Provider`
+
+```python
+# The default Django_1_8_Provider class always returns empty string as request body.
+# So we use Django_1_8_Provider_WithBody in order to read the body.
+# If you don't need to read the request body you may use Django_1_8_Provider
+# http_context_provider = Django_1_8_Provider(request, response)
+http_context_provider = Django_1_8_Provider_WithBody(request, response)
 ```

SDK/.gitignore

@@ -4,3 +4,4 @@
 
 *.pyc
 /.vs
+.idea

SDK/_run_all_tests.py

@@ -4,7 +4,7 @@
 suite = unittest.TestLoader().discover("")
 result = unittest.TextTestRunner(verbosity=1).run(suite)
 
-if(result.wasSuccessful()):
-	sys.exit(0)
+if result.wasSuccessful():
+    sys.exit(0)
 else:
-	sys.exit(1)
+    sys.exit(1)

SDK/queueit_knownuserv3/connector_diagnostics.py

@@ -2,51 +2,52 @@
 from models import RequestValidationResult, Utils
 from queueit_helpers import QueueitHelpers
 
+
 class ConnectorDiagnostics:
     def __init__(self):
         self.isEnabled = False
         self.hasError = False
         self.validationResult = RequestValidationResult(None, None, None, None, None, None)
 
-    def __setStateWithTokenError(self, customerId, errorCode):
+    def __setStateWithTokenError(self, customer_id, error_code):
         self.hasError = True
-        redirectUrl = "https://{0}.api2.queue-it.net/{0}/diagnostics/connector/error/?code={1}".format(customerId, errorCode)
+        redirect_url_template = "https://{0}.api2.queue-it.net/{0}/diagnostics/connector/error/?code={1}"
+        redirect_url = redirect_url_template.format(customer_id, error_code)
         self.validationResult = RequestValidationResult("ConnectorDiagnosticsRedirect",
-                                                        None, None, redirectUrl, None, None)
+                                                        None, None, redirect_url, None, None)
 
     def __setStateWithSetupError(self):
         self.hasError = True
-        redirectUrl = "https://api2.queue-it.net/diagnostics/connector/error/?code=setup"
+        redirect_url = "https://api2.queue-it.net/diagnostics/connector/error/?code=setup"
         self.validationResult = RequestValidationResult("ConnectorDiagnosticsRedirect",
-                                                        None, None, redirectUrl, None, None)
+                                                        None, None, redirect_url, None, None)
 
     @staticmethod
-    def verify(customerId, secretKey, queueitToken):
+    def verify(customer_id, secret_key, queueit_token):
         diagnostics = ConnectorDiagnostics()
-        qParams = QueueUrlParams.extractQueueParams(queueitToken)
+        q_params = QueueUrlParams.extractQueueParams(queueit_token)
 
-        if(qParams == None):
+        if q_params is None:
             return diagnostics
 
-        if(qParams.redirectType == None):
+        if q_params.redirectType is None:
             return diagnostics
 
-        if(qParams.redirectType != "debug"):
+        if q_params.redirectType != "debug":
             return diagnostics
 
-        if(Utils.isNilOrEmpty(customerId) or Utils.isNilOrEmpty(secretKey)):
+        if Utils.isNilOrEmpty(customer_id) or Utils.isNilOrEmpty(secret_key):
             diagnostics.__setStateWithSetupError()
             return diagnostics
 
-        calculatedHash = QueueitHelpers.hmacSha256Encode(qParams.queueITTokenWithoutHash, secretKey)
-        if(qParams.hashCode != calculatedHash):
-            diagnostics.__setStateWithTokenError(customerId, "hash")
+        expected_hash = QueueitHelpers.hmacSha256Encode(q_params.queueITTokenWithoutHash, secret_key)
+        if q_params.hashCode != expected_hash:
+            diagnostics.__setStateWithTokenError(customer_id, "hash")
             return diagnostics
 
-        if(qParams.timeStamp < QueueitHelpers.getCurrentTime()):
-            diagnostics.__setStateWithTokenError(customerId, "timestamp")
+        if q_params.timeStamp < QueueitHelpers.getCurrentTime():
+            diagnostics.__setStateWithTokenError(customer_id, "timestamp")
             return diagnostics
 
         diagnostics.isEnabled = True
         return diagnostics
-

SDK/queueit_knownuserv3/http_context_providers.py

@@ -1,13 +1,13 @@
 from queueit_helpers import QueueitHelpers
 
 
-class HttpContextProvider:
+class HttpContextProvider(object):
     ERROR_MSG = "Please implement/use specific provider"
 
     def getProviderName(self):
         raise NotImplementedError(self.ERROR_MSG)
 
-    def setCookie(self, name, value, expire, domain):
+    def setCookie(self, name, value, expire, domain, is_http_only, is_secure):
         raise NotImplementedError(self.ERROR_MSG)
 
     def getCookie(self, name):
@@ -16,12 +16,15 @@ def getCookie(self, name):
     def getHeader(self, name):
         raise NotImplementedError(self.ERROR_MSG)
 
-    def getRequestIp(self, name):
+    def getRequestIp(self):
         raise NotImplementedError(self.ERROR_MSG)
 
     def getOriginalRequestUrl(self):
         raise NotImplementedError(self.ERROR_MSG)
 
+    def getRequestBodyAsString(self):
+        raise NotImplementedError(self.ERROR_MSG)
+
 
 class Django_1_8_Provider(HttpContextProvider):
     def __init__(self, request, response):
@@ -31,11 +34,11 @@ def __init__(self, request, response):
     def getProviderName(self):
         return "django_1_8"
 
-    def setCookie(self, name, value, expire, domain):
-        if (str(domain) == ""):
+    def setCookie(self, name, value, expire, domain, is_http_only, is_secure):
+        if str(domain) == "":
             domain = None
 
-        if (value is not None):
+        if value is not None:
             value = QueueitHelpers.urlEncode(value)
 
         self.response.set_cookie(
@@ -45,17 +48,17 @@ def setCookie(self, name, value, expire, domain):
             expires=expire,
             path='/',
             domain=domain,
-            secure=None,
-            httponly=False)
+            secure=is_secure,
+            httponly=is_http_only)
 
     def getCookie(self, name):
         value = self.request.COOKIES.get(name)
-        if (value is not None):
+        if value is not None:
             value = QueueitHelpers.urlDecode(value)
         return value
 
     def getHeader(self, name):
-        if (name is None or name == ""):
+        if name is None or name == "":
             return None
 
         key = "HTTP_" + name.replace("-", "_").upper()
@@ -65,4 +68,7 @@ def getRequestIp(self):
         return self.request.META.get("REMOTE_ADDR")
 
     def getOriginalRequestUrl(self):
-        return self.request.build_absolute_uri()
+        return self.request.build_absolute_uri()
+
+    def getRequestBodyAsString(self):
+        return ''