config.json dummy

Author: bigretromike

api/common/__init__.py

@@ -20,15 +20,15 @@ class APIClient:
 
     Attributes
     ----------
-    _address : str
+    api_address : str
         default address is localhost, use hostname or ip address
-    _port : int
+    api_port : int
         default port is 8111
-    _version : int
+    api_version : int
         version of api used for endpoints
-    _apikey : str
+    api_key : str
         api_key if needed for most calls
-    _timeout : int
+    timeout : int
         time until Request timeout without getting any response
 
     Methods
@@ -38,6 +38,7 @@ class APIClient:
 
     """
     def __init__(self,
+                 api_proto: str = 'http',
                  api_address: str = 'localhost',
                  api_port: int = 8111,
                  api_version: int = 3,
@@ -48,6 +49,8 @@ def __init__(self,
 
         Parameters
         ----------
+            api_proto : str
+                protocol used with api call, default is http
             api_address : str
                 address that will be used to call api
             api_port : int
@@ -59,18 +62,21 @@ def __init__(self,
             timeout: int
                 time until Request timeout without getting any response
         """
+        self.proto = api_proto
         self.address = api_address
         self.port = api_port
         self.version = api_version
         self.apikey = api_key
         self.timeout = timeout
 
-    def call(self, url: str = '/', call_type: APIType = APIType.GET, query=dict(), data={}, auth: bool = True):
+    def call(self, proto: str = 'http', url: str = '/', call_type: APIType = APIType.GET, query: dict = {}, data: dict = {}, auth: bool = True):
         """
         call api based on given url, call_type, query, data and auth parameter while using base class attributes
 
         Parameters
         ----------
+            proto: str
+                protocol used with api call, default is http
             url : str
                 url that will be added to api address and api port to make full endpoint address to call
             call_type : APIType
@@ -84,9 +90,9 @@ def call(self, url: str = '/', call_type: APIType = APIType.GET, query=dict(), d
         """
         if query:
             query = urlencode(query)
-            url = f"{self.address}:{self.port}{url}?{query}&api-version={self.version}"
+            url = f"{self.proto}://{self.address}:{self.port}{url}?{query}&api-version={self.version}"
         else:
-            url = f"{self.address}:{self.port}{url}?api-version={self.version}"
+            url = f"{self.proto}://{self.address}:{self.port}{url}?api-version={self.version}"
         print(f"{url}")
 
         headers = {
@@ -104,6 +110,7 @@ def call(self, url: str = '/', call_type: APIType = APIType.GET, query=dict(), d
             headers['api-version'] = '1.0'
 
     # Api Calls
+        req = None
         if call_type == APIType.GET:
             print(f"Api.GET === {url} -- -H {headers} -D {data}")
             req = Request(url, data=data, headers=headers, method="GET")
@@ -131,29 +138,18 @@ def call(self, url: str = '/', call_type: APIType = APIType.GET, query=dict(), d
         else:
             print(f"Unknown === {url}")
 
-        response = urlopen(req, timeout=int(self.timeout))
-
-        if response.info().get('Content-Encoding') == 'gzip':
-            try:
-                buf = BytesIO(response.read())
-                f = gzip.GzipFile(fileobj=buf)
-                data = f.read()
-            except Exception as e:
-                print(f"Failed to decompress === {e}")
-        else:
-            data = response.read()
-        response.close()
-
-        return data
-
-    def _responde_helper(response):
-        if response.code == 200:
-            print('ok')
-        elif response.code == 400:
-            print('bad request')
-        elif response.code == 401:
-            print('unauthorized')
-        elif response.code == 500:
-            print('shoko is buggy')
-        else:
-            print('not supported error')
+        if req is not None:
+            response = urlopen(req, timeout=int(self.timeout))
+
+            if response.info().get('Content-Encoding') == 'gzip':
+                try:
+                    buf = BytesIO(response.read())
+                    f = gzip.GzipFile(fileobj=buf)
+                    data = f.read()
+                except Exception as e:
+                    print(f"Failed to decompress === {e}")
+            else:
+                data = response.read()
+            response.close()
+            return data
+        return None

api/shoko/v2/api2.py

@@ -2,12 +2,15 @@
 
 # BASED OF :8111/swagger/index.html?urls.primaryName=2.0
 
-from api.common import *
+try:
+    from api.common import APIClient, APIType
+except:
+    from ...common import APIClient, APIType
 from api2models import *
 
 
 address = "http://192.168.1.2"
-port = "8111"
+port = 8111
 version = 2
 # api related
 apikey = ''

api/shoko/v3/api3.py

@@ -3,12 +3,15 @@
 # BASED OF :8111/swagger/index.html?urls.primaryName=3.0
 # Asahara
 
+try:
+    from api.common import APIClient, APIType
+except:
+    from ...common import APIClient, APIType
 from api3models import *
-from ...common import *
 
 
 address = "http://10.1.1.100"
-port = "8111"
+port = 8111
 version = 3
 # api related
 apikey = ''

config.json

@@ -0,0 +1,9 @@
+{
+  "_comment": "config file for using while testing py",
+  "proto": "http",
+  "address": "localhost",
+  "port": 8111,
+  "version": 2,
+  "apikey": "",
+  "timeout": 120
+}