This is a Ruby app deployed as an AWS Lambda behind API Gateway to serve:
GET /api/v0.1/items/{nyplSource}/{id}/is-research
GET /api/v0.1/bibs/{nyplSource}/{id}/is-research
The service indicates whether the named item or bib is "research" (as opposed to "branch"/"circulating"). The business logic implemented in this codebase for determining if an item or bib is research or circulating is documented here:
bundle install; bundle install --deployment
If you get the error You must use Bundler 2 or greater with this lockfile. run
gem install bundler -v 2.0.2
All config is in sam.[ENVIRONMENT].yml templates, encrypted as necessary.
- Cut branches from
development. - Create PR against
development. - After review, PR author merges.
- Merge
development>qa - Merge
qa>master - Tag version bump in
master
The following will invoke the lambda against various mock events. Replace [event] with one of the mock events listed below.
sam local invoke --event events/[event] --region us-east-1 --template sam.local.yml --profile [aws profile]
event-bib_is_research_true.jsonevent-item_is_research_true.jsonevent-item_is_research_false.jsonevent-item_not_found.jsonevent-swagger.json
To run the server locally:
sam local start-api --template sam.local.yml
Given that gems are installed with the --deployment flag, Bundler will complain if you make changes to the Gemfile. To make changes to the Gemfile, exit deployment mode:
bundle install --no-deployment
bundle exec rspec -fd
Make sure to also run a test event, as described above as a form of end-to-end testing.
The scripts directory contains code used for a one time processing of an export of the itemservice sql database run locally. The scripts will not be actively maintained with the codebase. They are preserved for reference purposes.
Deployments are entirely handled by Travis-ci.com. To deploy to development, qa, or production, commit code to the development, qa, and master branches on origin, respectively.