blacklight_allmaps 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68d2d44ebaeae3f57846f37606e6a576e06a50d452e629cc715fbaf68a307f59
-  data.tar.gz: 61c1cb052866a522abe1e743da1e15d483e86ee96550f7081bacdb491f69c83c
+  metadata.gz: 1b77dce03fda3d3aab9db13861e8e1fc6b0dc8e39db47dcf75a8dc8ee34a27f2
+  data.tar.gz: 83e85dc411bcacefcb92b0b9b12701e778c58116e6cefda56768de040f0d7c50
 SHA512:
-  metadata.gz: 62f5d6a8a91d32fe95b3f205e31eb1a9d92776239aae871d8984feb65660b8bd4e6ba9133fde12bd49a1cee547eae5bef894e013aa54672853cef08be3a9278b
-  data.tar.gz: 49efe24708e9ca9e04308a591e82e7e48baf85b4c4ef5fc4b2e650ce53024e5ad86ff8510a90fb1dd86d7a0a2602b9f68a82cec9854afb0470d6b7b0dc86be51
+  metadata.gz: b182818f63f0e5a5fca137c8e7fbb8373a8e7955ffb93650a9fb0ccae01fbe2daaecedf29967c73bb5617c86cd92672653c67291bb3fe8244e0459180d4f205a
+  data.tar.gz: c9419afe74db352bdf7160b3900a856914b73f2171f9f13b0425dbe8087feb8b6142ccf78f000ec8dc4f545ce8064b938dec9452ee72a4417e37fd4ae0899b7b

data/README.md

@@ -1,6 +1,7 @@
 # Blacklight::Allmaps
 
 ![CI](https://github.com/bplmaps/blacklight-allmaps/actions/workflows/ci.yml/badge.svg) 
+[![Gem Version](https://img.shields.io/gem/v/blacklight_allmaps.svg)](https://github.com/bplmaps/blacklight-allmaps/releases)
 
 <img alt="Allmaps Logo" src="app/assets/images/blacklight/allmaps/allmaps-logo.svg" height="40px"/> <img alt="Blacklight Logo" src="app/assets/images/blacklight/allmaps/blacklight-logo.png" height="40px"/> <img alt="GeoBlacklight Logo" src="app/assets/images/blacklight/allmaps/geoblacklight-logo.png" height="40px"/>
 
@@ -11,7 +12,7 @@ A [Blacklight](https://projectblacklight.org/) / [GeoBlacklight](https://geoblac
 ## Dependencies
 
 * Blacklight v7 (v8 forthcoming)
-* GeoBlacklight v4.1 (v4.2+ forthcoming)
+* GeoBlacklight v4.4+
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -35,6 +36,27 @@ LIGHT=blacklight bundle exec rails generate blacklight:allmaps:install
 LIGHT=geoblacklight bundle exec rails generate blacklight:allmaps:install
 ```
 
+## CatalogController Configuration
+
+Configure options for local use are set into the `catalog_controller.rb` file. 
+
+### Blacklight
+
+```ruby
+    # Blacklight::Allmaps Viewer
+    config.show.partials.insert(1, :blacklight_allmaps)
+    config.default_solr_unique_key = "id"
+    config.default_georeferenced_field = "bl_georeferenced_bsi"
+    config.default_iiif_manifest_field = "iiif_manifest_url_ssi"
+```
+
+### GeoBlacklight
+```ruby
+    # Blacklight::Allmaps Viewer
+    config.default_solr_unique_key = "id"
+    config.default_georeferenced_field = "gbl_georeferenced_b"
+```
+
 ## Rake Tasks
 
 ### Seed Fixtures
@@ -60,6 +82,13 @@ The rake task here kicks off a background harvest process that walks through you
 rake blacklight_allmaps:sidecars:harvest:allmaps
 ```
 
+Alternatively, you can harvest Allmaps data for a list of identifers
+
+```bash
+# For Blacklight or GeoBlacklight
+rake "blacklight_allmaps:sidecars:harvest_ids[id1 id2 ...]"
+```
+
 ### Populate the Georeferenced Facet
 
 We expose the georeferenced items in the Blacklight user interface via a Georeferenced facet:
@@ -67,11 +96,8 @@ We expose the georeferenced items in the Blacklight user interface via a Georefe
 ![Screen shot](doc/georeferenced_facet.png)
 
 ```bash
-# For Blacklight...
-LIGHT=blacklight rake blacklight_allmaps:index:bl_georeferenced_facet
-
-# For GeoBlacklight...
-LIGHT=geoblacklight rake blacklight_allmaps:index:gbl_georeferenced_facet
+# For Blacklight or GeoBlacklight
+rake blacklight_allmaps:index:georeferenced_facet
 ```
 
 ## ActiveRecord Objects — Blacklight::Allmaps::Sidecar 
@@ -80,7 +106,8 @@ Blacklight::Allmaps adopts the SolrDocumentSidecar "sidecar" pattern from [Spotl
 
 We use this `document.sidecar_allmaps` object to hold the results of the Allmaps Annotation harvest task.
 
-The Blacklight::Allmaps::Sidecar object contains:
+The `Blacklight::Allmaps::Sidecar` object contains:
+
 | Field | Value |
 | --- | --- |
 | id | primary key |
@@ -114,6 +141,21 @@ document.sidecar_allmaps =>
  updated_at: Tue, 26 Mar 2024 16:39:42.427682000 UTC +00:00>
 ```
 
+## Allmaps::AnnotationsController
+
+We've added an annotations controller to the application to expose the `Blacklight::Allmaps::Sidecar` data we've harvested. This controller returns only JSON. 
+
+The `#fetch` method will query Allmaps in real time for updated annotation data, should a nightly harvest (rake) be insufficient for Solr indexing or local development needs.
+
+```
+Routes for Blacklight::Allmaps::Engine:
+fetch_allmaps_annotation GET   /allmaps/annotations/:id/fetch(.:format) allmaps/annotations#fetch {:format=>:json}
+     allmaps_annotations GET   /allmaps/annotations(.:format)           allmaps/annotations#index {:format=>:json}
+      allmaps_annotation GET   /allmaps/annotations/:id(.:format)       allmaps/annotations#show {:format=>:json}
+                         PATCH /allmaps/annotations/:id(.:format)       allmaps/annotations#update {:format=>:json}
+                         PUT   /allmaps/annotations/:id(.:format)       allmaps/annotations#update {:format=>:json}
+```
+
 ## Contributing
 
 For Developer documentation see [doc/developer.md](./doc/development.md)

data/Rakefile

@@ -1,12 +1,16 @@
+require "rails"
 require "rake"
 require "bundler"
+
 Bundler::GemHelper.install_tasks
 
+require "bundler/setup"
 require "bundler/gem_tasks"
 
 require "rspec/core/rake_task"
 require "engine_cart/rake_task"
 require "solr_wrapper"
+require "solr_wrapper/rake_task"
 require "blacklight/allmaps/rake_task"
 
 task default: :ci