blacklight_allmaps 0.2.0 → 0.4.0

data/app/assets/stylesheets/blacklight/allmaps/base.scss

@@ -1,9 +1,12 @@
 @charset "UTF-8";
 
 // Blacklight::Allmaps
+// Via NPM
 @import "leaflet";
 @import "leaflet.fullscreen";
-@import "leaflet.opacity";
+
+// Via 
+@import "modules/leaflet.opacity";
 
 #blacklight-allmaps-map { height: 400px; }
 #geoblacklight-allmaps-map { height: 400px; }

data/app/assets/stylesheets/blacklight/allmaps/modules/leaflet.opacity.css

@@ -0,0 +1,76 @@
+.leaflet-control.opacity-control {
+  background-color: #a9acb1;
+  border-radius: 15px;
+  color: black;
+  font: bold 18px 'Lucida Console', Monaco, monospace;
+  display: block;
+  height: 200px;
+  left: 11px;
+  position: relative;
+  top: 15px;
+  width: 5px;
+}
+.leaflet-control.opacity-control .opacity-handle {
+  background-color: #fff;
+  border-radius: 4px;
+  border: 1px solid #eee;
+  cursor: ns-resize;
+  font-size: 10px;
+  height: 26px;
+  left: -11px;
+  line-height: 26px;
+  position: absolute;
+  text-align: center;
+  top: 0;
+  width: 26px;
+}
+.leaflet-control.opacity-control .opacity-handle:hover {
+  background-color: #f4f4f4;
+}
+.leaflet-control.opacity-control .opacity-arrow-up {
+  color: #aaa;
+  position: absolute;
+  top: -11px;
+  text-align: center;
+  width: 100%;
+}
+.leaflet-control.opacity-control .opacity-arrow-up:before {
+  content: '=';
+}
+.leaflet-control.opacity-control .opacity-arrow-down {
+  bottom: -10px;
+  color: #aaa;
+  position: absolute;
+  text-align: center;
+  width: 100%;
+}
+.leaflet-control.opacity-control .opacity-arrow-down:before {
+  content: '=';
+}
+.leaflet-control.opacity-control .opacity-bottom {
+  background-color: #017afd;
+  border-radius: 15px;
+  display: block;
+  height: 137px;
+  left: 0px;
+  position: relative;
+  top: 63px;
+  width: 5px;
+}
+.leaflet-control.opacity-control .opacity-area {
+  padding: 14px;
+  cursor: default;
+  height: 200px;
+  left: -11px;
+  position: absolute;
+  top: 0px;
+  width: 20px;
+}
+.opacity-control.unselectable {
+  -webkit-touch-callout: none;
+  -webkit-user-select: none;
+  -khtml-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+}

data/app/controllers/allmaps/annotations_controller.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Allmaps
+  class AnnotationsController < ApplicationController
+    # JSON Only
+    respond_to :json
+
+    # Set @annotation before show and update
+    before_action :set_annotation, only: %i[show update]
+
+    # GET /allmaps/annotations.json
+    def index
+      @annotations = Blacklight::Allmaps::Sidecar.order(:id).page params[:page]
+
+      respond_to do |format|
+        format.all { render json: @annotations }
+      end
+    end
+
+    # GET /allmaps/annotations/1.json
+    def show
+      respond_to do |format|
+        format.all { render json: @annotation }
+      end
+    end
+
+    # PATCH/PUT /allmaps/annotations/1.json
+    def update
+      # Background Job to store the Allmaps Annotation
+      Blacklight::Allmaps::StoreSidecarAnnotation.perform_later(@annotation.solr_document_id)
+
+      respond_to do |format|
+        format.json { render json: @annotation, status: :ok }
+      end
+    end
+
+    # GET /annotations/fetch/1.json
+    def fetch
+      # Background Job to store the Allmaps Annotation — Perform Now
+
+      Blacklight::Allmaps::StoreSidecarAnnotation.perform_now(params[:id])
+      set_annotation
+
+      respond_to do |format|
+        format.all { render json: @annotation }
+      end
+    rescue Blacklight::Exceptions::RecordNotFound
+      render json: {error: "Record not found"}, status: :not_found
+    end
+
+    private
+
+    # Find the annotation or throw a 404
+    def set_annotation
+      @annotation = Blacklight::Allmaps::Sidecar.where(solr_document_id: params[:id]).first!
+    rescue ActiveRecord::RecordNotFound
+      render json: {error: "Record not found"}, status: :not_found
+    end
+
+    # Only allow a list of trusted parameters through.
+    def annotation_params
+      params.require(:Blacklight::Allmaps::Sidecar).permit(:id, :solr_document_id)
+    end
+  end
+end

