Supplejack API Mountable Engine
Clone or download
Latest commit ae7b753 Nov 15, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app delete more foundation andsimple form Nov 15, 2018
bin when the pigs try and get at you, drop it like it's hot Nov 27, 2017
config Remove the admin controllers for displaying the site activity informa… Apr 12, 2018
db US [#95675608] SEARCH FOR CONCEPTS Jul 2, 2015
features Change all instances of `SupplejackApi::Record to use the SupplejackA… Apr 10, 2018
lib remove simple form from generator Nov 9, 2018
script Removed Crown copyright where copyright owned by someone else May 16, 2014
solr/conf Fixed broken Cucumber specs due to Solr configuration. Jan 19, 2015
spec delete more foundation andsimple form Nov 15, 2018
.codeclimate.yml Add codeclimate.yml file to specify list of engines to run Feb 11, 2016
.gitignore install generator_spec gem Sep 14, 2018
.rspec Move new dependencies to gemspec; basic failing test for new schemas Sep 22, 2016
.rubocop.yml Why : Rubocop offences Mar 28, 2017
.rubocop_todo.yml Renamed create exception method to create error Oct 13, 2016
.ruby-version Remove .ruby-version from gitignore and set to 2.3.1 Sep 19, 2016
.tags clean up of story.rb endpoint: code review changes Jul 21, 2017
.travis.yml Revert "FIX SOURCE LINK CHECK 504 TIMEOUTS: As a PO I want the linkch… Jul 16, 2018
Dockerfile Refactoring changes for Chris & Dockerfile updates Oct 21, 2015
Gemfile Merge branch 'master' into tp/upgrade-mongo-to-3.6-in-staging Sep 27, 2018
Gemfile.lock remove simple form from generator Nov 9, 2018
Guardfile rubocops Nov 27, 2017
LICENSE.txt Rename License to LICENSE.txt May 16, 2014
README.md Why : Supplejack requires a logo. Sep 28, 2017
Rakefile Appease the rubocop Feb 22, 2018
docker-compose.yml Refactoring changes for Chris & Dockerfile updates Oct 21, 2015
supplejack_api.gemspec delete unnecessary gems Nov 8, 2018

README.md

Supplejack Logo

Supplejack API

Build Status

The Supplejack API is a mountable engine which provides functionality to store, index and retrieve metadata via an API.

For more information on how to configure and use this application refer to the documentation.

Installation

Install & Setup instructions

Swagger Documentation

Stories Api

Engine Development

Rails console

cd spec/dummy/
bundle exec rails console

Rails server

cd spec/dummy/
bundle exec rails server

Solr

cd spec/dummy/
bundle exec rake app:sunspot:solr:start

This will start the server based on the configuration in config/sunspot.yml

cd spec/dummy/
bundle exec rake app:sunspot:solr:stop

Engine Testing

Rspec Specs

From the root of the engine, run

bundle exec rspec spec/

This uses spec/dummy to mount the engine into and then runs the specs.

Cucumber Features

From the root of the engine, run

bundle exec cucumber features/

This uses a test Solr instance from spec/dummy/solr in order to test searching.

COPYRIGHT AND LICENSING



MAJORITY OF SUPPLEJACK CODE - GNU GENERAL PUBLIC LICENCE, VERSION 3



Supplejack is a tool for aggregating, searching and sharing metadata records. Supplejack API is a component of Supplejack. Except as indicated below, the Supplejack API code is Crown copyright (C) 2014, New Zealand Government. Supplejack was created by DigitalNZ at the National Library of NZ and the Department of Internal Affairs. http://digitalnz.org/supplejack

Except as indicated below, this program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses / http://www.gnu.org/licenses/gpl-3.0.txt

SUPPLEJACK API SUNSPOTSESSIONPROXY



The Supplejack API SunspotSessionProxy was authored by HeyZap (http://www.heyzap.com/) and is available at http://stdout.heyzap.com/2011/08/17/sunspot-resque-session-proxy/.