Add get_config, create destination

Author: Quentame

synology_dsm/api/download_station/__init__.py

@@ -34,6 +34,10 @@ def get_info(self):
         """Return general informations about the Download Station instance."""
         return self._dsm.get(self.INFO_API_KEY, "GetInfo")
 
+    def get_config(self):
+        """Return configuration about the Download Station instance."""
+        return self._dsm.get(self.INFO_API_KEY, "GetConfig")
+
     # Downloads
     def get_all_tasks(self):
         """Return a list of tasks."""
@@ -43,26 +47,49 @@ def get_task(self, task_id):
         """Return task matching task_id."""
         return self._tasks_by_id[task_id]
 
-    def create(self, uri, unzip_password=None):
+    def create(self, uri, unzip_password=None, destination=None):
         """Create a new task (uri accepts HTTP/FTP/magnet/ED2K links)."""
-        return self._dsm.post(
+        res = self._dsm.post(
             self.TASK_API_KEY,
-            "create",
-            {"uri": ",".join(uri), "unzip_password": unzip_password},
+            "Create",
+            {
+                "uri": ",".join(uri) if isinstance(uri, list) else uri,
+                "unzip_password": unzip_password,
+                "destination": destination,
+            },
         )
+        self.update()
+        return res
 
     def pause(self, task_id):
         """Pause a download task."""
-        return self._dsm.get(self.TASK_API_KEY, "pause", {"id": ",".join(task_id)})
+        res = self._dsm.get(
+            self.TASK_API_KEY,
+            "Pause",
+            {"id": ",".join(task_id) if isinstance(task_id, list) else task_id},
+        )
+        self.update()
+        return res
 
     def resume(self, task_id):
         """Resume a paused download task."""
-        return self._dsm.get(self.TASK_API_KEY, "resume", {"id": ",".join(task_id)})
+        res = self._dsm.get(
+            self.TASK_API_KEY,
+            "Resume",
+            {"id": ",".join(task_id) if isinstance(task_id, list) else task_id},
+        )
+        self.update()
+        return res
 
     def delete(self, task_id, force_complete=False):
         """Delete a download task."""
-        return self._dsm.get(
+        res = self._dsm.get(
             self.TASK_API_KEY,
-            "delete",
-            {"id": ",".join(task_id), "force_complete": force_complete},
+            "Delete",
+            {
+                "id": ",".join(task_id) if isinstance(task_id, list) else task_id,
+                "force_complete": force_complete,
+            },
         )
+        self.update()
+        return res

synology_dsm/synology_dsm.py

@@ -185,11 +185,9 @@ def get(self, api, method, params=None, **kwargs):
         """Handles API GET request."""
         return self._request("GET", api, method, params, **kwargs)
 
-    def post(self, api, method, params=None, data=None, json=None, **kwargs):
+    def post(self, api, method, params=None, **kwargs):
         """Handles API POST request."""
-        return self._request(
-            "POST", api, method, params, data=data, json=json, **kwargs
-        )
+        return self._request("POST", api, method, params, **kwargs)
 
     def _request(
         self, request_method, api, method, params=None, retry_once=True, **kwargs
@@ -229,20 +227,6 @@ def _request(
 
         url = self._build_url(api)
 
-        # If the request method is POST and the API is SynoCoreShare the params
-        # to the request body. Used to support the weird Syno use of POST
-        # to choose what fields to return. See ./api/core/share.py
-        # for an example.
-        if request_method == "POST" and api == SynoCoreShare.API_KEY:
-            body = {}
-            body.update(params)
-            body.update(kwargs.pop("data"))
-            body["mimeType"] = "application/json"
-            # Request data via POST (excluding FileStation file uploads)
-            self._debuglog("POST BODY: " + str(body))
-
-            kwargs["data"] = body
-
         # Request data
         response = self._execute_request(request_method, url, params, **kwargs)
         self._debuglog("Request Method: " + request_method)
@@ -281,6 +265,13 @@ def _execute_request(self, method, url, params, **kwargs):
                     url, params=encoded_params, timeout=self._timeout, **kwargs
                 )
             elif method == "POST":
+                data = {}
+                data.update(params)
+                data.update(kwargs.pop("data", {}))
+                data["mimeType"] = "application/json"
+                kwargs["data"] = data
+                self._debuglog("POST data: " + str(data))
+
                 response = self._session.post(
                     url, params=params, timeout=self._timeout, **kwargs
                 )

tests/__init__.py

@@ -45,7 +45,8 @@
     DSM_6_SURVEILLANCE_STATION_CAMERA_LIST,
     DSM_6_SURVEILLANCE_STATION_HOME_MODE_GET_INFO,
     DSM_6_SURVEILLANCE_STATION_HOME_MODE_SWITCH,
-    DSM_6_DOWNLOAD_STATION_INFO,
+    DSM_6_DOWNLOAD_STATION_INFO_INFO,
+    DSM_6_DOWNLOAD_STATION_INFO_CONFIG,
     DSM_6_DOWNLOAD_STATION_TASK_LIST,
 )
 from .api_data.dsm_5 import (
@@ -217,7 +218,9 @@ def _execute_request(self, method, url, params, **kwargs):
 
             if SynoDownloadStation.TASK_API_KEY in url:
                 if "GetInfo" in url:
-                    return DSM_6_DOWNLOAD_STATION_INFO
+                    return DSM_6_DOWNLOAD_STATION_INFO_INFO
+                if "GetConfig" in url:
+                    return DSM_6_DOWNLOAD_STATION_INFO_CONFIG
                 if "List" in url:
                     return DSM_6_DOWNLOAD_STATION_TASK_LIST
 

tests/api_data/dsm_6/__init__.py

@@ -13,7 +13,10 @@
     DSM_6_CORE_SECURITY,
     DSM_6_CORE_SECURITY_UPDATE_OUTOFDATE,
 )
-from .download_station.const_6_download_station_info import DSM_6_DOWNLOAD_STATION_INFO
+from .download_station.const_6_download_station_info import (
+    DSM_6_DOWNLOAD_STATION_INFO_INFO,
+    DSM_6_DOWNLOAD_STATION_INFO_CONFIG,
+)
 from .download_station.const_6_download_station_task import (
     DSM_6_DOWNLOAD_STATION_TASK_LIST,
 )

tests/api_data/dsm_6/download_station/const_6_download_station_info.py

@@ -1,7 +1,24 @@
 # -*- coding: utf-8 -*-
 """DSM 6 SYNO.DownloadStation.Info data."""
 
-DSM_6_DOWNLOAD_STATION_INFO = {
+DSM_6_DOWNLOAD_STATION_INFO_INFO = {
     "data": {"is_manager": True, "version": 3543, "version_string": "3.8-3543"},
     "success": True,
 }
+
+DSM_6_DOWNLOAD_STATION_INFO_CONFIG = {
+    "data": {
+        "bt_max_download": 0,
+        "bt_max_upload": 800,
+        "default_destination": "downloads",
+        "emule_default_destination": None,
+        "emule_enabled": False,
+        "emule_max_download": 0,
+        "emule_max_upload": 20,
+        "ftp_max_download": 0,
+        "http_max_download": 0,
+        "nzb_max_download": 0,
+        "unzip_service_enabled": False,
+    },
+    "success": True,
+}

tests/test_synology_dsm.py

@@ -704,6 +704,7 @@ def test_download_station(self):
         assert not self.api.download_station.get_all_tasks()
 
         assert self.api.download_station.get_info()
+        assert self.api.download_station.get_config()
         self.api.download_station.update()
         assert self.api.download_station.get_all_tasks()
         assert len(self.api.download_station.get_all_tasks()) == 8