add DRF, pyros api views, pyros_api python script, fixing period assignation whe…

…n submitting a sequence

add DRF, pyros api views, pyros_api python script, fixing period assignation whe…
…n submitting a sequence
Alexis Koralewski
1 parent 42cd9e29
Showing 17 changed files with 236 additions and 6 deletions Show diff stats
CHANGELOG
VERSION
install/requirements.txt
pyros_api.py
src/core/pyros_django/api/__init__.py
src/core/pyros_django/api/admin.py
src/core/pyros_django/api/apps.py
src/core/pyros_django/api/migrations/__init__.py
src/core/pyros_django/api/models.py
src/core/pyros_django/api/serializers.py
src/core/pyros_django/api/settings.py
src/core/pyros_django/api/tests.py
src/core/pyros_django/api/urls.py
src/core/pyros_django/api/views.py
src/core/pyros_django/pyros/settings.py
src/core/pyros_django/pyros/urls.py
src/core/pyros_django/routine_manager/functions.py
+08-02-2022 (AKo) : v0.3.6.0
+	- Add DRF (Django Rest Framework) to requirements
+	- Add Pyros API (User and sequences with sequence submission)
+	- Add PyrosAPI script to use the API via Python command line
+	- Fixed error when submitting the sequence : the period wasn't associated
+
 07-02-2022 (AKo) : v0.3.5.0
 	- Adding INVENTORY section to observatory configuration
 	- Logout now redirect to home page
-0.3.5.1
 \ No newline at end of file
+0.3.6.0
 \ No newline at end of file
@@ -5,7 +5,8 @@ Django==3.2
 django-admin-tools==0.9.1
 django-bootstrap3==21.1
 django-extensions==3.1.5
-
+# for Django Rest Framework (DRF)
+djangorestframework
 # for Choices
 django-model-utils==4.2.0
 django-suit==0.2.28
@@ -0,0 +1,86 @@
+import requests, sys, yaml
+
+class PyrosAPI:
+    """
+    Request Pyros API with an PyrosUser account linked to the username and password
+    """
+    BASE_PYROS_URL = "http://localhost:8000/api/"
+    def __init__(self, username : str, password : str ) -> None:
+        """
+        Initialize PyrosAPI class by getting the authentification token required to use the API
+
+        Args:
+            username : Username of the user (mail adress)
+            password : Password of the user
+        """
+        self.get_token(username, password)
+
+
+    def get_token(self,username : str,password : str):
+        """
+        get the authentification token linked to the user account
+
+        Args:
+            username : Username of the user (mail adress)
+            password : Password of the user
+        """
+        url = f"{self.BASE_PYROS_URL}api-token-auth/"
+        request = requests.post(url, data={"username":username,"password":password})
+        json_response = request.json()
+        self.token = json_response["token"]
+        print(f"Token is {self.token}")
+
+    def get_url(self,url : str) -> dict:
+        """
+        Query the url and return the response as json
+
+        Args:
+            url : Url to be requested without the base url of the website 
+
+        Returns:
+            dict : Json object that represents the response of the API
+        """
+        headers = {"Authorization" : f"Token {self.token}"}
+
+        request = requests.get(self.BASE_PYROS_URL+url, headers=headers)
+        return request.json()
+
+    def submit_sequence_file(self,file : str) -> dict:
+        """
+        Submit sequence file by querying the API via PUT method
+
+        Args:
+            file : File path to the sequence file to be uploaded
+
+        Returns:
+            dict : Json object that represents the response of the API
+        """
+        headers = {
+            "Authorization" : f"Token {self.token}",
+            'Content-type': 'application/json',
+        }
+        url = f"{self.BASE_PYROS_URL}submit_sequence"
+        yaml_file = open(file,"r")
+        sequence_file_as_dict = yaml.safe_load(yaml_file)
+        print(f"File content : {sequence_file_as_dict}")
+        request = requests.put(url, headers=headers, json=sequence_file_as_dict)
+        print(f"Request status code {request.status_code}")
+        return request.json()
+
+
+def main():
+    username = sys.argv[1]
+    password = sys.argv[2]
+    url = sys.argv[3]
+    yaml_file = None
+    api = PyrosAPI(username,password)
+    if len(sys.argv) > 4 and sys.argv[4]:
+        yaml_file = sys.argv[4]
+        print(api.submit_sequence_file(yaml_file))
+    else:
+        print(username,password,url)
+        print(api.get_url(url))
+
+
+if __name__ == "__main__":
+    main()
@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.
@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'api'
@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.
@@ -0,0 +1,16 @@
+from common.models import PyrosUser, Sequence
+from rest_framework import serializers
+
+class UserSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = PyrosUser
+        fields = ['url', 'username', 'email',  'institute', "user_level", "motive_of_registration"]
+        depth = 1
+
+
+
+class SequenceSerializer(serializers.ModelSerializer):
+    pyros_user = UserSerializer(read_only=True)
+    class Meta:
+        model = Sequence
+        fields = "__all__"
 \ No newline at end of file
