feat: Spec client | Add Get Spec API (#147)

Signed-off-by: Vishnu Govindaraj <[email protected]>
Co-authored-by: Vishnu Govindaraj <[email protected]>

Author: vishnu-ni

docs/api_reference/spec.rst

@@ -12,6 +12,7 @@ nisystemlink.clients.spec
    .. automethod:: delete_specs
    .. automethod:: query_specs
    .. automethod:: update_specs
+   .. automethod:: get_spec
 
 .. automodule:: nisystemlink.clients.spec.models
    :members:

docs/getting_started.rst

@@ -170,12 +170,14 @@ With a :class:`.SpecClient` object, you can:
 
 * Query for specifications on any fields using DynamicLinq syntax.
 
+* Get a specification using an Id.
+
 Examples
 ~~~~~~~~
 
-Create and Query Specifications
+Create, Get and Query Specifications
 
-.. literalinclude:: ../examples/spec/query_specs.py
+.. literalinclude:: ../examples/spec/get_and_query_specs.py
    :language: python
    :linenos:
 

examples/spec/query_specs.py examples/spec/get_and_query_specs.pyexamples/spec/query_specs.py renamed to examples/spec/get_and_query_specs.py

@@ -68,7 +68,11 @@
 ]
 
 # Create the specs on the server
-client.create_specs(CreateSpecificationsRequest(specs=spec_requests))
+created_response = client.create_specs(CreateSpecificationsRequest(specs=spec_requests))
+
+# use get for first spec created
+if created_response.created_specs and len(created_response.created_specs) > 0:
+    created_spec = client.get_spec(created_response.created_specs[0].id)
 
 # You can query specs based on any field using DynamicLinq syntax.
 # These are just some representative examples.

nisystemlink/clients/spec/_spec_client.py

@@ -96,6 +96,22 @@ def query_specs(
         """
         ...
 
+    @get("specs/{id}")
+    def get_spec(self, id: str) -> models.Specification:
+        """Retrieves a single spec by id.
+
+        Args:
+            id (str): Unique ID of a specification.
+
+        Returns:
+            The single spec matching `id`
+
+        Raises:
+            ApiException: if unable to communicate with the `nispec` service or if there are invalid
+            arguments.
+        """
+        ...
+
     @post("update-specs")
     def update_specs(
         self, specs: models.UpdateSpecificationsRequest

tests/integration/spec/test_spec.py

@@ -2,6 +2,7 @@
 from typing import List
 
 import pytest
+from nisystemlink.clients.core._api_exception import ApiException
 from nisystemlink.clients.core._http_configuration import HttpConfiguration
 from nisystemlink.clients.spec import SpecClient
 from nisystemlink.clients.spec.models import (
@@ -237,6 +238,39 @@ def test__update_single_same_version__version_updates(
         updated_spec = update_response.updated_specs[0]
         assert updated_spec.version == 1
 
+    def test__get_spec_by_id__spec_matches_expected(
+        self, client: SpecClient, create_specs, product
+    ):
+        productId = product
+        spec = CreateSpecificationsRequestObject(
+            product_id=productId,
+            spec_id="spec1",
+            type=SpecificationType.FUNCTIONAL,
+            keywords=["work", "reviewed"],
+            category="Parametric Specs",
+            block="newBlock",
+        )
+
+        response = create_specs(CreateSpecificationsRequest(specs=[spec]))
+
+        assert response is not None
+        assert len(response.created_specs) == 1
+        created_spec = response.created_specs[0]
+
+        get_spec_response = client.get_spec(created_spec.id)
+
+        assert get_spec_response is not None
+        assert get_spec_response.id == created_spec.id
+        assert get_spec_response.product_id == productId
+
+    def test__get_non_existant_spec_by_id__get_spec_fails(self, client: SpecClient):
+        non_existant_spec_id = "10"
+
+        with pytest.raises(ApiException) as exception_info:
+            client.get_spec(non_existant_spec_id)
+
+        assert exception_info.value.http_status_code == 404
+
     def test__query_product__all_returned(
         self, client: SpecClient, create_specs, create_specs_for_query, product
     ):