Fixed health endpoint

Author: rofrano

service/config.py

@@ -2,7 +2,6 @@
 Global Configuration for Application
 """
 import os
-import json
 import logging
 
 # Get configuration from environment
@@ -11,11 +10,6 @@
     "postgresql+psycopg://postgres:postgres@localhost:5432/postgres"
 )
 
-# override if we are running in Cloud Foundry
-if 'VCAP_SERVICES' in os.environ:
-    vcap = json.loads(os.environ['VCAP_SERVICES'])
-    DATABASE_URI = vcap['user-provided'][0]['credentials']['url']
-
 # Configure SQLAlchemy
 SQLALCHEMY_DATABASE_URI = DATABASE_URI
 SQLALCHEMY_TRACK_MODIFICATIONS = False

service/routes.py

@@ -1,4 +1,4 @@
-# Copyright 2016, 2019 John J. Rofrano. All Rights Reserved.
+# Copyright 2016, 2024 John J. Rofrano. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,13 +15,8 @@
 """
 Pet Store Service
 
-Paths:
-------
-GET /pets - Returns a list all of the Pets
-GET /pets/{id} - Returns the Pet with a given id number
-POST /pets - creates a new Pet record in the database
-PUT /pets/{id} - updates a Pet record in the database
-DELETE /pets/{id} - deletes a Pet record in the database
+This service implements a REST API that allows you to Create, Read, Update
+and Delete Pets from the inventory of pets in the PetShop
 """
 
 from flask import jsonify, request, url_for, abort
@@ -33,8 +28,8 @@
 ######################################################################
 # GET HEALTH CHECK
 ######################################################################
-@app.route("/healthcheck")
-def healthcheck():
+@app.route("/health")
+def health_check():
     """Let them know our heart is still beating"""
     return jsonify(status=200, message="Healthy"), status.HTTP_200_OK
 
@@ -63,7 +58,10 @@ def index():
 def list_pets():
     """Returns all of the Pets"""
     app.logger.info("Request for pet list")
+
     pets = []
+
+    # See if any query filters were passed in
     category = request.args.get("category")
     name = request.args.get("name")
     if category:
@@ -79,7 +77,7 @@ def list_pets():
 
 
 ######################################################################
-# RETRIEVE A PET
+# READ A PET
 ######################################################################
 @app.route("/pets/<int:pet_id>", methods=["GET"])
 def get_pets(pet_id):
@@ -89,32 +87,35 @@ def get_pets(pet_id):
     This endpoint will return a Pet based on it's id
     """
     app.logger.info("Request for pet with id: %s", pet_id)
+
     pet = Pet.find(pet_id)
     if not pet:
-        abort(status.HTTP_404_NOT_FOUND, f"Pet with id '{pet_id}' was not found.")
+        error(status.HTTP_404_NOT_FOUND, f"Pet with id '{pet_id}' was not found.")
 
     app.logger.info("Returning pet: %s", pet.name)
     return jsonify(pet.serialize()), status.HTTP_200_OK
 
 
 ######################################################################
-# ADD A NEW PET
+# CREATE A NEW PET
 ######################################################################
 @app.route("/pets", methods=["POST"])
 def create_pets():
     """
     Creates a Pet
+
     This endpoint will create a Pet based the data in the body that is posted
     """
     app.logger.info("Request to create a pet")
     check_content_type("application/json")
+
     pet = Pet()
     pet.deserialize(request.get_json())
     pet.create()
     message = pet.serialize()
     location_url = url_for("get_pets", pet_id=pet.id, _external=True)
 
-    app.logger.info("Pet with ID [%s] created.", pet.id)
+    app.logger.info("Pet with ID: %d created.", pet.id)
     return jsonify(message), status.HTTP_201_CREATED, {"Location": location_url}
 
 
@@ -128,18 +129,18 @@ def update_pets(pet_id):
 
     This endpoint will update a Pet based the body that is posted
     """
-    app.logger.info("Request to update pet with id: %s", pet_id)
+    app.logger.info("Request to update pet with id: %d", pet_id)
     check_content_type("application/json")
 
     pet = Pet.find(pet_id)
     if not pet:
-        abort(status.HTTP_404_NOT_FOUND, f"Pet with id '{pet_id}' was not found.")
+        error(status.HTTP_404_NOT_FOUND, f"Pet with id: '{pet_id}' was not found.")
 
     pet.deserialize(request.get_json())
     pet.id = pet_id
     pet.update()
 
-    app.logger.info("Pet with ID [%s] updated.", pet.id)
+    app.logger.info("Pet with ID: %d updated.", pet.id)
     return jsonify(pet.serialize()), status.HTTP_200_OK
 
 
@@ -153,12 +154,13 @@ def delete_pets(pet_id):
 
     This endpoint will delete a Pet based the id specified in the path
     """
