[Fixes #1758 #1766] Fix for DRF API filters

akvo/api/resources/partnership.py

@@ -31,7 +31,7 @@
 FIELD_NAME = 'name'
 FIELD_LONG_NAME = 'long_name'
 FIELD_NEW_ORGANISATION_TYPE = 'new_organisation_type'
-FIELD_PARTNER_TYPE = 'partner_type'
+FIELD_PARTNER_TYPE = 'iati_organisation_role'
 ORG_FIELDS = [FIELD_IATI_ORG_ID, FIELD_NAME, FIELD_LONG_NAME, FIELD_NEW_ORGANISATION_TYPE]
 # InternalOrganisationID
 FIELD_INTERNAL_ORG_ID = 'internal_org_id'
@@ -173,7 +173,7 @@ def hydrate(self, bundle):
             bundle.data[FIELD_ORGANISATION] = organisation
             if (
                 organisation.iati_org_id != bundle.data[FIELD_REPORTING_ORG] or
-                bundle.data[FIELD_PARTNER_TYPE] != Partnership.SUPPORT_PARTNER
+                bundle.data[FIELD_PARTNER_TYPE] != Partnership.IATI_ACCOUNTABLE_PARTNER
             ):
                 bundle.data[FIELD_IATI_ACTIVITY_ID] = None
                 bundle.data[FIELD_INTERNAL_ID] = None
@@ -197,15 +197,48 @@ def hydrate_organisation(self, bundle):
 class PartnershipResource(ConditionalFullResource):
     organisation = ConditionalFullToOneField('akvo.api.resources.OrganisationResource', 'organisation')
     project = ConditionalFullToOneField('akvo.api.resources.ProjectResource', 'project')
+    partner_type = fields.CharField(attribute='iati_role_to_partner_type')
 
     def __init__(self, api_name=None):
         """ override to be able to create custom help_text on the partner_type field
         """
         super(PartnershipResource, self).__init__(api_name=None)
-        self.fields['partner_type'].help_text = "Uses the following key-value pair list: {%s}" % ', '.join(
-            ['"%s": "%s"' % (k, v) for k, v in Partnership.PARTNER_TYPES]
+        self.fields[
+            'iati_organisation_role'].help_text = "Uses the following key-value pair list: {%s}" % ', '.join(
+            ['"%s": "%s"' % (k, v) for k, v in Partnership.IATI_ROLES]
         )
 
+    def apply_filters(self, request, applicable_filters):
+        """ Custom filtering for the "fake" field partner_type allowing the filtering of the
+        resource using the deprecated Akvo partner type values
+
+        Uses Partnership.PARTNER_TYPES_TO_ROLES_MAP map the filter to the
+        Partnership.iati_organisation_role field
+        """
+
+        partner_type_filter = {}
+        if 'iati_role_to_partner_type' in [k.split('__')[0] for k in applicable_filters.keys()]:
+            for k in applicable_filters.keys():
+                if k.startswith('iati_role_to_partner_type'):
+                    operator = k.split('__')[1]
+                    if operator == 'in':
+                        values = [
+                            Partnership.PARTNER_TYPES_TO_ROLES_MAP[v] for v in applicable_filters[k]
+                        ]
+                        partner_type_filter['iati_organisation_role__in'] = values
+                    else:
+                        partner_type_filter[
+                            "iati_organisation_role__{}".format(operator)
+                        ] = Partnership.PARTNER_TYPES_TO_ROLES_MAP[applicable_filters[k]]
+                    applicable_filters.pop(k)
+
+        default_filtering = super(PartnershipResource, self).apply_filters(request, applicable_filters)
+
+        if partner_type_filter:
+            return default_filtering.filter(**partner_type_filter)
+        else:
+            return default_filtering
+
     class Meta:
         max_limit = 10
         allowed_methods = ['get']
@@ -214,10 +247,11 @@ class Meta:
         filtering       = dict(organisation=ALL_WITH_RELATIONS)
         filtering       = dict(
             # other fields
-            iati_activity_id    = ALL,
-            internal_id         = ALL,
-            partner_type        = ALL,
+            iati_activity_id = ALL,
+            internal_id = ALL,
+            partner_type = ALL,
+            iati_organisation_role = ALL,
             # foreign keys
-            organisation        = ALL_WITH_RELATIONS,
-            project             = ALL_WITH_RELATIONS,
+            organisation = ALL_WITH_RELATIONS,
+            project = ALL_WITH_RELATIONS,
         )

akvo/api/resources/project.py

@@ -216,7 +216,7 @@ def alter_deserialized_detail_data(self, request, data):
                     reporting_org=temp_org['reporting_org'],
                     name='Incorrect business unit', #this should never be used, if it is the lookup of existing BUs is borked
                     long_name='Incorrect business unit',
-                    partner_type='sponsor',
+                    iati_organisation_role=100, # old partner type sponsor partner
                     new_organisation_type='21',
                     organisation=None,
                 )]

