fix: add user-agent on requests (#295)

* (WIP) fix: add user-agent on requests

* adjusted tests for download and upload

* clean it up, test it right

* blacken it

* adjust headers

* lint

* match x-goog and user-agent

google/resumable_media/_download.py

@@ -58,7 +58,7 @@ def __init__(self, media_url, stream=None, start=None, end=None, headers=None):
         self.end = end
         if headers is None:
             headers = {}
-        self._headers = headers
+        self._headers = _helpers._base_headers(headers)
         self._finished = False
         self._retry_strategy = common.RetryStrategy()
 

google/resumable_media/_helpers.py

@@ -20,6 +20,7 @@
 import hashlib
 import logging
 import random
+import pkg_resources
 import warnings
 
 from google.resumable_media import common
@@ -45,6 +46,13 @@ def do_nothing():
     """Simple default callback."""
 
 
+def _base_headers(headers):
+    version = pkg_resources.get_distribution("google-resumable-media").version
+    headers["User-Agent"] = "gcloud-python/{}-resumable-media".format(version)
+    headers["X-Goog-Api-Client"] = "gcloud-python/{}-resumable-media".format(version)
+    return headers
+
+
 def header_required(response, name, get_headers, callback=do_nothing):
     """Checks that a specific header is in a headers dictionary.
 

google/resumable_media/_upload.py

@@ -83,7 +83,7 @@ def __init__(self, upload_url, headers=None):
         self.upload_url = upload_url
         if headers is None:
             headers = {}
-        self._headers = headers
+        self._headers = _helpers._base_headers(headers)
         self._finished = False
         self._retry_strategy = common.RetryStrategy()
 

tests/unit/requests/test_download.py

@@ -22,7 +22,7 @@
 from google.resumable_media import _helpers
 from google.resumable_media.requests import download as download_mod
 from google.resumable_media.requests import _request_helpers
-
+from google.resumable_media._helpers import _base_headers
 
 URL_PREFIX = "https://www.googleapis.com/download/storage/v1/b/{BUCKET}/o/"
 EXAMPLE_URL = URL_PREFIX + "{OBJECT}?alt=media"
@@ -241,7 +241,7 @@ def test_consume_with_stream_hash_check_fail(self, checksum):
 
         assert stream.getvalue() == b"".join(chunks)
         assert download.finished
-        assert download._headers == {}
+        assert download._headers == _base_headers({})
 
         error = exc_info.value
         assert error.response is transport.request.return_value
@@ -260,7 +260,7 @@ def test_consume_with_stream_hash_check_fail(self, checksum):
             "GET",
             EXAMPLE_URL,
             data=None,
-            headers={},
+            headers=_base_headers({}),
             stream=True,
             timeout=EXPECTED_TIMEOUT,
         )
@@ -271,7 +271,7 @@ def test_consume_with_headers(self):
         self._consume_helper(end=end, headers=headers)
         range_bytes = "bytes={:d}-{:d}".format(0, end)
         # Make sure the headers have been modified.
-        assert headers == {"range": range_bytes}
+        assert headers == _base_headers({"range": range_bytes})
 
 
 class TestRawDownload(object):
@@ -494,7 +494,7 @@ def test_consume_with_stream_hash_check_fail(self, checksum):
 
         assert stream.getvalue() == b"".join(chunks)
         assert download.finished
-        assert download._headers == {}
+        assert download._headers == _base_headers({})
 
         error = exc_info.value
         assert error.response is transport.request.return_value
@@ -513,7 +513,7 @@ def test_consume_with_stream_hash_check_fail(self, checksum):
             "GET",
             EXAMPLE_URL,
             data=None,
-            headers={},
+            headers=_base_headers({}),
             stream=True,
             timeout=EXPECTED_TIMEOUT,
         )
@@ -524,7 +524,7 @@ def test_consume_with_headers(self):
         self._consume_helper(end=end, headers=headers)
         range_bytes = "bytes={:d}-{:d}".format(0, end)
         # Make sure the headers have been modified.
-        assert headers == {"range": range_bytes}
+        assert headers == _base_headers({"range": range_bytes})
 
 
 class TestChunkedDownload(object):
@@ -589,7 +589,7 @@ def test_consume_next_chunk(self):
         ret_val = download.consume_next_chunk(transport)
         assert ret_val is transport.request.return_value
         range_bytes = "bytes={:d}-{:d}".format(start, start + chunk_size - 1)
-        download_headers = {"range": range_bytes}
+        download_headers = _base_headers({"range": range_bytes})
         transport.request.assert_called_once_with(
             "GET",
             EXAMPLE_URL,
@@ -618,7 +618,7 @@ def test_consume_next_chunk_with_custom_timeout(self):
         download.consume_next_chunk(transport, timeout=14.7)
 
         range_bytes = "bytes={:d}-{:d}".format(start, start + chunk_size - 1)
-        download_headers = {"range": range_bytes}
+        download_headers = _base_headers({"range": range_bytes})
         transport.request.assert_called_once_with(
             "GET",
             EXAMPLE_URL,
@@ -695,7 +695,7 @@ def test_consume_next_chunk(self):
             "GET",
             EXAMPLE_URL,
             data=None,
-            headers=download_headers,
+            headers=_base_headers(download_headers),
             stream=True,
             timeout=EXPECTED_TIMEOUT,
         )
@@ -725,7 +725,7 @@ def test_consume_next_chunk_with_custom_timeout(self):
             "GET",
             EXAMPLE_URL,
             data=None,
-            headers=download_headers,
+            headers=_base_headers(download_headers),
             stream=True,
             timeout=14.7,
         )

tests/unit/requests/test_upload.py

@@ -19,6 +19,7 @@
 import mock
 
 import google.resumable_media.requests.upload as upload_mod
+from google.resumable_media._helpers import _base_headers
 
 
 URL_PREFIX = "https://www.googleapis.com/upload/storage/v1/b/{BUCKET}/o"
@@ -48,7 +49,7 @@ def test_transmit(self):
             "POST",
             SIMPLE_URL,
             data=data,
-            headers=upload_headers,
+            headers=_base_headers(upload_headers),
             timeout=EXPECTED_TIMEOUT,
         )
         assert upload.finished
@@ -67,7 +68,7 @@ def test_transmit_w_custom_timeout(self):
             "POST",
             SIMPLE_URL,
             data=data,
-            headers=expected_headers,
+            headers=_base_headers(expected_headers),
             timeout=12.6,
         )
 
@@ -103,7 +104,7 @@ def test_transmit(self, mock_get_boundary):
             "POST",
             MULTIPART_URL,
             data=expected_payload,
-            headers=upload_headers,
+            headers=_base_headers(upload_headers),
             timeout=EXPECTED_TIMEOUT,
         )
         assert upload.finished
@@ -141,7 +142,7 @@ def test_transmit_w_custom_timeout(self, mock_get_boundary):
             "POST",
             MULTIPART_URL,
             data=expected_payload,
-            headers=upload_headers,
+            headers=_base_headers(upload_headers),
             timeout=12.6,
         )
         assert upload.finished
@@ -187,7 +188,7 @@ def test_initiate(self):
             "POST",
             RESUMABLE_URL,
             data=json_bytes,
-            headers=expected_headers,
+            headers=_base_headers(expected_headers),
             timeout=EXPECTED_TIMEOUT,
         )
 
@@ -223,7 +224,7 @@ def test_initiate_w_custom_timeout(self):
             "POST",
             RESUMABLE_URL,
             data=json_bytes,
-            headers=expected_headers,
+            headers=_base_headers(expected_headers),
             timeout=12.6,
         )
 

tests/unit/test__download.py

@@ -20,7 +20,7 @@
 
 from google.resumable_media import _download
 from google.resumable_media import common
-
+from google.resumable_media._helpers import _base_headers
 
 EXAMPLE_URL = (
     "https://www.googleapis.com/download/storage/v1/b/{BUCKET}/o/{OBJECT}?alt=media"
@@ -34,7 +34,7 @@ def test_constructor_defaults(self):
         assert download._stream is None
         assert download.start is None
         assert download.end is None
-        assert download._headers == {}
+        assert download._headers == _base_headers({})
         assert not download._finished
         _check_retry_strategy(download)
 
@@ -53,7 +53,7 @@ def test_constructor_explicit(self):
         assert download._stream is mock.sentinel.stream
         assert download.start == start
         assert download.end == end
-        assert download._headers is headers
+        assert download._headers == _base_headers(headers)
         assert not download._finished
         _check_retry_strategy(download)
 
@@ -102,14 +102,14 @@ def test__prepare_request(self):
         assert method1 == "GET"
         assert url1 == EXAMPLE_URL
         assert payload1 is None
-        assert headers1 == {}
+        assert headers1 == _base_headers({})
 
         download2 = _download.Download(EXAMPLE_URL, start=53)
         method2, url2, payload2, headers2 = download2._prepare_request()
         assert method2 == "GET"
         assert url2 == EXAMPLE_URL
         assert payload2 is None
-        assert headers2 == {"range": "bytes=53-"}
+        assert headers2 == _base_headers({"range": "bytes=53-"})
 
     def test__prepare_request_with_headers(self):
         headers = {"spoonge": "borb"}
@@ -118,8 +118,9 @@ def test__prepare_request_with_headers(self):
         assert method == "GET"
         assert url == EXAMPLE_URL
         assert payload is None
-        assert new_headers is headers
-        assert headers == {"range": "bytes=11-111", "spoonge": "borb"}
+        assert new_headers == _base_headers(
+            {"range": "bytes=11-111", "spoonge": "borb"}
+        )
 
     def test__process_response(self):
         download = _download.Download(EXAMPLE_URL)
@@ -171,7 +172,7 @@ def test_constructor_defaults(self):
         assert download.chunk_size == chunk_size
         assert download.start == 0
         assert download.end is None
-        assert download._headers == {}
+        assert download._headers == _base_headers({})
         assert not download._finished
         _check_retry_strategy(download)
         assert download._stream is stream
@@ -288,7 +289,7 @@ def test__prepare_request(self):
         assert method1 == "GET"
         assert url1 == EXAMPLE_URL
         assert payload1 is None
-        assert headers1 == {"range": "bytes=0-2047"}
+        assert headers1 == _base_headers({"range": "bytes=0-2047"})
 
         download2 = _download.ChunkedDownload(
             EXAMPLE_URL, chunk_size, None, start=19991
@@ -298,7 +299,7 @@ def test__prepare_request(self):
         assert method2 == "GET"
         assert url2 == EXAMPLE_URL
         assert payload2 is None
-        assert headers2 == {"range": "bytes=19991-20100"}
+        assert headers2 == _base_headers({"range": "bytes=19991-20100"})
 
     def test__prepare_request_with_headers(self):
         chunk_size = 2048
@@ -310,9 +311,8 @@ def test__prepare_request_with_headers(self):
         assert method == "GET"
         assert url == EXAMPLE_URL
         assert payload is None
-        assert new_headers is headers
         expected = {"patrizio": "Starf-ish", "range": "bytes=0-2047"}
-        assert headers == expected
+        assert new_headers == _base_headers(expected)
 
     def test__make_invalid(self):
         download = _download.ChunkedDownload(EXAMPLE_URL, 512, None)