Fully removing connection module.

In the process, moving make_stub and MetadataTransformer
into _helpers module.

docs/index.rst

@@ -154,7 +154,6 @@ Documented Modules
 .. toctree::
    :maxdepth: 2
 
-   base-connection
    data-connection
    client
    cluster

gcloud_bigtable/_grpc_mocks.py

@@ -100,7 +100,7 @@ def __call__(self, *args, **kwargs):
 class GRPCMockTestMixin(unittest2.TestCase):
     """Mix-in to allow easy mocking for gRPC methods.
 
-    Expects :func:`gcloud_bigtable.connection.make_stub` to be used
+    Expects :func:`gcloud_bigtable._helpers.make_stub` to be used
     for making API calls.
 
     Also expects that :meth:`setUpClass` will be called and the following

gcloud_bigtable/_helpers.py

@@ -44,6 +44,28 @@
 # See https://gist.github.com/dhermes/bbc5b7be1932bfffae77
 # for appropriate values on other systems.
 SSL_CERT_FILE = '/etc/ssl/certs/ca-certificates.crt'
+TIMEOUT_SECONDS = 10
+USER_AGENT = 'gcloud-bigtable-python'
+
+
+class MetadataTransformer(object):
+    """Callable class to transform metadata for gRPC requests.
+
+    :type credentials: :class:`oauth2client.client.OAuth2Credentials`
+    :param credentials: The OAuth2 Credentials to use for access tokens
+                        to authorize requests.
+    """
+
+    def __init__(self, credentials):
+        self._credentials = credentials
+
+    def __call__(self, ignored_val):
+        """Adds authorization header to request metadata."""
+        access_token = self._credentials.get_access_token().access_token
+        return [
+            ('Authorization', 'Bearer ' + access_token),
+            ('User-agent', USER_AGENT),
+        ]
 
 
 class AuthInfo(object):
@@ -184,3 +206,31 @@ def get_certs():
     """
     set_certs(reset=False)
     return AuthInfo.ROOT_CERTIFICATES
+
+
+def make_stub(credentials, stub_factory, host, port):
+    """Makes a stub for the an API.
+
+    :type credentials: :class:`oauth2client.client.OAuth2Credentials`
+    :param credentials: The OAuth2 Credentials to use for access tokens
+                        to authorize requests.
+
+    :type stub_factory: callable
+    :param stub_factory: A factory which will create a gRPC stub for
+                         a given service.
+
+    :type host: string
+    :param host: The host for the service.
+
+    :type port: integer
+    :param port: The port for the service.
+
+    :rtype: :class:`grpc.early_adopter.implementations._Stub`
+    :returns: The stub object used to make gRPC requests to the
+              Data API.
+    """
+    custom_metadata_transformer = MetadataTransformer(credentials)
+    return stub_factory(host, port,
+                        metadata_transformer=custom_metadata_transformer,
+                        secure=True,
+                        root_certificates=get_certs())

gcloud_bigtable/client.py

@@ -39,12 +39,12 @@
 from gcloud_bigtable._generated import bigtable_cluster_data_pb2 as data_pb2
 from gcloud_bigtable._generated import (
     bigtable_cluster_service_messages_pb2 as messages_pb2)
+from gcloud_bigtable._helpers import TIMEOUT_SECONDS
+from gcloud_bigtable._helpers import make_stub
 from gcloud_bigtable.cluster import Cluster
 from gcloud_bigtable.cluster import CLUSTER_ADMIN_PORT
 from gcloud_bigtable.cluster import CLUSTER_ADMIN_HOST
 from gcloud_bigtable.cluster import CLUSTER_STUB_FACTORY
-from gcloud_bigtable.connection import TIMEOUT_SECONDS
-from gcloud_bigtable.connection import make_stub
 
 
 ADMIN_SCOPE = 'https://www.googleapis.com/auth/cloud-bigtable.admin'

gcloud_bigtable/cluster.py

@@ -24,11 +24,11 @@
 from gcloud_bigtable._generated import (
     bigtable_table_service_messages_pb2 as table_messages_pb2)
 from gcloud_bigtable._generated import operations_pb2
+from gcloud_bigtable._helpers import TIMEOUT_SECONDS
 from gcloud_bigtable._helpers import _parse_pb_any_to_native
 from gcloud_bigtable._helpers import _pb_timestamp_to_datetime
 from gcloud_bigtable._helpers import _require_pb_property
