Skip to content

Add Water Supply Pump Accounting Endpoints #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
krowvin merged 9 commits into from
Jul 2, 2025
Merged

Add Water Supply Pump Accounting Endpoints #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9e98583
Add initial accounting endpoints POST/GET
krowvin Jun 9, 2025
4bd46c5
No fail if exists param
krowvin Jun 9, 2025
2be0a5f
Add cwms import
krowvin Jun 17, 2025
9004895
Remove unused imports
krowvin Jun 17, 2025
be5465a
Create pump accounting tests
krowvin Jun 17, 2025
542138e
add multi timeseries store
Enovotny Jun 16, 2025
3d8e1a8
fix to save mutitimeseries call
Jun 17, 2025
50da643
Bump to 0.7.3
krowvin Jun 17, 2025
6db4190
Merge branch 'main' into 107-water-supply
krowvin Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cwms/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from cwms.projects.project_lock_rights import *
from cwms.projects.project_locks import *
from cwms.projects.projects import *
from cwms.projects.water_supply.accounting import *
from cwms.ratings.ratings import *
from cwms.ratings.ratings_spec import *
from cwms.ratings.ratings_template import *
Expand Down
145 changes: 145 additions & 0 deletions cwms/projects/water_supply/accounting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Copyright (c) 2024
# United States Army Corps of Engineers - Hydrologic Engineering Center (USACE/HEC)
# All Rights Reserved. USACE PROPRIETARY/CONFIDENTIAL.
# Source may not be released without written approval from HEC
import cwms.api as api
from cwms.cwms_types import JSON, Data


def get_pump_accounting(
office_id: str,
project_id: str,
water_user: str,
contract_name: str,
start: str,
end: str,
timezone: str = "UTC",
unit: str = "cms",
start_time_inclusive: bool = True,
end_time_inclusive: bool = True,
ascending: bool = True,
row_limit: int = 0,
) -> Data:
"""
Retrieves pump accounting entries associated with a water supply contract.

Parameters
----------
office_id : str
The office ID the pump accounting is associated with. (Path)
project_id : str
The project ID the pump accounting is associated with. (Path)
water_user : str
The water user the pump accounting is associated with. (Path)
contract_name : str
The name of the contract associated with the pump accounting. (Path)
start : str
The start time of the time window for pump accounting entries to retrieve.
Format: ISO 8601 extended, with optional offset and timezone. (Query)
end : str
The end time of the time window for pump accounting entries to retrieve.
Format: ISO 8601 extended, with optional offset and timezone. (Query)
timezone : str, optional
The default timezone to use if `start` or `end` lacks offset/timezone info.
Defaults to "UTC". (Query)
unit : str, optional
Unit of flow rate for accounting entries. Defaults to "cms". (Query)
start_time_inclusive : bool, optional
Whether the start time is inclusive. Defaults to True. (Query)
end_time_inclusive : bool, optional
Whether the end time is inclusive. Defaults to True. (Query)
ascending : bool, optional
Whether entries should be returned in ascending order. Defaults to True. (Query)
row_limit : int, optional
Maximum number of rows to return. Defaults to 0, meaning no limit. (Query)

Returns
-------
Data
The JSON response from CWMS Data API wrapped in a Data object.

Raises
------
ValueError
If any required path parameters are None.
ClientError
If a 400-level error occurs.
NoDataFoundError
If a 404-level error occurs.
ServerError
If a 500-level error occurs.
"""
if not all([office_id, project_id, water_user, contract_name, start, end]):
raise ValueError("All required parameters must be provided.")

endpoint = f"projects/{office_id}/{project_id}/water-user/{water_user}/contracts/{contract_name}/accounting"

params: dict[str, str | int] = {
"start": start,
"end": end,
"timezone": timezone,
"unit": unit,
"start-time-inclusive": str(start_time_inclusive).lower(),
"end-time-inclusive": str(end_time_inclusive).lower(),
"ascending": str(ascending).lower(),
"row-limit": row_limit,
}

response = api.get(endpoint, params, api_version=1)
return Data(response)


def store_pump_accounting(
office: str,
project_id: str,
water_user: str,
contract_name: str,
data: JSON,
) -> None:
"""
Creates a new pump accounting entry associated with a water supply contract.

Parameters
----------
office : str
The office ID the accounting is associated with. (Path)
project_id : str
The project ID the accounting is associated with. (Path)
water_user : str
The water user the accounting is associated with. (Path)
contract_name : str
The name of the contract associated with the accounting. (Path)
data : dict
A dictionary representing the JSON data to be stored. This should match the
WaterSupplyAccounting structure as defined by the API.

Returns
-------
None

Raises
------
ValueError
If any required argument is missing.
ClientError
If a 400 range error code response is returned from the server.
NoDataFoundError
If a 404 range error code response is returned from the server.
ServerError
If a 500 range error code response is returned from the server.
"""
if not all([office, project_id, water_user, contract_name]):
raise ValueError(
"Office, project_id, water_user, and contract_name must be provided."
)
if not data:
raise ValueError("Data must be provided and cannot be empty.")

endpoint = f"projects/{office}/{project_id}/water-user/{water_user}/contracts/{contract_name}/accounting"
params = {
"office": office,
"project-id": project_id,
"water-user": water_user,
"contract-name": contract_name,
}
api.post(endpoint, data, params)
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "cwms-python"
repository = "https://github.com/HydrologicEngineeringCenter/cwms-python"

version = "0.7.1"
version = "0.7.3"


packages = [
Expand Down
56 changes: 56 additions & 0 deletions tests/projects/water_supply/accounting_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import pytest

import cwms.api
from cwms.cwms_types import Data
from cwms.projects.water_supply.accounting import (
get_pump_accounting,
store_pump_accounting,
)


@pytest.fixture(autouse=True)
def init_session():
cwms.api.init_session(api_root="https://mockwebserver.cwms.gov")


def test_get_pump_accounting(requests_mock):
endpoint = (
"https://mockwebserver.cwms.gov/"
"projects/SWT/KEYS/water-user/TEST_USER/contracts/TEST_CONTRACT/accounting"
)
expected_json = {"entries": [{"timestamp": "2024-01-01T00:00:00Z", "value": 1.23}]}

requests_mock.get(endpoint, json=expected_json)

data = get_pump_accounting(
office_id="SWT",
project_id="KEYS",
water_user="TEST_USER",
contract_name="TEST_CONTRACT",
start="2024-01-01T00:00:00Z",
end="2024-01-02T00:00:00Z",
)

assert isinstance(data, Data)
assert data.json == expected_json


def test_store_pump_accounting(requests_mock):
endpoint = (
"https://mockwebserver.cwms.gov/"
"projects/SWT/KEYS/water-user/TEST_USER/contracts/TEST_CONTRACT/accounting"
)
mock_data = {"entries": [{"timestamp": "2024-01-01T00:00:00Z", "value": 1.23}]}

requests_mock.post(endpoint, status_code=200)

store_pump_accounting(
office="SWT",
project_id="KEYS",
water_user="TEST_USER",
contract_name="TEST_CONTRACT",
data=mock_data,
)

assert requests_mock.called
assert requests_mock.call_count == 1