add query params for metrics

Author: Turall

README.md

@@ -145,6 +145,17 @@ client = OpaClient()
 
 print(client.get_opa_raw_data("testapi/testdata"))  # response is {'result': ['world', 'hello']}
 
+# You can use query params for additional info
+# provenance - If parameter is true, response will include build/version info in addition to the result.
+# metrics - Return query performance metrics in addition to result 
+
+print(client.get_opa_raw_data("userinfo",query_params={"provenance": True})) 
+# response is {'provenance': {'version': '0.25.2', 'build_commit': '4c6e524', 'build_timestamp': '2020-12-08T16:56:55Z', 'build_hostname': '3bb58334a5a9'}, 'result': {'user_roles': {'alice': ['admin'], 'bob': ['employee', 'billing'], 'eve': ['customer']}}}
+
+print(client.get_opa_raw_data("userinfo",query_params={"metrics": True})) 
+
+# response is {'metrics': {'counter_server_query_cache_hit': 0, 'timer_rego_external_resolve_ns': 231, 'timer_rego_input_parse_ns': 381, 'timer_rego_query_compile_ns': 40173, 'timer_rego_query_eval_ns': 12674, 'timer_rego_query_parse_ns': 5692, 'timer_server_handler_ns': 83490}, 'result': {'user_roles': {'alice': ['admin'], 'bob': ['employee', 'billing'], 'eve': ['customer']}}}
+
 del client
 ```
 
@@ -212,6 +223,10 @@ client.check_permission(input_data=permission_you_want_check, policy_name="testp
 
 # response is {'result': True}
 
+# You can use query params for additional info
+# provenance - If parameter is true, response will include build/version info in addition to the result.
+# metrics - Return query performance metrics in addition to result 
+
 del client
 ```
 

opa_client/opa.py

@@ -22,7 +22,7 @@
                             SSLError, FileError, TypeExecption,
                             QueryExecuteError)
 
-__version__ = "1.3.0"
+__version__ = "1.3.1"
 __author__ = "Tural Muradov"
 __license__ = 'MIT'
 
@@ -248,7 +248,12 @@ def update_or_create_opa_data(self, new_data: dict, endpoint: str) -> bool:
         return self.__update_opa_data(new_data, endpoint)
 
     def get_opa_raw_data(self, data_name: str = "", query_params: Dict[str, bool] = dict()) -> dict:
-        """Returns OPA raw data in string type """
+        """ Returns OPA raw data in string type 
+            ```
+            param :: data_name : OPA data name you want get
+            param :: query_params : query params in url for more information about metrics
+            ```
+        """
         return self.__get_opa_raw_data(data_name, query_params)
 
     def opa_policy_to_file(self,
@@ -297,6 +302,8 @@ def check_permission(self, input_data: dict, policy_name: str,
 
             params :: rule_name   : the name included in the policy
                 type   :: rule_name  : str
+            param :: query_params : query params in url for more information about metrics
+                type :: query_params : dict
         ```
         """
 

opa_client/test/test_opa.py

@@ -27,13 +27,13 @@ def test_client(self):
         client = OpaClient("localhost", 8181, "v1")
         self.assertEqual("http://localhost:8181/v1", client._root_url)
 
-        client = OpaClient("127.0.0.1", 8181, "v1")
-        self.assertEqual("http://127.0.0.1:8181/v1", client._root_url)
+        client = OpaClient("localhost", 8181, "v1")
+        self.assertEqual("http://localhost:8181/v1", client._root_url)
 
         self.assertFalse(False, self.myclient._secure)
         self.assertEqual("http://", self.myclient._schema)
         self.assertEqual("v1", self.myclient._version)
-        self.assertEqual("127.0.0.1", self.myclient._host)
+        self.assertEqual("localhost", self.myclient._host)
         self.assertEqual(8181, self.myclient._port)
 
     def test_functions(self):
@@ -53,7 +53,7 @@ def test_functions(self):
             print(rr)
             try:
                 my_dict = {'test': {'path': [
-                    'http://127.0.0.1:8181/v1/data/play'], 'rules': ['http://127.0.0.1:8181/v1/data/play/hello']}}
+                    'http://localhost:8181/v1/data/play'], 'rules': ['http://localhost:8181/v1/data/play/hello']}}
 
                 self.assertEqual(my_dict, self.myclient.get_policies_info())
             except Exception as testing:
@@ -77,8 +77,8 @@ def test_functions(self):
 
         # self.assertEqual(self.myclient.update_opa_policy_fromurl())
         self.assertEqual(["test"], self.myclient.get_policies_list())
-        my_dict = {'test': {'path': ['http://127.0.0.1:8181/v1/data/play'],
-                            'rules': ['http://127.0.0.1:8181/v1/data/play/hello']}}
+        my_dict = {'test': {'path': ['http://localhost:8181/v1/data/play'],
+                            'rules': ['http://localhost:8181/v1/data/play/hello']}}
 
         self.assertEqual(my_dict, self.myclient.get_policies_info())
 

setup.py

@@ -11,7 +11,7 @@
 
 setuptools.setup(
     name="OPA-python-client",
-    version="1.3.0",
+    version="1.3.1",
     author="Tural Muradov",
     author_email="tural_m@hotmail.com",
     description="Client for connection to the OPA service",