Adding GCCL header for HTTP APIs. (#3046)

Author: dhermes

bigquery/google/cloud/bigquery/__init__.py

@@ -23,6 +23,9 @@
 """
 
 
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-bigquery').version
+
 from google.cloud.bigquery._helpers import ArrayQueryParameter
 from google.cloud.bigquery._helpers import ScalarQueryParameter
 from google.cloud.bigquery._helpers import StructQueryParameter

bigquery/google/cloud/bigquery/_http.py

@@ -16,6 +16,11 @@
 
 from google.cloud import _http
 
+from google.cloud.bigquery import __version__
+
+
+_CLIENT_INFO = _http.CLIENT_INFO_TEMPLATE.format(__version__)
+
 
 class Connection(_http.JSONConnection):
     """A connection to Google BigQuery via the JSON REST API.
@@ -32,3 +37,7 @@ class Connection(_http.JSONConnection):
 
     API_URL_TEMPLATE = '{api_base_url}/bigquery/{api_version}{path}'
     """A template for the URL of a particular API call."""
+
+    _EXTRA_HEADERS = {
+        _http.CLIENT_INFO_HEADER: _CLIENT_INFO,
+    }

bigquery/unit_tests/test__http.py

@@ -14,6 +14,8 @@
 
 import unittest
 
+import mock
+
 
 class TestConnection(unittest.TestCase):
 
@@ -48,3 +50,33 @@ def test_build_api_url_w_extra_query_params(self):
                          '/'.join(['', 'bigquery', conn.API_VERSION, 'foo']))
         parms = dict(parse_qsl(qs))
         self.assertEqual(parms['bar'], 'baz')
+
+    def test_extra_headers(self):
+        from google.cloud import _http as base_http
+        from google.cloud.bigquery 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,
+        )

datastore/google/cloud/datastore/__init__.py

@@ -54,6 +54,9 @@
 """
 
 
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-datastore').version
+
 from google.cloud.datastore.batch import Batch
 from google.cloud.datastore.client import Client
 from google.cloud.datastore.entity import Entity

datastore/google/cloud/datastore/_http.py

@@ -15,7 +15,6 @@
 """Connections to Google Cloud Datastore API servers."""
 
 import os
-from pkg_resources import get_distribution
 
 from google.rpc import status_pb2
 
@@ -24,6 +23,8 @@
 from google.cloud.environment_vars import GCD_HOST
 from google.cloud import exceptions
 from google.cloud.grpc.datastore.v1 import datastore_pb2 as _datastore_pb2
+
+from google.cloud.datastore import __version__
 try:
     from google.cloud.datastore._gax import _DatastoreAPIOverGRPC
     _HAVE_GRPC = True
@@ -37,9 +38,7 @@
 
 _DISABLE_GRPC = os.getenv(DISABLE_GRPC, False)
 _USE_GRPC = _HAVE_GRPC and not _DISABLE_GRPC
-_DATASTORE_DIST = get_distribution('google-cloud-datastore')
-_CLIENT_INFO = connection_module.CLIENT_INFO_TEMPLATE.format(
-    _DATASTORE_DIST.version)
+_CLIENT_INFO = connection_module.CLIENT_INFO_TEMPLATE.format(__version__)
 
 
 class _DatastoreAPIOverHttp(object):

dns/google/cloud/dns/__init__.py

@@ -25,6 +25,9 @@
 """
 
 
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-dns').version
+
 from google.cloud.dns.zone import Changes
 from google.cloud.dns.client import Client
 from google.cloud.dns.zone import ManagedZone

dns/google/cloud/dns/_http.py

@@ -16,6 +16,11 @@
 
 from google.cloud import _http
 
+from google.cloud.dns import __version__
+
+
+_CLIENT_INFO = _http.CLIENT_INFO_TEMPLATE.format(__version__)
+
 
 class Connection(_http.JSONConnection):
     """A connection to Google Cloud DNS via the JSON REST API.
@@ -32,3 +37,7 @@ class Connection(_http.JSONConnection):
 
     API_URL_TEMPLATE = '{api_base_url}/dns/{api_version}{path}'
     """A template for the URL of a particular API call."""
+
+    _EXTRA_HEADERS = {
+        _http.CLIENT_INFO_HEADER: _CLIENT_INFO,
+    }

dns/unit_tests/test__http.py

@@ -14,6 +14,8 @@
 
 import unittest
 
+import mock
+
 
 class TestConnection(unittest.TestCase):
 
@@ -48,3 +50,33 @@ def test_build_api_url_w_extra_query_params(self):
                          '/'.join(['', 'dns', conn.API_VERSION, 'foo']))
         parms = dict(parse_qsl(qs))
         self.assertEqual(parms['bar'], 'baz')
+
+    def test_extra_headers(self):
+        from google.cloud import _http as base_http
+        from google.cloud.dns 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,
+        )

error_reporting/google/cloud/error_reporting/__init__.py

@@ -15,6 +15,9 @@
 """Client library for Stackdriver Error Reporting"""
 
 
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-error-reporting').version
+
 from google.cloud.error_reporting.client import Client
 from google.cloud.error_reporting.client import HTTPContext
 from google.cloud.error_reporting.util import build_flask_context

language/google/cloud/language/__init__.py

@@ -15,6 +15,9 @@
 """Client library for Google Cloud Natural Language API."""
 
 
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-language').version
+
 from google.cloud.language.client import Client
 from google.cloud.language.document import Document
 from google.cloud.language.document import Encoding