WillowSword

A Ruby on Rails engine for the Sword V2 server. The Sword server is currently integrated with Hyrax V2.

Installation

Add this line to your application's Gemfile:

gem 'willow_sword', git: 'https://github.com/CottageLabs/willow_sword.git'

And then execute:

$ bundle

Or install it yourself as:

$ gem install willow_sword

Mount the engine. Add this line to config/routes.rb

mount WillowSword::Engine => '/sword'

Or run the generator

bundle exec rails generate willow_sword:install

Configuration

The plugin has a few configuration options. To view the current default options and override these, see configuration options

Enable authorization

If you would like to authorize all Sword requests using an Api-key header, see Enabling authorization

Usage

To use the plugin see usage.

Contributing

Contribution directions go here.

License

The gem is available as open source under the terms of the MIT License.

Testing

Legacy tests

bundle install
rspec

Request specs

Request 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
rspec

Troubleshooting

If 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