Skip to content

Replace retired Splines demo with a local Oxford HAL example - #328

Merged
dblock merged 1 commit into
codegram:masterfrom
dblock:dblock/oxford-example
Oct 14, 2026
Merged

dblock merged 1 commit into
codegram:masterfrom
dblock:dblock/oxford-example

Conversation

@dblock

@dblock dblock commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Closes #67 by making a reproducible local Oxford demo the main example instead of the retired Splines Heroku app.

  • Add a read-only localhost HAL server and runnable Hyperclient client demonstrating collections, attributes, relative link traversal, embedded file metadata, templated links, and CURIEs.
  • Use a small factual subset of the archived Balliol College record, retaining its original place paths. Document exact snapshot provenance and demo adaptations; no images are downloaded or redistributed.
  • Replace Splines README usage examples and remove the obsolete Splines script. Keep generic write-method documentation, explicitly noting the local demo rejects writes.
  • Add automated offline smoke coverage to the existing Minitest suite and WEBrick as a development/test dependency, not a runtime dependency.

The underlying OxPoints place data is CC0: Oxford explicitly states "Public domain (CC0; no attribution required)" on slide 8 of its 2011 OxPoints presentation. The demo README documents this primary-source licensing evidence. This does not claim a license for complete archived API responses or photographs; no images are redistributed. Collection/template/CURIE endpoints are explicitly documented as newly authored demo additions. The dataset is historical and intentionally minimal, not a mirror of the retired service.

Validation

Full Minitest and Spinach suites and RuboCop pass. Also started the actual WEBrick server on a local ephemeral port, verified its HAL response, and ran the documented client successfully over HTTP, then stopped the server.

The pre-existing untracked examples/README.md is untouched and excluded. This PR is independent of repository-hygiene PR #327.

@dblock
dblock force-pushed the dblock/oxford-example branch from 761a06c to 1f9157d Compare October 14, 2026 21:33
@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Danger Report

No issues found.

View run

@coveralls

coveralls commented Oct 14, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 99.687% (-0.3%) from 100.0% — dblock:dblock/oxford-example into codegram:master

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dblock
dblock force-pushed the dblock/oxford-example branch from 1f9157d to 3e21bf4 Compare October 14, 2026 21:37
@dblock
dblock merged commit 276b7d1 into codegram:master Oct 14, 2026
12 checks passed
@dblock
dblock deleted the dblock/oxford-example branch October 14, 2026 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an example that uses api.m.ox.ac.uk and others

2 participants