Merge pull request #153 from DevoInc/PAR-14428

fix: binary formats requires output parameter

Author: JuanFranDevo

CHANGELOG.md

@@ -4,11 +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).
 
+## [4.0.3] - 2022-09-12
+### Fix
+ * Added a constraint in client parameters so binary formats like, `msgpack` and `xls`, cannot be invoked without `output`parameter
+
+
 ## [4.0.2] - 2022-09-01
 ### Added
- * Add a new command-line option for escaping double quotes with `-eq` or `--escape_quotes`.
- * Add a check and shows a warning if the file contains double quotes and the option `-eq` is not used.
- * Add a new command-line option in tests for testing just one module with `-m <module_name>` or `--module <module_name>`.
+ * Add a new command-line option for escaping double quotes with `-eq` or `--escape_quotes`
+ * Add a check and shows a warning if the file contains double quotes and the option `-eq` is not used
+ * Add a new command-line option in tests for testing just one module with `-m <module_name>` or `--module <module_name>`
+ 
 ## [4.0.1] - 2022-08-26
 ### Added
  * Create GitHub action to publish package in PyPI

devo/__version__.py

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

devo/api/client.py

@@ -32,7 +32,9 @@
     "no_auth": "Client dont have key&secret or auth token/jwt",
     "no_endpoint": "Endpoint 'address' not found",
     "to_but_no_from": "If you use end dates for the query 'to' it is "
-                      "necessary to use start date 'from'"
+                      "necessary to use start date 'from'",
+    "binary_format_requires_output": "Binary format like `msgpack` and `xls` "
+                                     "requires output parameter"
 }
 
 DEFAULT_KEEPALIVE_TOKEN = '\n'

devo/api/scripts/client_cli.py

@@ -48,7 +48,10 @@ def cli(version):
 @click.option('--output', help='File path to store query response if not want '
                                'stdout')
 @click.option('--response', '-r', default="json/simple/compact",
-              help='The output format. Default is json/simple/compact')
+              help='The output format. Default is json/simple/compact',
+              type=click.Choice(['json', 'json/compact', 'json/simple',
+                                 'json/simple/compact', 'msgpack', 'csv',
+                                 'tsv', 'xls']))
 @click.option('--from',
               help='From date. For valid formats see API README.'
                    ' Default if now - 1 hour')
@@ -89,6 +92,14 @@ def query(**kwargs):
         else:
             dates = None
 
+    if "response" in config.keys():
+        if config["response"] in ["msgpack", "xls"]:
+            if "output" not in config.keys():
+                print_error(ERROR_MSGS['binary_format_requires_output'],
+                            show_help=True)
+                exit()
+
+
     reponse = api.query(query=config['query'], dates=dates)
 
     process_response(reponse, config)