OpenAPI code now returns clean errors and version number. cli4 prints fetch errors cleanly

Author: mahtin

CloudFlare/api_decode_from_openapi.py

@@ -62,21 +62,18 @@ def api_decode_from_openapi(content):
 
     try:
         j = json.loads(content)
-    except Exception as e:
-        sys.stderr.write("OpenAPI json format issue: %s\n" % (e))
-        return None
+    except json.decoder.JSONDecodeError as e:
+        raise SyntaxError('OpenAPI json decode failed: %s' % (e))
 
     try:
         components = j['components']
         info = j['info']
-        openapi = j['openapi']
+        cloudflare_version = info['version']
+        openapi_version = j['openapi']
         paths = j['paths']
         servers = ['servers']
     except Exception as e:
-        sys.stderr.write("OpenAPI json format structure: %s\n" % (e))
-        return None
-
-    sys.stderr.write("OpenAPI %s json file - version: %s\n" % (openapi, info['version']))
+        raise SyntaxError('OpenAPI json missing standard OpenAPI values: %s' % (e))
 
     all_cmds = []
     for path in paths:
@@ -85,4 +82,4 @@ def api_decode_from_openapi(content):
             continue
         all_cmds += do_path(path, paths[path])
 
-    return sorted(all_cmds, key=lambda v: v['cmd'])
+    return sorted(all_cmds, key=lambda v: v['cmd']), openapi_version, cloudflare_version

CloudFlare/cloudflare.py

@@ -9,7 +9,6 @@
 from .read_configs import read_configs
 from .api_v4 import api_v4
 from .api_extras import api_extras
-#from .api_decode_from_web import api_decode_from_web # TODO - remove at some point
 from .api_decode_from_openapi import api_decode_from_openapi
 from .exceptions import CloudFlareError, CloudFlareAPIError, CloudFlareInternalError
 
@@ -601,12 +600,29 @@ def _call_unwrapped(self, method, parts, identifiers, params, data_str, data_jso
             result = response_data
             return result
 
-        def api_from_openapi(self, url=None):
+        def _api_from_openapi(self, url=None):
             """ Cloudflare v4 API"""
 
             if url is None:
                 url = self.openapi_url
-            return self._read_from_web(url)
+
+            try:
+                v = self._read_from_web(url)
+            except Exception as e:
+                if self.logger:
+                    self.logger.debug('OpenAPI read from web failed: %s', e)
+                raise CloudFlareAPIError(0, 'OpenAPI read from web failed: %s' % (e)) from None
+
+            try:
+                v, openapi_version, cloudflare_version = api_decode_from_openapi(v)
+            except SyntaxError as e:
+                if self.logger:
+                    self.logger.debug('OpenAPI bad json file: %s', e)
+                raise CloudFlareAPIError(0, 'OpenAPI bad json file: %s' % (e)) from None
+
+            if self.logger:
+                self.logger.debug('OpenAPI version: %s, Cloudflare API version: %s', openapi_version, cloudflare_version)
+            return v
 
         def _read_from_web(self, url):
             """ Cloudflare v4 API"""
@@ -619,7 +635,7 @@ def _read_from_web(self, url):
             except Exception as e:
                 if self.logger:
                     self.logger.debug('Call: exception! "%s"', e)
-                raise CloudFlareAPIError(0, 'connection failed.')
+                raise CloudFlareAPIError(0, 'connection failed.') from None
 
             return response.text
 
@@ -851,16 +867,10 @@ def _api_list(self, m=None, s=''):
             w = w + self._api_list(a, s + '/' + n)
         return w
 
-    # TODO - remove at some point
-    #def api_from_web(self):
-    #    """ Cloudflare v4 API"""
-    #
-    #    return api_decode_from_web(self._base.api_from_web())
-
     def api_from_openapi(self, url=None):
         """ Cloudflare v4 API"""
 
-        return api_decode_from_openapi(self._base.api_from_openapi(url))
+        return self._base._api_from_openapi(url)
 
     def __init__(self, email=None, key=None, token=None, certtoken=None, debug=False, raw=False, use_sessions=True, profile=None, base_url=None, global_request_timeout=None, max_request_retries=None):
         """ Cloudflare v4 API"""

cli4/cli4.py

@@ -485,11 +485,16 @@ def do_it(args):
 
     if do_dump:
         a = dump_commands(cf)
+        # success - just dump results and exit
         sys.stdout.write(a)
         sys.exit(0)
 
     if do_openapi:
-        a = dump_commands_from_web(cf, openapi_url)
+        try:
+            a = dump_commands_from_web(cf, openapi_url)
+        except CloudFlare.exceptions.CloudFlareAPIError as e:
+            sys.exit('cli4: %s - Failed' % (e))
+        # success - just dump results and exit
         sys.stdout.write(a)
         sys.exit(0)