b15de49a4d
This patch introduces validation through jsonschema instead of using a custom format. In order for other API versions to extend this, this patch implements a base API under transport.api that should be extended for every API version. An example of this can be found in test_api.py, future patches will have more realistic examples and extensions of this class. The patch also moves api.py under v1/ since Api definitions are version specific. Partially-Implements blueprint python-marconiclient-v1 Change-Id: Ie7eacc63deeacb67edfada6ceb5c4956c5adc0b0
87 lines
2.6 KiB
Python
87 lines
2.6 KiB
Python
# Copyright (c) 2013 Rackspace, Inc.
|
|
# Copyright (c) 2013 Red Hat, Inc.
|
|
#
|
|
# 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 json
|
|
|
|
from marconiclient import auth
|
|
|
|
|
|
def prepare_request(conf, data=None):
|
|
"""Prepares a request
|
|
|
|
This method takes care of authentication
|
|
and all other steps in the preparation chain.
|
|
|
|
The request returned by this call is ready to
|
|
be sent to the server.
|
|
|
|
:param conf: `cfg.ConfigOpts` instance to use.
|
|
:type conf: `cfg.ConfigOpts`
|
|
:param data: Optional data to send along with the
|
|
request. If data is not None, it'll be serialized.
|
|
:type data: Any primitive type that is json-serializable.
|
|
|
|
:returns: A `Request` instance ready to be sent.
|
|
:rtype: `Request`
|
|
"""
|
|
|
|
req = Request()
|
|
auth_backend = auth.get_backend(conf)
|
|
# TODO(flaper87): Do something smarter
|
|
# to get the api_version.
|
|
req = auth_backend.authenticate(1, req)
|
|
|
|
if data is not None:
|
|
req.content = json.dumps(data)
|
|
return req
|
|
|
|
|
|
class Request(object):
|
|
"""General data for a Marconi request
|
|
|
|
The idea is to be declarative i.e. specify *what* is desired. It's up to
|
|
the respective transport to turn this into a layer-specific request.
|
|
|
|
*NOTE:* This implementation is not definitive and may change.
|
|
|
|
:param endpoint: Server's endpoint
|
|
:type endpoint: str
|
|
:param operation: Operation to issue on the endpoint, i.e:
|
|
- get_queues
|
|
- get_messages
|
|
:type operation: str
|
|
:param content: Request's body. Default: None
|
|
:type content: str
|
|
:param params: Query string params. Default: None
|
|
:type params: dict
|
|
:param headers: Request headers. Default: None
|
|
:type headers: dict
|
|
"""
|
|
|
|
def __init__(self, endpoint='', operation='',
|
|
content=None, params=None,
|
|
headers=None, api=None):
|
|
self.api = api
|
|
self.endpoint = endpoint
|
|
self.operation = operation
|
|
self.content = content
|
|
self.params = params or {}
|
|
self.headers = headers or {}
|
|
|
|
def validate(self):
|
|
return self.api.validate(params=self.params,
|
|
content=self.content)
|