Merge pull request #172 from barun-saha/maintenance

Skip image search when Pexels API key is unavailable and prepare for new release

pyproject.toml

@@ -7,7 +7,7 @@ name = "slidedeckai"
 authors = [
   { name="Barun Saha", email="[email protected]" }
 ]
-description = "A Python package to generate slide decks using AI."
+description = "Co-create PowerPoint slide decks with AI"
 readme = "README.md"
 requires-python = ">=3.10"
 classifiers = [

src/slidedeckai/_version.py

@@ -1 +1 @@
-__version__ = '8.0.2'
+__version__ = '8.0.3'

src/slidedeckai/helpers/image_search.py

@@ -4,6 +4,7 @@ Search photos using Pexels API.
 import logging
 import os
 import random
+import warnings
 from io import BytesIO
 from typing import Union, Literal
 from urllib.parse import urlparse, parse_qs
@@ -15,6 +16,19 @@ from dotenv import load_dotenv
 load_dotenv()
 
 
+# If PEXEL_API_KEY env var is unavailable, issue a one-time warning
+if not os.getenv('PEXEL_API_KEY'):
+    warnings.warn(
+        'PEXEL_API_KEY environment variable is not set. '
+        'Image search functionality will not work without it.',
+        stacklevel=2
+    )
+
+PEXELS_URL = 'https://api.pexels.com/v1/search'
+REQUEST_HEADER = {
+    'Authorization': os.getenv('PEXEL_API_KEY'),
+    'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:10.0) Gecko/20100101 Firefox/10.0',
+}
 REQUEST_TIMEOUT = 12
 MAX_PHOTOS = 3
 
@@ -50,23 +64,27 @@ def search_pexels(
         per_page: No. of results to be displayed per page.
 
     Returns:
-        The JSON response from the Pexels API containing search results.
+        The JSON response from the Pexels API containing search results. Empty dict if API key
+        is not set.
 
     Raises:
         requests.exceptions.RequestException: If the request to the Pexels API fails.
     """
-    url = 'https://api.pexels.com/v1/search'
-    headers = {
-        'Authorization': os.getenv('PEXEL_API_KEY'),
-        'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:10.0) Gecko/20100101 Firefox/10.0',
-    }
+    if not os.getenv('PEXEL_API_KEY'):
+        return {}
+
     params = {
         'query': query,
         'size': size,
         'page': 1,
         'per_page': per_page
     }
-    response = requests.get(url, headers=headers, params=params, timeout=REQUEST_TIMEOUT)
+    response = requests.get(
+        PEXELS_URL,
+        headers=REQUEST_HEADER,
+        params=params,
+        timeout=REQUEST_TIMEOUT
+    )
     response.raise_for_status()  # Ensure the request was successful
 
     return response.json()
@@ -83,8 +101,12 @@ def get_photo_url_from_api_response(
         json_response: The JSON response.
 
     Returns:
-        The selected photo URL and page URL or `None`.
+        The selected photo URL and page URL or `None`. Empty tuple if no photos found or API key
+        is not set.
     """
+    if not os.getenv('PEXEL_API_KEY'):
+        return None, None
+
     page_url = None
     photo_url = None
 
@@ -123,11 +145,7 @@ def get_image_from_url(url: str) -> BytesIO:
     Raises:
         requests.exceptions.RequestException: If the request to the URL fails.
     """
-    headers = {
-        'Authorization': os.getenv('PEXEL_API_KEY'),
-        'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:10.0) Gecko/20100101 Firefox/10.0',
-    }
-    response = requests.get(url, headers=headers, stream=True, timeout=REQUEST_TIMEOUT)
+    response = requests.get(url, headers=REQUEST_HEADER, stream=True, timeout=REQUEST_TIMEOUT)
     response.raise_for_status()
     image_data = BytesIO(response.content)
 

tests/unit/test_image_search.py

@@ -42,7 +42,6 @@ def _dummy_requests_get_success_search(
         timeout: int
 ):
     """Return a successful mock response for search_pexels."""
-
     # Validate that the function under test passes expected args
     assert 'Authorization' in headers
     assert 'User-Agent' in headers
@@ -72,7 +71,6 @@ def _dummy_requests_get_image(
         stream: bool, timeout: int
 ):
     """Return a mock image response for get_image_from_url."""
-
     assert stream is True
     assert 'Authorization' in headers
     data = b'\x89PNG\r\n\x1a\n...'
@@ -114,6 +112,10 @@ def test_get_photo_url_from_api_response_selects_large_and_original(monkeypatch)
         {'url': 'https://pexels.com/photo/3', 'src': {'large': 'https://images/3_large.jpg'}},
     ]
 
+    # Ensure the Pexels API key is present so the helper will attempt to select
+    # and return photo URLs rather than early-returning (None, None).
+    monkeypatch.setenv('PEXEL_API_KEY', 'akey')
+
     # Force selection of index 1 (second photo) which only has 'original'
     monkeypatch.setattr(image_search.random, 'choice', lambda seq: 1)
 
@@ -169,3 +171,22 @@ def test_search_pexels_raises_on_request_error(monkeypatch) -> None:
 
     with pytest.raises(RuntimeError):
         image_search.search_pexels(query='x')
+
+
+def test_search_pexels_returns_empty_when_no_api_key(monkeypatch) -> None:
+    """When PEXEL_API_KEY is not set, search_pexels should return an empty dict."""
+    monkeypatch.delenv('PEXEL_API_KEY', raising=False)
+    result = image_search.search_pexels(query='people')
+
+    assert result == {}
+
+
+def test_get_photo_url_from_api_response_returns_none_when_no_api_key(monkeypatch) -> None:
+    """When PEXEL_API_KEY is not set, get_photo_url_from_api_response should return (None, None)."""
+    photos = [
+        {'url': 'https://pexels.com/photo/1', 'src': {'large': 'https://images/1_large.jpg'}}
+    ]
+    monkeypatch.delenv('PEXEL_API_KEY', raising=False)
+    result = image_search.get_photo_url_from_api_response({'photos': photos})
+
+    assert result == (None, None)