Merge pull request #49 from openagri-eu/main

Sync AgStack repository with Openagri-eu fork

Author: fedjo

.github/workflows/docker-image.yml

@@ -3,6 +3,14 @@ name: Docker Image CI
 on:
   push:
     branches: [ main ]
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'Branch to run the workflow on'
+        required: false
+  release:
+    types:
+      - created
 
 jobs:
   build-and-push:

CONTRIBUTE.md

@@ -0,0 +1,73 @@
+# Contributing to Reporting Service
+
+We’re excited that you’re interested in contributing to Reporting Service! 🎉
+This project is licensed under the EUPL v1.2 and welcomes contributors of all backgrounds and experience levels.
+
+## 🚀 How to Contribute
+
+### Fork & Clone
+
+- Fork the repository on GitHub.
+
+- Clone your fork locally:
+
+        git clone https://github.com/your-username/reporting-service.git
+        cd reporting-service
+
+### Create a Branch
+
+Always create a new branch for your work:
+
+    git checkout -b feature/my-new-feature
+
+### Make Your Changes
+
+Add or update tests when making changes.
+
+### Commit & Push
+
+Write clear, descriptive commit messages:
+
+    git commit -m "Add support for caching pdf reports"
+    git push origin feature/my-new-feature
+
+### Open a Pull Request
+
+Go to the main repo and open a PR (Pull Request).
+
+Describe:
+
+- What your change does
+
+- Why it’s needed
+
+- Any related issues
+
+Maintainers will review your PR and may request changes. Don’t worry — feedback is part of the process!
+
+
+### 📝 Reporting Issues
+
+Check the issue tracker first.
+
+If not already reported, open a new issue with:
+
+-  A clear description
+
+-  Steps to reproduce (if a bug)
+
+-  Expected vs actual behavior
+
+### 🌱 First-Time Contributors
+
+We especially welcome first-time contributors! Some good first steps:
+
+Look for issues labeled good first issue.
+
+Improve documentation (typos, examples, guides).
+
+Add tests for untested parts of the code.
+
+### 🙏 Acknowledgments
+
+Every contribution — big or small — matters. Thank you for helping improve!

README.md

@@ -6,6 +6,14 @@
 The reporting service generates .pdf reports based on information present in datasets.\
 These datasets are required to conform to the OCSM (OpenAgri Common Semantic Model) as well as be JSON-LD compliant.
 
+# Roadmap
+
+High-level next steps for the Reporting Service:
+
+- [ ] Implement PDF reports for irrigation fertilization
+- [ ] Integrate with additional 3rd party Open Street Maps API for satelite images
+- [ ] Update PDF reports design and tables to be more adaptive for different use cases
+ 
 # Requirements
 <ul>
     <li>git</li>
@@ -52,7 +60,7 @@ docker compose up
 
 The application will be served on http://127.0.0.1:8009 (I.E. typing localhost/docs in your browser will load the swagger documentation)
 
