Initial commit

src/contact/config.py

@@ -0,0 +1,7 @@
+"""
+Configurations for contact module
+
+Configurations:
+ - List: Description
+ - Configs: Description
+"""

src/contact/constants.py

@@ -0,0 +1,7 @@
+"""
+Constants and error codes for contact module
+
+Constants:
+ - List: Description
+ - Consts: Description
+"""

src/contact/dependencies.py

@@ -0,0 +1,11 @@
+"""
+Router dependencies for contact module
+
+Classes:
+ - List: Description
+ - Classes: Description
+
+Functions:
+ - List: Description
+ - Functions: Description
+"""

src/contact/exceptions.py

@@ -0,0 +1,7 @@
+"""
+Module specific exceptions for contact module
+
+Exceptions:
+ - List: Description
+ - Exceptions: Description
+"""

src/contact/models.py

@@ -0,0 +1,29 @@
+"""
+Database models for contact module
+
+Models:
+ - Contact: id[pk], email, first_name, last_name, phonenumber, vat_number
+            street_address, post_office_box_number, address_locality, country_code, address_region, postal_code
+"""
+from sqlalchemy import Column, Integer, String
+
+from src.database import Base
+
+
+class Contact(Base):
+	__tablename__ = "contact"
+
+	id = Column(Integer, primary_key=True)
+	email = Column(String)
+	first_name = Column(String)
+	last_name = Column(String)
+	phonenumber = Column(String)
+	vat_number = Column(String, default=None, nullable=True)
+
+	street_address = Column(String)
+	street_address_line_2 = Column(String)
+	post_office_box_number = Column(String, default=None, nullable=True)
+	locality = Column(String)               # Ie City
+	country_code = Column(String)           # Eg GB
+	address_region = Column(String, default=None, nullable=True)
+	postal_code = Column(String)

src/contact/router.py

@@ -0,0 +1,116 @@
+"""
+Router endpoints for contact module
+
+Endpoints:
+ - [get]/{contact_id} - Returns non-address type details for contact
+ - [get]/{contact_id}/address - Returns address details for contact
+ - [get]/{contact_id}/orgs - Returns a list of orgs which the contact is assigned to, and what they are assigned as
+ - [post]/ - Creates a new contact
+ - [patch]/{contact_id} - Updates the details of an existing contact
+ - [delete]/{contact_id} - Deletes a contact by ID
+"""
+from fastapi import APIRouter, HTTPException
+from fastapi.params import Path
+
+from sqlalchemy import or_
+
+from src.contact.schemas import ContactContactGetResponse, ContactAddressGetResponse, ContactContactPostRequest, \
+	ContactUpdateRequest, ContactOrgGetResponse
+from src.contact.models import Contact
+
+from src.database import db_dependency
+from src.organisation.models import Organisation as Org
+from src.organisation.constants import ContactType
+
+router = APIRouter(
+	prefix="/contact",
+	tags=["contact"],
+)
+
+
+@router.get("/{contact_id}", response_model=ContactContactGetResponse)
+async def get_contact_details_by_id(contact_id: int, db: db_dependency):
+	contact_model = (db.query(Contact).filter(Contact.id == contact_id).first())
+	if contact_model is None:
+		raise HTTPException(status_code=404, detail="Contact not found")
+
+	return contact_model
+
+
+@router.get("/{contact_id}/address", response_model=ContactAddressGetResponse)
+async def get_contact_address_by_id(contact_id: int, db: db_dependency):
+	contact_model = (db.query(Contact).filter(Contact.id == contact_id).first())
+	if contact_model is None:
+		raise HTTPException(status_code=404, detail="Contact not found")
+
+	return contact_model
+
+
+@router.post("/")
+async def create_contact(db: db_dependency, contact_request: ContactContactPostRequest):
+	contact_model = Contact(**contact_request.model_dump())
+
+	db.add(contact_model)
+	db.commit()
+
+
+@router.patch("/{contact_id}")
+async def update_contact(db: db_dependency, contact_request: ContactUpdateRequest, contact_id: int = Path(gt=0)):
+	contact_model = (db.query(Contact).filter(Contact.id == contact_id).first())
+	if contact_model is None:
+		raise HTTPException(status_code=404, detail="Contact not found")
+
+	update_data = contact_request.model_dump(exclude_none=True)
+	for key, value in update_data.items():
+		if hasattr(contact_model, key):
+			setattr(contact_model, key, value)
+		else:
+			raise HTTPException(status_code=422, detail="Invalid keys in update request")
+
+	db.add(contact_model)
+	db.commit()
+
+
+@router.delete("/{contact_id}")
+async def delete_contact(db: db_dependency, contact_id: int = Path(gt=0)):
+	contact_model = (db.query(Contact).filter(Contact.id == contact_id).first())
+	if contact_model is None:
+		raise HTTPException(status_code=404, detail="Contact not found")
+
+	db.delete(contact_model)
+	db.commit()
+
+
+@router.get("/{contact_id}/orgs", response_model=list[ContactOrgGetResponse])
+async def get_contact_orgs(db: db_dependency, contact_id: int = Path(gt=0)):
+	contact_model = (db.query(Contact).filter(Contact.id == contact_id).first())
+	if contact_model is None:
+		raise HTTPException(status_code=404, detail="Contact not found")
+
+	org_models = (db.query(Org).filter(
+		or_(
+			Org.owner_contact_id == contact_id,
+			Org.billing_contact_id == contact_id,
+			Org.security_contact_id == contact_id
+		)
+	).all())
+
+	response = []
+
+	for org in org_models:
+		types=[]
+		if org.owner_contact_id == contact_id:
+			types.append(ContactType.OWNER)
+		if org.billing_contact_id == contact_id:
+			types.append(ContactType.BILLING)
+		if org.security_contact_id == contact_id:
+			types.append(ContactType.SECURITY)
+
+		org_response_model = ContactOrgGetResponse(
+			name=str(org.name),
+			contact_types=types,
+		)
+		response.append(org_response_model)
+
+
+	return response

