Progress

Author: adamtheturtle

src/vws/vws.py

@@ -490,3 +490,76 @@ def get_duplicate_targets(self, target_id: str) -> List[str]:
         )
 
         return list(response.json()['similar_targets'])
+
+    def update_target(
+        self,
+        target_id: str,
+        name: Optional[str] = None,
+        width: Optional[Union[int, float]] = None,
+        image: Optional[io.BytesIO] = None,
+        active_flag: Optional[bool] = None,
+        application_metadata: Optional[bytes] = None,
+    ) -> str:
+        """
+        Add a target to a Vuforia Web Services database.
+
+        See
+        https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API#How-To-Add-a-Target
+        for parameter details.
+
+        Args:
+            name: The name of the target.
+            width: The width of the target.
+            image: The image of the target.
+            active_flag: Whether or not the target is active for query.
+            application_metadata: The application metadata of the target.
+                This will be base64 encoded.
+
+        Returns:
+            The target ID of the new target.
+
+        Raises:
+            ~vws.exceptions.AuthenticationFailure: The secret key is not
+                correct.
+            ~vws.exceptions.BadImage: There is a problem with the given image.
+                For example, it must be a JPEG or PNG file in the grayscale or
+                RGB color space.
+            ~vws.exceptions.Fail: There was an error with the request. For
+                example, the given access key does not match a known database.
+            ~vws.exceptions.MetadataTooLarge: The given metadata is too large.
+                The maximum size is 1 MB of data when Base64 encoded.
+            ~vws.exceptions.ImageTooLarge: The given image is too large.
+            ~vws.exceptions.TargetNameExist: A target with the given ``name``
+                already exists.
+            ~vws.exceptions.ProjectInactive: The project is inactive.
+        """
+        if image is None:
+            image_data_encoded = None
+        else:
+            image_data = image.getvalue()
+            image_data_encoded = base64.b64encode(image_data).decode('ascii')
+
+        if application_metadata is None:
+            metadata_encoded = None
+        else:
+            metadata_encoded_str = base64.b64encode(application_metadata)
+            metadata_encoded = metadata_encoded_str.decode('ascii')
+
+        data = {
+            'name': name,
+            'width': width,
+            'image': image_data_encoded,
+            'active_flag': active_flag,
+            'application_metadata': metadata_encoded,
+        }
+
+        content = bytes(json.dumps(data), encoding='utf-8')
+
+        response = self._make_request(
+            method='PUT',
+            content=content,
+            request_path=f'/targets/{target_id}',
+            expected_result_code='Success',
+        )
+
+        return str(response.json()['target_id'])

tests/test_vws.py

@@ -444,6 +444,12 @@ def test_update_target(
         """
         It is possible to update a target.
         """
+        target_id = client.add_target(
+            name='x',
+            width=1,
+            image=high_quality_image,
+        )
+        client.update_target(target_id=target_id)
 
     def test_target_status_not_success(
         self,
@@ -453,6 +459,12 @@ def test_target_status_not_success(
         """
         It is possible to update a target.
         """
+        target_id = client.add_target(
+            name='x',
+            width=1,
+            image=high_quality_image,
+        )
+        client.update_target(target_id=target_id)
 
     def test_no_fields_given(
         self,
@@ -462,3 +474,9 @@ def test_no_fields_given(
         """
         It is possible to update a target.
         """
+        target_id = client.add_target(
+            name='x',
+            width=1,
+            image=high_quality_image,
+        )
+        client.update_target(target_id=target_id)