[OSDEV-2066] Enable POST/PATCH fields permission by attribute

doc/release/RELEASE-NOTES.md

@@ -16,6 +16,8 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### What's new
 * [OSDEV-2164](https://opensupplyhub.atlassian.net/browse/OSDEV-2164) - Added search functionality for user email and contributor name in the Facility Download Limits admin page.
+* [OSDEV-2066](https://opensupplyhub.atlassian.net/browse/OSDEV-2066) - Added permission system to control which partner data fields contributors can submit.
+Created new `PartnerField` model for categorizing partner-specific fields. Enhanced `Contributor` model with `partner_fields` relationship.
 
 ### Release instructions
 * Ensure that the following commands are included in the `post_deployment` command:

src/django/api/admin.py

@@ -10,6 +10,7 @@
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext as _
 from api.models.sector_group import SectorGroup
+from api.models.partner_field import PartnerField
 from simple_history.admin import SimpleHistoryAdmin
 from waffle.models import Flag, Sample, Switch
 from waffle.admin import FlagAdmin, SampleAdmin, SwitchAdmin
@@ -113,6 +114,7 @@ def pretty_results(self, instance):
 class ContributorAdmin(SimpleHistoryAdmin):
     history_list_display = ('is_verified', 'verification_notes')
     search_fields = ('name', 'admin__email')
+    filter_horizontal = ('partner_fields',)
 
     def get_ordering(self, request):
         return ['name']
@@ -239,6 +241,12 @@ def get_ordering(self, request):
         return ['name']
 
 
+class PartnerFieldAdmin(admin.ModelAdmin):
+    list_display = ('name', 'type', 'created_at')
+    search_fields = ('name', 'type')
+    readonly_fields = ('uuid', 'created_at', 'updated_at')
+
+
 admin_site.register(models.Version)
 admin_site.register(models.User, OarUserAdmin)
 admin_site.register(models.Contributor, ContributorAdmin)
@@ -261,3 +269,4 @@ def get_ordering(self, request):
 admin_site.register(models.Sector, SectorAdmin)
 admin_site.register(SectorGroup, SectorGroupAdmin)
 admin_site.register(models.FacilityDownloadLimit, FacilityDownloadLimitAdmin)
+admin_site.register(PartnerField, PartnerFieldAdmin)

src/django/api/migrations/0177_add_partner_fields_to_contributor.py

@@ -0,0 +1,37 @@
+from django.db import migrations, models
+import uuid
+
+class Migration(migrations.Migration):
+    """
+    Migration to create PartnerField model and add partner_fields ManyToManyField to Contributor model.
+    """
+
+    dependencies = [
+        ('api', '0176_introduce_enable_dromo_uploading_switch'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='PartnerField',
+            fields=[
+                ('name', models.CharField(help_text='The partner field name.', max_length=200, primary_key=True, serialize=False)),
+                ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, help_text='Unique identifier for the partner field.', unique=True)),
+                ('type', models.CharField(help_text='The partner field type.', max_length=200, blank=False, null=False, choices=[('int','int'),('float','float'),('string','string'),('object','object')])),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+            ],
+            options={
+                'verbose_name_plural': 'partner field',
+            },
+        ),
+
+        migrations.AddField(
+            model_name='contributor',
+            name='partner_fields',
+            field=models.ManyToManyField(
+                blank=True,
+                help_text='Partner fields that this contributor can access',
+                to='api.partnerfield'
+            ),
+        ),
+    ]

src/django/api/models/__init__.py

@@ -80,3 +80,4 @@
 from .version import Version
 from .moderation_event import ModerationEvent
 from .download_location_payment import DownloadLocationPayment
+from .partner_field import PartnerField

src/django/api/models/contributor/contributor.py

@@ -130,13 +130,18 @@ class Contributor(models.Model):
         max_length=200,
         help_text="The environment value where instance running"
     )
+    partner_fields = models.ManyToManyField(
+        'PartnerField',
+        blank=True,
+        help_text='Partner fields that this contributor can access'
+    )
 
     created_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
 
     objects = ContributorManager.as_manager()
     history = HistoricalRecords(
-        excluded_fields=['uuid', 'origin_source']
+        excluded_fields=['uuid', 'origin_source', 'partner_fields']
     )
 
     def __str__(self):