src/contact/schemas.py

@@ -0,0 +1,62 @@
+"""
+Pydantic models for contact module
+
+Models:
+ - List: Description
+ - Models: Description
+"""
+from typing import Optional
+
+from pydantic import Field, EmailStr
+
+from src.organisation.constants import ContactType
+from src.schemas import CustomBaseModel
+
+
+class ContactContactGetResponse(CustomBaseModel):
+	email: str
+	first_name: str
+	last_name: str
+	phonenumber: str
+	vat_number: Optional[str] = None
+
+class ContactAddressGetResponse(CustomBaseModel):
+	post_office_box_number: Optional[str] = None
+	street_address: Optional[str] = None        # If using a PO box, there would be no street address
+	street_address_line_2: Optional[str] = None
+	locality: str
+	address_region: Optional[str] = None
+	country_code: str
+	postal_code: str
+
+class ContactContactPostRequest(CustomBaseModel):
+	email: EmailStr
+	first_name: str
+	last_name: str
+	phonenumber: str
+	vat_number: Optional[str] = None
+	post_office_box_number: Optional[str] = None
+	street_address: Optional[str] = None
+	street_address_line_2: Optional[str] = None
+	locality: str
+	address_region: Optional[str] = None
+	country_code: str
+	postal_code: str
+
+class ContactUpdateRequest(CustomBaseModel):
+	email: Optional[EmailStr] = None
+	first_name: Optional[str] = None
+	last_name: Optional[str] = None
+	phonenumber: Optional[str] = None
+	vat_number: Optional[str] = None
+	post_office_box_number: Optional[str] = None
+	street_address: Optional[str] = None
+	street_address_line_2: Optional[str] = None
+	locality: Optional[str] = None
+	address_region: Optional[str] = None
+	country_code: Optional[str] = None
+	postal_code: Optional[str] = None
+
+class ContactOrgGetResponse(CustomBaseModel):
+	name: str
+	contact_types: list[ContactType]

src/contact/service.py

@@ -0,0 +1,11 @@
+"""
+Module specific business logic for contact module
+
+Classes:
+ - List: Description
+ - Classes: Description
+
+Functions:
+ - List: Description
+ - Functions: Description
+"""

src/contact/utils.py

@@ -0,0 +1,11 @@
+"""
+Non-business logic reusable functions and classes for contact module
+
+Classes:
+ - List: Description
+ - Classes: Description
+
+Functions:
+ - List: Description
+ - Functions: Description
+"""