Merge pull request #248 from RSE-Sheffield/feat/21-manage-org-members

Organisation member management

Author: Joe-Heffer-Shef

README.md

@@ -2,7 +2,6 @@
 # SORT
 ### Self-Assessment of Organisational Readiness Tool
 
-
 The SORT provides a comprehensive self-assessment framework, enabling organisations to evaluate and strengthen their research capabilities within nursing and 
 broader health and care practices. By guiding you through forty-four targeted statements, SORT helps assess your current level of research maturity 
 and the support available for nurses involved in research. Upon completion, your organisation will be equipped to create a tailored improvement plan to better 
@@ -70,6 +69,7 @@ DJANGO_SECRET_KEY=your_secret_key
 DJANGO_DEBUG=True
 DJANGO_ALLOWED_HOSTS=127.0.0.1 localhost
 DJANGO_EMAIL_BACKEND=django.core.mail.backends.console.EmailBackend
+DJANGO_LOG_LEVEL=DEBUG
 ```
 
 ---

SORT/settings.py

@@ -60,12 +60,13 @@ def cast_to_boolean(obj: Any) -> bool:
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
-    # Plugins
+    # Plugin apps
     "django_bootstrap5",
     "django_extensions",
     "qr_code",
     "crispy_forms",
     "crispy_bootstrap5",
+    "invitations",
     # SORT apps
     "home",
     "survey",
@@ -260,3 +261,9 @@ def cast_to_boolean(obj: Any) -> bool:
 # https://django-crispy-forms.readthedocs.io/en/latest/install.html
 CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
 CRISPY_TEMPLATE_PACK = "bootstrap5"
+
+# Invitations options
+# https://django-invitations.readthedocs.io/en/latest/configuration.html
+INVITATIONS_SIGNUP_REDIRECT = "signup"
+INVITATIONS_CONFIRMATION_URL_NAME = "member_invite_accept"
+INVITATIONS_EMAIL_SUBJECT_PREFIX = "SORT"

docs/invitations.md

@@ -0,0 +1,14 @@
+# Invitations
+
+https://django-invitations.readthedocs.io/
+
+# Usage
+
+## Clear invitations
+
+[Invitations management command](https://django-invitations.readthedocs.io/en/latest/usage.html#management-commands)
+
+```bash
+python manage.py clear_expired_invitations
+```
+

docs/templates.md

@@ -0,0 +1,8 @@
+# Icons
+
+The [Boxicons](https://boxicons.com/) website has a gallery of available icons that can be implemented using the following HTML code:
+
+```html
+<i class='bx bxs-envelope'></i>
+```
+

home/forms.py

@@ -0,0 +1,6 @@
+from .manager_signup import ManagerSignupForm
+from .manager_login import ManagerLoginForm
+from .search_bar import SearchBarForm
+from .user_profile import UserProfileForm
+
+__all__ = ["ManagerSignupForm", "ManagerLoginForm", "SearchBarForm", "UserProfileForm"]

home/forms/__init__.py

@@ -0,0 +1,8 @@
+import django.forms as forms
+from django.contrib.auth.forms import AuthenticationForm
+
+
+class ManagerLoginForm(AuthenticationForm):
+    username = forms.EmailField(
+        label="Email", max_length=60, widget=forms.EmailInput(attrs={"autofocus": True})
+    )

home/forms/manager_login.py

@@ -0,0 +1,76 @@
+"""
+New manager registration form
+"""
+
+import django.contrib.auth.models
+import django.forms as forms
+from django.contrib.auth.forms import UserCreationForm
+from invitations.models import Invitation
+
+from home.services import organisation_service
+from home.models import Organisation
+from home.constants import ROLE_PROJECT_MANAGER
+
+User = django.contrib.auth.get_user_model()
+
+
+class ManagerSignupForm(UserCreationForm):
+    """
+    A form to register a new user (a new manager) who was invited by
+    an existing manager of an organisation.
+    """
+
+    class Meta:
+        model = User
+        fields = ("password1", "password2")
+
+    # Secret key for the invitation (hidden form field)
+    key = forms.CharField(required=False, disabled=True, widget=forms.HiddenInput, label="")
+
+    @property
+    def invitation(self) -> Invitation:
+        """
+        The invitation that the existing manager send to the new user.
+        """
+        return Invitation.objects.get(key=self.data["key"])
+
+    @property
+    def inviter(self) -> User:
+        """
+        The user (manager) who invited this new manager.
+        """
+        return User.objects.get(pk=self.invitation.inviter_id)
+
+    @property
+    def organisation(self) -> Organisation:
+        """
+        The organisation that the new user was invited to join.
+        """
+        organisation = organisation_service.get_user_organisation(user=self.inviter)
+        if organisation is None:
+            raise forms.ValidationError("This user is not a manager of an organisation")
+        return organisation
+
+    @property
+    def email(self) -> str:
+        """
+        The email address of the new user that received the invitation email.
+        """
+        return self.invitation.email
+
+    def save(self, commit=True):
+        user = super().save(commit=False)
+        user.email = self.email
+        user.username = user.email
+        if commit:
+            user.save()
+
+        # Add user to organisation
+        organisation_service.add_user_to_organisation(
+            user_to_add=user,
+            organisation=self.organisation,
+            user=self.inviter,
+            role=ROLE_PROJECT_MANAGER,
+        )
+
+        return user

home/forms/manager_signup.py

@@ -0,0 +1,15 @@
+import django.forms as forms
+
+
+class SearchBarForm(forms.Form):
+    q = forms.CharField(
+        required=False,
+        widget=forms.TextInput(
+            attrs={
+                "class": "form-control",
+                "placeholder": "Search...",
+                "aria-label": "Search",
+                "name": "q",
+            }
+        ),
+    )

home/forms/search_bar.py

@@ -0,0 +1,28 @@
+import django.contrib.auth
+import django.forms as forms
+
+User = django.contrib.auth.get_user_model()
+
+
+class UserProfileForm(forms.ModelForm):
+    class Meta:
+        model = User
+        fields = ["email", "first_name", "last_name"]
+
+    def clean_email(self):
+        email = self.cleaned_data.get("email")
+
+        if email == self.instance.email:
+            return email
+
+        if User.objects.exclude(pk=self.instance.pk).filter(email=email).exists():
+            raise forms.ValidationError("This email is already in use.")
+        return email
+
+    def save(self, commit=True):
+        user = super().save(commit=False)
+        if self.cleaned_data.get("password"):
+            user.set_password(self.cleaned_data["password"])
+        if commit:
+            user.save()
+        return user