Merge pull request #1 from kilobyteno/feature/publish-event

Author: dsbilling

.env

@@ -0,0 +1,6 @@
+TEST_TITLE=sample_title
+TEST_API_TOKEN=token
+TEST_CHANNEL_ID=uuid
+TEST_DESCRIPTION=this is an event
+
+ENV=staging.

oppe/config.py

@@ -0,0 +1,22 @@
+import os
+
+from dotenv import load_dotenv
+
+
+class Config:
+    """
+    Configuration class for Oppe app settings
+
+    Attributes:
+        BASE_URL (str):
+            The base URL for the Oppe app
+        EVENT_URL (str):
+            The URL for accessing Oppe app events
+    """
+    # Reading the env variables
+    dotenv_path = os.path.join(os.path.dirname(__file__), '..', '.env')
+    if os.path.exists(dotenv_path):
+        load_dotenv(dotenv_path)
+
+    BASE_URL = f"https://{os.getenv('ENV')}oppe.app"
+    EVENT_URL = f"{BASE_URL}/api/event/"

oppe/oppe.py

@@ -0,0 +1,54 @@
+import requests
+from oppe.config import Config
+import json
+
+
+class Oppe:
+    """
+    Oppe class for triggering events in the Oppe app.
+
+    Attributes:
+        token (str):
+            The authentication token.
+        project (str):
+            The project identifier.
+        """
+    def __init__(self, token, project):
+        """
+          Initializes an instance of the Oppe class.
+
+          :param token: The authentication token.
+          :type token: str
+          :param project: The project identifier.
+          :type project: str
+          """
+        self.token = token
+        self.project = project
+
+    def trigger_event(self, channel, title, description):
+        """
+        Triggers an event in the Oppe app.
+
+        :param channel: The channel identifier.
+        :type channel: str
+        :param title: The title of the event.
+        :type title: str
+        :param description: The description of the event.
+        :type description: str
+
+        :return: True if the event was triggered successfully, False otherwise.
+        :rtype: bool
+        """
+        data = {
+            "channel_id": channel,
+            "title": title,
+            "description": description,
+        }
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {self.token}"
+        }
+        response = requests.post(Config.EVENT_URL, data=json.dumps(data), headers=headers)
+        return True
+

requirements.txt

@@ -1 +1,7 @@
 setuptools~=68.1.2
+certifi==2023.7.22
+pytest==7.4.1
+python-dotenv==1.0.0
+requests==2.31.0
+tomli==2.0.1
+urllib3==2.0.4

tests/test_pyoppe.py

@@ -0,0 +1,20 @@
+import os
+
+from dotenv import load_dotenv
+
+from oppe.oppe import Oppe
+
+# Reading the env variables
+dotenv_path = os.path.join(os.path.dirname(__file__), '..', '.env')
+if os.path.exists(dotenv_path):
+    load_dotenv(dotenv_path)
+
+
+def init_oppe():
+    return Oppe(token=os.getenv('TEST_API_TOKEN'), project=os.getenv('TEST_PROJECT'))
+
+
+def test_publish_event():
+    oppe = init_oppe()
+    response = oppe.trigger_event(channel=os.getenv('TEST_CHANNEL_ID'), title=os.getenv('TEST_TITLE'), description=os.getenv('TEST_DESCRIPTION'))
+    assert response == True