Merge pull request #2002 from rtibbles/presets

Use and store facility configuration presets

Author: rtibbles

kolibri/auth/constants/facility_configuration_presets.json

@@ -0,0 +1,36 @@
+{
+  "formal": {
+    "name": "Admin-managed",
+    "default": true,
+    "mappings": {
+      "learner_can_edit_username": false,
+      "learner_can_edit_name": false,
+      "learner_can_edit_password": false,
+      "learner_can_sign_up": false,
+      "learner_can_delete_account": false,
+      "learner_can_login_with_no_password": true
+    }
+  },
+  "nonformal": {
+    "name": "Self-managed",
+    "mappings": {
+      "learner_can_edit_username": true,
+      "learner_can_edit_name": true,
+      "learner_can_edit_password": true,
+      "learner_can_sign_up": true,
+      "learner_can_delete_account": true,
+      "learner_can_login_with_no_password": false
+    }
+  },
+  "informal": {
+    "name": "Informal and personal use",
+    "mappings": {
+      "learner_can_edit_username": true,
+      "learner_can_edit_name": true,
+      "learner_can_edit_password": true,
+      "learner_can_sign_up": false,
+      "learner_can_delete_account": true,
+      "learner_can_login_with_no_password": false
+    }
+  }
+}

kolibri/auth/constants/facility_presets.py

@@ -0,0 +1,17 @@
+import json
+import os
+
+from django.utils.translation import ugettext_lazy as _
+
+with open(os.path.join(os.path.dirname(__file__), './facility_configuration_presets.json'), 'r') as f:
+    presets = json.load(f)
+
+choices = list(
+    (key, _(item['name'])) for key, item in presets.items()
+)
+
+mappings = {
+    key: item['mappings'] for key, item in presets.items()
+}
+
+default = next((key for key, item in presets.items() if item.get('default')), None)

kolibri/auth/migrations/0004_auto_20170816_1607.py

@@ -13,19 +13,25 @@ def device_owner_to_super_user(apps, schema_editor):
     default_facility = Facility.objects.all().first()
     DevicePermissions = apps.get_model('device', 'DevicePermissions')
     DeviceSettings = apps.get_model('device', 'DeviceSettings')
+    from kolibri.auth.models import FacilityUser as RealFacilityUser, Facility as RealFacility
+    real_default_facility = RealFacility.get_default_facility()
     # Can't do much if no facilities exist, as no facility to FK the users onto
     if default_facility:
         for device_owner in DeviceOwner.objects.all():
+            uuid = RealFacilityUser(username=device_owner.username, facility=real_default_facility).calculate_uuid()
+            dataset_id = real_default_facility.dataset_id
             superuser = FacilityUser.objects.create(
                 username=device_owner.username,
                 password=device_owner.password,
                 facility=default_facility,
                 full_name=device_owner.full_name,
                 date_joined=device_owner.date_joined,
+                id=uuid,
+                dataset_id=dataset_id,
             )
             DevicePermissions.objects.create(user=superuser, is_superuser=True)
         # Finally, set the is_provisioned flag
-        settings, created = DeviceSettings.get_or_create(is_provisioned=True)
+        settings, created = DeviceSettings.objects.get_or_create(is_provisioned=True)
 
 
 class Migration(migrations.Migration):

kolibri/auth/migrations/0005_auto_20170818_1203.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.7 on 2017-08-18 19:03
+from __future__ import unicode_literals
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('kolibriauth', '0004_auto_20170816_1607'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='facilitydataset',
+            name='preset',
+            field=models.CharField(choices=[('formal', 'Admin-managed'), ('informal', 'Informal and personal use'), ('nonformal', 'Self-managed')], default='formal', max_length=50),
+        ),
+    ]

kolibri/auth/models.py

@@ -41,7 +41,7 @@
 from morango.utils.morango_mptt import MorangoMPTTModel
 from mptt.models import TreeForeignKey
 
