Add rule label to disposition

Author: kevcenteno

minfraud/models.py

@@ -430,16 +430,26 @@ class Disposition:
       "custom_rule", "block_list", and "default". If you do not have custom
       rules set up, ``None`` will be returned.
 
+      :type: str | None
+
+    .. attribute:: rule_label
+
+      The label of the custom rule that was triggered. If you do not have
+      custom rule set up, or the custom rule that was triggered does not have a
+      label, ``None`` will be returned.
+
       :type: str | None
     """
 
     action: Optional[str]
     reason: Optional[str]
+    rule_label: Optional[str]
 
     __slots__ = ()
     _fields = {
         "action": None,
         "reason": None,
+        "rule_label": None,
     }
 
 

tests/test_models.py

@@ -99,10 +99,13 @@ def test_device(self):
         self.assertEqual(local_time, device.local_time)
 
     def test_disposition(self):
-        disposition = Disposition({"action": "accept", "reason": "default"})
+        disposition = Disposition(
+            {"action": "accept", "reason": "default", "rule_label": "custom rule label"}
+        )
 
         self.assertEqual("accept", disposition.action)
         self.assertEqual("default", disposition.reason)
+        self.assertEqual("custom rule label", disposition.rule_label)
 
     def test_email(self):
         first_seen = "2016-01-01"