files-com 1.6.485__tar.gz → 1.6.486__tar.gz

{files_com-1.6.485/files_com.egg-info → files_com-1.6.486}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.485
+Version: 1.6.486
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

files_com-1.6.486/_VERSION

@@ -0,0 +1 @@
+1.6.486

{files_com-1.6.485 → files_com-1.6.486/files_com.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.6.485
+Version: 1.6.486
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5

{files_com-1.6.485 → files_com-1.6.486}/files_com.egg-info/SOURCES.txt

@@ -301,6 +301,7 @@ tests/test_sync.py
 tests/test_sync_log.py
 tests/test_sync_run.py
 tests/test_sync_run_live_transfer.py
+tests/test_transfer_privacy.py
 tests/test_usage_by_top_level_dir.py
 tests/test_usage_daily_snapshot.py
 tests/test_usage_snapshot.py

{files_com-1.6.485 → files_com-1.6.486}/files_sdk/__init__.py

@@ -320,7 +320,7 @@ source_ip = None
 workspace_id = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.6.485"
+version = "1.6.486"
 
 __version__ = version
 

{files_com-1.6.485 → files_com-1.6.486}/files_sdk/api_client.py

@@ -65,7 +65,7 @@ class ApiClient:
             headers = {}
         req = requests.Request(method, url=url, headers=headers, data=body)
 
-        response = self.execute_request_with_auto_retry(req)
+        response = self.execute_request_with_auto_retry(req, is_transfer=True)
         return response
 
     def send_request(
@@ -166,6 +166,7 @@ class ApiClient:
         return response
 
     def stream_download(self, uri, io, is_string_io=False):
+        util.log_debug("Download request", url=uri)
         # NOTE the stream=True parameter below
         try:
             with requests.get(
@@ -187,9 +188,14 @@ class ApiClient:
             requests.exceptions.ChunkedEncodingError,
         ) as e:
             raise self.handle_network_error(e, e.request, 0) from None
+        except requests.exceptions.HTTPError as e:
+            util.log_debug("Transfer error details", error_message=e)
+            raise APIError(
+                "Transfer request failed", http_status=e.response.status_code
+            ) from None
 
     def execute_request_with_auto_retry(
-        self, request, skip_body_logging=False
+        self, request, skip_body_logging=False, is_transfer=False
     ):
         for try_num in range(0, files_sdk.max_network_retries):
             response = None
@@ -227,7 +233,9 @@ class ApiClient:
 
                 if try_num + 1 == files_sdk.max_network_retries:
                     if response is not None:
-                        self.handle_error_response(response)
+                        self.handle_error_response(
+                            response, is_transfer=is_transfer
+                        )
                     else:
                         raise self.handle_network_error(
                             e, request, try_num
@@ -296,7 +304,7 @@ class ApiClient:
             msg += " Additional Information: {}".format(extra_info)
         return APIError(msg)
 
-    def handle_error_response(self, response):
+    def handle_error_response(self, response, is_transfer=False):
         error_data = None
 
         try:
@@ -317,18 +325,27 @@ class ApiClient:
             if not error_data:
                 raise Error("Unknown error")
         except Error:
+            if is_transfer:
+                raise APIError(
+                    "Transfer request failed", http_status=response.status_code
+                ) from None
             raise self.general_api_error(response, "Unknown error")
 
-        error = self.specific_api_error(response, error_data)
+        error = self.specific_api_error(
+            response, error_data, is_transfer=is_transfer
+        )
 
         error.response = response
-        raise error
+        raise error from None
 
-    def specific_api_error(self, response, error_data):
+    def specific_api_error(self, response, error_data, is_transfer=False):
         import files_sdk.error
 
+        message = (
+            "Transfer request failed" if is_transfer else error_data["message"]
+        )
         util.log_error(
-            "API error", status=response.status_code, error_message=error_data
+            "API error", status=response.status_code, error_message=message
         )
 
         opts = {
@@ -344,32 +361,31 @@ class ApiClient:
             "".join(list(map(str.capitalize, error_type.split("-")))) + "Error"
         )
         try:
-            return getattr(files_sdk.error, error_class_name)(
-                error_data["message"], **opts
-            )
+            return getattr(files_sdk.error, error_class_name)(message, **opts)
         except AttributeError:
-            return APIError(error_data["message"], **opts)
+            return APIError(message, **opts)
 
     def handle_network_error(self, error, request, num_retries):
-        util.log_error("Network error", error_message=error)
+        util.log_error("Network error", error_type=type(error).__name__)
+        util.log_debug("Network error details", error_message=error)
         msg = "Could not connect to Files.com at URL {}. Please check your internet connection and try again. If this problem persists, you should check Files.com's service status at https://status.files.com, or contact your primary account representative.".format(
             files_sdk.base_url
         )
         if num_retries > 0:
             msg += " Request was retried {} times.".format(num_retries)
-        msg += "\n\n(Network error: {})".format(error)
+        msg += "\n\n(Network error: {})".format(type(error).__name__)
 
         return APIConnectionError(msg)
 
     def log_request(self, request, num_retries):
         util.log_info(
-            "Request",
-            method=request.method,
-            num_retries=num_retries,
-            url=request.url,
+            "Request", method=request.method, num_retries=num_retries
         )
         util.log_debug(
-            "Request details", body=request.data, query_params=request.params
+            "Request details",
+            url=request.url,
+            body=request.data,
+            query_params=request.params,
         )
 
     def log_response(self, request, request_start, status, body):
@@ -377,7 +393,6 @@ class ApiClient:
             "Response",
             elapsed=(time.time() - request_start),
             method=request.method,
-            url=request.url,
             status=status,
         )
         util.log_debug("Response details", body=body)
@@ -386,7 +401,7 @@ class ApiClient:
         util.log_error(
             "Error",
             elapsed=(time.time() - request_start),
-            error_message=error,
+            error_type=type(error).__name__,
             method=request.method,
-            url=request.url,
         )
+        util.log_debug("Error details", error_message=error, url=request.url)

{files_com-1.6.485 → files_com-1.6.486}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "files_com"
-version = "1.6.485"
+version = "1.6.486"
 description = "Python bindings for the Files.com API"
 readme = "README.md"
 license = { text = "MIT" }

files_com-1.6.486/tests/test_transfer_privacy.py

@@ -0,0 +1,97 @@
+import io
+import json
+import logging
+import socket
+import threading
+import unittest
+from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
+from unittest.mock import patch
+
+import files_sdk
+from files_sdk.api_client import ApiClient
+from files_sdk.error import APIConnectionError, APIError, NotFoundError
+
+
+class TransferHandler(BaseHTTPRequestHandler):
+    def do_PUT(self):
+        self.rfile.read(int(self.headers.get("Content-Length", 0)))
+        self.do_GET()
+
+    def do_GET(self):
+        self.server.requests += 1
+        if self.path.startswith("/disconnect"):
+            self.connection.shutdown(socket.SHUT_RDWR)
+            self.connection.close()
+            return
+        body = self.path.encode()
+        status = 403 if self.path.startswith("/denied") else 200
+        if self.path.startswith("/typed"):
+            status = 404
+            body = json.dumps({"type": "not-found", "error": self.path}).encode()
+        self.send_response(status)
+        self.send_header("Content-Length", str(len(body)))
+        self.end_headers()
+        self.wfile.write(body)
+
+    def log_message(self, *args):
+        pass
+
+
+class TestTransferPrivacy(unittest.TestCase):
+    def setUp(self):
+        self.server = ThreadingHTTPServer(("127.0.0.1", 0), TransferHandler)
+        self.server.requests = 0
+        self.thread = threading.Thread(target=self.server.serve_forever)
+        self.thread.start()
+        self.addCleanup(self.thread.join)
+        self.addCleanup(self.server.server_close)
+        self.addCleanup(self.server.shutdown)
+        for name, value in {
+            "max_network_retries": 2,
+            "initial_network_retry_delay": 0,
+            "max_network_retry_delay": 0,
+            "console_log_level": "",
+        }.items():
+            patcher = patch.object(files_sdk, name, value)
+            patcher.start()
+            self.addCleanup(patcher.stop)
+
+    def url(self, path):
+        return "http://127.0.0.1:{}/{}?X-Amz-Credential=private-credential&X-Amz-Signature=private-signature".format(
+            self.server.server_port, path
+        )
+
+    def assert_safe(self, text):
+        for secret in ("127.0.0.1", "X-Amz", "private-credential", "private-signature"):
+            self.assertNotIn(secret, text)
+
+    def test_transfer_failures_keep_urls_out_of_logs_and_error_text(self):
+        for download in (False, True):
+            for path, error_type in (("disconnect", APIConnectionError), ("denied", APIError)):
+                with self.subTest(download=download, path=path):
+                    with self.assertLogs("files_sdk", level=logging.DEBUG) as logs:
+                        with self.assertRaises(error_type) as caught:
+                            if download:
+                                ApiClient().stream_download(self.url(path), io.BytesIO())
+                            else:
+                                ApiClient().send_remote_request("PUT", self.url(path), body=b"part")
+                    self.assert_safe(str(caught.exception))
+                    self.assert_safe("\n".join(record.getMessage() for record in logs.records if record.levelno > logging.DEBUG))
+                    self.assertIn("private-signature", "\n".join(logs.output))
+                    if path == "denied":
+                        self.assertEqual(caught.exception.http_status, 403)
+        self.assertEqual(self.server.requests, 6)
+
+    def test_successful_upload_does_not_log_the_transfer_url_at_info(self):
+        with self.assertLogs("files_sdk", level=logging.INFO) as logs:
+            response = ApiClient().send_remote_request("PUT", self.url("upload"), body=b"part")
+        self.assertEqual(response.status_code, 200)
+        self.assert_safe("\n".join(logs.output))
+
+    def test_transfer_api_errors_keep_their_type_without_echoing_the_url(self):
+        with self.assertLogs("files_sdk", level=logging.INFO) as logs:
+            with self.assertRaises(NotFoundError) as caught:
+                ApiClient().send_remote_request("PUT", self.url("typed"), body=b"part")
+        self.assertEqual(caught.exception.http_status, 404)
+        self.assert_safe(str(caught.exception))
+        self.assert_safe("\n".join(logs.output))

files_com-1.6.485/_VERSION

@@ -1 +0,0 @@
-1.6.485