aboutsummaryrefslogtreecommitdiffstats
path: root/moon_manager/moon_manager/api/meta_data.py
blob: 104f26bed642fa1a1c36620ae04df79663f7bf47 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
# This software is distributed under the terms and conditions of the 'Apache-2.0'
# license which can be found in the file 'LICENSE' in this package distribution
# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
"""
Meta Data are elements used to create Meta data (skeleton of security policies)

"""

from flask import request
from flask_restful import Resource
import logging
from python_moonutilities.security_functions import check_auth
from python_moondb.core import ModelManager

__version__ = "4.3.2"

logger = logging.getLogger("moon.manager.api." + __name__)


class SubjectCategories(Resource):
    """
    Endpoint for subject categories requests
    """

    __urls__ = (
        "/subject_categories",
        "/subject_categories/",
        "/subject_categories/<string:category_id>",
    )

    @check_auth
    def get(self, category_id=None, user_id=None):
        """Retrieve all subject categories or a specific one

        :param category_id: uuid of the subject category
        :param user_id: user ID who do the request
        :return: {
            "subject_category_id": {
                "name": "name of the category",
                "description": "description of the category (optional)"
            }
        }
        :internal_api: get_subject_categories
        """
        try:
            data = ModelManager.get_subject_categories(
                user_id=user_id, category_id=category_id)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"subject_categories": data}

    @check_auth
    def post(self, category_id=None, user_id=None):
        """Create or update a subject category.

        :param category_id: must not be used here
        :param user_id: user ID who do the request
        :request body: {
            "name": "name of the category",
            "description": "description of the category (optional)"
        }
        :return: {
            "subject_category_id": {
                "name": "name of the category",
                "description": "description of the category (optional)"
            }
        }
        :internal_api: add_subject_category
        """
        try:
            data = ModelManager.add_subject_category(
                user_id=user_id, value=request.json)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"subject_categories": data}

    @check_auth
    def delete(self, category_id=None, user_id=None):
        """Delete a subject category

        :param category_id: uuid of the subject category to delete
        :param user_id: user ID who do the request
        :return: {
            "result": "True or False",
            "message": "optional message (optional)"
        }
        :internal_api: delete_subject_category
        """
        try:
            data = ModelManager.delete_subject_category(
                user_id=user_id, category_id=category_id)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"result": True}


class ObjectCategories(Resource):
    """
    Endpoint for object categories requests
    """

    __urls__ = (
        "/object_categories",
        "/object_categories/",
        "/object_categories/<string:category_id>",
    )

    @check_auth
    def get(self, category_id=None, user_id=None):
        """Retrieve all object categories or a specific one

        :param category_id: uuid of the object category
        :param user_id: user ID who do the request
        :return: {
            "object_category_id": {
                "name": "name of the category",
                "description": "description of the category (optional)"
            }
        }
        :internal_api: get_object_categories
        """
        try:
            data = ModelManager.get_object_categories(
                user_id=user_id, category_id=category_id)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"object_categories": data}

    @check_auth
    def post(self, category_id=None, user_id=None):
        """Create or update a object category.

        :param category_id: must not be used here
        :param user_id: user ID who do the request
        :request body: {
            "name": "name of the category",
            "description": "description of the category (optional)"
        }
        :return: {
            "object_category_id": {
                "name": "name of the category",
                "description": "description of the category (optional)"
            }
        }
        :internal_api: add_object_category
        """
        try:
            data = ModelManager.add_object_category(
                user_id=user_id, value=request.json)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"object_categories": data}

    @check_auth
    def delete(self, category_id=None, user_id=None):
        """Delete an object category

        :param category_id: uuid of the object category to delete
        :param user_id: user ID who do the request
        :return: {
            "result": "True or False",
            "message": "optional message (optional)"
        }
        :internal_api: delete_object_category
        """
        try:
            data = ModelManager.delete_object_category(
                user_id=user_id, category_id=category_id)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"result": True}


class ActionCategories(Resource):
    """
    Endpoint for action categories requests
    """

    __urls__ = (
        "/action_categories",
        "/action_categories/",
        "/action_categories/<string:category_id>",
    )

    @check_auth
    def get(self, category_id=None, user_id=None):
        """Retrieve all action categories or a specific one

        :param category_id: uuid of the action category
        :param user_id: user ID who do the request
        :return: {
            "action_category_id": {
                "name": "name of the category",
                "description": "description of the category (optional)"
            }
        }
        :internal_api: get_action_categories
        """
        try:
            data = ModelManager.get_action_categories(
                user_id=user_id, category_id=category_id)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"action_categories": data}

    @check_auth
    def post(self, category_id=None, user_id=None):
        """Create or update an action category.

        :param category_id: must not be used here
        :param user_id: user ID who do the request
        :request body: {
            "name": "name of the category",
            "description": "description of the category (optional)"
        }
        :return: {
            "action_category_id": {
                "name": "name of the category",
                "description": "description of the category (optional)"
            }
        }
        :internal_api: add_action_category
        """
        try:
            data = ModelManager.add_action_category(
                user_id=user_id, value=request.json)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"action_categories": data}

    @check_auth
    def delete(self, category_id=None, user_id=None):
        """Delete an action

        :param category_id: uuid of the action category to delete
        :param user_id: user ID who do the request
        :return: {
            "result": "True or False",
            "message": "optional message (optional)"
        }
        :internal_api: delete_action_category
        """
        try:
            data = ModelManager.delete_action_category(
                user_id=user_id, category_id=category_id)
        except Exception as e:
            logger.error(e, exc_info=True)
            return {"result": False,
                    "error": str(e)}, 500
        return {"result": True}