[IMPORTANT]: Import EduVision Evaluation Function (#1)

* feat: main functionality upload from own repo

* fix(#1): private changes, .env

Author: DamianKobylinski

.github/workflows/test-and-deploy.yml

@@ -23,6 +23,7 @@ jobs:
 
     env:
       SCHEMAS_URL: https://raw.githubusercontent.com/lambda-feedback/request-response-schemas/master/
+      API_CONNECTION: ${{secrets.API_CONNECTION}}
 
     steps:
       - name: Checkout

app/docs/dev.md

@@ -1,29 +1,89 @@
-# YourFunctionName
-*Brief description of what this evaluation function does, from the developer perspective*
+# eduVision
+Handle all API calls to external services.
+
+For now, we have examples and API structure prepare for the EduVision Proof of Concept Application.
 
 ## Inputs
-*Specific input parameters which can be supplied when the `eval` command is supplied to this function.*
+
+- `response` (Any): The answers provided by the student. It can be a ID of the instance, a list of IDs, a list of dictionaries, etc. to handle the response from the API.
+- `answer` (Any): The correct answers to compare against the API response.
+- `params` (Dict): Important endpoint information to make the API call to EduVision API Server. Storing ````endpoint``` information.
+
+```
+{server}/{endpoint}{response}
+```
 
 ## Outputs
-*Output schema/values for this function*
+Return result value is a boolean.
+
+```python
+   {
+    "is_correct": true
+   }
+```
 
 ## Examples
-*List of example inputs and outputs for this function, each under a different sub-heading*
+For now, we have examples for the EduVision Proof of Concept Application.
 
-### Simple Evaluation
+### EduVision Application
+
+There is 2 endpoints to call the API. The first one is to get the list of all the students and the second one is to get the list of all the courses.
+
+#### Resistors
+Check how many resistors is recognized with its resistance value.
+***Answer value must be dictionary.***
+
+```python
+{
+  "headers": {
+    "command": "eval"
+  },
+  "body": {
+    "response": "999999",
+    "answer": [],
+    "params": {
+      "api_endpoint": "endpoint/"
+    }
+  }
+}
+```
 
 ```python
 {
-  "example": {
-    "Something": "something"
+  "headers": {
+    "command": "eval"
+  },
+  "body": {
+    "response": "999999",
+    "answer": [
+        {
+            "resistance": 1000.0,
+        },
+        {
+            "resistance": 1000.0,
+        },
+    ],
+    "params": {
+      "api_endpoint": "endpoint/"
+    }
   }
 }
 ```
+#### Resistance
+Check global resistance of the circuit
+***Answer value must be float.***
 
 ```python
 {
-  "example": {
-    "Something": "something"
+  "headers": {
+    "command": "eval"
+  },
+  "body": {
+    "response": "999999",
+    "answer": 1000.0,
+    "params": {
+      "api_endpoint": "endpoint/"
+    }
   }
 }
 ```

app/docs/user.md

@@ -1,3 +1,6 @@
-# YourFunctionName
+# eduVision
 
-Teacher-facing documentation for this function.
+Evaluation Function to handle all API calls to external services.
+It assumes that response from API is equal to the expected answer.
+
+Function is prepare for EduVision Proof of Concept Application for now.

app/evaluation.py

@@ -1,15 +1,12 @@
+import os
 from typing import Any, TypedDict
-
-
-class Params(TypedDict):
-    pass
-
+import requests
 
 class Result(TypedDict):
     is_correct: bool
 
 
-def evaluation_function(response: Any, answer: Any, params: Params) -> Result:
+def evaluation_function(response: Any, answer: Any, params: Any) -> Result:
     """
     Function used to evaluate a student response.
     ---
@@ -33,4 +30,18 @@ def evaluation_function(response: Any, answer: Any, params: Params) -> Result:
     to output the evaluation response.
     """
 
-    return Result(is_correct=True)
+    try:
+        api_endpoint = params.get("api_endpoint", 'resistance/')
+
+        if len(response) != 6:
+            raise Exception("Connection ID must be 6 characters long")
+
+        api_response = requests.get(f"{os.environ["API_CONNECTION"]}/{api_endpoint}{response}")
+        api_response.raise_for_status()
+        api_data = api_response.json()
+        is_correct = api_data == answer
+    except requests.RequestException as e:
+        print(f"Error API connection: {e}")
+        is_correct = False
+
+    return Result(is_correct=is_correct)

app/evaluation_tests.py

@@ -1,11 +1,14 @@
+import os
 import unittest
+from app.utility import initialize_test_connection
 
 try:
     from .evaluation import Params, evaluation_function
 except ImportError:
     from evaluation import Params, evaluation_function
 
 
+
 class TestEvaluationFunction(unittest.TestCase):
     """
     TestCase Class used to test the algorithm.
@@ -25,12 +28,13 @@ class TestEvaluationFunction(unittest.TestCase):
     as it should.
     """
 
-    def test_returns_is_correct_true(self):
-        response, answer, params = None, None, Params()
+    def test_connection(self):
+        id_connection = initialize_test_connection()
+
+        response, answer, params = id_connection, 0.0, {"api_endpoint": "resistance/"}
         result = evaluation_function(response, answer, params)
 
         self.assertEqual(result.get("is_correct"), True)
 
-
 if __name__ == "__main__":
     unittest.main()

app/preview.py

@@ -1,15 +1,12 @@
+import os
 from typing import Any, TypedDict
-
-
-class Params(TypedDict):
-    pass
-
+import requests
 
 class Result(TypedDict):
     preview: Any
 
 
-def preview_function(response: Any, params: Params) -> Result:
+def preview_function(response: Any, params: Any) -> Result:
     """
     Function used to preview a student response.
     ---
@@ -29,4 +26,14 @@ def preview_function(response: Any, params: Params) -> Result:
     The way you wish to structure you code (all in this function, or
     split into many) is entirely up to you.
     """
-    return Result(preview=response)
+    try:
+        api_endpoint = params.get("api_endpoint", 'resistance/')
+
+        api_response = requests.get(f"{os.environ["API_CONNECTION"]}/{api_endpoint}{response}")
+        api_response.raise_for_status()
+        api_data = api_response.json()
+    except requests.RequestException as e:
+        print(f"Error API connection: {e}")
+        api_data = None
+
+    return Result(preview=api_data)

app/preview_tests.py

@@ -1,9 +1,10 @@
 import unittest
+from app.utility import initialize_test_connection
 
 try:
-    from .preview import Params, preview_function
+    from .preview import preview_function
 except ImportError:
-    from preview import Params, preview_function
+    from preview import preview_function
 
 
 class TestPreviewFunction(unittest.TestCase):
@@ -25,8 +26,17 @@ class TestPreviewFunction(unittest.TestCase):
     as it should.
     """
 
-    def test_returns_preview_key(self):
-        response, params = "test", Params()
+    def test_api_endpoint_resistance(self):
+        id_connection = initialize_test_connection()
+        response, params = id_connection, {"api_endpoint": "resistance/"}
+        result = preview_function(response, params)
+
+        self.assertIn("preview", result)
+        self.assertIsNotNone(result["preview"])
+
+    def test_api_endpoint_resistors(self):
+        id_connection = initialize_test_connection()
+        response, params = id_connection, {"api_endpoint": "resistors/"}
         result = preview_function(response, params)
 
         self.assertIn("preview", result)

app/requirements.txt

@@ -0,0 +1,2 @@
+requests
+dotenv

app/utility.py

@@ -0,0 +1,10 @@
+import os
+import requests
+
+def initialize_test_connection():
+    response = requests.post(f"{os.environ["API_CONNECTION"]}/initialize")
+    if response.status_code == 200:
+        connection_id = response.json().get("connection_id")
+    else:
+        raise Exception("Failed to initialize connection with the API")
+    return connection_id