add deprecated pulsar endpoints

Author: fformica

ns1/rest/pulsar_decisions.py

@@ -3,6 +3,8 @@
 #
 # License under The MIT License (MIT). See LICENSE in project root.
 #
+import warnings
+
 from . import resource
 
 try:
@@ -134,6 +136,17 @@ def get_filters_time(self, callback=None, errback=None, **kwargs):
     def get_decision_customer(
         self, customer_id, callback=None, errback=None, **kwargs
     ):
+        """
+        .. deprecated::
+            The ``pulsar/query/decision/customer`` API is deprecated and will
+            be removed in a future release.
+        """
+        warnings.warn(
+            "Decisions.get_decision_customer is deprecated and will be"
+            " removed in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         path = self._make_query_url(
             "decision/customer/%s" % customer_id, **kwargs
         )
@@ -147,6 +160,17 @@ def get_decision_customer(
     def get_decision_customer_undetermined(
         self, customer_id, callback=None, errback=None, **kwargs
     ):
+        """
+        .. deprecated::
+            The ``pulsar/query/decision/customer`` API is deprecated and will
+            be removed in a future release.
+        """
+        warnings.warn(
+            "Decisions.get_decision_customer_undetermined is deprecated and"
+            " will be removed in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         path = self._make_query_url(
             "decision/customer/%s/undetermined" % customer_id, **kwargs
         )
@@ -166,6 +190,17 @@ def get_decision_record(
         errback=None,
         **kwargs
     ):
+        """
+        .. deprecated::
+            The ``pulsar/query/decision/customer`` API is deprecated and will
+            be removed in a future release.
+        """
+        warnings.warn(
+            "Decisions.get_decision_record is deprecated and will be"
+            " removed in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         path = self._make_query_url(
             "decision/customer/%s/record/%s/%s"
             % (customer_id, domain, rec_type),
@@ -187,6 +222,17 @@ def get_decision_record_undetermined(
         errback=None,
         **kwargs
     ):
+        """
+        .. deprecated::
+            The ``pulsar/query/decision/customer`` API is deprecated and will
+            be removed in a future release.
+        """
+        warnings.warn(
+            "Decisions.get_decision_record_undetermined is deprecated and"
+            " will be removed in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         path = self._make_query_url(
             "decision/customer/%s/record/%s/%s/undetermined"
             % (customer_id, domain, rec_type),
@@ -202,6 +248,17 @@ def get_decision_record_undetermined(
     def get_decision_total(
         self, customer_id, callback=None, errback=None, **kwargs
     ):
+        """
+        .. deprecated::
+            The ``pulsar/query/decision/customer`` API is deprecated and will
+            be removed in a future release.
+        """
+        warnings.warn(
+            "Decisions.get_decision_total is deprecated and will be"
+            " removed in a future release.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         path = self._make_query_url(
             "decision/customer/%s/total" % customer_id, **kwargs
         )

tests/unit/test_pulsar_decisions.py

@@ -97,6 +97,48 @@ def pulsar_decisions_config(config):
             "pulsar/query/decisions/filters/time",
             {"callback": None, "errback": None},
         ),
+        (
+            "get_decisions_records",
+            None,
+            "GET",
+            "pulsar/query/decisions/records",
+            {"callback": None, "errback": None},
+        ),
+        (
+            "get_decisions_results_record",
+            None,
+            "GET",
+            "pulsar/query/decisions/results/record",
+            {"callback": None, "errback": None},
+        ),
+    ],
+)
+def test_rest_pulsar_decisions(
+    pulsar_decisions_config, op, args, method, url, kwargs
+):
+    """Test Pulsar Decisions REST API endpoints."""
+    m = ns1.rest.pulsar_decisions.Decisions(pulsar_decisions_config)
+    m._make_request = mock.MagicMock()
+    operation = getattr(m, op)
+    if args is not None:
+        if (
+            isinstance(args, list)
+            and len(args) == 1
+            and isinstance(args[0], dict)
+        ):
+            # Handle kwargs case
+            operation(**args[0])
+        else:
+            # Handle positional args case
+            operation(*args)
+    else:
+        operation()
+    m._make_request.assert_called_once_with(method, url, **kwargs)
+
+
+@pytest.mark.parametrize(
+    "op, args, method, url, kwargs",
+    [
         (
             "get_decision_customer",
             ["12345"],
@@ -132,45 +174,22 @@ def pulsar_decisions_config(config):
             "pulsar/query/decision/customer/12345/total",
             {"callback": None, "errback": None},
         ),
-        (
-            "get_decisions_records",
-            None,
-            "GET",
-            "pulsar/query/decisions/records",
-            {"callback": None, "errback": None},
-        ),
-        (
-            "get_decisions_results_record",
-            None,
-            "GET",
-            "pulsar/query/decisions/results/record",
-            {"callback": None, "errback": None},
-        ),
     ],
 )
-def test_rest_pulsar_decisions(
+def test_rest_pulsar_decisions_deprecated(
     pulsar_decisions_config, op, args, method, url, kwargs
 ):
-    """Test Pulsar Decisions REST API endpoints."""
+    """Test deprecated pulsar/query/decision/customer endpoints."""
     m = ns1.rest.pulsar_decisions.Decisions(pulsar_decisions_config)
     m._make_request = mock.MagicMock()
     operation = getattr(m, op)
-    if args is not None:
-        if (
-            isinstance(args, list)
-            and len(args) == 1
-            and isinstance(args[0], dict)
-        ):
-            # Handle kwargs case
-            operation(**args[0])
-        else:
-            # Handle positional args case
-            operation(*args)
-    else:
-        operation()
+    with pytest.warns(DeprecationWarning):
+        operation(*args)
     m._make_request.assert_called_once_with(method, url, **kwargs)
 
 
+
+
 def test_rest_pulsar_decisions_build_query_params(pulsar_decisions_config):
     """Test _build_query_params helper method."""
     m = ns1.rest.pulsar_decisions.Decisions(pulsar_decisions_config)