Merge pull request #110 from gridsmartercities/currency

Currency

Author: RaminEsfandiari

.coveragerc

@@ -0,0 +1,21 @@
+[run]
+
+branch = True
+
+omit =
+    *__init__.py
+    examples/*
+    setup.py
+    tests/*
+
+[report]
+
+show_missing = True
+
+omit =
+    *__init__.py
+    examples/*
+    setup.py
+    tests/*
+
+fail_under = 100

CONTRIBUTING.md

@@ -18,12 +18,10 @@ Before submitting a PR, please ensure that:
 
 - you run [__Coverage__](https://pypi.org/project/coverage/) and all unit tests are passing:
 
-`coverage run --branch --source='.' -m unittest`
-
-- you have 100% unit test coverage:
-
-`coverage report -m --fail-under=100 --omit=*/__init__.py,tests/*,setup.py,examples/test_examples.py`
-
+`coverage run --source='.' -m unittest`
+    
+`coverage report`
+    
 - you can run the test examples like this:
 
 `python -m unittest examples.test_examples`

README.md

@@ -48,7 +48,7 @@ The current list of AWS Lambda Python Decorators includes:
 
 ### [Validators](https://github.com/gridsmartercities/aws-lambda-decorators/blob/master/aws_lambda_decorators/validators.py)
 
-Currently, the package offers 5 validators:
+Currently, the package offers 12 validators:
 
 * __Mandatory__: Checks if a parameter has a value.
 * __RegexValidator__: Checks a parameter against a regular expression.
@@ -61,6 +61,7 @@ Currently, the package offers 5 validators:
 * __EnumValidator__: Checks if an optional object value is in a list of valid values.
 * __NonEmpty__: Checks if an optional object value is not an empty value.
 * __DateValidator__: Checks if a given string is a valid date according to a passed in date format.
+* __CurrencyCodeValidator__: Checks if a given string is a valid currency code (ISO 4217).
 
 ### [Decoders](https://github.com/gridsmartercities/aws-lambda-decorators/blob/master/aws_lambda_decorators/decoders.py)
 

aws_lambda_decorators/classes.py

@@ -120,7 +120,7 @@ def validate(self, value, group_errors):
                     if hasattr(validator, "_error_message"):
                         errors.append(validator.message(value))
                     else:  # calling the validator statically
-                        errors.append(validator.ERROR_MESSAGE)
+                        errors.append(validator.ERROR_MESSAGE.format(value=value))
                     if not group_errors:
                         return errors
 

aws_lambda_decorators/validators.py

@@ -3,6 +3,19 @@
 import re
 from schema import SchemaError
 
+CURRENCIES = {"LKR", "ETB", "RWF", "NZD", "SBD", "MKD", "NPR", "LAK", "KWD", "INR", "HUF", "AFN", "BTN", "ISK", "MVR",
+              "WST", "MNT", "AZN", "SAR", "JMD", "BIF", "BMD", "CAD", "GEL", "MXN", "BHD", "HKD", "RSD", "PKR", "SLL",
+              "NGN", "TOP", "SCR", "SVC", "CHW", "UYW", "IDR", "IQD", "THB", "GBP", "MYR", "SDG", "CNY", "GNF", "LRD",
+              "KHR", "TJS", "BYN", "SHP", "AED", "BOB", "CUC", "PHP", "SSP", "USN", "MZN", "COP", "SEK", "EUR", "CDF",
+              "CRC", "KMF", "JPY", "ZWL", "ALL", "GHS", "GIP", "QAR", "GYD", "HTG", "VUV", "CZK", "ANG", "AWG", "AMD",
+              "DOP", "TRY", "ZMW", "MGA", "KZT", "XUA", "ARS", "XPF", "BRL", "MXV", "LSL", "CLP", "KES", "PYG", "TND",
+              "MAD", "DZD", "MWK", "BSD", "BBD", "FKP", "KGS", "BWP", "CVE", "HRK", "DKK", "COU", "SYP", "LYD", "PLN",
+              "TZS", "KPW", "UGX", "BOV", "UAH", "NAD", "AOA", "VES", "SOS", "CUP", "SGD", "PAB", "UZS", "STN", "SRD",
+              "CHE", "XOF", "DJF", "PGK", "UYI", "XCD", "BZD", "EGP", "ERN", "RON", "TWD", "USD", "FJD", "VND", "SZL",
+              "BND", "HNL", "KRW", "XAF", "MDL", "BDT", "MUR", "PEN", "OMR", "NIO", "TMT", "YER", "TTD", "GMD", "XDR",
+              "CHF", "NOK", "GTQ", "JOD", "KYD", "UYU", "RUB", "ZAR", "AUD", "BGN", "MOP", "LBP", "MRU", "CLF", "XSU",
+              "BAM", "MMK", "IRR", "ILS"}
+
 
 class Validator:  # noqa: pylint - too-few-public-methods
     """Validation rule to check if the given mandatory value exists."""
@@ -337,3 +350,31 @@ def validate(self, value=None):
             return False
         else:
             return True
+
+
+class CurrencyValidator(Validator):
+    """Validation rule to check if a string is a valid currency according to ISO 4217 Currency Code."""
+    ERROR_MESSAGE = "'{value}' is not a valid currency code."
+
+    def __init__(self, error_message=None):
+        """
+        Checks if a string is a valid currency based on ISO 4217
+
+        Args:
+            error_message (str): A custom error message to output if validation fails
+        """
+        super().__init__(error_message)
+
+    @staticmethod
+    def validate(value=None):
+        """
+        Check if a string is a valid currency based on ISO 4217
+
+        Args:
+            value (str): value to validate against a ISO 4217
+        """
+
+        if value is None:
+            return True
+
+        return value.upper() in CURRENCIES

examples/examples.py

@@ -7,7 +7,7 @@
                                    handle_exceptions, response_body_as_json, Parameter, SSMParameter,
                                    ValidatedParameter, ExceptionHandler, Mandatory, RegexValidator,
                                    handle_all_exceptions, cors, SchemaValidator, Maximum, Minimum, Type, EnumValidator,
-                                   NonEmpty, DateValidator)
+                                   NonEmpty, DateValidator, CurrencyValidator)
 
 
 @extract(parameters=[
@@ -205,3 +205,11 @@ def to_int(arg):
 ])
 def extract_with_custom_transform_example(a_dictionary, my_param=None):
     return {}
+
+
+@extract(parameters=[
+    Parameter(path="/params/currency_example", func_param_name="a_dictionary",
+              validators=[CurrencyValidator])
+])
+def extract_currency_param(a_dictionary, currency_example=None):
+    return currency_example

examples/test_examples.py

@@ -8,7 +8,8 @@
                                cors_example, extract_multiple_param_example,
                                extract_minimum_param_with_custom_error_example, extract_dictionary_example,
                                extract_type_param, extract_enum_param, extract_non_empty_param, extract_date_param,
-                               extract_with_transform_example, extract_with_custom_transform_example)
+                               extract_with_transform_example, extract_with_custom_transform_example,
+                               extract_currency_param)
 
 
 # pylint:disable=too-many-public-methods
@@ -334,6 +335,20 @@ def test_extract_date_param(self):
         # will return the extracted values in a dictionary.
         self.assertEqual("2001-01-01 00:00:00", response)
 
+    def test_extract_currency_param(self):
+        # Given this dictionary:
+        a_dictionary = {
+            "params": {
+                "currency_example": "GBP"
+            }
+        }
+
+        # calling the decorated extract_dictionary_example:
+        response = extract_currency_param(a_dictionary)
+
+        # will return the extracted values in a dictionary.
+        self.assertEqual("GBP", response)
+
     def test_extract_with_transform(self):
         # Given this dictionary:
         a_dictionary = {

setup.py

@@ -3,7 +3,7 @@
 LONG_DESCRIPTION = open("README.md").read()
 
 setup(name="aws-lambda-decorators",
-      version="0.45",
+      version="0.46",
       description="A set of python decorators to simplify aws python lambda development",
       long_description=LONG_DESCRIPTION,
       long_description_content_type="text/markdown",

tests/test_decorators.py

@@ -13,7 +13,7 @@
 from aws_lambda_decorators.decorators import extract, extract_from_event, extract_from_context, handle_exceptions, \
     log, response_body_as_json, extract_from_ssm, validate, handle_all_exceptions, cors
 from aws_lambda_decorators.validators import Mandatory, RegexValidator, SchemaValidator, Minimum, Maximum, MaxLength, \
-    MinLength, Type, EnumValidator, NonEmpty, DateValidator
+    MinLength, Type, EnumValidator, NonEmpty, DateValidator, CurrencyValidator
 
 TEST_JWT = "eyJraWQiOiJEQlwvK0lGMVptekNWOGNmRE1XVUxBRlBwQnVObW5CU2NcL2RoZ3pnTVhcL2NzPSIsImFsZyI6IlJTMjU2In0." \
            "eyJzdWIiOiJhYWRkMWUwZS01ODA3LTQ3NjMtYjFlOC01ODIzYmY2MzFiYjYiLCJhdWQiOiIycjdtMW1mdWFiODg3ZmZvdG9iNWFjcX" \
@@ -1679,6 +1679,61 @@ def handler(event, a=None):  # noqa: pylint - unused-argument
         response = handler(event)
         self.assertEqual(None, response)
 
+    def test_extract_currency_parameter(self):
+        event = {
+            "a": "GBP"
+        }
+
+        @extract([Parameter("/a", "event", [CurrencyValidator])])
+        def handler(event, a=None):  # noqa: pylint - unused-argument
+            return a
+
+        response = handler(event)
+        self.assertEqual("GBP", response)
+
+    def test_currency_validator_returns_true_when_none_is_passed_in(self):
+        path = "/a/b/c"
+        dictionary = {
+            "a": {
+                "b": {
+                    "c": None
+                }
+            }
+        }
+
+        @extract([Parameter(path, "event", [CurrencyValidator])])
+        def handler(event, c=None):  # noqa
+            return c
+
+        response = handler(dictionary, None)
+        self.assertEqual(None, response)
+
+    def test_currency_validator_returns_false_when_invalid_code_passed_in(self):
+        event = {
+            "a": "GBT"
+        }
+
+        @extract([Parameter("/a", "event", [CurrencyValidator])])
+        def handler(event, a=None):  # noqa: pylint - unused-argument
+            return {}
+
+        response = handler(event)
+        self.assertEqual(400, response["statusCode"])
+        self.assertEqual("{\"message\": [{\"a\": [\"\'GBT\' is not a valid currency code.\"]}]}",
+                         response["body"])
+
+    def test_currency_validator_can_be_called_non_statically(self):
+        event = {
+            "a": "GBP"
+        }
+
+        @extract([Parameter("/a", "event", [CurrencyValidator()])])
+        def handler(event, a=None):  # noqa: pylint - unused-argument
+            return a
+
+        response = handler(event)
+        self.assertEqual("GBP", response)
+
     def test_can_apply_transformation(self):
         event = {
             "a": "2"