Add view to get sequences for a period and improving pyros_api.py

Alexis Koralewski
1 parent c2589779
Showing 5 changed files with 78 additions and 29 deletions Show diff stats
CHANGELOG
VERSION
pyros_api.py
src/core/pyros_django/api/urls.py
src/core/pyros_django/api/views.py
+21-02-2022 (AKo): v0.3.8.0
+	- Improve pyros_api with (click) commands 
+	- Add view to get all sequences within a date period (start_date and end_date)
+
 18-02-2022 (AKo): v0.3.7.0
 	- Add API url to get a full sequence (i.e. with albums and plans)
 	- Add API urls for querying Plan and Album models
-0.3.7.0
 \ No newline at end of file
+0.3.8.0
 \ No newline at end of file
-import requests, sys, yaml
+#!/usr/bin/env python3
+import requests, sys, yaml, click
 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:
+
+    def __init__(self, username: str, password: str) -> None:
         """
         Initialize PyrosAPI class by getting the authentification token required to use the API
@@ -15,8 +17,7 @@ class PyrosAPI:
         """
         self.get_token(username, password)
-
-    def get_token(self,username : str,password : str):
+    def get_token(self, username: str, password: str):
         """
         get the authentification token linked to the user account
@@ -25,12 +26,12 @@ class PyrosAPI:
             password : Password of the user
         """
         url = f"{self.BASE_PYROS_URL}api-token-auth/"
-        request = requests.post(url, data={"username":username,"password":password})
+        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:
+    def get_url(self, url: str) -> dict:
         """
         Query the url and return the response as json
@@ -45,7 +46,7 @@ class PyrosAPI:
         request = requests.get(self.BASE_PYROS_URL+url, headers=headers)
         return request.json()
-    def submit_sequence_file(self,file : str) -> dict:
+    def submit_sequence_file(self, file: str) -> dict:
         """
         Submit sequence file by querying the API via PUT method
@@ -60,27 +61,57 @@ class PyrosAPI:
             'Content-type': 'application/json',
         }
         url = f"{self.BASE_PYROS_URL}submit_sequence"
-        yaml_file = open(file,"r")
+        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()
+    def get_sequences_for_period(self, start_date:str, end_date:str) -> dict:
+        """
+        Return all the sequence between two dates
+        Args:
+            start_date : start date of the period we want to retrieve (format : day/month/year, example : 13/02/2022)
+            end_date : end date of the period we want to retrieve (same format as start_date)
+        Returns:
+            dict : Json object that represents the response of the API
+        """
+        url = f"{self.BASE_PYROS_URL}full_sequences/get_sequences_for_period/"
+        headers = {"Authorization": f"Token {self.token}"}
+        response = requests.get(url, params={"start_date": start_date, "end_date": end_date}, headers=headers)
+        return response.json()
+
+@click.group()
+@click.argument("username")
+@click.argument("password")
+@click.pass_context
+def cli(ctx, username, password):
+    ctx.obj = PyrosAPI(username, password)
+
+
+@cli.command("get_sequences")
+@click.argument("start_date")
+@click.argument("end_date")
+@click.pass_obj
+def get_sequences_for_period(api, start_date: str, end_date: str):
+    response = api.get_sequences_for_period(start_date, end_date)
+    print(response)
+
+
+@cli.command("submit_sequence")
+@click.argument("file_path")
+@click.pass_obj
+def submit_sequence(api, file_path):
+    response = api.submit_sequence_file(file_path)
+    print(response)
+
+@cli.command("query_url")
+@click.argument("url")
+@click.pass_obj
+def query_url(api, url):
+    response = api.get_url(url)
+    print(response)
+
+if __name__ == '__main__':
+    cli(obj={})
 from django.urls import path, include
 from . import views
 from rest_framework.authtoken.views import obtain_auth_token
-from rest_framework import routers
+from rest_framework import routers, renderers
 router = routers.DefaultRouter()
 router.register(r'users', views.UserViewSet)
 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 import viewsets, renderers
 from rest_framework.permissions import IsAuthenticated, AllowAny
-from rest_framework.decorators import api_view, permission_classes
+from rest_framework.decorators import api_view, permission_classes, action
 from django.core.validators import ValidationError
 from src.core.pyros_django.user_manager import views as user_views
 from api.serializers import AlbumSerializer, FullSequenceSerializer, PlanSerializer, SequenceSerializer, UserSerializer
 from common.models import PyrosUser, Sequence, Album, Plan, UserLevel, SP_Period_User
 from routine_manager.functions import check_sequence_file_validity
 from rest_framework.request import Request
+from django.db.models import Q
+from datetime import datetime
 # Create your views here.
@@ -104,6 +106,18 @@ class FullSequenceViewSet(viewsets.ModelViewSet):
         else:
             return Sequence.objects.filter(pyros_user=user).order_by("-updated")
+    @action(detail=False, methods=["get"])
+    def get_sequences_for_period(self, request):
+        """
+        Return the list of sequences corresponding to the requested period 
+        """
+        params = request.query_params
+        start_date = datetime.strptime(params.get("start_date"),"%d/%m/%Y")
+        end_date = datetime.strptime(params.get("end_date"),"%d/%m/%Y")
+        queryset = Sequence.objects.filter(Q(start_date__gte=start_date) | Q(start_date__lte=end_date))
+        serializer = self.get_serializer(queryset,many=True)
+        response = Response(serializer.data)
+        return response
 class AlbumViewSet(viewsets.ModelViewSet):
     """