@@ -0,0 +1,7 @@
+from src.core.pyros_django import pyros_settings
+
+
+REST_FRAMEWORK = {
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
+    'PAGE_SIZE': pyros_settings.NB_ELEMENT_PER_PAGE
+}
 \ No newline at end of file
@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.
@@ -0,0 +1,14 @@
+from django.urls import path, include
+from . import views
+from rest_framework.authtoken.views import obtain_auth_token
+from rest_framework import routers
+
+router = routers.DefaultRouter()
+router.register(r'users', views.UserViewSet)
+router.register(r'sequences', views.SequenceViewSet)
+urlpatterns = [
+    path('', include(router.urls)),
+    path('hello/', views.Users.as_view(), name='hello'),
+    path('api-token-auth/', obtain_auth_token, name='api_token_auth'),
+    path("submit_sequence",views.submit_sequence_with_json, name="api_submit_sequence"),
+] + router.urls
 \ No newline at end of file
@@ -0,0 +1,63 @@
+from django.shortcuts import render
+from rest_framework.views import APIView
+from rest_framework.response import Response
+from rest_framework import viewsets
+from rest_framework.permissions import IsAuthenticated, AllowAny
+from rest_framework.decorators import api_view, permission_classes
+from django.core.validators import ValidationError
+from src.core.pyros_django.user_manager import views as user_views
+from api.serializers import SequenceSerializer, UserSerializer
+from common.models import PyrosUser, Sequence
+from routine_manager.functions import check_sequence_file_validity
+# Create your views here.
+
+
+class Users(APIView):
+
+    permission_classes = (IsAuthenticated,)  
+
+    def get(self, request):
+        content = {"message" : "Hello"}
+        return Response(content)
+
+    @api_view(["GET"])
+    def user_logout(request):
+
+        request.user.auth_token.delete()
+
+        user_views.logout()
+
+        return Response('User Logged out successfully')
+
+
+class UserViewSet(viewsets.ModelViewSet):
+    """
+    API endpoint that allows users to be viewed or edited.
+    """
+    queryset = PyrosUser.objects.all().order_by('-date_joined')
+    serializer_class = UserSerializer
+    permission_classes = [IsAuthenticated]
+
+
+class SequenceViewSet(viewsets.ModelViewSet):
+    """
+    API endpoint that allows users to be viewed or edited.
+    """
+    queryset = Sequence.objects.all().order_by("-created")
+    serializer_class = SequenceSerializer
+    permission_classes = [IsAuthenticated]
+
+    def get_queryset(self):
+        """
+        This view should return a list of all the purchases
+        for the currently authenticated user.
+        """
+        user = self.request.user
+        return Sequence.objects.filter(pyros_user=user).order_by("-created")
+
+@api_view(["PUT"])
+def submit_sequence_with_json(request):
+    sequence_json = request.data
+    print(sequence_json)
+    response = check_sequence_file_validity(sequence_json,request)
+    return Response(response)
@@ -192,6 +192,10 @@ INSTALLED_APPS = [
     'test_without_migrations',
     'bootstrap3',
+    # Django Rest Framework
+    "rest_framework",
+    "rest_framework.authtoken",
+
     # PYROS APPS
     'dashboard',
     'scheduler',
@@ -206,9 +210,17 @@ INSTALLED_APPS = [
     'devices',
     'scientific_program',
     'obsconfig',
+    "api",
     #'kombu.transport.django'
 ]
+REST_FRAMEWORK = {
+    'DEFAULT_AUTHENTICATION_CLASSES': [
+        'rest_framework.authentication.TokenAuthentication',  
+        'rest_framework.authentication.SessionAuthentication',
+    ],
+}
+
 MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
@@ -42,6 +42,7 @@ urlpatterns = [
     url(r'^user_manager/', include('user_manager.urls')),
     url(r'^scientific_program/', include('scientific_program.urls')),
     url(r'^obs_config/', include('obsconfig.urls')),
+    url(r'^api/', include('api.urls')),
     url(r'^$', dashboard.views.index)
 ] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
 import ast
 from src.core.pyros_django.obsconfig.obsconfig_class import OBSConfig
 from .forms import SequenceForm, AlbumForm, PlanForm
-from common.models import PyrosUser, ScientificProgram, Sequence, Album, Plan
+from common.models import PyrosUser, ScientificProgram, Sequence, Album, Plan, Period
 import datetime
 import os, yaml
@@ -19,8 +19,9 @@ def check_sequence_file_validity(yaml_content,request):
         "errors": [],
     }
     index_value_sp = yaml_content["sequence"]["scientific_program"]["value"]
+    values =  yaml_content["sequence"]["scientific_program"]["values"]
     if index_value_sp < 0 or index_value_sp > len(yaml_content["sequence"]["scientific_program"]["values"]):
-        result["errors"].append(f"Value of scientific program isn't valid, index out of bounds")
+        result["errors"].append(f"Value of scientific program isn't valid, index out of bounds ({index_value_sp} > {len(values)})")
         index_value_sp = 0
     chosen_sp = ScientificProgram.objects.get(name=yaml_content["sequence"]["scientific_program"]["values"][index_value_sp])
     if chosen_sp in sp_list:
@@ -37,8 +38,9 @@ def check_sequence_file_validity(yaml_content,request):
         else:
             if yaml_content["sequence"][field].get("values"):
                 index_value = yaml_content["sequence"][field]["value"]
+                values =  yaml_content["sequence"][field]["values"]
                 if index_value < 0 or index_value > len(yaml_content["sequence"][field]["values"]):
-                    result["errors"].append(f"Value of {field} isn't valid, index out of bounds")
+                    result["errors"].append(f"Value of {field} isn't valid, index out of bounds ({index_value} > {len(values)})")
                     index_value = 0
                 value = yaml_content["sequence"][field]["values"][index_value]
             else:
@@ -102,8 +104,9 @@ def check_sequence_file_validity(yaml_content,request):
                         else:
                             if plan[field].get("values"):
                                 index_value = plan[field]["value"]
+                                values =  plan[field]["values"]
                                 if index_value < 0 or index_value > len(plan[field]["values"]):
-                                    result["errors"].append(f"Value of Plan field '{field}' isn't valid, index out of bounds")
+                                    result["errors"].append(f"Value of Plan field '{field}' isn't valid, index out of bounds ({index_value} > {len(values)})")
                                     index_value = 0
                                 value = plan[field]["values"][index_value]
                                 try:
@@ -129,9 +132,15 @@ def check_sequence_file_validity(yaml_content,request):
     seq.status = Sequence.TOBEPLANNED
     seq.complete = True
+    period = Period.objects.exploitation_period()
+    if Period.objects.next_period() != None and Period.objects.next_period().start_date < seq.start_date.date():
+        period = Period.objects.next_period()
+    seq.period = period
     seq.save()
     if len(result["errors"]) != 0:
         result["succeed"] = False
         seq.delete()
+    else:
+        result["sequence_id"] = seq.id
     return result