Merge pull request #145 from DevoInc/fix/keep-alive-spaces-bug

angel-devo · web-flow · commit 5e757e5cdad9 · 2022-07-22T08:19:31.000+02:00
Fix/keep alive spaces bug
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.6.4] - 2022-07-21
+### Fixed
+ * Fixed bug when processing keep alive empty tokens
+
+
 ## [3.6.3] - 2022-07-12
 ### Fixed
  * Dependencies updated for `click` and `PyYAML`
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 
 [![master Build Status](https://travis-ci.com/DevoInc/python-sdk.svg?branch=master)](https://travis-ci.com/DevoInc/python-sdk) [![LICENSE](https://img.shields.io/dub/l/vibe-d.svg)](https://github.com/DevoInc/python-sdk/blob/master/LICENSE)
 
-[![wheel](https://img.shields.io/badge/wheel-yes-brightgreen.svg)](https://pypi.org/project/devo-sdk/) [![version](https://img.shields.io/badge/version-3.6.3-blue.svg)](https://pypi.org/project/devo-sdk/) [![python](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue.svg)](https://pypi.org/project/devo-sdk/)
+[![wheel](https://img.shields.io/badge/wheel-yes-brightgreen.svg)](https://pypi.org/project/devo-sdk/) [![version](https://img.shields.io/badge/version-3.6.4-blue.svg)](https://pypi.org/project/devo-sdk/) [![python](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue.svg)](https://pypi.org/project/devo-sdk/)
 
 
 # Devo Python SDK
@@ -69,9 +69,9 @@ To send data with Devo SDK, first choose the required endpoint depending on the
 |--------	|---------------------------	|------	|
 | USA    	| us.elb.relay.logtrust.net 	| 443  	|
 | Europe 	| eu.elb.relay.logtrust.net 	| 443  	|
-| VDC    	| es.elb.relay.logtrust.net 	| 443  	|
+| Spain  	| es.elb.relay.logtrust.net 	| 443  	|
 
-You have more information in the official documentation of Devo, [Sending data to Devo](https://docs.devo.com/confluence/ndt/sending-data-to-devo).
+You have more information in the official documentation of Devo, [Sending data to Devo](https://docs.devo.com/space/latest/94652410/Sending%20data%20to%20Devo).
 
 ##### API
 To perform a request with API, first choose the required endpoint depending on the region your are accessing from:
@@ -81,13 +81,14 @@ To perform a request with API, first choose the required endpoint depending on t
 | USA    	| https://apiv2-us.devo.com/search/query 	|
 | Canada 	| https://apiv2-ca.devo.com/search/query 	|
 | Europe 	| https://apiv2-eu.devo.com/search/query 	|
-| VDC    	| https://apiv2-es.devo.com/search/query 	|
+| Spain  	| https://apiv2-es.devo.com/search/query 	|
+| APAC  	| https://api-apac.devo.com/search/query 	|
 
-You have more information in the official documentation of Devo, [REST API](https://docs.devo.com/confluence/ndt/latest/api-reference/query-api) .
+You have more information in the official documentation of Devo, [REST API](https://docs.devo.com/space/latest/95128275/Query%20API).
 
 ## Credentials
 To obtain the access credentials necessary to use this SDK, you must have an account in [DEVO](https://www.devo.com/).<br/>
-Check the [security credentials](https://docs.devo.com/confluence/ndt/domain-administration/security-credentials) info for more details. 
+Check the [security credentials](https://docs.devo.com/space/latest/94763701/Security%20credentials) info for more details. 
 
 ##### Certificates
 You need use a three files (Cert, key and chain) to secure send data to Devo. 
diff --git a/devo/__version__.py b/devo/__version__.py
@@ -1,7 +1,7 @@
 __description__ = 'Devo Python Library.'
 __url__ = 'http://www.devo.com'
-__version__ = "3.6.3"
+__version__ = "3.6.4"
 __author__ = 'Devo'
 __author_email__ = 'support@devo.com'
 __license__ = 'MIT'
-__copyright__ = 'Copyright 2021 Devo'
+__copyright__ = 'Copyright 2022 Devo'
diff --git a/devo/api/__init__.py b/devo/api/__init__.py
@@ -1,3 +1,3 @@
-from .client import Client, DevoClientException, DEFAULT, TO_STR, \
-    TO_BYTES, JSON, JSON_SIMPLE, COMPACT_TO_ARRAY, \
-    SIMPLECOMPACT_TO_ARRAY, SIMPLECOMPACT_TO_OBJ, ClientConfig
+from .client import (COMPACT_TO_ARRAY, DEFAULT, JSON, JSON_SIMPLE,
+                     SIMPLECOMPACT_TO_ARRAY, SIMPLECOMPACT_TO_OBJ, TO_BYTES,
+                     TO_STR, Client, ClientConfig, DevoClientException)
diff --git a/devo/api/processors.py b/devo/api/processors.py
@@ -26,9 +26,10 @@ def proc_json():
     Return json object processor
     :return: json object
     """
-    return lambda data: json.loads(data if isinstance(data, str)
-                                   else data.decode("utf-8"))\
-        if data else None
+    return lambda data: json.loads(data
+                                   if isinstance(data, str) else data.decode(
+                                       "utf-8")) if data and proc_bytes_to_str(
+                                       )(data) != '' else None
 
 
 def proc_json_simple():
@@ -42,22 +43,30 @@ def proc_json_compact_to_array():
     """
     :return: json object
     """
-    return lambda data: proc_json()(data)['object']['d'] if data else None
+    return lambda data: proc_json()(data)['object']['d'] \
+        if data and isinstance(
+            data, bytes) and proc_bytes_to_str()(data) != '' else None
 
 
 def json_compact_simple_names(data):
-    return [item for item in sorted(data, key=lambda x: data[x]['index'])]
+    if isinstance(data, bytes) and proc_bytes_to_str()(data) == '':
+        return []
+    else:
+        return [item for item in sorted(data, key=lambda x: data[x]['index'])]
 
 
 def proc_json_compact_simple_to_jobj(names=None):
     return proc_json_compact_simple_to_array() if not names else \
         lambda data: dict(zip(names,
-                              proc_json_compact_simple_to_array()(data))) \
-            if data else {}
+                              proc_json_compact_simple_to_array()(
+                                data))) if data and isinstance(
+                                data, bytes) and proc_bytes_to_str()(
+                                    data) != '' else {}
 
 
 def proc_json_compact_simple_to_array():
-    return lambda data: proc_json()(data)['d'] if data else []
+    return lambda data: proc_json()(data)['d'] if data and isinstance(
+        data, bytes) and proc_bytes_to_str()(data) != '' else []
 
 
 def processors():
diff --git a/devo/api/scripts/client_cli.py b/devo/api/scripts/client_cli.py
@@ -14,7 +14,7 @@
 @click.group(invoke_without_command=True)
 @click.option('--version', "-v", is_flag=True, default=False)
 def cli(version):
-    """ Initialize click """
+    """Devo API Command-line Interface"""
     if version:
         pkg_dir = os.path.abspath(os.path.join(
             os.path.dirname(__file__), "..", "..",
diff --git a/devo/sender/scripts/sender_cli.py b/devo/sender/scripts/sender_cli.py
@@ -22,7 +22,7 @@
 @click.group(invoke_without_command=True)
 @click.option('--version', "-v", is_flag=True, default=False)
 def cli(version):
-    """ Initialize click """
+    """Devo Sender Command-line Interface"""
     if version:
         pkg_dir = os.path.abspath(os.path.join(
             os.path.dirname(__file__), "..", "..",
diff --git a/docs/api/api.md b/docs/api/api.md
@@ -11,9 +11,10 @@ To perform a request with API, first choose the required endpoint depending on t
 | USA    	| https://apiv2-us.devo.com/search/query 	|
 | Canada 	| https://apiv2-ca.devo.com/search/query 	|
 | Europe 	| https://apiv2-eu.devo.com/search/query 	|
-| VDC    	| https://apiv2-es.devo.com/search/query 	|
+| Spain  	| https://apiv2-es.devo.com/search/query 	|
+| APAC  	| https://api-apac.devo.com/search/query 	|
 
-You have more information in the official documentation of Devo, [REST API](https://docs.devo.com/confluence/ndt/api-reference/rest-api) .
+You have more information in the official documentation of Devo, [REST API](https://docs.devo.com/space/latest/95128275/Query%20API).
 
 #### Differences in use from version 2 to 3:
 
diff --git a/docs/sender/sender.md b/docs/sender/sender.md
@@ -21,9 +21,9 @@ To send data with Devo SDK, first choose the required endpoint depending on the
 |--------	|---------------------------	|------	|
 | USA    	| us.elb.relay.logtrust.net 	| 443  	|
 | Europe 	| eu.elb.relay.logtrust.net 	| 443  	|
-| VDC    	| es.elb.relay.logtrust.net 	| 443  	|
+| Spain  	| es.elb.relay.logtrust.net 	| 443  	|
     
-You have more information in the official documentation of Devo, [Sending data to Devo](https://docs.devo.com/confluence/ndt/sending-data-to-devo).
+You have more information in the official documentation of Devo, [Sending data to Devo](https://docs.devo.com/space/latest/94652410/Sending%20data%20to%20Devo).
 
 #### Differences in use from version 2 to 3:
 
diff --git a/tests/api/__init__.py b/tests/api/__init__.py
@@ -1,2 +1 @@
 """Python library for Devo."""
-
diff --git a/tests/api/cli.py b/tests/api/cli.py
@@ -1,12 +1,14 @@
-import unittest
 import os
+import unittest
+
 from click.testing import CliRunner
-from devo.common import Configuration
-from devo.api.scripts.client_cli import query
 from devo.api.client import ERROR_MSGS, DevoClientException
+from devo.api.scripts.client_cli import query
+from devo.common import Configuration
 
 
 class TestApi(unittest.TestCase):
+
     def setUp(self):
         self.query = 'from demo.ecommerce.data select * limit 1'
         self.app_name = "testing-app_name"
@@ -20,12 +22,18 @@ def setUp(self):
         self.comment = os.getenv('DEVO_API_COMMENT', None)
 
         configuration = Configuration()
-        configuration.set("api", {
-            "query": self.query, "address": self.uri,
-            "key": self.key, "secret": self.secret, "token": self.token,
-            "query_id": self.query_id, "user": self.user,
-            "comment": self.comment, "app_name": self.app_name
-        })
+        configuration.set(
+            "api", {
+                "query": self.query,
+                "address": self.uri,
+                "key": self.key,
+                "secret": self.secret,
+                "token": self.token,
+                "query_id": self.query_id,
+                "user": self.user,
+                "comment": self.comment,
+                "app_name": self.app_name
+            })
         self.config_path = "/tmp/devo_api_tests_config.json"
         configuration.save(path=self.config_path)
 
@@ -36,11 +44,11 @@ def test_query_args(self):
 
     def test_not_credentials(self):
         runner = CliRunner()
-        result = runner.invoke(query, ["--debug",
-                                       "--from", "2018-01-01",
-                                       "--query", "from demo.ecommerce.data "
-                                                  "select timestamp limit 1",
-                                       "--address", self.uri])
+        result = runner.invoke(query, [
+            "--debug", "--from", "2018-01-01", "--query",
+            "from demo.ecommerce.data "
+            "select timestamp limit 1", "--address", self.uri
+        ])
 
         self.assertIsInstance(result.exception, DevoClientException)
         self.assertEqual(result.exception.args[0]['status'], 500)
@@ -49,39 +57,35 @@ def test_not_credentials(self):
 
     def test_bad_url(self):
         runner = CliRunner()
-        result = runner.invoke(query, ["--debug",
-                                       "--from", "2018-01-01",
-                                       "--query", "from demo.ecommerce.data "
-                                                  "select timestamp limit 1",
-                                       "--address", "error-apiv2-us.logtrust"
-                                                ".com/search/query",
-                                       "--key", self.key,
-                                       "--secret", self.secret])
+        result = runner.invoke(query, [
+            "--debug", "--from", "2018-01-01", "--query",
+            "from demo.ecommerce.data "
+            "select timestamp limit 1", "--address", "error-apiv2-us.logtrust"
+            ".com/search/query", "--key", self.key, "--secret", self.secret
+        ])
         self.assertIsInstance(result.exception, DevoClientException)
         self.assertEqual(result.exception.args[0]['status'], 500)
 
     def test_bad_credentials(self):
         runner = CliRunner()
-        result = runner.invoke(query, ["--debug",
-                                       "--from", "2018-01-01",
-                                       "--query", "from demo.ecommerce.data "
-                                                  "select timestamp limit 1",
-                                       "--address", self.uri,
-                                       "--key", "aaa",
-                                       "--secret", self.secret])
+        result = runner.invoke(query, [
+            "--debug", "--from", "2018-01-01", "--query",
+            "from demo.ecommerce.data "
+            "select timestamp limit 1", "--address", self.uri, "--key", "aaa",
+            "--secret", self.secret
+        ])
 
         self.assertIsInstance(result.exception, DevoClientException)
         self.assertEqual(result.exception.args[0]['error']['code'], 12)
 
     def test_normal_query(self):
         runner = CliRunner()
-        result = runner.invoke(query, ["--debug",
-                                       "--from", "2018-01-01",
-                                       "--query", "from demo.ecommerce.data "
-                                                  "select timestamp limit 1",
-                                       "--address", self.uri,
-                                       "--key", self.key,
-                                       "--secret", self.secret])
+        result = runner.invoke(query, [
+            "--debug", "--from", "2018-01-01", "--query",
+            "from demo.ecommerce.data "
+            "select timestamp limit 1", "--address", self.uri, "--key",
+            self.key, "--secret", self.secret
+        ])
 
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
@@ -91,12 +95,11 @@ def test_normal_query(self):
     def test_with_config_file(self):
         if self.config_path:
             runner = CliRunner()
-            result = runner.invoke(query, ["--debug",
-                                           "--from", "2018-01-01",
-                                           "--query",
-                                           "from demo.ecommerce.data "
-                                           "select timestamp limit 1",
-                                           "--config", self.config_path])
+            result = runner.invoke(query, [
+                "--debug", "--from", "2018-01-01", "--query",
+                "from demo.ecommerce.data "
+                "select timestamp limit 1", "--config", self.config_path
+            ])
 
             self.assertIsNone(result.exception)
             self.assertEqual(result.exit_code, 0)
diff --git a/tests/api/test_proccesors.py b/tests/api/test_proccesors.py
