Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Allow registration of users via REST API

Roland Geider98a8cce7e207
diff --git a/wger/core/api/permissions.py b/wger/core/api/permissions.py
new file mode 100644
index 000000000..1e8b446c2
--- /dev/null
+++ b/wger/core/api/permissions.py
@@ -0,0 +1,31 @@
+# This file is part of wger Workout Manager.
+#
+# wger Workout Manager is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# wger Workout Manager is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Workout Manager. If not, see <http://www.gnu.org/licenses/>.
+
+# Third Party
+from rest_framework.permissions import BasePermission
+
+
+class AllowRegisterUser(BasePermission):
+ """
+ Checks that users are allow to register via API.
+
+ Apps can register user via the REST API, but only if they have been whitelisted first
+ """
+
+ def has_permission(self, request, view):
+ if request.user.is_anonymous:
+ return False
+
+ return request.user.userprofile.can_add_user
diff --git a/wger/core/api/serializers.py b/wger/core/api/serializers.py
index 8c4257773..a7850b9cf 100644
--- a/wger/core/api/serializers.py
+++ b/wger/core/api/serializers.py
@@ -17,9 +17,11 @@
# Django
from django.contrib.auth.models import User
+from django.contrib.auth.password_validation import validate_password
# Third Party
from rest_framework import serializers
+from rest_framework.validators import UniqueValidator
# wger
from wger.core.models import (
@@ -84,6 +86,23 @@ class UserApiSerializer(serializers.ModelSerializer):
fields = ['username', 'password']
+class UserRegistrationSerializer(serializers.ModelSerializer):
+ username = serializers.CharField(required=True,
+ validators=[UniqueValidator(queryset=User.objects.all())])
+ password = serializers.CharField(write_only=True, required=True, validators=[validate_password])
+
+ class Meta:
+ model = User
+ fields = ('username', 'password')
+
+ def create(self, validated_data):
+ user = User.objects.create(username=validated_data['username'])
+ user.set_password(validated_data['password'])
+ user.save()
+
+ return user
+
+
class LanguageSerializer(serializers.ModelSerializer):
"""
Language serializer
diff --git a/wger/core/api/views.py b/wger/core/api/views.py
index 1aa401b1f..59ab86935 100644
--- a/wger/core/api/views.py
+++ b/wger/core/api/views.py
@@ -32,6 +32,7 @@ from rest_framework.response import Response
# wger
from wger import get_version
+from wger.core.api.permissions import AllowRegisterUser
from wger.core.api.serializers import (
DaysOfWeekSerializer,
LanguageSerializer,
@@ -40,6 +41,7 @@ from wger.core.api.serializers import (
UserApiSerializer,
UsernameSerializer,
UserprofileSerializer,
+ UserRegistrationSerializer,
WeightUnitSerializer
)
from wger.core.models import (
@@ -138,6 +140,31 @@ class UserAPILoginView(viewsets.ViewSet):
status=status.HTTP_401_UNAUTHORIZED)
+class UserAPIRegistrationViewSet(viewsets.ViewSet):
+ """
+ API endpoint for api user objects
+ """
+ permission_classes = (AllowRegisterUser, )
+ serializer_class = UserRegistrationSerializer
+
+ def get_queryset(self):
+ """
+ Only allow access to appropriate objects
+ """
+ return UserProfile.objects.filter(user=self.request.user)
+
+ def post(self, request):
+ data = request.data
+ serializer = self.serializer_class(data=data)
+ serializer.is_valid(raise_exception=True)
+ user = serializer.save()
+ token = create_token(user)
+
+ return Response({'message': 'api user successfully registered',
+ 'token': token.key},
+ status=status.HTTP_201_CREATED)
+
+
class LanguageViewSet(viewsets.ReadOnlyModelViewSet):
"""
API endpoint for workout objects
diff --git a/wger/core/fixtures/test-user-data.json b/wger/core/fixtures/test-user-data.json
index 3992a7134..92c52a426 100644
--- a/wger/core/fixtures/test-user-data.json
+++ b/wger/core/fixtures/test-user-data.json
@@ -498,12 +498,14 @@
"workout_reminder": 20,
"workout_duration": 8,
"notification_language": 1,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": true,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -529,12 +531,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":3
+ "num_days_weight_reminder": 3,
+ "added_by": null,
+ "can_add_user": true
}
},
{
@@ -563,7 +567,9 @@
"gym": 2,
"weight_unit": "kg",
"ro_access": true,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -589,12 +595,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": 2,
+ "can_add_user": false
}
},
{
@@ -620,12 +628,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": 2,
+ "can_add_user": false
}
},
{
@@ -651,12 +661,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -682,12 +694,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 2,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 2,
"weight_unit": "lb",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -713,12 +727,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 2,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 2,
"weight_unit": "lb",
"ro_access": true,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -744,12 +760,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -775,12 +793,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -806,12 +826,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 2,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 2,
"weight_unit": "lb",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -837,12 +859,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 1,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 1,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -868,12 +892,14 @@
"workout_reminder": 14,
"workout_duration": 12,
"notification_language": 2,
- "timer_active": true,
- "timer_pause": 90,
- "gym": 2,
+ "timer_active": true,
+ "timer_pause": 90,
+ "gym": 2,
"weight_unit": "lb",
"ro_access": true,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -904,7 +930,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -935,7 +963,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -966,7 +996,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -997,7 +1029,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -1028,7 +1062,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -1059,7 +1095,9 @@
"is_temporary": false,
"weight_unit": "lb",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -1090,7 +1128,9 @@
"is_temporary": false,
"weight_unit": "lb",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -1121,7 +1161,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -1152,7 +1194,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -1183,7 +1227,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
@@ -1214,7 +1260,9 @@
"is_temporary": false,
"weight_unit": "kg",
"ro_access": false,
- "num_days_weight_reminder":0
+ "num_days_weight_reminder": 0,
+ "added_by": null,
+ "can_add_user": false
}
},
{
diff --git a/wger/core/management/commands/add-user-rest.py b/wger/core/management/commands/add-user-rest.py
new file mode 100644
index 000000000..536727eef
--- /dev/null
+++ b/wger/core/management/commands/add-user-rest.py
@@ -0,0 +1,46 @@
+# Django
+from django.core.management.base import BaseCommand
+
+# wger
+from wger.core.models import User
+
+
+"""
+Custom command permitting users to create user accounts
+"""
+
+
+class Command(BaseCommand):
+
+ help = 'Permit user to create user accounts'
+
+ # Named (optional arguments)
+ def add_arguments(self, parser):
+ parser.add_argument('name', type=str)
+
+ parser.add_argument(
+ '--disable',
+ action='store_true',
+ dest='disable',
+ default=False
+ )
+
+ def handle(self, *args, **options):
+ name = options['name']
+
+ try:
+ user = User.objects.get(username=name)
+
+ if options['disable']:
+ user.userprofile.can_add_user = False
+ self.stdout.write(self.style.SUCCESS(
+ f"{options['name']} is now DISABLED from adding users via the API"))
+
+ else:
+ user.userprofile.can_add_user = True
+ self.stdout.write(self.style.SUCCESS(
+ f"{options['name']} is now ALLOWED to add users via the API"))
+ user.userprofile.save()
+
+ except Exception as exc:
+ self.stdout.write(self.style.WARNING(exc))
diff --git a/wger/core/management/commands/list-users-api.py b/wger/core/management/commands/list-users-api.py
new file mode 100644
index 000000000..9490ae9e2
--- /dev/null
+++ b/wger/core/management/commands/list-users-api.py
@@ -0,0 +1,23 @@
+# Django
+from django.core.management.base import BaseCommand
+
+# wger
+from wger.core.models import UserProfile
+
+
+"""
+List users registered via the API
+"""
+
+
+class Command(BaseCommand):
+
+ help = 'List all users registered via REST, grouped by app-user'
+
+ def handle(self, *args, **options):
+
+ for app_profile in UserProfile.objects.filter(can_add_user=True):
+ self.stdout.write(self.style.SUCCESS(f"Users created by {app_profile.user.username}:"))
+
+ for user_profile in UserProfile.objects.filter(added_by=app_profile.user):
+ self.stdout.write(f"- {user_profile.user.username}")
diff --git a/wger/core/migrations/0012_auto_20210210_1228.py b/wger/core/migrations/0012_auto_20210210_1228.py
new file mode 100644
index 000000000..4cfb95c50
--- /dev/null
+++ b/wger/core/migrations/0012_auto_20210210_1228.py
@@ -0,0 +1,30 @@
+# Generated by Django 3.1.5 on 2021-02-10 11:28
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+ ('core', '0011_auto_20201201_0653'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='userprofile',
+ name='added_by',
+ field=models.ForeignKey(editable=False,
+ null=True,
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name='added_by',
+ to=settings.AUTH_USER_MODEL),
+ ),
+ migrations.AddField(
+ model_name='userprofile',
+ name='can_add_user',
+ field=models.BooleanField(default=False, editable=False),
+ ),
+ ]
diff --git a/wger/core/models.py b/wger/core/models.py
index 72547dace..168ffff2a 100644
--- a/wger/core/models.py
+++ b/wger/core/models.py
@@ -340,6 +340,23 @@ by the US Department of Agriculture. It is extremely complete, with around
default=0)
"""Number of Days for email weight reminder"""
+ #
+ # API
+ #
+ added_by = models.ForeignKey(User,
+ editable=False,
+ null=True,
+ related_name='added_by',
+ on_delete=models.CASCADE)
+ """User that originally registered this user via REST API"""
+
+ can_add_user = models.BooleanField(default=False,
+ editable=False)
+ """
+ Flag to indicate whether the (app) user can register other users on his
+ behalf over the REST API
+ """
+
@property
def weight(self):
"""
diff --git a/wger/core/tests/test_user_rest_registration.py b/wger/core/tests/test_user_rest_registration.py
new file mode 100644
index 000000000..979328dfc
--- /dev/null
+++ b/wger/core/tests/test_user_rest_registration.py
@@ -0,0 +1,110 @@
+# Standard Library
+from io import StringIO
+
+# Django
+from django.contrib.auth.models import User
+from django.core.management import call_command
+from django.urls import reverse
+
+# Third Party
+from rest_framework.authtoken.models import Token
+from rest_framework.status import (
+ HTTP_201_CREATED,
+ HTTP_400_BAD_REQUEST,
+ HTTP_403_FORBIDDEN
+)
+
+# wger
+from wger.core.tests.base_testcase import WgerTestCase
+
+
+class CreateUserCommand(WgerTestCase):
+
+ def setUp(self):
+ super(CreateUserCommand, self).setUp()
+ self.out = StringIO()
+
+ def test_access_api_user_creation(self):
+ """Tests giving permission to register users via API"""
+
+ user = User.objects.get(username='admin')
+ self.assertFalse(user.userprofile.can_add_user)
+
+ call_command('add-user-rest', 'admin', stdout=self.out, no_color=True)
+ self.assertEqual('admin is now ALLOWED to add users via the API\n', self.out.getvalue())
+
+ user = User.objects.get(username='admin')
+ self.assertTrue(user.userprofile.can_add_user)
+
+ def test_revoke_access_api_user_creation(self):
+ """Tests revoking permission to register users via API"""
+
+ user = User.objects.get(username='test')
+ self.assertTrue(user.userprofile.can_add_user)
+
+ call_command('add-user-rest', 'test', disable=True, stdout=self.out, no_color=True)
+ self.assertEqual('test is now DISABLED from adding users via the API\n',
+ self.out.getvalue())
+
+ user = User.objects.get(username='test')
+ self.assertFalse(user.userprofile.can_add_user)
+
+ def test_access_get_api_users(self):
+ """Tests listing created users via API"""
+
+ call_command('list-users-api', stdout=self.out, no_color=True)
+ self.assertIn('Users created by test:', self.out.getvalue())
+ self.assertIn('- trainer1', self.out.getvalue())
+ self.assertIn('- trainer2', self.out.getvalue())
+
+ def test_post_valid_api_user_creation(self):
+ """Successfully register a user via the REST API"""
+
+ self.user_login('test')
+ user = User.objects.get(username='test')
+ token = Token.objects.get(user=user)
+ count_before = User.objects.count()
+
+ response = self.client.post(reverse('api_register'),
+ {'username': 'restapi',
+ 'email': '[email protected]',
+ 'password': 'AekaiLe0ga'},
+ Authorization=f'Token {token.key}')
+ count_after = User.objects.count()
+ self.assertEqual(response.status_code, HTTP_201_CREATED)
+
+ new_user = User.objects.get(username='restapi')
+ token = Token.objects.get(user=new_user)
+ self.assertEqual(response.data["message"], "api user successfully registered")
+ self.assertEqual(response.data["token"], token.key)
+ self.assertEqual(count_after, count_before + 1)
+
+ def test_post_invalid_api_user_creation(self):
+ """Test unsuccessfully registration (weak password)"""
+
+ self.user_login('test')
+ user = User.objects.get(username='test')
+ token = Token.objects.get(user=user)
+
+ response = self.client.post(reverse('api_register'),
+ {'username': 'restapi',
+ 'email': '[email protected]',
+ 'password': '12345'},
+ Authorization=f'Token {token.key}')
+
+ self.assertEqual(response.status_code, HTTP_400_BAD_REQUEST)
+
+ def test_post_not_allowed_api_user_creation(self):
+ """User admin isn't allowed to register users"""
+
+ self.user_login('admin')
+ count_before = User.objects.count()
+
+ response = self.client.post(reverse('api_register'),
+ {'username': 'restapi',
+ 'email': '[email protected]',
+ 'password': 'AekaiLe0ga'})
+ count_after = User.objects.count()
+
+ self.assertEqual(response.status_code, HTTP_403_FORBIDDEN)
+ self.assertEqual(count_after, count_before)
diff --git a/wger/urls.py b/wger/urls.py
index bbacc3af1..d20086334 100644
--- a/wger/urls.py
+++ b/wger/urls.py
@@ -143,6 +143,8 @@ urlpatterns += [
# The api user login
path('api/v2/login/', core_api_views.UserAPILoginView.as_view({
'post': 'post'}), name='api_user'),
+ path('api/v2/register/', core_api_views.UserAPIRegistrationViewSet.as_view({
+ 'post': 'post'}), name='api_register'),
# Others
path('api/v2/version/', core_api_views.ApplicationVersionView.as_view({