#57 Refactoring APIGmS to improve and minfy the code.

Author: juanAFernandez

SMS-Back-End/apigms/apigms_api.py

@@ -11,23 +11,56 @@
 # Activating verbose mode
 v = 1
 
+#DEFAULT PORT TO THIS microService in local: 8001
+
 microservice_name = '\n ## dbms Data Base mService ##'
 
 module = modules.get_current_module_name()
 instance = modules.get_current_instance_id()
 
-# Test method.
+
+def ping(url, payload=None, method=None):
+    """
+    Method that isolates the way to do the request front all microservices and how processes the response.
+
+    :param url:
+    :param payload:
+    :param method:
+    :return:
+    """
+
+    if payload is None:
+        request = urllib2.Request(url)
+        if method == 'DELETE':
+            request.get_method = lambda: "DELETE"
+
+    else:
+        # We need send data with json format and by default is POST
+        request = urllib2.Request(url, data=json.dumps(payload.get_json()), headers={'Content-Type': 'application/json'})
+        # We can force to PUT if is the method that we need
+        if method is 'PUT':
+            request.get_method = lambda: "PUT"
+
+    response = make_response(Response(urllib2.urlopen(request), mimetype='application/json'))
+    response.headers['Access-Control-Allow-Origin'] = "*"
+
+    return response
+
+
 @app.route('/test',methods=['GET'])
 def test():
     """
-    Test resource.
+     Test resource.
 
-    Example of use:
-    curl -i -X GET localhost:8002/test
+    :return:
+
+     Example of use:
+        curl -i -X GET localhost:8002/test
     """
 
     url = "http://%s/" % modules.get_hostname(module='dbms')
     url += 'test'
+
     req = urllib2.Request(url)
     f = urllib2.urlopen(req)
     response = f.read()
@@ -38,72 +71,63 @@ def test():
 
 @app.route('/entities/<string:kind>', methods=['POST'])
 def put_entity(kind):
+    """
+    Data Base micro Service Resource connector, put all kind of entities in this mService.
 
-    url = "http://%s/" % modules.get_hostname(module='dbms')
-    url += 'entities/' + str(kind)
+    :param kind:
+    :payload json:
+    :return:
 
-    req = urllib2.Request(url, request.get_data(), {'Content-Type': 'application/json'})
-    f = urllib2.urlopen(req)
-    response = f.read()
-    f.close()
+     Example of use:
+      curl -H "Content-Type: application/json" -X POST -d '{ "data": {"name": "María"} }' localhost:8001/entities/student
 
-    return response
+    """
+
+    url = 'http://' + str(modules.get_hostname(module='dbms')) + '/' + 'entities/' + str(kind)
+
+    return ping(url=url, payload=request, method='POST')
 
 
 @app.route('/entities/<string:kind>', methods=['GET'])
 @app.route('/entities/<string:kind>/<int:entity_id>', methods=['GET'])
 def get_entities(kind, entity_id=None):
-    # curl -i -X GET localhost:8080/entities/teacher
-
-    url = "http://%s/" % modules.get_hostname(module='dbms')
-    url += 'entities/' + str(kind)
-
-    if entity_id is not None:
-        url += '/' + str(entity_id)
-
-    print url
+    """
+    Data Base micro Service Resource connector, to get info about all kind of entities in this mService.
 
-    req = urllib2.Request(url)
-    f = urllib2.urlopen(req)
-    response = f.read()
+    :param kind: Type of entity to get info.
+    :param entity_id:
+    :return: Exactly the response which is received from service.
 
-    print type(response)
-    response = json.dumps(response)
-    print type(response)
+    Example of use:
 
-    f.close()
+         curl -i -X GET localhost:8001/entities/teacher
 
+    See more info in dbms_apy.py
     """
-    res = Response(json.dumps(response), mimetype='application/json')
 
-    rews = make_response(res)
+    url = 'http://' + str(modules.get_hostname(module='dbms')) + '/' + 'entities/' + str(kind)
 
