python-documentcloud 4.5.0__tar.gz → 4.6.0__tar.gz

{python_documentcloud-4.5.0/python_documentcloud.egg-info → python_documentcloud-4.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-documentcloud
-Version: 4.5.0
+Version: 4.6.0
 Summary: A simple Python wrapper for the DocumentCloud API
 Home-page: https://github.com/muckrock/python-documentcloud
 Author: Mitchell Kotler

{python_documentcloud-4.5.0 → python_documentcloud-4.6.0}/documentcloud/addon.py

@@ -182,6 +182,26 @@ class AddOn(BaseAddOn):
             f"addon_runs/{self.id}/", json={"file_name": file_name}
         )
 
+    def load_run_data(self):
+        "Load persistent data from this run"
+        if not self.id:
+            return {}
+
+        response = self.client.get(f"addon_runs/{self.id}/")
+        response.raise_for_status()
+        return response.json().get("data", {})
+
+    def store_run_data(self, data):
+        "Store persistent data for this run"
+        if not self.id:
+            print("Run ID not set. Try again later or check if something went wrong.")
+            return None
+
+        if not isinstance(data, dict):
+            raise TypeError("Invalid data")
+
+        return self.client.patch(f"addon_runs/{self.id}/", json={"data": data})
+
     def load_event_data(self):
         """Load persistent data for this event"""
         if not self.event_id:

{python_documentcloud-4.5.0 → python_documentcloud-4.6.0}/documentcloud/documents.py

@@ -9,6 +9,7 @@ import os
 import re
 import warnings
 from functools import partial
+from urllib.parse import urlparse
 
 # Third Party
 from requests.exceptions import RequestException
@@ -23,11 +24,6 @@ from .sections import SectionClient
 from .toolbox import grouper, is_url, merge_dicts, requests_retry_session
 from .users import User
 
-try:
-    from urllib.parse import urlparse
-except ImportError:
-    from urlparse import urlparse
-
 logger = logging.getLogger("documentcloud")
 
 IMAGE_SIZES = ["thumbnail", "small", "normal", "large", "xlarge"]

python_documentcloud-4.6.0/documentcloud/exceptions.py

@@ -0,0 +1,15 @@
+"""
+Custom exceptions for python-documentcloud
+"""
+
+# Third Party
+# pylint: disable=unused-import
+# Import exceptions from python-squarelet
+from squarelet.exceptions import (
+    APIError,
+    CredentialsFailedError,
+    DoesNotExistError,
+    DuplicateObjectError,
+    MultipleObjectsReturnedError,
+    SquareletError as DocumentCloudError,
+)

