Merge branch 'feature/add-storage-volumes' into develop

Author: tamirse

.gitignore

@@ -114,6 +114,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+datacrunch_env/
 
 # Spyder project settings
 .spyderproject

CHANGELOG.rst

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+v1.0.0 (2021-06-16)
+-------------------
+
+* Added support for storage volumes
+* Breaking change: moved all constants under DataCrunchClient to DataCrunchClient.constants
+
 v0.1.0 (2021-01-05)
 -------------------
 

README.md

@@ -111,7 +111,8 @@ DataCrunch's Public API documentation [is available here](https://datacrunch.sto
 - Install Dependencies:
 
   ```bash
-  pip3 install -e
+  pip3 install -e .[test]
+  pip3 install -U pytest
   ```
 
 ### Running Tests
@@ -130,6 +131,18 @@ We use pytest for testing.
   pytest ./tests/unit_tests/test_file.py
   ```
 
+### Local Manual Testing
+
+```python
+from datacrunch.datacrunch import DataCrunchClient
+
+CLIENT_SECRET = 'secret'
+CLIENT_ID = 'Ibk5bdxV64lKAWOqYnvSi'
+
+# Create datcrunch client
+datacrunch = DataCrunchClient(CLIENT_ID, CLIENT_SECRET, base_url='http://localhost:3001/v1')
+```
+
 ### Generating the documentation
 
 ```bash

datacrunch/constants.py

@@ -9,6 +9,17 @@ def __init__(self):
         return
 
 
+class VolumeActions:
+    ATTACH = 'attach'
+    DETACH = 'detach'
+    RENAME = 'rename'
+    INCREASE_SIZE = 'increase-size'
+    DELETE = 'delete'
+
+    def __init__(self):
+        return
+
+
 class InstanceStatus:
     RUNNING = 'running'
     PROVISIONING = 'provisioning'
@@ -22,6 +33,26 @@ def __init__(self):
         return
 
 
+class VolumeStatus:
+    ORDERED = "ordered"
+    CREATING = "creating"
+    ATTACHED = "attached"
+    DETACHED = "detached"
+    DELETING = "deleting"
+    DELETED = "deleted"
+
+    def __init__(self):
+        return
+
+
+class VolumeTypes:
+    NVMe = "NVMe"
+    HDD = "HDD"
+
+    def __init__(self):
+        return
+
+
 class ErrorCodes:
     INVALID_REQUEST = "invalid_request"
     UNAUTHORIZED_REQUEST = "unauthorized_request"
@@ -33,3 +64,30 @@ class ErrorCodes:
 
     def __init__(self):
         return
+
+
+class Constants:
+    def __init__(self, base_url, version):
+        self.instance_actions: Actions = Actions()
+        """Available actions to perform on an instance"""
+
+        self.volume_actions: VolumeActions = VolumeActions()
+        """Available actions to perform on a volume"""
+
+        self.instance_status: InstanceStatus = InstanceStatus()
+        """Possible instance statuses"""
+
+        self.volume_status: VolumeStatus = VolumeStatus()
+        """Possible volume statuses"""
+
+        self.volume_types: VolumeTypes = VolumeTypes()
+        """Available volume types"""
+
+        self.error_codes: ErrorCodes = ErrorCodes()
+        """Available error codes"""
+
+        self.base_url: str = base_url
+        """DataCrunch's Public API URL"""
+
+        self.version: str = version
+        """Current SDK Version"""

datacrunch/datacrunch.py

@@ -6,7 +6,9 @@
 from datacrunch.instances.instances import InstancesService
 from datacrunch.ssh_keys.ssh_keys import SSHKeysService
 from datacrunch.startup_scripts.startup_scripts import StartupScriptsService
-from datacrunch.constants import Actions, InstanceStatus, ErrorCodes
+from datacrunch.volume_types.volume_types import VolumeTypesService
+from datacrunch.volumes.volumes import VolumesService
+from datacrunch.constants import Constants
 from datacrunch.__version__ import VERSION
 
 
@@ -25,26 +27,14 @@ def __init__(self, client_id: str, client_secret: str, base_url: str = "https://
         """
 
         # Constants
-        self.actions: Actions = Actions()
-        """Available actions to perform on an instance"""
-
-        self.instance_status: InstanceStatus = InstanceStatus()
-        """Possible instance statuses"""
-
-        self.error_codes: ErrorCodes = ErrorCodes()
-        """Available error codes"""
-
-        self.base_url: str = base_url
-        """DataCrunch's Public API URL"""
-
-        self.version: str = VERSION
-        """Current SDK Version"""
+        self.constants: Constants = Constants(base_url, VERSION)
+        """Constants"""
 
         # Services
         self._authentication: AuthenticationService = AuthenticationService(
-            client_id, client_secret, self.base_url)
+            client_id, client_secret, self.constants.base_url)
         self._http_client: HTTPClient = HTTPClient(
-            self._authentication, self.base_url)
+            self._authentication, self.constants.base_url)
 
         self.balance: BalanceService = BalanceService(self._http_client)
         """Balance service. Get client balance"""