-    rews.headers['Access-Control-Allow-Origin'] = "*"
-    """
-
-    return response
+    if entity_id is not None:
+        url += '/' + str(entity_id)
 
-    #return Response(json.dumps(list), mimetype='application/json')
-    #return  jsonify(r)
-    #return response
+    return ping(url)
 
 
 @app.route('/entities/<string:kind>/<int:entity_id>', methods=['PUT'])
 def update_entities(kind, entity_id):
-    # curl -H "Content-Type: application/json" -X PUT -d '{ "data": {"name": "NombreModificado"} }' localhost:8001/entities/teacher/1
-
-    url = "http://%s/" % modules.get_hostname(module='dbms')
-    url += 'entities/' + str(kind) + '/' + str(entity_id)
+    """
+    Data Base micro Service Resource connector, to update all kind of entities in this mService.
 
-    print url
+    :param kind:
+    :param entity_id:
+    :return:
 
-    req = urllib2.Request(url, request.get_data(), {'Content-Type': 'application/json'})
-    req.get_method = lambda: "PUT"
-    f = urllib2.urlopen(req)
-    response = f.read()
-    f.close()
+    Exampe of use:
+     # curl -H "Content-Type: application/json" -X PUT -d '{ "data": {"name": "NombreModificado"} }' localhost:8001/entities/teacher/1
+    """
 
-    return response
+    url = 'http://' + modules.get_hostname(module='dbms') + '/entities/' + str(kind) + '/' + str(entity_id)
+    return ping(url=url, payload=request, method='PUT')
 
 
 @app.route('/entities/<string:kind>/<int:entity_id>', methods=['DELETE'])
@@ -112,33 +136,26 @@ def delete_entity(kind, entity_id):
     curl  -i -X  DELETE localhost:8002/entities/subject/1
     """
 
-    url = "http://%s/" % modules.get_hostname(module='dbms')
-    url += 'entities/' + str(kind) + '/' + str(entity_id)
-
-    req = urllib2.Request(url)
-    req.get_method = lambda: "DELETE"
-    f = urllib2.urlopen(req)
-    response = f.read()
-    f.close()
+    url = 'http://' + modules.get_hostname(module='dbms') + '/entities/' + str(kind) + '/' + str(entity_id)
 
-    return response
+    return ping(url=url, method='DELETE')
 
 
 @app.route('/entities/<string:kind>/<int:entity_id>/<string:related_kind>', methods=['GET'])
 def get_related_entities(kind, entity_id, related_kind):
-#    """
-#    curl -i -X GET localhost:8001/entities/student/1/teacher
-#    ""
+    """
 
-    url = "http://%s/" % modules.get_hostname(module='dbms')
-    url += 'entities/' + str(kind) + '/' + str(entity_id) + '/' + str(related_kind)
+    :param kind:
+    :param entity_id:
+    :param related_kind:
+    :return:
 
-    req = urllib2.Request(url)
-    f = urllib2.urlopen(req)
-    response = f.read()
-    f.close()
+     Example of use:
+       curl -i -X GET localhost:8001/entities/student/1/teacher
+    """
 
-    return response
+    url = 'http://' + modules.get_hostname(module='dbms') + '/entities/' + str(kind) + '/' + str(entity_id) + '/' + str(related_kind)
+    return ping(url=url)
 
 
 if __name__ == '__main__':

SMS-Back-End/dbms/dbms_api.py

@@ -122,6 +122,7 @@ def test():
 #   Resources about entities    #
 #################################
 
+
 @app.route('/entities/<string:kind>', methods=['POST'])
 def put_entity(kind):
     """
@@ -141,8 +142,8 @@ def put_entity(kind):
         A json with the entire entity which is saved in database (with all extra control values) or error status code.
 
     Example of use:
-        curl -H "Content-Type: application/json" -X POST -d '{ "data": {"name": "María"} }' localhost:8080/entities/student
-        curl -H "Content-Type: application/json" -X POST -d '{"data": {"course": 1, "word": "B", "level": "ESO"} }' localhost:8080/entities/class
+        curl -H "Content-Type: application/json" -X POST -d '{ "data": {"name": "María"} }' localhost:8002/entities/student
+        curl -H "Content-Type: application/json" -X POST -d '{"data": {"course": 1, "word": "B", "level": "ESO"} }' localhost:8002/entities/class
 
     Example of return:
         {"createdBy": 1, "course": 5, "createdAt": "Thu Sep 22 16:09:36 2016", "word": "B", "level": "Primary", "classId": 19}