|
+
+
+
+ Your account is now active+ +
+
+
+ Hi {{first_name}}, {{last_name}} +Congratulations! Your account with Boilerplate is now active and ready + to use. +
+
+
+
+ Learn more
+
+
+ We're thrilled to have you as part of our community and look forward + to helping you make the most out of your experience with us.+
+
+ + You can now log in and start exploring all the features and benefits we have to offer. + +
+
+
+ Thank you for joining Boilerplate +
+
+ Regards, +Boilerplate + |
+
Account Deactivation In Two Days
+Hi John Doe,
++ Your deactivation details: +
+Account Email: johndoe@gmail.com
+Last Active: 17th June, 2024 / 11:56pm
+Deactivation Date: 20th July, 2024 / 11:56pm
++ To keep your account active, simply log in before the deactivation + date. However, if you no longer wish to use your account, no + further action is needed on your part. +
+ +Regards,
+Boilerplate
+Account Deactivation Due To Inactivity
+Hi John Doe,
+ +Your deactivation details:
+Account Email: johndoe@gmail.com
+Last Active: 17th June, 2024 / 11:56pm
+Deactivation Date: 20th July, 2024 / 11:56pm
++ If you would like to re-activate your account, you can easily do so + by contacting our support team via the details below. +
++ Give us a call at + (+234)-456-7890 or shoot us an + email at support@llaihng.com +
+We value your membership and would love to have you back.
+Regards,
+Boilerplate
+Activate Your Account
+Hi John Doe,
+ + +Regards,
+Boilerplate
+Activation Link Expired
+Hi John Doe,
+ ++ Don’t worry, you can easily request a new activation link by + clicking the button below: +
+ Send Another Activation Link +Regards,
+Boilerplate
+
+ HNG Boilerplate+ |
+
|
+ + Need help? Contact our customer support +You are receiving this email because you signed up at Boilerplate.com. Want to change how you receive these emails? Update your preferences or unsubscribe from this list. + |
+
Account Deactivation In Two Days
+Hi John Doe,
+ +Your deactivation details:
+Account Email: johndoe@gmail.com
+Last Active: 17th June, 2024 / 11:56pm
+Deactivation Date: 20th July, 2024 / 11:56pm
++ To keep your account active, simply log in before the deactivation + date. However, if you no longer wish to use your account, no further + action is needed on your part. +
+ +Regards,
+Boilerplate
+Email Confirmed
+Hi John Doe,
+ ++ You can now fully enjoy all the features and benefits we offer, + including exclusive access to key features, special discounts, and + personalized content. +
+ + Proceed to Account + +Regards,
+Boilerplate
+Email Verification
+Hi John Doe,
+ ++ This link will expire 30 minutes after this email has been sent. If + you did not make this request, you can ignore this email. +
+To verify your email, please click the button below:
+ ++ Or copy this link: + + https://carbonated-umbra-a35.notion.site/Language-Learning-AI-game-608b687875cf4b48a9a0194ee82ae17d + +
+Regards,
+Boilerplate
+New Activation Link Sent
+Hi John Doe,
+ + + + +Regards,
+Boilerplate
+Password Reset Complete
+Hi John Doe,
+ ++ If this wasn't done by you, please immediately reset the password to + your Boilerplate account by following the steps below: +
+Regards,
+Boilerplate
+Reset Your Password
+Hi John Doe,
+ + + +Regards,
+Boilerplate
+|
+
+
+
+ Welcome to Boilerplate+Thanks for signing up +
+
+
+ Hi {{first_name}}, {{last_name}} +We're thrilled to have you join us. Experience quality and innovation + like never before. Our product is made to fit your needs and make your + life easier. +
+
+
+
+ Learn more about us
+
+
+
+
+ Here's what you can look forward to.+
+
+
+
+ Regards, +Boilerplate + |
+
Use the following link to log in: Magic Link
" + + part1 = MIMEText(text, "plain") + part2 = MIMEText(html, "html") + + message.attach(part1) + message.attach(part2) + + with smtplib.SMTP(settings.MAIL_SERVER, settings.MAIL_PORT) as server: + server.starttls() + server.login(sender_email, password) + server.sendmail(sender_email, receiver_email, message.as_string()) diff --git a/api/utils/settings.py b/api/utils/settings.py index a7125eb4a..9146d9f06 100644 --- a/api/utils/settings.py +++ b/api/utils/settings.py @@ -10,8 +10,6 @@ class Settings(BaseSettings): """ Class to hold application's config values.""" - # API_V1_STR: str = "/api/v1" - # APP_NAME: str = "TicketHub" SECRET_KEY: str = config("SECRET_KEY") ALGORITHM: str = config("ALGORITHM") ACCESS_TOKEN_EXPIRE_MINUTES: int = config("ACCESS_TOKEN_EXPIRE_MINUTES") @@ -26,12 +24,16 @@ class Settings(BaseSettings): DB_TYPE: str = config("DB_TYPE") MAIL_USERNAME: str = config("MAIL_USERNAME") - MAIL_PASSWORD: str = config('MAIL_PASSWORD') - MAIL_FROM: str = config('MAIL_FROM') - MAIL_PORT: int = config('MAIL_PORT') - MAIL_SERVER: str = config('MAIL_SERVER') + MAIL_PASSWORD: str = config("MAIL_PASSWORD") + MAIL_FROM: str = config("MAIL_FROM") + MAIL_PORT: int = config("MAIL_PORT") + MAIL_SERVER: str = config("MAIL_SERVER") + + FLUTTERWAVE_SECRET: str = config("FLUTTERWAVE_SECRET") + + TWILIO_ACCOUNT_SID: str = config("TWILIO_ACCOUNT_SID") + TWILIO_AUTH_TOKEN: str = config("TWILIO_AUTH_TOKEN") + TWILIO_PHONE_NUMBER: str = config("TWILIO_PHONE_NUMBER") - # FACEBOOK_APP_ID: str = config("FACEBOOK_APP_ID") - # FACEBOOK_APP_SECRET: str = config("FACEBOOK_APP_SECRET") settings = Settings() diff --git a/api/utils/success_response.py b/api/utils/success_response.py index 149af3869..3048bf2d8 100644 --- a/api/utils/success_response.py +++ b/api/utils/success_response.py @@ -1,20 +1,18 @@ -from typing import Optional +from typing import Optional, Dict, Any from fastapi.responses import JSONResponse +from fastapi.encoders import jsonable_encoder def success_response(status_code: int, message: str, data: Optional[dict] = None): - '''Returns a JSOn response for success responses''' + '''Returns a JSON response for success responses''' response_data = { "status_code": status_code, "success": True, "message": message } + + if data is not None: + response_data["data"] = data - if data: - response_data['data'] = data - - return JSONResponse( - status_code=status_code, - content=response_data - ) + return JSONResponse(status_code=status_code, content=jsonable_encoder(response_data)) diff --git a/api/v1/models/__init__.py b/api/v1/models/__init__.py index 701396940..120e32717 100644 --- a/api/v1/models/__init__.py +++ b/api/v1/models/__init__.py @@ -1,22 +1,29 @@ from api.v1.models.activity_logs import ActivityLog from api.v1.models.billing_plan import BillingPlan -from api.v1.models.comment import Comment +from api.v1.models.comment import Comment, CommentLike, CommentDislike from api.v1.models.contact_us import ContactUs from api.v1.models.message import Message from api.v1.models.payment import Payment from api.v1.models.waitlist import Waitlist from api.v1.models.user import User -from api.v1.models.org import Organization -from api.v1.models.org_role import OrgRole +from api.v1.models.organization import Organization from api.v1.models.profile import Profile from api.v1.models.notifications import Notification -from api.v1.models.product import Product -from api.v1.models.blog import Blog -from api.v1.models.job import Job +from api.v1.models.product import ProductVariant, ProductCategory, Product +from api.v1.models.blog import Blog, BlogLike, BlogDislike +from api.v1.models.job import Job, JobApplication from api.v1.models.testimonial import Testimonial from api.v1.models.token_login import TokenLogin from api.v1.models.oauth import OAuth from api.v1.models.invitation import Invitation -from api.v1.models.newsletter import Newsletter -from api.v1.models.blog_dislike import BlogDislike -from api.v1.models.blog_like import BlogLike \ No newline at end of file +from api.v1.models.faq import FAQ +from api.v1.models.newsletter import Newsletter, NewsletterSubscriber +from api.v1.models.topic import Topic +from api.v1.models.email_template import EmailTemplate +from api.v1.models.regions import Region +from api.v1.models.squeeze import Squeeze +from api.v1.models.sales import Sales +from api.v1.models.team import TeamMember +from api.v1.models.data_privacy import DataPrivacySetting +from api.v1.models.privacy import PrivacyPolicy +from api.v1.models.terms import TermsAndConditions diff --git a/api/v1/models/activity_logs.py b/api/v1/models/activity_logs.py index 5f6b8a87a..1c9169158 100644 --- a/api/v1/models/activity_logs.py +++ b/api/v1/models/activity_logs.py @@ -1,13 +1,14 @@ -from sqlalchemy import Column, String, Integer, DateTime, ForeignKey +from sqlalchemy import Column, String, DateTime, ForeignKey from sqlalchemy.orm import relationship from sqlalchemy.sql import func from api.v1.models.base_model import BaseTableModel + class ActivityLog(BaseTableModel): __tablename__ = "activity_logs" - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) action = Column(String, nullable=False) timestamp = Column(DateTime(timezone=True), server_default=func.now()) - user = relationship("User", back_populates="activity_logs") \ No newline at end of file + user = relationship("User", back_populates="activity_logs") diff --git a/api/v1/models/associations.py b/api/v1/models/associations.py new file mode 100644 index 000000000..1d183e52f --- /dev/null +++ b/api/v1/models/associations.py @@ -0,0 +1,37 @@ +""" Associations +""" +from sqlalchemy import ( + Column, + ForeignKey, + String, + Table, + Enum + ) +from api.db.database import Base + + +user_organization_association = Table( + "user_organization", + Base.metadata, + Column( + "user_id", String, ForeignKey("users.id", ondelete="CASCADE"), primary_key=True + ), + Column( + "organization_id", + String, + ForeignKey("organizations.id", ondelete="CASCADE"), + primary_key=True, + ), + Column( + "role", + Enum("admin", "user", "guest", "owner", name="user_org_role"), + nullable=False, + default="user", + ), + Column( + "status", + Enum("member", "suspended", "left", name="user_org_status"), + nullable=False, + default="member", + ), +) diff --git a/api/v1/models/base.py b/api/v1/models/base.py deleted file mode 100644 index 55dd0ea39..000000000 --- a/api/v1/models/base.py +++ /dev/null @@ -1,29 +0,0 @@ -""" Associations -""" -from sqlalchemy import ( - Column, - ForeignKey, - String, - Table, - Integer, - DateTime, - func - ) -from sqlalchemy.dialects.postgresql import UUID -from api.db.database import Base - - -user_organization_association = Table('user_organization', Base.metadata, - Column('user_id', String, ForeignKey('users.id', ondelete='CASCADE'), primary_key=True), - Column('organization_id', String, ForeignKey('organizations.id', ondelete='CASCADE'), primary_key=True), - Column('status', String(20), nullable=False, default="member") - -) - -user_newsletter_association = Table( - 'user_newsletter_association', - Base.metadata, - Column('user_id', String, ForeignKey('users.id'), primary_key=True), - Column('newsletter_id', String, ForeignKey('newsletters.id'), primary_key=True), - Column('created_at', DateTime(timezone=True), server_default=func.now()) -) \ No newline at end of file diff --git a/api/v1/models/base_model.py b/api/v1/models/base_model.py index 32bc49ef4..57c0daaaf 100644 --- a/api/v1/models/base_model.py +++ b/api/v1/models/base_model.py @@ -3,30 +3,30 @@ """ from uuid_extensions import uuid7 from fastapi import Depends -from sqlalchemy.dialects.postgresql import UUID -from api.v1.models.base import Base +from api.v1.models.associations import Base from sqlalchemy import ( - Column, - String, - DateTime, - func - ) + Column, + String, + DateTime, + func +) class BaseTableModel(Base): - """ This model creates helper methods for all models - """ + """This model creates helper methods for all models""" + __abstract__ = True - + id = Column(String, primary_key=True, index=True, default=lambda: str(uuid7())) created_at = Column(DateTime(timezone=True), server_default=func.now()) - updated_at = Column(DateTime(timezone=True), server_default=func.now(), onupdate=func.now()) + updated_at = Column( + DateTime(timezone=True), server_default=func.now(), onupdate=func.now() + ) def to_dict(self): - """ returns a dictionary representation of the instance - """ + """returns a dictionary representation of the instance""" obj_dict = self.__dict__.copy() del obj_dict["_sa_instance_state"] - obj_dict['id'] = self.id + obj_dict["id"] = self.id if self.created_at: obj_dict["created_at"] = self.created_at.isoformat() if self.updated_at: @@ -36,6 +36,7 @@ def to_dict(self): @classmethod def get_all(cls): from api.db.database import get_db + db = Depends(get_db) """ returns all instance of the class in the db """ @@ -44,6 +45,7 @@ def get_all(cls): @classmethod def get_by_id(cls, id): from api.db.database import get_db + db = Depends(get_db) """ returns a single object from the db """ diff --git a/api/v1/models/billing_plan.py b/api/v1/models/billing_plan.py index 9a50c464b..69eba80de 100644 --- a/api/v1/models/billing_plan.py +++ b/api/v1/models/billing_plan.py @@ -1,15 +1,20 @@ # app/models/billing_plan.py -from sqlalchemy import Column, String, ARRAY, ForeignKey, Numeric, DateTime, JSON +from sqlalchemy import Column, String, ARRAY, ForeignKey, Numeric from sqlalchemy.orm import relationship from api.v1.models.base_model import BaseTableModel + class BillingPlan(BaseTableModel): __tablename__ = "billing_plans" - organization_id = Column(String, ForeignKey('organizations.id', ondelete="CASCADE"), nullable=False) + organization_id = Column( + String, ForeignKey("organizations.id", ondelete="CASCADE"), nullable=False + ) name = Column(String, nullable=False) price = Column(Numeric, nullable=False) currency = Column(String, nullable=False) + duration = Column(String, nullable=False) + description = Column(String, nullable=True) features = Column(ARRAY(String), nullable=False) organization = relationship("Organization", back_populates="billing_plans") diff --git a/api/v1/models/blog.py b/api/v1/models/blog.py index 8dc4cea40..96586da3b 100644 --- a/api/v1/models/blog.py +++ b/api/v1/models/blog.py @@ -3,24 +3,54 @@ from sqlalchemy import Column, String, Text, ForeignKey, Boolean, text from sqlalchemy.orm import relationship -# from api.v1.models.base import Base from api.v1.models.base_model import BaseTableModel -from sqlalchemy.dialects.postgresql import UUID, ARRAY -from uuid_extensions import uuid7 class Blog(BaseTableModel): __tablename__ = "blogs" - author_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + author_id = Column( + String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False + ) title = Column(String, nullable=False) content = Column(Text, nullable=False) image_url = Column(String, nullable=True) is_deleted = Column(Boolean, server_default=text("false")) excerpt = Column(Text, nullable=True) - tags = Column(Text, nullable=True) # Assuming tags are stored as a comma-separated string + tags = Column( + Text, nullable=True + ) # Assuming tags are stored as a comma-separated string author = relationship("User", back_populates="blogs") - comments = relationship("Comment", back_populates="blog", cascade="all, delete-orphan") - likes = relationship("BlogLike", back_populates="blog", cascade="all, delete-orphan") - dislikes = relationship("BlogDislike", back_populates="blog", cascade="all, delete-orphan") \ No newline at end of file + comments = relationship( + "Comment", back_populates="blog", cascade="all, delete-orphan" + ) + likes = relationship( + "BlogLike", back_populates="blog", cascade="all, delete-orphan" + ) + dislikes = relationship( + "BlogDislike", back_populates="blog", cascade="all, delete-orphan" + ) + + +class BlogDislike(BaseTableModel): + __tablename__ = "blog_dislikes" + + blog_id = Column(String, ForeignKey("blogs.id", ondelete="CASCADE"), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) + ip_address = Column(String, nullable=True) + + # Relationships + blog = relationship("Blog", back_populates="dislikes") + user = relationship("User", back_populates="blog_dislikes") + + +class BlogLike(BaseTableModel): + __tablename__ = "blog_likes" + + blog_id = Column(String, ForeignKey("blogs.id", ondelete="CASCADE"), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) + ip_address = Column(String, nullable=True) + + blog = relationship("Blog", back_populates="likes") + user = relationship("User", back_populates="blog_likes") diff --git a/api/v1/models/blog_dislike.py b/api/v1/models/blog_dislike.py deleted file mode 100644 index 011c978b9..000000000 --- a/api/v1/models/blog_dislike.py +++ /dev/null @@ -1,16 +0,0 @@ -from sqlalchemy import Column, String, DateTime, ForeignKey -from sqlalchemy.sql import func -from sqlalchemy.orm import relationship -from api.v1.models.base_model import BaseTableModel - - -class BlogDislike(BaseTableModel): - __tablename__ = "blog_dislikes" - - blog_id = Column(String, ForeignKey("blogs.id", ondelete="CASCADE"), nullable=False) - user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) - ip_address = Column(String, nullable=True) - - # Relationships - blog = relationship("Blog", back_populates="dislikes") - user = relationship("User", back_populates="blog_dislikes") \ No newline at end of file diff --git a/api/v1/models/blog_like.py b/api/v1/models/blog_like.py deleted file mode 100644 index cf2fa54ac..000000000 --- a/api/v1/models/blog_like.py +++ /dev/null @@ -1,14 +0,0 @@ -from sqlalchemy import Column, String, DateTime, ForeignKey -from sqlalchemy.sql import func -from sqlalchemy.orm import relationship -from api.v1.models.base_model import BaseTableModel - -class BlogLike(BaseTableModel): - __tablename__ = "blog_likes" - - blog_id = Column(String, ForeignKey("blogs.id", ondelete="CASCADE"), nullable=False) - user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) - ip_address = Column(String, nullable=True) - - blog = relationship("Blog", back_populates="likes") - user = relationship("User", back_populates="blog_likes") \ No newline at end of file diff --git a/api/v1/models/comment.py b/api/v1/models/comment.py index 28ca35182..2f4e691df 100644 --- a/api/v1/models/comment.py +++ b/api/v1/models/comment.py @@ -1,13 +1,46 @@ -from sqlalchemy import Column, String, Text, Integer, DateTime, ForeignKey +from sqlalchemy import Column, String, Text, ForeignKey from sqlalchemy.orm import relationship from api.v1.models.base_model import BaseTableModel + class Comment(BaseTableModel): __tablename__ = "comments" - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) - blog_id = Column(String, ForeignKey('blogs.id', ondelete="CASCADE"), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) + blog_id = Column(String, ForeignKey("blogs.id", ondelete="CASCADE"), nullable=False) content = Column(Text, nullable=False) user = relationship("User", back_populates="comments") - blog = relationship("Blog", back_populates="comments") \ No newline at end of file + blog = relationship("Blog", back_populates="comments") + likes = relationship( + "CommentLike", back_populates="comment", cascade="all, delete-orphan" + ) + dislikes = relationship( + "CommentDislike", back_populates="comment", cascade="all, delete-orphan" + ) + + +class CommentLike(BaseTableModel): + __tablename__ = "comment_likes" + + comment_id = Column( + String, ForeignKey("comments.id", ondelete="CASCADE"), nullable=False + ) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) + ip_address = Column(String, nullable=True) + + comment = relationship("Comment", back_populates="likes") + user = relationship("User", back_populates="comment_likes") + + +class CommentDislike(BaseTableModel): + __tablename__ = "comment_dislikes" + + comment_id = Column( + String, ForeignKey("comments.id", ondelete="CASCADE"), nullable=False + ) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) + ip_address = Column(String, nullable=True) + + comment = relationship("Comment", back_populates="dislikes") + user = relationship("User", back_populates="comment_dislikes") diff --git a/api/v1/models/contact_us.py b/api/v1/models/contact_us.py index 87e1f79dd..ea826670a 100644 --- a/api/v1/models/contact_us.py +++ b/api/v1/models/contact_us.py @@ -1,8 +1,9 @@ -# app/models/contact_us.py -from sqlalchemy import Column, String, Text, DateTime +from sqlalchemy import Column, String, Text, ForeignKey from sqlalchemy.sql import func +from sqlalchemy.orm import relationship from api.v1.models.base_model import BaseTableModel + class ContactUs(BaseTableModel): __tablename__ = "contact_us" @@ -10,3 +11,6 @@ class ContactUs(BaseTableModel): email = Column(String, nullable=False) title = Column(String, nullable=False) message = Column(Text, nullable=False) + org_id = Column(String, ForeignKey('organizations.id', ondelete="CASCADE"), nullable=False) + + organization = relationship("Organization", back_populates="contact_us") \ No newline at end of file diff --git a/api/v1/models/data_privacy.py b/api/v1/models/data_privacy.py new file mode 100644 index 000000000..7be7bc8c6 --- /dev/null +++ b/api/v1/models/data_privacy.py @@ -0,0 +1,18 @@ +from sqlalchemy import Column, String, ForeignKey, Boolean +from sqlalchemy.orm import relationship +from api.v1.models.base_model import BaseTableModel + + +class DataPrivacySetting(BaseTableModel): + __tablename__ = "data_privacy_settings" + + profile_visibility = Column(Boolean, server_default='true') + share_data_with_partners = Column(Boolean, server_default='false') + receice_email_updates = Column(Boolean, server_default='true') + enable_two_factor_authentication = Column(Boolean, server_default='false') + use_data_encryption = Column(Boolean, server_default='true') + allow_analytics = Column(Boolean, server_default='true') + personalized_ads = Column(Boolean, server_default='false') + + user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + user = relationship("User", back_populates="data_privacy_setting") diff --git a/api/v1/models/email_template.py b/api/v1/models/email_template.py new file mode 100644 index 000000000..1b0efee5f --- /dev/null +++ b/api/v1/models/email_template.py @@ -0,0 +1,11 @@ +from sqlalchemy import Boolean, Column, Text, String, Enum +from api.v1.models.base_model import BaseTableModel + + +class EmailTemplate(BaseTableModel): + __tablename__ = "email_templates" + + title = Column(Text, nullable=False) + template = Column(Text, nullable=False) + type = Column(String, nullable=False) + template_status = Column(Enum('online', 'offline', name='template_status'), server_default='online') diff --git a/api/v1/models/faq.py b/api/v1/models/faq.py new file mode 100644 index 000000000..d5050e332 --- /dev/null +++ b/api/v1/models/faq.py @@ -0,0 +1,10 @@ +from sqlalchemy import Column, String, Text +from api.v1.models.base_model import BaseTableModel + + +class FAQ(BaseTableModel): + __tablename__ = "faqs" + + question = Column(String, nullable=False) + answer = Column(Text, nullable=False) + category = Column(String, nullable=True) diff --git a/api/v1/models/invitation.py b/api/v1/models/invitation.py index b7a83753c..ac7d2fb77 100644 --- a/api/v1/models/invitation.py +++ b/api/v1/models/invitation.py @@ -1,17 +1,17 @@ -from sqlalchemy import Column, String, Integer, ForeignKey, Table, Boolean, DateTime, func +from sqlalchemy import Column, String, ForeignKey, Boolean, DateTime from sqlalchemy.orm import relationship -from api.v1.models.base import Base from api.v1.models.base_model import BaseTableModel -from uuid_extensions import uuid7 -from sqlalchemy.dialects.postgresql import UUID + class Invitation(BaseTableModel): - __tablename__ = 'invitations' + __tablename__ = "invitations" - user_id = Column(String, ForeignKey('users.id', ondelete='CASCADE'), nullable=False) - organization_id = Column(String, ForeignKey('organizations.id', ondelete='CASCADE'), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) + organization_id = Column( + String, ForeignKey("organizations.id", ondelete="CASCADE"), nullable=False + ) expires_at = Column(DateTime(timezone=True), nullable=False) is_valid = Column(Boolean, default=True) user = relationship("User", back_populates="invitations") - organization = relationship("Organization", back_populates="invitations") \ No newline at end of file + organization = relationship("Organization", back_populates="invitations") diff --git a/api/v1/models/job.py b/api/v1/models/job.py index 61bd50cf4..c2d97ba77 100644 --- a/api/v1/models/job.py +++ b/api/v1/models/job.py @@ -1,29 +1,17 @@ #!/usr/bin/env python3 """ The Job Model Class """ -from sqlalchemy import ( - Column, - Integer, - String, - Text, - Date, - ForeignKey, - Numeric, - DateTime, - func, - ) +from sqlalchemy import Column, String, Text, ForeignKey, Enum from sqlalchemy.orm import relationship -from datetime import datetime -from api.v1.models.base import Base from api.v1.models.base_model import BaseTableModel -from uuid_extensions import uuid7 -from sqlalchemy.dialects.postgresql import UUID class Job(BaseTableModel): - __tablename__ = 'jobs' - - author_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + __tablename__ = "jobs" + + author_id = Column( + String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False + ) title = Column(Text, nullable=False) description = Column(Text, nullable=False) department = Column(String, nullable=True) @@ -33,4 +21,20 @@ class Job(BaseTableModel): company_name = Column(String, nullable=True) author = relationship("User", back_populates="jobs") + applications = relationship('JobApplication', back_populates='job') + + +class JobApplication(BaseTableModel): + __tablename__ = "job_applications" + + job_id = Column( + String, ForeignKey("jobs.id", ondelete="CASCADE"), nullable=False + ) + applicant_name = Column(String, nullable=False) + applicant_email = Column(String, nullable=False) + cover_letter = Column(Text, nullable=True) + resume_link = Column(String, nullable=False) + portfolio_link = Column(String, nullable=True) + application_status = Column(Enum('pending', 'accepted', 'rejected', name='application_status'), default="pending") + job = relationship('Job', back_populates='applications') diff --git a/api/v1/models/message.py b/api/v1/models/message.py index dc174baed..e0c22908f 100644 --- a/api/v1/models/message.py +++ b/api/v1/models/message.py @@ -1,14 +1,15 @@ -# app/models/message.py -from sqlalchemy import Column, String, Text, ForeignKey, DateTime + +from sqlalchemy import Column, String, Text, ForeignKey from sqlalchemy.orm import relationship from sqlalchemy.sql import func from api.v1.models.base_model import BaseTableModel + class Message(BaseTableModel): __tablename__ = "messages" message = Column(Text, nullable=False) phone_number = Column(String, nullable=True) - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) user = relationship("User", back_populates="messages") diff --git a/api/v1/models/newsletter.py b/api/v1/models/newsletter.py index f0c9dac6c..169e79a77 100644 --- a/api/v1/models/newsletter.py +++ b/api/v1/models/newsletter.py @@ -1,20 +1,32 @@ -from sqlalchemy import Column, String, Text -from uuid import uuid4 -from sqlalchemy.orm import relationship -from datetime import datetime -from api.db.database import Base -from api.v1.models.base import user_newsletter_association +from sqlalchemy import Column, String, Text, ForeignKey, UniqueConstraint +from sqlalchemy.orm import Mapped, mapped_column, relationship from api.v1.models.base_model import BaseTableModel class Newsletter(BaseTableModel): - """ - Newsletter db model - """ - __tablename__ = 'newsletters' + __tablename__ = "newsletters" - email = Column(String(150), unique=True, nullable=False) - title = Column(String, nullable=True) - content = Column(Text, nullable=True) + title: Mapped[str] = mapped_column(String(100), nullable=False) + description: Mapped[str | None] = mapped_column(Text, nullable=True) + content: Mapped[str | None] = mapped_column(Text, nullable=True) - subscribers = relationship("User", secondary=user_newsletter_association, back_populates="newsletters") \ No newline at end of file + newsletter_subscribers: Mapped[list["NewsletterSubscriber"]] = relationship( + back_populates="newsletter" + ) + + +class NewsletterSubscriber(BaseTableModel): + __tablename__ = "newsletter_subscribers" + + email: Mapped[str] = mapped_column(String(120), nullable=False) + newsletter_id: Mapped[str] = mapped_column( + ForeignKey("newsletters.id"), nullable=False + ) + + newsletter: Mapped["Newsletter"] = relationship( + back_populates="newsletter_subscribers" + ) + + __table_args__ = ( + UniqueConstraint("email", "newsletter_id", name="uq_subscriber_newsletter"), + ) diff --git a/api/v1/models/notifications.py b/api/v1/models/notifications.py index 58bc6a333..c49573a17 100644 --- a/api/v1/models/notifications.py +++ b/api/v1/models/notifications.py @@ -1,14 +1,31 @@ -from sqlalchemy import Column, String, Text, ForeignKey +from sqlalchemy import Column, String, Text, ForeignKey, Boolean from sqlalchemy.orm import relationship -from sqlalchemy.sql import func from api.v1.models.base_model import BaseTableModel + class Notification(BaseTableModel): __tablename__ = "notifications" - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=True) title = Column(String, nullable=False) message = Column(Text, nullable=False) - status = Column(String, default='unread') # unread, read + status = Column(String, default="unread") # unread, read + + user = relationship("User", back_populates="notifications", primaryjoin="Notification.user_id==User.id", foreign_keys=[user_id]) + + +class NotificationSetting(BaseTableModel): + __tablename__ = "notification_settings" + + mobile_push_notifications = Column(Boolean, server_default='false') + email_notification_activity_in_workspace = Column(Boolean, server_default='false') + email_notification_always_send_email_notifications = Column(Boolean, server_default='true') + email_notification_email_digest = Column(Boolean, server_default='false') + email_notification_announcement_and_update_emails = Column(Boolean, server_default='false') + slack_notifications_activity_on_your_workspace = Column(Boolean, server_default='false') + slack_notifications_always_send_email_notifications = Column(Boolean, server_default='false') + slack_notifications_announcement_and_update_emails = Column(Boolean, server_default='false') + + user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + user = relationship("User", back_populates="notification_setting") - user = relationship("User", back_populates="notifications") \ No newline at end of file diff --git a/api/v1/models/oauth.py b/api/v1/models/oauth.py index 608e3a73b..097e837c3 100644 --- a/api/v1/models/oauth.py +++ b/api/v1/models/oauth.py @@ -1,4 +1,4 @@ -from sqlalchemy import Column, String, ForeignKey, DateTime +from sqlalchemy import Column, String, ForeignKey from sqlalchemy.orm import relationship from api.v1.models.base_model import BaseTableModel @@ -6,10 +6,12 @@ class OAuth(BaseTableModel): __tablename__ = "oauth" - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), unique=True, nullable=False) + user_id = Column( + String, ForeignKey("users.id", ondelete="CASCADE"), unique=True, nullable=False + ) provider = Column(String, nullable=False) sub = Column(String, nullable=False) access_token = Column(String, nullable=False) refresh_token = Column(String, nullable=False) - user = relationship("User", back_populates="oauth") \ No newline at end of file + user = relationship("User", back_populates="oauth") diff --git a/api/v1/models/org.py b/api/v1/models/org.py deleted file mode 100644 index 1ffbf0f99..000000000 --- a/api/v1/models/org.py +++ /dev/null @@ -1,38 +0,0 @@ -#!/usr/bin/env python3 -""" The Organization model -""" -from sqlalchemy import ( - Column, - Integer, - String, - Text, - Date, - ForeignKey, - Numeric, - DateTime, - func, - ) -from sqlalchemy.orm import relationship -from api.v1.models.base import user_organization_association -from api.v1.models.base_model import BaseTableModel -from uuid_extensions import uuid7 - - -class Organization(BaseTableModel): - __tablename__ = 'organizations' - - name = Column(String(50), nullable=False) - description = Column(Text, nullable=True) - - users = relationship( - "User", - secondary=user_organization_association, - back_populates="organizations" - ) - roles = relationship("OrgRole", back_populates="organization", cascade="all, delete-orphan") - billing_plans = relationship("BillingPlan", back_populates="organization", cascade="all, delete-orphan") - invitations = relationship("Invitation", back_populates="organization", cascade="all, delete-orphan") - products = relationship("Product", back_populates="organization", cascade="all, delete-orphan") - - def __str__(self): - return self.name diff --git a/api/v1/models/org_role.py b/api/v1/models/org_role.py deleted file mode 100644 index ae10f41b4..000000000 --- a/api/v1/models/org_role.py +++ /dev/null @@ -1,14 +0,0 @@ -from sqlalchemy import Column, String, Boolean, ForeignKey -from sqlalchemy.orm import relationship -from api.v1.models.base_model import BaseTableModel -from uuid_extensions import uuid7 - -class OrgRole(BaseTableModel): - __tablename__ = "org_roles" - - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) - org_id = Column(String, ForeignKey('organizations.id', ondelete="CASCADE"), nullable=False) - is_admin = Column(Boolean, default=False) - - organization = relationship("Organization", back_populates="roles") - user = relationship("User", back_populates="roles") \ No newline at end of file diff --git a/api/v1/models/organization.py b/api/v1/models/organization.py new file mode 100644 index 000000000..1ba72d052 --- /dev/null +++ b/api/v1/models/organization.py @@ -0,0 +1,43 @@ + +""" The Organization model +""" +from sqlalchemy import Column, String, Text, Enum +from sqlalchemy.orm import relationship +from api.v1.models.associations import user_organization_association +from api.v1.models.base_model import BaseTableModel + + +class Organization(BaseTableModel): + __tablename__ = "organizations" + + name = Column(String, nullable=False, unique=True) + email = Column(String, nullable=True, unique=True) + industry = Column(String, nullable=True) + type = Column(String, nullable=True) + description = Column(String, nullable=True) + country = Column(String, nullable=True) + state = Column(String, nullable=True) + address = Column(String, nullable=True) + + users = relationship( + "User", secondary=user_organization_association, back_populates="organizations" + ) + billing_plans = relationship("BillingPlan", back_populates="organization", cascade="all, delete-orphan") + invitations = relationship("Invitation", back_populates="organization", cascade="all, delete-orphan") + products = relationship("Product", back_populates="organization", cascade="all, delete-orphan") + contact_us = relationship("ContactUs", back_populates="organization", cascade="all, delete-orphan") + + billing_plans = relationship( + "BillingPlan", back_populates="organization", cascade="all, delete-orphan" + ) + invitations = relationship( + "Invitation", back_populates="organization", cascade="all, delete-orphan" + ) + products = relationship( + "Product", back_populates="organization", cascade="all, delete-orphan" + ) + sales = relationship('Sales', back_populates='organization', + cascade='all, delete-orphan') + + def __str__(self): + return self.name diff --git a/api/v1/models/payment.py b/api/v1/models/payment.py index f6e9b7466..5caf335ee 100644 --- a/api/v1/models/payment.py +++ b/api/v1/models/payment.py @@ -1,15 +1,17 @@ -from sqlalchemy import Column, String, Integer, ForeignKey, Numeric, DateTime, Enum +from sqlalchemy import Column, String, ForeignKey, Numeric from sqlalchemy.orm import relationship from api.v1.models.base_model import BaseTableModel + class Payment(BaseTableModel): __tablename__ = "payments" - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) amount = Column(Numeric, nullable=False) currency = Column(String, nullable=False) status = Column(String, nullable=False) # e.g., completed, pending method = Column(String, nullable=False) # e.g., credit card, PayPal transaction_id = Column(String, unique=True, nullable=False) - user = relationship("User", back_populates="payments") \ No newline at end of file + user = relationship("User", back_populates="payments") + sales = relationship("Sales", back_populates="payment") diff --git a/api/v1/models/permissions/__init__.py b/api/v1/models/permissions/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/api/v1/models/permissions/permissions.py b/api/v1/models/permissions/permissions.py new file mode 100644 index 000000000..e773e41df --- /dev/null +++ b/api/v1/models/permissions/permissions.py @@ -0,0 +1,9 @@ +from sqlalchemy import Column, String +from api.v1.models.base_model import BaseTableModel +from uuid_extensions import uuid7 + +class Permission(BaseTableModel): + __tablename__ = 'permissions' + + #id = Column(String, primary_key=True, index=True, default=lambda: str(uuid7())) + name = Column(String, unique=True, nullable=False) diff --git a/api/v1/models/permissions/role.py b/api/v1/models/permissions/role.py new file mode 100644 index 000000000..bd89728f4 --- /dev/null +++ b/api/v1/models/permissions/role.py @@ -0,0 +1,9 @@ +from sqlalchemy import Column, String +from api.v1.models.base_model import BaseTableModel +from uuid_extensions import uuid7 + +class Role(BaseTableModel): + __tablename__ = 'roles' + + id = Column(String, primary_key=True, index=True, default=lambda: str(uuid7())) + name = Column(String, unique=True, nullable=False) diff --git a/api/v1/models/permissions/role_permissions.py b/api/v1/models/permissions/role_permissions.py new file mode 100644 index 000000000..d3a0be5a4 --- /dev/null +++ b/api/v1/models/permissions/role_permissions.py @@ -0,0 +1,8 @@ +from sqlalchemy import Table, Column, ForeignKey, String +from api.v1.models.base_model import BaseTableModel + +role_permissions = Table( + 'role_permissions', BaseTableModel.metadata, + Column('role_id', String, ForeignKey('roles.id', ondelete='CASCADE'), primary_key=True), + Column('permission_id', String, ForeignKey('permissions.id', ondelete='CASCADE'), primary_key=True) +) diff --git a/api/v1/models/permissions/user_org_role.py b/api/v1/models/permissions/user_org_role.py new file mode 100644 index 000000000..43ce920a0 --- /dev/null +++ b/api/v1/models/permissions/user_org_role.py @@ -0,0 +1,10 @@ +from sqlalchemy import Table, Column, ForeignKey, String +from api.v1.models.base_model import BaseTableModel + +user_organization_roles = Table( + 'user_organization_roles', BaseTableModel.metadata, + Column("user_id", String, ForeignKey("users.id", ondelete="CASCADE"), primary_key=True), + Column("organization_id", String, ForeignKey("organizations.id", ondelete="CASCADE"), primary_key=True), + Column('role_id', String, ForeignKey('roles.id', ondelete='CASCADE'), nullable=False), + Column('status', String(20), nullable=False, default="active") +) diff --git a/api/v1/models/privacy.py b/api/v1/models/privacy.py new file mode 100644 index 000000000..ea47c9584 --- /dev/null +++ b/api/v1/models/privacy.py @@ -0,0 +1,9 @@ +from sqlalchemy import Column, Text, Integer +from sqlalchemy.orm import relationship +from api.v1.models.base_model import BaseTableModel + + +class PrivacyPolicy(BaseTableModel): + __tablename__ = "privacy_policies" + + content = Column(Text, nullable=False) \ No newline at end of file diff --git a/api/v1/models/product.py b/api/v1/models/product.py index 0fde2755e..acb15522b 100644 --- a/api/v1/models/product.py +++ b/api/v1/models/product.py @@ -1,23 +1,93 @@ - """ The Product model """ + from sqlalchemy import ( - Column, - String, - Text, - Numeric, - ForeignKey - ) + Column, + String, + Text, + Numeric, + ForeignKey, + Integer, + Enum as SQLAlchemyEnum, + Boolean, + DateTime, + func, +) from api.v1.models.base_model import BaseTableModel from sqlalchemy.orm import relationship +from enum import Enum + +class ProductStatusEnum(Enum): + in_stock = "in_stock" + out_of_stock = "out_of_stock" + low_on_stock = "low_on_stock" + +class ProductFilterStatusEnum(Enum): + active = "active" + draft = "draft" class Product(BaseTableModel): - __tablename__ = 'products' + __tablename__ = "products" name = Column(String, nullable=False) description = Column(Text, nullable=True) price = Column(Numeric, nullable=False) - org_id = Column(String, ForeignKey('organizations.id', ondelete="CASCADE"), nullable=False) + org_id = Column( + String, ForeignKey("organizations.id", ondelete="CASCADE"), nullable=False + ) + category_id = Column( + String, ForeignKey("product_categories.id", ondelete="CASCADE"), nullable=False + ) + quantity = Column(Integer, default=0) + image_url = Column(String, nullable=False) + status = Column( + SQLAlchemyEnum(ProductStatusEnum), default=ProductStatusEnum.in_stock + ) + archived = Column(Boolean, default=False) + filter_status = Column( + SQLAlchemyEnum(ProductFilterStatusEnum), default=ProductFilterStatusEnum.active) + variants = relationship( + "ProductVariant", back_populates="product", cascade="all, delete-orphan" + ) organization = relationship("Organization", back_populates="products") + category = relationship("ProductCategory", back_populates="products") + sales = relationship('Sales', back_populates='product', + cascade='all, delete-orphan') + comments = relationship("ProductComment", back_populates="product", cascade="all, delete-orphan") + + + def __str__(self): + return self.name + + +class ProductVariant(BaseTableModel): + __tablename__ = "product_variants" + + size = Column(String, nullable=False) + stock = Column(Integer, default=1) + price = Column(Numeric) + product_id = Column(String, ForeignKey("products.id", ondelete="CASCADE")) + product = relationship("Product", back_populates="variants") + + +class ProductCategory(BaseTableModel): + __tablename__ = "product_categories" + + name = Column(String, nullable=False, unique=True) + products = relationship("Product", back_populates="category") + + def __str__(self): + return self.name + + +class ProductComment(BaseTableModel): + __tablename__ = "product_comments" + + product_id = Column(String, ForeignKey("products.id", ondelete="CASCADE"), nullable=False) + content = Column(Text, nullable=False) + created_at = Column(DateTime, server_default=func.now()) + updated_at = Column(DateTime, server_default=func.now(), onupdate=func.now()) + + product = relationship("Product", back_populates="comments") \ No newline at end of file diff --git a/api/v1/models/profile.py b/api/v1/models/profile.py index e6cef9ac1..dba95e236 100644 --- a/api/v1/models/profile.py +++ b/api/v1/models/profile.py @@ -1,21 +1,18 @@ """ The Profile model """ -from sqlalchemy import ( - Column, - String, - Text, - ForeignKey, - ) + +from sqlalchemy import Column, String, Text, ForeignKey, DateTime, func from sqlalchemy.orm import relationship -from api.v1.models.base import Base from api.v1.models.base_model import BaseTableModel - class Profile(BaseTableModel): - __tablename__ = 'profiles' + __tablename__ = "profiles" - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), unique=True, nullable=False) + user_id = Column( + String, ForeignKey("users.id", ondelete="CASCADE"), unique=True, nullable=False + ) + username = Column(String, nullable=True) pronouns = Column(String, nullable=True) job_title = Column(String, nullable=True) department = Column(String, nullable=True) @@ -24,6 +21,23 @@ class Profile(BaseTableModel): phone_number = Column(String, nullable=True) avatar_url = Column(String, nullable=True) recovery_email = Column(String, nullable=True) - + created_at = Column(DateTime, default=func.now()) + updated_at = Column(DateTime, default=func.now(), onupdate=func.now()) user = relationship("User", back_populates="profile") + + def to_dict(self): + return { + "id": self.id, + "pronouns": self.pronouns, + "job_title": self.job_title, + "department": self.department, + "social": self.social, + "bio": self.bio, + "phone_number": self.phone_number, + "avatar_url": self.avatar_url, + "recovery_email": self.recovery_email, + "created_at": self.created_at.isoformat(), + "updated_at": self.updated_at.isoformat(), + "user": self.user.to_dict() if self.user else None, + } diff --git a/api/v1/models/regions.py b/api/v1/models/regions.py new file mode 100644 index 000000000..e6d302e08 --- /dev/null +++ b/api/v1/models/regions.py @@ -0,0 +1,13 @@ +from sqlalchemy import Column, String, ForeignKey, Integer +from sqlalchemy.orm import relationship +from api.v1.models.base_model import BaseTableModel + +class Region(BaseTableModel): + __tablename__ = "regions" + + user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + region = Column(String, nullable=False) + language = Column(String, nullable=True) + timezone = Column(String, nullable=True) + + user = relationship("User", back_populates="region") \ No newline at end of file diff --git a/api/v1/models/sales.py b/api/v1/models/sales.py new file mode 100644 index 000000000..c6c899207 --- /dev/null +++ b/api/v1/models/sales.py @@ -0,0 +1,28 @@ +from sqlalchemy import (Column, Integer, Float, + ForeignKey, Index, String) +from sqlalchemy.orm import relationship + +from api.v1.models.base_model import BaseTableModel + + +class Sales(BaseTableModel): + __tablename__ = 'sales' + quantity = Column(Integer, nullable=False) + amount = Column(Float, nullable=False) + product_id = Column(String, ForeignKey('products.id', ondelete='CASCADE'), + nullable=False) + organization_id = Column(String, ForeignKey('organizations.id', ondelete='CASCADE'), + nullable=False) + payment_id = Column(String, ForeignKey('payments.id', ondelete='CASCADE'), + nullable=True) + + + + + product = relationship("Product", back_populates="sales") + organization = relationship("Organization", back_populates="sales") + payment = relationship("Payment", back_populates="sales") + + __table_args__ = ( + Index('idx_sales_created_at', 'created_at'), + ) diff --git a/api/v1/models/squeeze.py b/api/v1/models/squeeze.py new file mode 100644 index 000000000..a6302f286 --- /dev/null +++ b/api/v1/models/squeeze.py @@ -0,0 +1,39 @@ +"""Squeeze page model.""" + +from sqlalchemy import ( + Column, + String, + Text, + ForeignKey, + Enum as SQLAlchemyEnum, +) +from api.v1.models.base_model import BaseTableModel +from sqlalchemy.orm import relationship +from enum import Enum + + +class SqueezeStatusEnum(str, Enum): + online = "online" + offline = "offline" + + +class Squeeze(BaseTableModel): + __tablename__ = "squeezes" + + title = Column(String, nullable=False) + email = Column(String, nullable=False) + user_id = Column(String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False) + url_slug = Column(String, nullable=True) + headline = Column(String, nullable=True) + sub_headline = Column(String, nullable=True) + body = Column(Text, nullable=True) + type = Column(String, nullable=True, default="product") + full_name = Column(String, nullable=True) + + status = Column( + SQLAlchemyEnum(SqueezeStatusEnum), default=SqueezeStatusEnum.offline + ) + user = relationship("User", back_populates="squeeze") + + def __str__(self): + return self.title diff --git a/api/v1/models/team.py b/api/v1/models/team.py new file mode 100644 index 000000000..081e06b86 --- /dev/null +++ b/api/v1/models/team.py @@ -0,0 +1,15 @@ +from sqlalchemy import Column, String, Text +from api.v1.models.base_model import BaseTableModel + + +class TeamMember(BaseTableModel): + __tablename__ = "team_members" + + name = Column(String, nullable=False) + role = Column(String, nullable=False) + description = Column(Text, nullable=False) + picture_url = Column(String, nullable=False) + team_type = Column(String, nullable=True) # e.g Executive team, Development team + facebook_link = Column(String, nullable=True) + instagram_link = Column(String, nullable=True) + xtwitter_link = Column(String, nullable=True) diff --git a/api/v1/models/terms.py b/api/v1/models/terms.py new file mode 100644 index 000000000..724c90158 --- /dev/null +++ b/api/v1/models/terms.py @@ -0,0 +1,9 @@ +from sqlalchemy import Column, String, Text +from api.v1.models.base_model import BaseTableModel + + +class TermsAndConditions(BaseTableModel): + __tablename__ = "terms_and_conditions" + + title = Column(String) + content = Column(Text) \ No newline at end of file diff --git a/api/v1/models/testimonial.py b/api/v1/models/testimonial.py index 26d876083..332e6ca67 100644 --- a/api/v1/models/testimonial.py +++ b/api/v1/models/testimonial.py @@ -1,13 +1,16 @@ -from sqlalchemy import Column, String, ForeignKey, Text, Integer, DateTime, Float +from sqlalchemy import Column, String, ForeignKey, Text, Float from sqlalchemy.orm import relationship from api.v1.models.base_model import BaseTableModel + class Testimonial(BaseTableModel): __tablename__ = "testimonials" client_designation = Column(String, nullable=True) client_name = Column(String, nullable=True) - author_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), nullable=False) + author_id = Column( + String, ForeignKey("users.id", ondelete="CASCADE"), nullable=False + ) comments = Column(Text, nullable=True) content = Column(Text, nullable=False) ratings = Column(Float, nullable=True) diff --git a/api/v1/models/token_login.py b/api/v1/models/token_login.py index 7df63e005..b8042032e 100644 --- a/api/v1/models/token_login.py +++ b/api/v1/models/token_login.py @@ -2,11 +2,14 @@ from sqlalchemy.orm import relationship from api.v1.models.base_model import BaseTableModel + class TokenLogin(BaseTableModel): __tablename__ = "token_logins" - user_id = Column(String, ForeignKey('users.id', ondelete="CASCADE"), unique=True, nullable=False) + user_id = Column( + String, ForeignKey("users.id", ondelete="CASCADE"), unique=True, nullable=False + ) token = Column(String, nullable=False) expiry_time = Column(DateTime, nullable=False) - user = relationship("User", back_populates="token_login") \ No newline at end of file + user = relationship("User", back_populates="token_login") diff --git a/api/v1/models/topic.py b/api/v1/models/topic.py new file mode 100644 index 000000000..43dd8f97d --- /dev/null +++ b/api/v1/models/topic.py @@ -0,0 +1,11 @@ +from sqlalchemy import Column, String, ForeignKey, Text, Float, ARRAY +from sqlalchemy.orm import relationship +from api.v1.models.base_model import BaseTableModel + + +class Topic(BaseTableModel): + __tablename__ = 'topics' + + title = Column(String, nullable=False) + content = Column(String, nullable=False) + tags = Column(ARRAY(String), nullable=True) diff --git a/api/v1/models/user.py b/api/v1/models/user.py index f85b3dbb8..229a2dd68 100644 --- a/api/v1/models/user.py +++ b/api/v1/models/user.py @@ -1,63 +1,93 @@ """ User data model """ -from sqlalchemy import ( - create_engine, - Column, - Integer, - String, - Text, - text, - Date, - ForeignKey, - Numeric, - DateTime, - func, - Table, - Boolean - ) + +from sqlalchemy import Column, String, text, Boolean from sqlalchemy.orm import relationship -from datetime import datetime -from api.v1.models.base import Base, user_organization_association, user_newsletter_association +from api.v1.models.associations import user_organization_association from api.v1.models.base_model import BaseTableModel - class User(BaseTableModel): - __tablename__ = 'users' + __tablename__ = "users" - username = Column(String, unique=True, nullable=False) email = Column(String, unique=True, nullable=False) password = Column(String, nullable=True) first_name = Column(String, nullable=True) last_name = Column(String, nullable=True) - is_active = Column(Boolean, server_default=text("false")) + avatar_url = Column(String, nullable=True) + is_active = Column(Boolean, server_default=text("true")) is_super_admin = Column(Boolean, server_default=text("false")) is_deleted = Column(Boolean, server_default=text("false")) is_verified = Column(Boolean, server_default=text("false")) - profile = relationship("Profile", uselist=False, back_populates="user", cascade="all, delete-orphan") - organizations = relationship("Organization", secondary=user_organization_association, back_populates="users") - roles = relationship("OrgRole", back_populates="user", cascade="all, delete-orphan") - notifications = relationship("Notification", back_populates="user", cascade="all, delete-orphan") - activity_logs = relationship("ActivityLog", back_populates="user", cascade="all, delete-orphan") + profile = relationship( + "Profile", uselist=False, back_populates="user", cascade="all, delete-orphan" + ) + organizations = relationship( + "Organization", secondary=user_organization_association, back_populates="users" + ) + notifications = relationship( + "Notification", back_populates="user", cascade="all, delete-orphan" + ) + activity_logs = relationship( + "ActivityLog", back_populates="user", cascade="all, delete-orphan" + ) jobs = relationship("Job", back_populates="author", cascade="all, delete-orphan") - token_login = relationship("TokenLogin", back_populates="user", uselist=False, cascade="all, delete-orphan") - oauth = relationship("OAuth", back_populates="user", uselist=False, cascade="all, delete-orphan") - testimonials = relationship("Testimonial", back_populates="author", cascade="all, delete-orphan") - payments = relationship("Payment", back_populates="user", cascade="all, delete-orphan") - blogs = relationship("Blog", back_populates="author", cascade="all, delete-orphan") - comments = relationship("Comment", back_populates="user", cascade="all, delete-orphan") - invitations = relationship("Invitation", back_populates="user", cascade="all, delete-orphan") - messages = relationship("Message", back_populates="user", cascade="all, delete-orphan") - newsletters = relationship("Newsletter", secondary=user_newsletter_association, back_populates="subscribers") - blog_likes = relationship("BlogLike", back_populates="user", cascade="all, delete-orphan") - blog_dislikes = relationship("BlogDislike", back_populates="user", cascade="all, delete-orphan") - + token_login = relationship( + "TokenLogin", back_populates="user", uselist=False, cascade="all, delete-orphan" + ) + oauth = relationship( + "OAuth", back_populates="user", uselist=False, cascade="all, delete-orphan" + ) + testimonials = relationship( + "Testimonial", back_populates="author", cascade="all, delete-orphan" + ) + payments = relationship( + "Payment", back_populates="user", cascade="all, delete-orphan" + ) + blogs = relationship("Blog", back_populates="author", cascade="all, delete-orphan") + comments = relationship( + "Comment", back_populates="user", cascade="all, delete-orphan" + ) + invitations = relationship( + "Invitation", back_populates="user", cascade="all, delete-orphan" + ) + messages = relationship( + "Message", back_populates="user", cascade="all, delete-orphan" + ) + blog_likes = relationship( + "BlogLike", back_populates="user", cascade="all, delete-orphan" + ) + blog_dislikes = relationship( + "BlogDislike", back_populates="user", cascade="all, delete-orphan" + ) + comment_likes = relationship( + "CommentLike", back_populates="user", cascade="all, delete-orphan" + ) + comment_dislikes = relationship( + "CommentDislike", back_populates="user", cascade="all, delete-orphan" + ) + notification_setting = relationship( + "NotificationSetting", + back_populates="user", + cascade="all, delete-orphan", + uselist=False, + ) + region = relationship("Region", back_populates="user", cascade="all, delete-orphan") + squeeze = relationship( + "Squeeze", back_populates="user", cascade="all, delete-orphan" + ) + data_privacy_setting = relationship( + "DataPrivacySetting", + uselist=False, + back_populates="user", + cascade="all, delete-orphan", + ) + def to_dict(self): obj_dict = super().to_dict() obj_dict.pop("password") return obj_dict - def __str__(self): - return self.email \ No newline at end of file + return self.email diff --git a/api/v1/models/waitlist.py b/api/v1/models/waitlist.py index 3d2396562..605317bb5 100644 --- a/api/v1/models/waitlist.py +++ b/api/v1/models/waitlist.py @@ -2,9 +2,10 @@ from sqlalchemy.sql import func from api.v1.models.base_model import BaseTableModel + class Waitlist(BaseTableModel): __tablename__ = "waitlist" email = Column(String, nullable=False) full_name = Column(String, nullable=False) - joined_at = Column(DateTime(timezone=True), server_default=func.now()) \ No newline at end of file + joined_at = Column(DateTime(timezone=True), server_default=func.now()) diff --git a/api/v1/routes/__init__.py b/api/v1/routes/__init__.py index c6ac996f0..b80df28ac 100644 --- a/api/v1/routes/__init__.py +++ b/api/v1/routes/__init__.py @@ -1,34 +1,88 @@ -from fastapi import APIRouter -from api.v1.routes.auth import auth -from api.v1.routes.newsletter import newsletter -from api.v1.routes.user import user -from api.v1.routes.superadmin import superadmin -from api.v1.routes.product import product -from api.v1.routes.notification import notification -from api.v1.routes.testimonial import testimonial -from api.v1.routes.facebook_login import fb_auth -from api.v1.routes.blog import blog -from api.v1.routes.waitlist import waitlist as waitlist_router -from api.v1.routes.billing_plan import bill_plan -from api.v1.routes.google_login import google_auth -from api.v1.routes.notifications import notifications -from api.v1.routes.invitations import invites -from api.v1.routes.profiles import profile - -api_version_one = APIRouter(prefix="/api/v1") - -api_version_one.include_router(auth) -api_version_one.include_router(newsletter) -api_version_one.include_router(user) -api_version_one.include_router(superadmin) -api_version_one.include_router(notifications) -api_version_one.include_router(product) -api_version_one.include_router(notification) -api_version_one.include_router(testimonial) -api_version_one.include_router(fb_auth) -api_version_one.include_router(blog) -api_version_one.include_router(waitlist_router) -api_version_one.include_router(bill_plan) -api_version_one.include_router(google_auth) -api_version_one.include_router(invites) -api_version_one.include_router(profile) \ No newline at end of file +from api.v1.routes.settings import settings +from api.v1.routes.privacy import privacies +from api.v1.routes.team import team +from fastapi import APIRouter +from api.v1.routes.auth import auth +from api.v1.routes.newsletter import newsletter +from api.v1.routes.user import user +from api.v1.routes.product import product +from api.v1.routes.notification import notification +from api.v1.routes.testimonial import testimonial +from api.v1.routes.facebook_login import fb_auth +from api.v1.routes.blog import blog +from api.v1.routes.waitlist import waitlist as waitlist_router +from api.v1.routes.billing_plan import bill_plan +from api.v1.routes.google_login import google_auth +from api.v1.routes.invitations import invites +from api.v1.routes.profiles import profile +from api.v1.routes.jobs import jobs +from api.v1.routes.payment import payment +from api.v1.routes.organization import organization +from api.v1.routes.request_password import pwd_reset +from api.v1.routes.activity_logs import activity_logs +from api.v1.routes.contact_us import contact_us +from api.v1.routes.comment import comment +from api.v1.routes.sms_twilio import sms +from api.v1.routes.faq import faq +import api.v1.routes.payment_flutterwave +from tests.run_all_test import test_rout +from api.v1.routes.topic import topic +from api.v1.routes.notification_settings import notification_setting +from api.v1.routes.regions import regions +from api.v1.routes.api_tests import test_router +from api.v1.routes.email_routes import email_sender +from api.v1.routes.squeeze import squeeze +from api.v1.routes.dashboard import dashboard +from api.v1.routes.email_template import email_template +from api.v1.routes.contact import contact +from api.v1.routes.permissions.permisions import perm_role +from api.v1.routes.permissions.roles import role_perm +from api.v1.routes.analytics import analytics +from api.v1.routes.job_application import job_application +from api.v1.routes.privacy import privacies +from api.v1.routes.settings import settings +from api.v1.routes.terms_and_conditions import terms_and_conditions + +api_version_one = APIRouter(prefix="/api/v1") + +api_version_one.include_router(auth) +api_version_one.include_router(google_auth) +api_version_one.include_router(fb_auth) +api_version_one.include_router(pwd_reset) +api_version_one.include_router(user) +api_version_one.include_router(profile) +api_version_one.include_router(organization) +api_version_one.include_router(product) +api_version_one.include_router(payment) +api_version_one.include_router(bill_plan) +api_version_one.include_router(notification) +api_version_one.include_router(notification_setting) +api_version_one.include_router(email_template) +api_version_one.include_router(invites) +api_version_one.include_router(activity_logs) +api_version_one.include_router(blog) +api_version_one.include_router(comment) +api_version_one.include_router(sms) +api_version_one.include_router(jobs) +api_version_one.include_router(test_router) +api_version_one.include_router(faq) +api_version_one.include_router(topic) +api_version_one.include_router(contact_us) +api_version_one.include_router(waitlist_router) +api_version_one.include_router(newsletter) +api_version_one.include_router(testimonial) +api_version_one.include_router(test_rout) +api_version_one.include_router(email_sender) +api_version_one.include_router(regions) +api_version_one.include_router(test_router) +api_version_one.include_router(squeeze) +api_version_one.include_router(contact) +api_version_one.include_router(dashboard) +api_version_one.include_router(perm_role) +api_version_one.include_router(role_perm) +api_version_one.include_router(analytics) +api_version_one.include_router(job_application) +api_version_one.include_router(privacies) +api_version_one.include_router(settings) +api_version_one.include_router(team) +api_version_one.include_router(terms_and_conditions) diff --git a/api/v1/routes/activity_logs.py b/api/v1/routes/activity_logs.py new file mode 100644 index 000000000..51017efa5 --- /dev/null +++ b/api/v1/routes/activity_logs.py @@ -0,0 +1,87 @@ +from fastapi import APIRouter, Depends, status, HTTPException +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session +from api.v1.models.user import User +from api.v1.schemas.activity_logs import ActivityLogCreate, ActivityLogResponse +from api.v1.services.activity_logs import activity_log_service +from api.v1.services.user import user_service +from api.db.database import get_db +from api.utils.success_response import success_response + +activity_logs = APIRouter(prefix="/activity-logs", tags=["Activity Logs"]) + + +@activity_logs.post("/create", status_code=status.HTTP_201_CREATED) +async def create_activity_log( + activity_log: ActivityLogCreate, db: Session = Depends(get_db) +): + """Create a new activity log""" + + new_activity_log = activity_log_service.create_activity_log( + db=db, + user_id=activity_log.user_id, + action=activity_log.action + ) + + return success_response( + status_code=201, + message="Activity log created successfully", + data=jsonable_encoder(new_activity_log) + ) + + +@activity_logs.get("", response_model=list[ActivityLogResponse]) +async def get_all_activity_logs(current_user: User = Depends(user_service.get_current_super_admin), db: Session = Depends(get_db)): + '''Get all activity logs''' + + activity_logs = activity_log_service.fetch_all(db=db) + + return success_response( + status_code=200, + message="Activity logs retrieved successfully", + data=jsonable_encoder(activity_logs) + ) + +@activity_logs.get("/{user_id}", status_code=status.HTTP_200_OK) +async def fetch_all_users_activity_log( + user_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin) +): + """ + Get endpoint for admin users get a users activity logs. + + Args: + user_id (str): the id of user + current_user: the admin user + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + + + activity_logs = activity_log_service.fetch_all( + db=db, + user_id=user_id + ) + + return success_response( + status_code=status.HTTP_200_OK, + message="Activity logs fetched successfully!", + data=jsonable_encoder(activity_logs) + ) + +@activity_logs.delete("/{log_id}", status_code=status.HTTP_204_NO_CONTENT) +async def delete_activity_log( + log_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin) +): + """Endpoint to delete an activity log by its ID""" + + activity_log_service.delete_activity_log_by_id(db, log_id) + return success_response( + status_code=status.HTTP_200_OK, + message=f"Activity log with ID {log_id} deleted successfully" + ) diff --git a/api/v1/routes/analytics.py b/api/v1/routes/analytics.py new file mode 100644 index 000000000..583fa69e1 --- /dev/null +++ b/api/v1/routes/analytics.py @@ -0,0 +1,56 @@ +from fastapi import status, Depends, APIRouter +from typing import Annotated +from sqlalchemy.orm import Session +from fastapi.security import OAuth2 +from datetime import datetime, timedelta +from api.db.database import get_db +from api.v1.services.user import oauth2_scheme +from api.v1.services.analytics import analytics_service, AnalyticsServices + +analytics = APIRouter(prefix='/analytics') + + +def get_current_month_date_range(): + now = datetime.utcnow() + start_date = datetime(now.year, now.month, 1) + end_date = (start_date + timedelta(days=32) + ).replace(day=1) - timedelta(seconds=1) + return start_date, end_date + + +@analytics.get('/line-chart-data', status_code=status.HTTP_200_OK) +async def get_analytics_line_chart_data(token: Annotated[OAuth2, Depends(oauth2_scheme)], + db: Annotated[Session, Depends(get_db)]): + """ + Retrieves analytics line-chart-data for an organization or super admin. + Args: + token: access_token + db: database Session object + Retunrs: + analytics response: contains the analytics data + """ + return analytics_service.get_analytics_line_chart(token, db) + + +@analytics.get('/summary', status_code=status.HTTP_200_OK) +async def get_analytics_summary( + token: Annotated[str, Depends(oauth2_scheme)], + db: Annotated[Session, Depends(get_db)], + analytics_service: Annotated[AnalyticsServices, Depends()], + start_date: datetime = None, + end_date: datetime = None +): + + """ + Retrieves analytics summary data for an organization or super admin. + Args: + token: access_token + db: database Session object + start_date: start date for filtering + end_date: end date for filtering + Returns: + analytics response: contains the analytics summary data + """ + if not start_date or not end_date: + start_date, end_date = get_current_month_date_range() + return analytics_service.get_analytics_summary(token=token, db=db, start_date=start_date, end_date=end_date) diff --git a/api/v1/routes/api_tests.py b/api/v1/routes/api_tests.py new file mode 100644 index 000000000..39c8e864f --- /dev/null +++ b/api/v1/routes/api_tests.py @@ -0,0 +1,26 @@ +import io +import sys +from fastapi import Depends, status, APIRouter, Response, Request +from fastapi.responses import JSONResponse +from api.v1.services.api_tests import PythonAPIs +from unittest import TestLoader, TextTestRunner, TestCase + +test_router = APIRouter(prefix="/hng-test", tags=["Tests"]) + +@test_router.get("") +async def run_tests(): + loader = TestLoader() + suite = loader.loadTestsFromTestCase(PythonAPIs) + stream = io.StringIO() + runner = TextTestRunner(stream=stream, verbosity=2) + result = runner.run(suite) + stream.seek(0) + results = stream.read() + response = { + "total_tests": result.testsRun, + "failures": len(result.failures), + "errors": len(result.errors), + "skipped": len(result.skipped), + "test_results": results, + } + return JSONResponse(content=response) diff --git a/api/v1/routes/auth.py b/api/v1/routes/auth.py index c4a2f9742..bad721ba0 100644 --- a/api/v1/routes/auth.py +++ b/api/v1/routes/auth.py @@ -1,53 +1,77 @@ -from fastapi import Depends, status, APIRouter, Response, Request -from fastapi.security import OAuth2PasswordRequestForm -from sqlalchemy.orm import Session, relationship +from datetime import timedelta +from fastapi import BackgroundTasks, Depends, status, APIRouter, Response, Request +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session + +from api.core.dependencies.email_sender import send_email from api.utils.success_response import success_response +from api.utils.send_mail import send_magic_link from api.v1.models import User -from typing_extensions import Annotated -from datetime import datetime, timedelta - -from api.v1.schemas.user import UserCreate -from api.v1.schemas.token import TokenRequest, EmailRequest -from typing import Annotated -from datetime import datetime, timedelta - -from api.v1.schemas.user import UserCreate -from api.v1.schemas.token import EmailRequest, TokenRequest -from api.utils.email_service import send_mail +from api.v1.schemas.user import Token +from api.v1.schemas.user import LoginRequest, UserCreate, EmailRequest +from api.v1.schemas.token import TokenRequest +from api.v1.schemas.user import UserCreate, MagicLinkRequest +from api.v1.services.organization import organization_service +from api.v1.schemas.organization import CreateUpdateOrganization from api.db.database import get_db from api.v1.services.user import user_service +from api.v1.services.auth import AuthService auth = APIRouter(prefix="/auth", tags=["Authentication"]) -@auth.post("/login", status_code=status.HTTP_200_OK) -def login(login_request: OAuth2PasswordRequestForm = Depends(), db: Session = Depends(get_db)): - '''Endpoint to log in a user''' + +@auth.post("/register", status_code=status.HTTP_201_CREATED, response_model=success_response) +def register(background_tasks: BackgroundTasks, response: Response, user_schema: UserCreate, db: Session = Depends(get_db)): + '''Endpoint for a user to register their account''' - # Authenticate the user - user = user_service.authenticate_user( - db=db, - username=login_request.username, - password=login_request.password - ) + # Create user account + user = user_service.create(db=db, schema=user_schema) - # Generate access and refresh tokens + # create an organization for the user + org = CreateUpdateOrganization(name=f"{user.first_name}'s Organization", + email=user.email) + user_org = organization_service.create(db=db, schema=org, user=user) + + # Create access and refresh tokens access_token = user_service.create_access_token(user_id=user.id) refresh_token = user_service.create_refresh_token(user_id=user.id) + # Send email in the background + background_tasks.add_task( + send_email, + recipient=user.email, + template_name='welcome.html', + subject='Welcome to HNG Boilerplate', + context={ + 'first_name': user.first_name, + 'last_name': user.last_name + } + ) + response = success_response( - status_code=200, - message='Login successful', + status_code=201, + message="User created successfully", data={ - 'access_token': access_token, - 'token_type': 'bearer', - } + "access_token": access_token, + "token_type": "bearer", + "user": jsonable_encoder( + user, + exclude=[ + "password", + "is_super_admin", + "is_deleted", + "is_verified", + "updated_at", + ], + ), + }, ) # Add refresh token to cookies response.set_cookie( key="refresh_token", value=refresh_token, - expires=timedelta(days=30), + expires=timedelta(days=60), httponly=True, secure=True, samesite="none", @@ -56,13 +80,11 @@ def login(login_request: OAuth2PasswordRequestForm = Depends(), db: Session = De return response - -@auth.post("/register", status_code=status.HTTP_201_CREATED) -def register(response: Response, user_schema: UserCreate, db: Session = Depends(get_db)): - '''Endpoint for a user to register their account''' +@auth.post(path="/register-super-admin", status_code=status.HTTP_201_CREATED) +def register_as_super_admin(user: UserCreate, db: Session = Depends(get_db)): + """Endpoint for super admin creation""" - # Create user account - user = user_service.create(db=db, schema=user_schema) + user = user_service.create_admin(db=db, schema=user) # Create access and refresh tokens access_token = user_service.create_access_token(user_id=user.id) @@ -70,11 +92,18 @@ def register(response: Response, user_schema: UserCreate, db: Session = Depends( response = success_response( status_code=201, - message='User created successfully', + message="User Created Successfully", data={ 'access_token': access_token, 'token_type': 'bearer', - 'user': user.to_dict() + 'user': { + **jsonable_encoder( + user, + exclude=['password', 'is_super_admin', 'is_deleted', 'is_verified', 'updated_at'] + ), + 'access_token': access_token, + 'token_type': 'bearer', + } } ) @@ -91,38 +120,86 @@ def register(response: Response, user_schema: UserCreate, db: Session = Depends( return response -@auth.post("/logout", status_code=status.HTTP_200_OK) -def logout(response: Response, db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user)): - '''Endpoint to log a user out of their account''' +@auth.post("/login", status_code=status.HTTP_200_OK, response_model=success_response) +def login(background_tasks: BackgroundTasks, login_request: LoginRequest, db: Session = Depends(get_db)): + """Endpoint to log in a user""" + + # Authenticate the user + user = user_service.authenticate_user( + db=db, email=login_request.email, password=login_request.password + ) + + # Generate access and refresh tokens + access_token = user_service.create_access_token(user_id=user.id) + refresh_token = user_service.create_refresh_token(user_id=user.id) response = success_response( status_code=200, - message='User logged put successfully' + message='Login successful', + data={ + 'access_token': access_token, + 'token_type': 'bearer', + 'user': { + **jsonable_encoder( + user, + exclude=['password', 'is_super_admin', 'is_deleted', 'is_verified', 'updated_at'] + ), + 'access_token': access_token, + 'token_type': 'bearer', + } + } + ) + + # Add refresh token to cookies + response.set_cookie( + key="refresh_token", + value=refresh_token, + expires=timedelta(days=30), + httponly=True, + secure=True, + samesite="none", ) + return response + + +@auth.post("/logout", status_code=status.HTTP_200_OK) +def logout( + response: Response, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to log a user out of their account""" + + response = success_response(status_code=200, message="User logged put successfully") + # Delete refresh token from cookies - response.delete_cookie(key='refresh_token') + response.delete_cookie(key="refresh_token") return response @auth.post("/refresh-access-token", status_code=status.HTTP_200_OK) -def refresh_access_token(request: Request, response: Response, db: Session = Depends(get_db)): - '''Endpoint to log a user out of their account''' +def refresh_access_token( + request: Request, response: Response, db: Session = Depends(get_db) +): + """Endpoint to log a user out of their account""" # Get refresh token - current_refresh_token = request.cookies.get('refresh_token') + current_refresh_token = request.cookies.get("refresh_token") # Create new access and refresh tokens - access_token, refresh_token = user_service.refresh_access_token(current_refresh_token=current_refresh_token) + access_token, refresh_token = user_service.refresh_access_token( + current_refresh_token=current_refresh_token + ) response = success_response( status_code=200, - message='Tokens refreshed cuccessfully', + message="Tokens refreshed successfully", data={ - 'access_token': access_token, - 'token_type': 'bearer', - } + "access_token": access_token, + "token_type": "bearer", + }, ) # Add refresh token to cookies @@ -137,9 +214,12 @@ def refresh_access_token(request: Request, response: Response, db: Session = Dep return response + @auth.post("/request-token", status_code=status.HTTP_200_OK) -async def request_signin_token(email_schema: EmailRequest, db: Session = Depends(get_db)): - '''Generate and send a 6-digit sign-in token to the user's email''' +async def request_signin_token( + email_schema: EmailRequest, db: Session = Depends(get_db) +): + """Generate and send a 6-digit sign-in token to the user's email""" user = user_service.fetch_by_email(db, email_schema.email) @@ -148,36 +228,91 @@ async def request_signin_token(email_schema: EmailRequest, db: Session = Depends # Save the token and expiry user_service.save_login_token(db, user, token, token_expiry) - # Send the token to the user's email - # send_mail(to=user.email, subject="Your SignIn Token", body=token) + # Send mail notification return success_response( - status_code=200, - message="Sign-in token sent to email" + status_code=200, message=f"Sign-in token sent to {user.email}" ) + @auth.post("/verify-token", status_code=status.HTTP_200_OK) -async def verify_signin_token(token_schema: TokenRequest, db: Session = Depends(get_db)): - '''Verify the 6-digit sign-in token and log in the user''' +async def verify_signin_token( + token_schema: TokenRequest, db: Session = Depends(get_db) +): + """Verify the 6-digit sign-in token and log in the user""" user = user_service.verify_login_token(db, schema=token_schema) # Generate JWT token access_token = user_service.create_access_token(user_id=user.id) + refresh_token = user_service.create_refresh_token(user_id=user.id) - return success_response( + response = success_response( status_code=200, - message="Sign-in successful", + message="Sign in successful", data={ "access_token": access_token, - "token_type": "bearer" + "token_type": "bearer", + }, + ) + + # Add refresh token to cookies + response.set_cookie( + key="refresh_token", + value=refresh_token, + expires=timedelta(days=30), + httponly=True, + secure=True, + samesite="none", + ) + + return response + + +# Verify Magic Link +@auth.post("/verify-magic-link") +async def verify_magic_link(token_schema: Token, db: Session = Depends(get_db)): + user, access_token = AuthService.verify_magic_token(token_schema.access_token, db) + + refresh_token = user_service.create_refresh_token(user_id=user.id) + + response = success_response( + status_code=200, + message='Login successful', + data={ + 'access_token': access_token, + 'token_type': 'bearer', + 'user': jsonable_encoder( + user, + exclude=['password', 'is_super_admin', 'is_deleted', 'is_verified', 'updated_at'] + ), } ) + + # Add refresh token to cookies + response.set_cookie( + key="refresh_token", + value=refresh_token, + expires=timedelta(days=30), + httponly=True, + secure=True, + samesite="none", + ) + + return response + -# Protected route example: test route -@auth.get("/admin") -def read_admin_data(current_admin: Annotated[User, Depends(user_service.get_current_super_admin)]): - return {"message": "Hello, admin!"} +@auth.post("/request-magic-link", status_code=status.HTTP_200_OK) +def request_magic_link( + request: MagicLinkRequest, response: Response, db: Session = Depends(get_db) +): + user = user_service.fetch_by_email(db=db, email=request.email) + access_token = user_service.create_access_token(user_id=user.id) + send_magic_link(user.email, access_token) + response = success_response( + status_code=200, message=f"Magic link sent to {user.email}" + ) + return response diff --git a/api/v1/routes/billing_plan.py b/api/v1/routes/billing_plan.py index 10ce8d33e..7374ab075 100644 --- a/api/v1/routes/billing_plan.py +++ b/api/v1/routes/billing_plan.py @@ -2,35 +2,52 @@ APIRouter, Depends, status, - ) +) +from fastapi.encoders import jsonable_encoder from sqlalchemy.orm import Session +from api.utils.success_response import success_response from api.v1.models.user import User from api.v1.services.billing_plan import billing_plan_service from api.db.database import get_db -from api.utils.json_response import JsonResponseDict from api.v1.services.user import user_service +from api.v1.schemas.plans import CreateSubscriptionPlan bill_plan = APIRouter(prefix='/organizations', tags=['Billing-Plan']) -@bill_plan.get('/billing-plans') +@bill_plan.get('/{organization_id}/billing-plans', response_model=success_response) async def retrieve_all_billing_plans( - current_user: User = Depends(user_service.get_current_user), - db: Session = Depends(get_db)): + organization_id: str, + db: Session = Depends(get_db) +): """ - Get All Billing Plan endpoint + Endpoint to get all billing plans """ - billing_plans: list = [ { - "id": billing_plan.id, - "name": billing_plan.name, - "price": float(billing_plan.price), - "features": billing_plan.features, - } for billing_plan in billing_plan_service.fetch_all(db=db)] - - return JsonResponseDict( + + plans = billing_plan_service.fetch_all(db=db, organization_id=organization_id) + + return success_response( status_code=status.HTTP_200_OK, + message="Plans fetched successfully", data={ - "plans": billing_plans - }, - message="plans fetched successfully" - + "plans": jsonable_encoder(plans), + }, + ) + + +@bill_plan.post("/billing-plans", response_model=success_response) +async def create_new_billing_plan( + request: CreateSubscriptionPlan, + current_user: User = Depends(user_service.get_current_super_admin), + db: Session = Depends(get_db), +): + """ + Endpoint to create new billing plan + """ + + plan = billing_plan_service.create(db=db, request=request) + + return success_response( + status_code=status.HTTP_200_OK, + message="Plans created successfully", + data=jsonable_encoder(plan), ) diff --git a/api/v1/routes/blog.py b/api/v1/routes/blog.py index 10198f798..19fb906e0 100644 --- a/api/v1/routes/blog.py +++ b/api/v1/routes/blog.py @@ -1,40 +1,61 @@ -from typing import List - -from fastapi import APIRouter, Depends, HTTPException, status +from fastapi import ( + APIRouter, Depends, HTTPException, status, + HTTPException, Response, Request +) from fastapi.encoders import jsonable_encoder -from fastapi.responses import JSONResponse from sqlalchemy.orm import Session +from typing import Annotated from api.db.database import get_db -from api.utils.dependencies import get_current_user, get_super_admin -from api.v1.models.blog import Blog +from api.utils.pagination import paginated_response +from api.utils.success_response import success_response from api.v1.models.user import User -from api.v1.schemas.blog import (BlogCreate, BlogPostResponse, BlogRequest, - BlogResponse, BlogUpdateResponseModel) +from api.v1.models.blog import Blog, BlogDislike, BlogLike +from api.v1.schemas.blog import ( + BlogCreate, + BlogPostResponse, + BlogRequest, + BlogUpdateResponseModel, + BlogLikeDislikeResponse +) from api.v1.services.blog import BlogService +from api.v1.services.user import user_service +from api.v1.schemas.comment import CommentCreate, CommentSuccessResponse +from api.v1.services.comment import comment_service +from api.v1.services.comment import CommentService +from api.utils.client_helpers import get_ip_address blog = APIRouter(prefix="/blogs", tags=["Blog"]) -@blog.post("/api/v1/blogs") -def create_blog(blog: BlogCreate, db: Session = Depends(get_db), current_user: User = Depends(get_super_admin)): + +@blog.post("/", response_model=success_response) +def create_blog( + blog: BlogCreate, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): if not current_user: raise HTTPException(status_code=401, detail="You are not Authorized") blog_service = BlogService(db) new_blogpost = blog_service.create(db=db, schema=blog, author_id=current_user.id) - return { - "message": "Post Created Successfully!", - "status_code": 200, - "data": new_blogpost -} + return success_response( + message="Blog created successfully!", + status_code=200, + data=jsonable_encoder(new_blogpost), + ) -@blog.get("/", response_model=List[BlogResponse]) -def get_all_blogs(db: Session = Depends(get_db)): - blogs = db.query(Blog).filter(Blog.is_deleted == False).all() - if not blogs: - return [] - return blogs +@blog.get("/", response_model=success_response) +def get_all_blogs(db: Session = Depends(get_db), limit: int = 10, skip: int = 0): + """Endpoint to get all blogs""" + + return paginated_response( + db=db, + model=Blog, + limit=limit, + skip=skip, + ) @blog.get("/{id}", response_model=BlogPostResponse) @@ -55,58 +76,188 @@ def get_blog_by_id(id: str, db: Session = Depends(get_db)): blog_service = BlogService(db) blog_post = blog_service.fetch(id) - if not blog_post: - return JSONResponse( - status_code=status.HTTP_404_NOT_FOUND, - content={ - "success": False, - "status_code": status.HTTP_404_NOT_FOUND, - "message": "Post not Found" - } - ) - return JSONResponse( - status_code=status.HTTP_200_OK, - content={ - "success": True, - "status_code": status.HTTP_200_OK, - "message": "Blog post retrieved successfully", - "data": jsonable_encoder(blog_post) - } + return success_response( + message="Blog post retrieved successfully!", + status_code=200, + data=jsonable_encoder(blog_post), ) @blog.put("/{id}", response_model=BlogUpdateResponseModel) -async def update_blog(id: str, blogPost: BlogRequest, db: Session = Depends(get_db), current_user: User = Depends(get_current_user)): +async def update_blog( + id: str, + blogPost: BlogRequest, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to update a blog post""" + blog_service = BlogService(db) - try: - updated_blog_post = blog_service.update( - blog_id=id, - title=blogPost.title, - content=blogPost.content, - current_user=current_user + updated_blog_post = blog_service.update( + blog_id=id, + title=blogPost.title, + content=blogPost.content, + current_user=current_user, + ) + + return success_response( + message="Blog post updated successfully", + status_code=200, + data=jsonable_encoder(updated_blog_post), + ) + + +@blog.post("/{blog_id}/like", response_model=BlogLikeDislikeResponse) +def like_blog_post( + blog_id: str, + request: Request, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + + blog_service = BlogService(db) + + # GET blog post + blog_p = blog_service.fetch(blog_id) + if not isinstance(blog_p, Blog): + raise HTTPException( + detail="Post not found", status_code=status.HTTP_404_NOT_FOUND ) - except HTTPException as e: - raise e - except Exception as e: + + # CONFIRM current user has NOT liked before + existing_like = blog_service.fetch_blog_like(blog_p.id, current_user.id) + if isinstance(existing_like, BlogLike): raise HTTPException( - status_code=500, detail="An unexpected error occurred") + detail="You have already liked this blog post", + status_code=status.HTTP_403_FORBIDDEN, + ) - return { - "status": "200", - "message": "Blog post updated successfully", - "data": {"post": jsonable_encoder(updated_blog_post)} - } + # UPDATE likes + blog_service.create_blog_like( + db, blog_p.id, current_user.id, ip_address=get_ip_address(request)) -@blog.delete("/{id}") -async def delete_blog_post(id: str, db: Session = Depends(get_db), current_user: User = Depends(get_super_admin)): - blog_service = BlogService(db=db) - if not current_user: - return {"status_code":403, "message":"Unauthorized User"} - post = blog_service.fetch_post(blog_id=id) + # CONFIRM new like + new_like = blog_service.fetch_blog_like(blog_p.id, current_user.id) + if not isinstance(new_like, BlogLike): + raise HTTPException( + detail="Unable to record like.", status_code=status.HTTP_400_BAD_REQUEST + ) - if not post: - return {"message": "Blog with the given ID does not exist", "status_code": 404} - + # Return success response + return success_response( + status_code=status.HTTP_200_OK, + message="Like recorded successfully.", + data=new_like.to_dict(), + ) + + +@blog.put("/{blog_id}/dislike", response_model=BlogLikeDislikeResponse) +def dislike_blog_post( + blog_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + + blog_service = BlogService(db) + + # GET blog post + blog_p = blog_service.fetch(blog_id) + if not isinstance(blog_p, Blog): + raise HTTPException( + detail="Post not found", status_code=status.HTTP_404_NOT_FOUND + ) + + # CONFIRM current user has NOT disliked before + existing_dislike = blog_service.fetch_blog_dislike(blog_p.id, current_user.id) + if isinstance(existing_dislike, BlogDislike): + raise HTTPException( + detail="You have already disliked this blog post", + status_code=status.HTTP_403_FORBIDDEN, + ) + + # UPDATE disikes + new_dislike = blog_service.create_blog_dislike(db, blog_p.id, current_user.id) + + if not isinstance(new_dislike, BlogDislike): + raise HTTPException( + detail="Unable to record dislike.", status_code=status.HTTP_400_BAD_REQUEST + ) + + # Return success response + return success_response( + status_code=status.HTTP_200_OK, + message="Dislike recorded successfully.", + data=new_dislike.to_dict(), + ) + + +@blog.delete("/{id}", status_code=204) +async def delete_blog_post( + id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to delete a blog post""" + + blog_service = BlogService(db=db) blog_service.delete(blog_id=id) - return {"message": "Blog post deleted successfully", "status_code": 200} + + +# Post a comment to a blog +@blog.post("/{blog_id}/comments", response_model=CommentSuccessResponse) +async def add_comment_to_blog( + blog_id: str, + current_user: Annotated[User, Depends(user_service.get_current_user)], + comment: CommentCreate, + db: Annotated[Session, Depends(get_db)], +) -> Response: + """Post endpoint for authenticated users to add comments to a blog. + + Args: + blog_id (str): the id of the blog to be commented on + current_user: the current authenticated user + comment (CommentCreate): the body of the request + db: the database session object + + Returns: + Response: a response object containing the comment details if successful or appropriate errors if not + """ + + user_id = current_user.id + new_comment = comment_service.create( + db=db, schema=comment, user_id=user_id, blog_id=blog_id + ) + + return success_response( + message="Comment added successfully!", + status_code=201, + data=jsonable_encoder(new_comment), + ) + + +@blog.get("/{blog_id}/comments") +async def comments( + db: Annotated[Session, Depends(get_db)], + blog_id: str, + page: int = 1, + per_page: int = 20, +) -> object: + """ + Retrieves all comments associated with a blog + + Args: + db: Database Session object + blog_id: the blog associated with the comments + page: the number of the current page + per_page: the page size for a current page + Returns: + Response: An exception if error occurs + object: Response object containing the comments + """ + comment_services = CommentService() + comments_response = comment_services.validate_params(blog_id, page, per_page, db) + if comments_response == 'Blog not found': + raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, + detail="Blog not found") + return comments_response \ No newline at end of file diff --git a/api/v1/routes/comment.py b/api/v1/routes/comment.py new file mode 100644 index 000000000..1382275af --- /dev/null +++ b/api/v1/routes/comment.py @@ -0,0 +1,141 @@ +from typing import Annotated +from fastapi import APIRouter, Depends, HTTPException, status, Response, Request, Header +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session +from api.db.database import get_db +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.services.comment_like import comment_like_service +from api.v1.services.user import user_service +from api.v1.schemas.comment import ( + DislikeSuccessResponse, + CommentDislike, + LikeSuccessResponse, +) +from api.v1.services.comment_dislike import comment_dislike_service +from api.v1.services.comment import comment_service +from api.utils.json_response import JsonResponseDict +from uuid import UUID + +comment = APIRouter(prefix="/comments", tags=["Comment"]) + + +@comment.post("/{comment_id}/like", response_model=LikeSuccessResponse) +async def like_comment( + comment_id: str, + request: Request, + x_forwarded_for: str = Header(None), + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +) -> Response: + """ + Description + Post endpoint for authenticated users to like a comment. + + Args: + request: the request object + comment_id (str): the id of the comment to like + current_user: the current authenticated user + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + user_ip = ( + x_forwarded_for.split(",")[0].strip() + if x_forwarded_for + else request.client.host + ) + like = comment_like_service.create( + db=db, comment_id=comment_id, user_id=current_user.id, client_ip=user_ip + ) + return success_response( + message="Comment liked successfully!", + status_code=201, + data=jsonable_encoder(like), + ) + +@comment.post("/{comment_id}/dislike", response_model=DislikeSuccessResponse) +async def dislike_comment( + request: Request, + comment_id: str, + current_user: Annotated[User, Depends(user_service.get_current_user)], + db: Annotated[Session, Depends(get_db)], +) -> Response: + """Post endpoint for authenticated users to dislike a comment. + + Args: + request: the request object + comment_id (str): the id of the comment to dislike + current_user: the current authenticated user + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + + user_id = current_user.id + + client_ip = request.headers.get("X-Forwarded-For") + if client_ip is None or client_ip == "": + client_ip = request.client.host + + dislike = comment_dislike_service.create( + db=db, user_id=user_id, comment_id=comment_id, client_ip=client_ip + ) + + return success_response( + message="Comment disliked successfully!", + status_code=201, + data=jsonable_encoder(dislike), + ) + +@comment.delete("/{comment_id}", response_model=None) +async def delete_comment( + comment_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +) -> JsonResponseDict: + try: + # Validate comment_id as a UUID + try: + comment_uuid = UUID(comment_id) + except ValueError: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, + detail="An invalid request was sent." + ) + + # Fetch the comment + comment = comment_service.fetch(db=db, id=str(comment_uuid)) + + if not comment: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Comment does not exist" + ) + + # Check if the current user is the owner of the comment + if comment.user_id != current_user.id: + raise HTTPException( + status_code=status.HTTP_403_FORBIDDEN, + detail="Unauthorized access." + ) + + # Perform the deletion + comment_service.delete(db=db, id=str(comment_uuid)) + return JsonResponseDict( + message="Comment deleted successfully.", + status_code=status.HTTP_200_OK + ) + except HTTPException as e: + return JsonResponseDict( + message=e.detail, + status_code=e.status_code + ) + except Exception as e: + return JsonResponseDict( + message="Internal server error.", + error=str(e), + status_code=status.HTTP_500_INTERNAL_SERVER_ERROR + ) diff --git a/api/v1/routes/contact.py b/api/v1/routes/contact.py new file mode 100644 index 000000000..0b35f4f4f --- /dev/null +++ b/api/v1/routes/contact.py @@ -0,0 +1,38 @@ +from fastapi import APIRouter, status, Header, Depends +from api.v1.schemas.contact import AdminGet200Response, AdminGet200Data +from typing import Optional +from api.utils.dependencies import get_super_admin +from sqlalchemy.orm import Session +from api.db.database import get_db +from api.v1.services.contact import ContactMessage +from api.v1.services.user import user_service +from api.v1.models.user import User + +contact = APIRouter(prefix="/contact", tags=['contact']) + + +@contact.get('/{id}', response_model=AdminGet200Response, status_code=status.HTTP_200_OK) +def get_contact( + id: str, + current_admin: User = Depends(user_service.get_current_super_admin), + db: Session = Depends(get_db), +): + + contact_message = ContactMessage() + + message = contact_message.fetch_message(db, id) + + contact_message.check_admin_access(db, current_admin.id, message.org_id) + + if not message: + contact_message.raise_not_found() + + response_data = AdminGet200Data(full_name=message.full_name, + email=message.email, + title=message.title, + message=message.message + ) + + response_body = AdminGet200Response(data=response_data.__dict__) + + return response_body diff --git a/api/v1/routes/contact_us.py b/api/v1/routes/contact_us.py new file mode 100644 index 000000000..f9312b861 --- /dev/null +++ b/api/v1/routes/contact_us.py @@ -0,0 +1,67 @@ +from fastapi import APIRouter, Depends, status +from sqlalchemy.orm import Session +from api.db.database import get_db +from typing import Annotated +from api.core.responses import SUCCESS +from api.utils.success_response import success_response +from api.v1.services.contact_us import contact_us_service +from api.v1.schemas.contact_us import CreateContactUs +from api.v1.schemas.contact_us import ContactUsResponseSchema +from fastapi.encoders import jsonable_encoder +from api.v1.services.user import user_service +from api.v1.models import * + +contact_us = APIRouter(prefix="/contact", tags=["Contact-Us"]) + + +# CREATE +@contact_us.post( + "", + response_model=success_response, + status_code=status.HTTP_201_CREATED, + responses={ + 201: {"description": "Contact us message created successfully"}, + 422: {"description": "Validation Error"}, + }, +) +async def create_contact_us( + data: CreateContactUs, db: Annotated[Session, Depends(get_db)] +): + """Add a new contact us message.""" + new_contact_us_message = contact_us_service.create(db, data) + response = success_response( + message=SUCCESS, + data={"id": new_contact_us_message.id}, + status_code=status.HTTP_201_CREATED, + ) + return response + + +@contact_us.get( + "", + response_model=success_response, + status_code=200, + responses={ + 403: {"description": "Unauthorized"}, + 500: {"description": "Server Error"}, + }, +) +def retrieve_contact_us( + db: Session = Depends(get_db), + admin: User = Depends(user_service.get_current_super_admin), +): + """ + Retrieve all contact-us submissions from database + """ + + all_submissions = contact_us_service.fetch_all(db) + submissions_filtered = list( + map(lambda x: ContactUsResponseSchema.model_validate(x), all_submissions) + ) + if len(submissions_filtered) == 0: + submissions_filtered = [{}] + return success_response( + message="Submissions retrieved successfully", + status_code=200, + data=jsonable_encoder(submissions_filtered), + ) diff --git a/api/v1/routes/dashboard.py b/api/v1/routes/dashboard.py new file mode 100644 index 000000000..728e6d558 --- /dev/null +++ b/api/v1/routes/dashboard.py @@ -0,0 +1,82 @@ +from fastapi import APIRouter, Depends +from api.db.database import get_db +from sqlalchemy.orm import Session + +from api.v1.models.user import User +from api.v1.services.user import user_service +from api.v1.services.product import product_service +from api.utils.success_response import success_response +from api.v1.schemas.dashboard import ( + DashboardProductCountResponse, + DashboardSingleProductResponse, + DashboardProductListResponse +) + + +dashboard = APIRouter(prefix="/dashboard", tags=['Dashboard']) + + +@dashboard.get("/products/count", response_model=DashboardProductCountResponse) +async def get_products_count( + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin) +): + products = product_service.fetch_all(db) + + return success_response( + status_code=200, + message="Products count fetched successfully", + data={"count": len(products)} + ) + + +@dashboard.get("/products", response_model=DashboardProductListResponse) +async def get_products( + current_user: User = Depends(user_service.get_current_super_admin), + db: Session = Depends(get_db) +): + products = product_service.fetch_all(db) + + payment_data = [ + { + "name": prod.name, + "description": prod.description, + "price": str(prod.price), + "category": prod.category.name, + "quantity": prod.quantity, + "image_url": prod.image_url, + "archived": prod.archived, + "created_at": prod.created_at.isoformat(), + } + for prod in products + ] + + return success_response( + status_code=200, + message="Products fetched successfully", + data=payment_data + ) + + +@dashboard.get("/products/{product_id}", response_model=DashboardSingleProductResponse) +async def get_product( + product_id: str, + current_user: User = Depends(user_service.get_current_super_admin), + db: Session = Depends(get_db) +): + prod = product_service.fetch(db, product_id) + + return success_response( + status_code=200, + message="Product fetched successfully", + data={ + "name": prod.name, + "description": prod.description, + "price": str(prod.price), + "category": prod.category.name, + "quantity": prod.quantity, + "image_url": prod.image_url, + "archived": prod.archived, + "created_at": prod.created_at.isoformat(), + } + ) \ No newline at end of file diff --git a/api/v1/routes/email_routes.py b/api/v1/routes/email_routes.py new file mode 100644 index 000000000..3e760c868 --- /dev/null +++ b/api/v1/routes/email_routes.py @@ -0,0 +1,17 @@ +from api.v1.services.email_services import email_service +from api.v1.schemas.email_schema import EmailRequest +from fastapi import APIRouter, BackgroundTasks + +email_sender = APIRouter(prefix='/mails', tags=["Email Template Management"]) + +@email_sender.post("/send-email") +async def send_email(request: EmailRequest, background_tasks: BackgroundTasks): + '''Endpoint to send an email in the background''' + + return await email_service.send_email( + background_tasks, + request.to_email, + request.subject, + request.body, + request.from_name + ) diff --git a/api/v1/routes/email_template.py b/api/v1/routes/email_template.py new file mode 100644 index 000000000..35346da26 --- /dev/null +++ b/api/v1/routes/email_template.py @@ -0,0 +1,94 @@ +from fastapi import APIRouter, Depends, status +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session + +from api.db.database import get_db +from api.utils.pagination import paginated_response +from api.utils.success_response import success_response +from api.v1.models.email_template import EmailTemplate +from api.v1.models.user import User +from api.v1.services.user import user_service +from api.v1.services.email_template import email_template_service +from api.v1.schemas.email_template import EmailTemplateSchema + +email_template = APIRouter(prefix="/email-templates", tags=["Email Template Management"]) + + +@email_template.get("", response_model=success_response, status_code=200) +async def get_all_email_templates( + db: Session = Depends(get_db), + limit: int = 10, + skip: int = 0, + current_user: User = Depends(user_service.get_current_super_admin) +): + """Endpoint to get all email templates""" + + return paginated_response( + db=db, + model=EmailTemplate, + limit=limit, + skip=skip, + ) + + +@email_template.post("", response_model=success_response, status_code=201) +async def create_email_template( + schema: EmailTemplateSchema, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to create a new email template. Only accessible to superadmins""" + + template = email_template_service.create(db, schema=schema) + + return success_response( + data=jsonable_encoder(template), + message="Successfully created email template", + status_code=status.HTTP_201_CREATED, + ) + + +@email_template.get("/{template_id}", response_model=success_response, status_code=200) +async def get_single_template( + template_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to get a single template""" + + template = email_template_service.fetch(db, template_id=template_id) + + return success_response( + data=jsonable_encoder(template), + message="Successfully fetched email template", + status_code=status.HTTP_200_OK, + ) + + +@email_template.patch("/{template_id}", response_model=success_response, status_code=200) +async def update_template( + template_id: str, + schema: EmailTemplateSchema, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to update a single template""" + + template = email_template_service.update(db, template_id=template_id, schema=schema) + + return success_response( + data=jsonable_encoder(template), + message="Successfully updated template", + status_code=status.HTTP_200_OK, + ) + + +@email_template.delete("/{template_id}", status_code=204) +async def delete_email_template( + template_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to delete a single template""" + + email_template_service.delete(db, template_id=template_id) diff --git a/api/v1/routes/facebook_login.py b/api/v1/routes/facebook_login.py index c25576478..33fc828fe 100644 --- a/api/v1/routes/facebook_login.py +++ b/api/v1/routes/facebook_login.py @@ -2,7 +2,6 @@ from sqlalchemy.orm import Session from api.db.database import get_db from typing import Annotated -from uuid_extensions import uuid7 from api.core.responses import INVALID_CREDENTIALS, COULD_NOT_VALIDATE_CRED from api.utils.json_response import JsonResponseDict from api.v1.services.facebook import fb_user_service diff --git a/api/v1/routes/faq.py b/api/v1/routes/faq.py new file mode 100644 index 000000000..724c07b52 --- /dev/null +++ b/api/v1/routes/faq.py @@ -0,0 +1,101 @@ +from fastapi import APIRouter, Depends, status +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session + +from api.db.database import get_db +from api.utils.pagination import paginated_response +from api.utils.success_response import success_response +from api.v1.models.faq import FAQ +from api.v1.models.user import User +from api.v1.services.user import user_service +from api.v1.services.faq import faq_service +from api.v1.schemas.faq import CreateFAQ, UpdateFAQ + +faq = APIRouter(prefix="/faqs", tags=["Frequently Asked Questions"]) + + +@faq.get("", response_model=success_response, status_code=200) +async def get_all_faqs( + db: Session = Depends(get_db), + # limit: int = 10, + # skip: int = 0, +): + """Endpoint to get all FAQs""" + + faqs = faq_service.fetch_all(db=db) + + return success_response( + status_code=200, + message="FAQs retrieved successfully", + data=jsonable_encoder(faqs), + ) + + # return paginated_response( + # db=db, + # model=FAQ, + # limit=limit, + # skip=skip, + # ) + + +@faq.post("", response_model=success_response, status_code=201) +async def create_faq( + schema: CreateFAQ, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to create a new FAQ. Only accessible to superadmins""" + + faq = faq_service.create(db, schema=schema) + + return success_response( + data=jsonable_encoder(faq), + message="Successfully created FAQ", + status_code=status.HTTP_201_CREATED, + ) + + +@faq.get("/{id}", response_model=success_response, status_code=200) +async def get_single_faq(id: str, db: Session = Depends(get_db)): + """Endpoint to get a single FAQ""" + + faq = faq_service.fetch(db, faq_id=id) + return success_response( + data=jsonable_encoder(faq), + message="Successfully fetched FAQ", + status_code=status.HTTP_200_OK, + ) + + +@faq.patch("/{id}", response_model=success_response, status_code=200) +async def update_faq( + id: str, + schema: UpdateFAQ, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to update an FAQ. Only accessible to superadmins""" + + faq = faq_service.update(db, faq_id=id, schema=schema) + + return success_response( + data=jsonable_encoder(faq), + message="Successfully created FAQ", + status_code=status.HTTP_200_OK, + ) + + +@faq.delete("/{id}", status_code=200) +async def delete_faq( + id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to delete an FAQ. Only accessible to superadmins""" + + faq_service.delete(db, faq_id=id) + + return success_response( + message="Successfully deleted FAQ", + status_code=200, + ) diff --git a/api/v1/routes/google_login.py b/api/v1/routes/google_login.py index 62618a2e8..816afea89 100644 --- a/api/v1/routes/google_login.py +++ b/api/v1/routes/google_login.py @@ -1,43 +1,73 @@ -from fastapi import (Depends, status, APIRouter, - Response, Request, HTTPException) +from fastapi import Depends, APIRouter, status, HTTPException, Response, Request from sqlalchemy.orm import Session from typing import Annotated from starlette.responses import RedirectResponse from authlib.integrations.base_client import OAuthError from authlib.oauth2.rfc6749 import OAuth2Token import secrets +from decouple import config from api.db.database import get_db from api.core.dependencies.google_oauth_config import google_oauth from api.v1.services.google_oauth import GoogleOauthServices +from api.utils.success_response import success_response +from api.v1.schemas.google_oauth import OAuthToken +from api.v1.services.user import user_service +from fastapi.encoders import jsonable_encoder +import requests +from datetime import timedelta google_auth = APIRouter(prefix="/auth", tags=["Authentication"]) +FRONTEND_URL = config("FRONTEND_URL") -@google_auth.get("/google-login") -async def google_oauth2(request: Request) -> RedirectResponse: - """ - Allows users to login using their google accounts. +@google_auth.post("/google") +async def google_login(token_request: OAuthToken, db: Session = Depends(get_db)): + access_token = token_request.id_token + profile_endpoint = 'https://www.googleapis.com/oauth2/v1/userinfo' + headers = {'Authorization': f'Bearer {access_token}'} + + profile_response = requests.get(profile_endpoint, headers=headers) + + if profile_response.status_code != 200: + raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Invalid token or failed to fetch user info") - Args: - request: request object - Returns: - RedirectResponse: A redirect to google authorization server for authorization - """ - redirect_uri = request.url_for('google_oauth2_callback') - # generate a state value and stre it in the session - state = secrets.token_urlsafe(16) - request.session['state'] = state - response = await google_oauth.google.authorize_redirect(request, - redirect_uri, - state=state) + profile_data = profile_response.json() + user = GoogleOauthServices.create_oauth_user(db=db, google_response=profile_data) + + access_token = user_service.create_access_token(user_id=user.id) + refresh_token = user_service.create_refresh_token(user_id=user.id) + + response = success_response( + status_code=200, + message='success', + data={ + 'access_token': access_token, + 'token_type': 'bearer', + 'user': jsonable_encoder( + user, + exclude=['password', 'is_super_admin', 'is_deleted', 'is_verified', 'updated_at'] + ), + } + ) + + response.set_cookie( + key="refresh_token", + value=refresh_token, + expires=timedelta(days=60), + httponly=True, + secure=True, + samesite="none", + ) + return response -@google_auth.get('/callback/google') -async def google_oauth2_callback(request: Request, - db: Annotated[Session, Depends(get_db)]) -> Response: +@google_auth.get("/callback/google") +async def google_oauth2_callback( + request: Request, db: Annotated[Session, Depends(get_db)] +) -> Response: """ Handles request from google after user has authenticated or fails to authenticate with google account. @@ -50,34 +80,73 @@ async def google_oauth2_callback(request: Request, response: contains message, status code, tokens, and user data on success or HttpException if not authenticated, """ + + err_message: str = 'Authentication Failed' try: - state_in_session = request.session.get('state') - state_from_params = request.query_params.get('state') - # verify the state value tomprevent CSRF - if state_from_params != state_in_session: - raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, - detail="CSRF Warning! State not equal in request and response.") + # For testing purposes + if config("TESTING") != "TEST": + state_in_session = request.session.get("state") + state_from_params = request.query_params.get("state") + # verify the state value to prevent CSRF + if state_from_params != state_in_session: + return RedirectResponse( + url=f"{FRONTEND_URL}?error=true&message{err_message}", + status_code=status.HTTP_302_FOUND, + ) + # get the user access token and information from google authorization/resource server - google_response: OAuth2Token = await google_oauth.google.authorize_access_token(request) + google_response: OAuth2Token = await google_oauth.google.authorize_access_token( + request + ) # check if id_token is present - if 'id_token' not in google_response: - raise HTTPException(status_code=400, detail="Authentication Failed") + if "id_token" not in google_response: + RedirectResponse( + url=f"{FRONTEND_URL}?error=true&message{err_message}", + status_code=status.HTTP_302_FOUND, + ) - except OAuthError as exc: - raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, - detail="Authentication Failed") + except OAuthError: + RedirectResponse( + url=f"{FRONTEND_URL}?error=true&message{err_message}", + status_code=status.HTTP_302_FOUND, + ) try: if not google_response.get("access_token"): - raise HTTPException(status_code=400, detail="Authentication Failed") + RedirectResponse( + url=f"{FRONTEND_URL}?error=true&message{err_message}", + status_code=status.HTTP_302_FOUND, + ) # if google has not verified the user email - if not google_response.get('userinfo').get('email_verified'): - raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, - detail="Authentication Failed") - google_oauth_serivce = GoogleOauthServices() - return google_oauth_serivce.create(google_response, db) - except Exception as exc: - raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, - detail="Authentication Failed") \ No newline at end of file + if not google_response.get("userinfo").get("email_verified"): + RedirectResponse( + url=f"{FRONTEND_URL}?error=true&message{err_message}", + status_code=status.HTTP_302_FOUND, + ) + + google_oauth_service = GoogleOauthServices() + + tokens: object = google_oauth_service.create(google_response, db) + + if not tokens: + RedirectResponse( + url=f"{FRONTEND_URL}?error=true&message{err_message}", + status_code=status.HTTP_302_FOUND, + ) + + response = RedirectResponse( + url=f"{FRONTEND_URL}/dashboard/products", status_code=status.HTTP_302_FOUND + ) + + access_token = tokens.access_token + + refresh_token = tokens.refresh_token + + response.set_cookie(key="access_token", value=access_token) + + response.set_cookie(key="refresh_token", value=refresh_token) + return response + except Exception: + return RedirectResponse(url=FRONTEND_URL, status_code=status.HTTP_302_FOUND) diff --git a/api/v1/routes/invitations.py b/api/v1/routes/invitations.py index 9f280070c..686b7d236 100644 --- a/api/v1/routes/invitations.py +++ b/api/v1/routes/invitations.py @@ -1,31 +1,41 @@ -from fastapi import APIRouter, Depends, HTTPException, Request +from fastapi import APIRouter, Depends, HTTPException, Request, status from sqlalchemy.orm import Session -from urllib.parse import urlencode, urlparse, parse_qs -from datetime import datetime, timedelta +from urllib.parse import urlparse, parse_qs from api.v1.schemas import invitations from api.db.database import get_db as get_session from api.v1.services import invite from api.v1.models.user import User +from api.utils.success_response import success_response from api.v1.services.user import user_service import logging -invites = APIRouter(prefix='/invite', tags=["Invitation Management"]) +invites = APIRouter(prefix="/invite", tags=["Invitation Management"]) # Add other necessary imports -# Helper route for generating invitation link pending when the actual endpoint will be ready +# generate invitation link to join organization @invites.post("/create", tags=["Invitation Management"]) -async def generate_invite_link(invite_schema: invitations.InvitationCreate, request: Request, session: Session = Depends(get_session)): +async def generate_invite_link( + invite_schema: invitations.InvitationCreate, + request: Request, + session: Session = Depends(get_session), + current_user: User = Depends(user_service.get_current_user) +): return invite.InviteService.create(invite_schema, request, session) # Add user to organization @invites.post("/accept", tags=["Invitation Management"]) -async def add_user_to_organization(request: Request, user_data: invitations.UserAddToOrganization, session: Session = Depends(get_session), current_user: User = Depends(user_service.get_current_user)): +async def add_user_to_organization( + request: Request, + user_data: invitations.UserAddToOrganization, + session: Session = Depends(get_session), + current_user: User = Depends(user_service.get_current_user) +): logging.info("Received request to accept invitation.") query_params = parse_qs(urlparse(user_data.invitation_link).query) - invite_id = query_params.get('invitation_id', [None])[0] + invite_id = query_params.get("invitation_id", [None])[0] if not invite_id: logging.warning("Invitation ID not found in the link.") @@ -34,3 +44,17 @@ async def add_user_to_organization(request: Request, user_data: invitations.User logging.info(f"Processing invitation ID: {invite_id}") return invite.InviteService.add_user_to_organization(invite_id, session) + +@invites.delete("/{invite_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_invite( + invite_id: str, + db: Session = Depends(get_session), + admin: User = Depends(user_service.get_current_super_admin) +): + """ Delete invite from database """ + invite_is_deleted = invite.InviteService.delete(db, invite_id) + + if not invite_is_deleted: + raise HTTPException(status_code=404, detail="Invalid invitation id") + + logging.info(f"Deleted invite. ID: {invite_id}") \ No newline at end of file diff --git a/api/v1/routes/job_application.py b/api/v1/routes/job_application.py new file mode 100644 index 000000000..7bf8c511d --- /dev/null +++ b/api/v1/routes/job_application.py @@ -0,0 +1,33 @@ +""" +job_application routes +""" +from fastapi import Depends, APIRouter, status +from sqlalchemy.orm import Session +from typing import Annotated + +from api.db.database import get_db +from api.v1.services.user import user_service +from api.v1.models import User +from api.v1.services.job_application import job_application_service + +job_application = APIRouter(prefix='/jobs/{job_id}/applications', tags=['Job Applications']) + + +@job_application.get('/{application_id}', status_code=status.HTTP_200_OK) +async def get_single_application(job_id: str, + application_id: str, + db: Annotated[Session, Depends(get_db)], + current_user : Annotated[User , Depends(user_service.get_current_super_admin)]): + """ + Retrieves a single application. + + + Args: + job_id: The id of the job for the applicant + application_id: The id of the application for the job + db: database Session object + current_user: the super admin user + Returns: + SingleJobAppResponse: response on success + """ + return job_application_service.fetch(job_id, application_id, db) diff --git a/api/v1/routes/jobs.py b/api/v1/routes/jobs.py new file mode 100644 index 000000000..837c63ca5 --- /dev/null +++ b/api/v1/routes/jobs.py @@ -0,0 +1,243 @@ +#!/usr/bin/env python3 + +from api.utils.success_response import success_response +from api.v1.schemas.jobs import PostJobSchema, AddJobSchema, JobCreateResponseSchema, UpdateJobSchema +from fastapi.exceptions import HTTPException +from fastapi.encoders import jsonable_encoder +from typing import Annotated +from fastapi import APIRouter, HTTPException, Depends, status, Query + +from api.v1.services.user import user_service +from sqlalchemy.orm import Session +from api.utils.logger import logger +from api.db.database import get_db +from api.v1.models.user import User +from api.v1.models.job import Job, JobApplication +from api.v1.services.jobs import job_service +from api.v1.services.job_application import job_application_service, UpdateJobApplication +from api.utils.pagination import paginated_response +from api.utils.db_validators import check_model_existence +import uuid +from api.v1.schemas.job_application import CreateJobApplication, UpdateJobApplication, JobApplicationResponse + + +jobs = APIRouter(prefix="/jobs", tags=["Jobs"]) + + +@jobs.post( + "", + response_model=success_response, + status_code=201, + +) +async def add_jobs( + job: PostJobSchema, + db: Session = Depends(get_db), + admin: User = Depends(user_service.get_current_super_admin), +): + """ + Add a job listing to the database. + This endpoint allows an admin to post a job listing to the database. + + Parameters: + - job: PostJobSchema + The details of the job listing. + - admin: User (Depends on get_current_super_admin) + The current admin posting the job request. This is a dependency that provides the admin context. + - db: The database session + """ + if job.title.strip() == "" or job.description.strip() == "": + raise HTTPException(status_code=400, detail="Invalid request data") + + job_full = AddJobSchema(author_id=admin.id, **job.model_dump()) + new_job = job_service.create(db, job_full) + logger.info(f"Job Listing created successfully {new_job.id}") + + return success_response( + message="Job listing created successfully", + status_code=201, + data=jsonable_encoder(JobCreateResponseSchema.model_validate(new_job)) + ) + + +@jobs.get("/{job_id}", response_model=success_response) +async def get_job( + job_id: str, + db: Session = Depends(get_db) +): + """ + Retrieve job details by ID. + This endpoint fetches the details of a specific job by its ID. + + Parameters: + - job_id: str + The ID of the job to retrieve. + - db: The database session + """ + job = job_service.fetch(db, job_id) + + return success_response( + message="Retrieved Job successfully", + status_code=200, + data=jsonable_encoder(job) + ) + + +@jobs.get("") +async def fetch_all_jobs( + db: Session = Depends(get_db), + page_size: int = 10, + page: int = 0, +): + """ + Description + Get endpoint for unauthenticated users to retrieve all jobs. + + Args: + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + return paginated_response( + db=db, + model=Job, + limit=page_size, + skip=max(page, 0), + ) + + +@jobs.delete( + "/{job_id}", + response_model=success_response, + status_code=200, + +) +async def delete_job_by_id( + job_id: str, + db: Session = Depends(get_db), + admin: User = Depends(user_service.get_current_super_admin), +): + """ + Delete a job record by id + """ + job_service.delete(db, job_id) + + return success_response( + message="Job listing deleted successfully", + status_code=200, + ) + + +@jobs.patch("/{id}") +async def update_job( + id: str, + schema: UpdateJobSchema, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + '''This endpoint is to update a job listing by its id''' + + job = job_service.update(db, id=id, schema=schema) + + return success_response( + data=jsonable_encoder(job), + message="Successfully updated a job listing", + status_code=status.HTTP_200_OK, + ) + + +# -------------------- JOB APPLICATION ROUTES ------------------------ +# -------------------------------------------------------------------- + +@jobs.post("/{job_id}/applications", response_model=success_response) +async def apply_to_job( + job_id: str, + application: CreateJobApplication, + db: Session = Depends(get_db) +): + '''Endpoint to apply for a job''' + + job_application = job_application_service.create( + db=db, schema=application, job_id=job_id) + + return success_response( + status_code=201, + message="Job application submitted successfully", + data=jsonable_encoder(job_application) + ) + + +@jobs.patch("/{job_id}/applications/{application_id}") +async def create_application( + job_id: str, + application_id: str, + update_data: UpdateJobApplication, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """ + Description + Get endpoint for admin users to update a job application. + + Args: + db: the database session object + job_id: the ID of the Job + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + + check_model_existence(db, Job, job_id) + check_model_existence(db, JobApplication, application_id) + updated_application = job_application_service.update( + db, application_id=application_id, job_id=job_id, schema=update_data) + return success_response( + status_code=status.HTTP_200_OK, + message="Job Application updated successfully!", + data=jsonable_encoder(updated_application) + ) + +# Fetch all applications (superadmin) +@jobs.get("/{job_id}/applications", response_model=JobApplicationResponse, status_code=status.HTTP_200_OK,) +async def fetch_all_job_applications( + job_id: str, + db: Annotated[Session, Depends(get_db)], + current_user: Annotated[User, Depends(user_service.get_current_super_admin)], + per_page: Annotated[int, Query(ge=1, description="Number of applications per page")] = 10, + page: Annotated[int, Query(ge=1, description="Page number (starts from 1)")] = 1, +): + """Superadmin endpoint to fetch all applications for a job + + Args: + - job_id (str): The Job ID + - db (Annotated[Session, Depends): the database session + - current_user: The current authenticated super admin + - per_page: Number of customers per page (default: 10, minimum: 1) + - page: Page number (starts from 1) + + Returns: + obj: paginated list of applications for the Job ID + + Raises: + - HTTPException: 403 FORBIDDEN (Current user is not a super admin) + - HTTPException: 404 NOT FOUND (Provided Job ID does not exist) + """ + return job_application_service.fetch_all(job_id=job_id, page=page, per_page=per_page,db=db) + +@jobs.delete('/{job_id}/applications/{application_id}', status_code=status.HTTP_204_NO_CONTENT) +async def delete_application(job_id: str, + application_id: str, + db: Annotated[Session, Depends(get_db)], + current_user: Annotated[User, Depends(user_service.get_current_super_admin)]): + """ + Deletes a single application. + Args: + job_id: The id of the job for the applicant + application_id: The id of the application for the job + db: database Session object + current_user: the super admin user + Returns: + HTTP 204 No Content on success + """ + job_application_service.delete(job_id, application_id, db) \ No newline at end of file diff --git a/api/v1/routes/newsletter.py b/api/v1/routes/newsletter.py index ecde405d8..9d4779ed6 100644 --- a/api/v1/routes/newsletter.py +++ b/api/v1/routes/newsletter.py @@ -1,62 +1,89 @@ -from fastapi import ( - APIRouter, - HTTPException, - Request, - Depends, - status - ) -from fastapi.responses import JSONResponse +from fastapi import APIRouter, Depends, status +from typing import Annotated from sqlalchemy.orm import Session -from api.v1.models.newsletter import Newsletter -from api.v1.schemas.newsletter import EMAILSCHEMA -from api.db.database import get_db, Base, engine +from api.utils.success_response import success_response +from api.v1.schemas.newsletter import EmailSchema, EmailRetrieveSchema, SingleNewsletterResponse +from api.db.database import get_db from api.v1.services.newsletter import NewsletterService +from fastapi.encoders import jsonable_encoder +from api.v1.models.user import User +from api.v1.services.user import user_service -class CustomException(HTTPException): - """ - Custom error handling - """ - def __init__(self, status_code: int, detail: dict): - super().__init__(status_code=status_code, detail=detail) - self.message = detail.get("message") - self.success = detail.get("success") - self.status_code = detail.get("status_code") - -async def custom_exception_handler(request: Request, exc: CustomException): - return JSONResponse( - status_code=exc.status_code, - content={ - "message": exc.message, - "success": exc.success, - "status_code": exc.status_code - } - ) +newsletter = APIRouter(prefix="/pages/newsletters", tags=["Newsletter"]) -newsletter = APIRouter(tags=['Newsletter']) -@newsletter.post('/newsletters') -async def sub_newsletter(request: EMAILSCHEMA, db: Session = Depends(get_db)): +@newsletter.post("/") +async def sub_newsletter(request: EmailSchema, db: Session = Depends(get_db)): """ Newsletter subscription endpoint """ # check for duplicate email - existing_subscriber = NewsletterService.check_existing_subscriber(db, request) - if existing_subscriber: - raise CustomException( - status_code=status.HTTP_400_BAD_REQUEST, - detail={ - "message": "Email already exists", - "success": False, - "status_code": 400 - } - ) + NewsletterService.check_existing_subscriber(db, request) # Save user to the database NewsletterService.create(db, request) - return { - "message": "Thank you for subscribing to our newsletter.", - "success": True, - "status": status.HTTP_201_CREATED - } + return success_response( + message="Thank you for subscribing to our newsletter.", + status_code=status.HTTP_201_CREATED, + ) + + +@newsletter.get( + "/", + response_model=success_response, + status_code=200, +) +def retrieve_subscribers( + db: Session = Depends(get_db), + admin: User = Depends(user_service.get_current_super_admin), +): + """ + Retrieve all newsletter subscription from database + """ + + subscriptions = NewsletterService.fetch_all(db) + subs_filtered = list( + map(lambda x: EmailRetrieveSchema.model_validate(x), subscriptions) + ) + + if len(subs_filtered) == 0: + subs_filtered = [{}] + + return success_response( + message="Subscriptions retrieved successfully", + status_code=200, + data=jsonable_encoder(subs_filtered), + ) + +@newsletter.get('/{id}', response_model=SingleNewsletterResponse, status_code=status.HTTP_200_OK) +async def get_single_newsletter( + id: str, + db: Annotated[Session, Depends(get_db)], + ): + """Retrieves a single newsletter. + + Args: + id: The id of the job for the newsletter + db: database Session object + + Returns: + SingleNewslettersResponse: response on success + """ + newsletterservice = NewsletterService() + return newsletterservice.fetch(news_id=id, db=db) + +@newsletter.delete( + "/{id}", + status_code=status.HTTP_204_NO_CONTENT, + summary="Delete single newsletter", + description="Endpoint to delete a single newsletter by ID", +) +def delete_newsletter( + id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to delete a newsletter""" + NewsletterService.delete(db=db, id=id) \ No newline at end of file diff --git a/api/v1/routes/notification.py b/api/v1/routes/notification.py index 2186648d1..4efa8f4a7 100644 --- a/api/v1/routes/notification.py +++ b/api/v1/routes/notification.py @@ -1,4 +1,4 @@ -from fastapi import Depends, status, APIRouter, Path +from fastapi import Depends, status, APIRouter, Path, HTTPException from sqlalchemy.orm import Session from api.utils.success_response import success_response from api.v1.models import User @@ -7,15 +7,37 @@ from api.v1.services.user import user_service from api.v1.services.notification import notification_service +from api.v1.schemas.notification import NotificationCreate + + notification = APIRouter(prefix="/notifications", tags=["Notifications"]) +@notification.post( + "/send", + summary="Send a notification", + description="This endpoint sends a notification", + status_code=status.HTTP_201_CREATED, +) +def send_notification( + notification_data: NotificationCreate, db: Session = Depends(get_db) +): + notification = notification_service.send_notification( + title=notification_data.title, + message=notification_data.message, + db=db, + ) + return success_response( + status_code=201, message="Notification sent successfully", data=notification + ) + + @notification.patch( "/{id}", summary="Mark a notification as read", description="This endpoint marks a notification as `read`. User must be authenticated an must be the owner of a notification to mark it as `read`", status_code=status.HTTP_200_OK, - response_model=success_response + response_model=success_response, ) def mark_notification_as_read( id: Annotated[str, Path()], @@ -26,4 +48,60 @@ def mark_notification_as_read( notification_id=id, user=current_user, db=db ) - return success_response(status_code=200, message="Notifcation marked as read") + return success_response(status_code=200, message="Notification marked as read") + + +@notification.get("/current-user") +def get_current_user_notifications( + current_user: User = Depends(user_service.get_current_user), + db: Session = Depends(get_db), +): + data = notification_service.get_current_user_notifications(current_user, db) + return success_response(status_code=200, message="All notifications", data=data) + + +@notification.get( + "/{notification_id}", + summary="Fetch a notification", + description="This endpoint fetches a notification by id", + status_code=status.HTTP_200_OK, +) +def get_notification_by_id( + notification_id: str, + db: Session = Depends(get_db), +): + notification = notification_service.fetch_notification_by_id( + notification_id=notification_id, db=db + ) + return success_response( + status_code=200, message="Notification fetched successfully", data=notification + ) + + +@notification.get( + "/all", + summary="Fetch all notifications", + description="This endpoint fetches all notifications.", + status_code=status.HTTP_200_OK, +) +def get_all_notifications( + db: Session = Depends(get_db), +): + notifications = notification_service.fetch_all_notifications(db=db) + return success_response( + status_code=200, + message="All notifications fetched successfully", + data=notifications, + ) + + +@notification.delete("/{notification_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_notification( + notification_id: str, + current_user=Depends(user_service.get_current_user), + db: Session = Depends(get_db), +): + notification_service.delete_notification(notification_id, current_user, db) + return success_response( + status_code=204, message="Notification deleted successfully" + ) diff --git a/api/v1/routes/notification_settings.py b/api/v1/routes/notification_settings.py new file mode 100644 index 000000000..72769e4a2 --- /dev/null +++ b/api/v1/routes/notification_settings.py @@ -0,0 +1,70 @@ +from fastapi import Depends, status, APIRouter, Path +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session +from api.utils.success_response import success_response +from api.v1.models import User +from typing import Annotated +from api.db.database import get_db +from api.v1.schemas.notification_settings import NotificationSettingsBase +from api.v1.services.user import user_service +from api.v1.services.notification_settings import notification_setting_service +from api.v1.models.notifications import NotificationSetting + + +notification_setting = APIRouter(prefix="/settings/notification-settings", tags=["Notification Settings"]) + +@notification_setting.get('', response_model=success_response, status_code=200) +def get_user_notification_settings( + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): + '''Endpoint to get current user notification preferences settings''' + + settings = notification_setting_service.fetch_by_user_id(db=db, user_id=current_user.id) + + return success_response( + status_code=200, + message="Notification preferences retrieved successfully", + data=jsonable_encoder(settings) + ) + +@notification_setting.post('', response_model=success_response, status_code=200) +def create_user_notification_settings( + schema: NotificationSettingsBase, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): + '''Endpoint to create new notification settings for the current user''' + + settings = notification_setting_service.update( + db=db, + user_id=current_user.id, + schema=schema + ) + + return success_response( + status_code=201, + message="Notification settings created successfully", + data=jsonable_encoder(settings) + ) + + +@notification_setting.patch('', response_model=success_response, status_code=200) +def update_user_notification_settings( + schema: NotificationSettingsBase, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): + '''Endpoint to update current user notification preferences settings''' + + settings = notification_setting_service.update( + db=db, + user_id=current_user.id, + schema=schema + ) + + return success_response( + status_code=200, + message="Notification preferences updated successfully", + data=jsonable_encoder(settings) + ) diff --git a/api/v1/routes/notifications.py b/api/v1/routes/notifications.py deleted file mode 100644 index df0c6202e..000000000 --- a/api/v1/routes/notifications.py +++ /dev/null @@ -1,25 +0,0 @@ -from fastapi import Depends, APIRouter, status -from sqlalchemy.orm import Session - -from api.v1.models.user import User -from api.v1.services.notification import notification_service -from api.v1.services.user import user_service - -from api.db.database import get_db - - -notifications = APIRouter(prefix="/notifications", tags=["notifications"]) - - -@notifications.delete("/{notification_id}", status_code=status.HTTP_204_NO_CONTENT) -def delete_notification( - notification_id: str, - current_user = Depends(user_service.get_current_user), - db: Session = Depends(get_db) - ): - - notification_service.delete( - notification_id, - user=current_user, - db=db - ) diff --git a/api/v1/routes/organization.py b/api/v1/routes/organization.py new file mode 100644 index 000000000..f21fecebe --- /dev/null +++ b/api/v1/routes/organization.py @@ -0,0 +1,211 @@ +import time +from fastapi import Depends, APIRouter, status, HTTPException +from fastapi.encoders import jsonable_encoder +from fastapi.responses import StreamingResponse +from sqlalchemy.orm import Session + +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.schemas.organization import ( + CreateUpdateOrganization, + PaginatedOrgUsers, + OrganizationBase, +) +from api.v1.services.product import product_service +from api.v1.schemas.product import ProductCreate +from api.db.database import get_db +from api.v1.services.user import user_service +from api.v1.services.organization import organization_service +from api.v1.services.product import product_service +from api.v1.schemas.product import ProductDetail +from typing import Annotated + +organization = APIRouter(prefix="/organizations", tags=["Organizations"]) + + +@organization.post( + "", response_model=success_response, status_code=status.HTTP_201_CREATED +) +def create_organization( + schema: CreateUpdateOrganization, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to create a new organization""" + + new_org = organization_service.create( + db=db, + schema=schema, + user=current_user, + ) + + # For some reason this line is needed before data can show in the response + print("Created Organization:", new_org) + + return success_response( + status_code=status.HTTP_201_CREATED, + message="Organization created successfully", + data=jsonable_encoder(new_org), + ) + + +@organization.get( + "/{org_id}/users", + response_model=success_response, + status_code=status.HTTP_200_OK, +) +async def get_organization_users( + org_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), + skip: int = 1, + limit: int = 10, +): + """Endpoint to fetch all users in an organization""" + + return organization_service.paginate_users_in_organization(db, org_id, skip, limit) + + +@organization.get('/{org_id}/users/export', status_code=200) +async def export_organization_member_data_to_csv( + org_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + '''Endpoint to export organization users data to csv''' + + csv_file = organization_service.export_organization_members(db=db, org_id=org_id) + + # Stream the response as a CSV file download + response = StreamingResponse(csv_file, media_type="text/csv") + response.headers["Content-Disposition"] = f"attachment; filename=organization_{org_id}_members.csv" + response.status_code = 200 + + return response + + +@organization.patch("/{org_id}", response_model=success_response, status_code=200) +async def update_organization( + org_id: str, + schema: CreateUpdateOrganization, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to update organization""" + + updated_organization = organization_service.update(db, org_id, schema, current_user) + + return success_response( + status_code=status.HTTP_200_OK, + message="Organization updated successfully", + data=jsonable_encoder(updated_organization), + ) + + +@organization.get("", status_code=status.HTTP_200_OK) +def get_all_organizations( + super_admin: Annotated[User, Depends(user_service.get_current_super_admin)], + db: Session = Depends(get_db), +): + orgs = organization_service.fetch_all(db) + return success_response( + status_code=status.HTTP_200_OK, + message="Retrived all organizations information Successfully", + data=jsonable_encoder(orgs), + ) + +@organization.post("/{org_id}/products", status_code=status.HTTP_201_CREATED) +def product_create( + org_id: str, + product: ProductCreate, + current_user: Annotated[User, Depends(user_service.get_current_user)], + db: Session = Depends(get_db), +): + created_product = product_service.create( + db=db, schema=product, org_id=org_id, current_user=current_user + ) + + return success_response( + status_code=status.HTTP_201_CREATED, + message="Product created successfully", + data=jsonable_encoder(created_product), + ) + +@organization.delete( + "/{org_id}/products/{product_id}", status_code=status.HTTP_204_NO_CONTENT +) +def delete_product( + org_id: str, + product_id: str, + current_user: User = Depends(user_service.get_current_user), + db: Session = Depends(get_db), +): + """Enpoint to delete a product + + Args: + product_id (str): The unique identifier of the product to be deleted + current_user (User): The currently authenticated user, obtained from the `get_current_user` dependency. + db (Session): The database session, provided by the `get_db` dependency. + + Raises: + HTTPException: 401 FORBIDDEN (Current user is not a authenticated) + HTTPException: 404 NOT FOUND (Product to be deleted cannot be found) + """ + + product_service.delete( + db=db, org_id=org_id, product_id=product_id, current_user=current_user + ) + +@organization.delete("/{org_id}") +async def delete_organization( + org_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + check = organization_service.check_organization_exist(db, org_id) + if check: + organization_service.delete(db, id=org_id) + return success_response( + status_code=status.HTTP_200_OK, + message="Organization with ID {org_id} deleted successfully" + ) + + +@organization.get( + "/{org_id}/products/{product_id}", + response_model=dict[str, int | str | bool | ProductDetail], + summary="Get product detail", + description="Endpoint to get detail about the product with the given `id`", +) +async def get_product_detail( + org_id: str, + product_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """ + Retrieve product detail + + This endpoint retrieve details about a product + + Args: + org_id (UUID): The unique identifier of the organization + product_id (UUID): The unique identifier of the product to be retrieved. + db (Session): The database session, provided by the `get_db` dependency. + current_user (User): The currently authenticated user, obtained from the `get_current_user` dependency. + + Returns: + ProductDetail: The detail of the product matching the given id + + Raises: + HTTPException: If the product with the specified `id` does not exist, a 404 error is raised. + """ + + product = product_service.fetch_single_by_organization(db, org_id, product_id, current_user) + + return { + "status_code": status.HTTP_200_OK, + "success": True, + "message": "Product fetched successfully", + "data": product, + } diff --git a/api/v1/routes/payment.py b/api/v1/routes/payment.py new file mode 100644 index 000000000..ea22ca03c --- /dev/null +++ b/api/v1/routes/payment.py @@ -0,0 +1,91 @@ +from fastapi import Depends, APIRouter, status, Query, HTTPException +from sqlalchemy.orm import Session +from typing import Annotated + +from api.utils.success_response import success_response +from api.v1.schemas.payment import PaymentListResponse, PaymentResponse +from api.v1.services.payment import PaymentService +from api.v1.services.user import user_service +from api.db.database import get_db +from api.v1.models import User + +payment = APIRouter(prefix="/payments", tags=["Payments"]) + + +@payment.get( + "/current-user", status_code=status.HTTP_200_OK, response_model=PaymentListResponse +) +def get_payments_for_current_user( + current_user: User = Depends(user_service.get_current_user), + limit: Annotated[int, Query(ge=1, description="Number of payments per page")] = 10, + page: Annotated[int, Query(ge=1, description="Page number (starts from 1)")] = 1, + db: Session = Depends(get_db), +): + """ + Endpoint to retrieve a paginated list of payments of ``current_user``. + + Query parameter: + - limit: Number of payment per page (default: 10, minimum: 1) + - page: Page number (starts from 1) + """ + payment_service = PaymentService() + + # FETCH all payments for current user + payments = payment_service.fetch_by_user( + db, user_id=current_user.id, limit=limit, page=page + ) + + # GET number of payments + num_of_payments = len(payments) + + if not num_of_payments: + # RETURN not found message + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, detail="Payments not found for user" + ) + + # GET total number of pages based on number of payments/limit per page + total_pages = int(num_of_payments / limit) + (num_of_payments % limit > 0) + + # COMPUTE payment data into a list + payment_data = [ + { + "amount": str(pay.amount), + "currency": pay.currency, + "status": pay.status, + "method": pay.method, + "created_at": pay.created_at.isoformat(), + } + for pay in payments + ] + + # GATHER all data in a dict + data = { + "pagination": { + "limit": limit, + "current_page": page, + "total_pages": total_pages, + "total_items": num_of_payments, + }, + "payments": payment_data, + "user_id": current_user.id, + } + + # RETURN all data with success message + return success_response( + status_code=status.HTTP_200_OK, + message="Payments fetched successfully", + data=data, + ) + + +@payment.get("/{payment_id}", response_model=PaymentResponse) +async def get_payment(payment_id: str, db: Session = Depends(get_db)): + ''' + Endpoint to retrieve a payment by its ID. + ''' + + payment_service = PaymentService() + payment = payment_service.get_payment_by_id(db, payment_id) + return payment + diff --git a/api/v1/routes/payment_flutterwave.py b/api/v1/routes/payment_flutterwave.py new file mode 100644 index 000000000..d200bea23 --- /dev/null +++ b/api/v1/routes/payment_flutterwave.py @@ -0,0 +1,67 @@ +from fastapi import Depends, APIRouter, status, Query, HTTPException +from sqlalchemy.orm import Session +from typing import Annotated + +from api.utils.success_response import success_response +from api.utils.db_validators import check_model_existence +from api.v1.schemas.payment import PaymentDetail +from api.v1.services.payment import PaymentService +from api.v1.services.user import user_service +from api.db.database import get_db +from api.v1.models import User +from decouple import config +from uuid_extensions import uuid7 +import requests +from api.v1.routes.payment import payment +from api.v1.models.billing_plan import BillingPlan +from api.utils.settings import settings + +@payment.post("/flutterwave", response_model=success_response) +async def pay_with_flutterwave( + request: PaymentDetail, + current_user: User = Depends(user_service.get_current_user), + db: Session = Depends(get_db) + ): + """ + Flutterwave payment intergration - initialize payment + """ + SECRET_KEY = settings.FLUTTERWAVE_SECRET + FLUTTERWAVE_URL = 'https://api.flutterwave.com/v3/payments' + header = {'Authorization': 'Bearer ' + SECRET_KEY} + transaction_id = str(uuid7()) + plan = check_model_existence(db, BillingPlan, request.plan_id) + data = { + "tx_ref": transaction_id, + "amount": float(plan.price), + "currency": plan.currency, + "redirect_url": request.redirect_url, + "payment_options":"card", + "customer":{ + "email": current_user.email + }, + } + + try: + response = requests.post(FLUTTERWAVE_URL, json=data, headers=header) + response=response.json() + + # save payment detail + payment_service = PaymentService() + payment_data = { + "user_id":current_user.id, + "amount": float(plan.price), + "currency":plan.currency, + "status": "pending", + "method": "card", + "transaction_id":transaction_id + } + payment_service.create(db, payment_data) + + return success_response( + status_code=status.HTTP_200_OK, + message='Payment initiated successfully', + data={"payment_url": response['data']['link']}, + ) + except Exception as e: + print(e) + raise HTTPException(status_code=400, detail='Error initializing payment') diff --git a/api/v1/routes/permissions/__init__.py b/api/v1/routes/permissions/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/api/v1/routes/permissions/permisions.py b/api/v1/routes/permissions/permisions.py new file mode 100644 index 000000000..10cf1d43b --- /dev/null +++ b/api/v1/routes/permissions/permisions.py @@ -0,0 +1,42 @@ +from fastapi import APIRouter, Depends, Path, Query, HTTPException +from sqlalchemy.orm import Session +from fastapi import status +from api.v1.schemas.permissions.permissions import PermissionCreate, PermissionResponse, PermissionAssignRequest, PermissionUpdate +from api.v1.services.permissions.permison_service import permission_service +from api.db.database import get_db +from uuid_extensions import uuid7 +from api.v1.models.user import User +from api.v1.services.user import user_service + +perm_role = APIRouter(tags=["permissions management"]) + +@perm_role.post("/permissions", tags=["create permissions"]) +def create_permission_endpoint(permission: PermissionCreate, db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user)): + return permission_service.create_permission(db, permission) + + +@perm_role.post("/roles/{role_id}/permissions", tags=["assign role to a user"]) +def assign_permission_endpoint( + request: PermissionAssignRequest, # Updated to receive request body + role_id: str = Path(..., description="The ID of the role"), # Role ID from path + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user)): + return permission_service.assign_permission_to_role(db, role_id,request.permission_id) + +@perm_role.delete("/permissions/{permission_id}", tags=["Delete permissions"] , status_code=status.HTTP_204_NO_CONTENT) +def delete_permissions( + permission_id : str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin) + ): + return permission_service.delete_permission(db , permission_id) + + +@perm_role.put("/roles/{role_id}/permissions/{permission_id}", tags=["update permissions"]) +def update_permission_endpoint( + new_permission_id: PermissionUpdate, # New Permission ID from path + permission_id: str = Path(..., description="The ID of the old permission"), # Old Permission ID from path + role_id: str = Path(..., description="The ID of the role"), # Role ID from path + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin)): # Assuming only super admins can update permissions + return permission_service.update_permission_on_role(db, role_id, permission_id, new_permission_id.new_permission_id) \ No newline at end of file diff --git a/api/v1/routes/permissions/roles.py b/api/v1/routes/permissions/roles.py new file mode 100644 index 000000000..a0f8d68c5 --- /dev/null +++ b/api/v1/routes/permissions/roles.py @@ -0,0 +1,68 @@ +from fastapi import APIRouter, Depends, Path, Query, HTTPException, status +from typing import List +from sqlalchemy.orm import Session +from api.utils.success_response import success_response +from api.v1.schemas.permissions.roles import RoleCreate, RoleResponse, RoleAssignRequest +from api.v1.services.permissions.role_service import role_service +from api.v1.schemas.permissions.roles import RoleDeleteResponse +from fastapi.responses import JSONResponse +from api.utils.success_response import success_response + +from api.db.database import get_db +from uuid_extensions import uuid7 +from api.v1.models.user import User +from api.v1.services.user import user_service + +role_perm = APIRouter(tags=["permissions management"]) + +@role_perm.post("/roles", tags=["create role"]) +def create_role_endpoint( + role: RoleCreate, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user)): + return role_service.create_role(db, role) + + +@role_perm.post("/organizations/{org_id}/users/{user_id}/roles", tags=["assign role to a user"]) +def assign_role( + request: RoleAssignRequest, + org_id: str = Path(..., description="The ID of the organization"), + user_id: str = Path(..., description="The ID of the user"), + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): + return role_service.assign_role_to_user(db, org_id, user_id, request.role_id) + + +@role_perm.delete("/roles/{role_id}", tags=["delete role"], response_model=success_response) +def delete_role( + role_id: str, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): + role_service.delete_role(db, role_id) + return success_response(status_code=200, message="Role successfully deleted.", data={"id": role_id}) + + + + + +@role_perm.get( + "/organizations/{org_id}/roles", + response_model=List[RoleResponse], + tags=["Fetch Roles"], +) +def get_roles_for_organization( + org_id: str = Path(..., description="The ID of the organization"), + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + roles = (role_service.get_roles_by_organization(db, org_id),) + if not roles: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Roles not found for the given organization", + ) + return success_response( + status_code=status.HTTP_200_OK, message="Roles fetched successfully", data=roles + ) diff --git a/api/v1/routes/privacy.py b/api/v1/routes/privacy.py new file mode 100644 index 000000000..7de038ce0 --- /dev/null +++ b/api/v1/routes/privacy.py @@ -0,0 +1,53 @@ +from typing import Annotated, Optional +from fastapi import Depends, APIRouter, Request, status, Query, HTTPException +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session +from typing import List +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.schemas.privacy_policies import ( + PrivacyPolicyCreate, PrivacyPolicyResponse, PrivacyPolicyUpdate +) +from api.db.database import get_db +from api.v1.services.privacy_policies import privacy_service +from api.v1.services.user import user_service + + +privacies = APIRouter(prefix="/privacy-policy", tags=["Privacy Policy"]) + +@privacies.post("", response_model=PrivacyPolicyResponse, status_code=status.HTTP_201_CREATED) +def create_privacy(privacy: PrivacyPolicyCreate, db: Session = Depends(get_db), + superadmin_user: User = Depends(user_service.get_current_super_admin)): + privacy_item = privacy_service.create(db, privacy) + + return success_response( + status_code=status.HTTP_201_CREATED, + message='Privacy created successfully', + data=jsonable_encoder(privacy_item) + ) + +@privacies.get("", response_model=List[PrivacyPolicyResponse]) +def get_privacies(db: Session = Depends(get_db)): + """Get All Privacies""" + privacy_items = privacy_service.fetch_all(db) + + return success_response( + status_code=200, + message='Privacies retrieved successfully', + data=jsonable_encoder(privacy_items) + ) + +@privacies.get("/{privacy_id}", response_model=PrivacyPolicyResponse) +def get_privacy(privacy_id: str, db: Session = Depends(get_db)): + privacy = privacy_service.fetch(db, privacy_id) + + return success_response ( + status_code=200, + message='privacy retrieved successfully', + data=jsonable_encoder(privacy) + ) + +@privacies.delete("/{privacy_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_privacy(privacy_id: str, db: Session = Depends(get_db), superadmin_user: User = Depends(user_service.get_current_super_admin)): + """Delete a Privacy Policy""" + privacy_service.delete(db, privacy_id) diff --git a/api/v1/routes/product.py b/api/v1/routes/product.py index 16e70cafb..57ea8dfa0 100644 --- a/api/v1/routes/product.py +++ b/api/v1/routes/product.py @@ -1,39 +1,140 @@ -from fastapi import Depends, HTTPException, APIRouter, Request, Response, status, Query +from fastapi import Depends, APIRouter, status, Query, HTTPException +from fastapi.encoders import jsonable_encoder from sqlalchemy.orm import Session +from sqlalchemy import func from typing import Annotated -from datetime import datetime - +from typing import List +from api.utils.pagination import paginated_response from api.utils.success_response import success_response -from api.v1.models.product import Product -from api.v1.schemas.user import DeactivateUserSchema, UserBase from api.db.database import get_db -from api.v1.services.product import product_service -from api.v1.schemas.product import ProductList -from api.v1.schemas.product import ProductUpdate, ResponseModel +from api.v1.models.product import Product, ProductFilterStatusEnum, ProductStatusEnum +from api.v1.services.product import product_service, ProductCategoryService +from api.v1.schemas.product import ( + ProductCategoryCreate, + ProductCategoryData, + ProductCreate, + ProductList, + ProductUpdate, + ResponseModel, + ProductStockResponse, + ProductFilterResponse, + SuccessResponse, + ProductCategoryRetrieve +) from api.utils.dependencies import get_current_user from api.v1.services.user import user_service from api.v1.models import User -product = APIRouter(prefix='/products', tags=['Products']) +product = APIRouter(prefix="/products", tags=["Products"]) + + +@product.get("", response_model=success_response, status_code=200) +async def get_all_products( + current_user: Annotated[User, Depends(user_service.get_current_super_admin)], + limit: Annotated[int, Query( + ge=1, description="Number of products per page")] = 10, + skip: Annotated[int, Query( + ge=1, description="Page number (starts from 1)")] = 0, + db: Session = Depends(get_db), +): + """Endpoint to get all products. Only accessible to superadmin""" + + return paginated_response(db=db, model=Product, limit=limit, skip=skip) + + +@product.get( + "/filter-status", + response_model=SuccessResponse[List[ProductFilterResponse]], + status_code=200, +) +async def get_products_by_filter_status( + filter_status: ProductFilterStatusEnum = Query(...), + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to get products by filter status""" + try: + products = product_service.fetch_by_filter_status(db, filter_status) + return SuccessResponse( + message="Products retrieved successfully", status_code=200, data=products + ) + except Exception as e: + raise HTTPException( + status_code=500, detail="Failed to retrieve products") -@product.get('/{org_id}', status_code=status.HTTP_200_OK, response_model=ProductList) + +@product.get( + "/status", + response_model=SuccessResponse[List[ProductFilterResponse]], + status_code=200, +) +async def get_products_by_status( + status: ProductStatusEnum = Query(...), + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to get products by status""" + try: + products = product_service.fetch_by_status(db, status) + return SuccessResponse( + message="Products retrieved successfully", status_code=200, data=products + ) + except Exception as e: + raise HTTPException( + status_code=500, detail="Failed to retrieve products") + + +@product.get("/categories", response_model=success_response, status_code=200) +def retrieve_categories( + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): + """ + Retrieve all product categories from database + """ + + categories = ProductCategoryService.fetch_all(db) + + categories_filtered = list( + map(lambda x: ProductCategoryRetrieve.model_validate(x), categories)) + + if (len(categories_filtered) == 0): + categories_filtered = [{}] + + return success_response( + message="Categories retrieved successfully", + status_code=200, + data=jsonable_encoder(categories_filtered) + ) + + +@product.get("/{org_id}", status_code=status.HTTP_200_OK, response_model=ProductList) +@product.get( + "/organizations/{org_id}", + status_code=status.HTTP_200_OK, + response_model=ProductList, +) def get_organization_products( org_id: str, current_user: Annotated[User, Depends(user_service.get_current_user)], - limit: Annotated[int, Query(ge=1, description="Number of products per page")] = 10, - page: Annotated[int, Query(ge=1, description="Page number (starts from 1)")] = 1, - db: Session = Depends(get_db), - ): - ''' + limit: Annotated[int, Query( + ge=1, description="Number of products per page")] = 10, + page: Annotated[int, Query( + ge=1, description="Page number (starts from 1)")] = 1, + db: Session = Depends(get_db), +): + """ Endpoint to retrieve a paginated list of products of an organization. - Query parameter: + Query parameter: - limit: Number of product per page (default: 10, minimum: 1) - page: Page number (starts from 1) - ''' + """ - products = product_service.fetch_by_organization(db, user=current_user, org_id=org_id, limit=limit, page=page) + products = product_service.fetch_by_organization( + db, user=current_user, org_id=org_id, limit=limit, page=page + ) total_products = len(products) @@ -43,7 +144,7 @@ def get_organization_products( { "name": product.name, "description": product.description, - "price": str(product.price) + "price": str(product.price), } for product in products ] @@ -53,18 +154,45 @@ def get_organization_products( "total_pages": total_pages, "limit": limit, "total_items": total_products, - "products": product_data + "products": product_data, } return success_response( - status_code=200, - message="Successfully fetched organizations products", - data=data - ) + status_code=200, + message="Successfully fetched organizations products", + data=data, + ) +@product.get("/{id}/stock", response_model=ResponseModel) +async def get_product_stock( + id: str, + current_user: Annotated[User, Depends(user_service.get_current_user)], + db: Session = Depends(get_db) +): + """ + Retrieve the current stock level for a specific product. + This endpoint fetches the current stock information for a given product, + including the total stock across all variants and the last update time. + + Args: + id (str): The unique identifier of the product. + db (Session): The database session, provided by the `get_db` dependency. + + + Returns: + ResponseModel: A success response containing the product stock information. + Raises: + HTTPException: If the product with the specified `id` does not exist, a 404 error is raised. + """ + stock_info = product_service.fetch_stock(db, id, current_user) + return success_response( + status_code=status.HTTP_200_OK, + message="Product stock fetched successfully", + data=jsonable_encoder(stock_info), + ) @product.put("/{id}", response_model=ResponseModel) @@ -72,13 +200,13 @@ async def update_product( id: str, product_update: ProductUpdate, current_user: User = Depends(get_current_user), - db: Session = Depends(get_db) + db: Session = Depends(get_db), ): """ Update the details of an existing product. This endpoint updates a product's attributes such as name, price, description, and tag. - It ensures that the product exists before performing the update. The `updated_at` timestamp + It ensures that the product exists before performing the update. The `updated_at` timestamp is set to the current time to reflect when the update occurred. Args: @@ -100,25 +228,44 @@ async def update_product( "price": 29.99, "description": "Updated description", } - """ - try: - updated_product = product_service.update(db, id=str(id), schema=product_update) - except HTTPException as e: - raise e + """ + + updated_product = product_service.update( + db, id=str(id), schema=product_update) # Prepare the response - response = ResponseModel( - success=True, + return success_response( status_code=200, message="Product updated successfully", - data={ - "id": updated_product.id, - "name": updated_product.name, - "price": updated_product.price, - "description": updated_product.description, - "updated_at": updated_product.updated_at - } + data=jsonable_encoder(updated_product), + ) + +@product.post('/categories/{org_id}', status_code=status.HTTP_201_CREATED) +def create_product_category( + org_id: str, + category_schema: ProductCategoryCreate, + current_user: User = Depends(user_service.get_current_user), + db: Session = Depends(get_db), +): + """Endpoint to create a product category + + Args: + org_id (str): The unique identifier of the organization + current_user (User): The currently authenticated user, obtained from the `get_current_user` dependency. + db (Session): The database session, provided by the `get_db` dependency. + + Returns: + ResponseModel: The created product category + + Raises: + HTTPException: 401 FORBIDDEN (Current user is not a authenticated) + """ + + new_category = ProductCategoryService.create(db, org_id, category_schema, current_user) + + return success_response( + status_code=status.HTTP_201_CREATED, + message="Category successfully created", + data=jsonable_encoder(new_category), ) - - return response diff --git a/api/v1/routes/profiles.py b/api/v1/routes/profiles.py index c0e8edb0f..60ad9848d 100644 --- a/api/v1/routes/profiles.py +++ b/api/v1/routes/profiles.py @@ -1,31 +1,144 @@ -from fastapi import Depends, HTTPException, APIRouter, Request, Response, status -from jose import JWTError +from fastapi import Depends, APIRouter, Request, logger, status, File, UploadFile, HTTPException from sqlalchemy.orm import Session +import logging +from PIL import Image +from io import BytesIO +from fastapi.responses import JSONResponse +import os from api.utils.success_response import success_response from api.v1.models.user import User -from api.v1.schemas.profile import ProfileBase,ProfileCreateUpdate +from api.v1.schemas.profile import ProfileCreateUpdate from api.db.database import get_db +from api.v1.schemas.user import DeactivateUserSchema from api.v1.services.user import user_service from api.v1.services.profile import profile_service -from api.utils.success_response import success_response +profile = APIRouter(prefix="/profile", tags=["Profiles"]) + -profile = APIRouter(prefix='/profile', tags=['Profiles']) +@profile.get( + "/current-user", status_code=status.HTTP_200_OK, response_model=success_response +) +def get_current_user_profile( + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to get current user profile details""" -@profile.get('/current-user', status_code=status.HTTP_200_OK, response_model=ProfileBase) -def get_current_user_profile(db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user)): - '''Endpoint to get current user profile details''' + profile = profile_service.fetch_by_user_id(db, user_id=current_user.id) - return profile_service.fetch_by_user_id(db,user_id=current_user.id) + return success_response( + status_code=status.HTTP_201_CREATED, + message="User profile create successfully", + data=profile.to_dict(), + ) -@profile.post('/', status_code=status.HTTP_201_CREATED, response_model=ProfileBase) -def create_user_profile(schema: ProfileCreateUpdate, db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user)): + +@profile.post('/', status_code=status.HTTP_201_CREATED, response_model=success_response) +def create_user_profile( + schema: ProfileCreateUpdate, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): '''Endpoint to create user profile from the frontend''' user_profile = profile_service.create(db, schema=schema, user_id=current_user.id) - - response = success_response(status_code=status.HTTP_201_CREATED,message="User profile create successfully", data=user_profile.to_dict()) - return response \ No newline at end of file + response = success_response( + status_code=status.HTTP_201_CREATED, + message="User profile create successfully", + data=user_profile.to_dict(), + ) + + return response + + +@profile.patch("/", status_code=status.HTTP_200_OK, response_model=success_response) +def update_user_profile( + schema: ProfileCreateUpdate, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to update user profile""" + + updated_profile = profile_service.update(db, schema=schema, user_id=current_user.id) + + response = success_response( + status_code=status.HTTP_200_OK, + message="User profile updated successfully", + data=updated_profile.to_dict(), + ) + + return response + + +@profile.post("/deactivate", status_code=status.HTTP_200_OK) +async def deactivate_account( + request: Request, + schema: DeactivateUserSchema, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user), +): + """Endpoint to deactivate a user account""" + + reactivation_link = user_service.deactivate_user( + request=request, db=db, schema=schema, user=current_user + ) + + return success_response( + status_code=200, + message="User deactivation successful", + data={"reactivation_link": reactivation_link}, + ) + + +@profile.get("/reactivate", status_code=200) +async def reactivate_account(request: Request, db: Session = Depends(get_db)): + """Endpoint to reactivate a user account""" + + # Get access token from query + token = request.query_params.get("token") + + # reactivate user + user_service.reactivate_user(db=db, token=token) + + return success_response( + status_code=200, + message="User reactivation successful", + ) + +PROFILE_IMAGE_DIR = "static/profile_images" + +@profile.post("/upload-image") +async def upload_profile_image( + file: UploadFile = File(...), + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user) +): + user_id = current_user.id + + if file.content_type not in ["image/jpeg", "image/png"]: + raise HTTPException(status_code=400, detail="Invalid file format. Only JPG and PNG are supported.") + + try: + image = Image.open(BytesIO(await file.read())) + image = image.resize((300, 300)) + buffer = BytesIO() + image.save(buffer, format="JPEG", quality=85) + buffer.seek(0) + + file_name = f"{PROFILE_IMAGE_DIR}/{user_id}.jpg" + os.makedirs(PROFILE_IMAGE_DIR, exist_ok=True) + with open(file_name, "wb") as f: + f.write(buffer.getbuffer()) + + image_url = f"/static/profile_images/{user_id}.jpg" + + profile_service.update_user_avatar(db, user_id, image_url) + + return JSONResponse(status_code=200, content={"message": "Image uploaded successfully", "image_url": image_url}) + + except Exception as e: + raise HTTPException(status_code=500, detail=f"An error occurred: {str(e)}") \ No newline at end of file diff --git a/api/v1/routes/regions.py b/api/v1/routes/regions.py new file mode 100644 index 000000000..30d206c1d --- /dev/null +++ b/api/v1/routes/regions.py @@ -0,0 +1,63 @@ +from typing import Annotated, Optional +from fastapi import Depends, APIRouter, Request, status, Query, HTTPException +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session +from typing import List +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.schemas.regions import ( + RegionCreate, RegionOut, RegionUpdate +) +from api.db.database import get_db +from api.v1.services.regions import region_service +from api.v1.services.user import user_service + + +regions = APIRouter(prefix="/regions", tags=["Regions, Timezone and Language"]) + +# Region Endpoints +@regions.post("", response_model=RegionOut, status_code=status.HTTP_201_CREATED) +def create_region(region: RegionCreate, db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_user)): + region = region_service.create(db, region, current_user.id) + + return success_response( + status_code=status.HTTP_201_CREATED, + message='Region created successfully', + data=jsonable_encoder(region) + ) + +@regions.get("", response_model=List[RegionOut]) +def get_regions(db: Session = Depends(get_db)): + """Get All Regions""" + regions = region_service.fetch_all(db) + + return success_response( + status_code=200, + message='Regions retrieved successfully', + data=jsonable_encoder(regions) + ) + +@regions.get("/{region_id}", response_model=RegionOut) +def get_region_by_user(region_id: str, db: Session = Depends(get_db)): + region = region_service.fetch(db, region_id) + + return success_response ( + status_code=200, + message='Region retrieved successfully', + data=jsonable_encoder(region) + ) + +@regions.put("/{region_id}", response_model=RegionOut) +def update_region(region_id: str, region: RegionUpdate, db: Session = Depends(get_db)): + db_region = region_service.update(db, region_id, region) + return success_response( + status_code=200, + message='Region updated successfully', + data=jsonable_encoder(db_region) + ) + +@regions.delete("/{region_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_region(region_id: str, db: Session = Depends(get_db)): + region = region_service.delete(db, region_id) + return \ No newline at end of file diff --git a/api/v1/routes/request_password.py b/api/v1/routes/request_password.py new file mode 100644 index 000000000..a63913006 --- /dev/null +++ b/api/v1/routes/request_password.py @@ -0,0 +1,37 @@ +from fastapi import APIRouter, Depends, Request, Query, BackgroundTasks +from sqlalchemy.orm import Session +from api.v1.schemas.request_password_reset import RequestEmail, ResetPassword +from api.db.database import get_db as get_session +from api.v1.services.request_pwd import reset_service +import logging + +pwd_reset = APIRouter(prefix="/auth", tags=["Authentication"]) + + +# generate password reset link +@pwd_reset.post("/request-password-reset") +async def request_reset_link( + reset_schema: RequestEmail, + request: Request, + background_tasks: BackgroundTasks, + session: Session = Depends(get_session), +): + return await reset_service.create(reset_schema, request, session, background_tasks) + + +# process password link +@pwd_reset.get("/reset-password") +async def process_reset_link( + token: str = Query(...), session: Session = Depends(get_session) +): + return reset_service.process_reset_link(token, session) + + +# change the password +@pwd_reset.post("/reset-password") +async def reset_password( + data: ResetPassword, + token: str = Query(...), + session: Session = Depends(get_session), +): + return reset_service.reset_password(data, token, session) diff --git a/api/v1/routes/settings.py b/api/v1/routes/settings.py new file mode 100644 index 000000000..ce7e225bd --- /dev/null +++ b/api/v1/routes/settings.py @@ -0,0 +1,48 @@ +from fastapi import APIRouter, Depends, status +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session + +from api.db.database import get_db +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.services.user import user_service +from api.v1.services.data_privacy import data_privacy_service +from api.v1.schemas.data_privacy import DataPrivacySettingUpdate + +settings = APIRouter(prefix="/settings") + + +@settings.get("/data-privacy") +async def get_user_data_privacy_setting( + current_user: User = Depends(user_service.get_current_user), + db: Session = Depends(get_db), +): + """ + Endpoint to get a user's data privacy setting + """ + + data = data_privacy_service.fetch(db, current_user) + + return success_response( + status_code=status.HTTP_200_OK, + message="Data privacy setting fetched successfully", + data=jsonable_encoder(data), + ) + + +@settings.patch("/data-privacy") +async def update_user_data_privacy_setting( + schema: DataPrivacySettingUpdate, + current_user: User = Depends(user_service.get_current_user), + db: Session = Depends(get_db), +): + """ + Endpoint to update a user's data privacy setting' + """ + updated_settings = data_privacy_service.update(db=db, schema=schema, user=current_user) + + return success_response( + status_code=status.HTTP_200_OK, + message="Data Privacy settings updated successfully", + data=jsonable_encoder(updated_settings) + ) diff --git a/api/v1/routes/sms_twilio.py b/api/v1/routes/sms_twilio.py new file mode 100644 index 000000000..5d8900a67 --- /dev/null +++ b/api/v1/routes/sms_twilio.py @@ -0,0 +1,54 @@ +from fastapi import APIRouter, HTTPException, status, Depends +from api.v1.schemas.sms_twilio import SMSRequest +from api.v1.services.sms_twilio import send_sms +from api.utils.success_response import success_response +from api.v1.services.user import user_service +from api.v1.models.user import User +from api.utils.dependencies import get_current_user +from typing import Annotated + +sms = APIRouter(prefix="/sms/send", tags=["SMS"]) + +@sms.post("/", status_code=status.HTTP_200_OK, response_model=SMSRequest) +def send_sms_endpoint( + sms_request: SMSRequest, + current_user: Annotated[User, Depends(user_service.get_current_user)], + + ): + """ + Endpoint to send SMS using Twilio. + + Parameters: + sms_request (SMSRequest): The request body containing phone number and message. + + Returns: + dict: The response containing status and message SID or error details. + """ + try: + result = send_sms(sms_request.phone_number, sms_request.message) + + if result.get("status") == "error": + raise HTTPException( + status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, + detail={ + "status": "unsuccessful", + "status_code": 500, + "message": "Failed to send SMS. Please try again later." + } + ) + return success_response( + status_code=200, + message = "SMS sent successfully.", + data = { + "sid": result['sid'] + } + ) + except Exception as e: + raise HTTPException( + status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, + detail={ + "status": "unsuccessful", + "status_code": 500, + "message": "Failed to send SMS. Please try again later." + } + ) \ No newline at end of file diff --git a/api/v1/routes/squeeze.py b/api/v1/routes/squeeze.py new file mode 100644 index 000000000..1131e0edd --- /dev/null +++ b/api/v1/routes/squeeze.py @@ -0,0 +1,57 @@ +from fastapi import APIRouter, Depends, status +from sqlalchemy.orm import Session +from api.db.database import get_db +from api.core.responses import SUCCESS +from api.utils.success_response import success_response +from api.v1.services.squeeze import squeeze_service +from api.v1.schemas.squeeze import CreateSqueeze, FilterSqueeze +from api.v1.services.user import user_service +from api.v1.models import * + +squeeze = APIRouter(prefix="/squeeze", tags=["Squeeze Page"]) + + +@squeeze.post("", response_model=success_response, status_code=201) +def create_squeeze( + data: CreateSqueeze, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Create a squeeze page""" + user = user_service.fetch_by_email(db, data.email) + if not user: + return success_response(status.HTTP_404_NOT_FOUND, "User not found!") + data.user_id = user.id + data.full_name = f"{user.first_name} {user.last_name}" + new_squeeze = squeeze_service.create(db, data) + return success_response(status.HTTP_201_CREATED, SUCCESS, new_squeeze.to_dict()) + + +@squeeze.get("", response_model=success_response, status_code=200) +def get_all_squeeze( + filter: FilterSqueeze = None, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Get all squeeze pages""" + squeeze_pages = squeeze_service.fetch_all(db, filter) + return success_response(status.HTTP_200_OK, SUCCESS, squeeze_pages) + + +@squeeze.get("/{squeeze_id}", response_model=success_response, status_code=200) +def get_squeeze( + squeeze_id: str, + filter: FilterSqueeze = None, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Get a squeeze page""" + squeeze_page = squeeze_service.fetch(db, squeeze_id, filter) + if not squeeze_page: + return success_response(status.HTTP_404_NOT_FOUND, "Squeeze page not found!") + return success_response(status.HTTP_200_OK, SUCCESS, squeeze_page) + +@squeeze.delete("/{squeeze_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_squeeze(squeeze_id: str, db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_super_admin)): + """Delete a squeeze page""" + squeeze_service.delete(db, squeeze_id) \ No newline at end of file diff --git a/api/v1/routes/superadmin.py b/api/v1/routes/superadmin.py deleted file mode 100644 index cea3ad818..000000000 --- a/api/v1/routes/superadmin.py +++ /dev/null @@ -1,66 +0,0 @@ -""" -Superadmin endpoints -""" - -from fastapi import APIRouter, Depends, HTTPException, status -from typing import Annotated -from sqlalchemy.orm import Session -from api.utils.success_response import success_response -from api.db.database import get_db -from api.v1.models.user import User -from api.v1.services.user import user_service -from api.v1.schemas.user import UserCreate, UserBase - -superadmin = APIRouter(prefix="/superadmin", tags=["superadmin"]) - -db_dependency = Annotated[Session, Depends(get_db)] - - -@superadmin.post(path="/register", status_code=status.HTTP_201_CREATED) -def register_admin(user: UserCreate, db: db_dependency): - """Endpoint for super admin creation""" - user_created = user_service.create_admin(db=db, schema=user) - return success_response( - status_code=201, - message="User Created Successfully", - data=user_created.to_dict(), - ) - - -@superadmin.delete(path="/users/{user_id}") -def delete_user( - user_id: str, - current_user: Annotated[User, Depends(user_service.get_current_super_admin)], - db: db_dependency, -): - """Endpoint for user deletion (soft-delete)""" - - """ - - Args: - user_id (str): User ID - current_user (User): Current logged in user - db (Session, optional): Database Session. Defaults to Depends(get_db). - - Raises: - HTTPException: 403 FORBIDDEN (Current user is not a super admin) - HTTPException: 404 NOT FOUND (User to be deleted cannot be found) - - Returns: - JSONResponse: 204 NO CONTENT (successful user deletion) - """ - - user = user_service.fetch(db=db, id=user_id) - - # check if the user_id points to a valid user - if not user: - raise HTTPException( - status_code=status.HTTP_404_NOT_FOUND, detail="User does not exist" - ) - - # soft-delete the user - user_service.delete(db=db, id=user_id) - - return success_response( - status_code=status.HTTP_200_OK, message="user deleted successfully" - ) diff --git a/api/v1/routes/team.py b/api/v1/routes/team.py new file mode 100644 index 000000000..3bdbc0310 --- /dev/null +++ b/api/v1/routes/team.py @@ -0,0 +1,126 @@ +"""Defines Teams Endpoints""" + +from typing import Annotated + +from fastapi import APIRouter, Depends, HTTPException, Path +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm.session import Session +from starlette import status + +from api.db.database import get_db +from api.utils.logger import logger +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.schemas.team import (PostTeamMemberSchema, + TeamMemberCreateResponseSchema, + UpdateTeamMember) +from api.v1.services.team import TeamServices, team_service +from api.v1.services.user import user_service + +team = APIRouter(prefix="/team", tags=["Teams"]) + + +@team.get( + '/members', + response_model=success_response, + status_code=status.HTTP_200_OK +) +def get_all_team_members( + db: Session = Depends(get_db), + su: User = Depends(user_service.get_current_super_admin) +): + '''Endpoint to fetch all team members''' + team_members = team_service.fetch_all(db) + + if not team_members: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="No team members found" + ) + + return success_response( + status_code=status.HTTP_200_OK, + message='Team members retrieved successfully', + data=jsonable_encoder(team_members), + ) + + +@team.get( + '/members/{team_id}', + response_model=success_response, + status_code=status.HTTP_200_OK +) +def get_team_member_by_id( + team_id: Annotated[str, Path(description="Team Member ID")], + db: Session = Depends(get_db), + su: User = Depends(user_service.get_current_super_admin) +): + '''Endpoint to fetch a team by id''' + team_response = team_service.fetch(db, team_id) + if not team: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Team not found" + ) + + return success_response( + status_code=status.HTTP_200_OK, + message='Team fetched successfully', + data=jsonable_encoder(team_response), + ) + + +@team.patch( + '/members/{team_id}', + response_model=success_response, + status_code=status.HTTP_200_OK +) +def update_team_member_by_id( + team_id: Annotated[str, Path(description="Team Member ID")], + team_data: UpdateTeamMember, + db: Session = Depends(get_db), + su: User = Depends(user_service.get_current_super_admin), +): + '''Endpoint to update a team by id''' + + team_response = team_service.update( + db, team_id, team_data.model_dump(exclude_unset=True, + exclude_none=True)) + return success_response( + status_code=status.HTTP_200_OK, + message='Team updated successfully', + data=jsonable_encoder(team_response), + ) + + +@team.post( + "/members", + response_model=success_response, + status_code=201, + +) +async def add_team_members( + member: PostTeamMemberSchema, + db: Session = Depends(get_db), + admin: User = Depends(user_service.get_current_super_admin), +): + """ + Add a team member to the database. + This endpoint allows an admin add a new team member to the database. + + Parameters: + - team: PostTeamMemberSchema + The details of the team member. + - admin: User (Depends on get_current_super_admin) + The current admin adding the team member. This is a dependency that provides the admin context. + - db: The database session + """ + new_member = TeamServices.create(db, member) + logger.info(f"Team Member added successfully {new_member.id}") + + return success_response( + message="Team Member added successfully", + status_code=201, + data=jsonable_encoder( + TeamMemberCreateResponseSchema.model_validate(new_member)) + ) diff --git a/api/v1/routes/terms_and_conditions.py b/api/v1/routes/terms_and_conditions.py new file mode 100644 index 000000000..1d9027cfa --- /dev/null +++ b/api/v1/routes/terms_and_conditions.py @@ -0,0 +1,92 @@ +from fastapi import APIRouter, Depends, status, HTTPException +from sqlalchemy.orm import Session +from api.db.database import get_db +from api.utils.success_response import success_response +from api.v1.services.terms_and_conditions import terms_and_conditions_service +from api.v1.schemas.terms_and_conditions import DeleteResponseModel, UpdateTermsAndConditions +from api.v1.services.user import user_service +from api.v1.models import * + +terms_and_conditions = APIRouter( + prefix="/terms-and-conditions", tags=["Terms and Conditions"] +) + +@terms_and_conditions.get("/{id}", response_model=success_response, status_code=200) +async def get_terms_and_conditions( + id: str, + db: Session = Depends(get_db) +): + """Endpoint to get term and condition based on id""" + tc = terms_and_conditions_service.fetch(db, id) + if not tc: + return success_response( + message="Term and condition not found", + status_code=status.HTTP_404_NOT_FOUND, + ) + return success_response( + data=tc.to_dict(), + message="success", + status_code=status.HTTP_200_OK + ) + +@terms_and_conditions.patch("/{id}", response_model=success_response, status_code=200) +async def update_terms_and_conditions( + id: str, + schema: UpdateTermsAndConditions, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to update terms and conditions. Only accessible to superadmins""" + + tc = terms_and_conditions_service.update(db, id=id, data=schema) + if not tc: + return success_response( + message="Terms and conditions not found", + status_code=status.HTTP_404_NOT_FOUND, + ) + return success_response( + data=tc.to_dict(), + message="Successfully updated terms and conditions", + status_code=status.HTTP_200_OK, + ) + + +@terms_and_conditions.post("/", response_model=success_response, status_code=201) +async def create_terms_and_conditions( + schema: UpdateTermsAndConditions, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to create terms and conditions. Only accessible to superadmins""" + + # Check if terms and conditions already exist + existing_tc = db.query(TermsAndConditions).first() + if existing_tc: + return success_response( + message="Terms and conditions already exist. Use PATCH to update.", + status_code=status.HTTP_400_BAD_REQUEST, + ) + + # Create new terms and conditions + new_tc = TermsAndConditions(title=schema.title, content=schema.content) + db.add(new_tc) + db.commit() + db.refresh(new_tc) + + return success_response( + data=new_tc.to_dict(), + message="Successfully created terms and conditions", + status_code=status.HTTP_201_CREATED, + ) + + +@terms_and_conditions.delete("/{id}", response_model=DeleteResponseModel) +async def delete_terms_and_conditions(id: str, db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_super_admin)): + try: + result = terms_and_conditions_service.delete(terms_id=id, db=db, current_user=current_user) + except HTTPException as e: + raise e + except Exception as e: + # Catch any other exceptions and raise an HTTP 500 error + raise HTTPException(status_code=500, detail={"message": "An unexpected error occurred", "status_code": 500, "success": False}) + return result diff --git a/api/v1/routes/testimonial.py b/api/v1/routes/testimonial.py index ae5c5e3d9..22ff49033 100644 --- a/api/v1/routes/testimonial.py +++ b/api/v1/routes/testimonial.py @@ -2,87 +2,91 @@ """ Module contains CRUD routes for testimonial """ +from fastapi.encoders import jsonable_encoder from api.db.database import get_db from sqlalchemy.orm import Session from api.v1.models.user import User -from api.v1.models.testimonial import Testimonial -from fastapi import Depends, HTTPException, APIRouter, Request, Response, status -from fastapi.responses import JSONResponse +from fastapi import Depends, APIRouter, status,Query from api.utils.success_response import success_response -from api.utils.json_response import JsonResponseDict from api.v1.services.testimonial import testimonial_service from api.v1.services.user import user_service +from api.v1.schemas.testimonial import CreateTestimonial +from api.core.responses import SUCCESS +from typing import Annotated +from api.utils.pagination import paginated_response +from api.v1.models.testimonial import Testimonial -testimonial = APIRouter(prefix='/testimonials', tags=['Testimonial']) +testimonial = APIRouter(prefix="/testimonials", tags=['Testimonial']) -@testimonial.delete("/{testimonial_id}") -def delete_testimonial( - testimonial_id: str, - current_user: User = Depends(user_service.get_current_user), - db: Session = Depends(get_db) + +@testimonial.get("", status_code=status.HTTP_200_OK) +def get_testimonials( + page_size: Annotated[int, Query(ge=1, description="Number of products per page")] = 10, + page: Annotated[int, Query(ge=1, description="Page number (starts from 1)")] = 0, + db: Session = Depends(get_db), ): - """ - Function for deleting a testimonial based on testimonial id - """ - if not testimonial_service.delete(db, testimonial_id): - raise HTTPException( - detail="Testimonial not found", - status_code=status.HTTP_404_NOT_FOUND - ) - return JSONResponse( - content={ - "success": True, - "message": "Testimonial deleted successfully", - "status_code": status.HTTP_200_OK - }, - status_code=status.HTTP_200_OK + """End point to Query Testimonials with pagination""" + + return paginated_response( + db=db, + model=Testimonial, + limit=page_size, + skip=max(page,0), ) -@testimonial.get('/{testimonial_id}', status_code=status.HTTP_200_OK) + +@testimonial.get("/{testimonial_id}", status_code=status.HTTP_200_OK) def get_testimonial( testimonial_id: str, db: Session = Depends(get_db), - current_user: User = Depends(user_service.get_current_user) + current_user: User = Depends(user_service.get_current_user), ): - '''Endpoint to get testimonial by id''' + """Endpoint to get testimonial by id""" + testimonial = testimonial_service.fetch(db, testimonial_id) - if testimonial and testimonial_id == testimonial.id: - return success_response( - status_code=200, - message=f'Testimonial {testimonial_id} retrieved successfully', - data={ - 'id': testimonial.id, - 'client_designation': testimonial.client_designation, - 'client_name': testimonial.client_name, - 'author_id': testimonial.author_id, - 'comments': testimonial.comments, - 'content': testimonial.content, - 'ratings': testimonial.ratings, - } - ) - return JSONResponse( - status_code=404, - content={ - "success": False, - "status_code": 404, - "message": f'Testimonial {testimonial_id} not found' - } + + return success_response( + status_code=200, + message=f"Testimonial {testimonial_id} retrieved successfully", + data=jsonable_encoder(testimonial), ) -@testimonial.delete("/", response_class=JsonResponseDict) -async def delete_all_testimonials(db: Session = Depends(get_db)): + +@testimonial.delete("/{testimonial_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_testimonial( + testimonial_id: str, + current_user: User = Depends(user_service.get_current_super_admin), + db: Session = Depends(get_db), +): + """ + Function for deleting a testimonial based on testimonial id + """ + + testimonial_service.delete(db, testimonial_id) + + +@testimonial.delete("/", status_code=status.HTTP_204_NO_CONTENT) +async def delete_all_testimonials( + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): """ Deletes all testimonials """ - try: - testimonial_service.delete_all(db) - return JsonResponseDict( - message="All testimonials deleted successfully", - data={}, - status_code=status.HTTP_200_OK - ) - except Exception as e: - raise HTTPException( - status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, - detail=str(e) - ) + + testimonial_service.delete_all(db) + +@testimonial.post('/', response_model=success_response) +def create_testimonial( + testimonial_data: CreateTestimonial, + db: Annotated[Session, Depends(get_db)], + current_user: User = Depends(user_service.get_current_user) +): + '''Endpoint to create testimonial''' + testimonial = testimonial_service.create(db, current_user, testimonial_data) + response = success_response( + status_code=201, + message=SUCCESS, + data={"id": testimonial.id} + ) + return response diff --git a/api/v1/routes/topic.py b/api/v1/routes/topic.py new file mode 100644 index 000000000..590b3c7d3 --- /dev/null +++ b/api/v1/routes/topic.py @@ -0,0 +1,157 @@ +from fastapi import ( + APIRouter, + Depends, + status, + ) +from fastapi.encoders import jsonable_encoder +from sqlalchemy.orm import Session +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.services.topic import topic_service +from api.db.database import get_db +from api.v1.services.user import user_service +from api.v1.schemas.topic import TopicList, TopicUpdateSchema,TopicBase, TopicData, TopicSearchSchema, TopicDeleteSchema + +topic = APIRouter(prefix='/help-center', tags=['Help-Center']) + +@topic.get('/topics', response_model=TopicList) +async def retrieve_all_topics( + db: Session = Depends(get_db) +): + """ + Description + Get endpoint for unauthenticated users to to get all topics. + + Args: + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + + topics = topic_service.fetch_all(db=db) + + return success_response( + status_code=status.HTTP_200_OK, + message='Topics fetched successfully', + data=jsonable_encoder(topics) + ) + +@topic.get('/topic/{topic_id}', response_model=TopicData) +async def retrieve_topic( + topic_id: str, + db: Session = Depends(get_db) +): + """ + Description + Get endpoint for unauthenticated users to to get a topic. + + Args: + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + + topic = topic_service.fetch(db=db, id=topic_id) + + return success_response( + status_code=status.HTTP_200_OK, + message='Topic fetched successfully', + data=jsonable_encoder(topic) + ) + +@topic.get('/search', response_model=TopicList) +async def search_for_topic( + schema: TopicSearchSchema, + db: Session = Depends(get_db) +): + """ + Description + Get endpoint for unauthenticated users to to search for topics. + + Args: + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + topics = topic_service.search(db=db,search_query=schema.query) + + return success_response( + status_code=status.HTTP_200_OK, + message='Topics fetched successfully', + data=jsonable_encoder(topics) + ) + +@topic.delete('/topics', status_code=status.HTTP_204_NO_CONTENT) +async def delete_a_topic( + id: TopicDeleteSchema, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """ + Description + Delete endpoint for admin users to delete topics. + + Args: + id: parameter for topic id + db: the database session object + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + + topic_service.delete(db, id.id) + + +@topic.patch("/topics") +async def update_a_topic( + schema: TopicUpdateSchema, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """ + Description + Put endpoint for admin users to update a topic. + + Args: + db: the database session object + schema: TopicUpdateSchema + id: parameter for topic id + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + updated_topic = topic_service.update(db, schema) + return success_response( + status_code=status.HTTP_200_OK, + message='Topic updated successfully!', + # data=jsonable_encoder(updated_topic) + ) + +@topic.post("/topics") +async def create_a_topic( + schema: TopicBase, + db: Session = Depends(get_db), + current_user: User = Depends(user_service.get_current_super_admin), +): + """Endpoint to create a new topic.""" + """ + Description + Post endpoint for admin users to create a new topic. + + Args: + db: the database session object + schema: TopicUpdateSchema + + Returns: + Response: a response object containing details if successful or appropriate errors if not + """ + + new_topic = topic_service.create(db, schema.title, schema.content, schema.tags) + return success_response( + status_code=status.HTTP_201_CREATED, + message='Topic created successfully!', + data=jsonable_encoder(new_topic) + ) diff --git a/api/v1/routes/update_product.py b/api/v1/routes/update_product.py deleted file mode 100644 index b49a72899..000000000 --- a/api/v1/routes/update_product.py +++ /dev/null @@ -1,82 +0,0 @@ -#!/usr/bin/env python3 -from datetime import datetime -from fastapi import APIRouter, HTTPException, Depends, status -from sqlalchemy.orm import Session -from sqlalchemy.future import select -from pydantic import BaseModel, validator -from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm -from api.v1.models.product import Product as ProductModel -from api.v1.schemas.product import ProductUpdate, ResponseModel -from api.db.database import engine, get_db -from api.v1.models.product import Product -from api.v1.services.product import product_service -from api.v1.models.user import User -from api.utils.dependencies import get_current_user -from uuid import UUID -from api.utils.config import SECRET_KEY, ALGORITHM -import jwt - - - - - -# Create a router for product-related endpoints -productupdate = APIRouter(prefix="/products", tags=["Products"]) - -""" - Update the details of an existing product. - - This endpoint updates a product's attributes such as name, price, description, and tag. - It ensures that the product exists before performing the update. The `updated_at` timestamp - is set to the current time to reflect when the update occurred. - - Args: - id (UUID): The unique identifier of the product to be updated. - product (ProductUpdate): The new product data to be updated. - current_user (User): The currently authenticated user, obtained from the `get_current_user` dependency. - db (Session): The database session, provided by the `get_db` dependency. - - Returns: - ProductUpdate: The updated product details. - - Raises: - HTTPException: If the product with the specified `id` does not exist, a 404 error is raised. - - Example: - PUT /product/123e4567-e89b-12d3-a456-426614174000 - { - "name": "New Product Name", - "price": 29.99, - "description": "Updated description", - } - """ - - - -@productupdate.put("/{id}", response_model=ResponseModel) -async def update_product( - id: str, - product_update: ProductUpdate, - current_user: User = Depends(get_current_user), - db: Session = Depends(get_db) -): - try: - updated_product = product_service.update(db=db, id=str(id), schema=product_update) - except HTTPException as e: - raise e - - # Prepare the response - response = ResponseModel( - success=True, - status_code=200, - message="Product updated successfully", - data={ - "id": updated_product.id, - "name": updated_product.name, - "price": updated_product.price, - "description": updated_product.description, - "updated_at": updated_product.updated_at - } - ) - - return response diff --git a/api/v1/routes/user.py b/api/v1/routes/user.py index 9da84275d..48ff1d4c5 100644 --- a/api/v1/routes/user.py +++ b/api/v1/routes/user.py @@ -1,16 +1,15 @@ -from fastapi import Depends, HTTPException, APIRouter, Request, Response, status -from jose import JWTError +from typing import Annotated, Optional, Literal +from fastapi import Depends, APIRouter, Request, status, Query, HTTPException +from fastapi.encoders import jsonable_encoder from sqlalchemy.orm import Session -from api.core.dependencies.email import mail_service -from fastapi.responses import JSONResponse from api.utils.success_response import success_response from api.v1.models.user import User from api.v1.schemas.user import ( DeactivateUserSchema, - UserBase, ChangePasswordSchema, - ChangePwdRet, + ChangePwdRet, AllUsersResponse, UserUpdate, + AdminCreateUserResponse, AdminCreateUser ) from api.db.database import get_db from api.v1.services.user import user_service @@ -19,79 +18,187 @@ user = APIRouter(prefix="/users", tags=["Users"]) -@user.get("/me", status_code=status.HTTP_200_OK, response_model=UserBase) +@user.get("/me", status_code=status.HTTP_200_OK, response_model=success_response) def get_current_user_details( db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user), ): """Endpoint to get current user details""" - return current_user + return success_response( + status_code=200, + message="User details retrieved successfully", + data=jsonable_encoder( + current_user, + exclude=[ + "password", + "is_super_admin", + "is_deleted", + "is_verified", + "updated_at", + ], + ), + ) -@user.post("/deactivation", status_code=status.HTTP_200_OK) -async def deactivate_account( - request: Request, - schema: DeactivateUserSchema, - db: Session = Depends(get_db), - current_user: User = Depends(user_service.get_current_user), -): - """Endpoint to deactivate a user account""" +@user.get('/delete', status_code=200) +async def delete_account(request: Request, db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user)): + '''Endpoint to delete a user account''' - reactivation_link = user_service.deactivate_user( - request=request, db=db, schema=schema, user=current_user - ) + # Delete current user + user_service.delete(db=db) return success_response( status_code=200, - message="User deactivation successful", - data={"reactivation_link": reactivation_link}, + message='User deleted successfully', ) -# @user.get('/current-user/delete', status_code=200) -# async def delete_account(request: Request, db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user)): -# '''Endpoint to delete a user account''' -# # Delete current user -# user_service.delete(db=db) +@user.patch("/me/password", status_code=200) +async def change_password( + schema: ChangePasswordSchema, + db: Session = Depends(get_db), + user: User = Depends(user_service.get_current_user), +): + """Endpoint to change the user's password""" -# return success_response( -# status_code=200, -# message='User deleted successfully', -# ) + user_service.change_password(schema.old_password, schema.new_password, user, db) + return success_response(status_code=200, message="Password changed successfully") -@user.get("/reactivation", status_code=200) -async def reactivate_account(request: Request, db: Session = Depends(get_db)): - """Endpoint to reactivate a user account""" - # Get access token from query - token = request.query_params.get("token") +@user.get(path="/{user_id}", status_code=status.HTTP_200_OK) +def get_user( + user_id : str, + current_user : Annotated[User , Depends(user_service.get_current_user)], + db : Session = Depends(get_db) +): + + user = user_service.fetch(db=db, id=user_id) - # reactivate user - user_service.reactivate_user(db=db, token=token) + return success_response( + status_code=status.HTTP_200_OK, + message='User retrieved successfully', + data = jsonable_encoder( + user, + exclude=['password', 'is_super_admin', 'is_deleted', 'is_verified', 'updated_at', 'created_at', 'is_active'] + ) + ) +@user.patch(path="/",status_code=status.HTTP_200_OK) +def update_current_user( + current_user : Annotated[User , Depends(user_service.get_current_user)], + schema : UserUpdate, + db : Session = Depends(get_db)): + + user = user_service.update(db=db, schema= schema, current_user=current_user) return success_response( - status_code=200, - message="User reactivation successful", + status_code=status.HTTP_200_OK, + message='User Updated Successfully', + data= jsonable_encoder( + user, + exclude=['password', 'is_super_admin', 'is_deleted', 'is_verified', 'updated_at', 'created_at', 'is_active'] + ) + ) +@user.patch(path="/{user_id}", status_code=status.HTTP_200_OK) +def update_user(user_id : str, + current_user : Annotated[User , Depends(user_service.get_current_super_admin)], + schema : UserUpdate, + db : Session = Depends(get_db) + ): + user = user_service.update(db=db, schema=schema, id=user_id, current_user=current_user) + + return success_response( + status_code=status.HTTP_200_OK, + message='User Updated Successfully', + data= jsonable_encoder( + user, + exclude=['password', 'is_super_admin', 'is_deleted', 'is_verified', 'updated_at', 'created_at', 'is_active'] + ) ) -@user.patch("/me/password", status_code=200, response_model=ChangePwdRet) -async def change_password( - schema: ChangePasswordSchema, +@user.delete(path="/{user_id}", status_code=status.HTTP_204_NO_CONTENT) +def delete_user( + user_id: str, + current_user: Annotated[User, Depends(user_service.get_current_super_admin)], db: Session = Depends(get_db), - user: User = Depends(user_service.get_current_user), ): - """Endpoint to change the user's password""" - - user_service.change_password(schema.old_password, schema.new_password, user, db) + """Endpoint for user deletion (soft-delete)""" + + """ + + Args: + user_id (str): User ID + current_user (User): Current logged in user + db (Session, optional): Database Session. Defaults to Depends(get_db). + + Raises: + HTTPException: 403 FORBIDDEN (Current user is not a super admin) + HTTPException: 404 NOT FOUND (User to be deleted cannot be found) + """ + + user = user_service.fetch(db=db, id=user_id) + + # soft-delete the user + user_service.delete(db=db, id=user_id) + +@user.get('/', status_code=status.HTTP_200_OK, response_model=AllUsersResponse) +async def get_users( + current_user: Annotated[User, Depends(user_service.get_current_super_admin)], + db: Annotated[Session, Depends(get_db)], + page: int = 1, per_page: int = 10, + is_active: Optional[bool] = Query(None), + is_deleted: Optional[bool] = Query(None), + is_verified: Optional[bool] = Query(None), + is_super_admin: Optional[bool] = Query(None) +): + """ + Retrieves all users. + Args: + current_user: The current user(admin) making the request + db: database Session object + page: the page number + per_page: the maximum size of users for each page + is_active: boolean to filter active users + is_deleted: boolean to filter deleted users + is_verified: boolean to filter verified users + is_super_admin: boolean to filter users that are super admin + Returns: + UserData + """ + query_params = { + 'is_active': is_active, + 'is_deleted': is_deleted, + 'is_verified': is_verified, + 'is_super_admin': is_super_admin, + } + return user_service.fetch_all(db, page, per_page, **query_params) + +@user.post("/", status_code=status.HTTP_201_CREATED, response_model=AdminCreateUserResponse) +def admin_registers_user(user_request: AdminCreateUser, + current_user: Annotated[User, Depends(user_service.get_current_super_admin)], + db: Session = Depends(get_db)): + ''' + Endpoint for an admin to register a user. + Args: + user_request: the body containing the user details to register + current_user: The superadmin registering the user + db: database Session object + Returns: + AdminCreateUserResponse: The full details of the newly created user + ''' + return user_service.super_admin_create_user(db, user_request) + + +@user.get('/{role_id}/roles', status_code=status.HTTP_200_OK) +async def get_users_by_role(role_id: Literal["admin", "user", "guest", "owner"], db: Session = Depends(get_db), current_user: User = Depends(user_service.get_current_user)): + '''Endpoint to get all users by role''' + users = user_service.get_users_by_role(db, role_id, current_user) - return JSONResponse( - content={ - "success": True, - "status_code": 200, - "message": "Password Changed successfully", - } - ) + return success_response( + status_code=200, + message='Users retrieved successfully', + data=jsonable_encoder(users) + ) \ No newline at end of file diff --git a/api/v1/routes/waitlist.py b/api/v1/routes/waitlist.py index d86048c01..b7599599e 100644 --- a/api/v1/routes/waitlist.py +++ b/api/v1/routes/waitlist.py @@ -1,6 +1,7 @@ #!/usr/bin/env python3 from api.utils.dependencies import get_super_admin +from api.utils.success_response import success_response from api.v1.schemas.waitlist import WaitlistAddUserSchema from api.utils.json_response import JsonResponseDict from fastapi.exceptions import HTTPException @@ -8,60 +9,74 @@ from fastapi import APIRouter, HTTPException, Depends, Request from sqlalchemy.orm import Session -from pydantic import BaseModel from api.v1.schemas.waitlist import WaitlistAddUserSchema -from api.v1.services.waitlist_email import send_confirmation_email, add_user_to_waitlist, find_existing_user +from api.v1.services.waitlist_email import ( + send_confirmation_email, + add_user_to_waitlist, + find_existing_user, +) from api.utils.logger import logger -from fastapi.responses import JSONResponse from api.db.database import get_db +from api.v1.services.waitlist import waitlist_service -waitlist = APIRouter(prefix="/waitlists", tags=["Waitlist"]) +waitlist = APIRouter(prefix="/waitlist", tags=["Waitlist"]) -class WaitlistResponse(BaseModel): - message: str -@waitlist.post("/", response_model=WaitlistResponse, status_code=201) +@waitlist.post("/", response_model=success_response, status_code=201) async def waitlist_signup( - request: Request, - user: WaitlistAddUserSchema, - db: Session = Depends(get_db) + request: Request, user: WaitlistAddUserSchema, db: Session = Depends(get_db) ): if not user.full_name: logger.error("Full name is required") - raise HTTPException(status_code=422, detail={"message": "Full name is required", - "success": False, "status_code": 422}) + raise HTTPException( + status_code=422, + detail={ + "message": "Full name is required", + "success": False, + "status_code": 422, + }, + ) existing_user = find_existing_user(db, user.email) if existing_user: logger.error(f"Email already registered: {user.email}") - raise HTTPException(status_code=400, detail={"message": "Email already registered", - "success": False, "status_code": 400}) + raise HTTPException( + status_code=400, + detail={ + "message": "Email already registered", + "success": False, + "status_code": 400, + }, + ) db_user = add_user_to_waitlist(db, user.email, user.full_name) try: - await send_confirmation_email(user.email, user.full_name) + # await send_confirmation_email(user.email, user.full_name) logger.info(f"Confirmation email sent successfully to {user.email}") except HTTPException as e: logger.error(f"Failed to send confirmation email: {e.detail}") raise HTTPException( - status_code=500, detail={"message": "Failed to send confirmation email", - "success": False, "status_code": 500}) + status_code=500, + detail={ + "message": "Failed to send confirmation email", + "success": False, + "status_code": 500, + }, + ) logger.info(f"User signed up successfully: {user.email}") - return JSONResponse(content={"message": "You are all signed up!"}, status_code=201) + return success_response(message="You are all signed up!", status_code=201) + @waitlist.post( "/admin", - responses={400: {"message": "Validation error"}, - 403: {"message": "Forbidden"}}, + responses={400: {"message": "Validation error"}, 403: {"message": "Forbidden"}}, ) - def admin_add_user_to_waitlist( item: WaitlistAddUserSchema, admin=Depends(get_super_admin), - db: Session = Depends(get_db) - + db: Session = Depends(get_db), ): """ Manually adds a user to the waitlist. @@ -78,23 +93,39 @@ def admin_add_user_to_waitlist( - 400: Validation error - 403: Forbidden """ + try: if len(item.full_name) == 0: detail = "full_name field cannot be blank" raise HTTPException(status_code=400, detail=detail) - - if obj:= find_existing_user(db, item.email): + + if obj := find_existing_user(db, item.email): raise IntegrityError("Duplicate entry", {}, None) - + new_waitlist_user = add_user_to_waitlist(db, **item.model_dump()) except IntegrityError: detail = "Email already added" raise HTTPException(status_code=400, detail=detail) - resp = { - "message": "User added to waitlist successfully", - "status_code": 201, - "data": {"email": item.email, "full_name": item.full_name}, - } + return success_response( + message="User added to waitlist successfully", + status_code=201, + data={"email": item.email, "full_name": item.full_name}, + ) - return JsonResponseDict(**resp) \ No newline at end of file + return JsonResponseDict(**resp) + +@waitlist.get("/users", response_model=success_response, status_code=200) +async def get_all_waitlist_emails( + request: Request, + db: Session = Depends(get_db), + admin=Depends(get_super_admin) +): + waitlist_users = waitlist_service.fetch_all(db) + emails = [{"email": user.email, "full_name": user.full_name} for user in waitlist_users] + + return success_response( + message="Waitlist retrieved successfully", + status_code=200, + data=emails + ) diff --git a/api/v1/schemas/activity_logs.py b/api/v1/schemas/activity_logs.py new file mode 100644 index 000000000..eb0b0f6f5 --- /dev/null +++ b/api/v1/schemas/activity_logs.py @@ -0,0 +1,14 @@ +from pydantic import BaseModel +from datetime import datetime + + + +class ActivityLogCreate(BaseModel): + user_id: str + action: str + + +class ActivityLogResponse(BaseModel): + action: str + user_id: str + timestamp: datetime diff --git a/api/v1/schemas/analytics.py b/api/v1/schemas/analytics.py new file mode 100644 index 000000000..97ad8cd3f --- /dev/null +++ b/api/v1/schemas/analytics.py @@ -0,0 +1,36 @@ +from pydantic import BaseModel +from typing import List, Dict, Union + + +class AnalyticsChartsResponse(BaseModel): + """ + Schema Response for analytics line charts + """ + status: str + status_code: int + message: str + data: Dict + + +class MetricData(BaseModel): + value: int | float + percentage_increase: float + + +class SuperAdminMetrics(BaseModel): + total_revenue: MetricData + total_products: MetricData + total_users: MetricData + lifetime_sales: MetricData + +class UserMetrics(BaseModel): + total_revenue: MetricData + subscriptions: MetricData + sales: MetricData + active_now: MetricData + +class AnalyticsSummaryResponse(BaseModel): + message: str + status: str + status_code: int + data: List[Dict[str, Union[float, int, MetricData]]] diff --git a/api/v1/schemas/blog.py b/api/v1/schemas/blog.py index ac9360dd4..1f8b6471f 100644 --- a/api/v1/schemas/blog.py +++ b/api/v1/schemas/blog.py @@ -1,8 +1,7 @@ from datetime import datetime from typing import List, Optional -from uuid import UUID -from pydantic import BaseModel, Field, HttpUrl +from pydantic import BaseModel, Field class BlogCreate(BaseModel): @@ -25,8 +24,8 @@ class BlogUpdateResponseModel(BaseModel): class BlogResponse(BaseModel): - id: UUID - author_id: UUID + id: str + author_id: str title: str content: str image_url: Optional[str] @@ -54,3 +53,17 @@ class BlogPostResponse(BaseModel): class Config: from_attributes = True + + +class BlogLikeDislikeCreate(BaseModel): + id: str + blog_id: str + user_id: str + ip_address: Optional[str] + created_at: datetime + + +class BlogLikeDislikeResponse(BaseModel): + status_code: str + message: str + data: BlogLikeDislikeCreate diff --git a/api/v1/schemas/comment.py b/api/v1/schemas/comment.py new file mode 100644 index 000000000..c865a747b --- /dev/null +++ b/api/v1/schemas/comment.py @@ -0,0 +1,113 @@ +from datetime import datetime +from typing_extensions import Annotated, List +from pydantic import BaseModel, StringConstraints, ConfigDict + + +class CommentCreate(BaseModel): + content: Annotated[str, StringConstraints(strip_whitespace=True, min_length=1)] + + +class CommentData(BaseModel): + id: str + user_id: str + blog_id: str + content: str + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True + + +class CommentSuccessResponse(BaseModel): + status_code: int = 201 + message: str + success: bool = True + data: CommentData + + +class CommentDislike(BaseModel): + id: str = "" + comment_id: str = "" + user_id: str = "" + ip_address: str = "" + created_at: datetime = "" + updated_at: datetime = "" + + model_config = ConfigDict(from_attributes=True) + + +class DislikeSuccessResponse(BaseModel): + status_code: int = 201 + message: str + success: bool = True + data: CommentDislike + + +class LikeSchema(BaseModel): + """ + Schema for likes + """ + + user_id: str = "" + comment_id: str = "" + + model_config = ConfigDict(from_attributes=True) + + +class CommentsSchema(BaseModel): + """ + Schema for Comments + """ + + user_id: str = "" + blog_id: str = "" + content: str = "" + likes: List[LikeSchema] = [] + dislikes: List[CommentDislike] = [] + created_at: datetime = datetime.now() + + model_config = ConfigDict(from_attributes=True) + + +class CommentsResponse(BaseModel): + """ + Schema for comments response + """ + + page: int = 1 + per_page: int = 20 + total: int = 0 + data: List[CommentsSchema] = [] + + +class CommentLike(BaseModel): + id: str + comment_id: str + user_id: str + ip_address: str + created_at: datetime + updated_at: datetime + + +class LikeSuccessResponse(BaseModel): + status_code: int = 201 + message: str + success: bool = True + data: CommentLike + + +class CommentLike(BaseModel): + id: str + comment_id: str + user_id: str + ip_address: str + created_at: datetime + updated_at: datetime + + +class LikeSuccessResponse(BaseModel): + status_code: int = 201 + message: str + success: bool = True + data: CommentLike diff --git a/api/v1/schemas/contact.py b/api/v1/schemas/contact.py new file mode 100644 index 000000000..b1131e162 --- /dev/null +++ b/api/v1/schemas/contact.py @@ -0,0 +1,15 @@ +from pydantic import BaseModel, EmailStr + + +class AdminGet200Data(BaseModel): + full_name: str + email: EmailStr + title: str + message: str + + +class AdminGet200Response(BaseModel): + status_code: int = 200 + status: str = "success" + message: str = "Message retrieved successfully" + data: dict diff --git a/api/v1/schemas/contact_us.py b/api/v1/schemas/contact_us.py new file mode 100644 index 000000000..f07969f22 --- /dev/null +++ b/api/v1/schemas/contact_us.py @@ -0,0 +1,20 @@ +from pydantic import BaseModel, EmailStr + + +class ContactUsResponseSchema(BaseModel): + full_name: str + email: EmailStr + title: str # Need review on this > to be converted to phone_number base on what I see on FE + message: str + + class Config: + from_attributes = True + + +class CreateContactUs(BaseModel): + """Validate the contact us form data.""" + + full_name: str + email: EmailStr + phone_number: str + message: str diff --git a/api/v1/schemas/dashboard.py b/api/v1/schemas/dashboard.py new file mode 100644 index 000000000..c0653f6db --- /dev/null +++ b/api/v1/schemas/dashboard.py @@ -0,0 +1,37 @@ +from typing import List +from datetime import datetime +from pydantic import BaseModel + + + +class DashboardProductBase(BaseModel): + name: str + description: str + price: str + category: str + quantity: int + image_url: str + archived: bool + created_at: datetime + + +class DashboardResponseBase(BaseModel): + status_code: int = 200 + success: bool + message: str + + +class ProductCountBase(BaseModel): + count: int + + +class DashboardProductCountResponse(DashboardResponseBase): + data: ProductCountBase + + +class DashboardSingleProductResponse(DashboardResponseBase): + data: DashboardProductBase + + +class DashboardProductListResponse(DashboardResponseBase): + data: List[DashboardProductBase] diff --git a/api/v1/schemas/data_privacy.py b/api/v1/schemas/data_privacy.py new file mode 100644 index 000000000..6b531a672 --- /dev/null +++ b/api/v1/schemas/data_privacy.py @@ -0,0 +1,16 @@ +from pydantic import BaseModel +from typing import Optional + + +class DataPrivacySettingUpdate(BaseModel): + profile_visibility: Optional[bool] = None + share_data_with_partners: Optional[bool] = None + receice_email_updates: Optional[bool] = None + enable_two_factor_authentication: Optional[bool] = None + use_data_encryption: Optional[bool] = None + allow_analytics: Optional[bool] = None + personalized_ads: Optional[bool] = None + + class Config: + from_attributes = True + populate_by_name = True diff --git a/api/v1/schemas/email_schema.py b/api/v1/schemas/email_schema.py new file mode 100644 index 000000000..d3d364aae --- /dev/null +++ b/api/v1/schemas/email_schema.py @@ -0,0 +1,8 @@ +from pydantic import BaseModel, EmailStr +from typing import Optional + +class EmailRequest(BaseModel): + to_email: EmailStr + subject: str + body: str + from_name: Optional[str] = None \ No newline at end of file diff --git a/api/v1/schemas/email_template.py b/api/v1/schemas/email_template.py new file mode 100644 index 000000000..1862866db --- /dev/null +++ b/api/v1/schemas/email_template.py @@ -0,0 +1,43 @@ +from pydantic import BaseModel, field_validator +import bleach + +ALLOWED_TAGS = [ + 'a', 'abbr', 'acronym', 'b', 'blockquote', 'code', 'em', 'i', 'li', + 'ol', 'strong', 'ul', 'h1', 'h2', 'h3', 'p', 'br', 'span', 'div', 'table', + 'tr', 'td' +] +ALLOWED_ATTRIBUTES = { + 'a': ['style', 'href', 'title', 'target'], + 'img': ['src', 'alt'], + 'span': ['style'], + 'div': ['style'], + 'p': ['style'], + 'table': ['style'], + 'tr': ['style'], + 'td': ['style'], +} +ALLOWED_STYLES = [ + 'color', 'font-weight', 'background-color', 'font-size', 'margin', 'padding' +] + + +def sanitize_html(template: str) -> str: + cleaned_html = bleach.clean( + template, + tags=ALLOWED_TAGS, + attributes=ALLOWED_ATTRIBUTES, + strip=False + ) + return cleaned_html + +class EmailTemplateSchema(BaseModel): + + title: str + template: str + type: str + status: str = 'online' + + @field_validator("template") + @classmethod + def template_validator(cls, value): + return sanitize_html(value) diff --git a/api/v1/schemas/faq.py b/api/v1/schemas/faq.py new file mode 100644 index 000000000..1bf42b862 --- /dev/null +++ b/api/v1/schemas/faq.py @@ -0,0 +1,29 @@ +from datetime import datetime +from typing import Optional +from pydantic import BaseModel + + +class FAQBase(BaseModel): + """Base schema for FAQ""" + + id: str + question: str + answer: str + created_at: datetime + updated_at: datetime + + +class CreateFAQ(BaseModel): + """Schema for creating FAQ""" + + question: str + answer: str + category: str + + +class UpdateFAQ(BaseModel): + """Schema for updating FAQ""" + + question: Optional[str] + answer: Optional[str] + category: Optional[str] diff --git a/api/v1/schemas/google_oauth.py b/api/v1/schemas/google_oauth.py index 5a11c8aea..caf83b7ce 100644 --- a/api/v1/schemas/google_oauth.py +++ b/api/v1/schemas/google_oauth.py @@ -1,34 +1,42 @@ from datetime import datetime from pydantic import BaseModel, EmailStr + class UserData(BaseModel): """ Schema Response representing the validated google login """ + id: str first_name: str last_name: str - username: str email: EmailStr created_at: datetime class Config: from_attributes = True + class Tokens(BaseModel): """ Schema representing tokens """ + access_token: str refresh_token: str token_type: str + class StatusResponse(BaseModel): """ Schema Response to the end user """ + message: str status: str statusCode: int tokens: Tokens - user: UserData \ No newline at end of file + user: UserData + +class OAuthToken(BaseModel): + id_token: str diff --git a/api/v1/schemas/invitations.py b/api/v1/schemas/invitations.py index 55037e753..6d8d3dcd8 100644 --- a/api/v1/schemas/invitations.py +++ b/api/v1/schemas/invitations.py @@ -1,9 +1,10 @@ -from pydantic import BaseModel +from pydantic import BaseModel, EmailStr + class UserAddToOrganization(BaseModel): invitation_link: str class InvitationCreate(BaseModel): - user_id: str - organization_id: str \ No newline at end of file + user_email: EmailStr + organization_id: str diff --git a/api/v1/schemas/job_application.py b/api/v1/schemas/job_application.py new file mode 100644 index 000000000..b06c7afea --- /dev/null +++ b/api/v1/schemas/job_application.py @@ -0,0 +1,107 @@ +""" +Job application schemas +""" +from pydantic import BaseModel, ConfigDict, EmailStr, field_validator + +from typing import Union, Optional, List +import re + +class JobApplicationData(BaseModel): + """ + Schema for job application base + """ + job_id: str + applicant_name: str + applicant_email: str + resume_link: str + portfolio_link: Union[str, None] + cover_letter: Union[str, None] + application_status: str + + model_config = ConfigDict(from_attributes=True) + +class JobApplicationBase(BaseModel): + """ + Schema for job application base + """ + job_id: str + applicant_name: str + applicant_email: EmailStr + resume_link: str + portfolio_link: Union[str, None] + cover_letter: Union[str, None] + application_status: str + + model_config = ConfigDict(from_attributes=True) + +class JobApplicationResponseData(BaseModel): + """ + Schema for job application data + """ + + page: int = 1 + per_page: int = 20 + total_pages: int = 0 + applications: List[JobApplicationBase] = [] + +class JobApplicationResponse(BaseModel): + status_code: int = 200 + message: str + success: bool = True + data: JobApplicationResponseData + + +class SingleJobAppResponse(BaseModel): + """ + Single job application response schema + """ + status: str + message: str + status_code: int + data: JobApplicationBase + + +class CreateJobApplication(BaseModel): + '''Schema for creating job application''' + + applicant_name: str + applicant_email: EmailStr + cover_letter: str + resume_link: str + portfolio_link: Optional[str] = None + application_status: str = 'pending' + + @field_validator('resume_link', 'portfolio_link') + def validate_links(cls, v): + # Regular expression pattern to match valid URLs + url_regex = re.compile( + r'^(https?:\/\/)?' # optional scheme + r'((([a-zA-Z0-9\-]+)\.)+[a-zA-Z]{2,})' # domain + r'(\/[^\s]*)?$' # path + ) + if not url_regex.match(v): + raise ValueError('Invalid URL format') + return v + + +class UpdateJobApplication(BaseModel): + '''Schema for updating job application''' + + applicant_name: Optional[str] = None + applicant_email: Optional[EmailStr] = None + cover_letter: Optional[str] = None + resume_link: Optional[str] = None + portfolio_link: Optional[str] = None + application_status: Optional[str] = None + + @field_validator('resume_link', 'portfolio_link') + def validate_links(cls, v): + # Regular expression pattern to match valid URLs + url_regex = re.compile( + r'^(https?:\/\/)?' # optional scheme + r'((([a-zA-Z0-9\-]+)\.)+[a-zA-Z]{2,})' # domain + r'(\/[^\s]*)?$' # path + ) + if not url_regex.match(v): + raise ValueError('Invalid URL format') + return v diff --git a/api/v1/schemas/jobs.py b/api/v1/schemas/jobs.py new file mode 100644 index 000000000..e8205327a --- /dev/null +++ b/api/v1/schemas/jobs.py @@ -0,0 +1,36 @@ +from pydantic import EmailStr, BaseModel +from typing import Optional +from datetime import datetime + + +class PostJobSchema(BaseModel): + """Pydantic Model for adding user to waitlist""" + + title: str + description: str + department: Optional[str] = None + location: Optional[str] = None + salary: Optional[str] = None + job_type: Optional[str] = None + company_name: Optional[str] = None + + +class AddJobSchema(PostJobSchema): + author_id: str + + +class JobCreateResponseSchema(PostJobSchema): + id: str + created_at: datetime + + class Config: + from_attributes = True + +class UpdateJobSchema(BaseModel): + title: Optional[str] = None + description: Optional[str] = None + department: Optional[str] = None + location: Optional[str] = None + salary: Optional[str] = None + job_type: Optional[str] = None + company_name: Optional[str] = None \ No newline at end of file diff --git a/api/v1/schemas/newsletter.py b/api/v1/schemas/newsletter.py index 9e8ed5e3b..c847966db 100644 --- a/api/v1/schemas/newsletter.py +++ b/api/v1/schemas/newsletter.py @@ -1,8 +1,32 @@ from pydantic import BaseModel, EmailStr +from datetime import datetime -class EMAILSCHEMA(BaseModel): +class EmailSchema(BaseModel): """ pydantic model for data validation and serialization """ - email: EmailStr \ No newline at end of file + + email: EmailStr + + +class EmailRetrieveSchema(EmailSchema): + + class Config: + from_attributes = True + +class NewsletterBase(BaseModel): + title: str + description: str + content: str + created_at: datetime + updated_at: datetime + +class SingleNewsletterResponse(BaseModel): + """Schema for single newsletter + """ + status_code: int = 200 + message: str + success: bool = True + data: NewsletterBase + diff --git a/api/v1/schemas/notification.py b/api/v1/schemas/notification.py new file mode 100644 index 000000000..f3f3e053c --- /dev/null +++ b/api/v1/schemas/notification.py @@ -0,0 +1,23 @@ +from pydantic import BaseModel +from datetime import datetime + + +class NotificationBase(BaseModel): + id: str + title: str + message: str + status: str + + +class NotificationCreate(BaseModel): + title: str + message: str + + +class NotificationRead(NotificationBase): + id: str + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True diff --git a/api/v1/schemas/notification_settings.py b/api/v1/schemas/notification_settings.py new file mode 100644 index 000000000..e6341988a --- /dev/null +++ b/api/v1/schemas/notification_settings.py @@ -0,0 +1,14 @@ +from pydantic import BaseModel + + +class NotificationSettingsBase(BaseModel): + '''Base schema for notification settings''' + + mobile_push_notifications: bool + email_notification_activity_in_workspace: bool + email_notification_always_send_email_notifications: bool + email_notification_email_digest: bool + email_notification_announcement_and_update_emails: bool + slack_notifications_activity_on_your_workspace: bool + slack_notifications_always_send_email_notifications: bool + slack_notifications_announcement_and_update_emails: bool diff --git a/api/v1/schemas/organization.py b/api/v1/schemas/organization.py new file mode 100644 index 000000000..91bb35f8b --- /dev/null +++ b/api/v1/schemas/organization.py @@ -0,0 +1,67 @@ +from datetime import datetime +from typing import Dict, List +from pydantic import BaseModel, EmailStr, field_validator +from typing import Optional + +from api.utils.success_response import success_response + +class OrganizationBase(BaseModel): + """Base organization schema""" + + id: str + created_at: datetime + updated_at: datetime + name: str + email: Optional[EmailStr] = None + industry: Optional[str] = None + type: Optional[str] = None + country: Optional[str] = None + state: Optional[str] = None + address: Optional[str] = None + description: Optional[str] = None + + +class CreateUpdateOrganization(BaseModel): + """Organization schema to create or update organization""" + + name: str + email: Optional[EmailStr] = None + industry: Optional[str] = None + type: Optional[str] = None + country: Optional[str] = None + state: Optional[str] = None + address: Optional[str] = None + description: Optional[str] = None + + +class AddUpdateOrganizationRole(BaseModel): + """Schema to update a user role in an organization""" + + role: str + user_id: str + org_id: str + + @field_validator("role") + def role_validator(cls, value): + if value not in ["admin", "user", "guest", "owner"]: + raise ValueError("Role has to be one of admin, guest, user, or owner") + return value + + +class RemoveUserFromOrganization(BaseModel): + """Schema to delete a user role in an organization""" + + user_id: str + org_id: str + + +class PaginatedOrgUsers(BaseModel): + """Describe response object for paginated users in organization""" + page: int + per_page: int + per_page: int + total: int + status_code: int + success: bool + message: str + data: List[Dict] diff --git a/api/v1/schemas/payment.py b/api/v1/schemas/payment.py new file mode 100644 index 000000000..9283ac8a5 --- /dev/null +++ b/api/v1/schemas/payment.py @@ -0,0 +1,50 @@ +from pydantic import BaseModel, EmailStr +from typing import List +from typing import Optional +from datetime import datetime + + +class PaymentResponse(BaseModel): + id: str + user_id: str + amount: float + currency: str + status: str + method: str + transaction_id: str + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True + + +class PaymentBase(BaseModel): + amount: float + currency: str + status: str + method: str + created_at: datetime + + +class PaymentsData(BaseModel): + current_page: int + total_pages: int + limit: int + total_items: int + Payments: List[PaymentBase] + + +class PaymentListResponse(BaseModel): + status_code: int = 200 + success: bool + message: str + data: PaymentsData + + +class PaymentDetail(BaseModel): + organization_id: str + plan_id: str + full_name: str + billing_option: str + redirect_url: str \ No newline at end of file diff --git a/api/v1/schemas/permissions/__init_.py b/api/v1/schemas/permissions/__init_.py new file mode 100644 index 000000000..e69de29bb diff --git a/api/v1/schemas/permissions/permissions.py b/api/v1/schemas/permissions/permissions.py new file mode 100644 index 000000000..51455044a --- /dev/null +++ b/api/v1/schemas/permissions/permissions.py @@ -0,0 +1,19 @@ +from pydantic import BaseModel +from uuid_extensions import uuid7 + + +class PermissionCreate(BaseModel): + name: str + +class PermissionResponse(BaseModel): + id: str + name: str + + class Config: + from_attributes = True + +class PermissionAssignRequest(BaseModel): + permission_id: str + +class PermissionUpdate(BaseModel): + new_permission_id: str \ No newline at end of file diff --git a/api/v1/schemas/permissions/roles.py b/api/v1/schemas/permissions/roles.py new file mode 100644 index 000000000..ed2f431aa --- /dev/null +++ b/api/v1/schemas/permissions/roles.py @@ -0,0 +1,30 @@ +from pydantic import BaseModel +from uuid_extensions import uuid7 +from typing import Dict, Any, Optional + + +class RoleCreate(BaseModel): + name: str + +class RoleResponse(BaseModel): + id: str + name: str + + class Config: + from_attributes = True + +class RoleAssignRequest(BaseModel): + role_id: str + + +class RoleDeleteResponse(BaseModel): + id: str + message: str + + class Config: + orm_mode = True + + from_attributes = True + + + diff --git a/api/v1/schemas/plans.py b/api/v1/schemas/plans.py index ac6455f0e..b5b267baf 100644 --- a/api/v1/schemas/plans.py +++ b/api/v1/schemas/plans.py @@ -1,17 +1,19 @@ from pydantic import BaseModel from typing import List, Optional -import uuid + class CreateSubscriptionPlan(BaseModel): name: str description: Optional[str] = None price: int duration: str + currency: str + organization_id: str features: List[str] - - + + class SubscriptionPlanResponse(CreateSubscriptionPlan): - id: uuid.UUID - + id: str + class Config: - orm_mode = True \ No newline at end of file + from_attributes = True diff --git a/api/v1/schemas/privacy_policies.py b/api/v1/schemas/privacy_policies.py new file mode 100644 index 000000000..325d65b04 --- /dev/null +++ b/api/v1/schemas/privacy_policies.py @@ -0,0 +1,14 @@ +from pydantic import BaseModel + +class PrivacyPolicyCreate(BaseModel): + content: str + +class PrivacyPolicyUpdate(BaseModel): + content: str + +class PrivacyPolicyResponse(BaseModel): + id: int + content: str + + class Config: + from_attributes = True diff --git a/api/v1/schemas/product.py b/api/v1/schemas/product.py index f3f19ee71..ab6436f56 100644 --- a/api/v1/schemas/product.py +++ b/api/v1/schemas/product.py @@ -1,7 +1,9 @@ -from pydantic import BaseModel, Field, PositiveFloat -from typing import List, Optional, Any, Dict +from pydantic import BaseModel, EmailStr, Field, PositiveFloat +from typing import List, Optional, Any, Dict, TypeVar, Generic from datetime import datetime +T = TypeVar("T") + class ProductUpdate(BaseModel): """ @@ -9,7 +11,7 @@ class ProductUpdate(BaseModel): This model is used for validating and serializing data when updating a product in the system. It ensures that the `name` field is a required - string, the `price` is a positive float, and the `updated_at` field + string, the `price` is a positive float, and the `updated_at` field is a datetime object that indicates when the product was last updated. Attributes: @@ -18,26 +20,28 @@ class ProductUpdate(BaseModel): description (Optional[str]): An optional description of the product. updated_at (datetime): The date and time when the product was last updated. """ + name: str = Field(..., alias="name", description="Name of the product") price: PositiveFloat description: Optional[str] = None updated_at: Optional[datetime] = None class Config: - orm_mode = True - allow_population_by_field_name = True + from_attributes = True + populate_by_name = True class ResponseModel(BaseModel): """ A model to structure the response for the Product Update endpoint - + Attributes: success (bool): Indicates if the request was successful. status_code (int): HTTP status code of the response. message (str): A message describing the result. data (Optional[Dict[str, Any]]): Optional data payload of the respons """ + success: bool status_code: int message: str @@ -49,6 +53,7 @@ class ProductBase(BaseModel): description: float price: float + class ProductData(BaseModel): current_page: int total_pages: int @@ -56,9 +61,112 @@ class ProductData(BaseModel): total_items: int products: List[ProductBase] + +class ProductStockResponse(BaseModel): + product_id: str + current_stock: int + last_updated: datetime + + class ProductList(BaseModel): status_code: int = 200 success: bool message: str data: ProductData - \ No newline at end of file + + +class ProductCategoryBase(BaseModel): + id: str + name: str + + +class ProductVariantBase(BaseModel): + id: str + size: str + price: float + stock: int + + +class ProductDetailOrganization(BaseModel): + id: str + company_name: str + company_email: EmailStr | None = None + industry: str | None = None + organization_type: str | None = None + country: str | None = None + state: str | None = None + address: str | None = None + lga: str | None = None + created_at: datetime + updated_at: datetime + + +class ProductDetail(BaseModel): + id: str + name: str + description: str | None = None + price: float + organization: ProductDetailOrganization + quantity: int + image_url: str + status: str + archived: bool + variants: list[ProductVariantBase] + category: ProductCategoryBase + + class Config: + from_attributes = True + + +class ProductDetailResponse(BaseModel): + success: bool + status_code: int + message: str + data: ProductDetail + + +# status filter +class ProductFilterResponse(BaseModel): + id: str + name: str + description: Optional[str] = None + price: float + org_id: str + category_id: str + quantity: Optional[int] = 0 + image_url: str + status: str + archived: Optional[bool] = False + filter_status: Optional[str] = None + created_at: datetime + updated_at: datetime + + class Config: + from_attributes = True + + +class SuccessResponse(BaseModel, Generic[T]): + message: str + status_code: int + data: T + + +class ProductCreate(BaseModel): + name: str + category: str + price: PositiveFloat + description: str = None + quantity: int = 0 + image_url: str = "placeholder-image" + +class ProductCategoryRetrieve(BaseModel): + name: str + id: str + class Config: + from_attributes = True + +class ProductCategoryCreate(BaseModel): + name: str + +class ProductCategoryData(BaseModel): + name: str diff --git a/api/v1/schemas/profile.py b/api/v1/schemas/profile.py index de6f3a0cb..7bd71cdb1 100644 --- a/api/v1/schemas/profile.py +++ b/api/v1/schemas/profile.py @@ -1,42 +1,76 @@ -from datetime import datetime -from fastapi import HTTPException -from pydantic import BaseModel, Field, EmailStr, field_validator -from typing import Any, Optional -from uuid_extensions import uuid7 -import re -from api.v1.schemas.user import UserBase - -class ProfileBase(BaseModel): - '''Base profile schema''' - - id: str - created_at: datetime - pronouns: str - job_title: str - department: str - social: str - bio: str - phone_number:str - avatar_url:str - recovery_email:Optional[EmailStr] - user: UserBase - - -class ProfileCreateUpdate(BaseModel): - '''Schema to create a profile''' - - pronouns: str - job_title: str - department: str - social: str - bio: str - phone_number:str - avatar_url:str - recovery_email:Optional[EmailStr] - - @field_validator('phone_number') - def phone_number_validator(cls, value): - if not re.match(r'^\+?[1-9]\d{1,14}$', value): - raise ValueError('Please use a valid phone number format') - return value - \ No newline at end of file +from datetime import datetime +from pydantic import BaseModel, EmailStr, field_validator +from typing import Optional +import re +from api.v1.schemas.user import UserBase + + +class ProfileBase(BaseModel): + """ + Pydantic model for a profile. + + This model is used for validating and serializing data related to a user's profile. + It ensures that various fields are correctly formatted and handles optional fields. + + Attributes: + id (str): The unique identifier of the profile. + created_at (datetime): The date and time when the profile was created. + pronouns (str): The pronouns of the user. + job_title (str): The job title of the user. + department (str): The department where the user works. + social (str): The social media handle or URL of the user. + bio (str): A brief biography of the user. + phone_number (str): The user's phone number. + avatar_url (str): The URL to the user's avatar image. + recovery_email (Optional[EmailStr]): The user's recovery email address. + user (UserBase): The user information associated with this profile. + updated_at (datetime): The date and time when the profile was last updated. + """ + + id: str + created_at: datetime + pronouns: str + job_title: str + department: str + social: str + bio: str + phone_number: str + avatar_url: str + recovery_email: Optional[EmailStr] + user: UserBase + + +class ProfileCreateUpdate(BaseModel): + """ + Pydantic model for creating or updating a profile. + + This model is used for validating and serializing data when creating or updating + a user's profile in the system. It ensures that various fields are correctly formatted + and handles optional fields for partial updates. + + Attributes: + pronouns (Optional[str]): The pronouns of the user. + job_title (Optional[str]): The job title of the user. + department (Optional[str]): The department where the user works. + social (Optional[str]): The social media handle or URL of the user. + bio (Optional[str]): A brief biography of the user. + phone_number (Optional[str]): The user's phone number. + avatar_url (Optional[str]): The URL to the user's avatar image. + recovery_email (Optional[EmailStr]): The user's recovery email address. + """ + + pronouns: Optional[str] = None + job_title: Optional[str] = None + department: Optional[str] = None + social: Optional[str] = None + bio: Optional[str] = None + phone_number: Optional[str] = None + avatar_url: Optional[str] = None + recovery_email: Optional[EmailStr] = None + + @field_validator("phone_number") + @classmethod + def phone_number_validator(cls, value): + if value and not re.match(r"^\+?[1-9]\d{1,14}$", value): + raise ValueError("Please use a valid phone number format") + return value diff --git a/api/v1/schemas/regions.py b/api/v1/schemas/regions.py new file mode 100644 index 000000000..ae4f10dc0 --- /dev/null +++ b/api/v1/schemas/regions.py @@ -0,0 +1,22 @@ +from pydantic import BaseModel +from typing import Optional, List + +class RegionCreate(BaseModel): + region: str + language: str + timezone: str + +class RegionUpdate(BaseModel): + region: Optional[str] = None + language: Optional[str] = None + timezone: Optional[str] = None + +class RegionOut(BaseModel): + id: str + user_id: str + region: Optional[str] = None + language: Optional[str] = None + timezone: Optional[str] = None + + class Config: + from_attributes = True \ No newline at end of file diff --git a/api/v1/schemas/request_password_reset.py b/api/v1/schemas/request_password_reset.py new file mode 100644 index 000000000..e7a338fc6 --- /dev/null +++ b/api/v1/schemas/request_password_reset.py @@ -0,0 +1,22 @@ +from pydantic import BaseModel, EmailStr, Field, field_validator +import re + + +class RequestEmail(BaseModel): + user_email: EmailStr + + +class ResetPassword(BaseModel): + new_password: str = Field(min_length=8) + confirm_new_password: str = Field(min_length=8) + + @field_validator("new_password") + def password_validator(cls, value): + if not re.match( + r"^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&])[A-Za-z\d@$!%*?&]{8,}$", + value, + ): + raise ValueError( + "Password must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one digit and one special character." + ) + return value diff --git a/api/v1/schemas/role.py b/api/v1/schemas/role.py index 524057d17..21212f64c 100644 --- a/api/v1/schemas/role.py +++ b/api/v1/schemas/role.py @@ -1,11 +1,13 @@ from pydantic import BaseModel -from typing import List, Optional +from typing import List + class RoleCreate(BaseModel): role_name: str organization_id: str permission_ids: List[str] + class ResponseModel(BaseModel): message: str - status_code: int \ No newline at end of file + status_code: int diff --git a/api/v1/schemas/sms_twilio.py b/api/v1/schemas/sms_twilio.py new file mode 100644 index 000000000..c7c73d556 --- /dev/null +++ b/api/v1/schemas/sms_twilio.py @@ -0,0 +1,27 @@ +from pydantic import BaseModel, Field, field_validator +import re + +class SMSRequest(BaseModel): + phone_number: str = Field(..., example="+1234567890") + message: str = Field(..., example="Hello from HNG!") + + @field_validator('phone_number') + def validate_phone_number(cls, value): + phone_number_pattern = re.compile(r'^\+?[1-9]\d{8,14}$') + if not phone_number_pattern.match(value): + raise ValueError('Invalid phone number format') + return value + + @field_validator('message') + def validate_message(cls, value): + if not value.strip(): + raise ValueError('Message cannot be empty') + return value + + class Config: + json_schema_extra = { + "example": { + "phone_number": "+1234567890", + "message": "Hello from HNG!" + } + } \ No newline at end of file diff --git a/api/v1/schemas/squeeze.py b/api/v1/schemas/squeeze.py new file mode 100644 index 000000000..785dd959c --- /dev/null +++ b/api/v1/schemas/squeeze.py @@ -0,0 +1,23 @@ +from pydantic import BaseModel, EmailStr +from enum import Enum + +class SqueezeStatusEnum(str, Enum): + online = "online" + offline = "offline" + + +class CreateSqueeze(BaseModel): + title: str + email: EmailStr + user_id: str + url_slug: str = None + headline: str = None + sub_headline: str = None + body: str = None + type: str = "product" + status: SqueezeStatusEnum = SqueezeStatusEnum.offline + full_name: str = None + + +class FilterSqueeze(BaseModel): + status: SqueezeStatusEnum = None diff --git a/api/v1/schemas/team.py b/api/v1/schemas/team.py new file mode 100755 index 000000000..229d4fa3c --- /dev/null +++ b/api/v1/schemas/team.py @@ -0,0 +1,47 @@ +#!/usr/bin/env python3 +"""Defines endpoint schemas for teams""" + +from pydantic import Field, BaseModel +from datetime import datetime +from typing import Optional + + +class UpdateTeamMember(BaseModel): + """Schema for update team member request""" + role: Optional[str] = Field( + default=None, min_length=1, title="Role of the team member") + name: Optional[str] = Field( + default=None, min_length=1, title="Name of the team member") + description: Optional[str] = Field(default=None, min_length=1, + title="Description of the team member") + picture_url: Optional[str] = Field( + default=None, min_length=1, title="URL of the team member picture") + + +class PostTeamMemberSchema(BaseModel): + """Pydantic Model for adding user to waitlist""" + + name: str = Field(min_length=1, title="Name of the team member") + role: str = Field(min_length=1, title="Role of the team member") + description: str = Field( + min_length=1, title="Description of the team member") + picture_url: str = Field( + min_length=1, title="URL of the team member picture") + + team_type: Optional[str] = Field( + default=None, min_length=1, title="Type of team member") + facebook_link: Optional[str] = Field( + default=None, min_length=1, title="Facebook link") + instagram_link: Optional[str] = Field( + default=None, min_length=1, title="Instagram link" + ) + xtwitter_link: Optional[str] = Field( + default=None, min_length=1, title="Twitter link") + + +class TeamMemberCreateResponseSchema(PostTeamMemberSchema): + id: str + created_at: datetime + + class Config: + from_attributes = True diff --git a/api/v1/schemas/terms_and_conditions.py b/api/v1/schemas/terms_and_conditions.py new file mode 100644 index 000000000..8ec79823e --- /dev/null +++ b/api/v1/schemas/terms_and_conditions.py @@ -0,0 +1,11 @@ +from pydantic import BaseModel + +class UpdateTermsAndConditions(BaseModel): + title: str = None + content: str = None + +class DeleteResponseModel(BaseModel): + message: str + status_code: int + success: bool + data: dict diff --git a/api/v1/schemas/testimonial.py b/api/v1/schemas/testimonial.py new file mode 100644 index 000000000..91157cb41 --- /dev/null +++ b/api/v1/schemas/testimonial.py @@ -0,0 +1,5 @@ +from pydantic import BaseModel + +class CreateTestimonial(BaseModel): + content: str + ratings: float = 0 \ No newline at end of file diff --git a/api/v1/schemas/token.py b/api/v1/schemas/token.py index 051299c0b..7502587f0 100644 --- a/api/v1/schemas/token.py +++ b/api/v1/schemas/token.py @@ -1,31 +1,22 @@ -from datetime import datetime -from typing import List, Optional -from api.v1.models.user import User +from typing import Optional from pydantic import BaseModel, EmailStr + # Pydantic models for request and response class Token(BaseModel): access_token: str token_type: str + class TokenData(BaseModel): username: Optional[str] = None user_id: str = None - -class LoginRequest(BaseModel): - username: str - password: str - - -class EmailRequest(BaseModel): - email: EmailStr - class TokenRequest(BaseModel): email: EmailStr token: str - + class OAuthToken(BaseModel): - access_token: str \ No newline at end of file + access_token: str diff --git a/api/v1/schemas/topic.py b/api/v1/schemas/topic.py new file mode 100644 index 000000000..f5b022f1c --- /dev/null +++ b/api/v1/schemas/topic.py @@ -0,0 +1,36 @@ +from pydantic import BaseModel +from typing import List, Optional, Dict, Any +from datetime import datetime + + +class TopicBase(BaseModel): + title: str + content: str + tags: Optional[List[str]] = None + + +class TopicData(BaseModel): + id: Optional[str] = None + title: str + content: str + tags: Optional[list[str]] = None + created_at: Optional[datetime] = None + + +class TopicList(BaseModel): + status_code: int = 200 + success: bool + message: str + data: List[TopicData] + +class TopicUpdateSchema(BaseModel): + id: str + title: Optional[str] = None + content: Optional[str] = None + tags: Optional[List[str]] = None + +class TopicSearchSchema(BaseModel): + query: str + +class TopicDeleteSchema(BaseModel): + id: str \ No newline at end of file diff --git a/api/v1/schemas/user.py b/api/v1/schemas/user.py index c880c9b15..809d561d3 100644 --- a/api/v1/schemas/user.py +++ b/api/v1/schemas/user.py @@ -1,11 +1,8 @@ import re from datetime import datetime -from typing import Any, Optional - -from fastapi import HTTPException -from pydantic import BaseModel, EmailStr, Field, field_validator -from uuid_extensions import uuid7 +from typing import Optional, Union, List +from pydantic import BaseModel, EmailStr, field_validator, ConfigDict class UserBase(BaseModel): @@ -14,7 +11,6 @@ class UserBase(BaseModel): id: str first_name: str last_name: str - username: str email: EmailStr created_at: datetime @@ -22,13 +18,14 @@ class UserBase(BaseModel): class UserCreate(BaseModel): """Schema to create a user""" - username: str + email: EmailStr password: str first_name: str last_name: str - email: EmailStr + admin_secret: Optional[str] = None @field_validator("password") + @classmethod def password_validator(cls, value): if not re.match( r"^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&])[A-Za-z\d@$!%*?&]{8,}$", @@ -39,6 +36,75 @@ def password_validator(cls, value): ) return value +class UserUpdate(BaseModel): + + first_name : Optional[str] = None + last_name : Optional[str] = None + email : Optional[str] = None +class UserData(BaseModel): + """ + Schema for users to be returned to superadmin + """ + id: str + email: EmailStr + first_name: str + last_name: str + is_active: bool + is_deleted: bool + is_verified: bool + is_super_admin: bool + created_at: datetime + updated_at: datetime + + + model_config = ConfigDict(from_attributes=True) + + +class AllUsersResponse(BaseModel): + """ + Schema for all users + """ + message: str + status_code: int + status: str + page: int + per_page: int + total: int + data: Union[List[UserData], List[None]] + +class AdminCreateUser(BaseModel): + """ + Schema for admin to create a users + """ + email: EmailStr + first_name: str + last_name: str + password: str = '' + is_active: bool = False + is_deleted: bool = False + is_verified: bool = False + is_super_admin: bool = False + + model_config = ConfigDict(from_attributes=True) + + +class AdminCreateUserResponse(BaseModel): + """ + Schema response for user created by admin + """ + message: str + status_code: int + status: str + data: UserData + +class LoginRequest(BaseModel): + email: EmailStr + password: str + + +class EmailRequest(BaseModel): + email: EmailStr + class Token(BaseModel): access_token: str @@ -48,7 +114,7 @@ class Token(BaseModel): class TokenData(BaseModel): """Schema to structure token data""" - id: Optional[Any] + id: Optional[str] class DeactivateUserSchema(BaseModel): @@ -68,6 +134,30 @@ class ChangePasswordSchema(BaseModel): class ChangePwdRet(BaseModel): """schema for returning change password response""" - success: bool status_code: int message: str + + +class MagicLinkRequest(BaseModel): + """Schema for magic link creation""" + + email: EmailStr + + +class MagicLinkResponse(BaseModel): + """Schema for magic link respone""" + + message: str + +class UserRoleSchema(BaseModel): + """Schema for user role""" + + role: str + user_id: str + org_id: str + + @field_validator("role") + def role_validator(cls, value): + if value not in ["admin", "user", "guest", "owner"]: + raise ValueError("Role has to be one of admin, guest, user, or owner") + return value diff --git a/api/v1/schemas/waitlist.py b/api/v1/schemas/waitlist.py index 90855f461..3eb1eda79 100644 --- a/api/v1/schemas/waitlist.py +++ b/api/v1/schemas/waitlist.py @@ -1,6 +1,8 @@ from pydantic import EmailStr, BaseModel + class WaitlistAddUserSchema(BaseModel): - '''Pydantic Model for adding user to waitlist''' + """Pydantic Model for adding user to waitlist""" + email: EmailStr full_name: str diff --git a/api/v1/services/activity_logs.py b/api/v1/services/activity_logs.py new file mode 100644 index 000000000..bca5dca6d --- /dev/null +++ b/api/v1/services/activity_logs.py @@ -0,0 +1,51 @@ +from sqlalchemy.orm import Session +from fastapi import HTTPException, status +from sqlalchemy.exc import SQLAlchemyError +from api.v1.models.activity_logs import ActivityLog +from typing import Optional, Any + + + +class ActivityLogService: + """Activity Log service""" + + def create_activity_log(self, db: Session, user_id: str, action: str): + """Creates a new activity log""" + + activity_log = ActivityLog(user_id=user_id, action=action) + db.add(activity_log) + db.commit() + db.refresh(activity_log) + return activity_log + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all products with option tto search using query parameters""" + + query = db.query(ActivityLog) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(ActivityLog, column) and value: + query = query.filter( + getattr(ActivityLog, column).ilike(f"%{value}%") + ) + + return query.all() + + def delete_activity_log_by_id(self, db: Session, log_id: str): + log = db.query(ActivityLog).filter(ActivityLog.id == log_id).first() + + if not log: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail=f"Activity log with ID {log_id} not found" + ) + + db.delete(log) + db.commit() + + return {"status": "success", "detail": f"Activity log with ID {log_id} deleted successfully"} + + +activity_log_service = ActivityLogService() diff --git a/api/v1/services/analytics.py b/api/v1/services/analytics.py new file mode 100644 index 000000000..1f25976f0 --- /dev/null +++ b/api/v1/services/analytics.py @@ -0,0 +1,291 @@ +from fastapi import Depends, HTTPException +from fastapi.security import OAuth2 +from sqlalchemy.orm import Session +from sqlalchemy import cast, extract, Integer, func, and_ +from typing import Annotated, List, Union +import calendar +from datetime import datetime, timedelta +from api.db.database import get_db +from api.v1.services.user import user_service +from api.core.base.services import Service +from api.v1.services.user import oauth2_scheme +from api.v1.models.user import user_organization_association +from api.v1.models.sales import Sales +from api.v1.models.product import Product +from api.v1.models.user import User +from api.v1.models.billing_plan import BillingPlan +from api.v1.schemas.analytics import ( + AnalyticsChartsResponse, AnalyticsSummaryResponse, SuperAdminMetrics, UserMetrics, MetricData) + +DATA: dict = {idx: month_name for idx, + month_name in enumerate(calendar.month_name) if month_name} + +MONTHS_AND_DATA: dict = {month: 0 for month in DATA.values()} + + +class AnalyticsServices(Service): + """ + Handles services related to analytis + """ + + def get_analytics_line_chart(self, token: Annotated[OAuth2, Depends(oauth2_scheme)], + db: Annotated[Session, Depends(get_db)]) -> AnalyticsChartsResponse: + """ + Get analytics data for the line chart. + + + Args: + token: access_token from header + db: database Session object + Retuns: + AnalyticsChartsResponse: reponse object to the user + """ + user: object = user_service.get_current_user(access_token=token, db=db) + + # check if the analytics-line-data is for org admin + if not user.is_super_admin: + user_organization: object = (db.query(user_organization_association) + .filter_by(user_id=user.id).first()) + if not user_organization: + return AnalyticsChartsResponse( + message='User is not part of Any organization yet.', + status='success', + status_code=200, + data={month: 0 for month in DATA.values()} + ) + data = self.get_line_chart_data(db, super_admin=False, + org_id=user_organization.organization_id) + message: str = 'Successfully retrieved line-charts' + + # check if user is a super admin + elif user.is_super_admin: + data = self.get_line_chart_data(db) + message: str = 'Successfully retrieved line-charts for super_admin' + + return AnalyticsChartsResponse(message=message, + status='success', + status_code=200, + data=data) + + def get_line_chart_data(self, db: Annotated[Session, Depends(get_db)], + super_admin: bool = True, org_id: str = '') -> tuple: + """ + Rearranges the data for the line-chart. + Args: + db: database session object + super_admin: boolean signifying revenues for super admin + organization_id: the organization id of the user + Returns: + MONTHS_AND_DATA: a dict conatining the months(str) and revenue(float) for each month + """ + global DATA, MONTHS_AND_DATA + + results = self.get_year_revenue(db, super_admin, org_id) + try: + mapped_result = {DATA[result[0]]: result[1] for result in results} + except KeyError: + pass + + for month, value in mapped_result.items(): + MONTHS_AND_DATA[month] = value + + return MONTHS_AND_DATA + + def get_year_revenue(self, db: Annotated[Session, Depends(get_db)], + super_admin: bool = True, + org_id: str = None) -> List[tuple]: + """ + Get revenue data grouped by month. + + Args: + db: database session object + super_admin: boolean signifying revenues for super admin + organization_id: the organization id of the user + Returns: + query result: a list conatining the rows of months(int) and revenue(int) + """ + query = db.query( + cast(extract('month', Sales.created_at), Integer).label('month'), + func.sum(getattr(Sales, 'amount')).label('total') + ) + + if not super_admin: + query = query.filter(Sales.organization_id == org_id) + + query = query.group_by( + cast(extract('month', Sales.created_at), Integer) + ).order_by( + cast(extract('month', Sales.created_at), Integer) + ) + + revenue_result = query.all() + if not revenue_result: + revenue_result = [(0, 0), (0, 0)] + + return revenue_result + + def get_analytics_summary(self, token: Annotated[OAuth2, Depends(oauth2_scheme)], + db: Annotated[Session, Depends(get_db)], + start_date: datetime, + end_date: datetime) -> AnalyticsSummaryResponse: + """ + Get analytics summary data. + + Args: + token: access_token from header + db: database Session object + start_date: start date for filtering + end_date: end date for filtering + Returns: + AnalyticsSummaryResponse: response object to the user + """ + user: object = user_service.get_current_user(access_token=token, db=db) + + if user.is_super_admin: + data = self.get_summary_data_super_admin(db, start_date, end_date) + message = "Successfully retrieved summary for super admin dashboard" + else: + user_organization = (db.query(user_organization_association) + .filter_by(user_id=user.id).first()) + if not user_organization: + raise HTTPException( + status_code=403, detail="User is not part of any organization") + data = self.get_summary_data_organization( + db, user_organization.organization_id, start_date, end_date) + message = "Successfully retrieved summary for user dashboard" + + return AnalyticsSummaryResponse( + message=message, + status='success', + status_code=200, + data=data + ) + + def get_summary_data_super_admin(self, db: Session, start_date: datetime, end_date: datetime) -> SuperAdminMetrics: + total_revenue = db.query(func.sum(Sales.amount)).filter( + Sales.created_at.between(start_date, end_date)).scalar() or 0 + total_products = db.query(func.count(Product.id)).scalar() or 0 + total_users = db.query(func.count(User.id)).scalar() or 0 + lifetime_sales = db.query(func.sum(Sales.amount)).filter( + Sales.created_at <= end_date).scalar() or 0 + + last_month_start = start_date - timedelta(days=30) + last_month_revenue = db.query(func.sum(Sales.amount)).filter( + Sales.created_at.between(last_month_start, start_date)).scalar() or 0 + last_month_products = db.query(func.count(Product.id)).filter( + Product.created_at < start_date).scalar() or 0 + last_month_users = db.query(func.count(User.id)).filter( + User.created_at < start_date).scalar() or 0 + last_month_lifetime_sales = db.query(func.sum(Sales.amount)).filter( + Sales.created_at < start_date).scalar() or 0 + + return [ + + {'total_revenue': MetricData( + value=total_revenue, + percentage_increase=self.calculate_percentage_increase( + last_month_revenue, total_revenue) + )}, + {'total_products': MetricData( + value=int(total_products), + percentage_increase=self.calculate_percentage_increase( + last_month_products, total_products) + )}, + {'total_users': MetricData( + value=int(total_users), + percentage_increase=self.calculate_percentage_increase( + last_month_users, total_users) + )}, + {'lifetime_sales': MetricData( + value=lifetime_sales, + percentage_increase=self.calculate_percentage_increase( + last_month_lifetime_sales, lifetime_sales) + )} + + ] + + def get_summary_data_organization(self, db: Session, org_id: str, start_date: datetime, end_date: datetime) -> UserMetrics: + total_revenue = db.query(func.sum(Sales.amount)).filter(and_( + Sales.organization_id == org_id, Sales.created_at.between(start_date, end_date))).scalar() or 0 + subscriptions = db.query(func.count(BillingPlan.id)).filter(and_( + BillingPlan.organization_id == org_id, BillingPlan.created_at.between(start_date, end_date))).scalar() or 0 + sales = db.query(func.count(Sales.id)).filter(and_( + Sales.organization_id == org_id, Sales.created_at.between(start_date, end_date))).scalar() or 0 + + last_month_start = start_date - timedelta(days=30) + last_month_revenue = db.query(func.sum(Sales.amount)).filter(and_( + Sales.organization_id == org_id, Sales.created_at.between(last_month_start, start_date))).scalar() or 0 + last_month_subscriptions = db.query(func.count(BillingPlan.id)).filter(and_( + BillingPlan.organization_id == org_id, BillingPlan.created_at.between(last_month_start, start_date))).scalar() or 0 + last_month_sales = db.query(func.count(Sales.id)).filter(and_( + Sales.organization_id == org_id, Sales.created_at.between(last_month_start, start_date))).scalar() or 0 + + last_hour = datetime.utcnow() - timedelta(hours=1) + active_now = db.query(func.count(User.id)).filter(and_( + User.is_active == True, + User.organizations.any(id=org_id) + )).scalar() or 0 + + return [ + + {'total_revenue': MetricData( + value=total_revenue, + percentage_increase=self.calculate_percentage_increase( + last_month_revenue, total_revenue) + )}, + {'subscriptions': MetricData( + value=int(subscriptions), + percentage_increase=self.calculate_percentage_increase( + last_month_subscriptions, subscriptions) + )}, + {'sales': MetricData( + value=int(sales), + percentage_increase=self.calculate_percentage_increase( + last_month_sales, sales) + )}, + {'active_now': MetricData( + value=active_now, + percentage_increase=self.calculate_percentage_increase( + 0, active_now) # No comparison for active now + )} + + ] + + @staticmethod + def calculate_percentage_increase(previous_value: Union[int, float], current_value: Union[int, float]) -> float: + if previous_value == 0: + return 0.0 if current_value == 0 else 100.0 + return ((current_value - previous_value) / abs(previous_value)) * 100 + + def create(self): + """ + Create + """ + pass + + def update(self): + """ + Update + """ + pass + + def fetch(self): + """ + Fetch + """ + pass + + def fetch_all(self): + """ + Fetch All + """ + pass + + def delete(self): + """ + Delete + """ + pass + + +analytics_service = AnalyticsServices() diff --git a/api/v1/services/api_tests.py b/api/v1/services/api_tests.py new file mode 100644 index 000000000..50eaa7f4a --- /dev/null +++ b/api/v1/services/api_tests.py @@ -0,0 +1,178 @@ +import unittest +import requests +from faker import Faker + +class PythonAPIs(unittest.TestCase): + fake = Faker() + baseUrl = "https://deployment.api-python.boilerplate.hng.tech" + valid_body = {"email": "woss7@mailinator.com", "password": "Pa$$w0rd!", "first_name": fake.first_name(), "last_name": fake.last_name()} + existing_body = {"email": "woss5@mailinator.com", "password": "Pa$$w0rd!", "first_name": fake.first_name(), "last_name": fake.last_name()} + invalid_body = {"email": 12345678, "password": "Pa$$w0rd!", "first_name": 10110111, "last_name": fake.last_name()} + access_token = None + user_id = None + valid_body1 = {"email": fake.email(), "password": "Pa$$w0rd!", "first_name": fake.first_name(), "last_name": fake.last_name()} + valid_body2 = {"email": fake.email(), "password": "Pa$$w0rd!", "first_name": fake.first_name(), "last_name": fake.last_name()} + change_password = {"old_password": "Pa$$w0rd!", "new_password": "Pa$$w0rd!!"} + VALID_CREDENTIALS = {"email": "woss1@mailinator.com", "password": "Pa$$w0rd!", "first_name": fake.first_name(), "last_name": fake.last_name()} + LOGIN_CREDENTIALS = {"email": "woss2@mailinator.com", "password": "Pa$$w0rd!"} + INVALID_CREDENTIALS = {"username": "test@mail.com", "password": "wrongpassword"} + create_profile = {"username": fake.user_name(), "pronouns": "It/is", "job_title": "Tester", "department": "Science", "social": "@me", "bio": fake.paragraph(), "phone_number": "+2348026653321", "avatar_url": fake.image_url(), "recovery_email": fake.email()} + + @classmethod + def setUpClass(cls): + auth_response = requests.post(f"{cls.baseUrl}/api/v1/auth/login", json={"email": "woss2@mailinator.com", "password": "Pa$$w0rd!"}) + auth_response_data = auth_response.json() + cls.access_token = auth_response_data["data"]["access_token"] + cls.user_id = auth_response_data["data"]["user"]["id"] + print(auth_response_data) + instance = cls() + instance.assertEqual(auth_response.status_code, 200, "Expected status code 200, got {}".format(auth_response.status_code)) + + def test_register_user_successfully(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register", json = self.valid_body2) + self.assertEqual(response.status_code, 201, "Expected status code 201, got {}".format(response.status_code)) + response_data = response.json() + self.assertIn("access_token", response_data["data"]) + self.assertIsInstance(response_data["data"]["access_token"], str) + self.assertGreater(len(response_data["data"]["access_token"]), 0) + + def test_register_with_invalid_credentials(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register", json = self.invalid_body) + self.assertEqual(response.status_code, 422, "Expected status code 422, got {}".format(response.status_code)) + response_data = response.json() + + def test_register_with_existing_credentials(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register", json = self.existing_body) + self.assertEqual(response.status_code, 400, "Expected status code 400, got {}".format(response.status_code)) + response_data = response.json() + + def test_token_expiry(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register", json = self.valid_body1) + self.assertEqual(response.status_code, 201) + response_data = response.json() + access_token = response_data["data"]["access_token"] + import jwt + decoded_token = jwt.decode(access_token, options = {"verify_signature": False}) + self.assertIn("exp", decoded_token) + self.assertGreater(decoded_token["exp"], 0) + + def test_register_admin_successfully(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register-super-admin", json = self.valid_body) + self.assertEqual(response.status_code, 201, "Expected status code 201, got {}".format(response.status_code)) + response_data = response.json() + self.assertIn("access_token", response_data["data"]) + self.assertIsInstance(response_data["data"]["access_token"], str) + self.assertGreater(len(response_data["data"]["access_token"]), 0) + print("Super Admin successfully created, status code is {}".format(response.status_code)) + + def test_register_admin_with_invalid_credentials(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register-super-admin", json = self.invalid_body) + self.assertEqual(response.status_code, 422, "Expected status code 422, got {}".format(response.status_code)) + + def test_register_admin_with_existing_credentials(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register-super-admin", json = self.existing_body) + self.assertEqual(response.status_code, 400, "Expected status code 400, got {}".format(response.status_code)) + + def test_refresh_token(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.post(f"{self.baseUrl}/api/v1/auth/refresh-access-token", headers = headers) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_logout(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.post(f"{self.baseUrl}/api/v1/auth/logout", headers = headers) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_refresh_token(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.post(f"{self.baseUrl}/api/v1/auth/refresh-access-token", headers = headers) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_send_token(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/request-token", json = {"email": "woss@mailinator.com"}) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_login_with_token(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/verify-token", json = {"email": "woss@mailinator.com", "token": "123456"}) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_request_magicLink(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/request-magic-link", json = {"email": "woss@mailinator.com"}) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_facebook_login(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/facebook-login", json = {"token": self.access_token}) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_newsletter(self): + response = requests.post(f"{self.baseUrl}/api/v1/newsletters", json = {"email": "woss@mailinator.com"}) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_change_password(self): + response = requests.patch(f"{self.baseUrl}/api/v1/users/me/password", json = self.change_password) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + def register_user(self): + response = requests.post(f"{self.baseUrl}/api/v1/auth/register-super-admin", json = self.VALID_CREDENTIALS) + self.assertEqual(response.status_code, 201) + response_data = response.json() + + + def test_get_endpoint(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.get(f"{self.baseUrl}/api/v1/auth/admin", headers=headers) + self.assertEqual(response.status_code, 200) + self.assertEqual(response.json(), {'message': 'Hello, admin!'}) + + def test_get_auth_google_redirect_success(self): + response = requests.get(f"{self.baseUrl}/api/v1/auth/google") + self.assertEqual(response.status_code, 200) + + def test_get_current_user_details(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.get(f"{self.baseUrl}/api/v1/users/me", headers=headers) + self.assertEqual(response.status_code, 200) + + def test_get_user_by_id(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.get(f"{self.baseUrl}/api/v1/users/{self.user_id}", headers=headers) + self.assertEqual(response.status_code, 200) + + def test_delete_user_by_id(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.delete(f"{self.baseUrl}/api/v1/users/{self.user_id}", headers=headers) + self.assertEqual(response.status_code, 204) + + def test_get_current_user_profile(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.get(f"{self.baseUrl}/api/v1/profile/current-user", headers=headers) + self.assertEqual(response.status_code, 200) + + def test_create_profile(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.patch(f"{self.baseUrl}/api/v1/users/me/password", json = self.change_password, headers = headers) + self.assertEqual(response.status_code, 200, "Expected status code 200, got {}".format(response.status_code)) + + def test_get_all_organization_billing(self): + headers = { + "Authorization": f"Bearer {self.access_token}" + } + response = requests.get(f"{self.baseUrl}/api/v1/organization/billing-plans", headers = headers) + self.assertEqual(response.status_code, 200) \ No newline at end of file diff --git a/api/v1/services/auth.py b/api/v1/services/auth.py new file mode 100644 index 000000000..71ba8ab4a --- /dev/null +++ b/api/v1/services/auth.py @@ -0,0 +1,31 @@ +from api.core.base.services import Service +from api.db.database import get_db +from api.v1.models.user import User +from api.v1.schemas.user import TokenData +from api.v1.services.user import user_service +from api.utils.settings import settings +from fastapi import HTTPException, Depends +from fastapi.security import OAuth2PasswordBearer +from sqlalchemy.orm import Session +from typing import Tuple +import jwt + +oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/api/v1/auth/login") + +class AuthService(Service): + """Auth Service""" + + @staticmethod + def verify_magic_token(magic_token: str, db: Session) -> Tuple[User, str]: + """Function to verify magic token""" + + credentials_exception = HTTPException( + status_code=401, + detail="Could not validate credentials", + headers={"WWW-Authenticate": "Bearer"}, + ) + + token = user_service.verify_access_token(magic_token, credentials_exception) + user = db.query(User).filter(User.id == token.id).first() + + return user, magic_token \ No newline at end of file diff --git a/api/v1/services/billing_plan.py b/api/v1/services/billing_plan.py index 054ebe203..1afbd7944 100644 --- a/api/v1/services/billing_plan.py +++ b/api/v1/services/billing_plan.py @@ -2,36 +2,47 @@ from api.v1.models.billing_plan import BillingPlan from typing import Any, Optional from api.core.base.services import Service - +from api.v1.schemas.plans import CreateSubscriptionPlan class BillingPlanService(Service): - '''Product service functionality''' + """Product service functionality""" + + def create(self, db: Session, request: CreateSubscriptionPlan): + """ + Create and return a new billing plan + """ + + plan = BillingPlan(**request.dict()) + db.add(plan) + db.commit() + db.refresh(plan) - def create(): - pass + return plan - def delete(): - pass + def delete(): + pass - def fetch(): - pass + def fetch(): + pass - def update(): - pass + def update(): + pass - def fetch_all(db: Session, **query_params: Optional[Any]): - '''Fetch all products with option tto search using query parameters''' + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all products with option tto search using query parameters""" - query = db.query(BillingPlan) + query = db.query(BillingPlan) - # Enable filter by query parameter - if query_params: - for column, value in query_params.items(): - if hasattr(BillingPlan, column) and value: - query = query.filter(getattr(BillingPlan, column).ilike(f'%{value}%')) + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(BillingPlan, column) and value: + query = query.filter( + getattr(BillingPlan, column).ilike(f"%{value}%") + ) - return query.all() + return query.all() -billing_plan_service = BillingPlanService \ No newline at end of file +billing_plan_service = BillingPlanService() diff --git a/api/v1/services/blog.py b/api/v1/services/blog.py index dc80b581e..44891b46d 100644 --- a/api/v1/services/blog.py +++ b/api/v1/services/blog.py @@ -1,49 +1,64 @@ -from typing import Any, Optional -from uuid import UUID +from typing import Optional from fastapi import HTTPException from sqlalchemy.orm import Session from api.core.base.services import Service from api.utils.db_validators import check_model_existence -from api.v1.models.blog import Blog +from api.v1.models.blog import Blog, BlogDislike, BlogLike from api.v1.models.user import User from api.v1.schemas.blog import BlogCreate class BlogService: - '''Blog service functionality''' + """Blog service functionality""" def __init__(self, db: Session): self.db = db def create(self, db: Session, schema: BlogCreate, author_id: str): """Create a new blog post""" + new_blogpost = Blog(**schema.model_dump(), author_id=author_id) db.add(new_blogpost) db.commit() db.refresh(new_blogpost) return new_blogpost - + + def fetch_all(self): + """Fetch all blog posts""" + + blogs = self.db.query(Blog).filter(Blog.is_deleted == False).all() + return blogs + def fetch(self, blog_id: str): - '''Fetch a blog post by its ID''' + """Fetch a blog post by its ID""" + blog_post = self.db.query(Blog).filter(Blog.id == blog_id).first() if not blog_post: - raise HTTPException(status_code=404, detail="Post not Found") + raise HTTPException(status_code=404, detail="Post not found") return blog_post - def update(self, blog_id: str, title: Optional[str] = None, content: Optional[str] = None, current_user: User = None): - '''Updates a blog post''' + def update( + self, + blog_id: str, + title: Optional[str] = None, + content: Optional[str] = None, + current_user: User = None, + ): + """Updates a blog post""" if not title or not content: raise HTTPException( - status_code=400, detail="Title and content cannot be empty") + status_code=400, detail="Title and content cannot be empty" + ) blog_post = self.fetch(blog_id) if blog_post.author_id != current_user.id: raise HTTPException( - status_code=403, detail="Not authorized to update this blog") + status_code=403, detail="Not authorized to update this blog" + ) # Update the fields with the provided data blog_post.title = title @@ -55,18 +70,63 @@ def update(self, blog_id: str, title: Optional[str] = None, content: Optional[st except Exception as e: self.db.rollback() raise HTTPException( - status_code=500, detail="An error occurred while updating the blog post") + status_code=500, detail="An error occurred while updating the blog post" + ) return blog_post + def create_blog_like( + self, db: Session, blog_id: str, user_id: str, ip_address: str = None + ): + """Create new blog like.""" + blog_like = BlogLike( + blog_id=blog_id, user_id=user_id, ip_address=ip_address + ) + db.add(blog_like) + db.commit() + db.refresh(blog_like) + return blog_like + + def create_blog_dislike( + self, db: Session, blog_id: str, user_id: str, ip_address: str = None + ): + """Create new blog dislike.""" + blog_dislike = BlogDislike( + blog_id=blog_id, user_id=user_id, ip_address=ip_address + ) + db.add(blog_dislike) + db.commit() + db.refresh(blog_dislike) + return blog_dislike + + def fetch_blog_like(self, blog_id: str, user_id: str): + """Fetch a blog like by blog ID & ID of user who liked it""" + blog_like = ( + self.db.query(BlogLike) + .filter_by(blog_id=blog_id, user_id=user_id) + .first() + ) + return blog_like + + def fetch_blog_dislike(self, blog_id: str, user_id: str): + """Fetch a blog dislike by blog ID & ID of user who disliked it""" + blog_dislike = ( + self.db.query(BlogDislike) + .filter_by(blog_id=blog_id, user_id=user_id) + .first() + ) + return blog_dislike + + def num_of_likes(self, blog_id: str) -> int: + """Get the number of likes a blog post has""" + return self.db.query(BlogLike).filter_by(blog_id=blog_id).count() + + def num_of_dislikes(self, blog_id: str) -> int: + """Get the number of dislikes a blog post has""" + return self.db.query(BlogDislike).filter_by(blog_id=blog_id).count() - def fetch_post(self, blog_id: str): - '''Fetch a blog post by its ID''' - blog_post = self.db.query(Blog).filter(Blog.id == blog_id).first() - return blog_post - def delete(self, blog_id: str): - post = self.fetch_post(blog_id=blog_id) + post = self.fetch(blog_id=blog_id) if post: try: @@ -76,4 +136,6 @@ def delete(self, blog_id: str): except Exception as e: self.db.rollback() raise HTTPException( - status_code=400, detail="An error occurred while updating the blog post") + status_code=400, + detail="An error occurred while updating the blog post", + ) diff --git a/api/v1/services/comment.py b/api/v1/services/comment.py new file mode 100644 index 000000000..1e88b67f5 --- /dev/null +++ b/api/v1/services/comment.py @@ -0,0 +1,115 @@ +from fastapi import HTTPException +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.comment import Comment, CommentLike +from typing import Any, Optional, Union, Annotated +from sqlalchemy import desc +from api.db.database import get_db +from sqlalchemy.orm import Session +from api.utils.db_validators import check_model_existence +from api.v1.models.blog import Blog +from api.v1.schemas.comment import CommentsSchema, CommentsResponse + + +class CommentService(Service): + """Comment service functionality""" + + def create(self, db: Session, schema, user_id, blog_id): + """Create a new comment to a blog""" + # check if blog exists + blog = check_model_existence(db, Blog, blog_id) + + # create and add the new comment to the database + new_comment = Comment(**schema.model_dump(), user_id=user_id, blog_id=blog_id) + db.add(new_comment) + db.commit() + db.refresh(new_comment) + return new_comment + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all comments with option tto search using query parameters""" + + query = db.query(Comment) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(Comment, column) and value: + query = query.filter(getattr(Comment, column).ilike(f"%{value}%")) + + return query.all() + + def fetch(self, db: Session, id: str): + """Fetches a comment by id""" + + comment = check_model_existence(db, Comment, id) + return comment + + def update(self, db: Session, id: str, schema): + """Updates a comment""" + + comment = self.fetch(db=db, id=id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(comment, key, value) + + db.commit() + db.refresh(comment) + return comment + + def delete(self, db: Session, id: str): + """Deletes a comment""" + + comment = self.fetch(db=db, id=id) + db.delete(comment) + db.commit() + + def validate_params( + self, blog_id: str, page: int, per_page: int, db: Annotated[Session, get_db] + ): + """ + Validate parameters and fetch comments. + + Args: + blog_id: blog associated with comments + page: the number of the current page + per_page: the page size for a current page + db: Database Session object + Returns: + Response: An exception if error occurs + object: Response object containing the comments + """ + try: + blog_exists: Union[object, None] = ( + db.query(Blog).filter_by(id=blog_id).one_or_none() + ) + if not blog_exists: + return "Blog not found" + per_page = per_page if per_page <= 20 else 20 + + comments: Union[list, None] = ( + db.query(Comment) + .filter_by(blog_id=blog_id) + .order_by(desc(Comment.created_at)) + .limit(per_page) + .offset((page - 1) * per_page) + .all() + ) + if not comments: + return CommentsResponse() + total_comments = db.query(Comment).filter_by(blog_id=blog_id).count() + + comment_schema: list = [ + CommentsSchema.model_validate(comment) for comment in comments + ] + return CommentsResponse( + page=page, per_page=per_page, total=total_comments, data=comment_schema + ) + except Exception: + return False + + +comment_service = CommentService() + diff --git a/api/v1/services/comment_dislike.py b/api/v1/services/comment_dislike.py new file mode 100644 index 000000000..2d56d51d3 --- /dev/null +++ b/api/v1/services/comment_dislike.py @@ -0,0 +1,78 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from fastapi import HTTPException, status + +from api.core.base.services import Service +from api.utils.db_validators import check_model_existence +from api.v1.models import Comment, CommentDislike +from api.v1.models.comment import Comment + + +class CommentDislikeService(Service): + """Comment dislike service functionality""" + + def create(self, db: Session, user_id, comment_id, client_ip: Optional[str] = None): + """Function to dislike a comment""" + # check if the user_id has disliked the comment, return error is so + dislike_data = db.query(CommentDislike).filter_by(user_id=user_id, comment_id=comment_id).first() + if dislike_data: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, + detail="You can only dislike once", + ) + # check if comment exists + comment = check_model_existence(db, Comment, comment_id) + + # create and add the new commentDislike to the database + new_dislike = CommentDislike( + comment_id=comment_id, user_id=user_id, ip_address=client_ip + ) + db.add(new_dislike) + db.commit() + db.refresh(new_dislike) + return new_dislike + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all comment_dislike with option tto search using query parameters""" + + query = db.query(CommentDislike) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(CommentDislike, column) and value: + query = query.filter( + getattr(CommentDislike, column).ilike(f"%{value}%") + ) + + return query.all() + + def fetch(self, db: Session, id: str): + """Fetches a comment_dislike by id""" + + comment_dislike = check_model_existence(db, CommentDislike, id) + return comment_dislike + + def update(self, db: Session, id: str, schema): + """Updates a comment_dislike""" + + comment_dislike = self.fetch(db=db, id=id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(comment_dislike, key, value) + + db.commit() + db.refresh(comment_dislike) + return comment_dislike + + def delete(self, db: Session, id: str): + """Deletes a comment""" + + comment = self.fetch(id=id) + db.delete(comment) + db.commit() + + +comment_dislike_service = CommentDislikeService() diff --git a/api/v1/services/comment_like.py b/api/v1/services/comment_like.py new file mode 100644 index 000000000..92304020e --- /dev/null +++ b/api/v1/services/comment_like.py @@ -0,0 +1,72 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from fastapi import HTTPException, status +from api.core.base.services import Service +from api.utils.db_validators import check_model_existence +from api.v1.models import Comment, CommentLike +from api.v1.models.comment import Comment + + +class CommentLikeService(Service): + """Comment like service functionality""" + + def create(self, db: Session, user_id, comment_id, client_ip: Optional[str] = None): + '''Function to like a comment''' + + like_data = db.query(CommentLike).filter_by(user_id=user_id, comment_id=comment_id).first() + if like_data: + raise HTTPException( + status_code=status.HTTP_200_OK, + detail="You've already liked this comment", + ) + check_model_existence(db, Comment, comment_id) + new_like = CommentLike( + comment_id=comment_id, user_id=user_id, ip_address=client_ip + ) + db.add(new_like) + db.commit() + db.refresh(new_like) + return new_like + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all comment_like with option tto search using query parameters""" + + query = db.query(CommentLike) + + if query_params: + for column, value in query_params.items(): + if hasattr(CommentLike, column) and value: + query = query.filter( + getattr(CommentLike, column).ilike(f"%{value}%") + ) + + return query.all() + + def fetch(self, db: Session, id: str): + """Fetches a comment_like by id""" + + comment_like = check_model_existence(db, CommentLike, id) + return comment_like + + def update(self, db: Session, id: str, schema): + """Updates a comment_like""" + + comment_like = self.fetch(db=db, id=id) + + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(comment_like, key, value) + + db.commit() + db.refresh(comment_like) + return comment_like + + def delete(self, db: Session, id: str): + """Deletes a comment like""" + + comment = self.fetch(id=id) + db.delete(comment) + db.commit() + + +comment_like_service = CommentLikeService() diff --git a/api/v1/services/contact.py b/api/v1/services/contact.py new file mode 100644 index 000000000..8d56b165b --- /dev/null +++ b/api/v1/services/contact.py @@ -0,0 +1,45 @@ +from api.db.database import get_db +from api.v1.models.contact_us import ContactUs +from fastapi import HTTPException, status +from api.v1.models.associations import user_organization_association +from api.v1.services.organization import OrganizationService + + +class ContactMessage(object): + def __init__(self): + pass + + def fetch_message(self, db, message_id): + # result = ContactUs.get_by_id(message_id) + result = db.query(ContactUs).filter_by(id=message_id).first() + if not result: + raise self.raise_not_found() + return result + + def check_admin_access(self, db, admin_id, org_id): + org_service_obj = OrganizationService() + role = org_service_obj.get_organization_user_role(user_id=admin_id, org_id=org_id, db=db) + if role != 'admin': + self.raise_unauthorized_admin() + + @staticmethod + def raise_unauthorized(): + raise HTTPException( + status_code=status.HTTP_401_UNAUTHORIZED, + detail="Invalid token format", + headers={"WWW-Authenticate": "Bearer"}, + ) + + @staticmethod + def raise_unauthorized_admin(): + raise HTTPException( + status_code=status.HTTP_401_UNAUTHORIZED, + detail="Admin is unauthorized", + ) + + @staticmethod + def raise_not_found(): + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Message Not FOUND" + ) diff --git a/api/v1/services/contact_us.py b/api/v1/services/contact_us.py new file mode 100644 index 000000000..936ea267c --- /dev/null +++ b/api/v1/services/contact_us.py @@ -0,0 +1,74 @@ +from fastapi import Depends +from sqlalchemy.orm import Session +from typing import Annotated, Optional, Any +from api.core.base.services import Service +from api.v1.routes.contact_us import get_db +from api.v1.schemas.contact_us import CreateContactUs +from api.v1.models import ContactUs + + +class ContactUsService(Service): + """Contact Us Service.""" + + def __init__(self) -> None: + self.adabtingMapper = { + "full_name": "full_name", + "email": "email", + "title": "phone_number", # Adapting the schema to the model + "message": "message", + } + super().__init__() + + # ------------ CRUD functions ------------ # + # CREATE + def create(self, db: Annotated[Session, Depends(get_db)], data: CreateContactUs): + """Create a new contact us message.""" + contact_message = ContactUs( + full_name=getattr(data, self.adabtingMapper["full_name"]), + email=getattr(data, self.adabtingMapper["email"]), + title=getattr(data, self.adabtingMapper["title"]), + message=getattr(data, self.adabtingMapper["message"]), + ) + db.add(contact_message) + db.commit() + db.refresh(contact_message) + return contact_message + + # READ + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all submisions with option to search using query parameters""" + + query = db.query(ContactUs) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(ContactUs, column) and value: + query = query.filter(getattr(ContactUs, column).ilike(f"%{value}%")) + + return query.all() + + def fetch(self, db: Session, id: str): + """Fetches a job by id""" + + contact_us_submission = db.query(ContactUs).where(ContactUs.id == id) + return contact_us_submission + + def fetch_by_email(self, db: Session, email: str): + """Fetches a contact_us_submission by id""" + + contact_us_submission = db.query(ContactUs).where(ContactUs.email == email) + return contact_us_submission + + # UPDATE + def update(self, db: Annotated[Session, Depends(get_db)], contact_id: int, data: CreateContactUs): + """Update a single contact us message.""" + pass + + # DELETE + def delete(self, db: Annotated[Session, Depends(get_db)], contact_id: int): + """Delete a single contact us message.""" + pass + + +contact_us_service = ContactUsService() diff --git a/api/v1/services/data_privacy.py b/api/v1/services/data_privacy.py new file mode 100644 index 000000000..681a634ed --- /dev/null +++ b/api/v1/services/data_privacy.py @@ -0,0 +1,50 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.user import User +from api.v1.models.data_privacy import DataPrivacySetting +from api.utils.db_validators import check_model_existence + + +class DataPrivacyService(Service): + """Data Privacy Services""" + + def create(self, user: User, db: Session): + # create data privacy setting + + data_privacy = DataPrivacySetting(user_id=user.id) + + db.add(data_privacy) + db.commit() + db.refresh(data_privacy) + + def fetch_all(self): + pass + + def fetch(self, db: Session, user: User): + # * for users create before this update + + if not user.data_privacy_setting: + self.create(user, db) + + return user.data_privacy_setting + + def update(self, db: Session, user: User, schema): + """Updates the user privacy settings""" + + data_privacy_setting = self.fetch(db=db, user=user) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(data_privacy_setting, key, value) + + db.commit() + db.refresh(data_privacy_setting) + return data_privacy_setting + + def delete(self): + pass + + +data_privacy_service = DataPrivacyService() diff --git a/api/v1/services/email_services.py b/api/v1/services/email_services.py new file mode 100644 index 000000000..30c777b60 --- /dev/null +++ b/api/v1/services/email_services.py @@ -0,0 +1,52 @@ +from typing import Optional +from fastapi_mail import FastMail, MessageSchema, ConnectionConfig +from pydantic import EmailStr +import os +from dotenv import load_dotenv +from fastapi import BackgroundTasks + +load_dotenv() + +class EmailService: + def __init__(self): + self.conf = ConnectionConfig( + MAIL_USERNAME=os.getenv("MAIL_USERNAME"), + MAIL_PASSWORD=os.getenv("MAIL_PASSWORD"), + MAIL_FROM=os.getenv("MAIL_FROM"), + MAIL_PORT=int(os.getenv("MAIL_PORT")), + MAIL_SERVER=os.getenv("MAIL_SERVER"), + USE_CREDENTIALS=True, + VALIDATE_CERTS=True, + MAIL_STARTTLS = False, + MAIL_SSL_TLS = True, + ) + self.fast_mail = FastMail(self.conf) + + async def send_email( + self, + background_tasks: BackgroundTasks, + to_email: EmailStr, + subject: str, + body: str, + from_name: Optional[str] = None + ): + message = MessageSchema( + subject=subject, + recipients=[to_email], + body=body, + subtype="plain", + sender=f"{from_name} <{self.conf.MAIL_FROM}>" if from_name else self.conf.MAIL_FROM + ) + + background_tasks.add_task(self._send_email_task, message) + + return {"message": "Email sending in the background"} + + async def _send_email_task(self, message: MessageSchema): + try: + await self.fast_mail.send_message(message) + except Exception as e: + # Handle exceptions as needed + print(f"Failed to send email: {e}") + +email_service = EmailService() diff --git a/api/v1/services/email_template.py b/api/v1/services/email_template.py new file mode 100644 index 000000000..5ca01a840 --- /dev/null +++ b/api/v1/services/email_template.py @@ -0,0 +1,63 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.email_template import EmailTemplate +from api.v1.schemas.email_template import EmailTemplateSchema +from api.utils.db_validators import check_model_existence + + +class EmailTemplateService(Service): + '''Email template service functionality''' + + def create(self, db: Session, schema: EmailTemplateSchema): + """Create a new FAQ""" + + new_template = EmailTemplate(**schema.model_dump()) + db.add(new_template) + db.commit() + db.refresh(new_template) + + return new_template + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all email templates with option to search using query parameters""" + + query = db.query(EmailTemplate) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(EmailTemplate, column) and value: + query = query.filter(getattr(EmailTemplate, column).ilike(f"%{value}%")) + + return query.all() + + def fetch(self, db: Session, template_id: str): + """Fetches a template by id""" + + email_template = check_model_existence(db, EmailTemplate, template_id) + return email_template + + def update(self, db: Session, template_id: str, schema: EmailTemplateSchema): + """Updates an email template""" + + template = self.fetch(db=db, template_id=template_id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(template, key, value) + + db.commit() + db.refresh(template) + return template + + def delete(self, db: Session, template_id: str): + """Deletes an FAQ""" + + template = self.fetch(db=db, template_id=template_id) + db.delete(template) + db.commit() + + +email_template_service = EmailTemplateService() diff --git a/api/v1/services/facebook.py b/api/v1/services/facebook.py index 067b1405f..25328504d 100644 --- a/api/v1/services/facebook.py +++ b/api/v1/services/facebook.py @@ -1,10 +1,8 @@ import requests from fastapi import Depends, HTTPException from sqlalchemy.orm import Session -from typing import Annotated, Optional +from typing import Annotated from uuid_extensions import uuid7 -from datetime import datetime, timedelta -from jose import jwt from api.core.base.services import Service from api.utils.settings import settings from api.v1.routes.facebook_login import get_db diff --git a/api/v1/services/faq.py b/api/v1/services/faq.py new file mode 100644 index 000000000..06f19ec38 --- /dev/null +++ b/api/v1/services/faq.py @@ -0,0 +1,63 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.faq import FAQ +from api.v1.schemas.faq import CreateFAQ, UpdateFAQ +from api.utils.db_validators import check_model_existence + + +class FAQService(Service): + '''FAQ service functionality''' + + def create(self, db: Session, schema: CreateFAQ): + """Create a new FAQ""" + + new_faq = FAQ(**schema.model_dump()) + db.add(new_faq) + db.commit() + db.refresh(new_faq) + + return new_faq + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all FAQs with option to search using query parameters""" + + query = db.query(FAQ) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(FAQ, column) and value: + query = query.filter(getattr(FAQ, column).ilike(f"%{value}%")) + + return query.all() + + def fetch(self, db: Session, faq_id: str): + """Fetches a, FAQ by id""" + + faq = check_model_existence(db, FAQ, faq_id) + return faq + + def update(self, db: Session, faq_id: str, schema: UpdateFAQ): + """Updates an FAQ""" + + faq = self.fetch(db=db, faq_id=faq_id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(faq, key, value) + + db.commit() + db.refresh(faq) + return faq + + def delete(self, db: Session, faq_id: str): + """Deletes an FAQ""" + + faq = self.fetch(db=db, faq_id=faq_id) + db.delete(faq) + db.commit() + + +faq_service = FAQService() diff --git a/api/v1/services/google_oauth.py b/api/v1/services/google_oauth.py index 8c5526caf..f2c07bbf0 100644 --- a/api/v1/services/google_oauth.py +++ b/api/v1/services/google_oauth.py @@ -1,22 +1,23 @@ -from fastapi import Depends, HTTPException, status +from fastapi import Depends from datetime import datetime, timezone from api.db.database import get_db from api.v1.models.user import User from api.v1.models.oauth import OAuth +from api.v1.models.user import User from api.v1.models.profile import Profile from api.core.base.services import Service from sqlalchemy.orm import Session from typing import Annotated, Union from api.v1.services.user import user_service -from api.v1.schemas.google_oauth import Tokens, UserData, StatusResponse +from api.v1.schemas.google_oauth import Tokens +from api.v1.services.profile import profile_service -class GoogleOauthServices(Service): +class GoogleOauthServices(Service): """ Handles database operations for google oauth """ - def create(self, google_response: dict, - db: Annotated[Session, Depends(get_db)]) -> object: + def create_oauth_user(self, google_response: dict, db: Session): """ Creates a user using information from google. @@ -25,88 +26,27 @@ def create(self, google_response: dict, db: database session to manage database operation Returns: - user: The user object if already exists or if newly created - Response: HttpException for when Authentication fails + user: The user object if user already exists or if newly created + False: for when Authentication fails """ try: - # retrieve the user information user_info: dict = google_response.get("userinfo") - - existing_user = db.query(User).filter_by(email=user_info.get("email")).one_or_none() + email = user_info.get("email") + existing_user = db.query(User).filter_by(email=email).first() if existing_user: - # retrieve the user's google_access_token - oauth_data = db.query(OAuth).filter_by(user_id=existing_user.id).one_or_none() - # if the entry exists + oauth_data = db.query(OAuth).filter_by(user_id=existing_user.id).first() if oauth_data: - # update the oauth data self.update(oauth_data, google_response, db) - # pass the user object to get_response method to generate a response object - user_response = self.get_response(existing_user) - return user_response - # if the entry does not exist else: - try: - # user used google oauth for the first time, save his info - # if the user is not found in the database, add the user oauth2_data - oauth_data = OAuth(provider="google", - user_id=existing_user.id, - sub=user_info.get("sub"), - access_token=google_response.get("access_token"), - refresh_token=google_response.get("refresh_token", '')) - # add and commit to get the inserted_id - db.add(oauth_data) - db.commit() - # update the user's relationship with oauth - existing_user.oauth = oauth_data - existing_user.updated_at = datetime.now(timezone.utc) - db.commit() - # pass the user object to get_response method to generate a response object - user_response = self.get_response(existing_user) - return user_response - except Exception as exc: - db.rollback() - raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR) + self.create_oauth_data(existing_user.id, google_response, db) + return existing_user else: - try: - # if the user is not found in the database, add the user oauth2_data - # add the user to the database, and link the user to the associated - # oauth_data - new_user = User(username=user_info.get("email"), - first_name=user_info.get("given_name"), - last_name=user_info.get("family_name"), - email=user_info.get("email")) - # commit to get the user_id - db.add(new_user) - db.commit() - - oauth_data = OAuth(provider="google", - user_id=new_user.id, - sub=user_info.get("sub"), - access_token=google_response.get("access_token"), - refresh_token=google_response.get("refresh_token", "")) - # add and commit to get the inserted_id - # add the avatar_url of the new user to the profile - profile = Profile(user_id=new_user.id, - avatar_url=user_info.get("picture")) - - # commit to the database - db.add_all([oauth_data, profile]) - db.commit() - except Exception as exc: - db.rollback() - raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR) - - db.refresh(new_user) - - # pass the user object to get_response method to generate a response object - user_response = self.get_response(new_user) - - # return the user object for further processing - return user_response - except Exception as exc: + new_user = self.create_new_user(google_response, db) + return new_user + except Exception: db.rollback() - raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR) + return False def fetch(self): """ @@ -114,7 +54,7 @@ def fetch(self): """ pass - def fetch_all(self, db: Annotated[Session, Depends(get_db)])-> Union[list, HTTPException]: + def fetch_all(self, db: Annotated[Session, Depends(get_db)]) -> Union[list, bool]: """ Retrieves all users information from the oauth table @@ -127,8 +67,8 @@ def fetch_all(self, db: Annotated[Session, Depends(get_db)])-> Union[list, HTTPE try: all_oauth = db.query(OAuth).all() return all_oauth - except Exception as exc: - raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR) + except Exception: + return False def delete(self): """ @@ -136,8 +76,12 @@ def delete(self): """ pass - def update(self, oauth_data: object, google_response, - db: Annotated[Session, Depends(get_db)]) -> None: + def update( + self, + oauth_data: object, + google_response: dict, + db: Annotated[Session, Depends(get_db)], + ) -> Union[None, bool]: """ Updates a user information in the oauth table @@ -147,44 +91,114 @@ def update(self, oauth_data: object, google_response, db: the database session object for connection Returns: - None + None: If no exception was raised + Fasle: if an exception was raised """ try: # update the access and refresh token oauth_data.access_token = google_response.get("access_token") - oauth_data.refresh_token = google_response.get("refresh_token", '') + oauth_data.refresh_token = google_response.get("refresh_token", "") oauth_data.updated_at = datetime.now(timezone.utc) # commit and return the user object db.commit() - except Exception as exc: + except Exception: db.rollback() - raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR) + return False - def get_response(self, user: object) -> object: + def generate_tokens(self, user: object) -> Union[object, bool]: """ Creates a resnpose for the end user Args: user: the user object Returns: - the response object for the end user + tokens: the object containing access and refresh tokens for the user """ try: - # create a user data for response - user_response = UserData.model_validate(user, strict=True, from_attributes=True) # create access token access_token = user_service.create_access_token(user.id) # create refresh token refresh_token = user_service.create_access_token(user.id) # create a token data for response - tokens = Tokens(access_token=access_token, - refresh_token=refresh_token, - token_type="bearer") - - return StatusResponse(message="Authentication was successful", - status="successful", - statusCode=200, - tokens=tokens, - user=user_response) - except Exception as exc: - raise HTTPException(status_code=status.HTTP_500_INTERNAL_SERVER_ERROR) \ No newline at end of file + tokens = Tokens( + access_token=access_token, + refresh_token=refresh_token, + token_type="bearer", + ) + return tokens + except Exception: + return False + + def create_oauth_data( + self, + user_id: int, + google_response: dict, + db: Annotated[Session, Depends(get_db)], + ) -> Union[None, bool]: + """ + Creates OAuth data for a new user. + + Args: + user_id: The ID of the user. + google_response: The response from Google OAuth. + db: The database session object for connection. + + Return: + None: If no exception occured + False: If an exception occures + """ + try: + oauth_data = OAuth( + provider="google", + user_id=user_id, + sub=google_response["userinfo"].get("sub"), + access_token=google_response.get("access_token"), + refresh_token=google_response.get("refresh_token", ""), + ) + db.add(oauth_data) + db.commit() + except Exception: + db.rollback() + return False + + def create_new_user( + self, google_response: dict, db: Annotated[Session, Depends(get_db)] + ) -> Union[User, bool]: + """ + Creates a new user and their associated profile and OAuth data. + + Args: + user_info: User information from Google OAuth. + google_response: The response from Google OAuth. + db: The database session object for connection. + + Returns: + new user: The newly created user object. + False: If an error occured + """ + try: + new_user = User( + first_name=google_response.get("given_name"), + last_name=google_response.get("family_name"), + email=google_response.get("email"), + avatar_url=google_response.get("picture") + ) + db.add(new_user) + db.commit() + + profile = Profile(user_id=new_user.id, avatar_url=google_response.get("picture")) + oauth_data = OAuth( + provider="google", + user_id=new_user.id, + sub=google_response.get("sub"), + access_token=user_service.create_access_token(new_user.id), + refresh_token=user_service.create_refresh_token(new_user.id) + ) + db.add_all([profile, oauth_data]) + db.commit() + + db.refresh(new_user) + return new_user + except Exception: + db.rollback() + return False diff --git a/api/v1/services/invite.py b/api/v1/services/invite.py index edfdcf1b4..87ac4d9c1 100644 --- a/api/v1/services/invite.py +++ b/api/v1/services/invite.py @@ -3,48 +3,84 @@ from pytz import utc from sqlalchemy.orm import Session from sqlalchemy import insert -from fastapi import HTTPException, Request +from fastapi import HTTPException, Request, Depends, status from collections import OrderedDict from fastapi.responses import JSONResponse -from api.db.database import get_db from api.v1.models.invitation import Invitation -from api.v1.models.org import Organization +from api.v1.models.organization import Organization from api.v1.models.user import User -from api.v1.models.base import user_organization_association +from api.v1.models.associations import user_organization_association from api.v1.schemas import invitations +from api.core.base.services import Service from urllib.parse import urlencode -class InviteService: + +class InviteService(Service): @staticmethod - def create(invite: invitations.InvitationCreate, request: Request, session: Session): - user = session.query(User).filter_by(id=invite.user_id).first() + def create( + invite: invitations.InvitationCreate, request: Request, session: Session + ): + + user_email = session.query(User).filter_by(email=invite.user_email).first() + # user = session.query(User).filter_by(id=invite.user_id).first() org = session.query(Organization).filter_by(id=invite.organization_id).first() - if not user or not org: - raise HTTPException(status_code=400, detail="Invalid user or organization ID") + if not user_email or not org: + exceptions = HTTPException( + status_code=404, detail="invalid user or organization id" + ) + print(exceptions) + raise exceptions + + user_organizations = session.execute( + user_organization_association.select().where( + user_organization_association.c.user_id == user_email.id, + user_organization_association.c.organization_id == org.id, + ) + ).fetchall() + + if user_organizations: + logging.warning(f"User {user_email.id} already in organization {org.id}") + raise HTTPException(status_code=400, detail="User already in organization") expiration = datetime.now(utc) + timedelta(days=1) - new_invite = Invitation(user_id=invite.user_id, organization_id=invite.organization_id, expires_at=expiration) - + new_invite = Invitation( + user_id=user_email.id, + organization_id=invite.organization_id, + expires_at=expiration, + ) + session.add(new_invite) session.commit() session.refresh(new_invite) base_url = request.base_url invite_link = f'{base_url}api/v1/invite/accept?{urlencode({"invitation_id": str(new_invite.id)})}' - - return {"invitation_link": invite_link} + + response = { + "message": "Invitation link created successfully", + "data": { + "invitation_link": invite_link, + "success": True, + "status_code": status.HTTP_201_CREATED, + }, + } + return response @staticmethod def add_user_to_organization(invite_id: str, session: Session): logging.info(f"Processing invitation ID: {invite_id}") - invite = session.query(Invitation).filter_by(id=invite_id, is_valid=True).first() + invite = ( + session.query(Invitation).filter_by(id=invite_id, is_valid=True).first() + ) logging.info(f"Found invitation: {invite}") if not invite: logging.warning(f"Invitation with ID {invite_id} not found or already used") - raise HTTPException(status_code=404, detail="Invitation not found or already used") + raise HTTPException( + status_code=404, detail="Invitation not found or already used" + ) now = datetime.now(utc) logging.info(f"Current UTC time: {now}") @@ -70,7 +106,7 @@ def add_user_to_organization(invite_id: str, session: Session): user_organizations = session.execute( user_organization_association.select().where( user_organization_association.c.user_id == user.id, - user_organization_association.c.organization_id == org.id + user_organization_association.c.organization_id == org.id, ) ).fetchall() @@ -79,23 +115,60 @@ def add_user_to_organization(invite_id: str, session: Session): raise HTTPException(status_code=400, detail="User already in organization") try: - stmt = insert(user_organization_association).values(user_id=user.id, organization_id=org.id) + stmt = insert(user_organization_association).values( + user_id=user.id, organization_id=org.id + ) session.execute(stmt) session.commit() invite.is_valid = False session.commit() - response = OrderedDict([ - ("status", "success"), - ("message", "User added to organization successfully") - ]) + response = OrderedDict( + [ + ("status", "success"), + ("message", "User added to organization successfully"), + ] + ) logging.info(f"User {user.id} added to organization {org.id} successfully.") return JSONResponse(content=response) - + except Exception as e: session.rollback() logging.error(f"Error adding user to organization: {e}") - raise HTTPException(status_code=500, detail="An error occurred while adding the user to the organization") + raise HTTPException( + status_code=500, + detail="An error occurred while adding the user to the organization", + ) + @staticmethod + def delete(session: Session, id: str): + """Function to delete invite link + + Args: + session(Session): The current ORM session object. + id(str): Invite id string + + Returns: + True if delete is successful else False + + """ + invite = ( + session.query(Invitation).filter_by(id=id).first() + ) + + if invite is None: + return False + session.delete(invite) + session.commit() + return True + + def fetch(self): + pass + + def fetch_all(self): + pass + def update(self): + pass + invite_service = InviteService() \ No newline at end of file diff --git a/api/v1/services/job_application.py b/api/v1/services/job_application.py new file mode 100644 index 000000000..375821a44 --- /dev/null +++ b/api/v1/services/job_application.py @@ -0,0 +1,144 @@ +from fastapi import HTTPException, Depends, status +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.comment import Comment, CommentLike +from typing import Any, Optional, Union, Annotated +from sqlalchemy import desc +from api.db.database import get_db +from sqlalchemy.orm import Session +from api.utils.db_validators import check_model_existence +from api.utils.pagination import paginated_response +from api.v1.models.job import Job, JobApplication +from api.utils.success_response import success_response +from api.v1.schemas.job_application import (SingleJobAppResponse, + JobApplicationBase, + JobApplicationData, + JobApplicationResponseData, + CreateJobApplication, UpdateJobApplication + ) + +class JobApplicationService(Service): + """ + Job application service class + """ + + def fetch(self, job_id: str, application_id: str, + db: Annotated[Session, Depends(get_db)]): + """ + Fetch a single job application. + Args: + job_id: The id of the job for the applicant + application_id: The id of the application for the job + db: database Session object + Returne: + SingleJobAppResponse: Response on success + """ + application: object | None = db.query(JobApplication).filter_by(job_id=job_id, + id=application_id).first() + if not application: + raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, + detail='Invalid id') + else: + return SingleJobAppResponse(status='success', + status_code=status.HTTP_200_OK, + message='successfully retrieved job application.', + data=JobApplicationData.model_validate(application, + from_attributes=True)) + + def create(self, db: Session, job_id: str, schema: CreateJobApplication): + """Create a new job application""" + + job_application = JobApplication(**schema.model_dump(), job_id=job_id) + + # Check if user has already applied by checking through the email + if db.query(JobApplication).filter( + JobApplication.applicant_email == schema.applicant_email, + JobApplication.job_id == job_id, + ).first(): + raise HTTPException( + status_code=400, detail='You have already applied for this role') + + db.add(job_application) + db.commit() + db.refresh(job_application) + + return job_application + + def fetch_all( + self, job_id: str, page: int, per_page: int, db: Annotated[Session, Depends(get_db)] + ): + """Fetches all applications for a job + + Args: + job_id: the Job ID of the applications + page: the number of the current page + per_page: the page size for a current page + db: Database Session object + Returns: + Response: An exception if error occurs + object: Response object containing the applications + """ + + # check if job id exists + check_model_existence(db, Job, job_id) + + # Calculating offset value from page number and per-page given + offset_value = (page - 1) * per_page + + # Querying the db for applications of that job + applications = db.query(JobApplication).filter_by(job_id=job_id).offset(offset_value).limit(per_page).all() + + total_applications = len(applications) + + # Total pages: integer division with ceiling for remaining items + total_pages = int(total_applications / per_page) + (total_applications % per_page > 0) + + application_schema: list = [ + JobApplicationBase.model_validate(application) for application in applications + ] + application_data = JobApplicationResponseData( + page=page, per_page=per_page, total_pages=total_pages, applications=application_schema + ) + + return success_response( + status_code=200, + message="Successfully fetched job applications", + data=application_data + ) + + def update(self, db: Session, job_id: str, application_id: str, schema: UpdateJobApplication): + """Updates an application""" + + job_application = self.fetch( + db=db, job_id=job_id, application_id=application_id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True, exclude={"id"}) + for key, value in update_data.items(): + setattr(job_application, key, value) + + db.commit() + db.refresh(job_application) + return job_application + + def delete(self, job_id: str, application_id: str, + db: Annotated[Session, Depends(get_db)]): + """ + Delete a single job application. + Args: + job_id: The id of the job for the applicant + application_id: The id of the application for the job + db: database Session object + Returns: + None + """ + application: object | None = db.query(JobApplication).filter_by(job_id=job_id, + id=application_id).first() + if not application: + raise HTTPException( + status_code=404, detail='Invalid id') + db.delete(application) + db.commit() + + +job_application_service = JobApplicationService() diff --git a/api/v1/services/jobs.py b/api/v1/services/jobs.py new file mode 100644 index 000000000..41982eddc --- /dev/null +++ b/api/v1/services/jobs.py @@ -0,0 +1,71 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session + +from api.core.base.services import Service +from api.v1.models.job import Job +from fastapi import HTTPException + + +class JobService(Service): + """Job service functionality""" + + def create(self, db: Session, schema) -> Job: + """Create a new job""" + + new_job = Job(**schema.model_dump()) + db.add(new_job) + db.commit() + db.refresh(new_job) + + return new_job + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all jobs with option to search using query parameters""" + + query = db.query(Job) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(Job, column) and value: + query = query.filter(getattr(Job, column).ilike(f"%{value}%")) + + return query.all() + + + @staticmethod + def fetch(db: Session, id: str) -> Optional[Job]: + """Fetches a job by ID""" + return db.query(Job).filter(Job.id == id).first() + + def fetch(self, db: Session, id: str): + """Fetches a job by id""" + job = db.query(Job).filter(Job.id == id).first() + if not job: + raise HTTPException(status_code=404, detail="Job not found") + return job + + + def update(self, db: Session, id: str, schema): + """Updates a job""" + + job = self.fetch(db=db, id=id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(job, key, value) + + db.commit() + db.refresh(job) + return job + + def delete(self, db: Session, id: str): + """Deletes a job""" + + job = self.fetch(db=db, id=id) + db.delete(job) + db.commit() + + +job_service = JobService() diff --git a/api/v1/services/newsletter.py b/api/v1/services/newsletter.py index ff0368e89..73e950767 100644 --- a/api/v1/services/newsletter.py +++ b/api/v1/services/newsletter.py @@ -1,20 +1,22 @@ +from fastapi import HTTPException, Depends from sqlalchemy.orm import Session -from api.v1.schemas.newsletter import EMAILSCHEMA +from api.db.database import get_db +from api.v1.schemas.newsletter import EmailSchema from api.core.base.services import Service -from api.v1.models.newsletter import Newsletter - +from api.v1.models.newsletter import NewsletterSubscriber, Newsletter +from typing import Optional, Any, Annotated +from api.utils.db_validators import check_model_existence +from api.utils.success_response import success_response +from api.v1.schemas.newsletter import SingleNewsletterResponse class NewsletterService(Service): - '''Newsletter service functionality''' + """Newsletter service functionality""" @staticmethod - def create(db: Session, request: EMAILSCHEMA) -> Newsletter: - '''add a new subscriber''' + def create(db: Session, request: EmailSchema) -> NewsletterSubscriber: + """add a new subscriber""" - new_subscriber = Newsletter( - title="", - content="", - email=request.email) + new_subscriber = NewsletterSubscriber(email=request.email) db.add(new_subscriber) db.commit() db.refresh(new_subscriber) @@ -22,9 +24,74 @@ def create(db: Session, request: EMAILSCHEMA) -> Newsletter: return new_subscriber @staticmethod - def check_existing_subscriber(db: Session, request: EMAILSCHEMA) -> Newsletter: + def check_existing_subscriber( + db: Session, request: EmailSchema + ) -> NewsletterSubscriber: """ Check if user with email already exist """ - return db.query(Newsletter).filter(Newsletter.email==request.email).first() \ No newline at end of file + newsletter = ( + db.query(NewsletterSubscriber) + .filter(NewsletterSubscriber.email == request.email) + .first() + ) + if newsletter: + raise HTTPException( + status_code=400, detail="User already subscribed to newsletter" + ) + + return newsletter + + @staticmethod + def fetch(db: Session, id: str): + """Fetches a single newsletter by id""" + return check_model_existence(db=db, model=Newsletter, id=id) + + @staticmethod + def fetch_all(db: Session, **query_params: Optional[Any]): + """Fetch all newsletter subscriptions with option to search using query parameters""" + + query = db.query(NewsletterSubscriber) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(NewsletterSubscriber, column) and value: + query = query.filter( + getattr(NewsletterSubscriber, column).ilike(f"%{value}%") + ) + + return query.all() + + @staticmethod + def fetch(news_id: str, db: Annotated[Session, Depends(get_db)]): + """Fetch a single newsletter. + + Args: + news_id: The id of the newsletter + db: database Session object + + Return: + SingleNewsletterResponse: Response on success + """ + + # checking if newsletter exist and send + newsletter = check_model_existence(db, Newsletter, news_id) + return success_response( + status_code=200, + message="Successfully fetched newsletter", + data=newsletter + ) + + @staticmethod + def update(): + pass + + def delete(db: Session, id: str): + """Deletes a single newsletter by id""" + + newsletter = check_model_existence(db=db, model=Newsletter, id=id) + + db.delete(newsletter) + db.commit() \ No newline at end of file diff --git a/api/v1/services/notification.py b/api/v1/services/notification.py index b068b9701..a2a94f98e 100644 --- a/api/v1/services/notification.py +++ b/api/v1/services/notification.py @@ -8,6 +8,17 @@ class NotificationService(Service): + + def send_notification( + self, title: str, message: str, db: Session = Depends(get_db) + ): + """Function to send a notification""" + new_notification = Notification(title=title, message=message, status="unread") + db.add(new_notification) + db.commit() + db.refresh(new_notification) + return new_notification + def mark_notification_as_read( self, notification_id: str, @@ -32,29 +43,53 @@ def mark_notification_as_read( # commit changes db.commit() + db.refresh(notification) + return notification - def delete( + def delete_notification( self, notification_id: str, user: User, db: Session = Depends(get_db), ): notification = ( - db.query(Notification) - .filter(Notification.id == notification_id) - .first() + db.query(Notification).filter(Notification.id == notification_id).first() ) if not notification: raise HTTPException(status_code=404, detail="Notification not found") if notification.user_id != user.id: - raise HTTPException(status_code=403, detail="You do not have permission to delete this notification") + raise HTTPException( + status_code=403, + detail="You do not have permission to delete this notification", + ) db.delete(notification) db.commit() db.refresh() + def get_current_user_notifications(self, user: User, db: Session = Depends(get_db)): + """Endpoint to get current user notifications""" + + return {"notifications": user.notifications} + + def fetch_notification_by_id( + self, notification_id: str, db: Session = Depends(get_db) + ): + """Function to fetch any notification by ID""" + notification = ( + db.query(Notification).filter(Notification.id == notification_id).first() + ) + if not notification: + raise HTTPException(status_code=404, detail="Notification not found") + return notification + + def fetch_all_notifications(self, db: Session): + """Function to fetch all notifications""" + notifications = db.query(Notification).all() + return [notification.to_dict() for notification in notifications] + def create(self): super().create() @@ -67,4 +102,8 @@ def fetch_all(self): def update(self): super().update() + def delete(self): + return super().delete() + + notification_service = NotificationService() diff --git a/api/v1/services/notification_settings.py b/api/v1/services/notification_settings.py new file mode 100644 index 000000000..b3c119f0d --- /dev/null +++ b/api/v1/services/notification_settings.py @@ -0,0 +1,71 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.notifications import NotificationSetting +from api.v1.models.user import User +from api.v1.schemas.notification_settings import NotificationSettingsBase +from api.utils.db_validators import check_model_existence + + +class NotificationSettingService(Service): + '''Notification settings service functionality''' + + def create(self, db: Session, user: User): + '''Create a new notification setting for a user''' + + new_setting = NotificationSetting(user_id=user.id) + db.add(new_setting) + db.commit() + db.refresh(new_setting) + + return new_setting + + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + '''Fetch all notification settings with option to search using query parameters''' + + query = db.query(NotificationSetting) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(NotificationSetting, column) and value: + query = query.filter(getattr(NotificationSetting, column).ilike(f'%{value}%')) + + return query.all() + + + def fetch(self, db: Session, id: str): + '''Fetches a notification service by id''' + + notification_setting = check_model_existence(db, NotificationSetting, id) + return notification_setting + + + def fetch_by_user_id(self, db: Session, user_id: str): + '''Fetches a notification service by the user id of the user''' + + return db.query(NotificationSetting).filter(NotificationSetting.user_id == user_id).first() + + + def update(self, db: Session, user_id: str, schema: NotificationSettingsBase): + '''Updates an notification service''' + + notification_setting = self.fetch_by_user_id(db=db, user_id=user_id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(notification_setting, key, value) + + db.commit() + db.refresh(notification_setting) + return notification_setting + + + def delete(self, db: Session, id: str): + '''Deletes an notification service''' + pass + + +notification_setting_service = NotificationSettingService() diff --git a/api/v1/services/organization.py b/api/v1/services/organization.py new file mode 100644 index 000000000..b214f391f --- /dev/null +++ b/api/v1/services/organization.py @@ -0,0 +1,290 @@ +import csv +from io import StringIO +import logging +from typing import Any, Optional +from fastapi import HTTPException +from sqlalchemy.orm import Session +from fastapi import HTTPException, status +from sqlalchemy import select +from api.core.base.services import Service +from api.utils.db_validators import check_model_existence, check_user_in_org +from api.utils.pagination import paginated_response +from api.v1.models.product import Product +from api.v1.models.associations import user_organization_association +from api.v1.models.organization import Organization +from api.v1.models.user import User +from api.v1.schemas.organization import ( + CreateUpdateOrganization, + AddUpdateOrganizationRole, + RemoveUserFromOrganization +) + + +class OrganizationService(Service): + """Organization service functionality""" + + def create(self, db: Session, schema: CreateUpdateOrganization, user: User): + """Create a new product""" + + # Create a new organization + new_organization = Organization(**schema.model_dump()) + email = schema.model_dump()["email"] + name = schema.model_dump()["name"] + self.check_by_email(db, email) + self.check_by_name(db, name) + + db.add(new_organization) + db.commit() + db.refresh(new_organization) + + # Add user as owner to the new organization + stmt = user_organization_association.insert().values( + user_id=user.id, organization_id=new_organization.id, role="owner" + ) + db.execute(stmt) + db.commit() + + return new_organization + + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all products with option tto search using query parameters""" + + query = db.query(Organization) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(Organization, column) and value: + query = query.filter( + getattr(Organization, column).ilike(f"%{value}%") + ) + + return query.all() + + + def fetch(self, db: Session, id: str): + """Fetches an organization by id""" + + organization = check_model_existence(db, Organization, id) + + return organization + + def get_organization_user_role(self, user_id: str, org_id: str, db: Session): + try: + stmt = select(user_organization_association.c.role).where( + user_organization_association.c.user_id == user_id, + user_organization_association.c.organization_id == org_id, + ) + result = db.execute(stmt).scalar_one_or_none() + return result + except Exception as e: + print(f"An error occurred: {e}") + return None + + def update(self, db: Session, id: str, schema, current_user: User): + """Updates a product""" + + organization = self.fetch(db=db, id=id) + + # check if the current user has the permission to update the organization + role = self.get_organization_user_role(current_user.id, id, db) + if role not in ["admin", "owner"]: + raise HTTPException( + status_code=status.HTTP_403_FORBIDDEN, detail="Not enough permissions" + ) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(organization, key, value) + + db.commit() + db.refresh(organization) + return organization + + def delete(self, db: Session, id: str): + '''Deletes a product''' + + organization = self.fetch(db, id=id) + db.delete(organization) + db.commit() + + def check_user_role_in_org(self, db: Session, user: User, org: Organization, role: str): + '''Check user role in organization''' + + if role not in ['user', 'guest', 'admin', 'owner']: + raise HTTPException(status_code=400, detail="Invalid role") + + stmt = user_organization_association.select().where( + user_organization_association.c.user_id == user.id, + user_organization_association.c.organization_id == org.id, + user_organization_association.c.role == role, + ) + + result = db.execute(stmt).fetchone() + + if result is None: + raise HTTPException(status_code=403, detail=f"Permission denied as user is not of {role} role") + + + # def update_user_role(self, schema: AddUpdateOrganizationRole, db: Session, org_id: str, user_to_update_id: str): + def update_user_role(self, schema: AddUpdateOrganizationRole, db: Session): + '''Updates a user role''' + + # Fetch the user and organization + user = check_model_existence(db, User, schema.user_id) + organization = check_model_existence(db, Organization, schema.org_id) + + # Check if user is not in organization + check_user_in_org(user, organization) + + # Update user role + stmt = user_organization_association.update().where( + user_organization_association.c.user_id == schema.user_id, + user_organization_association.c.organization_id == schema.org_id, + ).values(role=schema.role) + + db.execute(stmt) + db.commit() + + + # def add_user_to_organization(self, db: Session, org_id: str, user_id: str): + def add_user_to_organization(self, schema: AddUpdateOrganizationRole, db: Session): + '''Adds a user to an organization''' + + # Fetch the user and organization + user = check_model_existence(db, User, schema.user_id) + organization = check_model_existence(db, Organization, schema.org_id) + + # Check if user is not in organization + check_user_in_org(user, organization) + + # Check for user role permissions + self.check_user_role_in_org(db=db, user=user, org=organization, role='admin')\ + or self.check_user_role_in_org(db=db, user=user, org=organization, role='owner') + + # Update user role + stmt = user_organization_association.insert().values( + user_id=user.id, + organization_id=organization.id, + role=schema.role + ) + + db.execute(stmt) + db.commit() + + + # # def remove_user_from_organization(self, db: Session, org_id: str, user_id: str): + def remove_user_from_organization(self, schema: RemoveUserFromOrganization, db: Session): + '''Deletes a user from an organization''' + + # Fetch the user and organization + user = check_model_existence(db, User, schema.user_id) + organization = check_model_existence(db, Organization, schema.org_id) + + # Check if user is not in organization + check_user_in_org(user, organization) + + # Check for user role permissions + self.check_user_role_in_org(db=db, user=user, org=organization, role='admin')\ + or self.check_user_role_in_org(db=db, user=user, org=organization, role='owner') + + # Update user role + stmt = user_organization_association.delete().where( + user_organization_association.c.user_id == schema.user_id, + user_organization_association.c.organization_id == schema.org_id, + ) + + db.execute(stmt) + db.commit() + + + def get_users_in_organization(self, db: Session, org_id: str): + '''Fetches all users in an organization''' + + organization = check_model_existence(db, Organization, org_id) + + # Fetch all users associated with the organization + return organization.users + + + def paginate_users_in_organization( + self, + db: Session, + org_id: str, + page: int, + per_page: int + ): + '''Fetches all users in an organization''' + + check_model_existence(db, Organization, org_id) + + return paginated_response( + db=db, + model=User, + skip=page, + join=user_organization_association, + filters={'organization_id': org_id}, + limit=per_page + ) + + + + def get_user_organizations(self, db: Session, user_id: str): + '''Fetches all organizations that belong to a user''' + + user = check_model_existence(db, User, user_id) + + # Fetch all users associated with the organization + return user.organizations + + def check_by_email(self, db: Session, email): + """Fetches a user by their email""" + + org = db.query(Organization).filter(Organization.email == email).first() + + if org: + raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="an organization with this email already exist") + + return False + + def check_by_name(self, db: Session, name): + """Fetches a user by their email""" + + org = db.query(Organization).filter(Organization.name == name).first() + + if org: + raise HTTPException(status_code=status.HTTP_409_CONFLICT, detail="an organization with this name already exist") + + return False + + def check_organization_exist(self, db: Session, org_id): + organization = db.query(Organization).filter(Organization.id == org_id).first() + if organization is None: + raise HTTPException(status_code=404, detail="Organization not found") + else: + return True + + def export_organization_members(self, db: Session, org_id: str): + '''Exports the organization members''' + + org = self.fetch(db=db, id=org_id) + + csv_file = StringIO() + csv_writer = csv.writer(csv_file) + + # Write headers + csv_writer.writerow(["ID", "First name", 'Last name', "Email", 'Date registered']) + + # Write member data + for user in org.users: + csv_writer.writerow([user.id, user.first_name, user.last_name, user.email, user.created_at]) + + # Move to the beginning of the file + csv_file.seek(0) + + return csv_file + + +organization_service = OrganizationService() diff --git a/api/v1/services/payment.py b/api/v1/services/payment.py new file mode 100644 index 000000000..d9bd17261 --- /dev/null +++ b/api/v1/services/payment.py @@ -0,0 +1,94 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from api.v1.models.payment import Payment + +from fastapi import HTTPException +from api.v1.models import User +from api.v1.models.payment import Payment +from api.utils.db_validators import check_model_existence + + +class PaymentService: + """Payment service functionality""" + + def create(self, db: Session, schema): + """Create a new payment""" + + new_payment = Payment(**schema) + db.add(new_payment) + db.commit() + db.refresh(new_payment) + + return new_payment + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all payments with option to search using query parameters""" + + query = db.query(Payment) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(Payment, column) and value: + query = query.filter(getattr(Payment, column).ilike(f"%{value}%")) + + return query.all() + + def fetch(self, db: Session, payment_id: str): + """Fetches a payment by id""" + + payment = check_model_existence(db, Payment, payment_id) + return payment + + def get_payment_by_id(self, db: Session, payment_id: str): + payment = check_model_existence(db, Payment, payment_id) + return payment + + def get_payment_by_transaction_id(self, db: Session, transaction_id: str): + try: + payment = db.query(Payment).filter(Payment.transaction_id==transaction_id).first() + return payment + except Exception: + raise HTTPException(status_code=404, detail='Payment record not found in the database') + + def fetch_by_user(self, db: Session, user_id, limit, page): + """Fetches all payments of a user""" + + # check if user exists + _ = check_model_existence(db, User, user_id) + + # calculating offset value + # from page and limit given + offset_value = (page - 1) * limit + + # Filter to return only payments of the user_id + payments = ( + db.query(Payment) + .filter(Payment.user_id == user_id) + .offset(offset_value) + .limit(limit) + .all() + ) + + return payments + + def update(self, db: Session, payment_id: str, schema): + """Updates a payment""" + + payment = self.fetch(db=db, payment_id=payment_id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(payment, key, value) + + db.commit() + db.refresh(payment) + return payment + + def delete(self, db: Session, payment_id: str): + """Deletes a payment""" + + payment = self.fetch(db=db, payment_id=payment_id) + db.delete(payment) + db.commit() diff --git a/api/v1/services/permissions/__init__.py b/api/v1/services/permissions/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/api/v1/services/permissions/permison_service.py b/api/v1/services/permissions/permison_service.py new file mode 100644 index 000000000..3ef427ca5 --- /dev/null +++ b/api/v1/services/permissions/permison_service.py @@ -0,0 +1,101 @@ +from sqlalchemy.orm import Session +from api.v1.models.permissions.permissions import Permission +from api.v1.models.permissions.role import Role +from api.v1.schemas.permissions.permissions import PermissionCreate +from api.utils.success_response import success_response +from api.v1.models.permissions.role_permissions import role_permissions +from uuid import UUID +from fastapi import HTTPException,status +from sqlalchemy.exc import IntegrityError +from sqlalchemy import delete + +class PermissionService: + @staticmethod + def create_permission(db: Session, permission: PermissionCreate) -> Permission: + try: + db_permission = Permission(name=permission.name) + db.add(db_permission) + db.commit() + db.refresh(db_permission) + response = success_response(200, "permissions created successfully", db_permission) + return response + except IntegrityError as e: + db.rollback() + raise HTTPException(status_code=400, detail="A permission with this name already exists.") + except Exception as e: + db.rollback() + raise HTTPException(status_code=500, detail="An unexpected error occurred: " + str(e)) + + @staticmethod + def assign_permission_to_role(db: Session, role_id: str, permission_id: str): + try: + # Check if the role exists + role = db.query(Role).filter_by(id=role_id).first() + if not role: + raise HTTPException(status_code=404, detail="Role not found.") + + # Check if the permission exists + permission = db.query(Permission).filter_by(id=permission_id).first() + if not permission: + raise HTTPException(status_code=404, detail="Permission not found.") + + # Assign the permission to the role + stmt = role_permissions.insert().values(role_id=role_id, permission_id=permission_id) + db.execute(stmt) + db.commit() + + response = success_response(200, "Permission assigned successfully") + return response + + except IntegrityError: + db.rollback() + raise HTTPException(status_code=400, detail="An error occurred while assigning the permission.") + except Exception as e: + db.rollback() + raise HTTPException(status_code=500, detail=str(e)) + + @staticmethod + def delete_permission(db:Session, permission_id : str): + permission = db.query(Permission).filter(Permission.id == permission_id).first() + if permission : + try: + db.execute(delete(role_permissions).where(role_permissions.c.permission_id == permission_id)) + db.delete(permission) + db.commit() + return {} + except IntegrityError as e : + db.rollback() + raise HTTPException(status_code=400, detail="A Permission with this name already exists.") + except Exception as e: + db.rollback() + raise HTTPException(status_code=500, detail="An unexpected error occurred: " + str(e)) + raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail='Not Found') + + @staticmethod + def update_permission_on_role(db: Session, role_id: str, permission_id: str, new_permission_id: str): + role = db.query(Role).filter_by(id=role_id).first() + # Check if the role exists + if not role: + raise HTTPException(status_code=404, detail="Role not found.") + new_permission = db.query(Permission).filter_by(id=new_permission_id).first() + if not new_permission: + raise HTTPException(status_code=404, detail="New permission not found.") + try: + + # Check if the new permission exists + # Remove the old permission from the role + db.execute(delete(role_permissions).where(role_permissions.c.role_id == role_id).where(role_permissions.c.permission_id == permission_id)) + + # Assign the new permission to the role + db.execute(role_permissions.insert().values(role_id=role_id, permission_id=new_permission_id)) + db.commit() + return {"success": True, "message": "Permission updated successfully"} + + except IntegrityError as e: + db.rollback() + raise HTTPException(status_code=400, detail="An error occurred while updating the permission.") + except Exception as e: + db.rollback() + raise HTTPException(status_code=500, detail=str(e)) + +permission_service = PermissionService() diff --git a/api/v1/services/permissions/role_service.py b/api/v1/services/permissions/role_service.py new file mode 100644 index 000000000..0cafd20b0 --- /dev/null +++ b/api/v1/services/permissions/role_service.py @@ -0,0 +1,69 @@ +from sqlalchemy.orm import Session +from api.v1.models.permissions.role import Role +from api.v1.models.permissions.user_org_role import user_organization_roles +from api.v1.schemas.permissions.roles import RoleDeleteResponse +from api.v1.schemas.role import RoleCreate +from uuid_extensions import uuid7 +from api.utils.success_response import success_response +from fastapi import HTTPException +from sqlalchemy.exc import IntegrityError + + +class RoleService: + + @staticmethod + def create_role(db: Session, role: RoleCreate) -> Role: + try: + db_role = Role(name=role.name) + db.add(db_role) + db.commit() + db.refresh(db_role) + response = success_response(201, f'role {role.name} created successfully', db_role) + return response + except IntegrityError as e: + db.rollback() + raise HTTPException(status_code=400, detail="A role with this name already exists.") + except Exception as e: + db.rollback() + raise HTTPException(status_code=500, detail="An unexpected error occurred: " + str(e)) + + @staticmethod + def assign_role_to_user(db: Session, org_id: uuid7, user_id: uuid7, role_id: uuid7): + try: + db.execute(user_organization_roles.insert().values( + organization_id=org_id, + user_id=user_id, + role_id=role_id + )) + db.commit() + return success_response(200, "role successfully added to user") + except IntegrityError as e: + db.rollback() + raise HTTPException(status_code=400, detail="The role or user might not exist, or there might be a duplication issue.") + except Exception as e: + db.rollback() + raise HTTPException(status_code=500, detail="An unexpected error occurred: " + str(e)) + + @staticmethod + def delete_role(db: Session, role_id: str) -> RoleDeleteResponse: + role = db.query(Role).filter(Role.id == role_id).first() + if not role: + raise HTTPException(status_code=404, detail="Role not found") + + db.delete(role) + db.commit() + return RoleDeleteResponse(id=role_id, message="Role successfully deleted") + + + + @staticmethod + def get_roles_by_organization(db: Session, organization_id: str): + roles = db.query(Role).join( + user_organization_roles, Role.id == user_organization_roles.c.role_id + ).filter(user_organization_roles.c.organization_id == organization_id).all() + if not roles: + raise HTTPException(status_code=404, detail="Roles not found for the given organization") + return roles + + +role_service = RoleService() \ No newline at end of file diff --git a/api/v1/services/privacy_policies.py b/api/v1/services/privacy_policies.py new file mode 100644 index 000000000..2b3ac80f9 --- /dev/null +++ b/api/v1/services/privacy_policies.py @@ -0,0 +1,67 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.privacy import PrivacyPolicy +from api.v1.schemas.privacy_policies import PrivacyPolicyCreate, PrivacyPolicyUpdate +from api.utils.db_validators import check_model_existence + + +class PrivacyService(Service): + """Privacy Services""" + + def create(self, db: Session, schema: PrivacyPolicyCreate): + '''Create a new Privacy''' + + new_privacy = PrivacyPolicy(**schema.model_dump()) + db.add(new_privacy) + db.commit() + db.refresh(new_privacy) + + return new_privacy + + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + '''Fetch all Privacy with option to search using query parameters''' + + query = db.query(PrivacyPolicy) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(PrivacyPolicy, column) and value: + query = query.filter(getattr(PrivacyPolicy, column).ilike(f'%{value}%')) + + return query.all() + + + def fetch(self, db: Session, privacy_id: str): + '''Fetches a privacy by id''' + + privacy = check_model_existence(db, PrivacyPolicy, privacy_id) + return privacy + + + def update(self, db: Session, privacy_id: str, schema: PrivacyPolicyUpdate): + '''Updates a Privacy''' + + privacy = self.fetch(db=db, privacy_id=privacy_id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(privacy, key, value) + + db.commit() + db.refresh(privacy) + return privacy + + + def delete(self, db: Session, privacy_id: str): + '''Deletes a privacy service''' + + privacy = self.fetch(db=db, privacy_id=privacy_id) + db.delete(privacy) + db.commit() + + +privacy_service = PrivacyService() diff --git a/api/v1/services/product.py b/api/v1/services/product.py index a4a79c1de..dca23c630 100644 --- a/api/v1/services/product.py +++ b/api/v1/services/product.py @@ -1,29 +1,68 @@ from typing import Any, Optional +import sqlalchemy from sqlalchemy.orm import Session +from sqlalchemy import func +from fastapi import HTTPException, status + from api.core.base.services import Service from api.utils.db_validators import check_model_existence -from api.v1.models.product import Product +from api.v1.models.product import Product, ProductFilterStatusEnum, ProductStatusEnum, ProductCategory +from api.v1.models.user import User from api.v1.models import Organization +from api.v1.schemas.product import ProductCategoryCreate, ProductCreate from api.utils.db_validators import check_user_in_org +from api.v1.schemas.product import ProductFilterResponse class ProductService(Service): - '''Product service functionality''' + """Product service functionality""" + + def create( + self, db: Session, schema: ProductCreate, org_id: str, current_user: User + ): + """Create a new product""" + + # check if user belongs to org + + organization = check_model_existence(db, Organization, org_id) + + check_user_in_org(user=current_user, organization=organization) + + # check if user inputted a valid category - def create(self, db: Session, schema): - '''Create a new product''' + category_name = schema.category + category = ( + db.query(ProductCategory) + .filter(func.lower(ProductCategory.name) == func.lower(category_name)) + .first() + ) + + if not category: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, + detail=f"{category_name} category does not exist", + ) + + # add org_id, category_id and remove category field from schema + + product_schema = schema.model_dump() + product_schema.pop("category") + product_schema["category_id"] = category.id + product_schema["org_id"] = org_id + + # create new product + + new_product = Product(**product_schema) - new_product = Product(**schema.model_dump()) db.add(new_product) db.commit() db.refresh(new_product) return new_product - def fetch_all(self, db: Session, **query_params: Optional[Any]): - '''Fetch all products with option tto search using query parameters''' + """Fetch all products with option tto search using query parameters""" query = db.query(Product) @@ -31,19 +70,19 @@ def fetch_all(self, db: Session, **query_params: Optional[Any]): if query_params: for column, value in query_params.items(): if hasattr(Product, column) and value: - query = query.filter(getattr(Product, column).ilike(f'%{value}%')) + query = query.filter( + getattr(Product, column).ilike(f"%{value}%")) return query.all() - - def fetch(self, db: Session, id: str): - '''Fetches a product by id''' + def fetch(self, db: Session, id: str) -> Product: + """Fetches a product by id""" product = check_model_existence(db, Product, id) return product def fetch_by_organization(self, db: Session, user, org_id, limit, page): - '''Fetches all products of an organization''' + """Fetches all products of an organization""" # check if organization exists organization = check_model_existence(db, Organization, org_id) @@ -55,30 +94,149 @@ def fetch_by_organization(self, db: Session, user, org_id, limit, page): offset_value = (page - 1) * limit # Filter to return only products of the org_id - products = db.query(Product).filter(Product.org_id == org_id).offset(offset_value).limit(limit).all() + products = ( + db.query(Product) + .filter(Product.org_id == org_id) + .offset(offset_value) + .limit(limit) + .all() + ) return products + def fetch_by_filter_status( + self, db: Session, filter_status: ProductFilterStatusEnum + ): + """Fetch products by filter status""" + try: + products = ( + db.query(Product) + .filter(Product.filter_status == filter_status.value) + .all() + ) + return [ProductFilterResponse.from_orm(product) for product in products] + except Exception as e: + raise + + def fetch_by_status(self, db: Session, status: ProductStatusEnum): + """Fetch products by filter status""" + try: + products = db.query(Product).filter( + Product.status == status.value).all() + response_data = [ + ProductFilterResponse.from_orm(product) for product in products + ] + return response_data + except Exception as e: + raise + + def fetch_stock(self, db: Session, product_id: str, current_user: User) -> dict: + """Fetches the current stock level for a specific product""" + product = check_model_existence(db, Product, product_id) + + organization = check_model_existence(db, Organization, product.org_id) + + check_user_in_org(user=current_user, organization=organization) + + total_stock = product.quantity + + return { + "product_id": product_id, + "current_stock": total_stock, + "last_updated": product.updated_at + } + def update(self, db: Session, id: str, schema): - '''Updates a product''' + """Updates a product""" product = self.fetch(db=db, id=id) - + # Update the fields with the provided schema data update_data = schema.dict(exclude_unset=True) for key, value in update_data.items(): setattr(product, key, value) - + db.commit() db.refresh(product) return product - - def delete(self, db: Session, id: str): - '''Deletes a product''' - - product = self.fetch(id=id) + def delete(self, db: Session, org_id: str, product_id: str, current_user: User): + """Deletes a product""" + + product: Product = self.fetch(db=db, id=id) + + # check ownership + + if org_id != product.org_id: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, + detail="product doesn't belong to the specified organisation", + ) + + organization = check_model_existence(db, Organization, org_id) + + check_user_in_org(user=current_user, organization=organization) + + # delete the product + db.delete(product) db.commit() + + def fetch_single_by_organization(self, db: Session, org_id: str, product_id: str, current_user: User) -> Product: + """Fetches a product by id""" + + # check if user belongs to org + + organization = check_model_existence(db, Organization, org_id) + + check_user_in_org(user=current_user, organization=organization) + + product = check_model_existence(db, Product, product_id) + return product + + +class ProductCategoryService(Service): + """Product categories service functionality""" + + @staticmethod + def create( + db: Session, + org_id: str, + schema: ProductCategoryCreate, + current_user: User + ): + organization = check_model_existence(db, Organization, org_id) + + check_user_in_org(user=current_user, organization=organization) + + try: + new_category = ProductCategory(**schema.model_dump()) + db.add(new_category) + db.commit() + db.refresh(new_category) + except sqlalchemy.exc.IntegrityError: + raise HTTPException( + status_code=status.HTTP_400_BAD_REQUEST, + detail="Category already exists.", + ) + + return new_category -product_service = ProductService() \ No newline at end of file + + @staticmethod + def fetch_all(db: Session, **query_params: Optional[Any]): + '''Fetch all newsletter subscriptions with option to search using query parameters''' + + query = db.query(ProductCategory) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(ProductCategory, column) and value: + query = query.filter( + getattr(ProductCategory, column).ilike(f'%{value}%')) + + return query.all() + + +product_service = ProductService() diff --git a/api/v1/services/profile.py b/api/v1/services/profile.py index 1cbdef135..154d23d6b 100644 --- a/api/v1/services/profile.py +++ b/api/v1/services/profile.py @@ -1,83 +1,101 @@ -from typing import Any, Optional -from sqlalchemy.orm import Session -from fastapi import HTTPException -from api.core.base.services import Service -from api.utils.db_validators import check_model_existence -from api.v1.models.profile import Profile -from api.v1.schemas.profile import ProfileCreateUpdate - - -class ProfileService(Service): - '''Profile service functionality''' - - def create(self, db: Session, schema:ProfileCreateUpdate, user_id: str): - '''Create a new Profile''' - profile = db.query(Profile).filter(Profile.user_id==user_id).first() - - if profile: - raise HTTPException(status_code=400, detail="User profile already exist") - - new_Profile = Profile(**schema.model_dump(), user_id=user_id) - db.add(new_Profile) - db.commit() - db.refresh(new_Profile) - - return new_Profile - - - def fetch_all(self, db: Session, **query_params: Optional[Any]): - '''Fetch all Profiles with option tto search using query parameters''' - - query = db.query(Profile) - - # Enable filter by query parameter - if query_params: - for column, value in query_params.items(): - if hasattr(Profile, column) and value: - query = query.filter(getattr(Profile, column).ilike(f'%{value}%')) - - return query.all() - - - def fetch(self, db: Session, id: str): - '''Fetches a user by their id''' - - profile = check_model_existence(db, Profile, id) - return profile - - def fetch_by_user_id(self, db: Session, user_id: str): - '''Fetches a user by their id''' - - profile = db.query(Profile).filter(Profile.user_id==user_id).first() - - if not profile: - raise HTTPException(status_code=404, detail="User profile not found") - - return profile - - - def update(self, db: Session, schema:ProfileCreateUpdate, user_id: str): - '''Updates a Profile''' - - profile = self.fetch_by_user_id(db, user_id) - - # Update the fields with the provided schema data - update_data = schema.model_dump() - for key, value in update_data.items(): - setattr(profile, key, value) - - db.commit() - db.refresh(profile) - return profile - - - def delete(self, db: Session, id: str): - '''Deletes a profile''' - - profile = self.fetch(id=id) - db.delete(profile) - db.commit() - -profile_service = ProfileService() - - \ No newline at end of file +from typing import Any, Optional +from datetime import datetime +from sqlalchemy.orm import Session +from fastapi import HTTPException +from api.core.base.services import Service +from api.utils.db_validators import check_model_existence +from api.v1.models.profile import Profile +from api.v1.schemas.profile import ProfileCreateUpdate +from api.v1.models.user import User + + +class ProfileService(Service): + """Profile service functionality""" + + def create(self, db: Session, schema: ProfileCreateUpdate, user_id: str): + """Create a new Profile""" + profile = db.query(Profile).filter(Profile.user_id == user_id).first() + + if profile: + raise HTTPException(status_code=400, detail="User profile already exists") + + new_profile = Profile(**schema.model_dump(), user_id=user_id) + db.add(new_profile) + db.commit() + db.refresh(new_profile) + + return new_profile + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + """Fetch all Profiles with option to search using query parameters""" + + query = db.query(Profile) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(Profile, column) and value: + query = query.filter(getattr(Profile, column).ilike(f"%{value}%")) + + return query.all() + + def fetch(self, db: Session, id: str): + """Fetches a user by their id""" + + profile = check_model_existence(db, Profile, id) + return profile + + def fetch_by_user_id(self, db: Session, user_id: str): + """Fetches a user by their id""" + + profile = db.query(Profile).filter(Profile.user_id == user_id).first() + + if not profile: + raise HTTPException(status_code=404, detail="User profile not found") + + return profile + + def update(self, db: Session, schema: ProfileCreateUpdate, user_id: str) -> Profile: + profile = db.query(Profile).filter(Profile.user_id == user_id).first() + if not profile: + raise HTTPException(status_code=404, detail="User profile not found") + + # Update only the fields that are provided in the schema + for field, value in schema.model_dump().items(): + if value is not None: + setattr(profile, field, value) + + for key, value in schema.dict(exclude_unset=True).items(): + setattr(profile, key, value) + + profile.updated_at = datetime.now() + db.commit() + db.refresh(profile) + return profile + + def delete(self, db: Session, id: str): + """Deletes a profile""" + + profile = self.fetch(id=id) + db.delete(profile) + db.commit() + + def fetch_user_by_id(self, db: Session, user_id: str): + """Fetches a user by their id""" + + user = db.query(User).filter(User.id == user_id).first() + + if not user: + raise HTTPException(status_code=404, detail="User not found") + + return user + def update_user_avatar(self, db: Session, user_id: int, avatar_url: str): + user = self.fetch_user_by_id(db, user_id) + if user: + user.avatar_url = avatar_url + db.commit() + else: + raise Exception("User not found") + + +profile_service = ProfileService() diff --git a/api/v1/services/regions.py b/api/v1/services/regions.py new file mode 100644 index 000000000..aaa05e07b --- /dev/null +++ b/api/v1/services/regions.py @@ -0,0 +1,67 @@ +from typing import Any, Optional +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.regions import Region +from api.v1.schemas.regions import RegionUpdate, RegionCreate +from api.utils.db_validators import check_model_existence + + +class RegionService(Service): + """Region Services""" + + def create(self, db: Session, schema: RegionCreate, user_id: str): + '''Create a new Region''' + + new_region = Region(**schema.model_dump(), user_id=user_id) + db.add(new_region) + db.commit() + db.refresh(new_region) + + return new_region + + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + '''Fetch all Region with option to search using query parameters''' + + query = db.query(Region) + + # Enable filter by query parameter + if query_params: + for column, value in query_params.items(): + if hasattr(Region, column) and value: + query = query.filter(getattr(Region, column).ilike(f'%{value}%')) + + return query.all() + + + def fetch(self, db: Session, region_id: str): + '''Fetches a Region by id''' + + region = check_model_existence(db, Region, region_id) + return region + + + def update(self, db: Session, region_id: str, schema: RegionUpdate): + '''Updates a Region''' + + region = self.fetch(db=db, region_id=region_id) + + # Update the fields with the provided schema data + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(region, key, value) + + db.commit() + db.refresh(region) + return region + + + def delete(self, db: Session, region_id: str): + '''Deletes a region service''' + + region = self.fetch(db=db, region_id=region_id) + db.delete(region) + db.commit() + + +region_service = RegionService() diff --git a/api/v1/services/request_pwd.py b/api/v1/services/request_pwd.py new file mode 100644 index 000000000..20d443d21 --- /dev/null +++ b/api/v1/services/request_pwd.py @@ -0,0 +1,140 @@ +import logging +from datetime import datetime, timedelta +from sqlalchemy.orm import Session +from fastapi import HTTPException, Request, Query, Depends, status +from sqlalchemy.exc import SQLAlchemyError +from fastapi.responses import JSONResponse +from api.db.database import get_db +from api.utils.success_response import success_response +from api.v1.models.user import User +from api.v1.schemas import request_password_reset +from itsdangerous import URLSafeTimedSerializer, BadSignature, SignatureExpired +from api.core.dependencies.email_sender import send_email +from fastapi import BackgroundTasks +from api.v1.services.email_services import EmailService +from passlib.context import CryptContext +from typing import Optional + +# Password hashing +pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto") + +# Token serializer +SECRET_KEY = "supersecretkey" +serializer = URLSafeTimedSerializer(SECRET_KEY) + + +# Helper functions +def create_reset_token(email: str) -> str: + return serializer.dumps(email, salt=SECRET_KEY) + + +def verify_reset_token(token: str, expiration: int = 3600) -> Optional[str]: + try: + email = serializer.loads(token, salt=SECRET_KEY, max_age=expiration) + return email + except (BadSignature, SignatureExpired): + return None + + +def get_password_hash(password: str) -> str: + return pwd_context.hash(password) + + +def verify_password(plain_password: str, hashed_password: str) -> bool: + return pwd_context.verify(plain_password, hashed_password) + + +class RequestPasswordService: + @staticmethod + async def create(email: request_password_reset.RequestEmail, request: Request, session: Session, background_tasks: BackgroundTasks): + + user = session.query(User).filter_by(email=email.user_email).first() + + if not user: + raise HTTPException(status_code=404, detail="User not found") + + token = create_reset_token(email.user_email) + + base_url = request.base_url + reset_link = f"{base_url}api/v1/auth/reset-password?token={token}" + + # Sending the email + email_service = EmailService() + subject = "HNG11 Password Reset" + body = f"Please use the following link to reset your password: {reset_link}" + await email_service.send_email( + background_tasks=background_tasks, + to_email=email.user_email, + subject=subject, + body=body, + from_name="HNG11 Support" + ) + + # Return the success response + return success_response( + message="Password reset link sent successfully", + data={"reset_link": reset_link}, + status_code=status.HTTP_201_CREATED + ) + + # return success_response( + # message="Password reset link sent successfully", + # data={"reset_link": reset_link}, + # status_code=status.HTTP_201_CREATED + # ) + + @staticmethod + def process_reset_link(token: str = Query(...), session: Session = Depends(get_db)): + + email = verify_reset_token(token) + + if not email: + raise HTTPException(status_code=400, detail="Invalid or expired token") + + user = session.query(User).filter_by(email=email).first() + + if not user: + raise HTTPException(status_code=404, detail="User not found") + + return success_response( + message=f"token is valid for user {email}", + status_code=status.HTTP_302_FOUND, + ) + + @staticmethod + def reset_password( + data: request_password_reset.ResetPassword = Depends(), + token: str = Query(...), + session: Session = Depends(get_db), + ): + try: + email = verify_reset_token(token) + + if not email: + raise HTTPException(status_code=400, detail="Invalid or expired token") + + user = session.query(User).filter_by(email=email).first() + if not user: + raise HTTPException(status_code=404, detail="User not found") + + if data.new_password != data.confirm_new_password: + raise HTTPException(status_code=400, detail="Passwords do not match") + + user.password = get_password_hash(data.new_password) + session.commit() + + return success_response( + message="Password has been reset successfully", + status_code=status.HTTP_200_OK, + ) + + except SQLAlchemyError as e: + session.rollback() # Rollback the session in case of an error + print(f"Database error: {e}") # Log the error for debugging purposes + raise HTTPException( + status_code=500, + detail="An error occurred while processing your request.", + ) + + +reset_service = RequestPasswordService() \ No newline at end of file diff --git a/api/v1/services/sms_twilio.py b/api/v1/services/sms_twilio.py new file mode 100644 index 000000000..fe50b53cb --- /dev/null +++ b/api/v1/services/sms_twilio.py @@ -0,0 +1,16 @@ +from twilio.rest import Client +from api.utils.settings import settings + +client = Client(settings.TWILIO_ACCOUNT_SID, settings.TWILIO_AUTH_TOKEN) + +def send_sms(phone_number: str, message: str): + try: + message = client.messages.create( + body=message, + from_=settings.TWILIO_PHONE_NUMBER, + to=phone_number + ) + return {"status": "success", "sid": message.sid} + except Exception as e: + return {"status": "error", "detail": str(e)} + \ No newline at end of file diff --git a/api/v1/services/squeeze.py b/api/v1/services/squeeze.py new file mode 100644 index 000000000..0096a1a90 --- /dev/null +++ b/api/v1/services/squeeze.py @@ -0,0 +1,72 @@ +from fastapi import HTTPException +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.squeeze import Squeeze +from api.v1.schemas.squeeze import CreateSqueeze, FilterSqueeze + + +class SqueezeService(Service): + """Squeeze service""" + + def create(self, db: Session, data: CreateSqueeze): + """Create squeeze page""" + new_squeeze = Squeeze( + title=data.title, + email=data.email, + user_id=data.user_id, + url_slug=data.url_slug, + headline=data.headline, + sub_headline=data.sub_headline, + body=data.body, + type=data.type, + status=data.status, + full_name=data.full_name, + ) + db.add(new_squeeze) + db.commit() + db.refresh(new_squeeze) + return new_squeeze + + def fetch_all(self, db: Session, filter: FilterSqueeze = None): + """Fetch all squeeze pages""" + squeezes = [] + if filter: + squeezes = db.query(Squeeze).filter(Squeeze.status == filter.status).all() + else: + squeezes = db.query(Squeeze).all() + return squeezes + + def fetch(self, db: Session, id: str, filter: FilterSqueeze = None): + """Fetch a specific squeeze page""" + squeeze = None + if filter: + squeeze = ( + db.query(Squeeze) + .filter(Squeeze.id == id, Squeeze.status == filter.status) + .first() + ) + else: + squeeze = db.query(Squeeze).filter(Squeeze.id == id).first() + return squeeze + + def update(self, db: Session, id: str, schema): + """Update a specific squeeze page""" + pass + + def delete(self, db: Session, id: str): + """Delete a specific squeeze page""" + squeeze = db.query(Squeeze).filter(Squeeze.id == id).first() + + if not squeeze: + raise HTTPException(status_code=404, detail="Squeeze page not found") + + db.delete(squeeze) + db.commit() + db.refresh() + + def delete_all(self, db: Session): + """Delete all squeeze pages""" + pass + + +squeeze_service = SqueezeService() diff --git a/api/v1/services/team.py b/api/v1/services/team.py new file mode 100755 index 000000000..810bb3011 --- /dev/null +++ b/api/v1/services/team.py @@ -0,0 +1,56 @@ +#!/usr/bin/env python3 + +"""Teams services""" + +from sqlalchemy.orm import Session + +from api.core.base.services import Service +from api.v1.models.team import TeamMember + +from api.utils.db_validators import check_model_existence + + +class TeamServices(Service): + """Team services functionality""" + + @staticmethod + def create(db: Session, schema) -> TeamMember: + """Create a new job""" + + new_member = TeamMember(**schema.model_dump()) + db.add(new_member) + db.commit() + db.refresh(new_member) + + return new_member + + def fetch_all(self, db: Session): + """Fetch all team members""" + team_members = db.query(TeamMember).all() + return team_members + + def fetch(self, db, id): + """Fetch a single team""" + team = check_model_existence(db, TeamMember, id) + + return team + + def update(self, db, id, data): + """Update a team""" + team = check_model_existence(db, TeamMember, id) + + db.query(TeamMember).filter(TeamMember.id == id).update(data) + db.commit() + db.refresh(team) + return team + + def delete(self, db, id): + """Delete a team""" + pass + + def delete_all(self, db): + """Delete all teams""" + pass + + +team_service = TeamServices() diff --git a/api/v1/services/terms_and_conditions.py b/api/v1/services/terms_and_conditions.py new file mode 100644 index 000000000..0d9c3b0ce --- /dev/null +++ b/api/v1/services/terms_and_conditions.py @@ -0,0 +1,47 @@ +from sqlalchemy.orm import Session +from api.core.base.services import Service +from api.v1.models.terms import TermsAndConditions +from api.v1.schemas.terms_and_conditions import UpdateTermsAndConditions +from fastapi import HTTPException +from api.v1.models.user import User + +class TermsAndConditionsService(Service): + """Terms And conditions service.""" + + def create(self): + return super().create() + + def fetch(self, db: Session, id: str): + tc = db.query(TermsAndConditions).filter(TermsAndConditions.id == id).first() + if not tc: + return None + return tc + + def fetch_all(self): + return super().fetch_all() + + def update(self, db: Session, id: str, data: UpdateTermsAndConditions): + tc = db.query(TermsAndConditions).filter(TermsAndConditions.id == id).first() + if not tc: + return None + if data.title: + tc.title = data.title + if data.content: + tc.content = data.content + db.commit() + db.refresh(tc) + return tc + + def delete(self, terms_id: str, db: Session, current_user: User): + # Check if the terms and conditions exist + tc = db.query(TermsAndConditions).filter(TermsAndConditions.id == terms_id).first() + if not tc: + raise HTTPException(status_code=404, detail="Terms and Conditions not found") + + # Delete the terms and conditions + db.delete(tc) + db.commit() + return {"message": "Terms and Conditions deleted successfully", "status_code": 200, "success": True, "data": {"terms_id": terms_id}} + + +terms_and_conditions_service = TermsAndConditionsService() diff --git a/api/v1/services/testimonial.py b/api/v1/services/testimonial.py index e73250cf8..f3d20352a 100644 --- a/api/v1/services/testimonial.py +++ b/api/v1/services/testimonial.py @@ -1,49 +1,59 @@ -from typing import Any, Optional from sqlalchemy.orm import Session - from api.core.base.services import Service from api.utils.db_validators import check_model_existence from api.v1.models.testimonial import Testimonial +from api.v1.models.user import User +from api.v1.schemas.testimonial import CreateTestimonial class TestimonialService(Service): - '''Product service functionality''' + """Product service functionality""" - def create(self, db: Session, schema): + def create(self, db: Session, user: User, data: CreateTestimonial): '''Create testimonial''' - pass + new_testimonial = Testimonial( + content=data.content, + ratings=data.ratings, + author_id=user.id + ) + db.add(new_testimonial) + db.commit() + db.refresh(new_testimonial) + return new_testimonial - def fetch_all(self, db: Session): - '''Fetch all testimonial''' - pass + def fetch_all(self, page :int , page_size : int, db: Session): + '''Fetch all testimonial with pagination''' + offset = (page - 1) * page_size + testimonials = db.query(Testimonial).offset(offset).limit(page_size).all() + return testimonials def fetch(self, db: Session, id: str): - '''Fetches a single testimonial id''' + """Fetches a single testimonial id""" return check_model_existence(db, Testimonial, id) def update(self, db: Session, id: str, schema): - '''Updates a testimonial''' + """Updates a testimonial""" pass def delete(self, db: Session, id: str): - '''Deletes a specific testimonial''' - testimonial = db.query(Testimonial).filter(Testimonial.id == id).first() - if not testimonial: - return False + """Deletes a specific testimonial""" + + testimonial = check_model_existence(db, Testimonial, id) + db.delete(testimonial) db.commit() - return True def delete_all(self, db: Session): - '''Delete all testimonials''' + """Delete all testimonials""" try: db.query(Testimonial).delete() db.commit() except Exception as e: db.rollback() raise e - -testimonial_service = TestimonialService() \ No newline at end of file + + +testimonial_service = TestimonialService() diff --git a/api/v1/services/topic.py b/api/v1/services/topic.py new file mode 100644 index 000000000..dce1c19e6 --- /dev/null +++ b/api/v1/services/topic.py @@ -0,0 +1,78 @@ +from typing import Any, Optional, List +from sqlalchemy.orm import Session +from fastapi import HTTPException, status +from api.core.base.services import Service +from api.utils.db_validators import check_model_existence +from api.v1.models.topic import Topic +from api.v1.schemas.topic import TopicUpdateSchema + + + +class TopicService(Service): + '''Topic service functionality''' + + def create(self, db: Session, title: str, content: str, tags: Optional[list] = None): + '''Function to like a topic''' + + topic_data = db.query(Topic).filter_by(title=title).first() + if topic_data: + raise HTTPException(status_code=status.HTTP_200_OK, detail="You've already created this topic") + new_topic = Topic(title=title, content=content, tags=tags) + db.add(new_topic) + db.commit() + db.refresh(new_topic) + return new_topic + + def fetch_all(self, db: Session, **query_params: Optional[Any]): + '''Fetch all topics with optional search using query parameters''' + + query = db.query(Topic) + + if query_params: + for column, value in query_params.items(): + if hasattr(Topic, column) and value: + query = query.filter(getattr(Topic, column).ilike(f'%{value}%')) + + return query.all() + + def fetch(self, db: Session, id: str): + '''Fetch a topic by id''' + + topic = check_model_existence(db, Topic, id) + return topic + + def update(self, db: Session, schema: TopicUpdateSchema): + '''Updates a topic''' + + topic = self.fetch(db=db, id=schema.id) + + update_data = schema.dict(exclude_unset=True, exclude={"id"}) + for key, value in update_data.items(): + setattr(topic, key, value) + + db.commit() + db.refresh(topic) + return topic + + def delete(self, db: Session, id: str): + """Deletes a topic""" + + topic = self.fetch(db=db, id=id) + db.delete(topic) + db.commit() + return True + + def search(self, db: Session, search_query: str): + """ + Search for topics based on title, content, tags, or topic IDs. + """ + query = db.query(Topic).filter( + (Topic.title.ilike(f'%{search_query}%')) | + (Topic.content.ilike(f'%{search_query}%')) | + (Topic.tags.any(search_query)) | + (Topic.id == search_query) # Include searching by topic ID + ) + return query.all() + + +topic_service = TopicService() \ No newline at end of file diff --git a/api/v1/services/user.py b/api/v1/services/user.py index 684543ba8..012a7c159 100644 --- a/api/v1/services/user.py +++ b/api/v1/services/user.py @@ -1,54 +1,119 @@ import random import string -from typing import Any, Optional -import bcrypt, datetime as dt +from typing import Any, Optional, Annotated +import datetime as dt +from fastapi import status from fastapi.security import OAuth2PasswordBearer from jose import JWTError, jwt from fastapi import Depends, HTTPException, Request from sqlalchemy.orm import Session +from sqlalchemy import desc from passlib.context import CryptContext from datetime import datetime, timedelta from api.core.base.services import Service +from api.core.dependencies.email_sender import send_email from api.db.database import get_db from api.utils.settings import settings from api.utils.db_validators import check_model_existence +from api.v1.models.associations import user_organization_association from api.v1.models.user import User +from api.v1.models.data_privacy import DataPrivacySetting from api.v1.models.token_login import TokenLogin from api.v1.schemas import user from api.v1.schemas import token +from api.v1.services.notification_settings import notification_setting_service -oauth2_scheme = OAuth2PasswordBearer("/api/v1/auth/login") +oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/api/v1/auth/login") pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto") class UserService(Service): """User service""" - def fetch_all(self, db: Session, **query_params: Optional[Any]): - """Fetch all users""" + def fetch_all( + self, db: Session, page: int, per_page: int, **query_params: Optional[Any] + ): + """ + Fetch all users + Args: + db: database Session object + page: page number + per_page: max number of users in a page + query_params: params to filter by + """ + per_page = min(per_page, 10) + # Enable filter by query parameter + filters = [] + if all(query_params): + # Validate boolean query parameters + for param, value in query_params.items(): + if value is not None and not isinstance(value, bool): + raise HTTPException( + status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, + detail=f"Invalid value for '{param}'. Must be a boolean.", + ) + if value == None: + continue + if hasattr(User, param): + filters.append(getattr(User, param) == value) query = db.query(User) + total_users = query.count() + if filters: + query = query.filter(*filters) + total_users = query.count() + + all_users: list = ( + query.order_by(desc(User.created_at)) + .limit(per_page) + .offset((page - 1) * per_page) + .all() + ) - # Enable filter by query parameter - if query_params: - for column, value in query_params.items(): - if hasattr(User, column) and value: - query = query.filter(getattr(User, column).ilike(f"%{value}%")) + return self.all_users_response(all_users, total_users, page, per_page) - return query.all() + def all_users_response( + self, users: list, total_users: int, page: int, per_page: int + ): + """ + Generates a response for all users + Args: + users: a list containing user objects + total_users: total number of users + """ + if not users or len(users) == 0: + return user.AllUsersResponse( + message="No User(s) for this query", + status="success", + status_code=200, + page=page, + per_page=per_page, + total=0, + data=[], + ) + all_users = [ + user.UserData.model_validate(usr, from_attributes=True) for usr in users + ] + return user.AllUsersResponse( + message="Users successfully retrieved", + status="success", + status_code=200, + page=page, + per_page=per_page, + total=total_users, + data=all_users, + ) def fetch(self, db: Session, id): """Fetches a user by their id""" - user = check_model_existence(db, User, id) # return user if user is not deleted if not user.is_deleted: return user - def fetch_by_email(self, db: Session, email): """Fetches a user by their email""" @@ -59,23 +124,12 @@ def fetch_by_email(self, db: Session, email): return user - def fetch_by_username(self, db: Session, username): - """Fetches a user by their username""" - - user = db.query(User).filter(User.username == username).first() - - if not user: - raise HTTPException(status_code=404, detail="User not found") - - return user - def create(self, db: Session, schema: user.UserCreate): """Creates a new user""" - if ( - db.query(User).filter(User.email == schema.email).first() - or db.query(User).filter(User.username == schema.username).first() - ): + del schema.admin_secret + + if db.query(User).filter(User.email == schema.email).first(): raise HTTPException( status_code=400, detail="User with this email or username already exists", @@ -90,61 +144,122 @@ def create(self, db: Session, schema: user.UserCreate): db.commit() db.refresh(user) + # # Create notification settings directly for the user + notification_setting_service.create(db=db, user=user) + + # create data privacy setting + + data_privacy = DataPrivacySetting(user_id=user.id) + + db.add(data_privacy) + db.commit() + db.refresh(data_privacy) + return user - def create_admin(self, db: Session, schema: user.UserCreate): - if ( - db.query(User).filter(User.email == schema.email).first() - or db.query(User).filter(User.username == schema.username).first() - ): - user = ( - db.query(User) - .filter(User.email == schema.email or User.username == schema.username) - .first() + def super_admin_create_user( + self, + db: Annotated[Session, Depends(get_db)], + user_request: user.AdminCreateUser, + ): + """ + Creates a user for super admin + Args: + db: database Session object + user_request: The user details to use for creation + Returns: + object: the complete details of the newly created user + """ + try: + user_exists = ( + db.query(User).filter_by(email=user_request.email).one_or_none() ) - if not user.is_super_admin: - user.is_super_admin = True - db.commit() - db.refresh(user) - return user - else: + if user_exists: raise HTTPException( - status_code=400, - detail="User is already registered and is a superuser", + status_code=status.HTTP_400_BAD_REQUEST, + detail=f"User with {user_request.email} already exists", ) + if user_request.password: + user_request.password = self.hash_password(user_request.password) + new_user = User(**user_request.model_dump()) + db.add(new_user) + db.commit() + db.refresh(new_user) + user_schema = user.UserData.model_validate(new_user, from_attributes=True) + return user.AdminCreateUserResponse( + message="User created successfully", + status_code=201, + status="success", + data=user_schema, + ) + except Exception as exc: + db.rollback() + raise Exception(exc) from exc + + def create_admin(self, db: Session, schema: user.UserCreate): + """Creates a new admin""" + + del schema.admin_secret + + if db.query(User).filter(User.email == schema.email).first(): + raise HTTPException( + status_code=400, + detail="User with this email already exists", + ) + # Hash password - # Create new admin - user = self.create(db=db, schema=schema) - user.is_super_admin = True + schema.password = self.hash_password(password=schema.password) + + # Create user object with hashed password and other attributes from schema + user = User(**schema.model_dump()) + db.add(user) db.commit() db.refresh(user) + # Set user to super admin + user.is_super_admin = True + db.commit() + return user - def update(self, db: Session): - return super().update() + def update(self, db: Session, current_user: User, schema: user.UserUpdate, id=None): + """Function to update a User""" + # Get user from access token if provided, otherwise fetch user by id + if db.query(User).filter(User.email == schema.email).first(): + raise HTTPException( + status_code=400, + detail="User with this email or username already exists", + ) + if current_user.is_super_admin and id is not None: + user = self.fetch(db=db, id=id) + else: + user = self.fetch(db=db, id=current_user.id) + update_data = schema.dict(exclude_unset=True) + for key, value in update_data.items(): + setattr(user, key, value) + db.commit() + db.refresh(user) + return user def delete(self, db: Session, id=None, access_token: str = Depends(oauth2_scheme)): """Function to soft delete a user""" # Get user from access token if provided, otherwise fetch user by id - - # user = self.get_current_user(access_token, db) if id is not None else check_model_existence(db, User, id) - - if id is not None: - user = check_model_existence(db, User, id) - else: - user = self.get_current_user(access_token, db) + user = ( + self.get_current_user(access_token, db) + if id is None + else check_model_existence(db, User, id) + ) user.is_deleted = True db.commit() return super().delete() - def authenticate_user(self, db: Session, username: str, password: str): + def authenticate_user(self, db: Session, email: str, password: str): """Function to authenticate a user""" - user = db.query(User).filter(User.username == username).first() + user = db.query(User).filter(User.email == email).first() if not user: raise HTTPException(status_code=400, detail="Invalid user credentials") @@ -178,8 +293,8 @@ def create_access_token(self, user_id: str) -> str: minutes=settings.ACCESS_TOKEN_EXPIRE_MINUTES ) data = {"user_id": user_id, "exp": expires, "type": "access"} - return jwt.encode(data, settings.SECRET_KEY, settings.ALGORITHM) - + encoded_jwt = jwt.encode(data, settings.SECRET_KEY, settings.ALGORITHM) + return encoded_jwt def create_refresh_token(self, user_id: str) -> str: """Function to create access token""" @@ -187,11 +302,9 @@ def create_refresh_token(self, user_id: str) -> str: expires = dt.datetime.now(dt.timezone.utc) + dt.timedelta( days=settings.JWT_REFRESH_EXPIRY ) - data = {"user_id": user_id, "exp": expires, "type": "refresh"} - - return jwt.encode(data, settings.SECRET_KEY, settings.ALGORITHM) - + encoded_jwt = jwt.encode(data, settings.SECRET_KEY, settings.ALGORITHM) + return encoded_jwt def verify_access_token(self, access_token: str, credentials_exception): """Funtcion to decode and verify access token""" @@ -211,7 +324,8 @@ def verify_access_token(self, access_token: str, credentials_exception): token_data = user.TokenData(id=user_id) - except JWTError: + except JWTError as err: + print(err) raise credentials_exception return token_data @@ -254,7 +368,6 @@ def refresh_access_token(self, current_refresh_token: str): return access, refresh - def get_current_user( self, access_token: str = Depends(oauth2_scheme), db: Session = Depends(get_db) ) -> User: @@ -262,13 +375,14 @@ def get_current_user( credentials_exception = HTTPException( status_code=401, - detail="Could not validate crenentials", + detail="Could not validate credentials", headers={"WWW-Authenticate": "Bearer"}, ) token = self.verify_access_token(access_token, credentials_exception) + user = db.query(User).filter(User.id == token.id).first() - return db.query(User).filter(User.id == token.id).first() + return user def deactivate_user( self, @@ -336,7 +450,6 @@ def change_password( ): """Endpoint to change the user's password""" - if not self.verify_password(old_password, user.password): raise HTTPException(status_code=400, detail="Incorrect old password") @@ -359,6 +472,7 @@ def save_login_token( self, db: Session, user: User, token: str, expiration: datetime ): """Save the token and expiration in the user's record""" + db.query(TokenLogin).filter(TokenLogin.user_id == user.id).delete() token = TokenLogin(user_id=user.id, token=token, expiry_time=expiration) @@ -368,6 +482,7 @@ def save_login_token( def verify_login_token(self, db: Session, schema: token.TokenRequest): """Verify the token and email combination""" + user = db.query(User).filter(User.email == schema.email).first() if not user: @@ -387,4 +502,30 @@ def generate_token(self): ), datetime.utcnow() + timedelta(minutes=10) + def get_users_by_role(self, db: Session, role_id: str, current_user: User): + """Function to get all users by role""" + if role_id == "" or role_id is None: + raise HTTPException( + status_code=400, + detail="Role ID is required" + ) + + user_roles = db.query(user_organization_association).filter(user_organization_association.c.user_id == current_user.id, user_organization_association.c.role.in_(['admin', 'owner'])).all() + + if len(user_roles) == 0: + raise HTTPException( + status_code=403, + detail="Permission denied. Admin access required." + ) + + users = db.query(User).join(user_organization_association).filter(user_organization_association.c.role == role_id).all() + + if len(users) == 0: + raise HTTPException( + status_code=404, + detail="No users found for this role" + ) + + return users + user_service = UserService() diff --git a/api/v1/services/waitlist.py b/api/v1/services/waitlist.py index ae819b239..cef5c2255 100644 --- a/api/v1/services/waitlist.py +++ b/api/v1/services/waitlist.py @@ -2,16 +2,15 @@ from sqlalchemy.orm import Session from api.core.base.services import Service -from api.utils.db_validators import check_model_existence from api.v1.models.waitlist import Waitlist -from pydantic import EmailStr, BaseModel +from pydantic import BaseModel class WaitListService(Service): - '''waitlist user service functionality''' + """waitlist user service functionality""" - def create(self, db: Session, schema: BaseModel): - '''Create a new waitlist user''' + def create(self, db: Session, schema: BaseModel): + """Create a new waitlist user""" new_waitlist_user = Waitlist(**schema.model_dump()) db.add(new_waitlist_user) @@ -19,10 +18,9 @@ def create(self, db: Session, schema: BaseModel): db.refresh(new_waitlist_user) return new_waitlist_user - def fetch_all(self, db: Session, **query_params: Optional[Any]): - '''Fetch all waitlist users with option to search using query parameters''' + """Fetch all waitlist users with option to search using query parameters""" query = db.query(Waitlist) @@ -30,35 +28,33 @@ def fetch_all(self, db: Session, **query_params: Optional[Any]): if query_params: for column, value in query_params.items(): if hasattr(Waitlist, column) and value: - query = query.filter(getattr(Waitlist, column).ilike(f'%{value}%')) + query = query.filter(getattr(Waitlist, column).ilike(f"%{value}%")) return query.all() - def fetch(self, db: Session, id: str): - '''Fetches a waitlist user by their id''' + """Fetches a waitlist user by their id""" waitlist_user = db.query(Waitlist).filter(Waitlist.id == id).first() return waitlist_user - + def fetch_by_email(self, db: Session, email: str): - '''Fetches a waitlist user by their email''' + """Fetches a waitlist user by their email""" waitlist_user = db.query(Waitlist).filter(Waitlist.email == email).first() return waitlist_user - def update(self, db: Session, id: str, schema): - '''Updates a waitlist user''' + """Updates a waitlist user""" pass - def delete(self, db: Session, id: str): - '''Deletes a waitlist user''' - + """Deletes a waitlist user""" + waitlist_user = self.fetch(db=db, id=id) db.delete(waitlist_user) db.commit() -waitlist_service = WaitListService() \ No newline at end of file + +waitlist_service = WaitListService() diff --git a/api/v1/services/waitlist_email.py b/api/v1/services/waitlist_email.py index 3b6d9ad35..b130ab6c2 100644 --- a/api/v1/services/waitlist_email.py +++ b/api/v1/services/waitlist_email.py @@ -1,5 +1,6 @@ from pydantic import EmailStr -from api.core.dependencies.email import mail_service +from api.core.dependencies.email_sender import send_email +from api.core.dependencies.google_email import mail_service from fastapi import HTTPException from api.utils.logger import logger from sqlalchemy.orm import Session @@ -8,18 +9,24 @@ async def send_confirmation_email(email: EmailStr, full_name: str): plain_text_body = "Welcome, {}. Thank you for joining our waitlist. We'll keep you updated \ - on our progress! Best regards, HNG BoilerPlate Team".format(full_name) + on our progress! Best regards, HNG BoilerPlate Team".format( + full_name + ) try: - logger.info(f"Attempting to send confirmation email to {email}") - mail_service.send_mail(to=email, subject="Welcome to our Waitlist!", body=plain_text_body) - logger.info(f"Confirmation email sent successfully to {email}") + logger.info(f"Attempting to send confirmation email to {email}") + mail_service.send_mail( + to=email, subject="Welcome to our Waitlist!", body=plain_text_body + ) + logger.info(f"Confirmation email sent successfully to {email}") except HTTPException as e: - logger.warning(f"Failed to send email: {e.detail}") + logger.warning(f"Failed to send email: {e.detail}") raise e except Exception as e: - logger.error(f"Unexpected error while sending email: {str(e)}") - raise HTTPException(status_code=500, detail=f"Failed to send confirmation email: {str(e)}") + logger.error(f"Unexpected error while sending email: {str(e)}") + raise HTTPException( + status_code=500, detail=f"Failed to send confirmation email: {str(e)}" + ) def add_user_to_waitlist(db: Session, email: str, full_name: str): @@ -30,6 +37,7 @@ def add_user_to_waitlist(db: Session, email: str, full_name: str): db.refresh(db_user) return db_user + def find_existing_user(db: Session, email: str): """Finds an existing user by email.""" - return db.query(Waitlist).filter(Waitlist.email == email).first() \ No newline at end of file + return db.query(Waitlist).filter(Waitlist.email == email).first() diff --git a/main.py b/main.py index a45c7550e..a2d0ab53e 100644 --- a/main.py +++ b/main.py @@ -1,17 +1,21 @@ -from fastapi.responses import JSONResponse + import uvicorn +from fastapi.staticfiles import StaticFiles +import uvicorn, os +from sqlalchemy.exc import IntegrityError from fastapi import HTTPException, Request +from fastapi.templating import Jinja2Templates from fastapi.exceptions import RequestValidationError from fastapi.responses import JSONResponse from contextlib import asynccontextmanager from fastapi import FastAPI, status +from fastapi.staticfiles import StaticFiles from fastapi.middleware.cors import CORSMiddleware from starlette.requests import Request -from api.utils.json_response import JsonResponseDict -from starlette.middleware.sessions import SessionMiddleware # required by google oauth +from starlette.middleware.sessions import SessionMiddleware # required by google oauth +from api.utils.json_response import JsonResponseDict from api.utils.logger import logger -from api.v1.routes.newsletter import CustomException, custom_exception_handler from api.v1.routes import api_version_one from api.utils.settings import settings @@ -23,13 +27,24 @@ async def lifespan(app: FastAPI): app = FastAPI(lifespan=lifespan) +# Set up email templates and css static files +email_templates = Jinja2Templates(directory='api/core/dependencies/email/templates') + +# MEDIA_DIR = os.path.expanduser('~/.media') +MEDIA_DIR = './media' +if not os.path.exists(MEDIA_DIR): + os.makedirs(MEDIA_DIR) + +# Load up media static files +app.mount('/media', StaticFiles(directory=MEDIA_DIR), name='media') + origins = [ "http://localhost:3000", "http://localhost:3001", ] -app.add_middleware(SessionMiddleware, secret_key=settings.SECRET_KEY) +app.add_middleware(SessionMiddleware, secret_key=settings.SECRET_KEY) app.add_middleware( CORSMiddleware, allow_origins=origins, @@ -38,12 +53,8 @@ async def lifespan(app: FastAPI): allow_headers=["*"], ) -app.add_exception_handler( - CustomException, custom_exception_handler -) # Newsletter custom exception registration app.include_router(api_version_one) - @app.get("/", tags=["Home"]) async def get_root(request: Request) -> dict: return JsonResponseDict( @@ -51,9 +62,12 @@ async def get_root(request: Request) -> dict: ) -# REGISTER EXCEPTION HANDLERS +@app.get("/probe", tags=["Home"]) +async def probe(): + return {"message": "I am the Python FastAPI API responding"} +# REGISTER EXCEPTION HANDLERS @app.exception_handler(HTTPException) async def http_exception(request: Request, exc: HTTPException): """HTTP exception handler""" @@ -61,7 +75,7 @@ async def http_exception(request: Request, exc: HTTPException): return JSONResponse( status_code=exc.status_code, content={ - "success": False, + "status": False, "status_code": exc.status_code, "message": exc.detail, }, @@ -80,7 +94,7 @@ async def validation_exception(request: Request, exc: RequestValidationError): return JSONResponse( status_code=422, content={ - "success": False, + "status": False, "status_code": 422, "message": "Invalid input", "errors": errors, @@ -88,6 +102,22 @@ async def validation_exception(request: Request, exc: RequestValidationError): ) +@app.exception_handler(IntegrityError) +async def exception(request: Request, exc: IntegrityError): + """Integrity error exception handlers""" + + logger.exception(f"Exception occured; {exc}") + + return JSONResponse( + status_code=400, + content={ + "status": False, + "status_code": 400, + "message": f"An unexpected error occurred: {exc}", + }, + ) + + @app.exception_handler(Exception) async def exception(request: Request, exc: Exception): """Other exception handlers""" @@ -97,12 +127,16 @@ async def exception(request: Request, exc: Exception): return JSONResponse( status_code=500, content={ - "success": False, + "status": False, "status_code": 500, "message": f"An unexpected error occurred: {exc}", }, ) +STATIC_DIR = "static/profile_images" +os.makedirs(STATIC_DIR, exist_ok=True) +app.mount("/static", StaticFiles(directory="static"), name="static") + if __name__ == "__main__": - uvicorn.run("main:app", port=7001, reload=True) \ No newline at end of file + uvicorn.run("main:app", port=7001, reload=True) diff --git a/requirements.txt b/requirements.txt index 4fdb6dc4b..8014c7186 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,51 +1,92 @@ +aiohttp==3.9.5 +aiohttp-retry==2.8.3 +aiosignal==1.3.1 +aiosmtplib==2.0.2 alembic==1.13.2 annotated-types==0.7.0 anyio==4.4.0 +astroid==3.2.4 +attrs==23.2.0 Authlib==1.3.1 +autopep8==2.3.1 bcrypt==4.1.3 +black==24.4.2 +bleach==6.1.0 +blinker==1.8.2 +cachetools==5.4.0 certifi==2024.7.4 cffi==1.16.0 +cfgv==3.4.0 charset-normalizer==3.3.2 click==8.1.7 +colorama==0.4.6 cryptography==43.0.0 +cssselect==1.2.0 +cssutils==2.11.1 +dill==0.3.8 +distlib==0.3.8 dnspython==2.6.1 ecdsa==0.19.0 email_validator==2.2.0 exceptiongroup==1.2.2 +Faker==26.0.0 fastapi==0.111.1 fastapi-cli==0.0.4 +fastapi-mail==1.4.1 +filelock==3.15.4 +flake8==7.1.0 +frozenlist==1.4.1 greenlet==3.0.3 h11==0.14.0 httpcore==1.0.5 httptools==0.6.1 httpx==0.27.0 +identify==2.6.0 idna==3.7 iniconfig==2.0.0 +isort==5.13.2 itsdangerous==2.2.0 Jinja2==3.1.4 +lxml==5.2.2 Mako==1.3.5 markdown-it-py==3.0.0 MarkupSafe==2.1.5 +mccabe==0.7.0 mdurl==0.1.2 +more-itertools==10.3.0 +multidict==6.0.5 +mypy-extensions==1.0.0 +nodeenv==1.9.1 packaging==24.1 passlib==1.7.4 +pathspec==0.12.1 +pipdeptree==2.23.1 +Pillow==10.4.0 +platformdirs==4.2.2 pluggy==1.5.0 +pre-commit==3.7.1 +premailer==3.10.0 psycopg2-binary==2.9.9 pyasn1==0.6.0 +pycodestyle==2.12.0 pycparser==2.22 pydantic==2.8.2 pydantic-settings==2.3.4 pydantic_core==2.20.1 +pyflakes==3.2.0 Pygments==2.18.0 PyJWT==2.8.0 +pylint==3.2.6 PyMySQL==1.1.1 pytest==8.2.2 pytest-asyncio==0.23.8 pytest-mock==3.14.0 +python-dateutil==2.9.0.post0 python-decouple==3.8 python-dotenv==1.0.1 python-jose==3.3.0 python-multipart==0.0.9 +pytz==2024.1 PyYAML==6.0.1 requests==2.32.3 rich==13.7.1 @@ -56,12 +97,16 @@ sniffio==1.3.1 SQLAlchemy==2.0.31 starlette==0.37.2 tomli==2.0.1 +tomlkit==0.13.0 +twilio==9.2.3 typer==0.12.3 typing_extensions==4.12.2 urllib3==2.2.2 uuid7==0.1.0 uvicorn==0.30.3 uvloop==0.19.0 +virtualenv==20.26.3 watchfiles==0.22.0 +webencodings==0.5.1 websockets==12.0 -pytz==2024.1 \ No newline at end of file +yarl==1.9.4 \ No newline at end of file diff --git a/get-pip.py b/scripts/get-pip.py similarity index 99% rename from get-pip.py rename to scripts/get-pip.py index 07df24d0a..44cd5ec0d 100644 --- a/get-pip.py +++ b/scripts/get-pip.py @@ -1065,7 +1065,7 @@ def main(): N06_Ayh9q>?&TMv{oE4YD$ZFnw9kz=uRaH