Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add login endpoint in REST API

Roland Geider43f1ef74a352
diff --git a/wger/core/api/serializers.py b/wger/core/api/serializers.py
index abb3bcbe9..55a52365d 100644
--- a/wger/core/api/serializers.py
+++ b/wger/core/api/serializers.py
@@ -15,6 +15,9 @@
# 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/>.
+# Django
+from django.contrib.auth.models import User
+
# Third Party
from rest_framework import serializers
@@ -45,6 +48,16 @@ class UsernameSerializer(serializers.Serializer):
username = serializers.CharField()
+class UserApiSerializer(serializers.ModelSerializer):
+ """ Serializer to map to User model in relation to api user"""
+ username = serializers.CharField(required=True)
+ password = serializers.CharField(required=True, min_length=8)
+
+ class Meta:
+ model = User
+ fields = ['username', 'password']
+
+
class LanguageSerializer(serializers.ModelSerializer):
"""
Language serializer
diff --git a/wger/core/api/views.py b/wger/core/api/views.py
index 067431d3a..8ec2fafda 100644
--- a/wger/core/api/views.py
+++ b/wger/core/api/views.py
@@ -15,12 +15,19 @@
# 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/>.
+# Standard Library
+import logging
+
# Django
from django.contrib.auth.models import User
# Third Party
-from rest_framework import viewsets
+from rest_framework import (
+ status,
+ viewsets
+)
from rest_framework.decorators import action
+from rest_framework.permissions import AllowAny
from rest_framework.response import Response
# wger
@@ -29,6 +36,7 @@ from wger.core.api.serializers import (
LanguageSerializer,
LicenseSerializer,
RepetitionUnitSerializer,
+ UserApiSerializer,
UsernameSerializer,
UserprofileSerializer,
WeightUnitSerializer
@@ -41,12 +49,16 @@ from wger.core.models import (
UserProfile,
WeightUnit
)
+from wger.utils.api_token import create_token
from wger.utils.permissions import (
UpdateOnlyPermission,
WgerPermission
)
+logger = logging.getLogger(__name__)
+
+
class UserProfileViewSet(viewsets.ModelViewSet):
"""
API endpoint for workout objects
@@ -78,6 +90,38 @@ class UserProfileViewSet(viewsets.ModelViewSet):
return Response(UsernameSerializer(user).data)
+class UserAPILoginView(viewsets.ViewSet):
+ """
+ API endpoint for api user objects
+ """
+ permission_classes = (AllowAny,)
+ queryset = User.objects.all()
+ serializer_class = UserApiSerializer
+ throttle_scope = 'login'
+
+ def post(self, request):
+ data = request.data
+ serializer = self.serializer_class(data=data)
+ serializer.is_valid(raise_exception=True)
+
+ username = serializer.data["username"]
+ password = serializer.data["password"]
+
+ try:
+ user = User.objects.get(username=username)
+ except User.DoesNotExist:
+ logger.info(f"Tried logging via API with unknown user: '{username}'")
+ return Response(status=status.HTTP_401_UNAUTHORIZED)
+
+ if user.check_password(password):
+ token = create_token(user)
+ return Response({'token': token.key},
+ status=status.HTTP_200_OK)
+ else:
+ logger.info(f"User '{username}' tried logging via API with a wrong password")
+ return Response(status=status.HTTP_401_UNAUTHORIZED)
+
+
class LanguageViewSet(viewsets.ReadOnlyModelViewSet):
"""
API endpoint for workout objects
diff --git a/wger/core/views/user.py b/wger/core/views/user.py
index 4bd37dac3..8e4474364 100644
--- a/wger/core/views/user.py
+++ b/wger/core/views/user.py
@@ -71,7 +71,6 @@ from crispy_forms.layout import (
Row,
Submit
)
-from rest_framework.authtoken.models import Token
# wger
from wger.config.models import GymConfig
@@ -95,6 +94,7 @@ from wger.manager.models import (
WorkoutSession
)
from wger.nutrition.models import NutritionPlan
+from wger.utils.api_token import create_token
from wger.utils.generic_views import (
WgerFormMixin,
WgerMultiplePermissionRequiredMixin
@@ -453,15 +453,8 @@ def api_key(request):
context = {}
context.update(csrf(request))
- try:
- token = Token.objects.get(user=request.user)
- except Token.DoesNotExist:
- token = False
+ token = create_token(request.user, request.GET.get('new_key'))
if request.GET.get('new_key'):
- if token:
- token.delete()
-
- token = Token.objects.create(user=request.user)
# Redirect to get rid of the GET parameter
return HttpResponseRedirect(reverse('core:user:api-key'))
diff --git a/wger/settings_global.py b/wger/settings_global.py
index 06a991484..f63550e64 100644
--- a/wger/settings_global.py
+++ b/wger/settings_global.py
@@ -341,7 +341,13 @@ REST_FRAMEWORK = {
'rest_framework.authentication.TokenAuthentication',
),
'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',
- 'rest_framework.filters.OrderingFilter',)
+ 'rest_framework.filters.OrderingFilter'),
+ 'DEFAULT_THROTTLE_CLASSES': [
+ 'rest_framework.throttling.ScopedRateThrottle'
+ ],
+ 'DEFAULT_THROTTLE_RATES': {
+ 'login': '3/min'
+ }
}
diff --git a/wger/software/templates/api.html b/wger/software/templates/api.html
index 0ef9b1d22..fe9c25a58 100644
--- a/wger/software/templates/api.html
+++ b/wger/software/templates/api.html
@@ -15,8 +15,14 @@ objects: <a href="/api/v2/" rel="nofollow">https://wger.de/api/v2/</a></p>
ingredients can be accessed without authentication. For <strong>user owned
objects such as workouts, you need to generate an API KEY</strong> and pass
it in the header, see the link on the sidebar for details.</p>
+
+<p>You can also generate a token via the <code>login</code> endpoint. Send a
+username and password and you will get the user's token or a new one will be
+generated. At the moment it is not possible to register via the API.</p>
+
<p>You should always use HTTPS if possible when communicating with the server.</p>
+
<div class="container">
<div class="row">
<div class="col-6">
diff --git a/wger/urls.py b/wger/urls.py
index 192fc6af7..93d24ea75 100644
--- a/wger/urls.py
+++ b/wger/urls.py
@@ -136,6 +136,10 @@ urlpatterns += [
nutrition_api_views.search,
name='ingredient-search'),
url(r'^api/v2/', include(router.urls)),
+
+ # The api user login
+ url(r'^api/v2/login/$', core_api_views.UserAPILoginView.as_view({
+ 'post': 'post'}), name='api_user'),
]
#
diff --git a/wger/utils/api_token.py b/wger/utils/api_token.py
new file mode 100644
index 000000000..6b5f2a5f3
--- /dev/null
+++ b/wger/utils/api_token.py
@@ -0,0 +1,43 @@
+# 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
+
+# Standard Library
+import logging
+
+# Third Party
+from rest_framework.authtoken.models import Token
+
+
+logger = logging.getLogger(__name__)
+
+
+def create_token(user, force_new=False):
+ """
+ Creates a new token for a user or returns the existing one.
+
+ :param force_new: forces creating a new token
+ """
+ token = False
+
+ try:
+ token = Token.objects.get(user=user)
+ except Token.DoesNotExist:
+ force_new = True
+
+ if force_new:
+ if token:
+ token.delete()
+ token = Token.objects.create(user=user)
+
+ return token
diff --git a/wger/utils/tests/test_make_token.py b/wger/utils/tests/test_make_token.py
new file mode 100644
index 000000000..f08528fc9
--- /dev/null
+++ b/wger/utils/tests/test_make_token.py
@@ -0,0 +1,71 @@
+# -*- coding: utf-8 *-*
+
+# 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
+
+
+# Django
+from django.contrib.auth.models import User
+
+# Third Party
+from rest_framework.authtoken.models import Token
+
+# wger
+from wger.core.tests.base_testcase import WgerTestCase
+from wger.utils.api_token import create_token
+
+
+class TokenHelperTestCase(WgerTestCase):
+ """
+ Tests the create_token helper
+ """
+
+ def test_make_token(self):
+ """
+ Test that create_token returns the user's existing token
+ """
+ user = User.objects.get(pk=2)
+ self.assertEqual(Token.objects.filter(user=user).count(), 1)
+
+ token_before = Token.objects.get(user=user).key
+ token = create_token(user).key
+ token_after = Token.objects.get(user=user).key
+
+ self.assertEqual(token_before, token_after)
+ self.assertEqual(token_before, token)
+
+ def test_make_token_force_new(self):
+ """
+ Test that create_token returns the user's existing token
+ """
+ user = User.objects.get(pk=2)
+ self.assertEqual(Token.objects.filter(user=user).count(), 1)
+
+ token_before = Token.objects.get(user=user).key
+ token = create_token(user, force_new=True).key
+ token_after = Token.objects.get(user=user).key
+
+ self.assertNotEqual(token_before, token_after)
+ self.assertEqual(token, token_after)
+
+ def test_make_token_new(self):
+ """
+ Test that create_token creates a token for users that don't have one
+ """
+ user = User.objects.get(pk=2)
+ Token.objects.filter(user=user).delete()
+ self.assertEqual(Token.objects.filter(user=user).count(), 0)
+
+ create_token(user)
+ self.assertEqual(Token.objects.filter(user=user).count(), 1)