fix: improvement PR comments

Author: Giriharan219

examples/feeds/create_feed.py

@@ -27,10 +27,10 @@
         platform=PLATFORM,
         workspace=workspace_id,
     )
-    created_feed_name = client.create_feed(feed=feed_request).name
+    feed_details = client.create_feed(feed=feed_request)
 
     print("Feed created Successfully.")
-    print(f"Created feed name: {created_feed_name}")
+    print(f"Created feed details: {feed_details}")
 
 except ApiException as exp:
     print(exp)

examples/feeds/delete_feed.py

@@ -2,20 +2,31 @@
 
 from nisystemlink.clients.core import ApiException, HttpConfiguration
 from nisystemlink.clients.feeds._feeds_client import FeedsClient
+from nisystemlink.clients.feeds.models import Platform
+from nisystemlink.clients.feeds.utilities import get_feed_by_name
 
 
-FEED_ID = ""
+FEED_NAME = "EXAMPLE FEED"  # Name of the feed.
+PLATFORM = Platform.WINDOWS
 
 server_url = ""  # SystemLink API URL
 server_api_key = ""  # SystemLink API key
+workspace_id = (
+    None  # None uses Default workspace. Replace with Systemlink workspace id.
+)
 
 # Please provide the valid API key and API URL for client intialization.
 client = FeedsClient(HttpConfiguration(api_key=server_api_key, server_uri=server_url))
 
 # Deleting Feed.
 try:
-    created_feed_name = client.delete_feed(id=FEED_ID)
-    print("Feed deleted successfully.")
+    # To query available feeds.
+    query_feeds_response = client.query_feeds(platform=PLATFORM, workspace=workspace_id)
+    feed_details = get_feed_by_name(feeds=query_feeds_response, name=FEED_NAME)
+
+    if feed_details and feed_details.id:
+        created_feed_name = client.delete_feed(id=feed_details.id)
+        print("Feed deleted successfully.")
 
 except ApiException as exp:
     print(exp)

examples/feeds/query_and_upload_feeds.py

@@ -3,7 +3,7 @@
 from nisystemlink.clients.core import ApiException, HttpConfiguration
 from nisystemlink.clients.feeds._feeds_client import FeedsClient
 from nisystemlink.clients.feeds.models import Platform
-from nisystemlink.clients.feeds.utilities import get_feed_id
+from nisystemlink.clients.feeds.utilities import get_feed_by_name
 
 # Constant
 FEED_NAME = "EXAMPLE FEED"
@@ -14,26 +14,24 @@
 
 server_url = ""  # SystemLink API URL
 server_api_key = ""  # SystemLink API key
-workspace_id = ""  # Systemlink workspace id
+workspace_id = (
+    None  # None uses Default workspace. Replace with Systemlink workspace id.
+)
 
 # Please provide the valid API key and API URL for client intialization.
 client = FeedsClient(HttpConfiguration(api_key=server_api_key, server_uri=server_url))
 
 # To upload a package to feed.
 try:
     # To query available feeds.
-    query_feeds_response = client.query_feeds(
-        platform=PLATFORM,
-        workspace=workspace_id,
-    )
+    query_feeds_response = client.query_feeds(platform=PLATFORM, workspace=workspace_id)
+    feed_details = get_feed_by_name(feeds=query_feeds_response, name=FEED_NAME)
 
-    feed_id = get_feed_id(feeds_details=query_feeds_response.feeds, feed_name=FEED_NAME)
-
-    if feed_id:
+    if feed_details and feed_details.id:
         upload_package = client.upload_package(
-            feed_id=feed_id,
+            feed_id=feed_details.id,
             overwrite=True,
-            package=open(PACKAGE_PATH, "rb"),
+            package_file_path=PACKAGE_PATH,
         )
         print("Package uploaded sucessfully.")
 

nisystemlink/clients/feeds/_feeds_client.py

@@ -1,6 +1,6 @@
 """Implementation of SystemLink Feeds Client."""
 
-from typing import BinaryIO, Optional
+from typing import BinaryIO, List, Optional
 
 from nisystemlink.clients import core
 from nisystemlink.clients.core._uplink._base_client import BaseClient
