samadaderinto/pearmonie

...

pearmonie

1. Installation

   • To install required libraries and dependencies. run: m

   pip install -r requirements.txt
   

2. Usage

   • To run the project(start the server), you run the following code:

   python manage.py runserver
   

3. Authentication

   • This project uses Token-based authentication (jwt tokens). Tokens will generated on client signup/login and sent to the client, which is send periodically to the server.

4. API Endpoints

   • Endpoint 1: /api/register/

   • Method: POST

   • Description: Retrieve a list of resources.

   • Request:

     {
       "email": "[email protected]",
       "phone": "[phone]",
       "password": "HardPass@2022",
       "first_name": "samaad"
     }
     

   • Response:

     {
       "id": 1,
       "email": "[email protected]",
       "first_name": "samaad",
       "phone": "[phone]",
       "created": "2024-02-05T11:42:37.269971Z",
       "updated": "2024-02-05T11:42:37.269996Z"
     }
     

   • Endpoint 2: /api/login/

   • Method: POST

   • Description: Retrieve a list of resources.

   • Request:

     {
      "email": "[email protected]",
      "password": "HardPass@2022"
     }
     

   • Response:

     {
          "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcwNzc0MjA0NiwiaWF0IjoxNzA3MTM3MjQ2LCJ dummy qdGkiOiJhNTU1Y2JlZmExMmY0ZmU3ODc2MDIxYzRiZjg0OWJmNCIsInVzZXJfaWQiOjF9.wFY2h1WZTiSqogGi1s7WyJ0BM4WhoAxVFXL86ovPVyk",
          "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzA3Mzk2NDQ2LCJpYXQiOjE3MDcxMzcyNDYsImp0aSI6 dummy IjEwMGRjNDc2NTE2MDRkZDBhMWQ1NTdlYmM2YmEwYzQyIiwidXNlcl9pZCI6MX0.m169D0RoesCZMjrOMWoIYvIv6b5iw_ySUygU1Bd_hQY"
     }
     

   • Endpoint 3: /api/logout/

   • Method: POST

   • Description: Retrieve a list of resources.

   • Request:

     {
     "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcwNzc0MjA0NiwiaWF0IjoxNzA3MTM3MjQ2LCJqdGkiOiJhNTU1Y2JlZmExMmY0ZmU3ODc2MDIxYzRiZjg0OWJmNCIsInVzZXJfaWQiOjF9.wFY2h1WZTiSqogGi1s7WyJ0BM4WhoAxVFXL86ovPVyk"
     }
     

   • Response: None

   • Endpoint 4: /api/login/refresh/

   • Method: POST

   • Description: Retrieve a list of resources.

   • Request:

     {
     "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcwNzc0MjA0NiwiaWF0IjoxNzA3MTM3MjQ2LCJqdGkiOiJhNTU1Y2JlZmExMmY0ZmU3ODc2MDIxYzRiZjg0OWJmNCIsInVzZXJfaWQiOjF9.wFY2h1WZTiSqogGi1s7WyJ0BM4WhoAxVFXL86ovPVyk"
     }
     

   • Response:

     {
     "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzA3Mzk2NDQ2LCJpYXQiOjE3MDcxMzcyNDYsImp0aSI6 dummy IjEwMGRjNDc2NTE2MDRkZDBhMWQ1NTdlYmM2YmEwYzQyIiwidXNlcl9pZCI6MX0.m169D0RoesCZMjrOMWoIYvIv6b5iw_ySUygU1Bd_hQY"
     }
     

   • Endpoint 5: /api/user/expense/

   • Method: POST

   • Request:

   • Response: None

   • Endpoint 6: /api/user/expense/all/

   • Method: GET

   • Request: None

   • Response:

     [{"id":2,"user":1,"category":"oojjpo","amount":900, date: 2024-02-06},{"id":3,"user":1,"category":"oopjo","amount":900, date: 2024-02-05}]
     

   • Endpoint 7: /api/user/budget/

   • Method: POST

   • Description: Retrieve a list of resources.

   • Request:

     {
     
       "user": 1,
       "category": "oopoq",
       "amount": 900
     }
     

   • Response: None

   • Endpoint 8: /api/user/budget/all/

   • Method: GET

   • Description: Retrieve a list of resources.

   • Request: None

   • Response:

     [
     {
     "id":2,
     "user":1,
     "category":"oorrpo",
     "amount":900
     },
     {"id":3,
     "user":1,
     "category":"oopro",
     "amount":900
     }]
     

5. Database Models

   class User(AbstractUser):
    username = None
    first_name = models.CharField(max_length=30)
    email = models.EmailField(unique=True)
    phone = PhoneNumberField(region="US")
    password = models.CharField(max_length=90)
    created = models.DateTimeField(auto_now_add=True)
    updated = models.DateTimeField(auto_now=True)
   
    USERNAME_FIELD = "email"
    REQUIRED_FIELDS = ["first_name","phone", "password"]
   
    objects = UserManager()
       
   
   class Expense(models.Model):
       user = models.ForeignKey(User, on_delete=models.CASCADE)
       category = models.CharField(max_length=40)
       description = models.TextField(max_length=60)
       amount = models.IntegerField(validators=[MinValueValidator(1)])
       date = models.DateTimeField(auto_now_add=True)
   
   
   class Budget(models.Model):
       user = models.ForeignKey(User, on_delete=models.CASCADE)
       category = models.CharField(max_length=40)
       amount = models.IntegerField(default=0, validators=[MinValueValidator(0)])
   

6. Permissions

• This library brings a declaritive, organized approach to managing access control in Django REST Framework projects. Each ViewSet or function-based view can be assigned an explicit policy for the exposed resources. No more digging through views or seralizers to understand access logic -- it's all in one place in a format that less technical stakeholders can understand. If you're familiar with other declaritive access models, such as AWS' IAM, the syntax will be familiar.

statements = [
     {
         "action": ["list", "retrieve"],
         "principal": "*",
         "effect": "allow"
     },
     {
         "action": ["publish", "unpublish"],
         "principal": ["group:editor"],
         "effect": "allow"
     }]

Example from this code snippet:

from rest_access_policy import AccessPolicy


# all views with permitted users in json


class AccessPolicies(AccessPolicy):
    statements = [
        {
            "action": [
                "register",
                "Login",
            ],
            "principal": "*",
            "effect": "allow",
        },
        {
            "action": [
                "Logout",
                "BudgetViewSet",
                "ExpenseViewSet",
                "ExpensesViewSet",
                "BudgetsViewSet"
                
               
            ],
            "principal": ["authenticated"],
            "effect": "allow"
        },
       
    ]