Adding GCCL header for HTTP APIs. (#3046)

Author: dhermes

packages/google-cloud-logging/google/cloud/logging/__init__.py

@@ -15,6 +15,9 @@
 """Google Stackdriver Logging API wrapper."""
 
 
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-logging').version
+
 from google.cloud.logging.client import Client
 
 

packages/google-cloud-logging/google/cloud/logging/_http.py

@@ -18,11 +18,16 @@
 
 from google.cloud import _http
 from google.cloud.iterator import HTTPIterator
+
+from google.cloud.logging import __version__
 from google.cloud.logging._helpers import entry_from_resource
 from google.cloud.logging.sink import Sink
 from google.cloud.logging.metric import Metric
 
 
+_CLIENT_INFO = _http.CLIENT_INFO_TEMPLATE.format(__version__)
+
+
 class Connection(_http.JSONConnection):
     """A connection to Google Stackdriver Logging via the JSON REST API.
 
@@ -39,6 +44,10 @@ class Connection(_http.JSONConnection):
     API_URL_TEMPLATE = '{api_base_url}/{api_version}{path}'
     """A template for the URL of a particular API call."""
 
+    _EXTRA_HEADERS = {
+        _http.CLIENT_INFO_HEADER: _CLIENT_INFO,
+    }
+
 
 class _LoggingAPI(object):
     """Helper mapping logging-related APIs.

packages/google-cloud-logging/unit_tests/test__http.py

@@ -42,6 +42,36 @@ def test_default_url(self):
         conn = self._make_one(client)
         self.assertIs(conn._client, client)
 
+    def test_extra_headers(self):
+        from google.cloud import _http as base_http
+        from google.cloud.logging import _http as MUT
+
+        http = mock.Mock(spec=['request'])
+        response = mock.Mock(status=200, spec=['status'])
+        data = b'brent-spiner'
+        http.request.return_value = response, data
+        client = mock.Mock(_http=http, spec=['_http'])
+
+        conn = self._make_one(client)
+        req_data = 'req-data-boring'
+        result = conn.api_request(
+            'GET', '/rainbow', data=req_data, expect_json=False)
+        self.assertEqual(result, data)
+
+        expected_headers = {
+            'Content-Length': str(len(req_data)),
+            'Accept-Encoding': 'gzip',
+            base_http.CLIENT_INFO_HEADER: MUT._CLIENT_INFO,
+            'User-Agent': conn.USER_AGENT,
+        }
+        expected_uri = conn.build_api_url('/rainbow')
+        http.request.assert_called_once_with(
+            body=req_data,
+            headers=expected_headers,
+            method='GET',
+            uri=expected_uri,
+        )
+
 
 class Test_LoggingAPI(unittest.TestCase):