Do not require the IP address input

Author: horgh

HISTORY.rst

@@ -3,6 +3,11 @@
 History
 -------
 
+2.2.0
+++++++++++++++++++
+
+* The device IP address is no longer a required input.
+
 2.1.0 (2020-09-25)
 ++++++++++++++++++
 

README.rst

@@ -72,8 +72,7 @@ Each of these methods takes a dictionary representing the transaction to be sent
 to the web service. The structure of this dictionary should be in `the format
 specified in the REST API documentation
 <https://dev.maxmind.com/minfraud/#Request_Body>`__.
-The ``ip_address`` in the ``device`` sub-dictionary is required. All other
-fields are optional.
+All fields are optional.
 
 Report Transactions Usage
 ^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -114,9 +113,9 @@ The possible errors are:
   is unable to authenticate the request, e.g., if the license key or account
   ID is invalid.
 * ``minfraud.InvalidRequestError`` - This will be raised when the server
-  rejects the request as invalid for another reason, such as a missing or
-  reserved IP address. It is also raised if validation of the request before
-  it is sent to the server fails.
+  rejects the request as invalid for another reason, such as a reserved IP
+  address. It is also raised if validation of the request before it is sent to
+  the server fails.
 * ``minfraud.HttpError`` - This will be raised when an unexpected HTTP
   error occurs such as a firewall interfering with the request to the server.
 * ``minfraud.MinFraudError`` - This will be raised when some other error

minfraud/validation.py

@@ -294,9 +294,9 @@ def _uri(s: str) -> str:
             "token": _credit_card_token,
         },
         "custom_inputs": {_custom_input_key: _custom_input_value},
-        Required("device"): {
+        "device": {
             "accept_language": str,
-            Required("ip_address"): _ip_address,
+            "ip_address": _ip_address,
             "session_age": All(_any_number, Range(min=0)),
             "session_id": str,
             "user_agent": str,

tests/test_validation.py

@@ -66,6 +66,16 @@ def check_report_str_type(self, key):
         self.check_invalid_report({key: 12})
 
 
+class TestTransaction(unittest.TestCase, ValidationBase):
+    def test_transaction_without_device(self):
+        transaction = {
+            "account": {
+                "user_id": "usr",
+            }
+        }
+        validate_transaction(transaction)
+
+
 class TestAccount(unittest.TestCase, ValidationBase):
     def test_account_user_id(self):
         self.check_transaction({"account": {"user_id": "usr"}})
@@ -209,12 +219,17 @@ def test_ip_address(self):
             self.check_invalid_transaction({"device": {"ip_address": invalid}})
 
     def test_missing_ip(self):
-        with self.assertRaises(MultipleInvalid):
-            validate_transaction({"device": {}})
+        validate_transaction({"device": {}})
+        validate_transaction(
+            {
+                "device": {
+                    "user_agent": "foo",
+                }
+            }
+        )
 
     def test_missing_device(self):
-        with self.assertRaises(MultipleInvalid):
-            validate_transaction({})
+        validate_transaction({})
 
     def test_user_agent(self):
         self.check_transaction_str_type("device", "user_agent")