Add 'Client.{publisher,subscriber,iam_policy}_api' properties.

These API objects will represent logical groupings of the JSON api
endpoints, and correspond one-for-one to the stubs exposed by the
generated gRPC code.

Further commits will move the endpoint-specific methods from the
'Connecttion' class into the relevant API classes, and adjust the
callers.

See:

#1700 (comment)

Author: tseaver

gcloud/pubsub/client.py

@@ -17,6 +17,9 @@
 
 from gcloud.client import JSONClient
 from gcloud.pubsub.connection import Connection
+from gcloud.pubsub.connection import _PublisherAPI
+from gcloud.pubsub.connection import _SubscriberAPI
+from gcloud.pubsub.connection import _IAMPolicyAPI
 from gcloud.pubsub.subscription import Subscription
 from gcloud.pubsub.topic import Topic
 
@@ -43,6 +46,28 @@ class Client(JSONClient):
     """
 
     _connection_class = Connection
+    _publisher_api = _subscriber_api = _iam_policy_api = None
+
+    @property
+    def publisher_api(self):
+        """Helper for publisher-related API calls."""
+        if self._publisher_api is None:
+            self._publisher_api = _PublisherAPI(self.connection)
+        return self._publisher_api
+
+    @property
+    def subscriber_api(self):
+        """Helper for subscriber-related API calls."""
+        if self._subscriber_api is None:
+            self._subscriber_api = _SubscriberAPI(self.connection)
+        return self._subscriber_api
+
+    @property
+    def iam_policy_api(self):
+        """Helper for IAM policy-related API calls."""
+        if self._iam_policy_api is None:
+            self._iam_policy_api = _IAMPolicyAPI(self.connection)
+        return self._iam_policy_api
 
     def list_topics(self, page_size=None, page_token=None):
         """List topics for the project associated with this client.

gcloud/pubsub/connection.py

@@ -486,3 +486,36 @@ def subscription_modify_ack_deadline(self, subscription_path, ack_ids,
             'ackDeadlineSeconds': ack_deadline,
         }
         self.api_request(method='POST', path=path, data=data)
+
+
+class _PublisherAPI(object):
+    """Helper mapping publisher-related APIs.
+
+    :type connection: :class:`Connection`
+    :param connection: the connection used to make API requests.
+    """
+
+    def __init__(self, connection):
+        self._connection = connection
+
+
+class _SubscriberAPI(object):
+    """Helper mapping subscriber-related APIs.
+
+    :type connection: :class:`Connection`
+    :param connection: the connection used to make API requests.
+    """
+
+    def __init__(self, connection):
+        self._connection = connection
+
+
+class _IAMPolicyAPI(object):
+    """Helper mapping IAM policy-related APIs.
+
+    :type connection: :class:`Connection`
+    :param connection: the connection used to make API requests.
+    """
+
+    def __init__(self, connection):
+        self._connection = connection

gcloud/pubsub/test_client.py

@@ -29,6 +29,42 @@ def _getTargetClass(self):
     def _makeOne(self, *args, **kw):
         return self._getTargetClass()(*args, **kw)
 
+    def test_publisher_api(self):
+        from gcloud.pubsub.connection import _PublisherAPI
+        creds = _Credentials()
+        client = self._makeOne(project=self.PROJECT, credentials=creds)
+        conn = client.connection = _Connection()
+        api = client.publisher_api
+        self.assertTrue(isinstance(api, _PublisherAPI))
+        self.assertTrue(api._connection is conn)
+        # API instance is cached
+        again = client.publisher_api
+        self.assertTrue(again is api)
+
+    def test_subscriber_api(self):
+        from gcloud.pubsub.connection import _SubscriberAPI
+        creds = _Credentials()
+        client = self._makeOne(project=self.PROJECT, credentials=creds)
+        conn = client.connection = _Connection()
+        api = client.subscriber_api
+        self.assertTrue(isinstance(api, _SubscriberAPI))
+        self.assertTrue(api._connection is conn)
+        # API instance is cached
+        again = client.subscriber_api
+        self.assertTrue(again is api)
+
+    def test_iam_policy_api(self):
+        from gcloud.pubsub.connection import _IAMPolicyAPI
+        creds = _Credentials()
+        client = self._makeOne(project=self.PROJECT, credentials=creds)
+        conn = client.connection = _Connection()
+        api = client.iam_policy_api
+        self.assertTrue(isinstance(api, _IAMPolicyAPI))
+        self.assertTrue(api._connection is conn)
+        # API instance is cached
+        again = client.iam_policy_api
+        self.assertTrue(again is api)
+
     def test_list_topics_no_paging(self):
         from gcloud.pubsub.topic import Topic
         creds = _Credentials()

gcloud/pubsub/test_connection.py

@@ -751,6 +751,51 @@ def test_subscription_modify_ack_deadline(self):
         self.assertEqual(http._called_with['body'], json.dumps(BODY))
 
 
+class Test_PublisherAPI(unittest2.TestCase):
+
+    def _getTargetClass(self):
+        from gcloud.pubsub.connection import _PublisherAPI
+        return _PublisherAPI
+
+    def _makeOne(self, *args, **kw):
+        return self._getTargetClass()(*args, **kw)
+
+    def test_ctor(self):
+        connection = _Connection()
+        api = self._makeOne(connection)
+        self.assertTrue(api._connection is connection)
+
+
+class Test_SubscriberAPI(unittest2.TestCase):
+
+    def _getTargetClass(self):
+        from gcloud.pubsub.connection import _SubscriberAPI
+        return _SubscriberAPI
+
+    def _makeOne(self, *args, **kw):
+        return self._getTargetClass()(*args, **kw)
+
+    def test_ctor(self):
+        connection = _Connection()
+        api = self._makeOne(connection)
+        self.assertTrue(api._connection is connection)
+
+
+class Test_IAMPolicyAPI(unittest2.TestCase):
+
+    def _getTargetClass(self):
+        from gcloud.pubsub.connection import _IAMPolicyAPI
+        return _IAMPolicyAPI
+
+    def _makeOne(self, *args, **kw):
+        return self._getTargetClass()(*args, **kw)
+
+    def test_ctor(self):
+        connection = _Connection()
+        api = self._makeOne(connection)
+        self.assertTrue(api._connection is connection)
+
+
 class _Http(object):
 
     _called_with = None
@@ -763,3 +808,11 @@ def __init__(self, headers, content):
     def request(self, **kw):
         self._called_with = kw
         return self._response, self._content
+
+
+class _Connection(object):
+
+    _called_with = None
+
+    def __init__(self, *responses):
+        self._responses = responses