data/app/helpers/blacklight/allmaps/application_helper.rb

@@ -10,7 +10,7 @@ module Blacklight
         document.iiif_manifest_url ? true : false
       rescue
         # Blacklight
-        document["iiif_manifest_url_ssi"] ? true : false
+        document[CatalogController.blacklight_config.default_iiif_manifest_field] ? true : false
       end
     end
   end

data/app/javascript/blacklight/allmaps/index.js

@@ -9,3 +9,9 @@ initializeGeoBlacklightMap();
 
 import { initializeBlacklightMap } from "./initialize_blacklight_map";
 initializeBlacklightMap();
+
+import { updateGeorefLinks } from './update_georef_links.js';
+
+document.addEventListener('DOMContentLoaded', () => {
+  updateGeorefLinks();
+});

data/app/javascript/blacklight/allmaps/update_georef_links.js

@@ -0,0 +1,36 @@
+// update_georef_links.js
+export 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);
+    }
+  }
+};

data/app/jobs/blacklight/allmaps/store_sidecar_annotation.rb

@@ -10,12 +10,18 @@ module Blacklight
         sidecar = solr_document.sidecar_allmaps
 
         if ApplicationController.helpers.georeferenceable?(solr_document)
+          # Sleep for a random amount of time to crawl politely
+          sleep(rand(1..5))
+
           # Store the IIIF Manifest
           response = HTTParty.get(solr_document.iiif_manifest_url, follow_redirects: true)
           if response.code == 200
             # @TODO: validate the response body is a valid IIIF Manifest
             sidecar.iiif_manifest = response.body
-            sidecar.manifest_id = JSON.parse(sidecar.iiif_manifest)["@id"]
+
+            # Store the Manifest ID
+            # - Could be either "@id" or "id"
+            sidecar.manifest_id = JSON.parse(sidecar.iiif_manifest)["@id"] || JSON.parse(sidecar.iiif_manifest)["id"]
           end
 
           # Store the Allmaps Annotation

data/app/models/concerns/blacklight/allmaps/solr_document.rb

@@ -5,9 +5,8 @@ module Blacklight
   module Allmaps
     module SolrDocument
       # Blacklight
-      # @TODO: Make this configurable
       def iiif_manifest_url
-        self["iiif_manifest_url_ssi"]
+        self[CatalogController.blacklight_config.default_iiif_manifest_field]
       end
     end
   end

data/app/views/allmaps/show/_blacklight.html.erb

@@ -1,3 +1,3 @@
 <!-- Georeferenced Map -->
-<h3 class="h6">Georeferenced Map</h3>
+<h3 class="h6"><%= t('allmaps.map_heading') %></h3>
 <div id="blacklight-allmaps-map" data-allmaps-id="<%= document.sidecar_allmaps.allmaps_id %>" class="mt-3 mb-3"></div>

data/app/views/allmaps/show/_geoblacklight.html.erb

@@ -1,3 +1,3 @@
 <!-- Georeferenced Map -->
-<h3 class="h6">Georeferenced Map</h3>
+<h3 class="h6"><%= t('allmaps.map_heading') %></h3>
 <div id="geoblacklight-allmaps-map" data-map-geom="<%= document.geometry.geojson %>" data-allmaps-id="<%= document.sidecar_allmaps.allmaps_id %>"></div>

data/app/views/allmaps/sidebar/_allmaps.html.erb

@@ -1,4 +1,4 @@
-<div class="card mb-3 mt-3" id="allmaps-sidebar" data-iiif-manifest="<%=@document.iiif_manifest_url %>">
+<div class="card mb-3 mt-3" id="allmaps-sidebar" data-document-id="<%= @document.id %>" data-iiif-manifest="<%= @document.iiif_manifest_url %>">
   <div class="card-header">
     <h2 class="mb-0 h6"><%= t('home.georeferencing') %></h2>
   </div>
@@ -6,12 +6,12 @@
   <div class="card-body" id="georeferencing">
     <% if @document.sidecar_allmaps.georeferenced? %>
       <div id="georef_present">
-        <%= link_to 'View this georeferenced item', 'https://viewer.allmaps.org/?url=https://annotations.allmaps.org/?url=' + @document.iiif_manifest_url, target: '_blank' %>
+        <%= link_to t('allmaps.georeferenced_link'), 'https://viewer.allmaps.org/?url=https://annotations.allmaps.org/?url=' + @document.iiif_manifest_url, target: '_blank' %>
       </div>
     <% else %>    
       <%# content will be updated via updateGeorefLinks(); %>
       <div id="georef_loading">