-from .constants import collection_kinds, role_kinds
+from .constants import collection_kinds, facility_presets, role_kinds
 from .errors import (
     InvalidRoleKind, UserDoesNotHaveRoleError, UserHasRoleOnlyIndirectlyThroughHierarchyError, UserIsMemberOnlyIndirectlyThroughHierarchyError,
     UserIsNotFacilityUser, UserIsNotMemberError
@@ -89,6 +89,8 @@ class FacilityDataset(FacilityDataSyncableModel):
     description = models.TextField(blank=True)
     location = models.CharField(max_length=200, blank=True)
 
+    preset = models.CharField(max_length=50, choices=facility_presets.choices, default=facility_presets.default)
+
     # Facility specific configuration settings
     learner_can_edit_username = models.BooleanField(default=True)
     learner_can_edit_name = models.BooleanField(default=True)

kolibri/core/device/serializers.py

@@ -1,7 +1,8 @@
 from django.db import transaction
 from django.utils.translation import check_for_language, ugettext_lazy as _
+from kolibri.auth.constants.facility_presets import choices, mappings
 from kolibri.auth.models import Facility, FacilityUser
-from kolibri.auth.serializers import FacilityDatasetSerializer, FacilitySerializer, FacilityUserSerializer
+from kolibri.auth.serializers import FacilitySerializer, FacilityUserSerializer
 from rest_framework import serializers
 
 from .models import DevicePermissions, DeviceSettings
@@ -24,7 +25,7 @@ class Meta:
 
 class DeviceProvisionSerializer(serializers.Serializer):
     facility = FacilitySerializer()
-    dataset = FacilityDatasetSerializer()
+    preset = serializers.ChoiceField(choices=choices)
     superuser = NoFacilityFacilityUserSerializer()
     language_code = serializers.CharField(max_length=15)
 
@@ -50,7 +51,8 @@ def create(self, validated_data):
         """
         with transaction.atomic():
             facility = Facility.objects.create(**validated_data.pop('facility'))
-            dataset_data = validated_data.pop('dataset')
+            preset = validated_data.pop('preset')
+            dataset_data = mappings[preset]
             for key, value in dataset_data.items():
                 setattr(facility.dataset, key, value)
             facility.dataset.save()
@@ -65,7 +67,7 @@ def create(self, validated_data):
             device_settings.save()
             return {
                 "facility": facility,
-                "dataset": facility.dataset,
+                "preset": preset,
                 "superuser": superuser,
                 "language_code": language_code
             }

kolibri/core/device/test/test_api.py

@@ -11,9 +11,8 @@ class DeviceProvisionTestCase(APITestCase):
 
     superuser_data = {"username": "superuser", "password": "password"}
     facility_data = {"name": "Wilson Elementary"}
+    preset_data = "nonformal"
     dataset_data = {
-        "description": "",
-        "location": "Somewhere over the rainbow",
         "learner_can_edit_username": True,
         "learner_can_edit_name": True,
         "learner_can_edit_password": True,
@@ -29,7 +28,7 @@ def test_cannot_post_if_provisioned(self):
         data = {
             "superuser": self.superuser_data,
             "facility": self.facility_data,
-            "dataset": self.dataset_data,
+            "preset": self.preset_data,
             "language_code": self.language_code,
         }
         response = self.client.post(reverse('deviceprovision'), data, format="json")
@@ -39,7 +38,7 @@ def test_superuser_created(self):
         data = {
             "superuser": self.superuser_data,
             "facility": self.facility_data,
-            "dataset": self.dataset_data,
+            "preset": self.preset_data,
             "language_code": self.language_code,
         }
         self.client.post(reverse('deviceprovision'), data, format="json")
@@ -49,7 +48,7 @@ def test_superuser_device_permissions_created(self):
         data = {
             "superuser": self.superuser_data,
             "facility": self.facility_data,
-            "dataset": self.dataset_data,
+            "preset": self.preset_data,
             "language_code": self.language_code,
         }
         self.client.post(reverse('deviceprovision'), data, format="json")
@@ -59,7 +58,7 @@ def test_facility_created(self):
         data = {
             "superuser": self.superuser_data,
             "facility": self.facility_data,
-            "dataset": self.dataset_data,
+            "preset": self.preset_data,
             "language_code": self.language_code,
         }
         self.client.post(reverse('deviceprovision'), data, format="json")
@@ -69,8 +68,13 @@ def test_dataset_set_created(self):
         data = {
             "superuser": self.superuser_data,
             "facility": self.facility_data,
-            "dataset": self.dataset_data,
+            "preset": self.preset_data,
             "language_code": self.language_code,
         }
         self.client.post(reverse('deviceprovision'), data, format="json")
-        self.assertEqual(FacilityDataset.objects.get().location, self.dataset_data["location"])
+        self.assertEqual(FacilityDataset.objects.get().learner_can_edit_username, self.dataset_data["learner_can_edit_username"])
+        self.assertEqual(FacilityDataset.objects.get().learner_can_edit_name, self.dataset_data["learner_can_edit_name"])
+        self.assertEqual(FacilityDataset.objects.get().learner_can_edit_password, self.dataset_data["learner_can_edit_password"])
+        self.assertEqual(FacilityDataset.objects.get().learner_can_sign_up, self.dataset_data["learner_can_sign_up"])
+        self.assertEqual(FacilityDataset.objects.get().learner_can_delete_account, self.dataset_data["learner_can_delete_account"])
+        self.assertEqual(FacilityDataset.objects.get().learner_can_login_with_no_password, self.dataset_data["learner_can_login_with_no_password"])

kolibri/plugins/setup_wizard/assets/src/state/actions.js

@@ -1,12 +1,12 @@
 import { DeviceProvisionResource } from 'kolibri.resources';
 import { kolibriLogin, handleApiError } from 'kolibri.coreVue.vuex.actions';
 
-export function provisionDevice(store, superuser, facility, dataset, languageCode) {
+export function provisionDevice(store, superuser, facility, preset, language_code) {
   const DeviceProvisionModel = DeviceProvisionResource.createModel({
     superuser,
     facility,
-    dataset,
-    language_code: languageCode,
+    preset,
+    language_code,
   });
   const deviceProvisionPromise = DeviceProvisionModel.save();
 

kolibri/plugins/setup_wizard/assets/src/state/constants.js

@@ -0,0 +1,3 @@
+import presets from '../../../../../auth/constants/facility_configuration_presets.json';
+
+export const facilityPresetChoices = Object.keys(presets);

kolibri/plugins/setup_wizard/assets/src/views/index.vue

@@ -102,6 +102,7 @@
   import kTextbox from 'kolibri.coreVue.components.kTextbox';
   import kButton from 'kolibri.coreVue.components.kButton';
   import uiAlert from 'keen-ui/src/UiAlert';
+  import { facilityPresetChoices } from '../state/constants';
   export default {
     name: 'setupWizard',
     $trs: {
@@ -137,6 +138,7 @@
         facility: '',
         facilityError: null,
         globalError: null,
+        preset: facilityPresetChoices[0],
       };
     },
     components: {
@@ -169,6 +171,9 @@
       firstFacilityFieldVisit() {
         return this.facilityError === null;
       },
+      presetValidityCheck() {
+        facilityPresetChoices.includes(this.preset);
+      },
       allFieldsPopulated() {
         return (
           this.passwordFieldsPopulated && this.usernameFieldPopulated && this.facilityFieldPopulated
@@ -195,17 +200,8 @@
           const facility = { name: this.facility };
           // TODO (rtibbles - paging DXCanas): Actually set these!
           const languageCode = 'en';
-          const dataset = {
-            description: '',
-            location: 'Somewhere over the rainbow',
-            learner_can_edit_username: true,
-            learner_can_edit_name: true,
-            learner_can_edit_password: true,
-            learner_can_sign_up: true,
-            learner_can_delete_account: true,
-            learner_can_login_with_no_password: false,
-          };
-          this.provisionDevice(superuser, facility, dataset, languageCode);
+          const preset = 'nonformal';
+          this.provisionDevice(superuser, facility, preset, languageCode);
         } else {
           if (this.firstUsernameFieldVisit) {
             this.visitUsername();