Add enhydris_api_client.put_timeseries() (fixes DEV-130)

Author: aptiko

docs/enhydris_api_client.rst

@@ -67,11 +67,13 @@ Reference
    .. method:: list_timeseries(self, station_id, timeseries_group_id)
                get_timeseries(self, station_id, timeseries_group_id, timeseries_id)
                post_timeseries(self, station_id, timeseries_group_id, data)
+               put_timeseries(self, station_id, timeseries_group_id, timeseries_id, data)
                delete_timeseries(self, station_id, timeseries_group_id, timeseries_id)
 
-      Methods that create, retrieve or delete time series. Similar to
-      the ones for station. :meth:`~EnhydrisApiClient.list_timeseries`
-      returns a list of dictionaries.
+      Methods that create, retrieve, update or delete time series.
+      Similar to the ones for station.
+      :meth:`~EnhydrisApiClient.list_timeseries` returns a list of
+      dictionaries.
 
    .. method:: read_tsdata(self, station_id, timeseries_group_id, timeseries_id, start_date=None, end_date=None, timezone=None)
               .post_tsdata(self, station_id, timeseries_group_id, timeseries_id, ts)

src/enhydris_api_client/__init__.py

@@ -244,6 +244,23 @@ def post_timeseries(
         self.check_response()
         return self.response.json()["id"]
 
+    def put_timeseries(
+        self,
+        station_id: int,
+        timeseries_group_id: int,
+        timeseries_id: int,
+        data: JSONDict,
+    ) -> None:
+        self.response = self.session.put(
+            urljoin(
+                self.base_url,
+                f"api/stations/{station_id}/timeseriesgroups/{timeseries_group_id}/"
+                f"timeseries/{timeseries_id}/",
+            ),
+            data=data,
+        )
+        self.check_response()
+
     def delete_timeseries(
         self, station_id: int, timeseries_group_id: int, timeseries_id: int
     ) -> None:

tests/enhydris_api_client/test_timeseries.py

@@ -87,6 +87,25 @@ def test_returns_id(self) -> None:
         self.assertEqual(self.data, 43)
 
 
+class PutTimeseriesTestCase(TestCase):
+    def setUp(self) -> None:
+        self.session_patcher = mock_session(
+            **{"post.return_value.json.return_value": {"id": 43}}
+        )
+        self.mock_requests_session = self.session_patcher.start()
+        self.client = EnhydrisApiClient("https://mydomain.com")
+        self.data = self.client.put_timeseries(41, 42, 43, data={"location": "Syria"})
+
+    def tearDown(self) -> None:
+        self.session_patcher.stop()
+
+    def test_makes_request(self) -> None:
+        self.mock_requests_session.return_value.put.assert_called_once_with(
+            "https://mydomain.com/api/stations/41/timeseriesgroups/42/timeseries/43/",
+            data={"location": "Syria"},
+        )
+
+
 class FailedPostTimeseriesTestCase(TestCase):
     @mock_session(**{"post.return_value.status_code": 404})
     def test_raises_exception_on_error(self, m: mock.MagicMock) -> None: