Update Django version and add swagger

Author: atanas-mavrov

rest/requirements.txt

@@ -1,13 +1,14 @@
-Django==1.9.8
+Django==2.1.4
 mysqlclient==1.3.7
-djangorestframework==3.4.0
-markdown==2.6.6
-django-filter==0.13.0
+djangorestframework==3.9.0
+markdown==2.6.10
+django-filter==2.0.0
 djangorestframework-jwt==1.8.0
-django-cors-headers==1.1.0
+django-cors-headers==2.4.0
 behave-django==0.3.0
 selenium==2.53.6
 gunicorn==19.7.1
-django-import-export==0.7.0
+django-import-export==1.1.0
 django-admin-rangefilter==0.3.1
-django-admin-multiple-choice-list-filter==0.1.1
+django-admin-multiple-choice-list-filter==0.1.1
+django-rest-swagger==2.2.0

rest/rest/settings.py

@@ -41,24 +41,21 @@
     'django.contrib.staticfiles',
     'import_export',
     'rangefilter',
-
+    'django_admin_multiple_choice_list_filter',
     'rest_framework',
     'corsheaders',
-
     'time_tracker',
-    'django_admin_multiple_choice_list_filter',
-
-    'behave_django'
+    'behave_django',
+    'rest_framework_swagger',
 ]
 
-MIDDLEWARE_CLASSES = [
+MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'corsheaders.middleware.CorsMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 ]
@@ -124,7 +121,7 @@
         'rest_framework.authentication.SessionAuthentication',
         'rest_framework.authentication.BasicAuthentication',
         'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
-    )
+    ),
 }
 
 JWT_AUTH = {

rest/rest/urls.py

@@ -18,11 +18,16 @@
 from django.conf.urls import url, include
 from django.conf import settings
 from django.conf.urls.static import static
+from rest_framework_swagger.views import get_swagger_view
+from rest_framework.documentation import include_docs_urls
+
 
 urlpatterns = [
     url(r"", include("time_tracker.urls")),
     url(r"^admin/", admin.site.urls),
     url(r"^time-tracker/api/", include("time_tracker.urls")),
+    url(r'^docs', include_docs_urls(title='MTR Time Tracker API')),
+    url(r'^swagger$', get_swagger_view(title='MTR Time Tracker API')),
 ] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
 
 if settings.DEBUG:

rest/time_tracker/filters/time_report_filter.py

@@ -1,19 +1,16 @@
-import django_filters
-
+import django_filters.rest_framework
 from django.db.models import F, Func
 
-from rest_framework import filters
-
 from time_tracker.models import TimeReport
 
 
-class TimeReportFilter(filters.FilterSet):
+class TimeReportFilter(django_filters.rest_framework.FilterSet):
     FILTERS = ['MONTH', "YEAR", "DAY"]
 
-    date = django_filters.DateFromToRangeFilter(name="date")
-    project__id = django_filters.NumberFilter(name="project__id")
-    profile__id = django_filters.NumberFilter(name="profile__id")
-    group_by = django_filters.MethodFilter()
+    date = django_filters.DateFromToRangeFilter(field_name="date")
+    project__id = django_filters.NumberFilter(field_name="project__id")
+    profile__id = django_filters.NumberFilter(field_name="profile__id")
+    group_by = django_filters.CharFilter(method='filter_group_by')
 
     class Meta:
         model = TimeReport

rest/time_tracker/urls.py

@@ -16,11 +16,13 @@
 router.register(r"time-reports", TimeReportViewSet)
 
 urlpatterns = [
-    url(r'', include(router.urls)),
+
     url(r"^auth/jwt/new/", obtain_jwt_token),
     url(r"^auth/jwt/refresh/", refresh_jwt_token),
     url(r"^auth/jwt/verify/", verify_jwt_token),
     url(r"time-reports/profiles/", TimeReportViewSet.as_view({'get': 'get_profiles_reports'})),
     url(r"time-reports/projects/", TimeReportViewSet.as_view({'get': 'get_projects_reports'})),
     url(r"time-reports/total-hours/", TimeReportViewSet.as_view({'get': 'get_total_hours'})),
+    url(r'', include(router.urls)),
+
 ]

rest/time_tracker/views/company.py

@@ -6,6 +6,13 @@
 
 
 class CompanyViewSet(viewsets.ModelViewSet):
+    """
+        Working with company data
+
+        retrieve:
+        Return the given company.
+
+    """
     queryset = Company.objects.all()
     serializer_class = CompanySerializer
     permission_classes = (CompanyPermission,)

rest/time_tracker/views/profile.py

@@ -1,20 +1,36 @@
 from rest_framework import filters
 from rest_framework import viewsets
+from django_filters.rest_framework import DjangoFilterBackend
 
 from time_tracker.models import Profile
 from time_tracker.serializers import ProfileSerializer
 from time_tracker.permissions import ProfilePermission
 
 
 class ProfileViewSet(viewsets.ModelViewSet):
+    """
+        Working with profile data
+
+        retrieve:
+        Return the given profile.
+
+        list:
+        Return a list of all the existing profiles.
+
+        update:
+        Create a new profile instance.
+
+        partial_update:
+        Update an existing profile
+    """
     queryset = Profile.objects.all()
     serializer_class = ProfileSerializer
     permission_classes = (ProfilePermission,)
-    filter_backends = (filters.DjangoFilterBackend, filters.OrderingFilter)
+    filter_backends = (DjangoFilterBackend, filters.OrderingFilter)
     filter_fields = ('user__id',)
     ordering_fields = ('first_name', 'last_name')
     ordering = ('first_name', 'last_name')
-    
+
     def get_queryset(self):
         user = self.request.user
         profile = Profile.objects.filter(is_active=True)

rest/time_tracker/views/project.py

@@ -1,16 +1,27 @@
 from rest_framework import filters
 from rest_framework import viewsets
+from django_filters.rest_framework import DjangoFilterBackend
 
 from time_tracker.models import Project
 from time_tracker.serializers import ProjectSerializer
 from time_tracker.permissions import ProjectPermission
 
 
 class ProjectViewSet(viewsets.ModelViewSet):
+    """
+        Working with project data
+
+        retrieve:
+        Return the given project.
+
+        list:
+        Return a list of all the existing project.
+
+    """
     queryset = Project.objects.all()
     serializer_class = ProjectSerializer
     permission_classes = (ProjectPermission,)
-    filter_backends = (filters.DjangoFilterBackend, filters.OrderingFilter)
+    filter_backends = (DjangoFilterBackend, filters.OrderingFilter)
     filter_fields = ('is_finished',)
     ordering_fields = ('name',)
     ordering = ('name',)

rest/time_tracker/views/time_report.py

@@ -10,13 +10,37 @@
 from time_tracker.filters.time_report_filter import TimeReportFilter
 from time_tracker.serializers import TimeReportProfileSerializer
 from time_tracker.serializers import TimeReportProjectSerializer
+from django_filters.rest_framework import DjangoFilterBackend
 
 
 class TimeReportViewSet(viewsets.ModelViewSet):
+    """
+        Working with TimeReport data
+
+        retrieve:
+        Return the given time report.
+
+        list:
+        Return a list of all the existing time report.
+
+        create:
+        Create a new time report.
+
+        update:
+        Create a new time report instance.
+
+        partial_update:
+        Update an existing time report
+
+        destroy:
+        Delete an existing time report
+
+    """
+
     queryset = TimeReport.objects.all()
     serializer_class = TimeReportSerializer
     permission_classes = (TimeReportPermission,)
-    filter_backends = (filters.DjangoFilterBackend, filters.OrderingFilter)
+    filter_backends = (DjangoFilterBackend, filters.OrderingFilter)
     filter_class = TimeReportFilter
     ordering_fields = ('date', 'id')
     ordering = ('-date', '-id')
@@ -33,7 +57,7 @@ def get_profiles_reports(self, request):
         user = self.request.user
         time_report = TimeReportFilter(request.GET, queryset=TimeReport.objects.total_time_by(user, 'profile', 'profile__first_name'))
 
-        serializer = TimeReportProfileSerializer(time_report, many=True)
+        serializer = TimeReportProfileSerializer(time_report.qs, many=True)
         return Response(serializer.data)
 
     def get_projects_reports(self, request):
@@ -43,7 +67,7 @@ def get_projects_reports(self, request):
         user = self.request.user
         time_report = TimeReportFilter(request.GET, queryset=TimeReport.objects.total_time_by(user, 'project', 'project__name'))
 
-        serializer = TimeReportProjectSerializer(time_report, many=True)
+        serializer = TimeReportProjectSerializer(time_report.qs, many=True)
         return Response(serializer.data)
 
     def get_total_hours(self, request):
@@ -54,4 +78,4 @@ def get_total_hours(self, request):
         time_report = TimeReportFilter(request.GET, queryset=TimeReport.objects.active_projects(user, seconds__gt=0))
         time_report = time_report.qs.aggregate(total_seconds=Sum('seconds'))
         time_report['total_hours'] = TimeReport.sec_to_hours(time_report['total_seconds'])
-        return Response(time_report)
+        return Response(time_report)

webapp/src/app/app.component.html

@@ -3,7 +3,10 @@
     <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
       <span class="navbar-toggler-icon"></span>
     </button>
-    <a class="navbar-brand" routerLink="/">{{ config.env.website.title }}</a>
+    <a class="navbar-brand" routerLink="/">
+      <img src="assets/images/logo.png" alt="Time Tracker">
+      <strong>{{ config.env.website.title }}</strong>
+    </a>
 
     <div class="collapse navbar-collapse" id="navbar">
       <ul class="navbar-nav mr-auto">