Merge pull request #89 from Worvast/master

## [3.3.1] - 2020-05-11

Author: Worvast

CHANGELOG.md

@@ -4,6 +4,17 @@ 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.3.1] - 2020-05-11
+### Added
+ * env vars JWT and TOKEN for API shell client
+ * verify certs in API creation and cli calls
+ 
+### Fixed
+ * Documentation about SSLConfigSender
+ 
+### Deprecated
+ * Unnecesary setters
+
 ## [No version upgraded] - 2020-04-29
 ### Added
  * Added examples

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.3.0-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-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.3.1-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-blue.svg)](https://pypi.org/project/devo-sdk/)
 
 
 # Devo Python SDK

devo/__version__.py

@@ -1,6 +1,6 @@
 __description__ = 'Devo Python Library.'
 __url__ = 'http://www.devo.com'
-__version__ = "3.3.0"
+__version__ = "3.3.1"
 __author__ = 'Devo'
 __author_email__ = 'support@devo.com'
 __license__ = 'MIT'

devo/api/client.py

@@ -133,7 +133,7 @@ class Client:
     The Devo seach rest api main class
     """
     def __init__(self, address=None, auth=None, config=None,
-                 retries=None, timeout=None):
+                 retries=None, timeout=None, verify=None):
         """
         Initialize the API with this params, all optionals
         :param address: endpoint
@@ -155,13 +155,11 @@ def __init__(self, address=None, auth=None, config=None,
                                                  "token": config.get("token",
                                                                      None)})
 
+            verify = verify if verify else config.get("verify", True)
             retries = retries if retries else config.get("retries", 3)
             timeout = timeout if timeout else config.get("timeout", 30)
             self.config = self._from_dict(config)
 
