comms-sdk 1.0.0__tar.gz

comms_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: comms_sdk
+Version: 1.0.0
+Summary: EgoSMS Python SDK
+Author-email: Pahappa Limited <systems@pahappa.com>
+License-Expression: MIT
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+
+# Usage
+
+```python
+# install the package
+pip install egosms_sdk
+# Or for dev "pip install ."
+
+
+# import in your project
+from egosms_sdk.v1 import EgoSmsSDK, MessagePriority
+
+# use
+EgoSmsSDK.authenticate("username", "password")
+EgoSmsSDK.send_sms("0712345678", "Message to send")
+# send_sms(self, numbers: List[str] | str, message: str, sender_id: Optional[str] = None, priority: MessagePriority = MessagePriority.HIGHEST)
+```

comms_sdk-1.0.0/README.md

@@ -0,0 +1,16 @@
+# Usage
+
+```python
+# install the package
+pip install egosms_sdk
+# Or for dev "pip install ."
+
+
+# import in your project
+from egosms_sdk.v1 import EgoSmsSDK, MessagePriority
+
+# use
+EgoSmsSDK.authenticate("username", "password")
+EgoSmsSDK.send_sms("0712345678", "Message to send")
+# send_sms(self, numbers: List[str] | str, message: str, sender_id: Optional[str] = None, priority: MessagePriority = MessagePriority.HIGHEST)
+```

comms_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,12 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools"]
+
+[project]
+name = "comms_sdk"
+version = "1.0.0"
+authors = [{name = "Pahappa Limited", email = "systems@pahappa.com"}]
+description = "EgoSMS Python SDK"
+license = "MIT"
+dependencies = ["requests"]
+readme = "README.md"

comms_sdk-1.0.0/setup.cfg

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

comms_sdk-1.0.0/src/comms_sdk/__init__.py

@@ -0,0 +1,13 @@
+"""
+Pahappa Comms platform Python SDK
+
+A Python SDK for integrating with the Comms platform API.
+"""
+
+__version__ = "0.1.0"
+__author__ = "Pahappa Limited"
+__email__ = "systems@pahappa.com"
+
+from .v1 import CommsSDK, MessagePriority
+
+__all__ = ['CommsSDK', 'MessagePriority']

comms_sdk-1.0.0/src/comms_sdk/v1/__init__.py

@@ -0,0 +1,3 @@
+from .comms_sdk import CommsSDK, MessagePriority
+
+__all__ = ['CommsSDK', 'MessagePriority']

comms_sdk-1.0.0/src/comms_sdk/v1/comms_sdk.py

