Merge pull request #2167 from daspecster/vision-connection

Add Vision API connection.

docs/index.rst

@@ -147,6 +147,7 @@
   :caption: Vision
 
   vision-usage
+  vision-client
 
 .. toctree::
   :maxdepth: 0

docs/json/json/master/toc.json

@@ -465,6 +465,15 @@
                 "title": "Util"
             }
     ]
-  }
+}, {
+    "title": "Vision",
+    "type": "gcloud/vision",
+    "nav": [
+        {
+            "type": "gcloud/vision/connection/connection",
+            "title": "Connection"
+        }
+    ]
+}
  ]
 }

docs/vision-client.rst

@@ -0,0 +1,10 @@
+Vision Client
+================
+
+Connection
+~~~~~~~~~~
+
+.. automodule:: gcloud.vision.connection
+  :members:
+  :undoc-members:
+  :show-inheritance:

gcloud/vision/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Google Cloud Vision API package."""

gcloud/vision/connection.py

@@ -0,0 +1,47 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""Create / interact with gcloud Vision connections."""
+
+
+from gcloud import connection as base_connection
+
+
+class Connection(base_connection.JSONConnection):
+    """A connection to Google Cloud Vision via the JSON REST API.
+
+    :type credentials: :class:`oauth2client.client.OAuth2Credentials`
+    :param credentials: (Optional) The OAuth2 Credentials to use for this
+                        connection.
+
+    :type http: :class:`httplib2.Http` or class that defines ``request()``.
+    :param http: (Optional) HTTP object to make requests.
+
+    :type api_base_url: string
+    :param api_base_url: The base of the API call URL. Defaults to the value
+                         :attr:`Connection.API_BASE_URL`.
+    """
+
+    API_BASE_URL = 'https://vision.googleapis.com'
+    """The base of the API call URL."""
+
+    API_VERSION = 'v1'
+    """The version of the API, used in building the API call's URL."""
+
+    API_URL_TEMPLATE = '{api_base_url}/{api_version}{path}'
+    """A template for the URL of a particular API call."""
+
+    SCOPE = ('https://www.googleapis.com/auth/cloud-platform',)
+    """The scopes required for authenticating as a Cloud Vision consumer."""

gcloud/vision/test_connection.py

@@ -0,0 +1,44 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import unittest
+
+
+class TestConnection(unittest.TestCase):
+
+    def _getTargetClass(self):
+        from gcloud.vision.connection import Connection
+        return Connection
+
+    def _makeOne(self, *args, **kw):
+        return self._getTargetClass()(*args, **kw)
+
+    def test_default_url(self):
+        creds = _Credentials()
+        conn = self._makeOne(creds)
+        klass = self._getTargetClass()
+        self.assertEqual(conn.credentials._scopes, klass.SCOPE)
+
+
+class _Credentials(object):
+
+    _scopes = None
+
+    @staticmethod
+    def create_scoped_required():
+        return True
+
+    def create_scoped(self, scope):
+        self._scopes = scope
+        return self

scripts/generate_json_docs.py

@@ -631,6 +631,7 @@ def main():
             'storage': [],
             'streaming': [],
             'translate': [],
+            'vision': [],
         }
     }
 

scripts/verify_included_modules.py

@@ -53,6 +53,7 @@
     'gcloud.streaming.transfer',
     'gcloud.streaming.util',
     'gcloud.translate.__init__',
+    'gcloud.vision.__init__',
 ])