enhanced education plugin methods

Author: Benoit Crickboom

orthanc_api_client/http_client.py

@@ -116,6 +116,7 @@ def _raise_or_retry_on_errors(self, response, url) -> bool:
         Will return False if everything was ok (HTTP 200 code).
         '''
         if response.status_code >= 200 and response.status_code < 300:
+            self._token_updated = False
             return False
 
         if response.status_code == 401:

orthanc_api_client/resources/education_images.py

@@ -1,7 +1,7 @@
 import json
 import typing
 from enum import StrEnum
-from typing import Dict
+from typing import Dict, List
 import uuid
 from .resources import Resources
 from ..education_image import Image
@@ -17,6 +17,18 @@ class Images(Resources):
     def __init__(self, api_client: 'OrthancApiClient'):
         super().__init__(api_client=api_client, url_segment='/education/api')
 
+    def get(self, resource_id) -> Image:
+        payload = {
+            "resource_id": resource_id,
+            "project": "_all-studies"
+        }
+        r = self._api_client.post(
+            endpoint=f"{self._url_segment}/list-images",
+            json=payload
+        )
+        print(r.content)
+        return Image.from_json(json.loads(r.content))
+
     def get_images_by_project(self, project_id: str) -> typing.List[Image]:
         payload = {
             "project": project_id
@@ -33,6 +45,18 @@ def get_series_without_a_project(self) -> typing.List[Image]:
     def get_studies_without_a_project(self) -> typing.List[Image]:
         return self.get_images_by_project(project_id="_unused-studies")
 
+    def get_all_images(self) -> typing.List[Image]:
+        return self.get_images_by_project(project_id="_all-studies")
+
+    def delete(self, resource_id):
+        if self._api_client.studies.get(resource_id) is not None:
+            self._api_client.studies.delete(resource_id)
+        elif self._api_client.series.get(resource_id) is not None:
+            self._api_client.series.delete(resource_id)
+
+    def delete_all(self):
+        self._api_client.delete_all_content()
+
     def link_image_to_project(self, resource_id: str, project_id: str, resource_level: str="Series"):
         """
         resource_level: 'Study' or 'Series'

orthanc_api_client/resources/education_projects.py

@@ -22,13 +22,34 @@ def create(self, name: str, description: str) :
             endpoint=f"{self._url_segment}/",
             json=payload
         )
+        r.raise_for_status()
+
         return r.json()['id']
 
+    def delete(self, project_id: str):
+        self._api_client.delete(f"{self._url_segment}/{project_id}")
+
+
+    def delete_all(self):
+        prjs = self.get_all()
+        for prj in prjs:
+            self.delete(prj.id)
+
     def get(self, project_id: str) -> Project:
         r = self._api_client.get(f"{self._url_segment}/{project_id}")
+        r.raise_for_status()
+
         return Project.from_json(self._api_client, json.loads(r.content))
 
     def get_all(self) -> typing.List[Project]:
         r = self._api_client.get(f"{self._url_segment}/")
+        r.raise_for_status()
+
         return [Project.from_json(self._api_client, prj_json) for prj_json in json.loads(r.content)]
 
+    def set_viewer(self, project_id: str, viewer: str):
+        if viewer not in [ 'stone', 'volview', 'wsi', 'ohif-basic', 'ohif-volume', 'ohif-tumor', 'ohif-segmentation' ]:
+            raise Exception(f'viewer {viewer} not supported')
+
+        r=self._api_client.put(f"{self._url_segment}/{project_id}/primary-viewer", data=json.dumps(viewer))
+        r.raise_for_status()

release-notes.md

@@ -1,4 +1,4 @@
-V 0.25.0
+V 0.25.1
 ========
 
 - Added components for the education plugin.

setup.py

@@ -28,7 +28,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version='0.25.0',  # Required
+    version='0.25.1',  # Required
 
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:

tests/test_api_client.py

@@ -1896,6 +1896,7 @@ def test_metrics(self):
 
     def test_education_create_project(self):
         self.od.delete_all_content()
+        self.od.projects.delete_all()
 
         # prj creation
         id = self.od.projects.create("prj-name", "prj-desc")
@@ -1909,8 +1910,32 @@ def test_education_create_project(self):
         all = self.od.projects.get_all()
         self.assertEqual(len(all), 1)
 
+        # check the project deletion
+        self.od.projects.delete(id)
+        all = self.od.projects.get_all()
+        self.assertEqual(len(all), 0)
+
+    def test_education_delete_all_projects(self):
+        self.od.delete_all_content()
+        self.od.projects.delete_all()
+
+        # prj creation
+        self.od.projects.create("prj-name", "prj-desc")
+        self.od.projects.create("prj-name2", "prj-desc2")
+
+        # check that there are 2 projects
+        all = self.od.projects.get_all()
+        self.assertEqual(len(all), 2)
+
+        # check the project deletion
+        self.od.projects.delete_all()
+        all = self.od.projects.get_all()
+        self.assertEqual(len(all), 0)
+
     def test_education_upload(self):
         self.od.delete_all_content()
+        self.od.images.delete_all()
+        self.od.projects.delete_all()
 
         # upload 1 image
         upload_id = self.od.images.upload_and_dicomize(file_path=here / "stimuli/education.jpeg", description="upload-desc")
@@ -1953,6 +1978,36 @@ def test_education_change_title(self):
         images = self.od.images.get_series_without_a_project()
         self.assertEqual(images[0].title, "new-title")
 
+    def test_education_set_viewer(self):
+        self.od.delete_all_content()
+        self.od.projects.delete_all()
+
+        # prj creation
+        id = self.od.projects.create("prj-name", "prj-desc")
+        prj = self.od.projects.get(id)
+
+        self.assertEqual(prj.primary_viewer.description, "stone")
+
+        self.od.projects.set_viewer(id, "volview")
+        prj = self.od.projects.get(id)
+        self.assertEqual(prj.primary_viewer.description, "volview")
+
+    def test_token_renewal(self):
+        self.od.delete_all_content()
+        self.od.projects.delete_all()
+
+        # put an expired token in the client
+        expired_token = "ZeyJhbGciOiJSUzI1NiIsImtpZCI6IjNhMjQzYWRhLTVhM2MtNDA0Mi04NmQ5LWFhZjBjM2ZiNzM3MCIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3ODI0ODYyNDgsImlhdCI6MTc4MjQ4MjY0OCwiaWQiOiJ0ZXN0IiwiaW5zdHJ1Y3Rvcl9vZiI6W10sImxlYXJuZXJfb2YiOltdLCJyb2xlIjoiYWRtaW4ifQ.L2DYuuNtHXnnhb6D7guT9t36b4pK-MTvk74UyoRsfHSqzFaikPEJZz6oM2Y2xkTqqwm_oOcjX_P683-s_MFAVycP-G3Fijfcz-hri-1_ewIMPd2mWGqg-jaXFDJBKD5Wo-Ws8rmWPweCu1VQ89dp6sYvPLKuJXCwaug5VFmGlP86lH6Cj4XuvFH9ncV1ynQzakEUAmoahL9H56QrrpXlD8J9TuoScPLqpxtAydFccL8r10Ysiyr-QWB4123BJUGo9jlpxYS29tpiswLbj94L8RX4vU5kjJu1ehn9jNJzNulPyarpaPHlBULJcQn8jyezqqQUuP1UbF5t09qszIZkEw"
+        expired_headers = {
+            "Authorization": f"Bearer {expired_token}"
+        }
+        self.od._http_session.headers.update(expired_headers)
+
+        id = self.od.projects.create("prj-name", "prj-desc")
+        prj = self.od.projects.get(id)
+
+        # check prj creation
+        self.assertEqual(prj.name, "prj-name")
 
     def test_pool_maxsize(self):