afri-auth-sms 0.1.0__tar.gz

afri_auth_sms-0.1.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: afri-auth-sms
+Version: 0.1.0
+Summary: Plug and play OTP authentication for African telecom providers
+Author: AdamKatani
+License: MIT
+Project-URL: Homepage, https://github.com/AdamMashaka/africastalking-kit-sms
+Project-URL: Repository, https://github.com/AdamMashaka/africastalking-kit-sms
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: redis
+Requires-Dist: africastalking
+Requires-Dist: python-dotenv
+Requires-Dist: typer
+
+# Afri Auth SMS
+
+Plug-and-play SMS OTP authentication package for FastAPI and Africa's Talking.
+
+## Installation
+
+pip install afri-auth-sms
+
+## Usage
+
+from afri_auth import OTPAuth

afri_auth_sms-0.1.0/README.md

@@ -0,0 +1,11 @@
+# Afri Auth SMS
+
+Plug-and-play SMS OTP authentication package for FastAPI and Africa's Talking.
+
+## Installation
+
+pip install afri-auth-sms
+
+## Usage
+
+from afri_auth import OTPAuth

afri_auth_sms-0.1.0/afri_auth/__init__.py

@@ -0,0 +1 @@
+from .otp import OTPAuth

afri_auth_sms-0.1.0/afri_auth/cli.py

@@ -0,0 +1,21 @@
+import typer
+import shutil
+from pathlib import Path
+
+app = typer.Typer()
+
+
+@app.command()
+def init(project_name: str = "starter_project"):
+
+    source = Path(__file__).parent / "templates"
+    destination = Path(project_name)
+
+    destination.mkdir(exist_ok=True)
+
+    shutil.copy(
+        source / "fastapi_app.py",
+        destination / "main.py"
+    )
+
+    typer.echo(f"Project '{project_name}' created successfully!")

afri_auth_sms-0.1.0/afri_auth/config.py

@@ -0,0 +1,12 @@
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+AFRICASTALKING_USERNAME = os.getenv("AFRICASTALKING_USERNAME")
+AFRICASTALKING_API_KEY = os.getenv("AFRICASTALKING_API_KEY")
+
+REDIS_HOST = os.getenv("REDIS_HOST", "localhost")
+REDIS_PORT = int(os.getenv("REDIS_PORT", 6379))
+
+OTP_EXPIRY = int(os.getenv("OTP_EXPIRY", 300))

afri_auth_sms-0.1.0/afri_auth/fastapi/__init__.py

@@ -0,0 +1 @@
+from .router import router as OTPRouter

afri_auth_sms-0.1.0/afri_auth/fastapi/router.py

@@ -0,0 +1,29 @@
+from fastapi import APIRouter
+from pydantic import BaseModel
+from afri_auth.otp import OTPAuth
+
+router = APIRouter()
+
+otp_auth = OTPAuth()
+
+
+class SendOTPRequest(BaseModel):
+    phone: str
+
+
+class VerifyOTPRequest(BaseModel):
+    phone: str
+    code: str
+
+
+@router.post("/send-otp")
+async def send_otp(data: SendOTPRequest):
+    return await otp_auth.send_otp(data.phone)
+
+
+@router.post("/verify-otp")
+async def verify_otp(data: VerifyOTPRequest):
+    return await otp_auth.verify_otp(
+        data.phone,
+        data.code
+    )

afri_auth_sms-0.1.0/afri_auth/otp.py

@@ -0,0 +1,49 @@
+from .security import generate_otp
+from .storage import redis_client
+from .providers.africastalking import send_sms
+from .config import OTP_EXPIRY
+
+
+class OTPAuth:
+
+    async def send_otp(self, phone: str):
+
+        code = generate_otp()
+
+        redis_client.setex(
+            f"otp:{phone}",
+            OTP_EXPIRY,
+            code
+        )
+
+        message = f"Your OTP code is {code}"
+
+        await send_sms(phone, message)
+
+        return {
+            "success": True,
+            "message": "OTP sent successfully"
+        }
+
+    async def verify_otp(self, phone: str, code: str):
+
+        stored_code = redis_client.get(f"otp:{phone}")
+
+        if not stored_code:
+            return {
+                "success": False,
+                "message": "OTP expired"
+            }
+
+        if stored_code != code:
+            return {
+                "success": False,
+                "message": "Invalid OTP"
+            }
+
+        redis_client.delete(f"otp:{phone}")
+
+        return {
+            "success": True,
+            "message": "OTP verified successfully"
+        }

