agilix-api-fr8train 0.1.0__tar.gz

agilix_api_fr8train-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: agilix_api_fr8train
+Version: 0.1.0
+Summary: Python SDK for integrating with Agilix API
+Author: Tyler Collette
+Author-email: t.collette@stellarvirtual.org
+Requires-Python: >=3.8
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary

agilix_api_fr8train-0.1.0/README.md

@@ -0,0 +1,8 @@
+# Agilix API
+### By fr8train-sv
+
+A Python SDK for integrating with Agilix Buzz API. Install with:
+
+```bash
+  pip install myutils
+```

agilix_api_fr8train-0.1.0/agilix_api_fr8train/api.py

@@ -0,0 +1,142 @@
+from agilix.models.connection import Connection
+from agilix.factories.api import build_api_connection
+
+from agilix.models.courses import UpdateCourseDefinition, CopyCourseDefinition
+
+
+class Api:
+    _conn: Connection
+
+    def __init__(self):
+        self._conn = build_api_connection()
+
+        # PACKAGED MODULAR SCOPES
+        self.courses = self.Courses(self._conn)
+        self.domains = self.Domains(self._conn)
+
+    @staticmethod
+    def get_domain_id(domain_id: str, connection: Connection) -> str:
+        return domain_id if domain_id else connection.home_domain_id
+
+    class Courses:
+        _conn: Connection
+
+        def __init__(self, connection: Connection):
+            self._conn = connection
+
+        def list_courses(
+            self,
+            domain_id: str = "",
+            include_descendant_domains: bool = False,
+            text: str = None,
+        ) -> list:
+            query_params = {
+                "domainid": Api.get_domain_id(
+                    domain_id=domain_id, connection=self._conn
+                ),
+                "includedescendantdomains": include_descendant_domains,
+            }
+
+            if text:
+                query_params["text"] = text
+
+            response = self._conn.get("listcourses", query_params)
+
+            return response.get("response", {}).get("courses", {}).get("course", [])
+
+        def get_course(self, course_id: str, select: list = []) -> dict:
+            params = {"courseid": course_id}
+
+            if select:
+                params["select"] = ",".join(select)
+
+            response = self._conn.get("getcourse2", params)
+
+            return response.get("response", {}).get("course", {})
+
+        def copy_courses(self, course_list: list[CopyCourseDefinition]) -> list:
+            payload = {"requests": {"course": course_list}}
+
+            response = self._conn.post("copycourses", payload=payload)
+
+            course_responses = list(
+                map(
+                    lambda x: (
+                        x.get("course", {}).get("courseid")
+                        if x.get("code") == "OK"
+                        else x.get("message", "Generic Error")
+                    ),
+                    response.get("response", {})
+                    .get("responses", {})
+                    .get("response", []),
+                )
+            )
+
+            return course_responses
+
+        def update_courses(self, course_list: list[UpdateCourseDefinition]) -> list:
+            payload = {"requests": {"course": course_list}}
+
+            response = self._conn.post("updatecourses", payload=payload)
+
+            course_responses = list(
+                map(
+                    lambda x: (
+                        x.get("code") == "OK"
+                        if x.get("code") == "OK"
+                        else x.get("message", "Generic Error")
+                    ),
+                    response.get("response", {})
+                    .get("responses", {})
+                    .get("response", []),
+                )
+            )
+
+            return course_responses
+
+        def delete_courses(self, course_id: list):
+            payload = {
+                "requests": {"course": list(map(lambda x: {"courseid": x}, course_id))}
+            }
+
+            response = self._conn.post("deletecourses", payload=payload)
+
+            course_responses = list(
+                map(
+                    lambda x: (
+                        x.get("code") == "OK"
+                        if x.get("code") == "OK"
+                        else x.get("message", "Generic Error")
+                    ),
+                    response.get("response", {})
+                    .get("responses", {})
+                    .get("response", []),
+                )
+            )
+
+            return course_responses
+
+    class Domains:
+        _conn: Connection
+
+        def __init__(self, connection: Connection):
+            self._conn = connection
+
+        def list_domains(
+            self,
+            domain_id: str = "",
+            include_descendant_domains: bool = False,
+            limit: int = 100,
+        ) -> list:
+            response = self._conn.get(
+                "listdomains",
+                {
+                    "domainid": Api.get_domain_id(
+                        domain_id=domain_id, connection=self._conn
+                    ),
+                    "includedescendantdomains": include_descendant_domains,
+                    "limit": limit,
+                },
+            )
+
+            return response.get("response", {}).get("domains", {}).get("domain", [])

agilix_api_fr8train-0.1.0/agilix_api_fr8train/factories/api.py