-Full list of APIs available you can check [here](https://editor-next.swagger.io/?url=https://gist.githubusercontent.com/JoleVLF/b1bcdd77ac82aeb115a6c94fb3dadbdc/raw/32df1d94947b67dcc70f730a629d7c91161e532f/api.json)
+Full list of APIs available you can check [here](https://editor-next.swagger.io/?url=https://gist.githubusercontent.com/JoleVLF/c29adf44808a683149426912383c75eb/raw/7b57a845ab37954424c0ef2108962fd248c6966f/api_v4.json)
 # Documentation
 <h3>GET</h3>
 
@@ -79,12 +87,26 @@ Response is generated PDF file.
 
 ## Request Params
 
+### irrigation_id
+- **Type**: `uudi str`
+- **Description**:  ID of irrigation operation for which PDF is generated (optional)
+
 ### data
 - **Type**: `UploadFile`
 - **Description**: API processes the data directly to generate the report if data passed. This parameter is not required and when it is, must be provided as an `UploadFile`.
 
+- ### from_date
+- **Type**: `date`
+- **Description**:  Optional date filter (from which data is filtered)
 
+- ### to_date
+- **Type**: `date`
+- **Description**:  AOptional date filter (until which data is filtered)
 
+- ### parcel_id
+- **Type**: `str`
+- **Description**:  Optional parcel filter.
+- 
 ## Response
 
 Response is uuid of generated PDF file.
@@ -97,14 +119,26 @@ Response is uuid of generated PDF file.
 
 ## Request Params 
 
-### observation_type_name
+### calendar_activity_type
+- **Type**: `str`
+- **Description**:  All Farm Calendar Observation Type values are possible as input (optional). If operation_id provided not used.
+
+### operation_id
+- **Type**: `uudi str`
+- **Description**:  ID of operation for which PDF is generated (optional)
+
+- ### from_date
+- **Type**: `date`
+- **Description**:  Optional date filter (from which data is filtered). If operation_id provided not used.
+
+- ### to_date
+- **Type**: `date`
+- **Description**:  Optional date filter (until which data is filtered). If operation_id provided not used.
+
+- ### parcel_id
 - **Type**: `str`
-- **Description**: The name of the observation type for the report. The value of this parameter must be one of the following options:
-  - "Pesticides"
-  - "Irrigation"
-  - "Fertilization"
-  - "CropStressIndicator"
-  - "CropGrowthObservation"
+- **Description**:  Optional parcel filter (When operation id not used).
+
 
 ### data
 - **Type**: `UploadFile`
@@ -129,6 +163,10 @@ When service is run without Gatekeeper data must be provided in .json file forma
 
 ## Request Params
 
+### farm_animal_id
+- **Type**: `uudi str`
+- **Description**:  ID of FarmAnimal record for which PDF is generated (optional)
+
 ### animal_group
 - **Type**: `Optional[str]`
 - **Description**: The group or category the animal belongs to. This is an optional string field, and it can be left as `None` if not applicable.
@@ -145,6 +183,18 @@ When service is run without Gatekeeper data must be provided in .json file forma
 - **Type**: `Optional[int]`
 - **Description**: The status code associated with the animal or the transaction. It is an optional integer field. If not specified, it defaults to `None`.
 
+- ### from_date
+- **Type**: `date`
+- **Description**:  Optional date filter (from which data is filtered)
+
+- ### to_date
+- **Type**: `date`
+- **Description**:  AOptional date filter (until which data is filtered)
+
+- ### parcel_id
+- **Type**: `str`
+- **Description**:  Optional parcel filter.
+
 ### data
 - **Type**: `UploadFile`
 - **Description**: API processes the data directly to generate the report if data passed. This parameter is not required and when it is, must be provided as an `UploadFile`.
@@ -172,8 +222,15 @@ This will run the tests and return success values for each api tested in the ter
 
 <h3>These tests will NOT result in generated .pdf files.</h3>
 
-# Contribution
-Please contact the maintainer of this repository.
+## Contributing
+
+We welcome first-time contributions!
+
+See our [Contributing Guide](CONTRIBUTE.md)
+
+You can also open an issue to discuss ideas.
+
+Reporting Service is part of OpenAgri project, building tools for agriculture & climate data. Your contribution helps farmers and researchers.
 
 # License
 This project code is licensed under the EUPL 1.2 license, see the [LICENSE](https://github.com/agstack/OpenAgri-ReportingService/blob/main/LICENSE) file for more details.

app/api/api_v1/endpoints/report.py

@@ -1,3 +1,4 @@
+import datetime
 import os
 import uuid
 from typing import Optional
@@ -23,7 +24,7 @@
 router = APIRouter()
 
 
-@router.get("/{report_id}", response_class=FileResponse)
+@router.get("/{report_id}/", response_class=FileResponse)
 def retrieve_generated_pdf(
     report_id: str,
     token=Depends(deps.get_current_user),
@@ -56,7 +57,11 @@ def retrieve_generated_pdf(
 async def generate_irrigation_report(
     background_tasks: BackgroundTasks,
     token=Depends(deps.get_current_user),
+    irrigation_id: str = None,
     data: UploadFile = None,
+    from_date: datetime.date = None,
+    to_date: datetime.date = None,
+    parcel_id: str = None
 ):
     """
     Generates Irrigation Report PDF file
@@ -75,49 +80,58 @@ async def generate_irrigation_report(
             status_code=400,
             detail=f"Data file must be provided if gatekeeper is not used.",
         )
-
+    if data:
+        data = data.file.read()
     background_tasks.add_task(
         process_irrigation_data,
         data=data,
         token=token,
         pdf_file_name=uuid_of_pdf,
+        from_date=from_date,
+        to_date=to_date,
+        irrigation_id=irrigation_id,
+        parcel_id=parcel_id
     )
 
     return PDF(uuid=uuid_v4)
 
 
 @router.post("/compost-report/", response_model=PDF)
 async def generate_generic_observation_report(
-    observation_type_name: str,
     background_tasks: BackgroundTasks,
+    calendar_activity_type: str = None,
     token=Depends(deps.get_current_user),
     data: UploadFile = None,
+    operation_id: str = None,
+    from_date: datetime.date = None,
+    to_date: datetime.date = None,
+    parcel_id: str = None
 ):
     """
     Generates Observation Report PDF file
-    possible_names = ["Pesticides", "Irrigation", "Fertilization", "CropStressIndicator", "CropGrowthObservation"]
-
+    All Farm Calendar Observation Type values are possible as input
 
     """
-    if observation_type_name == "CropGrowthObservation":
-        observation_type_name = "Crop Growth Stage Observation"
 
-    if observation_type_name == "CropStressIndicator":
-        observation_type_name = "Crop Stress Indicator"
     uuid_v4 = str(uuid.uuid4())
     user_id = (
         decode_jwt_token(token)["user_id"]
         if settings.REPORTING_USING_GATEKEEPER
         else token.id
     )
     uuid_of_pdf = f"{user_id}/{uuid_v4}"
-
+    if data:
+        data = data.file.read()
     background_tasks.add_task(
         process_farm_calendar_data,
-        observation_type_name=observation_type_name,
+        calendar_activity_type=calendar_activity_type,
         token=token,
         data=data,
         pdf_file_name=uuid_of_pdf,
+        operation_id=operation_id,
+        from_date=from_date,
+        to_date=to_date,
+        parcel_id=parcel_id
     )
 
     return PDF(uuid=uuid_v4)
@@ -127,11 +141,15 @@ async def generate_generic_observation_report(
 async def generate_animal_report(
     background_tasks: BackgroundTasks,
     token=Depends(deps.get_current_user),
+    farm_animal_id: str = None,
     animal_group: Optional[str] = None,
     name: Optional[str] = None,
     parcel: Optional[UUID4] = None,
     status: Optional[int] = None,
     data: UploadFile = None,
+    from_date: datetime.date = None,
+    to_date: datetime.date = None,
+    parcel_id: str = None
 ):
     """
     Generates Animal Report PDF file
@@ -151,7 +169,7 @@ async def generate_animal_report(
                 detail=f"Data file must be provided if gatekeeper is not used.",
             )
 
-        params = {"format": "json"}
+        params = {}
         if animal_group:
             params["animal_group"] = animal_group
         if name:
@@ -160,13 +178,19 @@ async def generate_animal_report(
             params["parcel"] = str(parcel)
         if status is not None:
             params["status"] = status
-
+        if parcel_id:
+            params['parcel'] = parcel_id
+    if data:
+        data = data.file.read()
     background_tasks.add_task(
         process_animal_data,
         data=data,
         token=token,
         params=params,
         pdf_file_name=uuid_of_pdf,
+        from_date=from_date,
+        to_date=to_date,
+        farm_animal_id=farm_animal_id,
     )
 
     return PDF(uuid=uuid_v4)

app/api/deps.py

@@ -36,7 +36,7 @@ def get_current_user(
                 json={"token": token, "token_type": "access"},
             )
 
-            if response.status_code == 400:
+            if str(response.status_code)[0] != "2":
                 raise HTTPException(status_code=400, detail="Error, bad jwt token.")
             return token
         else:

app/core/config.py

@@ -27,9 +27,14 @@ class Settings(BaseSettings):
         "irrigations": "/IrrigationOperations/",
         "activity_types": "/FarmCalendarActivityTypes/",
         "observations": "/Observations/",
+        "operations": "/CompostOperations/",
+        "turning_operations": "/CompostTurningOperations/",
         "activities": "/FarmCalendarActivities/",
         "parcel": "/FarmParcels/",
         "animals": "/FarmAnimals/",
+        "materials": "/AddRawMaterialOperations/",
+        "machines": "/AgriculturalMachines/",
+        "farm": "/Farm/"
     }
 
     PDF_DIRECTORY: str = "user_reports/"