Marshmallowing roles (#313)

lemur/roles/models.py

@@ -26,4 +26,4 @@ class Role(db.Model):
     description = Column(Text)
     authority_id = Column(Integer, ForeignKey('authorities.id'))
     user_id = Column(Integer, ForeignKey('users.id'))
-    users = relationship("User", secondary=roles_users, passive_deletes=True, backref="role", cascade='all,delete')
+    users = relationship("User", secondary=roles_users, viewonly=True, backref="role")

lemur/roles/schemas.py

@@ -0,0 +1,34 @@
+"""
+.. module: lemur.roles.schemas
+    :platform: unix
+    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
+    :license: Apache, see LICENSE for more details.
+.. moduleauthor:: Kevin Glisson <kglisson@netflix.com>
+"""
+from marshmallow import fields
+from lemur.common.schema import LemurInputSchema, LemurOutputSchema
+from lemur.schemas import AssociatedUserSchema, AssociatedAuthoritySchema
+
+
+class RoleInputSchema(LemurInputSchema):
+    name = fields.String(required=True)
+    username = fields.String()
+    password = fields.String()
+    description = fields.String()
+    authorities = fields.Nested(AssociatedAuthoritySchema, many=True)
+    users = fields.Nested(AssociatedUserSchema, many=True)
+
+
+class RoleOutputSchema(LemurOutputSchema):
+    name = fields.String()
+    username = fields.String()
+    password = fields.String()
+    description = fields.String()
+    authorities = fields.Nested(AssociatedAuthoritySchema, many=True)
+    users = fields.Nested(AssociatedUserSchema, many=True)
+    users = fields.Nested(AssociatedUserSchema, many=True)
+
+
+role_input_schema = RoleInputSchema()
+role_output_schema = RoleOutputSchema()
+roles_output_schema = RoleOutputSchema(many=True)

lemur/roles/service.py

@@ -92,10 +92,6 @@ def render(args):
     :return:
     """
     query = database.session_query(Role)
-    sort_by = args.pop('sort_by')
-    sort_dir = args.pop('sort_dir')
-    page = args.pop('page')
-    count = args.pop('count')
     filt = args.pop('filter')
     user_id = args.pop('user_id', None)
     authority_id = args.pop('authority_id', None)
@@ -117,9 +113,4 @@ def render(args):
         terms = filt.split(';')
         query = database.filter(query, Role, terms)
 
-    query = database.find_all(query, Role, args)
-
-    if sort_by and sort_dir:
-        query = database.sort(query, Role, sort_by, sort_dir)
-
-    return database.paginate(query, page, count)
+    database.sort_and_page(query, Role, args)

lemur/roles/views.py

@@ -9,32 +9,28 @@
 """
 from flask import Blueprint
 from flask import make_response, jsonify, abort, g
-from flask.ext.restful import reqparse, fields, Api
+from flask.ext.restful import reqparse, Api
 
 from lemur.roles import service
 from lemur.auth.service import AuthenticatedResource
 from lemur.auth.permissions import ViewRoleCredentialsPermission, admin_permission
-from lemur.common.utils import marshal_items, paginated_parser
+from lemur.common.utils import paginated_parser
+
+from lemur.common.schema import validate_schema
+from lemur.roles.schemas import role_input_schema, role_output_schema, roles_output_schema
 
 
 mod = Blueprint('roles', __name__)
 api = Api(mod)
 
 
-FIELDS = {
-    'name': fields.String,
-    'description': fields.String,
-    'id': fields.Integer,
-}
-
-
 class RolesList(AuthenticatedResource):
     """ Defines the 'roles' endpoint """
     def __init__(self):
         self.reqparse = reqparse.RequestParser()
         super(RolesList, self).__init__()
 
-    @marshal_items(FIELDS)
+    @validate_schema(None, role_output_schema)
     def get(self):
         """
         .. http:get:: /roles
@@ -90,8 +86,8 @@ class RolesList(AuthenticatedResource):
         return service.render(args)
 
     @admin_permission.require(http_exception=403)
-    @marshal_items(FIELDS)
-    def post(self):
+    @validate_schema(role_input_schema, role_output_schema)
+    def post(self, data=None):
         """
         .. http:post:: /roles
 
@@ -136,15 +132,8 @@ class RolesList(AuthenticatedResource):
            :statuscode 200: no error
            :statuscode 403: unauthenticated
         """
-        self.reqparse.add_argument('name', type=str, location='json', required=True)
-        self.reqparse.add_argument('description', type=str, location='json')
-        self.reqparse.add_argument('username', type=str, location='json')
-        self.reqparse.add_argument('password', type=str, location='json')
-        self.reqparse.add_argument('users', type=list, location='json')
-
-        args = self.reqparse.parse_args()
-        return service.create(args['name'], args.get('password'), args.get('description'), args.get('username'),
-                              args.get('users'))
+        return service.create(data['name'], data.get('password'), data.get('description'), data.get('username'),
+                              data.get('users'))
 
 
 class RoleViewCredentials(AuthenticatedResource):
@@ -197,7 +186,7 @@ class Roles(AuthenticatedResource):
         self.reqparse = reqparse.RequestParser()
         super(Roles, self).__init__()
 
-    @marshal_items(FIELDS)
+    @validate_schema(None, role_output_schema)
     def get(self, role_id):
         """
         .. http:get:: /roles/1
@@ -238,8 +227,8 @@ class Roles(AuthenticatedResource):
 
         return service.get(role_id)
 
-    @marshal_items(FIELDS)
-    def put(self, role_id):
+    @validate_schema(role_input_schema, role_output_schema)
+    def put(self, role_id, data=None):
         """
         .. http:put:: /roles/1
 
@@ -278,11 +267,7 @@ class Roles(AuthenticatedResource):
         """
         permission = ViewRoleCredentialsPermission(role_id)
         if permission.can():
-            self.reqparse.add_argument('name', type=str, location='json', required=True)
-            self.reqparse.add_argument('description', type=str, location='json')
-            self.reqparse.add_argument('users', type=list, location='json')
-            args = self.reqparse.parse_args()
-            return service.update(role_id, args['name'], args.get('description'), args.get('users'))
+            return service.update(role_id, data['name'], data.get('description'), data.get('users'))
         abort(403)
 
     @admin_permission.require(http_exception=403)
@@ -326,7 +311,7 @@ class UserRolesList(AuthenticatedResource):
         self.reqparse = reqparse.RequestParser()
         super(UserRolesList, self).__init__()
 
-    @marshal_items(FIELDS)
+    @validate_schema(None, roles_output_schema)
     def get(self, user_id):
         """
         .. http:get:: /users/1/roles
@@ -385,7 +370,7 @@ class AuthorityRolesList(AuthenticatedResource):
         self.reqparse = reqparse.RequestParser()
         super(AuthorityRolesList, self).__init__()
 
-    @marshal_items(FIELDS)
+    @validate_schema(None, roles_output_schema)
     def get(self, authority_id):
         """
         .. http:get:: /authorities/1/roles