@@ -65,3 +55,10 @@ def __init__(self, client_id: str, client_secret: str, base_url: str = "https://
         self.startup_scripts: StartupScriptsService = StartupScriptsService(
             self._http_client)
         """Startup Scripts service"""
+
+        self.volume_types: VolumeTypesService = VolumeTypesService(
+            self._http_client)
+        """Volume type service"""
+
+        self.volumes: VolumesService = VolumesService(self._http_client)
+        """Volume service. Create, attach, detach, get, rename, delete volumes"""

datacrunch/http_client/http_client.py

@@ -33,7 +33,7 @@ def __init__(self, auth_service, base_url: str) -> None:
         self._auth_service.authenticate()
 
     def post(self, url: str, json: dict = None, **kwargs) -> requests.Response:
-        """Sends a POST request. 
+        """Sends a POST request.
 
         A wrapper for the requests.post method.
 
@@ -59,16 +59,43 @@ def post(self, url: str, json: dict = None, **kwargs) -> requests.Response:
 
         return response
 
+    def put(self, url: str, json: dict = None, **kwargs) -> requests.Response:
+        """Sends a PUT request.
+
+        A wrapper for the requests.put method.
+
+        Builds the url, uses custom headers, refresh tokens if needed.
+
+        :param url: relative url of the API endpoint
+        :type url: str
+        :param json: A JSON serializable Python object to send in the body of the Request, defaults to None
+        :type json: dict, optional
+
+        :raises APIException: an api exception with message and error type code
+
+        :return: Response object
+        :rtype: requests.Response
+        """
+        url = self._add_base_url(url)
+        headers = self._generate_headers()
+
+        self._refresh_token_if_expired()
+
+        response = requests.put(url, json=json, headers=headers, **kwargs)
+        handle_error(response)
+
+        return response
+
     def get(self, url: str, params: dict = None, **kwargs) -> requests.Response:
-        """Sends a GET request. 
+        """Sends a GET request.
 
         A wrapper for the requests.get method.
 
         Builds the url, uses custom headers, refresh tokens if needed.
 
         :param url: relative url of the API endpoint
         :type url: str
-        :param params: Dictionary, list of tuples or bytes to send in the query string for the Request., defaults to None
+        :param params: Dictionary, list of tuples or bytes to send in the query string for the Request. defaults to None
         :type params: dict, optional
 
         :raises APIException: an api exception with message and error type code
@@ -87,7 +114,7 @@ def get(self, url: str, params: dict = None, **kwargs) -> requests.Response:
         return response
 
     def delete(self, url: str, json: dict = None, **kwargs) -> requests.Response:
-        """Sends a DELETE request. 
+        """Sends a DELETE request.
 
         A wrapper for the requests.delete method.
 
@@ -124,7 +151,7 @@ def _refresh_token_if_expired(self) -> None:
             # to to refresh. if refresh token has expired, reauthenticate
             try:
                 self._auth_service.refresh()
-            except:
+            except Exception:
                 self._auth_service.authenticate()
 
     def _generate_headers(self) -> dict:
@@ -141,7 +168,7 @@ def _generate_headers(self) -> dict:
         return headers
 
     def _generate_bearer_header(self) -> str:
-        """generate the authorization header Bearer string 
+        """generate the authorization header Bearer string
 
         :return: Authorization header Bearer string
         :rtype: str
@@ -162,7 +189,7 @@ def _generate_user_agent(self) -> str:
     def _add_base_url(self, url: str) -> str:
         """Adds the base url to the relative url
 
-        example: 
+        example:
         if the relative url is '/balance'
         and the base url is 'https://api.datacrunch.io/v1'
         then this method will return 'https://api.datacrunch.io/v1/balance'

datacrunch/instance_types/instance_types.py

@@ -13,6 +13,7 @@ def __init__(self,
                  cpu: dict,
                  gpu: dict,
                  memory: dict,
+                 gpu_memory: dict,
                  storage: dict) -> None:
         """Initialize an instance type object
 
@@ -29,7 +30,9 @@ def __init__(self,
         :param gpu: gpu details
         :type gpu: dict
         :param memory: memory details
-        :type storage: dict
+        :type memory: dict
+        :param gpu_memory: gpu memory details
+        :type gpu_memory: dict
         :param storage: storage details
         :type storage: dict
         """
@@ -40,6 +43,7 @@ def __init__(self,
         self._cpu = cpu
         self._gpu = gpu
         self._memory = memory
+        self._gpu_memory = gpu_memory
         self._storage = storage
 
     @property
@@ -105,6 +109,15 @@ def memory(self) -> dict:
         """
         return self._memory
 
+    @property
+    def gpu_memory(self) -> dict:
+        """Get the instance type gpu_memory details
+
+        :return: gpu_memory details
+        :rtype: dict
+        """
+        return self._gpu_memory
+
     @property
     def storage(self) -> dict:
         """Get the instance type storage details
@@ -114,6 +127,23 @@ def storage(self) -> dict:
         """
         return self._storage
 
+    def __str__(self) -> str:
+        """Prints the instance type
+
+        :return: instance type string representation
+        :rtype: str
+        """
+        return (f'id: {self._id}\n'
+                f'instance type: {self._instance_type}\n'
+                f'price_per_hour: ${self._price_per_hour}\n'
+                f'description: {self._description}\n'
+                f'cpu: {self._cpu}\n'
+                f'gpu: {self._gpu}\n'
+                f'memory :{self._memory}\n'
+                f'gpu_memory :{self._gpu_memory}\n'
+                f'storage :{self._storage}\n'
+                )
+
 
 class InstanceTypesService:
     """A service for interacting with the instance-types endpoint"""
@@ -136,6 +166,7 @@ def get(self) -> List[InstanceType]:
             cpu=instance_type['cpu'],
             gpu=instance_type['gpu'],
             memory=instance_type['memory'],
+            gpu_memory=instance_type['gpu_memory'],
             storage=instance_type['storage']
         ), instance_types))