reformat

Author: haydencarroll-NS1

examples/usage_alerts.py

@@ -10,19 +10,20 @@
 from ns1.config import Config
 
 # Path hackery to ensure we import the local ns1 module
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
-                                                '..')))
+sys.path.insert(
+    0, os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
+)
 
 # Create NS1 client
 config = {
-    'endpoint': 'https://api.nsone.net',
-    'default_key': 'test1',
-    'keys': {
-        'test1': {
-            'key': os.environ.get('NS1_APIKEY', 'test1'),
-            'desc': 'test key'
+    "endpoint": "https://api.nsone.net",
+    "default_key": "test1",
+    "keys": {
+        "test1": {
+            "key": os.environ.get("NS1_APIKEY", "test1"),
+            "desc": "test key",
         }
-    }
+    },
 }
 
 # Create a config from dictionary and create the client
@@ -40,7 +41,7 @@ def usage_alerts_example():
     try:
         alerts = client.alerting().usage.list(limit=10)
         print(f"Total alerts: {alerts.get('total_results', 0)}")
-        for i, alert in enumerate(alerts.get('results', [])):
+        for i, alert in enumerate(alerts.get("results", [])):
             print(f"  {i+1}. {alert.get('name')} (id: {alert.get('id')})")
     except Exception as e:
         print(f"Error listing alerts: {e}")
@@ -53,9 +54,9 @@ def usage_alerts_example():
             subtype="query_usage",
             alert_at_percent=85,
             notifier_list_ids=[],
-            zone_names=[]
+            zone_names=[],
         )
-        alert_id = alert['id']
+        alert_id = alert["id"]
         print(f"Created alert: {alert['name']} (id: {alert_id})")
         print(f"Alert details: {json.dumps(alert, indent=2)}")
     except Exception as e:
@@ -65,10 +66,7 @@ def usage_alerts_example():
     # Update the alert
     print("\nUpdating the alert threshold to 90%:")
     try:
-        updated = client.alerting().usage.patch(
-            alert_id,
-            alert_at_percent=90
-        )
+        updated = client.alerting().usage.patch(alert_id, alert_at_percent=90)
         print(f"Updated alert: {updated['name']}")
         print(f"New threshold: {updated['data']['alert_at_percent']}%")
     except Exception as e:
@@ -99,9 +97,7 @@ def test_validation():
     print("Testing invalid subtype:")
     try:
         client.alerting().usage.create(
-            name="Test alert",
-            subtype="invalid_subtype",
-            alert_at_percent=85
+            name="Test alert", subtype="invalid_subtype", alert_at_percent=85
         )
     except ValueError as e:
         print(f"Validation error (expected): {e}")
@@ -110,9 +106,7 @@ def test_validation():
     print("\nTesting threshold too low (0):")
     try:
         client.alerting().usage.create(
-            name="Test alert",
-            subtype="query_usage",
-            alert_at_percent=0
+            name="Test alert", subtype="query_usage", alert_at_percent=0
         )
     except ValueError as e:
         print(f"Validation error (expected): {e}")
@@ -121,18 +115,18 @@ def test_validation():
     print("\nTesting threshold too high (101):")
     try:
         client.alerting().usage.create(
-            name="Test alert",
-            subtype="query_usage",
-            alert_at_percent=101
+            name="Test alert", subtype="query_usage", alert_at_percent=101
         )
     except ValueError as e:
         print(f"Validation error (expected): {e}")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     print("Usage Alerts API Examples")
     print("-" * 30)
-    print("Note: To run against the actual API, set the NS1_APIKEY environment variable")
+    print(
+        "Note: To run against the actual API, set the NS1_APIKEY environment variable"
+    )
     print("Otherwise, this will run against a mock API endpoint")
 
     # Run examples

ns1/alerting/usage_alerts.py

@@ -1,8 +1,12 @@
 from typing import List, Optional, Dict, Any
 
 USAGE_SUBTYPES = {
-    "query_usage", "record_usage", "china_query_usage",
-    "rum_decision_usage", "filter_chain_usage", "monitor_usage",
+    "query_usage",
+    "record_usage",
+    "china_query_usage",
+    "rum_decision_usage",
+    "filter_chain_usage",
+    "monitor_usage",
 }
 
 
