refactor: HttpVerb as enum

Author: heitorlessa

Diff for: aws_lambda_powertools/utilities/data_classes/api_gateway_authorizer_event.py

@@ -1,3 +1,4 @@
+import enum
 import re
 from typing import Any, Dict, List, Optional
 
@@ -312,7 +313,7 @@ def asdict(self) -> dict:
         return response
 
 
-class HttpVerb:
+class HttpVerb(enum.Enum):
     GET = "GET"
     POST = "POST"
     PUT = "PUT"
@@ -386,8 +387,9 @@ def _add_route(self, effect: str, verb: str, resource: str, conditions: List[Dic
         """Adds a route to the internal lists of allowed or denied routes. Each object in
         the internal list contains a resource ARN and a condition statement. The condition
         statement can be null."""
-        if verb != "*" and not hasattr(HttpVerb, verb):
-            raise ValueError(f"Invalid HTTP verb {verb}. Allowed verbs in HttpVerb class")
+        if verb != "*" and verb not in HttpVerb.__members__:
+            allowed_values = [verb.value for verb in HttpVerb]
+            raise ValueError(f"Invalid HTTP verb: '{verb}'. Use either '{allowed_values}'")
 
         resource_pattern = re.compile(self.path_regex)
         if not resource_pattern.match(resource):
@@ -433,29 +435,42 @@ def _get_statement_for_effect(self, effect: str, methods: List) -> List:
 
         return statements
 
-    def allow_all_routes(self):
-        """Adds a '*' allow to the policy to authorize access to all methods of an API"""
-        self._add_route("Allow", HttpVerb.ALL, "*", [])
+    def allow_all_routes(self, http_method: str = HttpVerb.ALL.value):
+        """Adds a '*' allow to the policy to authorize access to all methods of an API
 
-    def deny_all_routes(self):
-        """Adds a '*' allow to the policy to deny access to all methods of an API"""
-        self._add_route("Deny", HttpVerb.ALL, "*", [])
+        Parameters
+        ----------
+        http_method: str
+        """
+        self._add_route(effect="Allow", verb=http_method, resource="*", conditions=[])
+
+    def deny_all_routes(self, http_method: str = HttpVerb.ALL.value):
+        """Adds a '*' allow to the policy to deny access to all methods of an API
+
+        Parameters
+        ----------
+        http_method: str
+        """
+
+        self._add_route(effect="Deny", verb=http_method, resource="*", conditions=[])
 
     def allow_route(self, http_method: str, resource: str, conditions: Optional[List[Dict]] = None):
         """Adds an API Gateway method (Http verb + Resource path) to the list of allowed
         methods for the policy.
 
         Optionally includes a condition for the policy statement. More on AWS policy
         conditions here: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#Condition"""
-        self._add_route("Allow", http_method, resource, conditions or [])
+        conditions = conditions or []
+        self._add_route(effect="Allow", verb=http_method, resource=resource, conditions=conditions)
 
     def deny_route(self, http_method: str, resource: str, conditions: Optional[List[Dict]] = None):
         """Adds an API Gateway method (Http verb + Resource path) to the list of denied
         methods for the policy.
 
         Optionally includes a condition for the policy statement. More on AWS policy
         conditions here: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#Condition"""
-        self._add_route("Deny", http_method, resource, conditions or [])
+        conditions = conditions or []
+        self._add_route(effect="Deny", verb=http_method, resource=resource, conditions=conditions)
 
     def asdict(self) -> Dict[str, Any]:
         """Generates the policy document based on the internal lists of allowed and denied

Diff for: tests/functional/data_classes/test_api_gateway_authorizer.py

@@ -22,23 +22,17 @@ def test_authorizer_response_no_statement(builder: APIGatewayAuthorizerResponse)
 
 
 def test_authorizer_response_invalid_verb(builder: APIGatewayAuthorizerResponse):
-    with pytest.raises(ValueError) as ex:
+    with pytest.raises(ValueError, match="Invalid HTTP verb: 'INVALID'"):
         # GIVEN a invalid http_method
         # WHEN calling deny_method
-        builder.deny_route("INVALID", "foo")
-
-    # THEN raise a name error for invalid http verb
-    assert str(ex.value) == "Invalid HTTP verb INVALID. Allowed verbs in HttpVerb class"
+        builder.deny_route(http_method="INVALID", resource="foo")
 
 
 def test_authorizer_response_invalid_resource(builder: APIGatewayAuthorizerResponse):
-    with pytest.raises(ValueError) as ex:
+    with pytest.raises(ValueError, match="Invalid resource path: \$."):  # noqa: W605
         # GIVEN a invalid resource path "$"
         # WHEN calling deny_method
-        builder.deny_route(HttpVerb.GET, "$")
-
-    # THEN raise a name error for invalid resource
-    assert "Invalid resource path: $" in str(ex.value)
+        builder.deny_route(http_method=HttpVerb.GET.value, resource="$")
 
 
 def test_authorizer_response_allow_all_routes_with_context():
@@ -78,7 +72,7 @@ def test_authorizer_response_deny_all_routes(builder: APIGatewayAuthorizerRespon
 
 
 def test_authorizer_response_allow_route(builder: APIGatewayAuthorizerResponse):
-    builder.allow_route(HttpVerb.GET, "/foo")
+    builder.allow_route(http_method=HttpVerb.GET.value, resource="/foo")
     assert builder.asdict() == {
         "policyDocument": {
             "Version": "2012-10-17",
@@ -95,7 +89,7 @@ def test_authorizer_response_allow_route(builder: APIGatewayAuthorizerResponse):
 
 
 def test_authorizer_response_deny_route(builder: APIGatewayAuthorizerResponse):
-    builder.deny_route(HttpVerb.PUT, "foo")
+    builder.deny_route(http_method=HttpVerb.PUT.value, resource="foo")
     assert builder.asdict() == {
         "principalId": "foo",
         "policyDocument": {
@@ -112,12 +106,11 @@ def test_authorizer_response_deny_route(builder: APIGatewayAuthorizerResponse):
 
 
 def test_authorizer_response_allow_route_with_conditions(builder: APIGatewayAuthorizerResponse):
+    condition = {"StringEquals": {"method.request.header.Content-Type": "text/html"}}
     builder.allow_route(
-        HttpVerb.POST,
-        "/foo",
-        [
-            {"StringEquals": {"method.request.header.Content-Type": "text/html"}},
-        ],
+        http_method=HttpVerb.POST.value,
+        resource="/foo",
+        conditions=[condition],
     )
     assert builder.asdict() == {
         "principalId": "foo",
@@ -136,13 +129,8 @@ def test_authorizer_response_allow_route_with_conditions(builder: APIGatewayAuth
 
 
 def test_authorizer_response_deny_route_with_conditions(builder: APIGatewayAuthorizerResponse):
-    builder.deny_route(
-        HttpVerb.POST,
-        "/foo",
-        [
-            {"StringEquals": {"method.request.header.Content-Type": "application/json"}},
-        ],
-    )
+    condition = {"StringEquals": {"method.request.header.Content-Type": "application/json"}}
+    builder.deny_route(http_method=HttpVerb.POST.value, resource="/foo", conditions=[condition])
     assert builder.asdict() == {
         "principalId": "foo",
         "policyDocument": {