A Ruby on Rails engine for the Sword V2 server. The Sword server is currently integrated with Hyrax V2.
Add this line to your application's Gemfile:
gem 'willow_sword', git: 'https://github.com/CottageLabs/willow_sword.git'And then execute:
$ bundleOr install it yourself as:
$ gem install willow_swordMount the engine. Add this line to config/routes.rb
mount WillowSword::Engine => '/sword'Or run the generator
bundle exec rails generate willow_sword:installThe plugin has a few configuration options. To view the current default options and override these, see configuration options
By default SWORD links (service document collection hrefs, edit, edit-media, related and Location headers) use the request host. If a proxy rewrites Host (for example so a multi-tenant app can resolve the tenant) and passes the host the client called in another header, name that header and list the hosts it may carry:
WillowSword.setup do |config|
config.sword_host_header = 'X-Sword-Host'
config.sword_allowed_hosts = ['sword.example.org']
endThe header is ignored, and the request host used, unless its value is a bare hostname that exactly matches (case-insensitively) an entry in sword_allowed_hosts. Clients can send any header they like, so without the allow-list a client could put its own host into the links. Both settings default to off (nil and []), which leaves links unchanged. Content links (work pages, file downloads) always stay on the request host.
If you would like to authorize all Sword requests using an Api-key header, see Enabling authorization
To use the plugin see usage.
Contribution directions go here.
The gem is available as open source under the terms of the MIT License.
bundle install
rspecRequest specs boot up a Hyrax instance inside a docker environment and run test against it.
docker compose up -d
# wait for the web service to finish booting up the Hyrax instance
cd /willow_sword
rspecIf you're getting a platform error when trying to up the containers, try adding
platform: linux/amd64 to the web service.
Ex.
services:
web:
platform: linux/amd64