added new unit test and http error handling

.gitignore.txt

@@ -0,0 +1,164 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.DS_Store

beachwatch.egg-info/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.1
+Name: beachwatch
+Version: 0.1.3
+Summary: A Python wrapper for the NSW Government's Beachwatch API.
+Author-email: Ben Nour <hello@ben-nour.com>
+License: MIT License
+
+        Copyright (c) 2024 Ben
+
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+
+Project-URL: homepage, https://github.com/ben-n93/beachwatch
+Project-URL: repository, https://github.com/ben-n93/beachwatch
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests~=2.32.3
+Requires-Dist: python-dateutil~=2.9.0.post0
+
+# beachwatch 🏖️
+
+<p align="center">
+    <a href="https://github.com/ben-n93/beachwatch/actions/workflows/tests.yml/badge.svg"><img src="https://github.com/ben-n93/beachwatch/actions/workflows/tests.yml/badge.svg"           alt="Testing"></a>
+    <a href="https://pypi.org/project/beachwatch/"><img src="https://img.shields.io/pypi/pyversions/beachwatch" alt="versions"></a>
+    <a href="https://github.com/ben-n93/beachwatch/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/beachwatch" alt="License"></a>
+</p>
+
+`beachwatch` is a Python wrapper for the NSW Government's [Beachwatch API](https://beachwatch.nsw.gov.au/waterMonitoring/beachwatchDataFeeds).
+
+In their own words:
+
+*"Beachwatch and our partners monitor water quality at swim sites to ensure that recreational water environments are managed as safely as possible so that as many people as possible can benefit from using the water."*
+
+With this package you can retrieve data about a NSW beach's water pollution forecast, water quality rating, coordinates and more.
+
+## Installation
+
+```
+pip install beachwatch
+```
+
+## Usage
+
+There is only one function - `get_beaches()` function, which returns `Beach` objects:
+
+```py
+>>> get_beaches() # Returns a list of all Beach objects.
+>>> get_beaches("Bondi Beach") # Returns a list with the specified beach.
+>>> get_beaches("Bondi Beach", "Whale Beach") # Returns a list with the specifies beaches.
+```
+
+The `Beach` object:
+``` py
+class Beach:
+    """A NSW beach.
+
+    Attributes
+    ----------
+    identifier : str
+         Unknown but likely a unique ID within the Beachwatch database.
+    name : str
+         The name of the beach.
+    pollution_forecast : str
+         The latest water quality pollution forecast.
+    pollution_forecast_timestamp : datetime.datetime
+         What time the forecast was issued by Beachwatch.
+    latest_result : str
+         A water quality rating based on the number of bacteria (enterococci)
+         in the most recent water sample.
+    latest_result_rating : int
+        The latest water quality result, rated from 1 to 4 to indicate
+        suitability for swimming.
+    latest_result_observation_timestamp : datetime.datetime
+         The most recent sampling date.
+    geometry : dict
+         A GeoJSON feature with the coordinates of the beach.
+    """
+```
+
+Note that the `Beach` object is not meant to be instantiated directly.
+
+### Example
+``` py
+>>> bondi = get_beaches("Bondi Beach")[0]
+>>> bondi.pollution_forecast
+    'Good'
+```
+## Important 
+
+Beachwatch notes on their website that forecasts *"are predictions of water quality only and are not 100% accurate.
+Beachwatch cannot guarantee the accuracy of any of the results or outputs from this model. Any reliance you place on such information is strictly at your own risk."*

beachwatch.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+beachwatch/__init__.py
+beachwatch/beachwatch.py
+beachwatch.egg-info/PKG-INFO
+beachwatch.egg-info/SOURCES.txt
+beachwatch.egg-info/dependency_links.txt
+beachwatch.egg-info/requires.txt
+beachwatch.egg-info/top_level.txt
+tests/test_beachwatch.py

beachwatch.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

beachwatch.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests~=2.32.3
+python-dateutil~=2.9.0.post0

beachwatch.egg-info/top_level.txt

@@ -0,0 +1 @@
+beachwatch

beachwatch/__init__.py

@@ -2,6 +2,6 @@
 
 __author__ = """Ben Nour"""
 __email__ = "hello@ben-nour.com"
-__version__ = "0.1.2"
+__version__ = "0.1.3"
 
 from .beachwatch import get_beaches, Beach

beachwatch/beachwatch.py

@@ -29,7 +29,7 @@ def get_beaches(*names):
     ValueException
         If the API returns no data for one of the beach names passed to this
         function, which would indicate that the beach does not exist in the
-        Beachwatch records/database.
+        Beachwatch database.
     """
 
     def create_beach(beach):
@@ -61,29 +61,32 @@ def create_beach(beach):
             ("site_name", name) for name in names
         ]  # In case a user passes multiple beach names.
 
-        data = requests.get(
+        response = requests.get(
             "https://api.beachwatch.nsw.gov.au/public/sites/geojson",
             params=parameters,
             timeout=15,
         )
-        if data.json() == {"type": "FeatureCollection", "features": []} or len(
-            data.json()["features"]
+        response.raise_for_status()
+        if response.json() == {"type": "FeatureCollection", "features": []} or len(
+            response.json()["features"]
         ) != len(names):
             returned_beach_names = [
-                feature["properties"]["siteName"] for feature in data.json()["features"]
+                feature["properties"]["siteName"]
+                for feature in response.json()["features"]
             ]
             invalid_beaches = list(set(names) - set(returned_beach_names))
             raise ValueError(
                 f"The following beaches does not exist or does not exist in the Beachwatch database: {invalid_beaches}"
             )
 
-        beaches = [create_beach(beach) for beach in data.json()["features"]]
+        beaches = [create_beach(beach) for beach in response.json()["features"]]
         return beaches
     # All beaches.
-    data = requests.get(
+    response = requests.get(
         "https://api.beachwatch.nsw.gov.au/public/sites/geojson", timeout=15
     )
-    beaches = [create_beach(beach) for beach in data.json()["features"]]
+    response.raise_for_status()
+    beaches = [create_beach(beach) for beach in response.json()["features"]]
     return beaches
 
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "beachwatch"
-version = "0.1.2"
+version = "0.1.3"
 description = "A Python wrapper for the NSW Government's Beachwatch API."
 authors = [
     { name = "Ben Nour", email = "hello@ben-nour.com" }

tests/test_beachwatch.py

@@ -5,6 +5,7 @@
 from datetime import datetime
 
 import pytest
+import requests
 
 from beachwatch.beachwatch import get_beaches, Beach
 
@@ -31,6 +32,17 @@ def api_json():
     }
 
 
+def test_http_error_raises_exception(requests_mock):
+    """Test that an exception is raised if the web API returns
+    a client or server error.
+    """
+    requests_mock.get(
+        "https://api.beachwatch.nsw.gov.au/public/sites/geojson", status_code=400
+    )
+    with pytest.raises(requests.exceptions.HTTPError):
+        get_beaches()
+
+
 def test_nonexistent_beach_name(requests_mock):
     """Test that a ValueError is raised when the API returns a blank
     response (indiciating the beach does not exist).