blacklight_allmaps 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6dd1b81643cf47fb27e96e46ebd57783c7a276f0c62d4a955358eddaccaa2ba
-  data.tar.gz: 55425ab5cabddc7f09b8da4bf81a421c5fbbc57e9b5e5925a874750a285cb9e0
+  metadata.gz: 1b77dce03fda3d3aab9db13861e8e1fc6b0dc8e39db47dcf75a8dc8ee34a27f2
+  data.tar.gz: 83e85dc411bcacefcb92b0b9b12701e778c58116e6cefda56768de040f0d7c50
 SHA512:
-  metadata.gz: cb4bf70dcd2491554327acaae79c8fd8fa0ff0eff8fa4a32728f602090072a5ca59c961003db9f9847f4cdbac61c22cab8dfd7358f223b62b7209da72e32631b
-  data.tar.gz: 1fbab7b1404ff1ddb861df8163c2ac17e5f5105bad2e5947170032f0002363e5576656d39459504c584317e8df169e5e382a8efc47e3814dc3ffccc4987e53b3
+  metadata.gz: b182818f63f0e5a5fca137c8e7fbb8373a8e7955ffb93650a9fb0ccae01fbe2daaecedf29967c73bb5617c86cd92672653c67291bb3fe8244e0459180d4f205a
+  data.tar.gz: c9419afe74db352bdf7160b3900a856914b73f2171f9f13b0425dbe8087feb8b6142ccf78f000ec8dc4f545ce8064b938dec9452ee72a4417e37fd4ae0899b7b

data/README.md

@@ -36,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
@@ -61,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:
@@ -68,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 
@@ -81,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 |
@@ -115,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

data/app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.esm.js

@@ -26771,6 +26771,47 @@ function initializeBlacklightMap() {
 }
 // app/javascript/blacklight/allmaps/initialize_blacklight_map.js
 
+// update_georef_links.js
+const updateGeorefLinks = async () => {
+  const sidebarElement = document.getElementById('allmaps-sidebar');
+  if (sidebarElement) {
+    const manifestUrl = sidebarElement.getAttribute('data-iiif-manifest');
+    const documentId = sidebarElement.getAttribute('data-document-id');
+    const georefDiv = document.getElementById('georeferencing');
+    const annotationUrlByIIIFUri = `https://annotations.allmaps.org/?url=${manifestUrl}`;
+
+    try {
+      const response = await fetch(annotationUrlByIIIFUri);
+      if (!response.ok) {
+        georefDiv.innerHTML = `<a href="https://editor.allmaps.org/#/collection?url=${manifestUrl}" target="_blank">Georeference this item</a>`;
+
+        const csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute("content");
+        fetch(`/allmaps/annotations/${documentId}`, {
+          method: "PUT",
+          headers: {
+            "X-CSRF-Token": csrfToken,
+            "Content-Type": "application/json",
+            "Accept": "application/json"
+          }
+        })
+        .then(response => response.json())
+        .then(data => console.log(data))
+        .catch(error => console.error(error));
+
+      } else {
+        const annotationUrl = response.url;
+        georefDiv.innerHTML = `<a href="https://viewer.allmaps.org/?url=${annotationUrl}" target="_blank">View this georeferenced item</a>`;
+      }
+    } catch (error) {
+      console.error("Fetch error:", error);
+    }
+  }
+};
+
 initializeGeoBlacklightMap();
 initializeBlacklightMap();
+
+document.addEventListener('DOMContentLoaded', () => {
+  updateGeorefLinks();
+});
 //# sourceMappingURL=blacklight-allmaps.esm.js.map