Merge pull request #43 from CSCI-GA-2820-SP24-003/feat-deactivate-acc…

…ount

Feat: Deactivate account

README.md

@@ -87,6 +87,7 @@ GET /: Root URL response.
 | `DELETE` | `/customers/<customer_id>` | Delete a customer with the given `id`. |
 | `GET` | `/customers` | List all customers. |
 | `PUT` | `/customers/<customer_id>` | Update an existing customer with the given `id`. |
+| `PUT` | `/customers/<customer_id>/deactivate` | Deactivate a customer with the given `id`. |
 
 ### Usage
 

service/models.py

@@ -151,6 +151,11 @@ def deserialize(self, data):
             ) from error
         return self
 
+    def deactivate(self):
+        """Deactivates the customer account"""
+        self.active = False
+        self.update()
+
     ##################################################
     # CLASS METHODS
     ##################################################

service/routes.py

@@ -28,7 +28,7 @@
 
 
 def encrypt_password(password):
-    """ Hashing Passwords """
+    """Hashing Passwords"""
     return hashlib.sha256(password.encode("UTF-8")).hexdigest()
 
 
@@ -42,17 +42,22 @@ def index():
     #     "Reminder: return some useful information in json format about the service here",
     #     status.HTTP_200_OK,
     # )
-    return jsonify({
-        "1_Customers": "Welcome to the Customer Store Service API. This API allows you to manage the customers.",
-        "2_methods_available": {
-            "2.1 GET /customers/<customer_id>": "Retrieve a single customer by ID.",
-            "2.2 POST /customers": "Create a new customer.",
-            "2.3 DELETE /customers/<customer_id>": "Delete a customer by ID.",
-            "2.4 GET /customers": "Retrieve a list of all customers.",
-            "2.5 PUT /customers/<customer_id>": "Update an existing customer by ID."
-        },
-        "3_contact": "For more information, refer to the API documentation or contact [email protected]."
-    }), status.HTTP_200_OK
+    return (
+        jsonify(
+            {
+                "1_Customers": "Welcome to the Customer Store Service API. This API allows you to manage the customers.",
+                "2_methods_available": {
+                    "2.1 GET /customers/<customer_id>": "Retrieve a single customer by ID.",
+                    "2.2 POST /customers": "Create a new customer.",
+                    "2.3 DELETE /customers/<customer_id>": "Delete a customer by ID.",
+                    "2.4 GET /customers": "Retrieve a list of all customers.",
+                    "2.5 PUT /customers/<customer_id>": "Update an existing customer by ID.",
+                },
+                "3_contact": "For more information, refer to the API documentation or contact [email protected].",
+            }
+        ),
+        status.HTTP_200_OK,
+    )
 
 
 ######################################################################
@@ -79,9 +84,7 @@ def get_customers(customer_id):
             f"Customer with id '{customer_id}' was not found.",
         )
 
-    app.logger.info(
-        "Returning customer: %s", customer.id
-    )
+    app.logger.info("Returning customer: %s", customer.id)
     return jsonify(customer.serialize()), status.HTTP_200_OK
 
 
@@ -175,6 +178,26 @@ def update_customers(customer_id):
     return jsonify(customer.serialize()), status.HTTP_200_OK
 
 
+######################################################################
+# DEACTIVATE A CUSTOMER
+######################################################################
+@app.route("/customers/<int:customer_id>/deactivate", methods=["PUT"])
+def deactivate_customer(customer_id):
+    """
+    Deactivate a customer
+    This endpoint will deactivate a customer based on the id specified in the path
+    """
+    customer = Customer.find(customer_id)
+    if not customer:
+        abort(
+            status.HTTP_404_NOT_FOUND,
+            f"Customer with id '{customer_id}' was not found.",
+        )
+
+    customer.deactivate()
+    return jsonify(""), status.HTTP_204_NO_CONTENT
+
+
 ######################################################################
 #  U T I L I T Y   F U N C T I O N S
 ######################################################################

tests/test_models.py

@@ -320,6 +320,14 @@ def test_representing_a_customer(self):
             f"<Customer {test_customer.first_name, test_customer.last_name} id=[{test_customer.id}]>",
         )
 
+    def test_deactivate_a_customer(self):
+        """It should Deactivate a Customer"""
+        customer = CustomerFactory()
+        customer.active = True
+        self.assertTrue(customer.active)
+        customer.deactivate()
+        self.assertFalse(customer.active)
+
 
 ######################################################################
 #  Q U E R Y   T E S T   C A S E S

tests/test_routes.py

@@ -230,3 +230,27 @@ def test_mediatype_not_supported(self):
         response = self.client.post("/customers", data="{}", content_type="text/plain")
         self.assertEqual(response.status_code, 415)
         self.assertIn("Unsupported media type", response.json["error"])
+
+    def test_deactivate_customer(self):
+        """It should Deactivate a Customer"""
+        test_customer_data = CustomerFactory().serialize()
+        test_customer_data["active"] = True
+        # Create customer via POST request
+        create_response = self.client.post(BASE_URL, json=test_customer_data)
+        self.assertEqual(create_response.status_code, status.HTTP_201_CREATED)
+        created_customer = create_response.get_json()
+
+        # Deactivate the customer via PUT request
+        response = self.client.put(f"{BASE_URL}/{created_customer['id']}/deactivate")
+        self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
+
+        # Fetch the customer to verify it's deactivated
+        get_response = self.client.get(f"{BASE_URL}/{created_customer['id']}")
+        deactivated_customer = get_response.get_json()
+        self.assertFalse(deactivated_customer["active"])
+
+    def test_deactivate_nonexistent_customer(self):
+        """It should return 404 for a nonexistent customer"""
+        nonexistent_customer_id = 99999  # Assuming this ID does not exist
+        response = self.client.put(f"{BASE_URL}/{nonexistent_customer_id}/deactivate")
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)