@@ -0,0 +1,139 @@
+import sys
+from typing import List, Optional
+import requests
+from .models import ApiRequest, ApiResponse, ApiResponseCode, MessageModel, MessagePriority, UserData
+from .utils import NumberValidator, Validator
+
+class CommsSDK:
+    API_URL = "https://comms.egosms.co/api/v1/json/"
+
+    def __init__(self):
+        self._api_key: Optional[str] = None
+        self._user_name: Optional[str] = None
+        self._sender_id: str = "EgoSMS"
+        self._is_authenticated: bool = False
+        self._client = requests.Session()
+
+    @property
+    def api_key(self) -> Optional[str]:
+        return self._api_key
+
+    @property
+    def user_name(self) -> Optional[str]:
+        return self._user_name
+
+    @property
+    def sender_id(self) -> str:
+        return self._sender_id
+
+    @property
+    def is_authenticated(self) -> bool:
+        return self._is_authenticated
+
+    def set_authenticated(self):
+        self._is_authenticated = True
+
+    @classmethod
+    def authenticate(cls, user_name: str, api_key: str):
+        sdk = cls()
+        sdk._user_name = user_name
+        sdk._api_key = api_key
+        Validator.validate_credentials(sdk)
+        return sdk
+
+    @staticmethod
+    def use_sandbox():
+        CommsSDK.API_URL = "https://comms-test.pahappa.net/api/v1/json"
+
+    @staticmethod
+    def use_live_server():
+        CommsSDK.API_URL = "https://comms.egosms.co/api/v1/json"
+
+    def with_sender_id(self, sender_id: str):
+        self._sender_id = sender_id
+        return self
+
+    def send_sms(self, numbers: str | List[str], message: str, sender_id: Optional[str] = None, priority: MessagePriority = MessagePriority.HIGHEST) -> bool:
+        if isinstance(numbers, str):
+            numbers = [numbers]
+
+        api_response = self.query_send_sms(numbers, message, sender_id or self._sender_id, priority)
+
+        if api_response is None:
+            print("Failed to get a response from the server.")
+            return False
+
+        if api_response.Status == ApiResponseCode.OK.value:
+            print("SMS sent successfully.")
+            print(f"MessageFollowUpUniqueCode: {api_response.MsgFollowUpUniqueCode}")
+            return True
+        elif api_response.Status == ApiResponseCode.FAILED.value:
+            print(f"Failed: {api_response.Message}")
+            return False
+        else:
+            raise RuntimeError(f"Unexpected response status: {api_response.Status}")
+
+    def query_send_sms(self, numbers: List[str], message: str, sender_id: str, priority: MessagePriority) -> Optional[ApiResponse]:
+        if self._sdk_not_authenticated():
+            return None
+
+        if not numbers:
+            raise ValueError("Numbers list cannot be empty")
+        if not message:
+            raise ValueError("Message cannot be empty")
+        if len(message) == 1:
+            raise ValueError("Message cannot be a single character")
+
+        if not sender_id or sender_id.strip() == "":
+            sender_id = self._sender_id
+        if sender_id and len(sender_id) > 11:
+            print("Warning: Sender ID length exceeds 11 characters. Some networks may truncate or reject messages.")
+
+        numbers = NumberValidator.validate_numbers(numbers)
+        if not numbers:
+            print("No valid phone numbers provided. Please check inputs.", file=sys.stderr)
+            return None
+
+        api_request = ApiRequest(method="SendSms", userdata=UserData(self._user_name, self._api_key))
+        message_models = []
+        for num in numbers:
+            message_model = MessageModel(number=num, message=message, senderid=sender_id, priority=priority.value)
+            message_models.append(message_model)
+        api_request.msgdata = message_models
+
+        try:
+            res = self._client.post(CommsSDK.API_URL, json=api_request.to_dict())
+            return ApiResponse(**res.json())
+        except Exception as e:
+            print(f"Failed to send SMS: {e}", file=sys.stderr)
+            try:
+                print(f"Request: {api_request.__dict__}", file=sys.stderr)
+            except Exception:
+                pass
+            return None
+
+    def _sdk_not_authenticated(self) -> bool:
+        if not self._is_authenticated:
+            print("SDK is not authenticated. Please authenticate before performing actions.", file=sys.stderr)
+            print("Attempting to re-authenticate with provided credentials...", file=sys.stderr)
+            return not Validator.validate_credentials(self)
+        return False
+
+    def __str__(self) -> str:
+        return f"SDK({self._user_name} => {self._api_key})"
+
+    def query_balance(self) -> Optional[ApiResponse]:
+        if self._sdk_not_authenticated():
+            return None
+
+        api_request = ApiRequest(method="Balance", userdata=UserData(self._user_name, self._api_key))
+
+        try:
+            res = self._client.post(CommsSDK.API_URL, json=api_request.to_dict())
+            return ApiResponse(**res.json())
+        except Exception as e:
+            raise RuntimeError(f"Failed to get balance: {e}") from e
+
+    def get_balance(self) -> Optional[float]:
+        response = self.query_balance()
+        return float(response.Balance) if response and response.Balance else None

comms_sdk-1.0.0/src/comms_sdk/v1/models.py

@@ -0,0 +1,75 @@
+from enum import Enum
+from dataclasses import dataclass, asdict
+from typing import List, Optional
+import json
+
+class ApiResponseCode(Enum):
+    OK = "OK"
+    FAILED = "Failed"
+
+    @classmethod
+    def from_json(cls, json_string: str):
+        for code in cls:
+            if code.value.lower() == json_string.lower():
+                return code
+        raise ValueError(f"Unknown value: {json_string}")
+
+class MessagePriority(Enum):
+    HIGHEST = "0"
+    HIGH = "1"
+    MEDIUM = "2"
+    LOW = "3"
+    LOWEST = "4"
+
+    @classmethod
+    def from_value(cls, text: str):
+        for priority in cls:
+            if priority.value == text:
+                return priority
+        raise ValueError(f"Unknown priority value: {text}")
+
+class JSONSerializable:
+    def to_dict(self):
+        return asdict(self)
+    
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+@dataclass
+class UserData(JSONSerializable):
+    username: str
+    apikey: str
+
+    def to_dict(self):
+        return {
+            "username": self.username,
+            "password": self.apikey  # Maps to "password" in JSON
+        }
+
+@dataclass
+class MessageModel(JSONSerializable):
+    number: str
+    message: str
+    senderid: str
+    priority: MessagePriority
+
+@dataclass
+class ApiRequest(JSONSerializable):
+    method: str
+    userdata: UserData
+    msgdata: Optional[List[MessageModel]] = None
+    def to_dict(self):
+        return {
+            "method": self.method,
+            "userdata": self.userdata.to_dict(),
+            "msgdata": [msg.to_dict() for msg in self.msgdata] if self.msgdata else None
+        }
+
+@dataclass
+class ApiResponse(JSONSerializable):
+    Status: str
+    Message: Optional[str] = None
+    Cost: Optional[int] = None
+    Currency: Optional[str] = None
+    MsgFollowUpUniqueCode: Optional[str] = None
+    Balance: Optional[str] = None

