https://github.com/sul-dlss/suri-rails

A Rails-based identifier service
https://github.com/sul-dlss/suri-rails

application infrastructure rails rails-api ruby

Last synced: about 2 months ago
JSON representation

A Rails-based identifier service

• Host: GitHub
• URL: https://github.com/sul-dlss/suri-rails
• Owner: sul-dlss
• Created: 2017-08-25T16:00:17.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T15:55:41.000Z (about 2 years ago)
• Last Synced: 2024-04-08T19:09:33.649Z (about 2 years ago)
• Topics: application, infrastructure, rails, rails-api, ruby
• Language: Ruby
• Homepage: https://sul-dlss.github.io/suri-rails/
• Size: 423 KB
• Stars: 1
• Watchers: 18
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![Build Status](https://circleci.com/gh/sul-dlss/suri-rails.svg?style=svg)](https://circleci.com/gh/sul-dlss/suri-rails)

[![codecov](https://codecov.io/github/sul-dlss/suri-rails/graph/badge.svg?token=HPGVvrZghX)](https://codecov.io/github/sul-dlss/suri-rails)

[![Docker image](https://images.microbadger.com/badges/image/suldlss/suri-rails.svg)](https://microbadger.com/images/suldlss/suri-rails "Get your own image badge on microbadger.com")

[![OpenAPI Validator](http://validator.swagger.io/validator?url=https://raw.githubusercontent.com/sul-dlss/suri-rails/main/openapi.yml)](http://validator.swagger.io/validator/debug?url=https://raw.githubusercontent.com/sul-dlss/suri-rails/main/openapi.yml)

# SURI

SURI is the Stanford Unique Resource Identifier service. It mints unique identifiers (e.g., DRUIDs).

SURI has an [OpenAPI 3.0 spec](http://spec.openapis.org/oas/v3.0.2) that documents the API in [openapi.yml](openapi.yml). You can browse the generated documentation at [http://sul-dlss.github.io/suri-rails/](http://sul-dlss.github.io/suri-rails/).

## Installation

Clone the repository

    $ git clone git@github.com:sul-dlss/suri-rails.git

Change directories into the app and install dependencies

    $ bundle install

Start the development server

    $ rails s

## Testing

First, ensure the database container is spun up:

    $ docker compose up db # use -d to daemonize/run in background

And if you haven't yet prepared the test database, run:

    $ bin/rails db:setup

The test suite (with RuboCop style enforcement) will be run with the default rake task (also run on CI).

    $ bin/rake

The specs can be run without RuboCop enforcement

    $ bin/rake spec

The RuboCop style enforcement can be run without running the tests

    $ bin/rake rubocop

## Building for Docker

Spin up the application and its database:

    $ docker compose up --build

## Updating Docker Image

Note that CI is configured to automatically update the image hosted on DockerHub on every commit to `main`. If you want to build and push an image manually, run:

    $ docker build -t suldlss/suri-rails:latest .

    $ docker push suldlss/suri-rails:latest