Release 1.3.0

Author: Turall

.gitignore

@@ -10,7 +10,7 @@ __pycache__/
 
 # C extensions
 *.so
-
+testopa.py
 # Distribution / packaging
 .Python
 build/

OpaExceptions/__init__.py

@@ -89,7 +89,7 @@ del client
 ```python
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 client.update_opa_policy_fromfile("/your/path/filename.rego", endpoint="fromfile") # response is True
 
@@ -105,7 +105,7 @@ del client
 
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 
 client.update_opa_policy_fromurl("http://opapolicyurlexample.test/example.rego", endpoint="fromurl") # response is True
@@ -124,11 +124,11 @@ del client
 
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 client.delete_opa_policy("fromfile") # response is True
 
-client.get_policies_list() # response is [fromurl"]
+client.get_policies_list() # response is [] 
 
 del client
 ```
@@ -141,7 +141,7 @@ del client
 
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 print(client.get_opa_raw_data("testapi/testdata"))  # response is {'result': ['world', 'hello']}
 
@@ -156,7 +156,7 @@ del client
 
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 client.opa_policy_to_file(policy_name="fromurl",path="/your/path",filename="example.rego")  # response is True
 
@@ -171,7 +171,7 @@ del client
 
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 client.delete_opa_data("testapi")  # response is True
 
@@ -187,7 +187,7 @@ del client
 
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 client.get_policies_info()
 
@@ -205,7 +205,7 @@ del client
 
 from opa_client.opa import OpaClient
 
-client = OpaClient() # default host='localhost', port=8181, version='v1'
+client = OpaClient() 
 
 permission_you_want_check = {"input": {"message": "hello"}}
 client.check_permission(input_data=permission_you_want_check, policy_name="testpolicy", rule_name="hello")
@@ -215,6 +215,80 @@ client.check_permission(input_data=permission_you_want_check, policy_name="testp
 del client
 ```
 
+### Queries a package rule with the given input data
+
+```python
+from opa_client.opa import OpaClient
+
+client = OpaClient()
+
+rego = """
+package play
+
+default hello = false
+
+hello {
+    m := input.message
+    m == "world"
+}
+"""
+
+check_data = {"message": "world"}
+client.check_policy_rule(input_data=check_data, package_path="play", rule_name="hello") # response {'result': True}
+
+```
+
+### Execute an Ad-hoc Query
+
+```python
+from opa_client.opa import OpaClient
+
+client = OpaClient()
+
+print(client.ad_hoc_query(query_params={"q": "data.userinfo.user_roles[name]"})) # response is {}
+
+data = {
+    "user_roles": {
+        "alice": [
+            "admin"
+        ],
+        "bob": [
+            "employee",
+            "billing"
+        ],
+        "eve": [
+            "customer"
+        ]
+    }
+}
+
+print(client.update_or_create_opa_data(data, "userinfo")) # response is True
+
+# execute query 
+print(client.ad_hoc_query(query_params={"q": "data.userinfo.user_roles[name]"})) 
+# response is {'result': [{'name': 'eve'}, {'name': 'alice'}, {'name': 'bob'}]}
+
+#you can send body request
+print(client.ad_hoc_query(body={"query": "data.userinfo.user_roles[name] "})) 
+# response is {'result': [{'name': 'eve'}, {'name': 'alice'}, {'name': 'bob'}]}
+
+```
+
+### Check OPA healthy. If you want check bundels or plugins, add query params for this.
+
+```python
+from opa_client.opa import OpaClient
+
+client = OpaClient()
+
+print(client.check_health()) # response is  True or False
+print(client.check_health({"bundle": True})) # response is  True or False
+# If your diagnostic url different than default url, you can provide it.
+print(client.check_health(diagnostic_url="http://localhost:8282/health"))  # response is  True or False
+print(client.check_health(query={"bundle": True}, diagnostic_url="http://localhost:8282/health"))  # response is  True or False
+
+```
+
 
 # Contributing #
 

README.md

@@ -9,6 +9,17 @@ def __init__(self, expression, message):
         self.message = message
 
 
+class QueryExecuteError(Exception):
+    """
+        expression -- input expression in which the error occurred
+        message -- explanation of the error
+    """
+
+    def __init__(self, expression, message):
+        self.expression = expression
+        self.message = message
+
+
 class PolicyNotFoundError(Exception):
     """
         expression -- input expression in which the error occurred
@@ -85,6 +96,7 @@ def __init__(self, expression, message):
         self.expression = expression
         self.message = message
 
+
 class FileError(ValueError):
     """
         expression -- input expression in which the error occurred
@@ -94,6 +106,7 @@ def __init__(self, expression, message):
         self.expression = expression
         self.message = message
 
+
 class TypeExecption(TypeError):
     """
         expression -- input expression in which the error occurred

OpaExceptions/OpaExceptions.py opa_client/OpaExceptions/OpaExceptions.py

@@ -0,0 +1,6 @@
+from .OpaExceptions import (CheckPermissionError,
+               ConnectionsError, DeleteDataError,
+               DeletePolicyError, PathNotFoundError,
+               PolicyNotFoundError, RegoParseError,
+               SSLError, FileError, TypeExecption,
+               QueryExecuteError)

opa_client/OpaExceptions/__init__.py

@@ -1,6 +1,7 @@
 """Initialize the OpaClient package."""
 
 from .opa import OpaClient
+from .OpaExceptions import *
 
 __all__ = [
     "OpaClient",