Merge pull request #349 from ASFHyP3/develop

jtherrmann · web-flow · commit 2aea5f1c2d41 · 2025-05-23T09:51:25.000-08:00
Release v7.5.0
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -12,4 +12,4 @@ on:
 
 jobs:
   call-changelog-check-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-changelog-check.yml@v0.19.0
diff --git a/.github/workflows/create-jira-issue.yml b/.github/workflows/create-jira-issue.yml
@@ -6,7 +6,7 @@ on:
 
 jobs:
   call-create-jira-issue-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-create-jira-issue.yml@v0.19.0
     secrets:
       JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
       JIRA_USER_EMAIL: ${{ secrets.JIRA_USER_EMAIL }}
diff --git a/.github/workflows/distribute.yml b/.github/workflows/distribute.yml
@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-version-info-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-version-info.yml@v0.19.0
     with:
       python_version: "3.10"
 
diff --git a/.github/workflows/labeled-pr.yml b/.github/workflows/labeled-pr.yml
@@ -12,4 +12,4 @@ on:
 
 jobs:
   call-labeled-pr-check-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-labeled-pr-check.yml@v0.19.0
diff --git a/.github/workflows/release-template-comment.yml b/.github/workflows/release-template-comment.yml
@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-release-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-release-checklist-comment.yml@v0.19.0
     permissions:
       pull-requests: write
     secrets:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,7 +7,7 @@ on:
 
 jobs:
   call-release-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-release.yml@v0.19.0
     with:
       release_prefix: HyP3 SDK
     secrets:
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -8,12 +8,12 @@ on: push
 jobs:
   call-secrets-analysis-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-secrets-analysis.yml@v0.19.0
 
   call-ruff-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-ruff.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-ruff.yml@v0.19.0
 
   call-mypy-workflow:
     # Docs: https://github.com/ASFHyP3/actions
-    uses: ASFHyP3/actions/.github/workflows/reusable-mypy.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-mypy.yml@v0.19.0
diff --git a/.github/workflows/tag-version.yml b/.github/workflows/tag-version.yml
@@ -9,6 +9,6 @@ jobs:
   call-bump-version-workflow:
     # For first-time setup, create a v0.0.0 tag as shown here:
     # https://github.com/ASFHyP3/actions#reusable-bump-versionyml
-    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-bump-version.yml@v0.19.0
     secrets:
       USER_TOKEN: ${{ secrets.TOOLS_BOT_PAK }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,7 +12,7 @@ on:
 
 jobs:
   call-pytest-workflow:
-    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.18.1
+    uses: ASFHyP3/actions/.github/workflows/reusable-pytest.yml@v0.19.0
     with:
       local_package_name: hyp3_sdk
       python_versions: >-
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.5.0]
+
+### Added
+* Added support for specifying a HyP3 API URL with a non-`.asf.alaska.edu` domain name. This is accomplished by updating the domain of the `asf-urs` cookie when creating the `HyP3` object.
+* Added support for specifying a HyP3 API URL that includes a path after the domain name. All API endpoints will be relative to the given path. For example, specifying `https://foo.example.com/api` results in the `/user` endpoint being relative to `/api`, i.e. `https://foo.example.com/api/user`.
+
 ## [7.4.0]
 
 ### Added
diff --git a/requirements-static.txt b/requirements-static.txt
@@ -1,2 +1,2 @@
-ruff==0.11.8
+ruff==0.11.10
 mypy==1.15.0
diff --git a/src/hyp3_sdk/hyp3.py b/src/hyp3_sdk/hyp3.py
@@ -5,7 +5,7 @@
 from functools import singledispatchmethod
 from getpass import getpass
 from typing import Literal
-from urllib.parse import urljoin
+from urllib.parse import SplitResult, urlsplit, urlunsplit
 from warnings import warn
 
 import hyp3_sdk
