Zendesk Deps Update (#418)

* initial changes for zendesk deps

* update versions and changelog

---------

Co-authored-by: nikpocuca <[email protected]>

Author: nikpocuca

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.5.12-dev0
+
+### Fixes
+
+Fixed zendesk dependency warning
+
 ## 0.5.11
 
 ### Features 

requirements/connectors/zendesk.in

@@ -0,0 +1,5 @@
+-c ../common/constraints.txt
+
+httpx
+aiofiles
+bs4

requirements/connectors/zendesk.txt

@@ -0,0 +1,34 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile ./connectors/zendesk.in --output-file ./connectors/zendesk.txt --no-strip-extras --python-version 3.9
+aiofiles==24.1.0
+    # via -r ./connectors/zendesk.in
+anyio==4.8.0
+    # via httpx
+beautifulsoup4==4.13.3
+    # via bs4
+bs4==0.0.2
+    # via -r ./connectors/zendesk.in
+certifi==2025.1.31
+    # via
+    #   httpcore
+    #   httpx
+exceptiongroup==1.2.2
+    # via anyio
+h11==0.14.0
+    # via httpcore
+httpcore==1.0.7
+    # via httpx
+httpx==0.28.1
+    # via -r ./connectors/zendesk.in
+idna==3.10
+    # via
+    #   anyio
+    #   httpx
+sniffio==1.3.1
+    # via anyio
+soupsieve==2.6
+    # via beautifulsoup4
+typing-extensions==4.12.2
+    # via
+    #   anyio
+    #   beautifulsoup4

setup.py

@@ -133,6 +133,7 @@ def load_requirements(file: Union[str, Path]) -> List[str]:
     "singlestore": load_requirements("requirements/connectors/singlestore.in"),
     "vectara": load_requirements("requirements/connectors/vectara.in"),
     "vastdb": load_requirements("requirements/connectors/vastdb.in"),
+    "zendesk": load_requirements("requirements/connectors/zendesk.in"),
 }
 
 embed_reqs = {

unstructured_ingest/__version__.py

@@ -1 +1 @@
-__version__ = "0.5.11"  # pragma: no cover
+__version__ = "0.5.12-dev0"  # pragma: no cover

unstructured_ingest/v2/processes/connectors/zendesk/client.py

@@ -2,8 +2,7 @@
 from dataclasses import dataclass
 from typing import Dict, List
 
-import httpx
-
+from unstructured_ingest.utils.dep_check import requires_dependencies
 from unstructured_ingest.v2.errors import ProviderError, RateLimitError, UserAuthError, UserError
 from unstructured_ingest.v2.logger import logger
 
@@ -42,7 +41,10 @@ def __lt__(self, other):
 
 class ZendeskClient:
 
+    @requires_dependencies(["httpx"], extras="zendesk")
     def __init__(self, token: str, subdomain: str, email: str):
+        import httpx
+
         # should be okay to be blocking.
         url_to_check = f"https://{subdomain}.zendesk.com/api/v2/groups.json"
         auth = f"{email}/token", token
@@ -57,7 +59,10 @@ def __init__(self, token: str, subdomain: str, email: str):
         self._email = email
         self._auth = auth
 
+    @requires_dependencies(["httpx"], extras="zendesk")
     def wrap_error(self, e: Exception) -> Exception:
+        import httpx
+
         if not isinstance(e, httpx.HTTPStatusError):
             logger.error(f"unhandled exception from Zendesk client: {e}", exc_info=True)
             return e
@@ -88,10 +93,12 @@ def wrap_error(self, e: Exception) -> Exception:
         logger.error(f"unhandled http status error from Zendesk client: {e}", exc_info=True)
         return e
 
+    @requires_dependencies(["httpx"], extras="zendesk")
     async def get_articles_async(self) -> List[ZendeskArticle]:
         """
         Retrieves article content from Zendesk asynchronously.
         """
+        import httpx
 
         articles: List[ZendeskArticle] = []
 
@@ -117,7 +124,10 @@ async def get_articles_async(self) -> List[ZendeskArticle]:
         ]
         return articles
 
+    @requires_dependencies(["httpx"], extras="zendesk")
     async def get_comments_async(self, ticket_id: int) -> List["Comment"]:
+        import httpx
+
         comments_url = f"https://{self._subdomain}.zendesk.com/api/v2/tickets/{ticket_id}/comments"
 
         try:
@@ -138,7 +148,9 @@ async def get_comments_async(self, ticket_id: int) -> List["Comment"]:
             for entry in response.json()["comments"]
         ]
 
+    @requires_dependencies(["httpx"], extras="zendesk")
     def get_users(self) -> List[dict]:
+        import httpx
 
         users: List[dict] = []
 
@@ -154,7 +166,10 @@ def get_users(self) -> List[dict]:
 
         return users
 
+    @requires_dependencies(["httpx"], extras="zendesk")
     async def get_tickets_async(self) -> List["ZendeskTicket"]:
+        import httpx
+
         tickets: List["ZendeskTicket"] = []
         tickets_url = f"https://{self._subdomain}.zendesk.com/api/v2/tickets"
 
@@ -179,10 +194,13 @@ async def get_tickets_async(self) -> List["ZendeskTicket"]:
 
         return tickets
 
+    @requires_dependencies(["httpx"], extras="zendesk")
     async def get_article_attachments_async(self, article_id: str):
         """
         Handles article attachments such as images and stores them as UTF-8 encoded bytes.
         """
+        import httpx
+
         article_attachment_url = (
             f"https://{self._subdomain}.zendesk.com/api/v2/help_center/"
             f"articles/{article_id}/attachments"

unstructured_ingest/v2/processes/connectors/zendesk/zendesk.py

@@ -7,11 +7,10 @@
 from time import time
 from typing import Any, AsyncGenerator, List, Literal
 
-import aiofiles
-import bs4
 from pydantic import BaseModel, Field, Secret
 
 from unstructured_ingest.utils.data_prep import batch_generator
+from unstructured_ingest.utils.dep_check import requires_dependencies
 from unstructured_ingest.utils.html import HtmlMixin
 from unstructured_ingest.v2.errors import UserAuthError
 from unstructured_ingest.v2.interfaces import (
@@ -290,13 +289,17 @@ def download_embedded_files(
             session=session,
         )
 
+    @requires_dependencies(["bs4", "aiofiles"], extras="zendesk")
     async def handle_articles_async(
         self, client: ZendeskClient, batch_file_data: ZendeskBatchFileData
     ):
         """
         Processes the article information, downloads the attachments for each article,
         and updates the content accordingly.
         """
+        import aiofiles
+        import bs4
+
         # Determine the download path
         download_path = self.get_download_path(batch_file_data)
 
@@ -327,12 +330,15 @@ async def handle_articles_async(
             file_data=batch_file_data, download_path=download_path
         )
 
+    @requires_dependencies(["aiofiles"], extras="zendesk")
     async def handle_tickets_async(
         self, client: ZendeskClient, batch_file_data: ZendeskBatchFileData
     ) -> DownloadResponse:
         """
         Processes a batch of tickets asynchronously, writing their details and comments to a file.
         """
+        import aiofiles
+
         # Determine the download path
         download_path = self.get_download_path(batch_file_data)
         if download_path is None: