Ruby for ArchivesSpace

Workshop for operations against the ArchivesSpace REST API using Ruby

Getting Started

Google Cloud Shell

Initializing the Environment

$ bin/init

Resetting the Environment

Should any repository files be corrupted, or should there be bugs arising from the state of the repository source code files, one may reset the state of the environment with the following:

$ bin/reset

Princeton University Library Infrastructure

Please see the Princeton University Library Infrastructure page for instructions on accessing the server environment ruby-office1.princeton.edu.

Workshop Sessions

Session 1 (REST API Tutorials)

Recording on Zoom Cloud from 02/24/2022

• Introduction to REST
• httparty (HTTP client)
• archivesspace-client (ArchivesSpace API client by Lyrasis)
• Authentication for ArchivesSpace

Session 2 (Introduction to the ArchivesSpace API)

Recording on Zoom Cloud from 03/03/2022

• Overview of aspace_helpers
• Methods in helper_methods.rb
• Examples in usage_examples.rb
• Authenticate with authentication.rb
• Our first script

Session 3 (Batch Operations with the ArchivesSpace API)

Recording on Zoom Cloud from 03/15/2022

• Loops
• Arrays and Hashes in ArchivesSpace
• Gotchas

Session 4 (Running Report Templates & Open Q&A)

Recording on Zoom Cloud from 03/29/2022

• Reports in aspace_helpers
• Read-through
• Modifying a report template
• Open Q&A