-        Loading...
+        <%= t('allmaps.loading') %>
       </div>
     <% end %>
   </div>
@@ -24,32 +24,4 @@
       </a>
     </small>
   </div>
-</div>
-
-<script type="text/javascript">
-  document.addEventListener('DOMContentLoaded', () => {
-    const updateGeorefLinks = async () => {
-      const manifestUrl = document.getElementById('allmaps-sidebar').getAttribute('data-iiif-manifest');
-      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}">Georeference this item</a>`;
-        } else {
-          const annotationUrl = response.url;
-          georefDiv.innerHTML = `<a href="https://viewer.allmaps.org/?url=${annotationUrl}">View this georeferenced item</a>`;
-          
-          // TODO: Ping Blacklight::Allmaps::AnnotationsController to save the annotation data
-          
-
-        }
-      } catch (error) {
-        console.error("Fetch error:", error);
-      }
-    };
-
-    updateGeorefLinks();
-  });
-</script>
+</div>

data/app/views/annotations/_annotation.json.jbuilder

@@ -0,0 +1 @@
+json.extract! annotation, :id, :solr_document_id, :document_type, :manifest_id, :annotated, :allmaps_id, :iiif_manifest, :allmaps_annotation, :solr_version, :created_at, :updated_at

data/app/views/annotations/_pagination.json.jbuilder

@@ -0,0 +1,9 @@
+json.pagination do
+  current, total, per_page = collection.current_page, collection.total_pages, collection.limit_value
+  json.current current
+  json.previous((current > 1) ? (current - 1) : nil)
+  json.next((current == total) ? nil : (current + 1))
+  json.per_page per_page
+  json.pages total
+  json.count collection.total_count
+end

data/app/views/annotations/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.partial! "pagination", collection: @annotations
+json.data do
+  json.array! @annotations, partial: "annotations/annotation", as: :annotation
+end

data/app/views/annotations/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "annotations/annotation", annotation: @annotation

data/app/views/catalog/_show_allmaps_tabbed_viewer_container.html.erb

@@ -2,15 +2,15 @@
 <div class='row'>
   <div id='viewer-container' class="col-md-12">
 
-    <span class="sr-only">Georeferenced: <%= document.sidecar_allmaps.georeferenced? %></span>
+    <span class="sr-only"><%= t('allmaps.georeferenced')%>: <%= document.sidecar_allmaps.georeferenced? %></span>
 
     <ul class="nav nav-tabs mt-3" id="myTab" role="tablist">
       <li class="nav-item" role="presentation">
-        <button class="nav-link active" id="item-viewer" data-toggle="tab" data-target="#item-viewer-tab" type="button" role="tab" aria-controls="home" aria-selected="true">Item Viewer</button>
+        <button class="nav-link active" id="item-viewer" data-toggle="tab" data-target="#item-viewer-tab" type="button" role="tab" aria-controls="home" aria-selected="true"><%= t('allmaps.item_viewer')%></button>
       </li>
       <% if document.sidecar_allmaps.georeferenced? %>
         <li class="nav-item" role="presentation">
-          <button class="nav-link" id="georeferenced-viewer" data-toggle="tab" data-target="#georeferenced-tab" type="button" role="tab" aria-controls="profile" aria-selected="false">Georeferenced Map</button>
+          <button class="nav-link" id="georeferenced-viewer" data-toggle="tab" data-target="#georeferenced-tab" type="button" role="tab" aria-controls="profile" aria-selected="false"><%= t('allmaps.map_heading')%></button>
         </li>
       <% end %>
     </ul>

data/blacklight_allmaps.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "blacklight/allmaps/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "blacklight_allmaps"
+  spec.version = Blacklight::Allmaps::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Eric Larson"]
+  spec.email = ["ewlarson@gmail.com"]
+  spec.homepage = "https://github.com/bplmaps/blacklight-allmaps"
+  spec.summary = "Blacklight::Allmaps plugin"
+  spec.description = "Description of Blacklight::Allmaps"
+  spec.license = "Apache 2.0"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.add_dependency "blacklight", ">= 7.25.2", "< 9"
+  spec.add_dependency "httparty", "~> 0.20"
+
+  spec.add_development_dependency "solr_wrapper"
+  spec.add_development_dependency "rails-controller-testing"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "engine_cart", "~> 2.1"
+  spec.add_development_dependency "factory_bot_rails"
+  spec.add_development_dependency "capybara", "~> 3"
+  spec.add_development_dependency "webdrivers"
+  spec.add_development_dependency "standard", "~> 1.34"
+  spec.add_development_dependency "sqlite3"
+end

