Adding GCCL header for HTTP APIs. (#3046)

Author: dhermes

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

@@ -14,4 +14,8 @@
 
 """Google Cloud Runtime Configurator API package."""
 
+
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-runtimeconfig').version
+
 from google.cloud.runtimeconfig.client import Client

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

@@ -18,6 +18,11 @@
 
 from google.cloud import _http
 
+from google.cloud.runtimeconfig import __version__
+
+
+_CLIENT_INFO = _http.CLIENT_INFO_TEMPLATE.format(__version__)
+
 
 class Connection(_http.JSONConnection):
     """A connection to Google Cloud RuntimeConfig via the JSON REST API.
@@ -34,3 +39,7 @@ 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,
+    }

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

@@ -14,6 +14,8 @@
 
 import unittest
 
+import mock
+
 
 class TestConnection(unittest.TestCase):
 
@@ -30,3 +32,33 @@ def test_default_url(self):
         client = object()
         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.runtimeconfig 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,
+        )