-        retries = int(retries) if retries else 3
-        timeout = int(timeout) if timeout else 30
-
         self.auth = auth
         if not address:
             raise raise_exception(
@@ -170,9 +168,9 @@ def __init__(self, address=None, auth=None, config=None,
 
         self.address = self.__get_address_parts(address)
 
-        self.retries = retries
-        self.timeout = timeout
-        self.verify = True
+        self.retries = int(retries) if retries else 3
+        self.timeout = int(timeout) if timeout else 30
+        self.verify = verify if verify else True
 
     @staticmethod
     def _from_dict(config):

devo/api/scripts/client_cli.py

@@ -40,6 +40,7 @@ def cli(version):
 @click.option('--key', help='Key for the api.')
 @click.option('--secret', help='Secret for the api.')
 @click.option('--token', help='Secret for the api.')
+@click.option('--jwt', help='JWT auth for the api.')
 @click.option('--query', '-q', help='Query.', default="")
 @click.option('--stream/--no-stream',
               help='Flag for make streaming query or full query with '
@@ -55,6 +56,7 @@ def cli(version):
               help='To date. For valid formats see API README')
 @click.option('--timeZone',
               help='Timezone info. For valid formats see API README')
+@click.option('--verify', type=bool, help='Verify certificates')
 @click.option('--debug/--no-debug', help='For testing purposes', default=False)
 def query(**kwargs):
     """Perform query by query string"""
@@ -129,6 +131,8 @@ def configure(args):
         if args.get('env'):
             config.set("key", os.environ.get('DEVO_API_KEY', None))
             config.set("secret", os.environ.get('DEVO_API_SECRET', None))
+            config.set("token", os.environ.get('DEVO_API_TOKEN', None))
+            config.set("jwt", os.environ.get('DEVO_API_JWT', None))
             config.set("address", os.environ.get('DEVO_API_ADDRESS', None))
             config.set("user", os.environ.get('DEVO_API_USER', None))
             config.set("comment", os.environ.get('DEVO_API_COMMENT', None))

devo/sender/data.py

@@ -251,6 +251,7 @@ def info(self, msg):
         """
         self.send(tag=self.logging.get("tag"), msg=msg)
 
+    # TODO: Deprecated
     def set_sec_level(self, sec_level=None):
         """
         Set sec_level of SSL Context:
@@ -260,6 +261,7 @@ def set_sec_level(self, sec_level=None):
         """
         self._sender_config.sec_level = sec_level
 
+    # TODO: Deprecated
     def set_verify_mode(self, verify_mode=None):
         """
         Set verify_mode of SSL Context:
@@ -273,6 +275,7 @@ def set_verify_mode(self, verify_mode=None):
         """
         self._sender_config.verify_mode = verify_mode
 
+    # TODO: Deprecated
     def set_check_hostname(self, check_hostname=True):
         """
         Set check_hostname of SSL Context:

devo/sender/lookup.py

@@ -206,7 +206,8 @@ def send_csv(self, path=None, has_header=True, delimiter=',',
                         p_fields = Lookup.process_fields(fields=fields,
                                                          key_index=key_index)
                         self.send_data(row=p_fields,
-                                       delete=field_action == "delete")
+                                       delete=field_action == "delete"
+                                       or field_action == "DELETE")
 
                         # Send full log for historic
                         if historic_tag is not None:

docs/api/api.md

@@ -343,25 +343,31 @@ Usage: `devo-api query [OPTIONS]`
 
 ```
 Options:
-  -c, --config PATH                            JSON/YAML File with configuration, you can put all options here
-  -e, --env                                    Use env vars for configuration
-  -a, --address TEXT                           Endpoint for the api.
-  --key TEXT                                   Key for the api.
-  --secret TEXT     Secret for the api.
-  --token TEXT      Token auth for query.
-  --jwt TEXT                                   jwt auth for query.
-  -q, --query TEXT                             Query.
-  --stream / --no-stream                       Flag for make streaming query or full query with start and end. Default is true
-  --output TEXT                                File path to store query response if not want stdout
-  -r, --response TEXT                          The output format. Default is json/simple/compact
-  --from TEXT                                  From date, and time for the query (YYYY-MM-DD hh:mm:ss). For valid formats see lt-common README
-  --to TEXT                                    To date, and time for the query (YYYY-MM-DD hh:mm:ss). For valid formats see lt-common README
-  --help                                       Show this message and exit.
-  --user                                       User for the api.
-  --app_name                                   App Name for the api.
-  --comment                                    Comment for pragma in query
-  --debug/--no-debug  For testing purposes
-  --help                 Show this message and exit.
+  -c, --config PATH       Optional JSON/Yaml File with configuration info.
+  -e, --env TEXT          Use env vars for configuration
+  -d, --default TEXT      Use default file for configuration
+  -a, --address TEXT      Endpoint for the api.
+  --user TEXT             User for the api.
+  --app_name TEXT         Application name for the api.
+  --comment TEXT          Comment for the queries.
+  --key TEXT              Key for the api.
+  --secret TEXT           Secret for the api.
+  --token TEXT            Secret for the api.
+  --jwt TEXT              JWT auth for the api.
+  -q, --query TEXT        Query.
+  --stream / --no-stream  Flag for make streaming query or full query with
+                          start and end. Default is true
+
+  --output TEXT           File path to store query response if not want stdout
+  -r, --response TEXT     The output format. Default is json/simple/compact
+  --from TEXT             From date. For valid formats see API README. Default
+                          if now - 1 hour
+
+  --to TEXT               To date. For valid formats see API README
+  --timeZone TEXT         Timezone info. For valid formats see API README
+  --verify BOOLEAN        Verify certificates
+  --debug / --no-debug    For testing purposes
+  --help                  Show this message and exit.
 ```
 
 A configuration file does not have to have all the necessary keys, you can have 
@@ -424,7 +430,13 @@ Priority order:
 3. Environment vars: if you send key, secrey or token in config file or params cli, this option not be called
 4. ~/.devo.json or ~/.devo.yaml: if you send key, secrey or token in other way, this option not be called
 
-Environment vars are: `DEVO_API_ADDRESS`, `DEVO_API_KEY`, `DEVO_API_SECRET`, `DEVO_API_USER`.
+Environment vars are: 
+- `DEVO_API_ADDRESS`
+- `DEVO_API_KEY`
+- `DEVO_API_SECRET`
+- `DEVO_API_USER`
+- `DEVO_API_TOKEN`
+- `DEVO_API_JWT`
 
 ## Choosing Fomat
 The default response format (`response`) is `json`, to change the default value, it can be established directly:

docs/sender/data.md

@@ -26,7 +26,8 @@ Class SenderConfigSSL accept various types of certificates, you has:
 + chain **(_str_)**: chain src file
 + pkcs **(_dict_)**: (path: pfx src file, password: of cert)
 + sec_level **(_int_)**: Security level to openssl launch
-
++ check_hostname **(_bool_)**: Verify cert hostname. Default: True
++ verify_mode **(_int_)**: Verify mode for SSL Socket. Default: SSL default.You need use int "0" (CERT_NONE), "1" (CERT_OPTIONAL) or "2" (CERT_REQUIRED)
 
 You can use the collector in some ways:
 

tests/api/cli.py

@@ -85,7 +85,7 @@ def test_normal_query(self):
 
         self.assertIsNone(result.exception)
         self.assertEqual(result.exit_code, 0)
-        self.assertIn('{"m":{"timestamp":{"type":"str","index":0}}}',
+        self.assertIn('{"m":{"timestamp":{"type":"str","index":0',
                       result.output)
 
     def test_with_config_file(self):
@@ -100,7 +100,7 @@ def test_with_config_file(self):
 
             self.assertIsNone(result.exception)
             self.assertEqual(result.exit_code, 0)
-            self.assertIn('{"m":{"timestamp":{"type":"str","index":0}}}',
+            self.assertIn('{"m":{"timestamp":{"type":"str","index":0',
                           result.output)