triannon 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21dce7d9930428e39541a90880061ab9430c4ed3
-  data.tar.gz: 9db2857167c28d12b8e265b38d7ebbeb0b30ad9d
+  metadata.gz: d20d2124fb17c180ab12ea7b7327231153911b78
+  data.tar.gz: 983a6a576832035c3fdc880c6f238543330abd9e
 SHA512:
-  metadata.gz: a972fe423f6d5bd9b71832694686f74e508fab8dfe9bac748146be479fd0ffe5ee12c003dc29f744ead0f338cd5110293403c4777157c193d0550943960f0d5f
-  data.tar.gz: 2b75bc5f07de320f259352ad2b3f386b3fdc4d385e20cae4a64959f4a53da4faa939fe544b71e1d0b1b478395213c353ef1a9b9630ea9988652a19f80ceade25
+  metadata.gz: fa243bfb9936f35133da5a99f863698415fcbeb9c05ebe924b4af6250579351ed719b4c3b6a23dcd2de94a9017b1721455fef48527630abbd7d95b54aff32c6b
+  data.tar.gz: 7343b0510476dde7a96efad33f16b2d3d771361edd2c4155be3342911c40da2e154ce38d5de0a944400e4c30ccf48221ed7477e407a77fb7e3c66161775f3e49

data/README.md

@@ -4,30 +4,20 @@
 
 Store Open Annotation in Fedora4 to support the Linked Data for Libraries use cases.
 
-## Tests
+## Installation into Your Rails Application
 
-Run tests:
-
-```console
-$ rake
-```
-
-## Installation into Rails app
-
-Add this line to your Rails app gemfile
+Add this line to your Rails application's Gemfile
 
 ```ruby
 gem 'triannon'
 ```
 
 Then execute:
-
 ```console
-$ bundle
+$ bundle install
 ```
 
 Then run the triannon generator:
-
 ```console
 $ rails g triannon:install
 ```
@@ -47,6 +37,7 @@ $ rake triannon:create_root_container
 Set up caching for jsonld context documents:
 
 * by using Rack::Cache for RestClient:
+
 ** add to Gemfile:
 
 ```ruby
@@ -54,6 +45,7 @@ gem 'rest-client'
 gem 'rack-cache'
 gem 'rest-client-components'
 ```
+
 *** bundle install
 ** create a  config/initializers/rest_client.rb
 
@@ -71,9 +63,22 @@ RestClient.enable Rack::Cache,
 ## Client Interactions with Triannon
 
 ### Get a list of annos
-NOTE:  implementation of Annotation Lists is coming!
-* `GET`: `http://(host)/`
-* `GET`: `http://(host)/annotations`
+as a IIIF Annotation List (see http://iiif.io/api/presentation/2.0/#other-content-resources)
+
+* `GET`: `http://(host)/annotations/search?targetUri=some.url.org`
+
+Search Parameters:
+* `targetUri` - matches URI for target, with or without http or https scheme prefix
+* `bodyUri` - matches URI for target, with or without http or https scheme prefix
+* `bodyExact` - matches body characters exactly
+* `bodyKeyword` - matches terms in body characters
+* `motivatedBy` - matches fragment part of motivation predicate URI, e.g.  commenting, tagging, painting
+
+* use HTTP `Accept` header with mime type to indicate desired format
+  * default:  jsonld
+    * `Accept`: `application/ld+json`
+  * also supports turtle, rdfxml, json, html
+    * `Accept`: `application/x-turtle`
 
 ### Get a particular anno
 `GET`: `http://(host)/annotations/(anno_id)`
@@ -128,49 +133,96 @@ Note that OA (Open Annotation) is the default context if none is specified.
 `DELETE`: `http://(host)/annotations/(anno_id)`
 
 
-## Running the application in development
+# Running This Code in Development
 
-There is a bundled rake task for running the test app, but there is some one-time set up.
+There is a bundled rake task for running triannon in a test rails application, but there is some one-time set up.
 
-### One time setup
+## One time setup
 
-##### Set up a local instance of Fedora4
+### Set up a local instance of Fedora4
 ```console
 $ rake jetty:download
 $ rake jetty:unzip
 ```
-##### Set up a Triannon flavored Solr
+
+### Set up a Triannon flavored Solr
 ```console
 rake triannon:solr_jetty_setup
 ```
 
-##### Set up a runnable Rails app that uses triannon gem
+### Set up the testing Rails app that uses triannon gem
 ```console
 $ rake engine_cart:generate # (first run only)
 ```
 
-#### Start jetty
+### Start jetty
 ```console
 $ rake jetty:start
 ```
 
-##### Generate root annotations container
+Note that jetty can be very sloooooooow to start up with Fedora and Solr.
+
+#### Check if Solr is up
+Go to http://localhost:8983/solr/#/triannon
+or to http://localhost:8983/solr/triannon/select
+
+If all is well, you will not get an error message; the triannon core exists in Solr.  If all is not
+well, try:
+
+```console
+$ rake jetty:stop
+$ rake triannon:solr_jetty_setup
+$ rake jetty:start
+```
+
+and then check again.
+
+
+#### Check if Fedora is up
+Go to http://localhost:8983/fedora/rest/
+
+If all is well, you will not get an error message.  If all is not well, try:
+
+```console
+$ rake jetty:stop
+$ rake jetty:clean
+$ rake triannon:solr_jetty_startup
+$ rake jetty:start
+```
+
+and check for Solr and Fedora again.
+
+#### Generate root annotations container
+After you ensure that Fedora4 is running:
+
 ```console
 $ cd spec/internal
 $ rake triannon:create_root_container
 $ cd ../..
 ```
 
-##### Configure spec/internal/config/triannon.yml as specified above
+#### Configure spec/internal/config/triannon.yml as specified above
 You might not need to change the file.
 ```console
 $ vi spec/internal/config/triannon.yml
 ```
 
 
-# Run the test app
+## Run the testing Rails application
 ```console
-$ rake jetty:start
+$ rake jetty:start  # if it isn't still running
 $ rake triannon:server
-$ rake jetty:stop # at some point
+$ <cntl + C> # to stop Rails application
+$ rake jetty:stop # to stop Fedora and Solr
+```
+
+The app will be running at localhost:3000
+
+# Running the Tests
+
+Run tests:
+
+```console
+$ rake spec
 ```
+

data/Rakefile

@@ -101,15 +101,4 @@ namespace :doc do
     rm_r 'rdoc' if File.exists?('rdoc')
   end
 end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Triannon'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 Bundler::GemHelper.install_tasks

data/lib/triannon/version.rb

@@ -1,3 +1,3 @@
 module Triannon
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: triannon
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chris Beer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails