Add IP velocity S4 rule

README.md

@@ -1 +1 @@
-**Hello world!!!**
+# S Series Model

block.py

@@ -1,21 +1,50 @@
-@flowx_block
+import logging
-def example_function(request: dict) -> dict:
+from rules_processing import processing
 
-  # Processing logic here...
+# Configure logging
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s [%(levelname)s] %(name)s - %(message)s",
+)
+logger = logging.getLogger(__name__)
 
-  return {
+def __main__(
-    "meta_info": [
+        hd_score_m1: float,
-      {
+        hd_score_g1: float,
-        "name": "created_date",
+        cluster_size_users_v2: int,
-        "type": "string",
+        target_connected_30_sum: float,
-        "value": "2024-11-05"
+        email_cnt: int,
-      }
+        rejected_app_count: float,
-    ],
+        app_dt_day_cnt: int,
-    "fields": [
+        hd_score_iso_m2: float,
-      {
+        hd_score_g2: float,
-        "name": "",
+        application_customer_type: str = None,
-        "type": "",
+        input_ip_address: str = None,
-        "value": ""
+        input_ip_connection_type: str = None,
-      }
+        input_ip_isp: str = None,
-    ]
+        input_ip_distinct_ssn_24h: float = None,
-  }
+        input_ip_distinct_zip_24h: float = None
+    ) -> dict:
+    # Create a dictionary instead of using pandas DataFrame
+    data = {
+        "hd_score_m1": hd_score_m1,
+        "hd_score_g1": hd_score_g1,
+        "cluster_size_users_v2": cluster_size_users_v2,
+        "target_connected_30_sum": target_connected_30_sum,
+        "email_cnt": email_cnt,
+        "rejected_app_count": rejected_app_count,
+        "app_dt_day_cnt": app_dt_day_cnt,
+        "hd_score_iso_m2": hd_score_iso_m2,
+        "hd_score_g2": hd_score_g2,
+        "application_customer_type": application_customer_type,
+        "input_ip_address": input_ip_address,
+        "input_ip_connection_type": input_ip_connection_type,
+        "input_ip_isp": input_ip_isp,
+        "input_ip_distinct_ssn_24h": input_ip_distinct_ssn_24h,
+        "input_ip_distinct_zip_24h": input_ip_distinct_zip_24h
+    }
+
+    final = processing(data)
+    logger.info(f"scores of application: {final}")
+
+    return final

request_schema.json

@@ -1 +1,67 @@
-{}
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "hd_score_m1": {
+      "type": ["number", "null"],
+      "description": "HD fraud Score M1"
+    },
+    "hd_score_g1": {
+        "type": ["number", "null"],
+        "description": "HD Fraud Score G1"
+      },
+    "hd_score_g2": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score G1"
+    },
+    "cluster_size_users_v2": {
+      "type": ["number", "null"],
+      "description": "Size of the user cluster in version 2."
+    },
+    "target_connected_30_sum": {
+      "type": ["number", "null"],
+      "description": "Sum of target connections within 30 days."
+    },
+    "email_cnt": {
+      "type": ["number", "null"],
+      "description": "Count of emails associated with the application."
+    },
+    "rejected_app_count": {
+      "type": ["number", "null"],
+      "description": "Count of rejected applications for the applicant."
+    },
+    "app_dt_day_cnt": {
+      "type": ["number", "null"],
+      "description": "Number of application days counted."
+    },
+    "hd_score_iso_m2": {
+      "type": ["number", "null"],
+      "description": "HD fraud Score M2"
+    },
+    "application_customer_type": {
+      "type": ["string", "null"],
+      "description": "Application customer type for S4 velocity rule."
+    },
+    "input_ip_address": {
+      "type": ["string", "null"],
+      "description": "Current application input IP address for S4 velocity rule."
+    },
+    "input_ip_connection_type": {
+      "type": ["string", "null"],
+      "description": "Current application input IP connection type for S4 velocity rule."
+    },
+    "input_ip_isp": {
+      "type": ["string", "null"],
+      "description": "Current application input IP ISP for S4 velocity rule."
+    },
+    "input_ip_distinct_ssn_24h": {
+      "type": ["number", "null"],
+      "description": "Distinct SSN count for the same input IP in the past 24 hours."
+    },
+    "input_ip_distinct_zip_24h": {
+      "type": ["number", "null"],
+      "description": "Distinct ZIP count for the same input IP in the past 24 hours."
+    }
+  },
+  "required": []
+}