{python_documentcloud-4.5.0 → python_documentcloud-4.6.0/python_documentcloud.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-documentcloud
-Version: 4.5.0
+Version: 4.6.0
 Summary: A simple Python wrapper for the DocumentCloud API
 Home-page: https://github.com/muckrock/python-documentcloud
 Author: Mitchell Kotler

{python_documentcloud-4.5.0 → python_documentcloud-4.6.0}/python_documentcloud.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ python_documentcloud.egg-info/SOURCES.txt
 python_documentcloud.egg-info/dependency_links.txt
 python_documentcloud.egg-info/requires.txt
 python_documentcloud.egg-info/top_level.txt
+tests/test_addon.py
 tests/test_annotations.py
 tests/test_base.py
 tests/test_client.py

{python_documentcloud-4.5.0 → python_documentcloud-4.6.0}/setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="python-documentcloud",
-    version="4.5.0",
+    version="4.6.0",
     description="A simple Python wrapper for the DocumentCloud API",
     author="Mitchell Kotler",
     author_email="mitch@muckrock.com",

python_documentcloud-4.6.0/tests/test_addon.py

@@ -0,0 +1,141 @@
+# Standard Library
+from unittest.mock import MagicMock
+
+# Third Party
+import pytest
+
+# DocumentCloud
+from documentcloud.addon import AddOn
+
+# pylint: disable=redefined-outer-name
+
+
+@pytest.fixture
+def addon():
+    """An AddOn instance built without invoking argparse or constructing a real client.
+
+    Tests can override `.id`, `.event_id`, `.client`, etc. as needed.
+    """
+    instance = AddOn.__new__(AddOn)
+    instance.id = "run-123"
+    instance.addon_id = "addon-1"
+    instance.event_id = None
+    instance.documents = None
+    instance.query = None
+    instance.user_id = None
+    instance.org_id = None
+    instance.data = {}
+    instance.title = "Test AddOn"
+    instance.client = MagicMock()
+    return instance
+
+
+class TestLoadRunData:
+    def test_returns_data_when_run_id_set(self, addon):
+        addon.client.get.return_value.json.return_value = {"data": {"foo": "bar"}}
+
+        result = addon.load_run_data()
+
+        addon.client.get.assert_called_once_with("addon_runs/run-123/")
+        assert result == {"foo": "bar"}
+
+    def test_returns_empty_dict_when_no_run_id(self, addon):
+        addon.id = None
+
+        assert addon.load_run_data() == {}
+        addon.client.get.assert_not_called()
+
+    def test_returns_empty_dict_when_data_missing_from_response(self, addon):
+        addon.client.get.return_value.json.return_value = {}
+
+        assert addon.load_run_data() == {}
+
+
+class TestStoreRunData:
+    def test_patches_run_with_data(self, addon):
+        addon.store_run_data({"foo": "bar"})
+
+        addon.client.patch.assert_called_once_with(
+            "addon_runs/run-123/", json={"data": {"foo": "bar"}}
+        )
+
+    def test_no_op_when_no_run_id(self, addon, capsys):
+        addon.id = None
+
+        result = addon.store_run_data({"foo": "bar"})
+
+        assert result is None
+        addon.client.patch.assert_not_called()
+        assert "Run ID not set" in capsys.readouterr().out
+
+    def test_rejects_non_dict_data(self, addon):
+        with pytest.raises(TypeError):
+            addon.store_run_data("not a dict")
+
+        addon.client.patch.assert_not_called()
+
+
+class TestLoadEventData:
+    def test_returns_scratch_when_event_id_set(self, addon):
+        addon.event_id = "evt-9"
+        addon.client.get.return_value.json.return_value = {"scratch": {"x": 1}}
+
+        result = addon.load_event_data()
+
+        addon.client.get.assert_called_once_with("addon_events/evt-9/")
+        assert result == {"x": 1}
+
+    def test_returns_none_when_no_event_id(self, addon):
+        assert addon.load_event_data() is None
+        addon.client.get.assert_not_called()
+
+
+class TestStoreEventData:
+    def test_patches_event_with_scratch(self, addon):
+        addon.event_id = "evt-9"
+
+        addon.store_event_data({"x": 1})
+
+        addon.client.patch.assert_called_once_with(
+            "addon_events/evt-9/", json={"scratch": {"x": 1}}
+        )
+
+    def test_no_op_when_no_event_id(self, addon):
+        assert addon.store_event_data({"x": 1}) is None
+        addon.client.patch.assert_not_called()
+
+
+@pytest.fixture
+def real_addon(client, addon_run):
+    """An AddOn wired to the real `client` fixture and a freshly created run."""
+    instance = AddOn.__new__(AddOn)
+    instance.id = addon_run
+    instance.addon_id = None
+    instance.event_id = None
+    instance.documents = None
+    instance.query = None
+    instance.user_id = None
+    instance.org_id = None
+    instance.data = {}
+    instance.title = "Test AddOn"
+    instance.client = client
+    return instance
+
+
+class TestRunDataVCR:
+    """VCR-recorded round-trip tests against the dev DC.
+
+    Recording: set DC_TEST_ADDON_RUN_ID to an existing AddOnRun UUID on your
+    local dev DC, then run `make test-dev` (or `pytest --record-mode=new_episodes`).
+    """
+
+    def test_load_run_data_returns_dict(self, real_addon):
+        result = real_addon.load_run_data()
+        assert isinstance(result, dict)
+
+    def test_store_then_load_run_data_round_trip(self, real_addon):
+        payload = {"foo": "bar", "n": 42}
+        real_addon.store_run_data(payload)
+        loaded = real_addon.load_run_data()
+        assert loaded.get("foo") == "bar"
+        assert loaded.get("n") == 42

python_documentcloud-4.5.0/documentcloud/exceptions.py

@@ -1,12 +0,0 @@
-"""
-Custom exceptions for python-documentcloud
-"""
-
-# pylint: disable=unused-import
-# Import exceptions from python-squarelet
-from squarelet.exceptions import SquareletError as DocumentCloudError
-from squarelet.exceptions import DuplicateObjectError
-from squarelet.exceptions import CredentialsFailedError
-from squarelet.exceptions import APIError
-from squarelet.exceptions import DoesNotExistError
-from squarelet.exceptions import MultipleObjectsReturnedError