Merge pull request #20 from piyush-jaiswal/feature/flask-smorest-subcategory

Feature/flask smorest subcategory

Author: piyush-jaiswal

README.md

@@ -64,7 +64,7 @@ Test the API using Swagger UI (`/` route), Postman, cURL or your preferred HTTP
 
 #### Fetch products using name, category, subcategory
 - [GET] `/product/<name: string>` - Get product with name: `name` <br/><br/>
-- [GET] `/subcategory/<subcategory_id: int>/products?page=<page_no>` - Get product with within subcategory `subcategory`. Returns `page_no` of the paginated results. <br/><br/>
+- [GET] `/subcategories/<subcategory_id: int>/products?page=<page_no>` - Get product with within subcategory `subcategory`. Returns `page_no` of the paginated results. <br/><br/>
 - [GET] `/categories/<category_id: int>/products` - Get product with within category `category`. Returns first page of the paginated results. <br/><br/>
 - [GET] `/categories/<category_id: int>/products?page=<page_no>` - Get product with within category `category`. Returns `page_no` of the paginated results. <br/><br/>
 
@@ -124,11 +124,11 @@ Test the API using Swagger UI (`/` route), Postman, cURL or your preferred HTTP
 
 #### Subcategory
 - [GET] `/subcategories` - Get all subcategories
-- [GET] `/subcategory/(int: subcategory_id)` - Get subcategory with subcategory_id
-- [GET] `/subcategory/(int: subcategory_id)/categories` - Get categories related to subcategory_id
-- [DELETE] `/subcategory/(int: subcategory_id)` (Protected) - Delete subcategory with subcategory_id
+- [GET] `/subcategories/(int: subcategory_id)` - Get subcategory with subcategory_id
+- [GET] `/subcategories/(int: subcategory_id)/categories` - Get categories related to subcategory_id
+- [DELETE] `/subcategories/(int: subcategory_id)` (Protected) - Delete subcategory with subcategory_id
 
-- [POST] `/subcategory/create` (Protected) - Create a new subcategory
+- [POST] `/subcategories` (Protected) - Create a new subcategory
   ```
   {
     "name": "name",
@@ -137,7 +137,7 @@ Test the API using Swagger UI (`/` route), Postman, cURL or your preferred HTTP
   }
   ```
 
-- [PUT] `/subcategory/(int: subcategory_id)/update` (Protected) - Update subcategory with subcategory_id
+- [PUT] `/subcategories/(int: subcategory_id)` (Protected) - Update subcategory with subcategory_id
   ```
   {
     "name": "name",

app/__init__.py

@@ -13,7 +13,10 @@
 
 def register_blueprints():
     from app.migrated_routes.category import bp as category_bp
+    from app.migrated_routes.subcategory import bp as subcategory_bp
+
     api.register_blueprint(category_bp, url_prefix="/categories")
+    api.register_blueprint(subcategory_bp, url_prefix="/subcategories")
 
 
 app = Flask(__name__)

app/migrated_routes/subcategory.py

@@ -0,0 +1,339 @@
+from flask.views import MethodView
+from flask_jwt_extended import jwt_required
+from flask_smorest import Blueprint, abort
+from psycopg2.errors import UniqueViolation
+from sqlalchemy import UniqueConstraint
+from sqlalchemy.exc import IntegrityError
+
+from app import db
+from app.models import (
+    Category,
+    Product,
+    Subcategory,
+    category_subcategory,
+    subcategory_product,
+)
+from app.schemas import (
+    CategoriesOut,
+    PaginationArgs,
+    ProductsOut,
+    SubcategoriesOut,
+    SubcategoryIn,
+    SubcategoryOut,
+)
+
+bp = Blueprint("subcategory", __name__)
+
+
+@bp.route("")
+class SubcategoryCollection(MethodView):
+    init_every_request = False
+
+    @staticmethod
+    def _get_name_unique_constraint():
+        name_col = Subcategory.__table__.c.name
+        return next(
+            con
+            for con in Subcategory.__table__.constraints
+            if isinstance(con, UniqueConstraint)
+            and len(con.columns) == 1
+            and con.columns.contains_column(name_col)
+        )
+
+    _NAME_UNIQUE_CONSTRAINT = _get_name_unique_constraint()
+
+    @bp.response(200, SubcategoriesOut)
+    def get(self):
+        """
+        Get All Subcategories
+        ---
+        tags:
+            - Subcategory
+        description: Get all subcategories.
+        responses:
+            200:
+                description: A list of subcategories.
+        """
+        return {"subcategories": Subcategory.query.all()}
+
+    @jwt_required()
+    @bp.arguments(SubcategoryIn)
+    @bp.response(201, SubcategoryOut)
+    def post(self, data):
+        """
+        Create Subcategory
+        ---
+        tags:
+            - Subcategory
+        description: Create a new subcategory.
+        security:
+            - access_token: []
+        requestBody:
+            required: true
+            description: name - Name of the subcategory <br> categories - Array of category ids (optional) <br> products - Array of product ids (optional)
+            content:
+                application/json:
+                    schema:
+                        type: object
+                        required:
+                            - name
+                        properties:
+                            name:
+                                type: string
+                            categories:
+                                type: array
+                                items:
+                                    type: integer
+                            products:
+                                type: array
+                                items:
+                                    type: integer
+        responses:
+            201:
+                description: Subcategory created successfully.
+            400:
+                description: Invalid input.
+            500:
+                description: Error occurred.
+        """
+        subcategory = Subcategory(name=data["name"])
+
+        if c_ids := data.get("categories"):
+            categories = Category.query.filter(Category.id.in_(c_ids)).all()
+            if len(categories) != len(c_ids):
+                abort(422, message="One or more categories not present")
+            subcategory.categories = categories
+
+        if p_ids := data.get("products"):
+            products = Product.query.filter(Product.id.in_(p_ids)).all()
+            if len(products) != len(p_ids):
+                abort(422, message="One or more products not present")
+            subcategory.products = products
+
+        try:
+            db.session.add(subcategory)
+            db.session.commit()
+        except IntegrityError as ie:
+            db.session.rollback()
+            if (
+                isinstance(ie.orig, UniqueViolation)
+                and ie.orig.diag.constraint_name
+                == SubcategoryCollection._NAME_UNIQUE_CONSTRAINT.name
+            ):
+                abort(409, message="Subcategory with this name already exists")
+            raise
+
+        return subcategory
+
+
+@bp.route("/<int:id>")
+class SubcategoryById(MethodView):
+    init_every_request = False
+
+    def _get(self, id):
+        return Subcategory.query.get_or_404(id)
+
+    @bp.response(200, SubcategoryOut)
+    def get(self, id):
+        """
+        Get Subcategory
+        ---
+        tags:
+            - Subcategory
+        description: Get a subcategory by ID.
+        parameters:
+            - in: path
+              name: id
+              required: true
+              type: integer
+              description: Subcategory ID
+        responses:
+            200:
+                description: Subcategory retrieved successfully.
+            404:
+                description: Subcategory not found.
+        """
+        return self._get(id)
+
+    @jwt_required()
+    @bp.arguments(SubcategoryIn(partial=("name",)))
+    @bp.response(200, SubcategoryOut)
+    def put(self, data, id):
+        """
+        Update Subcategory
+        ---
+        tags:
+            - Subcategory
+        description: Update an existing subcategory.
+        security:
+            - access_token: []
+        parameters:
+            - in: path
+              name: id
+              required: true
+              type: integer
+              description: Subcategory ID
+        requestBody:
+            required: true
+            description: name - Name of the subcategory (optional) <br> categories - Array of category ids (optional) <br> products - Array of product ids (optional)
+            content:
+                application/json:
+                    schema:
+                        type: object
+                        properties:
+                            name:
+                                type: string
+                            categories:
+                                type: array
+                                items:
+                                    type: integer
+                            products:
+                                type: array
+                                items:
+                                    type: integer
+        responses:
+            200:
+                description: Subcategory updated successfully.
+            400:
+                description: Invalid input.
+            404:
+                description: Subcategory not found.
+            500:
+                description: Error occurred.
+        """
+        subcategory = self._get(id)
+        if name := data.get("name"):
+            subcategory.name = name
+
+        with db.session.no_autoflush:
+            if c_ids := data.get("categories"):
+                categories = Category.query.filter(Category.id.in_(c_ids)).all()
+                if len(categories) != len(c_ids):
+                    abort(422, message="One or more categories not present")
+                subcategory.categories.extend(categories)
+
+            if p_ids := data.get("products"):
+                products = Product.query.filter(Product.id.in_(p_ids)).all()
+                if len(products) != len(p_ids):
+                    abort(422, message="One or more products not present")
+                subcategory.products.extend(products)
+
+        try:
+            db.session.commit()
+        except IntegrityError as ie:
+            db.session.rollback()
+            if (
+                isinstance(ie.orig, UniqueViolation)
+                and ie.orig.diag.constraint_name
+                == category_subcategory.primary_key.name
+            ):
+                abort(409, message="Subcategory and category already linked")
+            if (
+                isinstance(ie.orig, UniqueViolation)
+                and ie.orig.diag.constraint_name == subcategory_product.primary_key.name
+            ):
+                abort(409, message="Subcategory and product already linked")
+            raise
+
+        return subcategory
+
+    @jwt_required()
+    @bp.response(204)
+    def delete(self, id):
+        """
+        Delete Subcategory
+        ---
+        tags:
+            - Subcategory
+        description: Delete a subcategory by ID.
+        security:
+            - access_token: []
+        parameters:
+            - in: path
+              name: id
+              required: true
+              type: integer
+              description: Subcategory ID
+        responses:
+            204:
+                description: Subcategory deleted successfully.
+            404:
+                description: Subcategory not found.
+            500:
+                description: Error occurred.
+        """
+        subcategory = self._get(id)
+        db.session.delete(subcategory)
+        db.session.commit()
+
+
+@bp.route("/<int:id>/categories")
+class SubcategoryCategories(MethodView):
+    init_every_request = False
+
+    @bp.response(200, CategoriesOut)
+    def get(self, id):
+        """
+        Get Categories related to a Subcategory.
+        ---
+        tags:
+            - Subcategory
+        description: Get Categories related to a Subcategory.
+        parameters:
+            - in: path
+              name: id
+              required: true
+              type: integer
+              description: Subcategory ID
+        responses:
+            200:
+                description: Categories retrieved successfully.
+            404:
+                description: Subcategory not found.
+            500:
+                description: Error occurred.
+        """
+        subcategory = Subcategory.query.get_or_404(id)
+        return {"categories": subcategory.categories}
+
+
+@bp.route("/<int:id>/products")
+class SubcategoryProducts(MethodView):
+    init_every_request = False
+    _PER_PAGE = 10
+
+    @bp.arguments(PaginationArgs, location="query", as_kwargs=True)
+    @bp.response(200, ProductsOut)
+    def get(self, id, page):
+        """
+        Get Products within a Subcategory.
+        ---
+        tags:
+            - Subcategory
+        description: Get products for a subcategory.
+        parameters:
+            - in: path
+              name: id
+              required: true
+              type: integer
+              description: Subcategory ID
+            - in: query
+              name: page
+              type: integer
+              default: 1
+              description: Page number
+        responses:
+            200:
+                description: Products retrieved successfully.
+            404:
+                description: Subcategory not found.
+            500:
+                description: Error occurred.
+        """
+        subcategory = Subcategory.query.get_or_404(id)
+
+        products = subcategory.products.order_by(Product.id.asc()).paginate(
+            page=page, per_page=SubcategoryProducts._PER_PAGE, error_out=False
+        )
+
+        return {"products": products}