Update frame

app/db.py

@@ -150,4 +150,16 @@ def delete_frames(db, token, frame_id):
                 return False
         except Exception as e:
             print('ERROR: ', e)
-            return False
+            return False
+
+    @staticmethod
+    def update_frames(db, token, frame_id, frame_data):
+        user_id = decode_auth_token(token)
+        if user_id != None:
+            db.child('participants').child(user_id).child('frames').child(frame_id).remove()
+            upd_frame_id = db.child('participants').child(user_id).child('frames').push(frame_data)
+            frame = {"frame_id":upd_frame_id['name'], "frame_data":frame_data}
+            return frame
+        else:
+            print('ERROR: Token Value is None')
+            return None

app/routes.py

@@ -36,10 +36,11 @@ def login():
         return make_response(jsonify({"message": "Login failed"})), 401
 
 
-@app.route(BASE_URL+'/frames', methods=['POST', 'GET', 'DELETE'])
+@app.route(BASE_URL+'/frames', methods=['POST', 'GET', 'DELETE', 'PUT'])
 @swag_from('../docs/getframes.yml', methods=['GET'])
 @swag_from('../docs/postframes.yml', methods=['POST'])
 @swag_from('../docs/deleteframes.yml', methods=['DELETE'])
+@swag_from('../docs/updateframes.yml', methods=['PUT'])
 def frames():
     auth_header = request.headers.get('Authorization')
     if auth_header:
@@ -68,7 +69,7 @@ def frames():
                 responseObject = {
                     'message': 'Provide valid frame data'
                 }
-                return make_response(jsonify(responseObject)), 401
+                return make_response(jsonify(responseObject)), 400
         elif request.method == 'GET':
             frames_arr = Db.get_frames(database, auth_token)
             if frames_arr != None:
@@ -78,9 +79,9 @@ def frames():
                 return make_response(jsonify(responseObject)), 201
             else:
                 responseObject = {
-                    'message': 'Something went wrong'
+                    'message': 'Frames cannot be fetched'
                 }
-                return make_response(jsonify(responseObject)), 401
+                return make_response(jsonify(responseObject)), 400
         elif request.method == 'DELETE':
             frame_id = request.args.get('id')
             if Db.delete_frames(database, auth_token, frame_id):
@@ -93,6 +94,21 @@ def frames():
                     'message': 'Frame was not deleted!'
                 }
                 return make_response(jsonify(responseObject)), 400
+        elif request.method == 'PUT':
+            frame_id = request.json['frame_id']
+            frame_data = request.json['frame_data']
+            upd_frame = Db.update_frames(database, auth_token, frame_id, frame_data)
+            if upd_frame != None:
+                responseObject = {
+                    'message': 'Frame was updated successfully',
+                    'data': upd_frame
+                }
+                return make_response(jsonify(responseObject)), 201
+            else:
+                responseObject = {
+                    'message': 'Frame cannot be updated',
+                }
+                return make_response(jsonify(responseObject)), 400
     else:
         responseObject = {
             'message': 'Provide a valid auth token.'

docs/deleteframes.yml

@@ -6,6 +6,7 @@ tags:
 parameters:
   - in: query
     name: id
+    required: true
     schema:
       type: string
     description: ID of the frame to be deleted
@@ -15,7 +16,7 @@ responses:
   "201":
     description: Frame was deleted successfully
     schema:
-      $ref: '#/definitions/Frames'
+      $ref: '#/definitions/FrameObject'
   "400":
     description: Frame cannot be deleted
   "401":

docs/getframes.yml

@@ -10,19 +10,22 @@ responses:
     description: Frames were fetched successfully
     schema:
       $ref: '#/definitions/Frames'
-
   "401":
     description: Access token is missing or invalid
 definitions:
+  FrameObject:
+    type: object
+    properties:
+      frame_id:
+        type: string
+        description: Reference Id of the frame
+      frame_data:
+        type: string
+        description: Base64 encoded data of the frame
   Frames:
     type: array
     description: Array of Frame object
     items:
       type: object
-      properties:
-        frame_id:
-          type: string
-          description: Reference Id of the frame
-        frame_data:
-          type: string
-          description: Base64 encoded data of the frame
+      $ref: '#/definitions/FrameObject'
+

docs/postframes.yml

@@ -20,6 +20,8 @@ responses:
   "200":
     description: Frame added successfully
     schema:
-      $ref: '#/definitions/Frames'
+      $ref: '#/definitions/FrameObject'
+  "400":
+    description: Frame cannot be added
   "401":
     description: Access token is missing or invalid

docs/updateframes.yml

@@ -0,0 +1,31 @@
+Update a frame of a user
+The frame id has to be sent as a query along with the updated frame data in the request.
+---
+tags:
+  - user
+security:
+  - basicAuth: []
+parameters:
+  - in: body
+    name: body
+    required: true
+    schema:
+      required:
+        - frame_id
+        - frame_data
+      properties:
+        frame_id:
+          type: string
+          description: Id of the frame to be updated
+        frame_data:
+          type: string
+          description: Base64 encoded data of the frame
+responses:
+  "201":
+    description: Frame was updated successfully
+    schema:
+      $ref: '#/definitions/FrameObject'
+  "400":
+    description: Frame cannot be updated
+  "401":
+    description: Access token is missing or invalid