Add tests (#385)

pyesef/download/__init__.py

@@ -36,6 +36,21 @@ class Filing:
     file_name: str
     path: str
 
+    @property
+    def file_url(self) -> str:
+        """Return file URL."""
+        return f"{BASE_URL}{self.path}/{self.file_name}"
+
+    @property
+    def download_country_folder(self) -> str:
+        """Return download path."""
+        return os.path.join(PATH_ARCHIVES, self.country)
+
+    @property
+    def write_location(self) -> str:
+        """Return file write location."""
+        return os.path.join(self.download_country_folder, self.file_name)
+
 
 IdentifierType = dict[str, list[Filing]]
 
@@ -72,18 +87,17 @@ def _cleanup_package_dict(identifier_map: IdentifierType) -> list[Filing]:
 
 def _download_package(filing: Filing) -> None:
     """Download a package and store it the archive-folder."""
-    url = f"{BASE_URL}{filing.path}/{filing.file_name}"
-
-    download_path = os.path.join(PATH_ARCHIVES, filing.country)
-
-    # Create download path if it does not exist
-    Path(download_path).mkdir(parents=True, exist_ok=True)
+    Path(  # Create download path if it does not exist
+        filing.download_country_folder
+    ).mkdir(
+        parents=True,
+        exist_ok=True,
+    )
 
-    LOGGER.info(f"Downloading {url}")
+    LOGGER.info(f"Downloading {filing.file_url}")
 
-    req = requests.get(url, stream=True, timeout=30)
-    write_location = os.path.join(download_path, filing.file_name)
-    with open(write_location, "wb") as _file:
+    req = requests.get(filing.file_url, stream=True, timeout=30)
+    with open(filing.write_location, "wb") as _file:
         for chunk in req.iter_content(chunk_size=2048):
             _file.write(chunk)
 

tests/test_download.py

@@ -78,3 +78,21 @@ def test_cleanup_package_dict(test_data, expected_result) -> None:
     """Test function _cleanup_package_dict."""
     function_result = _cleanup_package_dict(test_data)
     assert function_result == expected_result
+
+
+def test_filing_property__file_url() -> None:
+    """Return Filing.file_url."""
+    model = Filing(country="se", file_name="abc", path="a/b/c")
+    assert model.file_url == "https://filings.xbrl.org/a/b/c/abc"
+
+
+def test_filing_property__download_country_folder() -> None:
+    """Return Filing.download_country_folder."""
+    model = Filing(country="se", file_name="abc", path="a/b/c")
+    assert "/pyesef/archives/se" in model.download_country_folder
+
+
+def test_filing_property__write_location() -> None:
+    """Return Filing.write_location."""
+    model = Filing(country="se", file_name="abc", path="a/b/c")
+    assert "/pyesef/archives/se/abc" in model.write_location