Order Processing Service

This is a Python-based E-Commerce service API built with Django Rest Framework (DRF). It enables customers to place orders, authenticate via Auth0, and manage product and order data. This API also provides integration with Africa's Talking SMS API for order notifications and email notifications for the admin.

Features:

• Customer Authentication: Auth0 OpenID Connect integration to authenticate users.
• Order Management: Customers can place orders with product quantities.
• Order Notifications:
  • SMS: Customers receive SMS notifications for order updates using Africa's Talking SMS API.
  • Email: Admins are notified via email when a new order is placed.
• Hierarchical Categories: Categories store a product hierarchy, allowing easy organization of products.
• Containerized with Docker: The project is containerized for easy deployment and scaling using Docker.
• Kubernetes (Minikube): Infrastructure as a Service (IaaS) with Kubernetes for scaling and management.
• CI/CD with GitHub Actions: Automated deployment and testing using GitHub Actions.
• PostgreSQL: Uses PostgreSQL as the database for storing product, customer, and order data.

Tools and Technologies:

• Django Rest Framework (DRF) for building the API
• PostgreSQL for the database
• Auth0 for customer authentication (via OpenID Connect)
• Africa's Talking SMS API for SMS notifications
• Django Mailer and SMTP for sending email notifications
• Docker for containerization
• GitHub Actions for CI/CD pipeline
• Kubernetes (Minikube) for Infrastructure as a Service (IaaS)

Authentication Flow:

1. Auth0 Authentication: Customers authenticate using their credentials via Auth0.
2. Access Token: Upon successful authentication, an access token is generated and stored for the customer.
3. Order Placement:
   • The customer places an order by specifying products, quantities, and their phone number.
   • An order is placed by sending a request to the API with the access token.
4. Customer Creation: A Customer instance is created or updated with the provided phone number.
5. Notifications:
   • The customer receives an SMS notification about the order.
   • Admins are notified via email when a new order is placed.

Requirements:

• Clone the repository:

  git clone https://github.com/yourusername/ecommerce-service-api.git
  cd ecommerce-service-api

• Set up your environment:

  • Install the dependencies:

    pip install -r requirements.txt

  • Set up your .env file for sensitive configurations:
    • Africa's Talking: Set your shortcode, API key, and API secret for SMS notifications.
    • Auth0: Set your client ID, client secret, domain, and identifier.

  Example .env file:

  AFRICA_TALKING_API_KEY=your_api_key
  AFRICA_TALKING_API_USERNAME=sandbox
  AFRICA_TALKING_SHORTCODE=your_shortcode
  
  AUTH0_CLIENT_ID=your_client_id
  AUTH0_CLIENT_SECRET=your_client_secret
  AUTH0_DOMAIN=your_auth0_domain
  AUTH0_IDENTIFIER=your_auth0_identifier

• Docker Setup:

  • Build the Docker image:

    docker build -t yourdockerhubusername/ecommerce-app .

  • Push the Docker image to Docker Hub:

    docker push yourdockerhubusername/ecommerce-app

  • Run the container:

    docker run -p 8000:8000 yourdockerhubusername/ecommerce-app

• Kubernetes Setup (using Minikube):

  • Start Minikube:

    minikube start

  • Apply the Kubernetes configurations:

    kubectl apply -f k8s/

  • Forward ports to access the app:

    kubectl port-forward svc/ecommerce-app 8000:8000

• Check Running Pods:

  • run:

    kubectl get pods -l app=ecommerce-app

• GitHub Actions:

  • The CI/CD pipeline is configured to deploy and test the application automatically. Ensure you have your secrets configured in GitHub.

API Endpoints:

1. Order Endpoints:

• POST /api/v1/orders/: Place an order

  • Request:

    {
      "items": [
        {
          "product": "product_id",
          "quantity": 2
        },
        {
          "product": "product_id_2",
          "quantity": 1
        }
      ],
      "phone_number": "+1234567890"
    }

  • Response:

    {
          "id": "c909fadb-b6ec-47d3-a3b2-54fb58797942",
          "customer": {
              "id": "3f1a0cf4-ab02-4224-ac6b-c8d76e7fbdd5",
              "name": "auth0|67af1e32c2e9611fd73e9f1a",
              "phonenumber": "+71811001910101011",
              "email": "auth0|67af1e32c2e9611fd73e9f1a@example.com",
              "address": "",
              "user": "ab22a598-0c26-428f-801b-857334163b48"
          },
          "created_at": "2025-02-14T12:15:01.808348Z",
          "total_amount": 1450.0,
          "status": "pending",
          "items": [
              {
                  "id": "e6fe8110-64ec-47cb-8bbe-0542e4075841",
                  "product": "11eb1775-893b-453d-a92a-529627c29b0a",
                  "quantity": 7,
                  "price": 200.0
              },
              {
                  "id": "844c8afc-342c-4357-ba47-779e0af9872b",
                  "product": "acf4935a-b66f-47c6-a6ba-d840e62a6cfe",
                  "quantity": 5,
                  "price": 10.0
              }
          ]
      }

2. Authentication Endpoints:

• POST /https://{{AUTH0_DOMAIN}}/oauth/token: Login using Auth0 credentials and get the access token.

3. Product Endpoints:

• GET /api/v1/products/: List all products.
• GET /api/v1/products/average_price/?category_id="c909fadb-b6ec-47d3-a3b2-54fb58797942"/: Returns the average price of the product for a given category.
• POST /api/v1/products/: Add a new product.

4. Category Endpoints:

• GET /api/v1/categories/: List all categories.
• POST /api/v1/categories/: Create a new category.

Sample Swagger UI:

Tests Coverage:

Contribution:

Feel free to fork and contribute to this project. If you have any improvements or bug fixes, please create a pull request.