Merge pull request #1164 from tseaver/search-client

Add search connection / client

Author: tseaver

gcloud/search/__init__.py

@@ -0,0 +1,21 @@
+# Copyright 2015 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 Search API wrapper."""
+
+from gcloud.search.client import Client
+from gcloud.search.connection import Connection
+
+
+SCOPE = Connection.SCOPE

gcloud/search/client.py

@@ -0,0 +1,43 @@
+# Copyright 2015 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.
+
+"""Client for interacting with the Google Cloud search API."""
+
+
+from gcloud.client import JSONClient
+from gcloud.search.connection import Connection
+
+
+class Client(JSONClient):
+ """Client to bundle configuration needed for API requests.
+
+ :type project: string
+ :param project: the project which the client acts on behalf of. Will be
+ passed when creating a zone. If not passed,
+ falls back to the default inferred from the environment.
+
+ :type credentials: :class:`oauth2client.client.OAuth2Credentials` or
+ :class:`NoneType`
+ :param credentials: The OAuth2 Credentials to use for the connection
+ owned by this client. If not passed (and if no ``http``
+ object is passed), falls back to the default inferred
+ from the environment.
+
+ :type http: :class:`httplib2.Http` or class that defines ``request()``.
+ :param http: An optional HTTP object to make requests. If not passed, an
+ ``http`` object is created that is bound to the
+ ``credentials`` for the current object.
+ """
+
+ _connection_class = Connection

gcloud/search/connection.py

@@ -0,0 +1,33 @@
+# Copyright 2015 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 search connections."""
+
+from gcloud import connection as base_connection
+
+
+class Connection(base_connection.JSONConnection):
+ """A connection to Google Cloud Search via the JSON REST API."""
+
+ API_BASE_URL = 'https://cloudsearch.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/ndev.cloudsearch',)
+ """The scopes required for authenticating as a Cloud Search consumer."""

gcloud/search/test_client.py

@@ -0,0 +1,48 @@
+# Copyright 2015 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 unittest2
+
+
+class TestClient(unittest2.TestCase):
+
+ def _getTargetClass(self):
+ from gcloud.search.client import Client
+ return Client
+
+ def _makeOne(self, *args, **kw):
+ return self._getTargetClass()(*args, **kw)
+
+ def test_ctor(self):
+ from gcloud.search.connection import Connection
+ PROJECT = 'PROJECT'
+ creds = _Credentials()
+ http = object()
+ client = self._makeOne(project=PROJECT, credentials=creds, http=http)
+ self.assertTrue(isinstance(client.connection, Connection))
+ self.assertTrue(client.connection.credentials is creds)
+ self.assertTrue(client.connection.http is http)
+
+
+class _Credentials(object):
+
+ _scopes = None
+
+ @staticmethod
+ def create_scoped_required():
+ return True
+
+ def create_scoped(self, scope):
+ self._scopes = scope
+ return self

gcloud/search/test_connection.py

@@ -0,0 +1,46 @@
+# Copyright 2015 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 unittest2
+
+
+class TestConnection(unittest2.TestCase):
+
+ def _getTargetClass(self):
+ from gcloud.search.connection import Connection
+ return Connection
+
+ def _makeOne(self, *args, **kw):
+ return self._getTargetClass()(*args, **kw)
+
+ def test_build_api_url_no_extra_query_params(self):
+ conn = self._makeOne()
+ URI = '/'.join([
+ conn.API_BASE_URL,
+ conn.API_VERSION,
+ 'foo',
+ ])
+ self.assertEqual(conn.build_api_url('/foo'), URI)
+
+ def test_build_api_url_w_extra_query_params(self):
+ from six.moves.urllib.parse import parse_qsl
+ from six.moves.urllib.parse import urlsplit
+ conn = self._makeOne()
+ uri = conn.build_api_url('/foo', {'bar': 'baz'})
+ scheme, netloc, path, qs, _ = urlsplit(uri)
+ self.assertEqual('%s://%s' % (scheme, netloc), conn.API_BASE_URL)
+ self.assertEqual(path,
+ '/'.join(['', conn.API_VERSION, 'foo']))
+ parms = dict(parse_qsl(qs))
+ self.assertEqual(parms['bar'], 'baz')