src/django/api/models/partner_field.py

@@ -0,0 +1,46 @@
+import uuid
+from django.db import models
+
+
+class PartnerField(models.Model):
+    """
+    Partner Field that will be protected for contribution.
+    """
+    INT = 'int'
+    FLOAT = 'float'
+    STRING = 'string'
+    OBJECT = 'object'
+
+    TYPE_CHOICES = (
+        (INT, INT),
+        (FLOAT, FLOAT),
+        (STRING, STRING),
+        (OBJECT, OBJECT)
+    )
+
+    class Meta:
+        verbose_name_plural = "partner field"
+
+    uuid = models.UUIDField(
+        null=False,
+        default=uuid.uuid4,
+        unique=True,
+        editable=False,
+        help_text='Unique identifier for the partner field.'
+    )
+    name = models.CharField(
+        max_length=200,
+        primary_key=True,
+        help_text=('The partner field name.'))
+    type = models.CharField(
+        max_length=200,
+        null=False,
+        blank=False,
+        choices=TYPE_CHOICES,
+        help_text=('The partner field type.'))
+
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return self.name

src/django/api/moderation_event_actions/creation/location_contribution/location_contribution.py

@@ -9,6 +9,8 @@
     import ProductionLocationDataProcessor
 from api.moderation_event_actions.creation.location_contribution \
     .processors.geocoding_processor import GeocodingProcessor
+from api.moderation_event_actions.creation.location_contribution \
+    .processors.permission_processor import PermissionProcessor
 from api.moderation_event_actions.creation.dtos.create_moderation_event_dto \
     import CreateModerationEventDTO
 
@@ -34,6 +36,7 @@ def serialize(
     @staticmethod
     def __setup_location_data_processors() -> ContributionProcessor:
         location_data_processors = (
+            PermissionProcessor(),
             SourceProcessor(),
             ProductionLocationDataProcessor(),
             GeocodingProcessor()

src/django/api/moderation_event_actions/creation/location_contribution/processors/permission_processor.py

@@ -0,0 +1,67 @@
+from typing import Dict, List
+
+from rest_framework import status
+
+from api.moderation_event_actions.creation.location_contribution \
+    .processors.contribution_processor import ContributionProcessor
+from api.moderation_event_actions.creation.dtos.create_moderation_event_dto \
+    import CreateModerationEventDTO
+from api.models.partner_field import PartnerField
+from api.constants import APIV1CommonErrorMessages
+
+
+class PermissionProcessor(ContributionProcessor):
+
+    def process(
+            self,
+            event_dto: CreateModerationEventDTO) -> CreateModerationEventDTO:
+
+        partner_fields = PartnerField.objects.all()
+        partner_field_names = [field.name for field in partner_fields]
+
+        if event_dto.raw_data and isinstance(event_dto.raw_data, dict):
+            matching_partner_field_names = [
+                key for key in event_dto.raw_data.keys()
+                if key in partner_field_names
+            ]
+
+            if matching_partner_field_names:
+                contributor_partner_fields = event_dto.contributor \
+                    .partner_fields.all()
+                contributor_partner_field_names = [
+                    field.name for field in contributor_partner_fields
+                ]
+
+                unauthorized_partner_fields = [
+                    name for name in matching_partner_field_names
+                    if name not in contributor_partner_field_names
+                ]
+
+                if unauthorized_partner_fields:
+                    validation_errors = self.__transform_fields_errors(
+                        unauthorized_partner_fields
+                    )
+                    event_dto.errors = validation_errors
+                    event_dto.status_code = status.HTTP_403_FORBIDDEN
+
+                    return event_dto
+
+        return super().process(event_dto)
+
+    @staticmethod
+    def __transform_fields_errors(fields_errors: List[str]) -> Dict:
+        validation_errors = {
+            'detail': APIV1CommonErrorMessages.COMMON_REQ_BODY_ERROR,
+            'errors': []
+        }
+
+        for field_name in fields_errors:
+            validation_errors['errors'].append(
+                {
+                    'field': field_name,
+                    'detail': 'You do not have permission '
+                    'to contribute to this field.'
+                }
+            )
+
+        return validation_errors