Make POST and PUT return created devices objects

app/api/resources/device.py

@@ -44,7 +44,7 @@ class DeviceResource(ProtectedResource):
     @swag_from('swagger/get_device_spec.yaml')
     def get(self, device_id):
         validate_device_ownership(device_id)
-        return DeviceSchema().dump(
+        return DeviceWithConfigurationSchema().dump(
                 devices.get_device(device_id)), 200
 
     @swag_from('swagger/delete_device_spec.yaml')
@@ -68,10 +68,9 @@ class DeviceTypeListResource(ProtectedResource):
         if g.current_account.role_id != 1:
             abort(403, message='Only admin may create device types',
                   status='error')
-        success = devices.create_device_type(
+        created_device_type = devices.create_device_type(
                 args['name'])
-        if success:
-            return '', 201
+        return DeviceTypeSchema().dump(created_device_type), 201
 
     @swag_from('swagger/get_device_types_spec.yaml')
     def get(self):
@@ -94,21 +93,20 @@ class DeviceRecordingResource(ProtectedResource):
     @swag_from('swagger/create_device_recording_spec.yaml')
     def post(self, device_id):
         validate_device_ownership(device_id)
-        success = devices.create_recording(device_id, request.json)
-        if success:
-            return '', 201
+        created_recording = devices.create_recording_and_return(
+                device_id, request.json)
+        return RecordingsSchema().dump(created_recording), 201
 
 
 class DeviceListResource(ProtectedResource):
     @use_args(DeviceSchema(), locations=('json',))
     @swag_from('swagger/create_device_spec.yaml')
     def post(self, args):
-        success = devices.create_device(
+        created_device = devices.create_device(
                 args['name'],
                 g.current_account.id,
                 args['device_type_id'])
-        if success:
-            return '', 201
+        return DeviceSchema().dump(created_device), 201
 
     @swag_from('swagger/get_devices_spec.yaml')
     def get(self):
@@ -120,9 +118,10 @@ class DeviceConfigurationResource(ProtectedResource):
     @swag_from('swagger/update_device_configuration_spec.yaml')
     def put(self, device_id):
         validate_device_ownership(device_id)
-        success = devices.set_device_configuration(device_id, request.json)
-        if success:
-            return '', 204
+        updated_device = devices.set_device_configuration(
+                device_id, request.json)
+        return DeviceWithConfigurationSchema().dump(
+                updated_device), 200
 
     @swag_from('swagger/get_device_configuration_spec.yaml')
     def get(self, device_id):

app/api/resources/swagger/create_device_recording_spec.yaml

@@ -16,4 +16,11 @@ parameters:
       $ref: '#/definitions/RecordingCreation'
 responses:
   201:
-    description: Successful creation
+    description: Success
+    schema:
+      type: object
+      required:
+        - content
+      properties:
+        content:
+            $ref: '#/definitions/Recording'

app/api/resources/swagger/create_device_spec.yaml

@@ -12,4 +12,11 @@ parameters:
         $ref: '#/definitions/DeviceCreation'
 responses:
   201:
-    description: Successful creation
+    description: Success
+    schema:
+      type: object
+      required:
+        - content
+      properties:
+        content:
+          $ref: '#/definitions/DeviceWithConfig'

app/api/resources/swagger/create_device_type_spec.yaml

@@ -12,4 +12,11 @@ parameters:
         $ref: '#/definitions/DeviceType'
 responses:
   201:
-    description: Successful creation
+    description: Success
+    schema:
+      type: object
+      required:
+        - content
+      properties:
+        content:
+          $ref: '#/definitions/DeviceType'

app/api/resources/swagger/update_device_configuration_spec.yaml

@@ -15,5 +15,12 @@ parameters:
     schema:
         type: object
 responses:
-  204:
+  200:
     description: Success
+    schema:
+      type: object
+      required:
+        - content
+      properties:
+        content:
+          $ref: '#/definitions/DeviceWithConfig'

app/devices/api.py

@@ -20,6 +20,7 @@ def create_device(name, account_id, device_type=1):
     device.save()
     device_association = DeviceAssociation(device.id, account_id)
     device_association.save()
+    return device
 
 
 def create_device_type(name):
@@ -33,6 +34,7 @@ def create_device_type(name):
     """
     device_type = DeviceType(name)
     device_type.save()
+    return device_type
 
 
 def set_device_configuration(device_id, configuration_json):
@@ -50,6 +52,7 @@ def set_device_configuration(device_id, configuration_json):
     device.configuration = configuration_json
     device.save()
     send_config.delay(device_id, str(configuration_json))
+    return device
 
 
 def get_device_configuration(device_id):
@@ -173,17 +176,16 @@ def get_device_types():
     return DeviceType.get_many()
 
 
-def create_recording(device_id, raw_json):
+def parse_raw_json_recording(device_id, json_msg):
     """
-    Tries to create recording with given parameters. Raises error on failure
+    Parses raw json recording and creates Recrding object
 
     :param device_id: Id of device
     :type device_id: int
     :param raw_json: Raw json received
     :type raw_json: json
-    :raises: ValueError if parsing fails or device does not exist
+    :raises: ValueError if parsing fails
     """
-    def parse_raw_json_recording(device_id, json_msg):
     try:
         return Recording(device_id=device_id,
                          record_type=json_msg["record_type"],
@@ -195,6 +197,36 @@ def create_recording(device_id, raw_json):
         raise ValueError("JSON parsing failed! Key error: "
                          + str(error_instance))
 
+
+def create_recording_and_return(device_id, raw_json):
+    """
+    Tries to create recording with given parameters and returns it.
+    Raises error on failure
+
+    :param device_id: Id of device
+    :type device_id: int
+    :param raw_json: Raw json received
+    :type raw_json: json
+    :raises: ValueError if parsing fails or device does not exist
+    """
+    if not Device.exists(id=device_id):
+        raise ValueError("Device does not exist!")
+
+    recording = parse_raw_json_recording(device_id, raw_json)
+    recording.save()
+    return recording
+
+
+def create_recording(device_id, raw_json):
+    """
+    Tries to create recording with given parameters. Raises error on failure
+
+    :param device_id: Id of device
+    :type device_id: int
+    :param raw_json: Raw json received
+    :type raw_json: json
+    :raises: ValueError if parsing fails or device does not exist
+    """
     if not Device.exists(id=device_id):
         raise ValueError("Device does not exist!")
 

app/devices/models.py

@@ -8,7 +8,7 @@ from sqlalchemy.dialects.postgresql import JSON
 class Recording(db.Model):
     __tablename__ = 'recordings'
 
-    id = db.Column(db.Integer, primary_key=True)
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     recorded_at = db.Column(db.DateTime, index=True,
                             default=db.func.current_timestamp())
     received_at = db.Column(db.DateTime, index=True,
@@ -115,7 +115,7 @@ class Recording(db.Model):
 class Device(db.Model):
     __tablename__ = 'devices'
 
-    id = db.Column(db.Integer, primary_key=True)
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     created_at = db.Column(db.DateTime,
                            nullable=False,
                            default=db.func.current_timestamp())
@@ -267,7 +267,7 @@ class DeviceAssociation(db.Model):
 class DeviceType(db.Model):
     __tablename__ = 'device_types'
 
-    id = db.Column(db.Integer, primary_key=True)
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     name = db.Column(db.String, nullable=False)
 
     def __init__(self, name):
@@ -320,7 +320,7 @@ class DeviceType(db.Model):
 class AccessLevel(db.Model):
     __tablename__ = 'access_levels'
 
-    id = db.Column(db.Integer, primary_key=True)
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     name = db.Column(db.String, nullable=False)
 
     def __init__(self, name):