Merge pull request #9 from aasaru/main3

Improvements

Author: ArtyomDevNow

Dockerfile

@@ -10,7 +10,7 @@ RUN mkdir -p config
 COPY config/docker.cfg config/
 COPY settings.yaml .
 
-EXPOSE 5000
+EXPOSE 8082
 
 ENV PYTHONPATH=/app
 ENV APP_SETTINGS=../config/docker.cfg

README.md

@@ -1,12 +1,12 @@
 
 # Adapter application (Python)
 
-This application is an adapter for Pääsuke written in Python Flask.
-This is used by a party who keeps mandates on their side but offers a standard service
+This application is an adapter for [Pääsuke](https://github.com/e-gov/PH) written in Python Flask.
+This can be used by a party who keeps mandates on their side and offers a standard web service
 for Pääsuke for it to query mandates.
 
 The idea is that there is a Postgres database that keeps the data.
-Into that Postgres database we create view and procedures that this app calls.
+Into that Postgres database we create view and stored procedures that this app calls.
 
 ## Sequence diagram illustrating the application
 ![Sequence diagram](doc/sequence-diagram-pr.png)
@@ -31,8 +31,6 @@ This database has a few tables to sore information about mandates.
 
 
 ## Configuration
-1. List of roles => view
-
 
 ## How to run API app in development environment
 
@@ -52,18 +50,15 @@ Check configuration example in example.cfg.
 ## How to run API app with docker-compose
     `docker-compose up -d`
 
-Access API on http://localhost:5002/v1
+## How to configure the list of roles
+
+Configure the list of roles in tests/pg_data/02b_view_paasuke_roles_view.sql
 
-```
-curl --location 'http://localhost:5002/v1/representees/EE33333333/delegates/mandates' \
---header 'X-Road-UserId: test-header-xroad-userid' \
---header 'X-Road-Represented-Party: TEST-Represented-Party' \
---header 'X-Road-Id: TEST-ID-12345'
-```
 
-## Tests
+## How to run tests
 
-Tests are using the Postgres database running on a Docker container and fixture data inside.
+Tests are using the Postgres database running on a Docker container (so you need to have `docker-compose up postgres`)
+Database contains fixture data .
     `python3 -m venv venv`
     `source venv/bin/activate`
     `pip install -r requirements.txt`
@@ -82,17 +77,20 @@ Point gunicorn to WSGI entrypoint `wsgi.py`
 
 ## Endpoints
 
+When running locally then access API on http://localhost:8082
+
+
 ### `GET /v1/representees/<str:representee>/delegates/mandates`
 
 Accepts representee identifier as parameter in path
-Raises `400` error if identifier does not validate
+Raises `400` error if identifier is not valid
 Returns the list of `MandateTriplet`s with status code `200` if representee has valid mandates
 Returns empty list if the representee has no valid mandates or the representee is unknown.
-Uses Postgres view `representee_mandates_view`
+Selects data from Postgres view `paasuke_mandates_view`
 
 Example:
 ```
-curl --location 'http://localhost:5002/v1/representees/EE33333333/delegates/mandates' \
+curl --location 'http://localhost:8082/v1/representees/EE44444444/delegates/mandates' \
 --header 'X-Road-UserId: test-header-xroad-userid' \
 --header 'X-Road-Represented-Party: test-header-xroad-represented-party' \
 --header 'X-Road-Id: test-header-xroad-id'
@@ -102,49 +100,54 @@ curl --location 'http://localhost:5002/v1/representees/EE33333333/delegates/mand
 ### `GET /v1/delegates/<str:delegate>/representees/mandates`
 
 Accepts delegate identifier as parameter in path
-Raises `400` error if identifier does not validate
+Raises `400` error if identifier is not valid
 Returns the list of `MandateTriplet`s with status code `200` if delegate has valid mandates
 Returns an empty list if delegate has no valid mandates or the delegate is unknown.
-Uses Postgres view `representee_mandates_view`
+Selects data from Postgres view `paasuke_mandates_view`
 
 Example:
 ```
-curl --location 'http://127.0.0.1:5002/v1/delegates/EE1111111/representees/mandates' \
+curl --location 'http://127.0.0.1:8082/v1/delegates/EE22202222222/representees/mandates' \
 --header 'X-Road-UserId: Test User Id'
 ```
 
 ### `GET /roles`
 
 Get a list of roles
-Selects data from Postgres view `roles_view`
+Selects data from Postgres view `paasuke_roles_view`
 
 Example:
 
-`curl --location 'http://localhost:5002/v1/roles`
+`curl --location 'http://localhost:8082/v1/roles'`
 
 
 
 ### `POST /v1/representees/<str:representee>/delegates/<str:delegate>/mandates`
 
 Accepts repreentee and delegate identifiers as path parameters
 Raises `400` error if payload data is not valid or identifiers are not valid
-Raises `422` error if Postgres function `function_create_mandate` does not validate input data.
+Raises `422` error if Postgres function `paasuke_add_mandate` does not validate input data.
 Return an empty list with status code `201` in case of success
 
 Example of successful request:
 
 ```
-curl --location 'http://127.0.0.1:5002/v1/representees/EE12345678/delegates/EE38302250123/mandates' \
+curl --location 'http://127.0.0.1:8082/v1/representees/EE12345678/delegates/EE38302250123/mandates' \
 --header 'Content-Type: application/json' \
 --header 'X-Road-UserId: LT123456' \
 --header 'X-Road-Represented-Party: LV1234566' \
 --data '  {
   "authorizations": [
     {
-      "hasRole": "FROM_BUSINESS_REGISTRY:MANAGEMENT_BOARD_MEMBER_FULL",
+      "hasRole": "BR_REPRIGHT:JUHL_SOLEREP",
       "userIdentifier": "EE49028099999"
     }
   ],
+  "representee": {
+    "identifier": "EE12345678",
+    "legalName": "Väikefirma OÜ",
+    "type": "LEGAL_PERSON"
+  },
   "delegate": {
     "firstName": "Jüri",
     "identifier": "EE38302250123",
@@ -157,16 +160,11 @@ curl --location 'http://127.0.0.1:5002/v1/representees/EE12345678/delegates/EE38
   },
   "mandate": {
     "canSubDelegate": true,
-    "role": "GLOBAL1_EMTA:ACCOUNTANT",
+    "role": "AGENCY_X:MANDATES_MANAGER",
     "validityPeriod": {
       "from": "2028-01-01",
       "through": "2030-12-31"
     }
-  },
-  "representee": {
-    "identifier": "EE12345678",
-    "legalName": "Väikefirma OÜ",
-    "type": "LEGAL_PERSON"
   }
 }'
 ```
@@ -176,19 +174,20 @@ curl --location 'http://127.0.0.1:5002/v1/representees/EE12345678/delegates/EE38
 
 Accepts `representeeId`, `delegateId`, `mandateId` as parameters in the path.
 Raises `404` error if the mandate does not exist
-Raises `422` error if Postgres function `function_insert_mandate_subdelegate` does not validate input data.
+Raises `422` error if Postgres function `paasuke_add_mandate_subdelegate` does not validate input data.
 Returns empty list with status code `200` in success case
 
 Example of successful request:
+
 ```
-curl --location 'http://127.0.0.1:5002/v1/representees/EE33333333/delegates/100001/mandates/150003/subdelegates' \
+curl --location 'http://127.0.0.1:8082/v1/representees/100004/delegates/100005/mandates/150003/subdelegates' \
 --header 'Content-Type: application/json' \
 --header 'X-Road-UserId: EE23232323' \
 --header 'X-Road-Represented-Party: EE2323224444' \
 --data '{
   "authorizations": [
     {
-      "hasRole": "FROM_BUSINESS_REGISTRY:MANAGEMENT_BOARD_MEMBER_FULL",
+      "hasRole": "BR_REPRIGHT:PROK_SOLEREP",
       "userIdentifier": "EE39912310123"
     }
   ],
@@ -214,13 +213,12 @@ curl --location 'http://127.0.0.1:5002/v1/representees/EE33333333/delegates/1000
 
 Accepts `representeeId`, `delegateId`, `mandateId` as parameters in the path.
 Raises `404` error if the mandate does not exist
-Raises `422` error if Postgres function `function_delete_mandate` does not validate input data.
-Returns empty list with status code `200` in success case
+Raises `422` error if Postgres function `paasuke_delete_mandate` does not validate input data.
+Returns empty list with status code `200` if mandates has been marked deleted successfully
 
 Example of successful request:
-
 ```
-curl --location --request PUT 'http://127.0.0.1:5002/v1/representees/EE33333333/delegates/100001/mandates/150003' \
+curl --location --request PUT 'http://127.0.0.1:8082/v1/representees/100001/delegates/100003/mandates/150002' \
 --header 'Content-Type: application/json' \
 --data '{
   "action": "DELETE",

api/app.py

@@ -65,22 +65,22 @@ def handle_unhandled_error(e):
         app.logger.exception('Unexpected error occurred: %s', e)
         return jsonify(base.to_dict()), 500
 
-    @app.route('/v1/delegates/<string:delegate_id>/representees/mandates', methods=['GET'])
-    def get_delegates_representees_mandates(delegate_id):
+    @app.route('/v1/delegates/<string:delegate_identifier>/representees/mandates', methods=['GET'])
+    def get_delegates_representees_mandates(delegate_identifier):
         xroad_user_id = request.headers.get('X-Road-UserId')
         app.logger.info(f'X-Road-UserId: {xroad_user_id} Getting delegate mandates')
         error_config = app.config['SETTINGS']['errors']['legal_person_format_validation_failed']
-        validate_person_company_code(delegate_id, error_config)
+        validate_person_company_code(delegate_identifier, error_config)
 
-        data_rows = get_mandates(db, delegate_identifier=delegate_id)
+        data_rows = get_mandates(db, delegate_identifier=delegate_identifier)
         if not data_rows:
             return make_success_response(data_rows, 200)
         delegate, representees = extract_delegates_mandates(data_rows)
         response_data = serialize_delegate_mandates(delegate, representees, app.config['SETTINGS'])
         return make_success_response(response_data, 200)
 
-    @app.route('/v1/representees/<string:representee_id>/delegates/mandates', methods=['GET'])
-    def get_representees_delegates_mandates(representee_id):
+    @app.route('/v1/representees/<string:representee_identifier>/delegates/mandates', methods=['GET'])
+    def get_representees_delegates_mandates(representee_identifier):
         xroad_user_id = request.headers.get('X-Road-UserId')
         app.logger.info(f'X-Road-UserId: {xroad_user_id} Getting representee mandates')
 
@@ -91,11 +91,11 @@ def get_representees_delegates_mandates(representee_id):
         error_config = app.config['SETTINGS']['errors']['legal_person_format_validation_failed']
         [
             validate_person_company_code(code, error_config)
-            for code in [representee_id, delegate_identifier, subdelegated_by_identifier]
+            for code in [representee_identifier, delegate_identifier, subdelegated_by_identifier]
         ]
         data_rows = get_mandates(
             db,
-            representee_identifier=representee_id,
+            representee_identifier=representee_identifier,
             delegate_identifier=delegate_identifier,
             subdelegated_by_identifier=subdelegated_by_identifier
         )
@@ -106,24 +106,24 @@ def get_representees_delegates_mandates(representee_id):
         response_data = serialize_representee_mandates(representee, delegates, app.config['SETTINGS'])
         return make_success_response(response_data, 200)
 
-    @app.route('/v1/representees/<string:representee_id>/delegates/<string:delegate_id>/mandates', methods=['POST'])
-    def post_representee_delegate_mandate(representee_id, delegate_id):
+    @app.route('/v1/representees/<string:representee_identifier>/delegates/<string:delegate_identifier>/mandates',
+               methods=['POST'])
+    def post_representee_delegate_mandate(representee_identifier, delegate_identifier):
         xroad_user_id = request.headers.get('X-Road-UserId')
         xroad_represented_party = request.headers.get('X-Road-Represented-Party')
         app.logger.info(f'X-Road-UserId: {xroad_user_id} is about to add a mandate')
 
         error_config = app.config['SETTINGS']['errors']['legal_person_format_validation_failed']
         [
             validate_person_company_code(code, error_config)
-            for code in [representee_id, delegate_id]
+            for code in [representee_identifier, delegate_identifier]
         ]
         data = request.json
         error_config = app.config['SETTINGS']['errors']['mandate_data_invalid']
-        validate_add_mandate_payload(data, error_config, representee_id, delegate_id)
+        validate_add_mandate_payload(data, error_config, representee_identifier, delegate_identifier)
 
         data_to_insert = extract_mandate_data(data)
         data_to_insert['data_created_by'] = xroad_user_id
-        data_to_insert['data_created_by_represented_person'] = xroad_represented_party
         db_uri = app.config['SQLALCHEMY_DATABASE_URI']
         try:
             create_mandate_pg(db_uri, data_to_insert)
@@ -183,7 +183,6 @@ def post_subdelegate_mandate(representee_id, delegate_id, mandate_id):
         data_to_insert['mandate_id'] = mandate_id
 
         data_to_insert['data_created_by'] = xroad_user_id
-        data_to_insert['data_created_by_represented_person'] = xroad_represented_party
         try:
             result = subdelegate_mandate_pg(app.config['SQLALCHEMY_DATABASE_URI'], data_to_insert)
         except psycopg2.errors.RaiseException as e:
@@ -253,5 +252,5 @@ def get_roles():
     app.run(
         debug=app.config.get('DEBUG'),
         host=app.config.get('HOST', '0.0.0.0'),
-        port=app.config.get('PORT', 5000)
+        port=app.config.get('PORT', 8082)
     )

api/exceptions.py

@@ -65,4 +65,4 @@ class UnprocessableRequestError(ErrorConfigBase):
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         status_code = kwargs.get('status_code')
-        self.status_code = status_code or UnprocessableRequestError.status_code
+        self.status_code = status_code or UnprocessableRequestError.status_code

api/serializers.py

@@ -2,18 +2,18 @@ def serialize_delegate_mandates(delegate, representees, settings):
     data = []
     for representee in representees:
         item = {
+            'representee': {
+                'identifier': representee['representee_identifier'],
+                'legalName': representee['representee_legal_name'],
+                'type': representee['representee_type']
+            },
             'delegate': {
                 'firstName': delegate['delegate_first_name'],
                 'identifier': delegate['delegate_identifier'],
                 'surname': delegate['delegate_surname'],
                 'type': delegate['delegate_type']
             },
-            'mandates': [],
-            'representee': {
-                'identifier': representee['representee_identifier'],
-                'legalName': representee['representee_legal_name'],
-                'type': representee['representee_type']
-            }
+            'mandates': []
         }
         for mandate in representee['mandates']:
             mandate_data = serialize_mandate(representee, delegate, mandate, settings)
@@ -26,9 +26,9 @@ def serialize_representee_mandates(representee, delegates, settings):
     response_data = []
     for delegate in delegates:
         item = {
+            'representee': serialize_item_by_type(representee, 'representee'),
             'delegate': serialize_item_by_type(delegate, 'delegate'),
             'mandates': [],
-            'representee': serialize_item_by_type(representee, 'representee'),
         }
         for mandate in delegate['mandates']:
             mandate_data = serialize_mandate(representee, delegate, mandate, settings)
@@ -70,14 +70,17 @@ def serialize_item_by_type(item, key_type):
 
 
 def serialize_mandate(representee, delegate, mandate, settings):
-    links = {
-        'delete': mandate['link_delete'],
-        'origin': settings["origin_url"],
-    }
+    links = {}
+
+    if mandate['link_delete']:
+        links['delete'] = mandate['link_delete']
 
     if mandate['can_sub_delegate'] and mandate['link_add_sub_delegate']:
         links['addSubDelegate'] = mandate['link_add_sub_delegate']
 
+    if mandate['link_origin']:
+        links['origin'] = mandate['link_origin']
+
     validity_period = {}
     if mandate['validity_period_from']:
         validity_period['from'] = mandate['validity_period_from'].strftime('%Y-%m-%d')
@@ -87,23 +90,10 @@ def serialize_mandate(representee, delegate, mandate, settings):
     mandate_data = {
         'links': links,
         'role': mandate['role'],
-        **({'subDelegatorIdentifier': mandate['created_by_represented_person']}
-            if mandate['original_mandate_id'] and mandate['created_by_represented_person'] else {}),
+        **({'subDelegatorIdentifier': mandate['subdelegated_by_identifier']}
+            if mandate['subdelegated_by_identifier'] else {}),
         **({'validityPeriod': validity_period}
             if validity_period else {}),
     }
     return mandate_data
 
-
-def set_subdelegate_link(mandate, representee, delegate):
-    representee_id = representee['representee_id']
-    delegate_id = delegate['delegate_id']
-    mandate_id = mandate['mandate_id']
-    return f'/v1/representees/{representee_id}/delegates/{delegate_id}/mandates/{mandate_id}/subdelegates'
-
-
-def set_delete_link(mandate, representee, delegate):
-    representee_id = representee['representee_id']
-    delegate_id = delegate['delegate_id']
-    mandate_id = mandate['mandate_id']
-    return f'/v1/representees/{representee_id}/delegates/{delegate_id}/mandates/{mandate_id}'