# Copyright 2017 AT&T Intellectual Property.
# 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.
from deckhand.client import base
[docs]class Revision(base.Resource):
def __repr__(self):
# List revision documents.
if hasattr(self, 'metadata') and hasattr(self, 'schema'):
return "<Document [%s] %s>" % (self.schema, self.metadata['name'])
# List revisions.
elif hasattr(self, 'results'):
return ', '.join(
["<Revision ID: %s>" % x['id'] for x in self.results])
# Show revision.
elif hasattr(self, 'id'):
return "<Revision ID: %s>" % base.getid(self)
# All options expired. Revision diff.
else:
return "<Revision Diff: %s>" % ', '.join(
x for x in self.to_dict())
[docs]class RevisionManager(base.Manager):
"""Manage :class:`Revision` resources."""
resource_class = Revision
[docs] def list(self, **filters):
"""Get a list of revisions."""
url = '/revisions'
# Call `_get` instead of `_list` because the response from the server
# is a dict of form `{"count": n, "results": []}`.
return self._get(url, filters=filters)
[docs] def get(self, revision_id):
"""Get details for a revision."""
url = '/revisions/%s' % revision_id
return self._get(url)
[docs] def diff(self, revision_id, comparison_revision_id):
"""Get revision diff between two revisions."""
url = '/revisions/%s/diff/%s' % (
revision_id, comparison_revision_id)
return self._get(url)
[docs] def deepdiff(self, revision_id, comparison_revision_id):
"""Get revision deepdiff between two revisions."""
url = '/revisions/%s/deepdiff/%s' % (
revision_id, comparison_revision_id)
return self._get(url)
[docs] def rollback(self, revision_id):
"""Rollback to a previous revision, effectively creating a new one."""
url = '/rollback/%s' % revision_id
return self._post(url)
[docs] def documents(self, revision_id, rendered=True, **filters):
"""Get a list of revision documents or rendered documents.
:param int revision_id: Revision ID.
:param bool rendered: If True, returns list of rendered documents.
Else returns list of unmodified, raw documents.
:param filters: Filters to apply to response body.
:returns: List of documents or rendered documents.
:rtype: list[:class:`Revision`]
"""
if rendered:
url = '/revisions/%s/rendered-documents' % revision_id
else:
url = '/revisions/%s/documents' % revision_id
return self._list(url, filters=filters)
[docs] def delete_all(self):
"""Delete all revisions.
.. warning::
Effectively the same as purging the entire database.
"""
url = '/revisions'
return self._delete(url)