-    app.logger.info("Request to delete pet with id: %s", pet_id)
+    app.logger.info("Request to delete pet with id: %d", pet_id)
+
     pet = Pet.find(pet_id)
     if pet:
         pet.delete()
 
-    app.logger.info("Pet with ID [%s] delete complete.", pet_id)
+    app.logger.info("Pet with ID: %d delete complete.", pet_id)
     return "", status.HTTP_204_NO_CONTENT
 
 
@@ -167,14 +169,22 @@ def delete_pets(pet_id):
 ######################################################################
 @app.route("/pets/<int:pet_id>/purchase", methods=["PUT"])
 def purchase_pets(pet_id):
-    """Purchasing a Pet makes it unavailable"""
+    """
+    Purchasing a Pet
+
+    This endpoint will purchase a pet makes it unavailable
+    """
+    app.logger.info("Request to purchase pet with id: %d", pet_id)
+
     pet = Pet.find(pet_id)
     if not pet:
-        abort(status.HTTP_404_NOT_FOUND, f"Pet with id '{pet_id}' was not found.")
+        error(status.HTTP_404_NOT_FOUND, f"Pet with id '{pet_id}' was not found.")
+
+    # you can only purchase pets that are available
     if not pet.available:
-        abort(
+        error(
             status.HTTP_409_CONFLICT,
-            f"Pet with id '{pet_id}' is not available.",
+            f"Pet with ID: '{pet_id}' is not available.",
         )
 
     # At this point you would execute code to purchase the pet
@@ -183,6 +193,7 @@ def purchase_pets(pet_id):
     pet.available = False
     pet.update()
 
+    app.logger.info("Pet with ID: %d has been purchased.", pet_id)
     return pet.serialize(), status.HTTP_200_OK
 
 
@@ -191,11 +202,14 @@ def purchase_pets(pet_id):
 ######################################################################
 
 
+######################################################################
+# Checks the ContentType of a request
+######################################################################
 def check_content_type(content_type):
     """Checks that the media type is correct"""
     if "Content-Type" not in request.headers:
         app.logger.error("No Content-Type specified.")
-        abort(
+        error(
             status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
             f"Content-Type must be {content_type}",
         )
@@ -204,7 +218,16 @@ def check_content_type(content_type):
         return
 
     app.logger.error("Invalid Content-Type: %s", request.headers["Content-Type"])
-    abort(
+    error(
         status.HTTP_415_UNSUPPORTED_MEDIA_TYPE,
         f"Content-Type must be {content_type}",
     )
+
+
+######################################################################
+# Logs error messages before aborting
+######################################################################
+def error(status_code, reason):
+    """Logs the error and then aborts"""
+    app.logger.error(reason)
+    abort(status_code, reason)

tests/test_models.py

@@ -28,16 +28,13 @@
 from unittest import TestCase
 from datetime import date
 from wsgi import app
-# from service import create_app
 from service.models import Pet, Gender, DataValidationError, db
 from tests.factories import PetFactory
 
 DATABASE_URI = os.getenv(
     "DATABASE_URI", "postgresql+psycopg://postgres:postgres@localhost:5432/testdb"
 )
 
-# app = create_app()
-
 
 ######################################################################
 #  B A S E   T E S T   C A S E S
@@ -54,7 +51,6 @@ def setUpClass(cls):
         app.config["SQLALCHEMY_DATABASE_URI"] = DATABASE_URI
         app.logger.setLevel(logging.CRITICAL)
         app.app_context().push()
-        # Pet.init_db(app)
 
     @classmethod
     def tearDownClass(cls):

tests/test_routes.py

@@ -107,7 +107,7 @@ def test_index(self):
 
     def test_health(self):
         """It should be healthy"""
-        response = self.client.get("/healthcheck")
+        response = self.client.get("/health")
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         data = response.get_json()
         self.assertEqual(data["status"], 200)