afri_auth_sms-0.1.0/afri_auth/providers/africastalking.py

@@ -0,0 +1,29 @@
+from afri_auth.config import AFRICASTALKING_USERNAME
+import africastalking
+
+# from afri_auth.config import (
+#     AFRICASTALKING_USERNAME,
+#     AFRICASTALKING_API_KEY
+)
+
+def get_sms_client():
+
+    africastalking.initialize(
+        AFRICASTALKING_USERNAME,
+        AFRICASTALKING_API_KEY
+    )
+
+    return africastalking.SMS
+sms = africastalking.SMS
+
+
+async def send_sms(phone, message):
+
+    sms = get_sms_client()
+
+    response = sms.send(
+        message,
+        [phone]
+    )
+
+    return response

afri_auth_sms-0.1.0/afri_auth/security.py

@@ -0,0 +1,4 @@
+import random
+
+def generate_otp():
+    return str(random.randint(100000, 999999))

afri_auth_sms-0.1.0/afri_auth/storage.py

@@ -0,0 +1,8 @@
+import redis
+from .config import REDIS_HOST, REDIS_PORT
+
+redis_client = redis.Redis(
+    host=REDIS_HOST,
+    port=REDIS_PORT,
+    decode_responses=True
+)

afri_auth_sms-0.1.0/afri_auth/template/fastapi_app.py

@@ -0,0 +1,17 @@
+from fastapi import FastAPI
+from afri_auth.fastapi import OTPRouter
+
+app = FastAPI()
+
+app.include_router(
+    OTPRouter,
+    prefix="/auth",
+    tags=["Authentication"]
+)
+
+
+@app.get("/")
+def home():
+    return {
+        "message": "Afri Auth Running"
+    }

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

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: afri-auth-sms
+Version: 0.1.0
+Summary: Plug and play OTP authentication for African telecom providers
+Author: AdamKatani
+License: MIT
+Project-URL: Homepage, https://github.com/AdamMashaka/africastalking-kit-sms
+Project-URL: Repository, https://github.com/AdamMashaka/africastalking-kit-sms
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: redis
+Requires-Dist: africastalking
+Requires-Dist: python-dotenv
+Requires-Dist: typer
+
+# Afri Auth SMS
+
+Plug-and-play SMS OTP authentication package for FastAPI and Africa's Talking.
+
+## Installation
+
+pip install afri-auth-sms
+
+## Usage
+
+from afri_auth import OTPAuth

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

@@ -0,0 +1,18 @@
+README.md
+pyproject.toml
+afri_auth/__init__.py
+afri_auth/cli.py
+afri_auth/config.py
+afri_auth/otp.py
+afri_auth/security.py
+afri_auth/storage.py
+afri_auth/fastapi/__init__.py
+afri_auth/fastapi/router.py
+afri_auth/providers/africastalking.py
+afri_auth/template/fastapi_app.py
+afri_auth_sms.egg-info/PKG-INFO
+afri_auth_sms.egg-info/SOURCES.txt
+afri_auth_sms.egg-info/dependency_links.txt
+afri_auth_sms.egg-info/entry_points.txt
+afri_auth_sms.egg-info/requires.txt
+afri_auth_sms.egg-info/top_level.txt

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

@@ -0,0 +1 @@
+

afri_auth_sms-0.1.0/afri_auth_sms.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+afri-auth-sms = afri_auth.cli:app

afri_auth_sms-0.1.0/afri_auth_sms.egg-info/requires.txt

@@ -0,0 +1,6 @@
+fastapi
+uvicorn
+redis
+africastalking
+python-dotenv
+typer

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

@@ -0,0 +1 @@
+afri_auth

afri_auth_sms-0.1.0/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "afri-auth-sms"
+version = "0.1.0"
+description = "Plug and play OTP authentication for African telecom providers"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+
+authors = [
+    {name = "AdamKatani"}
+]
+
+dependencies = [
+    "fastapi",
+    "uvicorn",
+    "redis",
+    "africastalking",
+    "python-dotenv",
+    "typer"
+]
+
+[project.urls]
+Homepage = "https://github.com/AdamMashaka/africastalking-kit-sms"
+Repository = "https://github.com/AdamMashaka/africastalking-kit-sms"
+
+[project.scripts]
+afri-auth-sms = "afri_auth.cli:app"
+
+[tool.setuptools.packages.find]
+include = ["afri_auth*"]

afri_auth_sms-0.1.0/setup.cfg

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