data/config/locales/allmaps.en.yml

@@ -0,0 +1,11 @@
+en:
+  allmaps:
+    bl_facet_label: 'Allmaps Georeferenced'
+    item_viewer: 'Item Viewer'
+    gbl_tab_label: 'Georeferenced Map'
+    georeference_link: 'Georeference this item'
+    georeferenced: 'Georeferenced'
+    georeferenced_link: 'View this georeferenced item'
+    loading: 'Loading...'
+    map_heading: 'Georeferenced Map'
+    

data/config/routes.rb

@@ -1,2 +1,9 @@
 Blacklight::Allmaps::Engine.routes.draw do
+  namespace :allmaps do
+    resources :annotations, only: [:index, :show, :update], defaults: {format: :json} do
+      member do
+        get "fetch"
+      end
+    end
+  end
 end

data/doc/development.md

@@ -0,0 +1,72 @@
+# Development Notes
+
+## Running the Application
+
+### Blacklight / MARC
+
+IIIF Manifest URI is likely in 856 4#$u
+https://www.loc.gov/marc/bibliographic/bd856.html
+
+Solr Field: iiif_manifest_url_ssi (from Spotlight fixtures)
+Georeferenced Field: georeferenced_bsi (Blacklight dynamicField Schema)
+
+@TODO: Use mods_xml_ssm instead of marc_ss?
+
+#### TERMINAL 1 / Run Solr
+
+```
+bundle exec rake engine_cart:clean
+LIGHT=blacklight bundle exec rake blacklight_allmaps:solr
+```
+
+#### TERMINAL 2 / Index
+```
+cd .internal_test_app
+rake blacklight_allmaps:index:bl_fixtures
+rake blacklight_allmaps:sidecars:harvest:allmaps
+rake blacklight_allmaps:index:georeferenced_facet
+rails s
+```
+
+### GeoBlacklight / Aardvark Schema
+
+IIIF Manifest URI is in dct_references_s
+https://opengeometadata.org/ogm-aardvark/#references
+Key: http://iiif.io/api/presentation#manifest
+
+Solr Field: dct_references_s
+Georeferenced Field: gbl_georeferenced_b (Aardvark Schema)
+
+#### TERMINAL 1 / Run Solr
+```
+bundle exec rake engine_cart:clean
+LIGHT=geoblacklight bundle exec rake blacklight_allmaps:solr
+```
+
+#### TERMINAL 2 / Index, Harvest, Facet
+```
+cd .internal_test_app
+rake blacklight_allmaps:index:gbl_fixtures
+rake blacklight_allmaps:sidecars:harvest:allmaps
+rake blacklight_allmaps:index:georeferenced_facet
+rails s
+```
+
+## Building the Javascript / Publishing the NPM Package
+
+The javascript is built by npm from sources in `app/javascript` into a bundle
+in `app/assets/javascripts/blacklight/allmaps/blacklight-allmaps.js`. This file should not be edited by hand as any changes would be overwritten.  When any of the javascript
+components in the gem are changed, this bundle should be rebuild with the
+following steps:
+1. [Install npm](https://www.npmjs.com/get-npm)
+1. run `npm install` to download dependencies
+1. run `npm run prepare` to build the bundle
+1. run `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-allmaps
+
+## Running the Test suite
+
+```LIGHT=blacklight bundle exec rake ci```
+
+or 
+
+```LIGHT=geoblacklight bundle exec rake ci```

data/lib/blacklight/allmaps/tasks/index.rake

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "blacklight"
+require "blacklight/allmaps/version"
 
 namespace :blacklight_allmaps do
   namespace :index do
@@ -19,12 +20,12 @@ namespace :blacklight_allmaps do
     end
 
     desc "Index - add Allmaps facet data to GeoBlacklight solr"
-    task gbl_georeferenced_facet: [:environment] do
+    task georeferenced_facet: [:environment] do
       # Steps
       # 1. Use cursor to paginate all documents in Solr
       # 2. Determine which documents have georeferenced data
       # 3. Clean JSON for re-indexing
-      # 4. Add gbl_georeferenced_b values
+      # 4. Add georeferenced values
       # 5. Re-index the georeferenced documents
 
       # 1. Get all the documents from Solr
@@ -36,13 +37,13 @@ namespace :blacklight_allmaps do
             fl: "*",  # all fields
             cursorMark: cursor_mark, # use the cursor mark to handle paging
             rows: 1000,
-            sort: "id asc" # must sort by id to use the cursor mark
+            sort: "#{CatalogController.blacklight_config.default_solr_unique_key} asc" # must sort by id to use the cursor mark
           }
         )
 
         response["response"]["docs"].each do |doc|
           # 2. Determine which documents have georeferenced data
-          solr_document = SolrDocument.find(doc["id"])
+          solr_document = SolrDocument.find(doc[CatalogController.blacklight_config.default_solr_unique_key])
           if solr_document.sidecar_allmaps.present? && solr_document.sidecar_allmaps.annotated?
 
             # 3. Clean JSON for re-indexing
@@ -58,59 +59,8 @@ namespace :blacklight_allmaps do
 
             cleaned_doc = doc.except!(*keys_for_deletion)
 
-            # 4. Add gbl_georeferenced_b value
-            # @TODO: add allmaps_id?
-            cleaned_doc["gbl_georeferenced_b"] = true
-
-            # 5. Re-index the georeferenced documents
-            Blacklight.default_index.connection.add cleaned_doc
-          end
-        end
-
-        break if response["nextCursorMark"] == cursor_mark # this means the result set is finished
-        cursor_mark = response["nextCursorMark"]
-      end
-      Blacklight.default_index.connection.commit
-    end
-
-    desc "Index - add Allmaps facet data to Blacklight solr"
-    task bl_georeferenced_facet: [:environment] do
-      # Steps
-      # 1. Use cursor to paginate all documents in Solr
-      # 2. Determine which documents have georeferenced data
-      # 3. Clean JSON for re-indexing
-      # 4. Add bl_georeferenced_bsi values
-      # 5. Re-index the georeferenced documents
-
-      # 1. Get all the documents from Solr
-      cursor_mark = "*"
-      loop do
-        response = Blacklight.default_index.connection.get(
-          "select", params: {
-            q: "*:*", # all docs
-            fl: "*",  # all fields
-            cursorMark: cursor_mark, # use the cursor mark to handle paging
-            rows: 1000,
-            sort: "id asc" # must sort by id to use the cursor mark
-          }
-        )
-
-        response["response"]["docs"].each do |doc|
-          # 2. Determine which documents have georeferenced data
-          solr_document = SolrDocument.find(doc["id"])
-          if solr_document.sidecar_allmaps.present? && solr_document.sidecar_allmaps.annotated?
-
-            # 3. Clean JSON for re-indexing
-            keys_for_deletion = %w[
-              _version_
-              timestamp
-            ]
-
-            cleaned_doc = doc.except!(*keys_for_deletion)
-
-            # 4. Add gbl_georeferenced_b value
-            # @TODO: add allmaps_id?
-            cleaned_doc["bl_georeferenced_bsi"] = true
+            # 4. Add georeferenced value
+            cleaned_doc[CatalogController.blacklight_config.default_georeferenced_field] = true
 
             # 5. Re-index the georeferenced documents
             Blacklight.default_index.connection.add cleaned_doc

data/lib/blacklight/allmaps/tasks/sidecars.rake

@@ -46,5 +46,14 @@ namespace :blacklight_allmaps do
         puts "orphaned / #{sc.document_id} / destroyed"
       end
     end
+
+    desc "Sidecars - Harvest list of document ids"
+    task :harvest_ids, [:ids] => :environment do |t, args|
+      docs = args[:ids].split(" ")
+      docs.each do |doc|
+        puts "Harvesting Allmaps data for #{doc}"
+        Blacklight::Allmaps::StoreSidecarAnnotation.perform_later(doc)
+      end
+    end
   end
 end

data/lib/blacklight/allmaps/version.rb

@@ -1,6 +1,6 @@
 module Blacklight
   module Allmaps
-    VERSION = "0.2.0"
+    VERSION = "0.4.0"
 
     def self.version
       @version ||= VERSION

data/lib/blacklight/allmaps.rb

@@ -1,8 +1,16 @@
 require "blacklight"
+require "blacklight/allmaps/version"
+require "blacklight/allmaps/engine"
 
 module Blacklight
   module Allmaps
-    require "blacklight/allmaps/engine"
-    require "blacklight/allmaps/version"
+    def self.version
+      @version ||= VERSION
+    end
+
+    # returns the full path the the plugin installation
+    def self.root
+      @root ||= __dir__
+    end
   end
 end