@@ -0,0 +1,48 @@
+from dotenv import load_dotenv
+from agilix.models.connection import Connection
+import os
+import requests
+
+
+def build_api_connection() -> Connection:
+    load_dotenv(override=True)
+
+    base_url = os.getenv("BASE_URL")
+    username = os.getenv("USERNAME")
+    password = os.getenv("PASSWORD")
+    domain = os.getenv("DOMAIN")
+    home_domain_id = os.getenv("HOME_DOMAIN_ID")
+
+    session = requests.Session()
+    session.headers.update({
+        "Content-Type": "application/json",
+        "Accept": "application/json"
+    })
+
+    json_payload = {
+        "request": {
+            "cmd": "login3",
+            "username": f"{domain}/{username}",
+            "password": password
+        }
+    }
+
+    response = session.post(base_url, json=json_payload)
+    response.raise_for_status()
+    login_data = response.json()
+
+    login_token = login_data.get('response', {}).get('user', {}).get('token', None)
+
+    if login_token is None:
+        error_code = login_data.get('response', {}).get('code', "Generic Error")
+        error_message = login_data.get('response', {}).get('message', "Generic Error")
+        raise Exception(f"{error_code}: {error_message}")
+
+    conn = Connection(
+        base_url=base_url,
+        session=session,
+        token=login_token,
+        home_domain_id=home_domain_id
+    )
+
+    return conn

agilix_api_fr8train-0.1.0/agilix_api_fr8train/models/connection.py

@@ -0,0 +1,53 @@
+from requests import Session
+from urllib.parse import urlencode
+
+class Connection:
+    token: str
+    session: Session
+    base_url: str
+    home_domain_id: str
+
+    def __init__(self, token: str = "",
+                 base_url: str = "",
+                 home_domain_id: str = "",
+                 session: Session = Session()):
+        self.token = token
+        self.base_url = base_url
+        self.session = session
+        self.home_domain_id = home_domain_id
+
+
+    def get(self,
+            cmd: str,
+            params: dict = {}):
+        query_string = urlencode({ 'cmd': cmd, '_token': self.token } | params, doseq=True)
+
+        response = self.session.get(f"{self.base_url}?{query_string}")
+        response.raise_for_status()
+
+        if response.status_code != 200:
+            raise Exception(f"Error: {response.status_code} - {response.text}")
+
+        return response.json()
+
+    def post(self,
+             cmd: str,
+             params: dict = {},
+             payload: dict = {}):
+        query_string = ""
+
+        if cmd:
+            query_string = urlencode({ 'cmd': cmd, '_token': self.token } | params, doseq=True)
+        else:
+            payload = {'_token': self.token} | payload
+            if bool(params):
+                query_string = urlencode(params, doseq=True)
+
+        target_url = f"{self.base_url}?{query_string}" if query_string else self.base_url
+
+        # NEED TO DO A POST PAYLOAD WITH THE TOKEN ADDED TO THE REQUESTS OBJECT
+
+        response = self.session.post(target_url, json=payload)
+        response.raise_for_status()
+
+        return response.json()

agilix_api_fr8train-0.1.0/agilix_api_fr8train/models/courses.py

@@ -0,0 +1,42 @@
+class UpdateCourseDefinition:
+    course_id: str
+    domain_id: str
+    title: str
+    reference: str
+
+    def __init__(self,
+                 course_id: str,
+                 domain_id: str,
+                 title: str,
+                 reference: str):
+        self.course_id = course_id
+        self.domain_id = domain_id
+        self.title = title
+        self.reference = reference
+
+
+    def __iter__(self):
+        yield "courseid", self.course_id
+        yield "domainid", self.domain_id
+        yield "title", self.title
+        yield "reference", self.reference
+
+
+class CopyCourseDefinition:
+    course_id: str
+    domain_id: str
+    action: str
+    reference: str
+    status: int
+
+    def __init__(self,
+                 course_id: str,
+                 domain_id: str,
+                 action: str = 'StaticCopy',
+                 reference: str = '',
+                 status: int = 0):
+        self.course_id = course_id
+        self.domain_id = domain_id
+        self.action = action
+        self.reference = reference
+        self.status = status

agilix_api_fr8train-0.1.0/agilix_api_fr8train.egg-info/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: agilix_api_fr8train
+Version: 0.1.0
+Summary: Python SDK for integrating with Agilix API
+Author: Tyler Collette
+Author-email: t.collette@stellarvirtual.org
+Requires-Python: >=3.8
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary

agilix_api_fr8train-0.1.0/agilix_api_fr8train.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+agilix_api_fr8train/__init__.py
+agilix_api_fr8train/api.py
+agilix_api_fr8train.egg-info/PKG-INFO
+agilix_api_fr8train.egg-info/SOURCES.txt
+agilix_api_fr8train.egg-info/dependency_links.txt
+agilix_api_fr8train.egg-info/top_level.txt
+agilix_api_fr8train/factories/__init__.py
+agilix_api_fr8train/factories/api.py
+agilix_api_fr8train/models/__init__.py
+agilix_api_fr8train/models/connection.py
+agilix_api_fr8train/models/courses.py
+tests/test_api.py

agilix_api_fr8train-0.1.0/agilix_api_fr8train.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

agilix_api_fr8train-0.1.0/agilix_api_fr8train.egg-info/top_level.txt

@@ -0,0 +1 @@
+agilix_api_fr8train

agilix_api_fr8train-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

agilix_api_fr8train-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

agilix_api_fr8train-0.1.0/setup.py

@@ -0,0 +1,12 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="agilix_api_fr8train",  # Must be unique on PyPI!
+    version="0.1.0",
+    description="Python SDK for integrating with Agilix API",
+    author="Tyler Collette",
+    author_email="t.collette@stellarvirtual.org",
+    packages=find_packages(),
+    install_requires=[],  # Add dependencies here
+    python_requires=">=3.8",
+)