akvo/api/xml/iati-xslt.xsl

@@ -524,16 +524,16 @@
         </xsl:otherwise>
       </xsl:choose>
       <xsl:if test="@role='Accountable'">
-        <partner_type>support</partner_type>
+        <iati_organisation_role>2</iati_organisation_role>
       </xsl:if>
       <xsl:if test="@role='Extending'">
-        <partner_type>support</partner_type>
+        <iati_organisation_role>3</iati_organisation_role>
       </xsl:if>
       <xsl:if test="@role='Funding'">
-        <partner_type>funding</partner_type>
+        <iati_organisation_role>1</iati_organisation_role>
       </xsl:if>
       <xsl:if test="@role='Implementing'">
-        <partner_type>field</partner_type>
+        <iati_organisation_role>4</iati_organisation_role>
       </xsl:if>
     </object>
   </xsl:template>

akvo/cordaid_org_importer.py

@@ -16,7 +16,7 @@
 from django.core.files.temp import NamedTemporaryFile
 
 from akvo.codelists.store.codelists_v201 import ORGANISATION_TYPE as IATI_LIST_ORGANISATION_TYPE
-from akvo.rsr.models import InternalOrganisationID, Organisation, PartnerType
+from akvo.rsr.models import InternalOrganisationID, Organisation
 from akvo.utils import model_and_instance_based_filename
 
 
@@ -95,8 +95,6 @@ def import_orgs(xml_file):
                         identifier=identifier
                     )
                     internal_org_id.save()
-                    for partner_type in PartnerType.objects.all():
-                        referenced_org.partner_types.add(partner_type)
                 except Exception, e:
                     action = "failed"
                     internal_org_id.delete()

akvo/iati/checks/v201.py

@@ -109,15 +109,16 @@ def partners(self):
             if partnership.organisation:
                 org = partnership.organisation
                 org_name = org.long_name or org.name
-                if partnership.partner_type and (org.iati_org_id or org_name):
+                if (partnership.iati_organisation_role and
+                        partnership.iati_organisation_role < 100 and (org.iati_org_id or org_name)):
                     valid_partner = True
-                if not partnership.partner_type:
+                if not partnership.iati_organisation_role:
                     checks.append((u'error', u'missing role for partner %s' % org_name))
                 if not org.iati_org_id:
                     checks.append((u'warning', u'partner %s has no IATI identifier' % org_name))
                 if not org_name:
-                    checks.append((u'warning', u'%s partner has no organisation '
-                                               u'name' % partnership.partner_type))
+                    checks.append((u'warning', u'%s has no organisation '
+                                               u'name' % partnership.iati_organisation_role))
             else:
                 checks.append((u'error', u'partnership has no organisation'))
 

akvo/iati/elements/participating_org.py