comms_sdk-1.0.0/src/comms_sdk/v1/utils.py

@@ -0,0 +1,80 @@
+import re
+from typing import List, Set
+
+from .models import ApiRequest, ApiResponse, ApiResponseCode, UserData
+import requests
+import sys
+
+class NumberValidator:
+    _regex = r"^\+?(0|\d{3})\d{9}$"
+
+    @staticmethod
+    def validate_numbers(numbers: List[str]) -> List[str]:
+        if not numbers:
+            print("Number list cannot be null or empty", file=sys.stderr)
+            return []
+
+        cleansed_numbers: Set[str] = set()
+        for number in numbers:
+            if not number or not number.strip():
+                print(f"Number ({number}) cannot be null or empty!", file=sys.stderr)
+                continue
+            
+            number = number.strip().replace("-", "").replace(" ", "")
+            if re.match(NumberValidator._regex, number):
+                if number.startswith("0"):
+                    number = "256" + number[1:]
+                elif number.startswith("+"):
+                    number = number[1:]
+                cleansed_numbers.add(number)
+            else:
+                print(f"Number ({number}) is not valid!", file=sys.stderr)
+        return list(cleansed_numbers)
+
+class Validator:
+    @staticmethod
+    def validate_credentials(sdk) -> bool:
+        if sdk is None:
+            raise ValueError("CommsSDK instance cannot be null")
+
+        if sdk.api_key is None and sdk.user_name is None:
+            raise ValueError("API Key and Username must be provided")
+            
+        
+        if not Validator._is_valid_credential(sdk):
+            print("                                                      _                    \n" +
+                  "  /\\     _|_ |_   _  ._ _|_ o  _  _. _|_ o  _  ._    |_ _. o |  _   _| | | \n" +
+                  " /--\\ |_| |_ | | (/_ | | |_ | (_ (_|  |_ | (_) | |   | (_| | | (/_ (_| o o \n" +
+                  "                                                                           \n" +
+                  "\n")
+            return False
+        
+        print("Validated using an api key")
+        sdk.set_authenticated()
+        return True
+
+    @staticmethod
+    def _is_valid_credential(sdk) -> bool:
+        client = requests.Session()
+        api_request = ApiRequest(method="Balance",userdata=UserData(sdk.user_name, sdk.api_key))
+        req = api_request.to_dict()
+        
+        try:
+            res = client.post(sdk.API_URL, json=req)
+            # res.raise_for_status() # Raise an exception for HTTP errors
+            
+            api_response = ApiResponse(**res.json())
+            
+            if api_response.Status == ApiResponseCode.OK.value:
+                print("Credentials validated successfully.")
+                return True
+            elif api_response.Status == ApiResponseCode.FAILED.value:
+                raise Exception(api_response.Message)
+            else:
+                return False
+        except requests.exceptions.RequestException as e:
+            print(f"Error validating credentials: {e}", file=sys.stderr)
+            return False
+        except Exception as e:
+            print(f"Error validating credentials: {e}", file=sys.stderr)
+            return False

comms_sdk-1.0.0/src/comms_sdk.egg-info/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: comms_sdk
+Version: 1.0.0
+Summary: EgoSMS Python SDK
+Author-email: Pahappa Limited <systems@pahappa.com>
+License-Expression: MIT
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+
+# Usage
+
+```python
+# install the package
+pip install egosms_sdk
+# Or for dev "pip install ."
+
+
+# import in your project
+from egosms_sdk.v1 import EgoSmsSDK, MessagePriority
+
+# use
+EgoSmsSDK.authenticate("username", "password")
+EgoSmsSDK.send_sms("0712345678", "Message to send")
+# send_sms(self, numbers: List[str] | str, message: str, sender_id: Optional[str] = None, priority: MessagePriority = MessagePriority.HIGHEST)
+```

comms_sdk-1.0.0/src/comms_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+src/comms_sdk/__init__.py
+src/comms_sdk.egg-info/PKG-INFO
+src/comms_sdk.egg-info/SOURCES.txt
+src/comms_sdk.egg-info/dependency_links.txt
+src/comms_sdk.egg-info/requires.txt
+src/comms_sdk.egg-info/top_level.txt
+src/comms_sdk/v1/__init__.py
+src/comms_sdk/v1/comms_sdk.py
+src/comms_sdk/v1/models.py
+src/comms_sdk/v1/utils.py

comms_sdk-1.0.0/src/comms_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

comms_sdk-1.0.0/src/comms_sdk.egg-info/requires.txt

@@ -0,0 +1 @@
+requests

comms_sdk-1.0.0/src/comms_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+comms_sdk