Merge pull request #31 from cern-vc/develop

🔖 Bump to v2.0.4

Author: SamuelGuillemet

.pylintrc

@@ -5,4 +5,5 @@ init-hook='import sys; sys.path.append(".")'
 disable=missing-module-docstring, missing-function-docstring, missing-class-docstring, too-few-public-methods, too-many-arguments, too-many-instance-attributes, too-many-locals, logging-fstring-interpolation, redefined-builtin,
 
 [FORMAT]
-good-names=i,j,k,ex,Run,_,pk,x,y,e,f
+good-names=i,j,k,ex,Run,_,pk,x,y,e,f
+max-line-length = 120

README.md

@@ -158,6 +158,7 @@ cern_ms_client = CERNMSApiClient.init_from_dotenv()
 4. update an event using zoom id
 5. delete an event using zoom id
 6. get the zoom id of an event
+7. get current event of a user
 
 You will find useful the `EventParameters` and `PartialEventParameters` classes, which will help you to create the events.
 

example/get_event_zoom_id.py

@@ -5,7 +5,12 @@
 
 from requests import HTTPError
 
-from ms_python_client import CERNMSApiClient, generate_error_log, setup_logs
+from ms_python_client import (
+    CERNMSApiClient,
+    NotFoundError,
+    generate_error_log,
+    setup_logs,
+)
 
 logger = setup_logs(log_level=logging.INFO)
 
@@ -26,3 +31,7 @@
 except HTTPError as e:
     print(json.dumps(generate_error_log(e), indent=4))
     sys.exit(1)
+
+except NotFoundError as e:
+    logger.error(e)
+    sys.exit(1)

ms_python_client/components/events/cern_events_component.py

@@ -40,6 +40,7 @@ def list_events(
         Args:
             user_id (str): The user id
             parameters (dict): Optional parameters for the request
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
@@ -55,17 +56,19 @@ def get_event_by_zoom_id(
         """Get an event of a user
 
         Args:
+            user_id (str): The user id
             zoom_id (str): The event id
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
         """
         parameters = {
             "$count": "true",
             "$filter": f"singleValueExtendedProperties/Any(ep: ep/id eq \
-                '{ZOOM_ID_EXTENDED_PROPERTY_ID}' and ep/value eq '{zoom_id}')",
+                        '{ZOOM_ID_EXTENDED_PROPERTY_ID}' and ep/value eq '{zoom_id}')",
             "$expand": f"singleValueExtendedProperties($filter=id eq \
-                '{ZOOM_ID_EXTENDED_PROPERTY_ID}')",
+                        '{ZOOM_ID_EXTENDED_PROPERTY_ID}')",
         }
         response = self.events_component.list_events(user_id, parameters, extra_headers)
 
@@ -91,20 +94,25 @@ def get_event_zoom_id(
         """Get the zoom id of an event of a user
 
         Args:
+            user_id (str): The user id
             event_id (str): The event id
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             str: The zoom id of the event
         """
         parameters = {
-            "$expand": f"singleValueExtendedProperties($filter=id eq \
-                '{ZOOM_ID_EXTENDED_PROPERTY_ID}')",
+            "$expand": f"singleValueExtendedProperties($filter=id eq '{ZOOM_ID_EXTENDED_PROPERTY_ID}')",
         }
         response = self.events_component.get_event(
             user_id, event_id, parameters, extra_headers
         )
 
-        return response["singleValueExtendedProperties"][0]["value"]
+        for property in response["singleValueExtendedProperties"]:
+            if property["id"] == ZOOM_ID_EXTENDED_PROPERTY_ID:
+                return property["value"]
+
+        raise NotFoundError(f"Zoom id not found for event {event_id}")
 
     def create_event(
         self,
@@ -117,7 +125,9 @@ def create_event(
 
         Args:
             user_id (str): The user id
+            zoom_id (str): The zoom id of the event
             event (EventParameters): The event data
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
@@ -136,7 +146,9 @@ def update_event_by_zoom_id(
 
         Args:
             user_id (str): The user id
+            zoom_id (str): The zoom id of the event
             event (EventParameters): The event parameters
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request
@@ -158,6 +170,7 @@ def delete_event_by_zoom_id(
         Args:
             user_id (str): The user id
             zoom_id (str): The event id
+            extra_headers (dict): Optional headers for the request
 
         Returns:
             dict: The response of the request

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ms-python-client"
-version = "2.0.3"
+version = "2.0.4"
 exclude = ["tests*", "example*", ".github*", ".git*", ".vscode*"]
 description = "This package is used to interact with the microsoft graph API"
 authors = ["Samuel Guillemet <samuel.guillemet@telecom-sudparis.eu>"]

pyproject.toml

@@ -7,6 +7,7 @@
     NotFoundError,
 )
 from ms_python_client.utils.event_generator import (
+    ZOOM_ID_EXTENDED_PROPERTY_ID,
     EventParameters,
     PartialEventParameters,
 )
@@ -154,7 +155,7 @@ def test_get_event_zoom_id(self):
                 "subject": "Test Event",
                 "singleValueExtendedProperties": [
                     {
-                        "id": "String {66f5a359-4659-4830-9070-00040ec6ac6e} Name ZoomId",
+                        "id": ZOOM_ID_EXTENDED_PROPERTY_ID,
                         "value": "1234567890",
                     }
                 ],
@@ -170,6 +171,29 @@ def test_get_event_zoom_id(self):
         assert zoom_id == "1234567890"
         assert responses.calls[0].request.headers["test"] == "test"
 
+    @responses.activate
+    def test_get_event_zoom_id_not_found(self):
+        responses.add(
+            responses.GET,
+            f"{TEST_API_ENDPOINT}/users/user_id/calendar/events/event_id",
+            json={
+                "id": "event_id",
+                "subject": "Test Event",
+                "singleValueExtendedProperties": [
+                    {
+                        "id": "Another id",
+                        "value": "Random value",
+                    }
+                ],
+            },
+            status=200,
+        )
+        headers = {
+            "test": "test",
+        }
+        with pytest.raises(NotFoundError):
+            self.events_component.get_event_zoom_id("user_id", "event_id", headers)
+
     @responses.activate
     def test_get_current_event(self):
         responses.add(