@@ -23,6 +23,8 @@ def participating_org(project):
     """
     partnership_elements = []
 
+    from akvo.rsr.models import Partnership
+
     for partnership in project.partnerships.all():
         org = partnership.organisation
         element = etree.Element("participating-org")
@@ -32,9 +34,9 @@ def participating_org(project):
 
         if org.new_organisation_type:
             element.attrib['type'] = str(org.new_organisation_type)
-
-        if partnership.partner_type in TYPE_TO_CODE.keys():
-            element.attrib['role'] = TYPE_TO_CODE[partnership.partner_type]
+        # don't include old akvo sponsor partner value when checking
+        if partnership.iati_organisation_role in Partnership.IATI_ROLE_LIST[:-1]:
+            element.attrib['role'] = str(partnership.iati_organisation_role)
 
         narrative_element = etree.SubElement(element, "narrative")
 

akvo/rest/rsr_api_upload/json/organisation_1.json

@@ -18,11 +18,6 @@
         "content_owner": null,
         "allow_edit": true,
         "primary_location": null,
-        "partner_types": [
-            "field",
-            "funding",
-            "sponsor"
-        ],
         "internal_org_ids": []
     },
     "organisation_location": {

akvo/rest/rsr_api_upload/json/project_1.json

@@ -98,7 +98,7 @@
     },
     "partnership": {
         "organisation": "Akvo",
-        "partner_type": "field",
+        "iati_organisation_role": "4",
         "funding_amount": null,
         "partner_type_extra": null,
         "iati_activity_id": null,
@@ -107,7 +107,7 @@
     },
     "partnership": {
         "organisation": "Akvo",
-        "partner_type": "funding",
+        "iati_organisation_role": "1",
         "funding_amount": 4711,
         "partner_type_extra": null,
         "iati_activity_id": null,

akvo/rest/serializers/__init__.py

@@ -27,7 +27,6 @@
 from .organisation_location import (OrganisationLocationSerializer,
                                     MapOrganisationLocationSerializer)
 from .partner_site import PartnerSiteSerializer
-from .partner_type import PartnerTypeSerializer
 from .partnership import PartnershipSerializer
 from .planned_disbursement import PlannedDisbursementSerializer
 from .policy_marker import PolicyMarkerSerializer
@@ -82,7 +81,6 @@
     'OrganisationLocationSerializer',
     'PartnershipSerializer',
     'PartnerSiteSerializer',
-    'PartnerTypeSerializer',
     'PlannedDisbursementSerializer',
     'PolicyMarkerSerializer',
     'ProjectCommentSerializer',

akvo/rest/serializers/partnership.py

@@ -4,6 +4,7 @@
 # See more details in the license.txt file located at the root folder of the Akvo RSR module.
 # For additional details on the GNU license please see < http://www.gnu.org/licenses/agpl.html >.
 
+from rest_framework import serializers
 
 from akvo.rsr.models import Partnership
 
@@ -12,5 +13,7 @@
 
 class PartnershipSerializer(BaseRSRSerializer):
 
+    partner_type = serializers.Field(source='iati_role_to_partner_type')
+
     class Meta:
         model = Partnership

akvo/rest/serializers/project_update_location.py

@@ -18,6 +18,9 @@ class Meta:
 
 class ProjectUpdateLocationExtraSerializer(ProjectUpdateLocationSerializer):
 
+    # Limit update data to its PK, this is needed because of Meta.depth = 2
+    location_target = serializers.Field(source='location_target.pk')
+
     class Meta(ProjectUpdateLocationSerializer.Meta):
         depth = 2
 

akvo/rest/urls.py

@@ -36,7 +36,6 @@
 router.register(r'organisation_location', views.OrganisationLocationViewSet)
 router.register(r'organisation_map_location', views.MapOrganisationLocationViewSet)
 router.register(r'partner_site', views.PartnerSiteViewSet)
-router.register(r'partner_type', views.PartnerTypeViewSet)
 router.register(r'partnership', views.PartnershipViewSet)
 router.register(r'planned_disbursement', views.PlannedDisbursementViewSet)
 router.register(r'policy_marker', views.PolicyMarkerViewSet)

akvo/rest/views/__init__.py

@@ -26,7 +26,6 @@
 from .organisation import OrganisationViewSet
 from .organisation_location import OrganisationLocationViewSet, MapOrganisationLocationViewSet
 from .partner_site import PartnerSiteViewSet
-from .partner_type import PartnerTypeViewSet
 from .partnership import PartnershipViewSet
 from .planned_disbursement import PlannedDisbursementViewSet
 from .policy_marker import PolicyMarkerViewSet
@@ -98,7 +97,6 @@
     'OrganisationCustomFieldViewSet',
     'PartnershipViewSet',
     'PartnerSiteViewSet',
-    'PartnerTypeViewSet',
     'PlannedDisbursementViewSet',
     'PolicyMarkerViewSet',
     'ProjectCommentViewSet',

akvo/rest/views/internal_organisation_id.py

@@ -18,19 +18,3 @@ class InternalOrganisationIDViewSet(BaseRSRViewSet):
     serializer_class = InternalOrganisationIDSerializer
     queryset = InternalOrganisationID.objects.all()
     filter_fields = ('recording_org', 'referenced_org', 'identifier', )
-
-    def get_queryset(self):
-        """
-        filter on recording org and/or identifier
-        """
-        queryset = self.queryset
-        recording_org = self.request.QUERY_PARAMS.get('recording_org', None)
-        identifier = self.request.QUERY_PARAMS.get('identifier', None)
-        filter_params = {}
-        if recording_org is not None:
-            filter_params.update(recording_org__id=recording_org)
-        if identifier is not None:
-            filter_params.update(identifier=identifier)
-        if filter:
-            queryset = queryset.filter(**filter_params)
-        return queryset

akvo/rest/views/organisation.py

@@ -71,24 +71,3 @@ class OrganisationViewSet(BaseRSRViewSet):
     serializer_class = OrganisationSerializer
     parser_classes = (AkvoOrganisationParser, JSONParser,)
     filter_fields = ('name', 'long_name', 'iati_org_id', 'content_owner')
-
-    def get_queryset(self):
-        """ Enable filtering of Organisations on iati_org_id or name
-        """
-        queryset = super(OrganisationViewSet, self).get_queryset()
-        pk = self.request.QUERY_PARAMS.get('id', None)
-        if pk is not None:
-            try:
-                queryset = queryset.filter(pk=pk)
-            except ValueError:
-                pass
-        iati_org_id = self.request.QUERY_PARAMS.get('iati_org_id', None)
-        if iati_org_id is not None:
-            queryset = queryset.filter(iati_org_id=iati_org_id)
-        name = self.request.QUERY_PARAMS.get('name', None)
-        if name is not None:
-            queryset = queryset.filter(name=name)
-        long_name = self.request.QUERY_PARAMS.get('long_name', None)
-        if long_name is not None:
-            queryset = queryset.filter(long_name=long_name)
-        return queryset

akvo/rest/views/partnership.py

@@ -16,4 +16,14 @@ class PartnershipViewSet(BaseRSRViewSet):
     """
     queryset = Partnership.objects.all()
     serializer_class = PartnershipSerializer
-    filter_fields = ('project', 'organisation', 'partner_type', )
+    filter_fields = ('project', 'organisation', 'iati_organisation_role', )
+
+    def get_queryset(self):
+        """Allow filtering on partner_type."""
+        queryset = self.queryset
+        partner_type = self.request.QUERY_PARAMS.get('partner_type', None)
+        if partner_type and partner_type in Partnership.PARTNER_TYPES_TO_ROLES_MAP.keys():
+            queryset = queryset.filter(
+                iati_organisation_role=Partnership.PARTNER_TYPES_TO_ROLES_MAP[partner_type]
+            )
+        return queryset

akvo/rest/views/project_editor.py

@@ -80,7 +80,7 @@
 
 PARTNER_FIELDS = (
     ('organisation', 'value-partner-', 'related-object'),
-    ('partner_type', 'partner-type-', 'text'),
+    ('iati_organisation_role', 'partner-role-', 'integer'),
     ('funding_amount', 'funding-amount-', 'decimal'),
 )
 
@@ -487,6 +487,7 @@ def log_addition(obj, user):
         change_message=change_message
     )
 
+
 @api_view(['POST'])
 @permission_classes((IsAuthenticated, ))
 def project_editor_delete_document(request, project_pk=None, document_pk=None):