04fbabadc0
This client will be used to communicate with builder service from solum. Generalize KeystoneAuthPlugin so that it can be used by both solumclient and builder client. Fixed a bug in solumclient/common/base.py Change-Id: I86630f40b32c6fcada5aa292fae8e36cecab9908
118 lines
3.9 KiB
Python
118 lines
3.9 KiB
Python
# Copyright 2013 - Noorul Islam K M
|
|
#
|
|
# 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.
|
|
|
|
from solumclient.openstack.common.apiclient import base
|
|
from solumclient.openstack.common.py3kcompat import urlutils
|
|
|
|
|
|
class ManagerMixin():
|
|
def _get(self, url, response_key=None):
|
|
"""Get an object from collection.
|
|
|
|
:param url: a partial URL, e.g., '/servers'
|
|
:param response_key: the key to be looked up in response dictionary,
|
|
e.g., 'server'
|
|
"""
|
|
body = self.client.get(url).json()
|
|
|
|
if response_key is None:
|
|
data = body
|
|
else:
|
|
data = body[response_key]
|
|
|
|
return self.resource_class(self, data, loaded=True)
|
|
|
|
def _list(self, url, response_key=None, obj_class=None, json=None):
|
|
"""List the collection.
|
|
|
|
:param url: a partial URL, e.g., '/servers'
|
|
:param response_key: the key to be looked up in response dictionary,
|
|
e.g., 'servers'
|
|
:param obj_class: class for constructing the returned objects
|
|
(self.resource_class will be used by default)
|
|
:param json: data that will be encoded as JSON and passed in POST
|
|
request (GET will be sent by default)
|
|
"""
|
|
if json:
|
|
body = self.client.post(url, json=json).json()
|
|
else:
|
|
body = self.client.get(url).json()
|
|
|
|
if obj_class is None:
|
|
obj_class = self.resource_class
|
|
|
|
if response_key is None:
|
|
data = body
|
|
else:
|
|
data = body[response_key]
|
|
# NOTE(ja): keystone returns values as list as {'values': [ ... ]}
|
|
# unlike other services which just return the list...
|
|
try:
|
|
data = data['values']
|
|
except (KeyError, TypeError):
|
|
pass
|
|
|
|
return [obj_class(self, res, loaded=True) for res in data if res]
|
|
|
|
def _post(self, url, json, response_key=None, return_raw=False):
|
|
"""Create an object.
|
|
|
|
:param url: a partial URL, e.g., '/servers'
|
|
:param json: data that will be encoded as JSON and passed in POST
|
|
request (GET will be sent by default)
|
|
:param response_key: the key to be looked up in response dictionary,
|
|
e.g., 'servers'
|
|
:param return_raw: flag to force returning raw JSON instead of
|
|
Python object of self.resource_class
|
|
"""
|
|
body = self.client.post(url, json=json).json()
|
|
|
|
if response_key is None:
|
|
data = body
|
|
else:
|
|
data = body[response_key]
|
|
|
|
if return_raw:
|
|
return data
|
|
return self.resource_class(self, data)
|
|
|
|
|
|
class BaseManager(ManagerMixin, base.BaseManager):
|
|
pass
|
|
|
|
|
|
class CrudManager(ManagerMixin, base.CrudManager):
|
|
def list(self, base_url=None, **kwargs):
|
|
"""List the collection.
|
|
|
|
:param base_url: if provided, the generated URL will be appended to it
|
|
"""
|
|
kwargs = self._filter_kwargs(kwargs)
|
|
|
|
return self._list(
|
|
'%(base_url)s%(query)s' % {
|
|
'base_url': self.build_url(base_url=base_url, **kwargs),
|
|
'query': '?%s' % urlutils.urlencode(kwargs) if kwargs else '',
|
|
})
|
|
|
|
def get(self, **kwargs):
|
|
kwargs = self._filter_kwargs(kwargs)
|
|
return self._get(
|
|
self.build_url(**kwargs))
|
|
|
|
def create(self, **kwargs):
|
|
kwargs = self._filter_kwargs(kwargs)
|
|
return self._post(
|
|
self.build_url(**kwargs), kwargs)
|