@@ -12,7 +16,8 @@ def _validate(name: str, subtype: str, alert_at_percent: int) -> None:
     if subtype not in USAGE_SUBTYPES:
         raise ValueError("invalid subtype")
     if not isinstance(alert_at_percent, int) or not (
-            1 <= alert_at_percent <= 100):
+        1 <= alert_at_percent <= 100
+    ):
         raise ValueError("data.alert_at_percent must be int in 1..100")
 
 
@@ -26,12 +31,15 @@ class UsageAlertsAPI:
     def __init__(self, client) -> None:
         self._c = client
 
-    def create(self, *,
-               name: str,
-               subtype: str,
-               alert_at_percent: int,
-               notifier_list_ids: Optional[List[str]] = None,
-               zone_names: Optional[List[str]] = None) -> Dict[str, Any]:
+    def create(
+        self,
+        *,
+        name: str,
+        subtype: str,
+        alert_at_percent: int,
+        notifier_list_ids: Optional[List[str]] = None,
+        zone_names: Optional[List[str]] = None,
+    ) -> Dict[str, Any]:
         _validate(name, subtype, alert_at_percent)
         body = {
             "name": name,
@@ -46,17 +54,22 @@ def create(self, *,
     def get(self, alert_id: str) -> Dict[str, Any]:
         return self._c._get(f"/alerting/v1/alerts/{alert_id}")
 
-    def patch(self, alert_id: str, *,
-              name: Optional[str] = None,
-              alert_at_percent: Optional[int] = None,
-              notifier_list_ids: Optional[List[str]] = None,
-              zone_names: Optional[List[str]] = None) -> Dict[str, Any]:
+    def patch(
+        self,
+        alert_id: str,
+        *,
+        name: Optional[str] = None,
+        alert_at_percent: Optional[int] = None,
+        notifier_list_ids: Optional[List[str]] = None,
+        zone_names: Optional[List[str]] = None,
+    ) -> Dict[str, Any]:
         patch: Dict[str, Any] = {}
         if name is not None:
             patch["name"] = name
         if alert_at_percent is not None:
             if not isinstance(alert_at_percent, int) or not (
-                    1 <= alert_at_percent <= 100):
+                1 <= alert_at_percent <= 100
+            ):
                 raise ValueError("data.alert_at_percent must be int in 1..100")
             patch["data"] = {"alert_at_percent": int(alert_at_percent)}
         if notifier_list_ids is not None:
@@ -68,10 +81,13 @@ def patch(self, alert_id: str, *,
     def delete(self, alert_id: str) -> None:
         self._c._delete(f"/alerting/v1/alerts/{alert_id}")
 
-    def list(self, *,
-             limit: int = 50,
-             next: Optional[str] = None,
-             order_descending: bool = False) -> Dict[str, Any]:
+    def list(
+        self,
+        *,
+        limit: int = 50,
+        next: Optional[str] = None,
+        order_descending: bool = False,
+    ) -> Dict[str, Any]:
         params: Dict[str, Any] = {"limit": limit}
         if next:
             params["next"] = next

tests/unit/test_usage_alerts.py

@@ -26,6 +26,7 @@ def usage_alerts_client(config):
         }
     )
     from ns1 import NS1
+
     client = NS1(config=config)
     return client
 
@@ -45,7 +46,7 @@ def test_create_usage_alert(usage_alerts_client):
         "notifier_list_ids": ["n1"],
         "zone_names": [],
         "created_at": 1597937213,
-        "updated_at": 1597937213
+        "updated_at": 1597937213,
     }
 
     # Patch the client reference
@@ -54,7 +55,7 @@ def test_create_usage_alert(usage_alerts_client):
             name="Test Alert",
             subtype="query_usage",
             alert_at_percent=85,
-            notifier_list_ids=["n1"]
+            notifier_list_ids=["n1"],
         )
 
     # Verify _post was called with correct arguments
@@ -64,10 +65,11 @@ def test_create_usage_alert(usage_alerts_client):
         "subtype": "query_usage",
         "data": {"alert_at_percent": 85},
         "notifier_list_ids": ["n1"],
-        "zone_names": []
+        "zone_names": [],
     }
     client._post.assert_called_once_with(
-        "/alerting/v1/alerts", json=expected_body)
+        "/alerting/v1/alerts", json=expected_body
+    )
 
     # Verify result
     assert alert["id"] == "a1b2c3"
@@ -91,7 +93,7 @@ def test_get_usage_alert(usage_alerts_client):
         "subtype": "query_usage",
         "data": {"alert_at_percent": 85},
         "notifier_list_ids": ["n1"],
-        "zone_names": []
+        "zone_names": [],
     }
 
     # Patch the client reference
@@ -121,24 +123,20 @@ def test_patch_usage_alert(usage_alerts_client):
         "subtype": "query_usage",
         "data": {"alert_at_percent": 90},
         "notifier_list_ids": ["n1"],
-        "zone_names": []
+        "zone_names": [],
     }
 
     # Patch the client reference
     with mock.patch.object(client.alerting().usage, "_c", client):
         alert = client.alerting().usage.patch(
-            alert_id,
-            name="Updated Alert",
-            alert_at_percent=90
+            alert_id, name="Updated Alert", alert_at_percent=90
         )
 
     # Verify _patch was called with correct arguments
-    expected_body = {
-        "name": "Updated Alert",
-        "data": {"alert_at_percent": 90}
-    }
+    expected_body = {"name": "Updated Alert", "data": {"alert_at_percent": 90}}
     client._patch.assert_called_once_with(
-        f"/alerting/v1/alerts/{alert_id}", json=expected_body)
+        f"/alerting/v1/alerts/{alert_id}", json=expected_body
+    )
 
     # Verify type/subtype are not in the arguments
     call_args = client._patch.call_args[1]["json"]
@@ -183,25 +181,20 @@ def test_list_usage_alerts(usage_alerts_client):
                 "name": "Alert 1",
                 "type": "account",
                 "subtype": "query_usage",
-                "data": {"alert_at_percent": 80}
+                "data": {"alert_at_percent": 80},
             }
-        ]
+        ],
     }
 
     # Patch the client reference
     with mock.patch.object(client.alerting().usage, "_c", client):
-        response = client.alerting().usage.list(
-            limit=1,
-            order_descending=True
-        )
+        response = client.alerting().usage.list(limit=1, order_descending=True)
 
     # Verify _get was called with correct URL and params
-    expected_params = {
-        "limit": 1,
-        "order_descending": "true"
-    }
+    expected_params = {"limit": 1, "order_descending": "true"}
     client._get.assert_called_once_with(
-        "/alerting/v1/alerts", params=expected_params)
+        "/alerting/v1/alerts", params=expected_params
+    )
 
     # Verify result
     assert "results" in response
@@ -219,27 +212,20 @@ def test_validation_threshold_bounds(usage_alerts_client):
     # Test below minimum
     with pytest.raises(ValueError) as excinfo:
         client.alerting().usage.create(
-            name="Test Alert",
-            subtype="query_usage",
-            alert_at_percent=0
+            name="Test Alert", subtype="query_usage", alert_at_percent=0
         )
     assert "alert_at_percent must be int in 1..100" in str(excinfo.value)
 
     # Test above maximum
     with pytest.raises(ValueError) as excinfo:
         client.alerting().usage.create(
-            name="Test Alert",
-            subtype="query_usage",
-            alert_at_percent=101
+            name="Test Alert", subtype="query_usage", alert_at_percent=101
         )
     assert "alert_at_percent must be int in 1..100" in str(excinfo.value)
 
     # Test same validation in patch
     with pytest.raises(ValueError) as excinfo:
-        client.alerting().usage.patch(
-            "a1",
-            alert_at_percent=101
-        )
+        client.alerting().usage.patch("a1", alert_at_percent=101)
     assert "alert_at_percent must be int in 1..100" in str(excinfo.value)