requirements.txt

@@ -1 +1,3 @@
-{}
+
+
+

response_schema.json

@@ -1 +1,40 @@
-{}
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "hd_score_m1": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score M1"
+    },
+    "hd_score_g1": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score G1"
+    },
+    "hd_score_g2": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score G1"
+    },
+    "hd_score_s1": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score S1"
+    },
+    "hd_score_s2": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score S2"
+    },
+    "hd_score_s3": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score S3"
+    },
+    "hd_score_s4": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score S4"
+    },
+    "hd_score_iso_m2": {
+      "type": ["number", "null"],
+      "description": "HD Fraud Score M2"
+    }
+  }
+}
+
+

rules_processing.py

@@ -0,0 +1,108 @@
+import logging
+import re
+
+# Configure logging
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s [%(levelname)s] %(name)s - %(message)s",
+)
+logger = logging.getLogger(__name__)
+
+INVALID_INPUT_IP_VALUES = {"", "nan", "null", "none", "n/a", "0.0.0.0", "unknown"}
+BLOCKED_CONNECTION_TYPES = {"mobile wireless", "tx"}
+BLOCKED_ISP_PATTERN = re.compile(
+    r"cloudflare|fastly|icloud|private relay|google llc|amazon technologies|datacamp|microsoft"
+)
+
+
+def _normalize_string(value) -> str:
+    if value is None:
+        return ""
+    return str(value).strip().lower()
+
+
+def _normalize_count(value) -> int:
+    if value is None:
+        return 0
+    try:
+        return int(float(value))
+    except (TypeError, ValueError):
+        return 0
+
+
+def _calculate_s4(data: dict) -> int:
+    customer_type = _normalize_string(data.get("application_customer_type"))
+    input_ip_address = _normalize_string(data.get("input_ip_address"))
+    connection_type = _normalize_string(data.get("input_ip_connection_type"))
+    isp = _normalize_string(data.get("input_ip_isp"))
+    distinct_ssn = _normalize_count(data.get("input_ip_distinct_ssn_24h"))
+    distinct_zip = _normalize_count(data.get("input_ip_distinct_zip_24h"))
+
+    if customer_type != "direct new":
+        return 0
+    if input_ip_address in INVALID_INPUT_IP_VALUES:
+        return 0
+    if connection_type in BLOCKED_CONNECTION_TYPES:
+        return 0
+    if BLOCKED_ISP_PATTERN.search(isp):
+        return 0
+    if distinct_ssn < 3 or distinct_zip < 2:
+        return 0
+
+    return min(1200, 1191 + (distinct_ssn - 3) + (distinct_zip - 2))
+
+
+def processing(data: dict) -> dict:
+    try:
+        hd_score_s1 = (
+            min(1225 + (data["cluster_size_users_v2"] * 5), 1390)
+            if data["cluster_size_users_v2"] >= 3 and data["hd_score_m1"] >= 1140
+            else 0
+        )
+        logger.info(f"score_s1 calculated: {hd_score_s1}")
+    except Exception as e:
+        logger.error(f"Error processing score_s1 calculations: {e}")
+        return {}
+
+    try:
+        hd_score_s2 = (
+            min(1215 + (data["cluster_size_users_v2"] * 5), 1380)
+            if data["cluster_size_users_v2"] >= 2 and data["app_dt_day_cnt"] == 1
+            else 0
+        )
+        logger.info(f"score_s2 calculated: {hd_score_s2}")
+    except Exception as e:
+        logger.error(f"Error processing score_s2 calculations: {e}")
+        return {}
+
+    try:
+        target_connected_30_sum = data.get("target_connected_30_sum", 0) or 0  # Handling None case
+        hd_score_s3 = (
+            min(1250 + (target_connected_30_sum * 5), 1400)
+            if target_connected_30_sum >= 1
+            else 0
+        )
+        logger.info(f"score_s3 calculated: {hd_score_s3}")
+    except Exception as e:
+        logger.error(f"Error processing score_s3 calculations: {e}")
+        return {}
+
+    try:
+        hd_score_s4 = _calculate_s4(data)
+        logger.info(f"score_s4 calculated: {hd_score_s4}")
+    except Exception as e:
+        logger.error(f"Error processing score_s4 calculations: {e}")
+        return {}
+
+    # Return the final results as a dictionary
+    return {
+        "hd_score_m1": data["hd_score_m1"],
+        "hd_score_g1": data["hd_score_g1"],
+        "hd_score_s1": hd_score_s1,
+        "hd_score_s2": hd_score_s2,
+        "hd_score_s3": hd_score_s3,
+        "hd_score_s4": hd_score_s4,
+        "hd_score_iso_m2": data["hd_score_iso_m2"],
+        "hd_score_g2": data["hd_score_g2"]
+    }
+