-from gcloud_bigtable.connection import TIMEOUT_SECONDS
-from gcloud_bigtable.connection import make_stub
+from gcloud_bigtable._helpers import make_stub
 from gcloud_bigtable.table import TABLE_ADMIN_HOST
 from gcloud_bigtable.table import TABLE_ADMIN_PORT
 from gcloud_bigtable.table import TABLE_STUB_FACTORY

gcloud_bigtable/data_connection.py

@@ -18,8 +18,8 @@
 from gcloud_bigtable._generated import bigtable_service_pb2
 from gcloud_bigtable._generated import (
     bigtable_service_messages_pb2 as messages_pb2)
-from gcloud_bigtable.connection import TIMEOUT_SECONDS
-from gcloud_bigtable.connection import make_stub
+from gcloud_bigtable._helpers import TIMEOUT_SECONDS
+from gcloud_bigtable._helpers import make_stub
 
 
 DATA_STUB_FACTORY = (bigtable_service_pb2.

gcloud_bigtable/table.py

@@ -19,9 +19,9 @@
 from gcloud_bigtable._generated import (
     bigtable_table_service_messages_pb2 as messages_pb2)
 from gcloud_bigtable._generated import bigtable_table_service_pb2
+from gcloud_bigtable._helpers import TIMEOUT_SECONDS
 from gcloud_bigtable._helpers import _timedelta_to_duration_pb
-from gcloud_bigtable.connection import TIMEOUT_SECONDS
-from gcloud_bigtable.connection import make_stub
+from gcloud_bigtable._helpers import make_stub
 
 
 TABLE_STUB_FACTORY = (bigtable_table_service_pb2.

gcloud_bigtable/test__helpers.py

@@ -16,6 +16,43 @@
 import unittest2
 
 
+class TestMetadataTransformer(unittest2.TestCase):
+
+    def _getTargetClass(self):
+        from gcloud_bigtable._helpers import MetadataTransformer
+        return MetadataTransformer
+
+    def _makeOne(self, *args, **kwargs):
+        return self._getTargetClass()(*args, **kwargs)
+
+    def test_constructor(self):
+        from gcloud_bigtable._testing import _MockWithAttachedMethods
+        credentials = _MockWithAttachedMethods()
+        transformer = self._makeOne(credentials)
+        self.assertTrue(transformer._credentials is credentials)
+        self.assertEqual(credentials._called, [])
+
+    def test___call__(self):
+        from gcloud_bigtable._testing import _MockWithAttachedMethods
+        from gcloud_bigtable._helpers import USER_AGENT
+
+        access_token_expected = 'FOOBARBAZ'
+
+        class _ReturnVal(object):
+            access_token = access_token_expected
+
+        credentials = _MockWithAttachedMethods(_ReturnVal)
+        transformer = self._makeOne(credentials)
+        result = transformer(None)
+        self.assertEqual(
+            result,
+            [
+                ('Authorization', 'Bearer ' + access_token_expected),
+                ('User-agent', USER_AGENT),
+            ])
+        self.assertEqual(credentials._called, [('get_access_token', (), {})])
+
+
 class Test__pb_timestamp_to_datetime(unittest2.TestCase):
 
     def _callFUT(self, timestamp):
@@ -275,3 +312,42 @@ class _AuthInfo(object):
 
         self.assertEqual(call_kwargs, [{'reset': False}])
         self.assertTrue(result is return_val)
+
+
+class Test_make_stub(unittest2.TestCase):
+
+    def _callFUT(self, credentials, stub_factory, host, port):
+        from gcloud_bigtable._helpers import make_stub
+        return make_stub(credentials, stub_factory, host, port)
+
+    def test_it(self):
+        from gcloud_bigtable._testing import _MockCalled
+        from gcloud_bigtable._testing import _MockWithAttachedMethods
+        from gcloud_bigtable._testing import _Monkey
+        from gcloud_bigtable import _helpers as MUT
+
+        mock_result = object()
+        custom_factory = _MockCalled(mock_result)
+        transformed = object()
+        transformer = _MockCalled(transformed)
+
+        host = 'HOST'
+        port = 1025
+        certs = 'FOOBAR'
+        credentials = _MockWithAttachedMethods()
+        with _Monkey(MUT, get_certs=lambda: certs,
+                     MetadataTransformer=transformer):
+            result = self._callFUT(credentials, custom_factory, host, port)
+
+        self.assertTrue(result is mock_result)
+        custom_factory.check_called(
+            self,
+            [(host, port)],
+            [{
+                'metadata_transformer': transformed,
+                'secure': True,
+                'root_certificates': certs,
+            }],
+        )
+        transformer.check_called(self, [(credentials,)])
+        self.assertEqual(credentials._called, [])