toulouse-maelis: new endpoint to get person places (#73734)

passerelle/contrib/toulouse_maelis/models.py

@@ -2222,6 +2222,71 @@ class ToulouseMaelis(BaseResource, HTTPResource):
             item['text'] = render_to_string(text_template, context).strip()
         return {'data': data, 'meta': meta}
 
+    @endpoint(
+        display_category='Inscriptions',
+        description="Liste des lieux d'une unité pour une personne",
+        name='get-person-place-list',
+        perm='can_access',
+        parameters={
+            'NameID': {'description': 'Publik NameID'},
+            'family_id': {'description': 'Numéro de DUI'},
+            'person_id': {'description': "Numéro du responsale légal ou de l'enfant"},
+            'activity_id': {'description': "Numéro de l'activités"},
+            'unit_id': {'description': "Numéro de l'unité"},
+            'start_date': {'description': 'Début de la période'},
+            'end_date': {'description': 'Fin de la période'},
+            'text_template': {
+                'description': 'template utilisée pour la valeur text (URL encoding)',
+                'example_value': '{{ libelle }}',
+            },
+        },
+    )
+    def get_person_place_list(
+        self,
+        request,
+        person_id,
+        activity_id,
+        unit_id,
+        NameID=None,
+        family_id=None,
+        start_date=None,
+        end_date=None,
+        text_template=None,
+    ):
+        family_id = family_id or self.get_link(NameID).family_id
+        reference_year = None
+        if start_date and end_date:
+            start_date, end_date, reference_year = self.get_start_and_end_dates(start_date, end_date)
+        if not text_template:
+            text_template = '{{ place.lib2|default:place.lib1 }}'
+
+        response = self.get_person_activity_list_raw(
+            family_id,
+            person_id,
+            reference_year=reference_year,
+            start_date=start_date and start_date.strftime(utils.json_date_format),
+            end_date=start_date and end_date.strftime(utils.json_date_format),
+        )
+        for activity in response['catalogueActivityList']:
+            if activity['activity']['idActivity'] == activity_id:
+                break
+        else:
+            raise APIError('No activity %s for person' % activity_id, err_code='no-activity')
+        for unit in activity['unitInfoList']:
+            if unit['idUnit'] == unit_id:
+                break
+        else:
+            raise APIError('No unit %s for person' % unit_id, err_code='no-unit')
+        data = unit.pop('placeInfoList')
+        del activity['unitInfoList']
+        meta = {'person': response['person'], 'activity': activity, 'unit': unit}
+        for item in data:
+            item['id'] = item['place']['idPlace']
+            context = dict(item)
+            context['meta'] = meta
+            item['text'] = render_to_string(text_template, context).strip()
+        return {'data': data, 'meta': meta}
+
 
 class Link(models.Model):
     resource = models.ForeignKey(ToulouseMaelis, on_delete=models.CASCADE)

tests/test_toulouse_maelis.py

@@ -4934,3 +4934,144 @@ def test_get_person_unit_list_no_activity_error(activity_service, con, app):
     resp = app.get(url, params=params)
     assert resp.json['err'] == 'no-activity'
     assert resp.json['err_desc'] == 'No activity plop for person'
+
+
+def test_get_person_place_list(activity_service, con, app):
+    def request_check(request):
+        assert request.yearSchool == 2022
+
+    activity_service.add_soap_response(
+        'getPersonCatalogueActivity',
+        get_xml_file('R_read_person_catalog_activity.xml'),
+        request_check=request_check,
+    )
+    url = get_endpoint('get-person-place-list')
+
+    params = {
+        'NameID': '',
+        'family_id': '311323',
+        'person_id': '246423',
+        'activity_id': 'A10053187087',
+        'unit_id': 'A10053187241',
+        'start_date': '2022-09-01',
+        'end_date': '2023-08-31',
+        'text_template': '',
+    }
+    resp = app.get(url, params=params)
+    assert resp.json['err'] == 0
+    Link.objects.create(resource=con, family_id='311323', name_id='local')
+
+    params['NameID'] = 'local'
+    params['family_id'] = ''
+    resp = app.get(url, params=params)
+    assert resp.json['err'] == 0
+    assert [(x['id'], x['text']) for x in resp.json['data']] == [('A10053179604', 'ALEX JANY')]
+    assert resp.json['data'] == [
+        {
+            'capacityInfo': {'controlOK': True, 'message': None},
+            'id': 'A10053179604',
+            'idIns': None,
+            'place': {
+                'ageEnd': None,
+                'ageStart': None,
+                'ctrlPlaces': 'H',
+                'etatIns': None,
+                'idIns': None,
+                'idPlace': 'A10053179604',
+                'latitude': 1.0,
+                'lib1': 'ALEX JANY',
+                'lib2': None,
+                'listBlocNoteBean': [],
+                'longitude': 2.0,
+            },
+            'text': 'ALEX JANY',
+        }
+    ]
+    assert resp.json['meta']['person']['numPerson'] == 246423
+    assert resp.json['meta']['activity']['activity']['idActivity'] == 'A10053187087'
+    assert resp.json['meta']['unit']['idUnit'] == 'A10053187241'
+
+    params['text_template'] = '{{ meta.unit.libelle }} - {{ place.lib1 }}'
+    resp = app.get(url, params=params)
+    assert resp.json['err'] == 0
+    assert [(x['id'], x['text']) for x in resp.json['data']] == [('A10053179604', 'Juillet - ALEX JANY')]
+
+
+def test_get_person_place_list_not_linked_error(con, app):
+    url = get_endpoint('get-person-place-list')
+    params = {
+        'NameID': 'local',
+        'family_id': '',
+        'person_id': '246423',
+        'activity_id': 'A10053187087',
+        'unit_id': 'A10053187241',
+        'start_date': '2022-09-01',
+        'end_date': '2023-08-31',
+        'text_template': '',
+    }
+    resp = app.get(url, params=params)
+    assert resp.json['err'] == 'not-linked'
+    assert resp.json['err_desc'] == 'User not linked to family'
+
+
+def test_get_person_place_list_date_error(con, app):
+    url = get_endpoint('get-person-place-list')
+
+    params = {
+        'NameID': '',
+        'family_id': '311323',
+        'person_id': '246423',
+        'activity_id': 'A10053187087',
+        'unit_id': 'A10053187241',
+        'start_date': 'bad',
+        'end_date': '2023-08-31',
+        'text_template': '',
+    }
+    resp = app.get(url, params=params, status=400)
+    assert resp.json['err'] == 'bad-request'
+    assert resp.json['err_desc'] == 'bad date format, should be YYYY-MM-DD'
+
+    params['start_date'] = '2022-09-01'
+    params['end_date'] = 'bad'
+    resp = app.get(url, params=params, status=400)
+    assert resp.json['err'] == 'bad-request'
+    assert resp.json['err_desc'] == 'bad date format, should be YYYY-MM-DD'
+
+    params['start_date'] = '2023-09-01'
+    params['end_date'] = '2023-08-31'
+    resp = app.get(url, params=params, status=400)
+    assert resp.json['err'] == 'bad-request'
+    assert resp.json['err_desc'] == 'start_date should be before end_date'
+
+    params['start_date'] = '2022-09-01'
+    params['end_date'] = '2024-08-31'
+    resp = app.get(url, params=params, status=400)
+    assert resp.json['err'] == 'bad-request'
+    assert resp.json['err_desc'] == 'start_date and end_date are in different reference year (2022 != 2023)'
+
+
+def test_get_person_place_list_no_unit_error(activity_service, con, app):
+    activity_service.add_soap_response(
+        'getPersonCatalogueActivity',
+        get_xml_file('R_read_person_catalog_activity.xml'),
+    )
+    url = get_endpoint('get-person-place-list')
+
+    params = {
+        'NameID': '',
+        'family_id': '311323',
+        'person_id': '246423',
+        'activity_id': 'plop',
+        'unit_id': 'plop',
+        'start_date': '2022-09-01',
+        'end_date': '2023-08-31',
+        'text_template': '',
+    }
+    resp = app.get(url, params=params)
+    assert resp.json['err'] == 'no-activity'
+    assert resp.json['err_desc'] == 'No activity plop for person'
+
+    params['activity_id'] = 'A10053187087'
+    resp = app.get(url, params=params)
+    assert resp.json['err'] == 'no-unit'
+    assert resp.json['err_desc'] == 'No unit plop for person'