test_block.py

@@ -0,0 +1,102 @@
+import json
+import unittest
+from pathlib import Path
+from block import __main__
+
+BASE_DIR = Path(__file__).resolve().parent
+
+data = {
+    "hd_score_m1": 1093.0,
+    "hd_score_g1": 0.0,
+    "cluster_size_users_v2": 1.0,
+    "target_connected_30_sum": 0.0,
+    "email_cnt": 1.0,
+    "rejected_app_count": 0.0,
+    "app_dt_day_cnt": 1.0,
+    "hd_score_iso_m2": 1001.0,
+    "hd_score_g2": 0.0
+}
+
+
+def s4_data(**overrides):
+    values = {
+        **data,
+        "application_customer_type": "Direct New",
+        "input_ip_address": "203.0.113.10",
+        "input_ip_connection_type": "broadband",
+        "input_ip_isp": "local isp",
+        "input_ip_distinct_ssn_24h": 3,
+        "input_ip_distinct_zip_24h": 2,
+    }
+    values.update(overrides)
+    return values
+
+
+class TestBlock(unittest.TestCase):
+    def test_main_success(self):
+        blockResult = __main__(**data)
+
+        self.assertIsInstance(blockResult, dict, "Result should be a dictionary.")
+        self.assertIn("hd_score_s1", blockResult, "Result dictionary should contain 'hd_score_s1' if success.")
+
+    def test_s4_triggers_for_direct_new_valid_ip_velocity(self):
+        block_result = __main__(**s4_data())
+
+        self.assertEqual(block_result["hd_score_s4"], 1191)
+
+    def test_s4_score_caps_at_1200(self):
+        block_result = __main__(**s4_data(
+            input_ip_distinct_ssn_24h=30,
+            input_ip_distinct_zip_24h=30,
+        ))
+
+        self.assertEqual(block_result["hd_score_s4"], 1200)
+
+    def test_s4_requires_direct_new(self):
+        block_result = __main__(**s4_data(application_customer_type="Returning"))
+
+        self.assertEqual(block_result["hd_score_s4"], 0)
+
+    def test_s4_rejects_invalid_ip(self):
+        block_result = __main__(**s4_data(input_ip_address="0.0.0.0"))
+
+        self.assertEqual(block_result["hd_score_s4"], 0)
+
+    def test_s4_rejects_blocked_connection_type(self):
+        block_result = __main__(**s4_data(input_ip_connection_type="Mobile Wireless"))
+
+        self.assertEqual(block_result["hd_score_s4"], 0)
+
+    def test_s4_rejects_blocked_isp(self):
+        block_result = __main__(**s4_data(input_ip_isp="Cloudflare Inc."))
+
+        self.assertEqual(block_result["hd_score_s4"], 0)
+
+    def test_s4_requires_distinct_ssn_and_zip_thresholds(self):
+        block_result = __main__(**s4_data(input_ip_distinct_zip_24h=1))
+
+        self.assertEqual(block_result["hd_score_s4"], 0)
+
+    def test_s4_schema_contract(self):
+        request_schema = json.loads((BASE_DIR / "request_schema.json").read_text())
+        response_schema = json.loads((BASE_DIR / "response_schema.json").read_text())
+
+        for field in (
+            "application_customer_type",
+            "input_ip_address",
+            "input_ip_connection_type",
+            "input_ip_isp",
+        ):
+            self.assertEqual(request_schema["properties"][field]["type"], ["string", "null"])
+
+        for field in (
+            "input_ip_distinct_ssn_24h",
+            "input_ip_distinct_zip_24h",
+        ):
+            self.assertEqual(request_schema["properties"][field]["type"], ["number", "null"])
+
+        self.assertEqual(response_schema["properties"]["hd_score_s4"]["type"], ["number", "null"])
+
+
+if __name__ == "__main__":
+    unittest.main()