feat(long-term): add OpenAPI long-term periods service

Co-authored-by: imagene-shahar <imagene-shahar@users.noreply.github.com>

Author: cursoragent

datacrunch_compat/datacrunch/__init__.py

@@ -15,6 +15,7 @@
     images,
     instance_types,
     instances,
+    long_term,
     locations,
     ssh_keys,
     startup_scripts,
@@ -41,6 +42,7 @@
     'images',
     'instance_types',
     'instances',
+    'long_term',
     'locations',
     'ssh_keys',
     'startup_scripts',

datacrunch_compat/datacrunch/datacrunch.py

@@ -12,6 +12,7 @@
 from verda.images import ImagesService
 from verda.instance_types import InstanceTypesService
 from verda.instances import InstancesService
+from verda.long_term import LongTermService
 from verda.locations import LocationsService
 from verda.ssh_keys import SSHKeysService
 from verda.startup_scripts import StartupScriptsService
@@ -31,6 +32,7 @@
     'ImagesService',
     'InstanceTypesService',
     'InstancesService',
+    'LongTermService',
     'LocationsService',
     'SSHKeysService',
     'StartupScriptsService',

docs/source/api/services/long_term.rst

@@ -0,0 +1,8 @@
+Long Term
+=========
+
+.. autoclass:: verda.long_term.LongTermService
+   :members:
+
+.. autoclass:: verda.long_term.LongTermPeriod
+   :members:

tests/unit_tests/long_term/test_long_term.py

@@ -0,0 +1,58 @@
+import responses  # https://github.com/getsentry/responses
+
+from verda.long_term import LongTermPeriod, LongTermService
+
+PERIODS_PAYLOAD = [
+    {
+        'code': '1-month',
+        'name': '1 Month',
+        'is_enabled': True,
+        'unit_name': 'month',
+        'unit_value': 1,
+        'discount_percentage': 5,
+    }
+]
+
+
+class TestLongTermService:
+    @responses.activate
+    def test_get_periods(self, http_client):
+        endpoint = http_client._base_url + '/long-term/periods'
+        responses.add(responses.GET, endpoint, json=PERIODS_PAYLOAD, status=200)
+
+        service = LongTermService(http_client)
+
+        periods = service.get()
+
+        assert isinstance(periods, list)
+        assert len(periods) == 1
+        assert isinstance(periods[0], LongTermPeriod)
+        assert periods[0].code == '1-month'
+        assert periods[0].discount_percentage == 5
+        assert responses.assert_call_count(endpoint, 1) is True
+
+    @responses.activate
+    def test_get_instance_periods(self, http_client):
+        endpoint = http_client._base_url + '/long-term/periods/instances'
+        responses.add(responses.GET, endpoint, json=PERIODS_PAYLOAD, status=200)
+
+        service = LongTermService(http_client)
+
+        periods = service.get_instances()
+
+        assert len(periods) == 1
+        assert periods[0].unit_name == 'month'
+        assert responses.assert_call_count(endpoint, 1) is True
+
+    @responses.activate
+    def test_get_cluster_periods(self, http_client):
+        endpoint = http_client._base_url + '/long-term/periods/clusters'
+        responses.add(responses.GET, endpoint, json=PERIODS_PAYLOAD, status=200)
+
+        service = LongTermService(http_client)
+
+        periods = service.get_clusters()
+
+        assert len(periods) == 1
+        assert periods[0].is_enabled is True
+        assert responses.assert_call_count(endpoint, 1) is True

tests/unit_tests/test_client.py

@@ -28,6 +28,7 @@ def test_client(self):
         assert client.constants.base_url == BASE_URL
         assert hasattr(client, 'container_types')
         assert hasattr(client, 'cluster_types')
+        assert hasattr(client, 'long_term')
 
     @responses.activate
     def test_client_with_default_base_url(self):

verda/_verda.py

@@ -10,6 +10,7 @@
 from verda.images import ImagesService
 from verda.instance_types import InstanceTypesService
 from verda.instances import InstancesService
+from verda.long_term import LongTermService
 from verda.locations import LocationsService
 from verda.ssh_keys import SSHKeysService
 from verda.startup_scripts import StartupScriptsService
@@ -91,5 +92,8 @@ def __init__(
         self.cluster_types: ClusterTypesService = ClusterTypesService(self._http_client)
         """Cluster types service. Get available cluster SKUs"""
 
+        self.long_term: LongTermService = LongTermService(self._http_client)
+        """Long-term service. Get available long-term pricing periods"""
+
 
 __all__ = ['VerdaClient']

verda/long_term/__init__.py

@@ -0,0 +1,3 @@
+from verda.long_term._long_term import LongTermPeriod, LongTermService
+
+__all__ = ['LongTermPeriod', 'LongTermService']

verda/long_term/_long_term.py

@@ -0,0 +1,40 @@
+from dataclasses import dataclass
+
+from dataclasses_json import dataclass_json
+
+LONG_TERM_PERIODS_ENDPOINT = '/long-term/periods'
+
+
+@dataclass_json
+@dataclass
+class LongTermPeriod:
+    """Long-term pricing period returned by the public API."""
+
+    code: str
+    name: str
+    is_enabled: bool
+    unit_name: str
+    unit_value: float
+    discount_percentage: float
+
+
+class LongTermService:
+    """Service for interacting with long-term pricing periods."""
+
+    def __init__(self, http_client) -> None:
+        self._http_client = http_client
+
+    def get(self) -> list[LongTermPeriod]:
+        """Return all long-term periods."""
+        periods = self._http_client.get(LONG_TERM_PERIODS_ENDPOINT).json()
+        return [LongTermPeriod.from_dict(period) for period in periods]
+
+    def get_instances(self) -> list[LongTermPeriod]:
+        """Return long-term periods available for instances."""
+        periods = self._http_client.get(f'{LONG_TERM_PERIODS_ENDPOINT}/instances').json()
+        return [LongTermPeriod.from_dict(period) for period in periods]
+
+    def get_clusters(self) -> list[LongTermPeriod]:
+        """Return long-term periods available for clusters."""
+        periods = self._http_client.get(f'{LONG_TERM_PERIODS_ENDPOINT}/clusters').json()
+        return [LongTermPeriod.from_dict(period) for period in periods]