summaryrefslogtreecommitdiff
path: root/barbicanclient/base.py
blob: 9bfcc980af22c867ee419deccc313b51a3bd491f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# Copyright (c) 2013 Rackspace, 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.
"""
Base utilities to build API operation managers.
"""
import uuid


def filter_null_keys(dictionary):
    return dict(((k, v) for k, v in dictionary.items() if v is not None))


def censored_copy(data_dict, censor_keys):
    '''Returns redacted dict copy for censored keys'''
    if censor_keys is None:
        censor_keys = []
    return {k: v if k not in censor_keys else '<redacted>' for k, v in
            data_dict.items()}


def validate_ref(ref, entity):
    """Verifies that there is a real uuid at the end of the uri

    :return: Returns True for easier testing
    :raises ValueError: If it cannot correctly parse the uuid in the ref.
    """
    try:
        _, entity_uuid = ref.rstrip('/').rsplit('/', 1)
        uuid.UUID(entity_uuid)
    except Exception:
        raise ValueError('{0} incorrectly specified.'.format(entity))

    return True


class ImmutableException(Exception):
    def __init__(self, attribute=None):
        message = "This object is immutable!"
        super(ImmutableException, self).__init__(message)


class BaseEntityManager(object):
    def __init__(self, api, entity):
        self._api = api
        self._entity = entity

    def total(self):
        """Returns the total number of entities stored in Barbican."""
        params = {'limit': 0, 'offset': 0}
        resp = self._api.get(self._entity, params=params)

        return resp['total']