@@ -63,7 +63,7 @@ def query_feeds(
         self,
         platform: Optional[models.Platform] = None,
         workspace: Optional[str] = None,
-    ) -> models.QueryFeedsResponse:
+    ) -> List[models.Feed]:
         """Get a set of feeds based on the provided `platform` and `workspace`.
 
         Args:
@@ -72,13 +72,13 @@ def query_feeds(
             workspace (Optional[str]): Workspace id. Defaults to None.
 
         Returns:
-            models.QueryFeedsResponse: List of feeds.
+            List[models.Feed]: List of feeds.
         """
         platform_by_str = platform.value if platform is not None else None
         response = self.__query_feeds(
             platform=platform_by_str,
             workspace=workspace,
-        )
+        ).feeds
 
         return response
 
@@ -106,6 +106,31 @@ def __upload_package(
         ...
 
     def upload_package(
+        self,
+        feed_id: str,
+        package_file_path: str,
+        overwrite: bool = False,
+    ) -> models.Package:
+        """Upload package to SystemLink feed.
+
+        Args:
+            feed_id (str): ID of the feed.
+            package_file_path (str): File path of the package to be uploaded.
+            overwrite (bool): Set to True, to overwrite the package if it already exists.\
+Defaults to False.
+
+        Returns:
+            models.Package: Uploaded package information.
+        """
+        response = self.__upload_package(
+            feed_id=feed_id,
+            overwrite=overwrite,
+            package=open(package_file_path, "rb"),
+        )
+
+        return response
+
+    def upload_package_content(
         self,
         feed_id: str,
         package: BinaryIO,
@@ -120,7 +145,7 @@ def upload_package(
 Defaults to False.
 
         Returns:
-            models.Package: Uploaded package response information.
+            models.Package: Uploaded package information.
         """
         response = self.__upload_package(
             feed_id=feed_id,

nisystemlink/clients/feeds/utilities.py

@@ -1,24 +1,24 @@
 """Utilities for FeedsClient."""
 
-from typing import List, Union
+from typing import List, Optional
 
 from nisystemlink.clients.feeds.models import Feed
 
 
-def get_feed_id(
-    feeds_details: List[Feed],
-    feed_name: str,
-) -> Union[str, None]:
+def get_feed_by_name(
+    feeds: List[Feed],
+    name: str,
+) -> Optional[Feed]:
     """Get feed id from the list of feed details using `feed_name`.
 
     Args:
-        feeds_details (List[Feed]): List of feed details.
+        feeds (List[Feed]): List of feed details.
         feed_name (str): Feed name.
 
     Returns:
-        Union[str, None]: Feed ID of the `feed_name`.
+        Optional[Feed]: Feed information.
     """
-    for feed in feeds_details:
-        if feed.name == feed_name and feed.id:
-            return feed.id
+    for feed in feeds:
+        if feed.name == name and feed.id:
+            return feed
     return None

tests/integration/feeds/test_feeds_client.py

@@ -181,7 +181,6 @@ def test__upload_package__succeeds(
         client: FeedsClient,
         create_feed: Callable,
         create_feed_request: Callable,
-        binary_pkg_file_data: BinaryIO,
         get_feed_name: Callable,
     ):
         """Test the case of upload package to feed."""
@@ -193,21 +192,44 @@ def test__upload_package__succeeds(
         create_feed_resp = create_feed(create_feed_request_body)
 
         upload_pacakge_rsp = client.upload_package(
+            package_file_path=PACKAGE_PATH,
+            feed_id=create_feed_resp.id,
+            overwrite=True,
+        )
+        assert upload_pacakge_rsp is not None
+
+    def test__upload_package_content__succeeds(
+        self,
+        client: FeedsClient,
+        create_feed: Callable,
+        create_feed_request: Callable,
+        binary_pkg_file_data: BinaryIO,
+        get_feed_name: Callable,
+    ):
+        """Test the case of upload package to feed."""
+        create_feed_request_body = create_feed_request(
+            feed_name=get_feed_name(),
+            description=FEED_DESCRIPTION,
+            platform=Platform.WINDOWS,
+        )
+        create_feed_resp = create_feed(create_feed_request_body)
+
+        upload_pacakge_rsp = client.upload_package_content(
             package=binary_pkg_file_data,
             feed_id=create_feed_resp.id,
             overwrite=True,
         )
         assert upload_pacakge_rsp is not None
 
-    def test__upload_package__invalid_feed_id_raises(
+    def test__upload_package_content__invalid_feed_id_raises(
         self,
         client: FeedsClient,
         binary_pkg_file_data: BinaryIO,
         invalid_id: str,
     ):
         """Test the case of uploading package to Invalid feed."""
         with pytest.raises(ApiException, match="FeedNotFoundError"):
-            client.upload_package(
+            client.upload_package_content(
                 package=binary_pkg_file_data,
                 feed_id=invalid_id,
             )