@@ -53,6 +53,16 @@ def __init__(
         self.session = hyp3_sdk.util.get_authenticated_session(username, password)
         self.session.headers.update({'User-Agent': f'{hyp3_sdk.__name__}/{hyp3_sdk.__version__}'})
 
+        hostname = urlsplit(self.url).hostname
+        assert hostname is not None
+        if not hostname.endswith('.asf.alaska.edu'):
+            self.session.cookies.set('asf-urs', self.session.cookies['asf-urs'], domain=hostname)
+
+    def _get_endpoint_url(self, endpoint: str) -> str:
+        parts = urlsplit(self.url)
+        path = '/'.join([parts.path.strip('/'), endpoint.strip('/')])
+        return urlunsplit(SplitResult(scheme=parts.scheme, netloc=parts.netloc, path=path, query='', fragment=''))
+
     def find_jobs(
         self,
         start: datetime | None = None,
@@ -86,7 +96,7 @@ def find_jobs(
 
                 params[param_name] = param_value
 
-        response = self.session.get(urljoin(self.url, '/jobs'), params=params)
+        response = self.session.get(self._get_endpoint_url('/jobs'), params=params)
         _raise_for_hyp3_status(response)
         jobs = [Job.from_dict(job) for job in response.json()['jobs']]
 
@@ -107,7 +117,7 @@ def get_job_by_id(self, job_id: str) -> Job:
         Returns:
             A Job object
         """
-        response = self.session.get(urljoin(self.url, f'/jobs/{job_id}'))
+        response = self.session.get(self._get_endpoint_url(f'/jobs/{job_id}'))
         _raise_for_hyp3_status(response)
 
         return Job.from_dict(response.json())
@@ -201,7 +211,7 @@ def submit_prepared_jobs(self, prepared_jobs: dict | list[dict]) -> Batch:
         else:
             payload = {'jobs': prepared_jobs}
 
-        response = self.session.post(urljoin(self.url, '/jobs'), json=payload)
+        response = self.session.post(self._get_endpoint_url('/jobs'), json=payload)
         _raise_for_hyp3_status(response)
 
         batch = Batch()
@@ -649,7 +659,7 @@ def my_info(self) -> dict:
         """Returns:
         Your user information
         """
-        response = self.session.get(urljoin(self.url, '/user'))
+        response = self.session.get(self._get_endpoint_url('/user'))
         _raise_for_hyp3_status(response)
         return response.json()
 
@@ -678,7 +688,7 @@ def costs(self) -> dict:
         """Returns:
         Table of job costs
         """
-        response = self.session.get(urljoin(self.url, '/costs'))
+        response = self.session.get(self._get_endpoint_url('/costs'))
         _raise_for_hyp3_status(response)
         return response.json()
 
@@ -703,6 +713,6 @@ def update_jobs(self, jobs: Batch | Job, **kwargs: object) -> Batch | Job:
         if not isinstance(jobs, Job):
             raise TypeError(f"'jobs' has type {type(jobs)}, must be {Batch} or {Job}")
 
-        response = self.session.patch(urljoin(self.url, f'/jobs/{jobs.job_id}'), json=kwargs)
+        response = self.session.patch(self._get_endpoint_url(f'/jobs/{jobs.job_id}'), json=kwargs)
         _raise_for_hyp3_status(response)
         return Job.from_dict(response.json())
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -14,11 +14,13 @@
 @pytest.fixture(autouse=True)
 def get_mock_hyp3():
     def mock_get_authenticated_session(username, password):
-        return requests.Session()
+        session = requests.Session()
+        session.cookies.set('asf-urs', 'test-cookie', domain='.asf.alaska.edu')
+        return session
 
-    def default_hyp3():
+    def default_hyp3(api_url: str = 'https://dummy-api.asf.alaska.edu'):
         with patch('hyp3_sdk.util.get_authenticated_session', mock_get_authenticated_session):
-            return HyP3()
+            return HyP3(api_url=api_url)
 
     return default_hyp3
 
diff --git a/tests/test_hyp3.py b/tests/test_hyp3.py
@@ -564,3 +564,35 @@ def test_update_jobs(get_mock_hyp3, get_mock_job):
 
     with pytest.raises(HyP3Error, match=r'^<Response \[400\]> test error message$'):
         api.update_jobs(job1, foo='bar')
+
+
+def test_get_endpoint_url(get_mock_hyp3):
+    api = get_mock_hyp3(api_url='https://dummy-api.asf.alaska.edu')
+    assert api._get_endpoint_url('foo') == 'https://dummy-api.asf.alaska.edu/foo'
+    assert api._get_endpoint_url('/foo') == 'https://dummy-api.asf.alaska.edu/foo'
+
+    api = get_mock_hyp3(api_url='https://foo.example.com/api')
+    assert api._get_endpoint_url('foo') == 'https://foo.example.com/api/foo'
+    assert api._get_endpoint_url('/foo') == 'https://foo.example.com/api/foo'
+    assert api._get_endpoint_url('///foo///') == 'https://foo.example.com/api/foo'
+
+    api = get_mock_hyp3(api_url='https://foo.example.com/api/')
+    assert api._get_endpoint_url('foo') == 'https://foo.example.com/api/foo'
+    assert api._get_endpoint_url('/foo') == 'https://foo.example.com/api/foo'
+    assert api._get_endpoint_url('///foo///') == 'https://foo.example.com/api/foo'
+
+    api = get_mock_hyp3(api_url='https://foo.example.com:8000/api/')
+    assert api._get_endpoint_url('foo') == 'https://foo.example.com:8000/api/foo'
+
+
+def test_update_cookie(get_mock_hyp3):
+    api = get_mock_hyp3()
+    assert api.session.cookies.get('asf-urs', domain='.asf.alaska.edu') == 'test-cookie'
+
+    api = get_mock_hyp3(api_url='https://foo.example.com:8000/api')
+    assert api.session.cookies.get('asf-urs', domain='.asf.alaska.edu') == 'test-cookie'
+    assert api.session.cookies.get('asf-urs', domain='foo.example.com') == 'test-cookie'
+
+    api = get_mock_hyp3(api_url='https://foo.asf.alaska.edu:8000/api')
+    assert api.session.cookies.get('asf-urs', domain='.asf.alaska.edu') == 'test-cookie'
+    assert api.session.cookies.get('asf-urs', domain='foo.asf.alaska.edu') is None
