[#72] Created resources to work with the options of disciplinary notes items and improve some parts of project.

Author: jfernandez_ccktlbs

SMS-Back-End/apigms/api/scms_segment/disciplinary_notes_api_segment.py

@@ -18,6 +18,19 @@
 disciplinary_notes_api = Blueprint('disciplinary_notes_api', __name__)
 
 
+@disciplinary_notes_api.route('/disciplinarynote/schema', methods=['GET', 'PUT'])
+def CRU_disciplinary_note_schema():
+    """
+    It call to SCmS to get a schema with options to ve showed in UI form to do a disciplinary note.
+    :return: A dict
+    """
+    if request.method == 'GET':
+        return CRUD.get(service='scms', resource='disciplinarynote/schema')
+
+    if request.method == 'PUT':
+        return CRUD.put(service='scms', resource='disciplinarynote/schema', id=None, json=request.get_json())
+
+
 @disciplinary_notes_api.route('/disciplinarynote', methods=['GET'])
 @disciplinary_notes_api.route('/disciplinarynote/<int:dn_id>', methods=['GET'])
 def get_disciplinary_note(dn_id=None):

SMS-Back-End/apigms/api/services.py

@@ -61,13 +61,18 @@ def put(cls, service, resource, id, json):
 
         :param service: The name of the service (used for google services auto discovering).
         :param resource: The url segment of the service.
-        :param id: The id of the request item.
+        :param id: The id of the request item. **CAN BE NONE TO SINGLETON RESOURCES**
         :param json: The payload where are the data to put in a dict format.
         :return: Exactly the same response of the service.
         """
-        response = requests.put(
-            url='http://{}/{}/{}'.format(modules.get_hostname(module=service),resource, id),
-            json=json)
+
+        # For singleton resources.
+        url = 'http://{}/{}'.format(modules.get_hostname(module=service), resource)
+
+        if id:
+            url += '/{}'.format(id)
+
+        response = requests.put(url=url, json=json)
         response.headers['Access-Control-Allow-Origin'] = "*"
         return make_response(response.content, response.status_code)
 

SMS-Back-End/scms/api/attendance_controls_api_segment.py

@@ -58,15 +58,15 @@
 
     Example:
 
-    >>> curl -H "Content-Type: application/json" -X POST -d '...' localhost:8003/association
+    >>> curl -H "Content-Type: application/json" -X POST -d '...' localhost:8003/ac
 
     Post with example file:
 
     >>> curl -i -H "Content-Type: application/json" -X POST -d @SMS-Back-End/scms/test/AC_example_1.json localhost:8003/ac
     {"acId": 6333186975989760}j
 
     An example of the data is:
-
+    
     .. code-block:: json
 
         {

SMS-Back-End/scms/api/disciplinary_notes_api_segment.py

@@ -65,6 +65,57 @@
                 "description": "A little problem with new boy."
             }
 
+
+/disciplinarynote/schema
+
+    **GET**
+    
+    Return the schema with data necesary to buil the form in the UI to make a disciplinary note.
+    
+    Example:
+        
+    >>> curl -i -X GET localhost:8003/disciplinarynote/schema
+    
+    {
+        "gravities": [
+            {
+                "code": 1,
+                "meaning": 1
+            },
+            {
+                "code": 2,
+                "meaning": 2
+            },
+            {
+                "code": 3,
+                "meaning": 3
+            },
+            {
+                "code": 4,
+                "meaning": 4
+            },
+            {
+                "code": 5,
+                "meaning": 5
+            }
+        ],
+        "kinds": [
+            {
+                "code": 1,
+                "meaning": "Acoso"
+            },
+            {
+                "code": 2,
+                "meaning": "Falta de respeto"
+            },
+            {
+                "code": 2,
+                "meaning": "Violencia de genero"
+            }
+        ]
+    }
+
+
 /disciplinarynote/{id}
 --------
 
@@ -146,6 +197,13 @@
 disciplinary_notes_api = Blueprint('disciplinary_notes_api', __name__)
 
 
+@disciplinary_notes_api.route('/disciplinarynote/schema', methods=['GET', 'PUT'])
+def get_disciplinary_note_schema():
+
+    return process_response(DisciplinaryNotesManager.cru_dn_schema(schema=request.get_json(),
+                                                                   action=request.method))
+
+
 @disciplinary_notes_api.route('/disciplinarynote', methods=['POST'])
 def post_disciplinary_note():
     """

SMS-Back-End/scms/scm/models/discipline_models.py

@@ -14,6 +14,19 @@
 # the api manage and the conversion to json is directly using the same name used here.
 
 
+class OptionItem(ndb.Model):
+    id = ndb.IntegerProperty()
+    meaning = ndb.StringProperty()
+
+
+# This is a singleton MODEL
+class DNOptions(ndb.Model):
+    kinds = ndb.StructuredProperty(OptionItem, repeated=True)
+    gravities = ndb.StructuredProperty(OptionItem, repeated=True)
+    modifiedBy = ndb.IntegerProperty()
+    modifiedAt = ndb.DateTimeProperty()
+
+
 class DisciplinaryNote(ndb.Model):
     """
     Model of a disciplinary note. We save only the id of students and teacher. One disciplinary note

SMS-Back-End/scms/scm/scm.py

@@ -59,9 +59,6 @@ def get_item_from_tdbms(kind, id, params):
         'time': '{} sec'.format((time_after-time_before).total_seconds())
     }
 
-    print colored(info, 'red', 'on_grey')
-
-
     status = response.status_code
 
     if status == 200:
@@ -194,7 +191,7 @@ def get_ac(cls, ac_id=None):
                         student_info = get_item_from_tdbms('student',
                                                            student['studentId'], ['name', 'surname', 'profileImageUrl'])
                         del (student['studentId'])
-                        student['student'] = student_info
+                        student.update(student_info)
 
                         populated_students.append(student)
 
@@ -487,8 +484,6 @@ def post_mark(cls, mark):
         # If mark has the required format:
         if cls.validate_mark(mark):
 
-            print colored('Posted mark')
-            print colored(mark, 'red')
 
             # Is created the object
             enrollment = mark['enrollment']
@@ -531,8 +526,6 @@ def update_mark(cls, mark_id, received_mark):
 
             if cls.validate_mark(received_mark):
 
-                print colored('Posted mark')
-                print colored(received_mark, 'red')
 
                 # Is created the object
                 enrollment = received_mark['enrollment']
@@ -595,8 +588,8 @@ def validate_dn(cls, disciplinary_note):
         """
         Validate the format of item based of data store model.
 
-        :param disciplinary_note: Item dict.
-        :return: True if format is ok and false in other hand.
+        :param disciplinary_note: data block, dict.
+        :return: True if format is ok and false in other hand, boolean.
         """
         # TODO: Implement.
         return True
@@ -768,4 +761,43 @@ def delete_dn(cls, disciplinary_note):
             return {'status': 200, 'data': None, 'log': None}
 
         else:  # If it doesn't exists:
-            return {'status': 404, 'data': None, 'log': 'Disciplinary Note required seem like doesn\'t exists or was deleted.'}
+            return {'status': 404, 'data': None, 'log': 'Disciplinary Note required seem like doesn\'t exists or was deleted.'}
+
+    @classmethod
+    def cru_dn_schema(cls, schema, action):
+        """
+        Do all functionality about schemas (all together because is very simple).
+        :param schema: Dict, data block to work with it.
+        :param action: String, action (HTTP verb) to realise with the singleton shema
+        in the database.
+        :return: Standard info dict (without data, only status code)
+        """
+
+        if action == 'GET' and not schema:
+            dn_options_saved = DNOptions.get_by_id('dn_options_saved')
+            if not dn_options_saved:
+                DNOptions.get_or_insert('dn_options_saved',
+                                        kinds=[OptionItem(id=1, meaning='Tipo base')],
+                                        gravities=[OptionItem(id=1, meaning='Gravedad base')])
+                dn_options_saved = DNOptions.get_by_id('dn_options_saved')
+            return {'status': 200, 'data': dn_options_saved.to_dict(), 'log': None }
+
+        if action == 'PUT' and schema:
+
+            kinds = []
+            gravities = []
+            for kind in schema['kinds']:
+                kinds.append(OptionItem(id=kind['id'], meaning=kind['meaning']))
+
+            for gravity in schema['gravities']:
+                gravities.append(OptionItem(id=gravity['id'], meaning=gravity['meaning']))
+
+            dn_options_saved = DNOptions.get_or_insert('dn_options_saved')
+
+            dn_options_saved.kinds = kinds
+            dn_options_saved.gravities = gravities
+            dn_options_saved.modifiedAt = time_now()
+
+            dn_options_saved.put()
+
+            return {'status': 200, 'data': dn_options_saved.to_dict(), 'log': None}

SMS-Back-End/scms/test/disciplinary_note_example_1.json

@@ -6,5 +6,5 @@
     "dateTime": "2000-12-03 10:30",
     "kind": 1,
     "gravity": 5,
-    "description": "A little problem with new boy."
+    "description": "A little problem with new boy. María"
 }

SMS-Back-End/scms/test/scms_api_rest_disciplinary_notes_segment_test.py

@@ -96,6 +96,42 @@ def test_update(self, port):
 
         sleep(0.5)
 
+
+class TestClassOptions(object):
+
+    scenarios = [scenario2, scenario1]
+
+    def test_get_initial_options(self, port):
+        """
+        $ pytest scms_api_rest_disciplinary_notes_segment_test.py::TestClassOptions::test_get_options -vv -s 
+        """
+
+        url = 'http://localhost:{}/disciplinarynote/schema'.format(port)
+        result = requests.get(url)
+        assert result.status_code == 200
+
+    def test_update_options(self, port):
+        """
+        $ pytest scms_api_rest_disciplinary_notes_segment_test.py::TestClassOptions::test_get_options -vv -s 
+        """
+
+        url = 'http://localhost:{}/disciplinarynote/schema'.format(port)
+
+        data = {
+            'kinds': [
+                {'id': 1, 'meaning': 'Tipo 1'},
+                {'id': 2, 'meaning': 'Tipo 2'},
+                {'id': 3, 'meaning': 'Tipo 3'}
+            ],
+            'gravities': [
+                {'id': 1, 'meaning': 'Gravedad 1'},
+                {'id': 2, 'meaning': 'Gravedad 2'},
+                {'id': 3, 'meaning': 'Gravedad 3'},
+            ]
+        }
+        response = requests.put(url=url, json=data)
+        assert response.status_code == 200
+
     """
 
 

SMS-Back-End/tdbms/dbapi/entities_manager.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-import datetime
+from datetime import datetime
 import pytz
 
 import db_params
@@ -167,13 +167,22 @@ def post(cls, kind, data):
         if v:
             print colored(locals(), 'blue')
 
+
         return_dic = {}
 
-        now = datetime.datetime.utcnow()
+        # Datetime adjusts
+
+        # Adjusting the right format to the datetime which data is saved.
+        now = datetime.utcnow()
         tz = pytz.timezone('Europe/Madrid')
         tzoffset = tz.utcoffset(now)
         mynow = now + tzoffset
 
+        # Adjusting the right format to the data object that is received form request.
+        if data.get('birthdate', None):
+            data['birthdate'] = datetime.strptime(data['birthdate'], '%Y-%m-%dT%H:%M:%S.%fZ')
+            print colored(type(data['birthdate']), 'blue')
+
         control_fields = {'createdBy': 1, 'createdAt': mynow, 'deleted': 0}
 
         query = 'insert into {0} ({0}Id, '.format(kind)

SMS-Back-End/tdbms/tdbms_api.py

@@ -61,9 +61,6 @@ def process_response(response):
     :return:
     """
 
-    print 'In process response'
-    print response
-
     """
     Function to build a response with sense.
     :param self:
@@ -207,18 +204,11 @@ def post_entity(kind):
         abort(400)  # Bad request.
 
     else:
-        for key, value in received_json.iteritems():
-            if type(value) is not int and type(value) is not list: # Because we accept a list of associationIds in enrollment resource.
-                received_json[key] = value.encode('utf-8')
-
-    # When are really saved data in database
-
-
-    # Special multiple enrollment checking:
-    if 'associationsIds' in received_json:
-        return process_response(EntitiesManager.multiple_enrollment(kind, received_json))
-    else:
-        return process_response(EntitiesManager.post(kind, received_json))
+        # Special multiple enrollment checking:
+        if 'associationsIds' in received_json:
+            return process_response(EntitiesManager.multiple_enrollment(kind, received_json))
+        else:
+            return process_response(EntitiesManager.post(kind, received_json))
 
 
 @app.route('/entities/<string:kind>', methods=['GET'])  # Si pedimos todas las entidades de un tipo