PushmiPullyu is a Ruby application, running behind the firewall that protects our Swift environment.
Its primary job is to manage the flow of content from Fedora into Swift for preservation.
- Any save (create or update) on a Item/Thesis in ERA/Jupiter will trigger an after save callback that will push the item's unique identifier (UUID or NOID) into a Queue.
- The queue (Redis) is setup to be a unique set (which only allows one item's UUID to be included in the queue at a single time), and ordered by priority from First In, First out (FIFO).
- PushmiPullyu will then monitor the queue. After a certain wait period has passed since an element has been on the queue, PushmiPullyu will then retrieve the elements off the queue and begin to process the preservation event.
- All the GenericFile information and data required for preservation are retrieved from Fedora using multiple REST calls. A database connection to the user database fetches (via ActiveRecord )owner emails and modifies the fetched documents, where applicable.
- An Archival Information Package (AIP) is created from the item's information. It is then bagged and tarred.
- The AIP tar is then uploaded to Swift via a REST call.
- On a successful Swift upload, a entry is added for this preservation event to the preservation event logs.
PushmiPullyu supports Ruby 2.3.1+
PushmiPullyu is hosted on rubygems.org. Therefore it can be installed via:
gem install pushmi_pullyu
Run as a daemon:
PushmiPullyu is quite flexible in that many options can be specified at the command line.
pushmi_pullyu --help to see all the command line options available.
Usage: pushmi_pullyu [options] [start|stop|restart|run] Specific options: -a, --minimum-age AGE Minimum amount of time an item must spend in the queue, in seconds. -d, --debug Enable debug logging -r, --rollbar-token TOKEN Enable error reporting to Rollbar -C, --config PATH Path for YAML config file -L, --logdir PATH Path for directory to store log files -D, --piddir PATH Path for directory to store pid files -W, --workdir PATH Path for directory where AIP creation work takes place in -N, --process_name NAME Name of the application process -m, --monitor Start monitor process for a deamon -q, --queue NAME Name of the queue to read from Common options: -v, --version Show version -h, --help Show this message
You can also provide a configuration file which PushmiPullyu will use with the -C (or --config) flag:
pushmi_pullyu start -C /path/to/config.yml
By default, if no configuration file is specified, PushmiPullyu will look for a configuration file at config/pushmi_pullyu.yml.
Options passed on the command line will also override options specified in the config file.
PushmiPullyu responds to these signals:
INT: Equivalent of sending Ctrl-C to PushmiPullyu. Will attempt to finish then exit.
TERM: Similar to
INT. PushmiPullyu will attempt to finish then exit.
HUP: Reopens log files as defined in logfile configuration options.
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
To run the test suite:
bundle install bundle exec rake
This will run both rspec and rubocop together.
To run rspec by itself:
bundle exec rspec
To run rubocop by itself:
bundle exec rubocop
Releasing a new gem version
To release a new version, bump the version file found here:
Try to bump versions using semantic versioning.
Commit this change into master branch via a PR.
Once committed, you can do a release by running the following rake command:
This will cut a tag version, builds the gem, and pushes the gem up to Rubygems
Note: You may need permission to push a gem up to Rubygems! You will first need to create an account on rubygems.org. Once you have an account, bug Shane or Matt to add you as an owner to pushmi_pullyu Rubygem. Once you are an owner you should be able to push new versions of pushmi_pullyu up to Rubygems.
TODO: Fill me out
The gem is available as open source under the terms of the MIT License.