blacklight_allmaps 0.2.0 → 0.3.0

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

@@ -15,7 +15,10 @@ module Blacklight
           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/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/lib/blacklight/allmaps/tasks/index.rake

@@ -19,12 +19,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 +36,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 +58,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.3.0"
 
     def self.version
       @version ||= VERSION

data/lib/generators/blacklight/allmaps/blacklight_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Blacklight
+  module Allmaps
+    class BlacklightGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc <<-DESCRIPTION
+        This generator makes the following changes to your application:
+        1. Copies stylesheets to Blacklight app
+        2. Adds Blacklight::Allmaps configuration to CatalogController
+        3. Adds georeferenced facet to CatalogController
+        4. Includes Blacklight::Allmaps::SolrDocument in SolrDocument
+      DESCRIPTION
+
+      def add_bl_stylesheets
+        append_to_file "app/assets/stylesheets/blacklight.scss" do
+          "@import 'blacklight/allmaps/base';"
+        end
+      end
+
+      def add_configuration
+        inject_into_file "app/controllers/catalog_controller.rb", after: "#config.show.thumbnail_field = 'thumbnail_path_ss'" do
+          "\n
+    # 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\""
+        end
+      end
+
+      def add_bl_georeferenced_facet
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.add_facet_field 'subject_era_ssim', label: 'Era'" do
+          "\n    config.add_facet_field 'bl_georeferenced_bsi', label: I18n.t('allmaps.bl_facet_label')"
+        end
+      end
+
+      def include_blacklight_allmaps_solrdocument
+        inject_into_file "app/models/solr_document.rb", after: "include Blacklight::Solr::Document" do
+          "\n include Blacklight::Allmaps::SolrDocument"
+        end
+      end
+    end
+  end
+end

data/lib/generators/blacklight/allmaps/config_generator.rb

@@ -52,65 +52,13 @@ module Blacklight
         end
       end
 
-      def add_bl_stylesheets
-        return unless ENV["LIGHT"] == "blacklight"
-        append_to_file "app/assets/stylesheets/blacklight.scss" do
-          "@import 'blacklight/allmaps/base';"
-        end
-      end
-
-      def add_gbl_stylesheets
-        return unless ENV["LIGHT"] == "geoblacklight"
-        append_to_file "app/assets/stylesheets/application.scss" do
-          "@import 'blacklight/allmaps/base';"
-        end
+      def set_routes
+        inject_into_file "config/routes.rb", "mount Blacklight::Allmaps::Engine => '/'\n", before: /^end/
       end
 
       def set_active_job_config
         inject_into_file "config/environments/development.rb", "  config.active_job.queue_adapter = :inline\n", after: "Rails.application.configure do\n"
       end
-
-      def add_geoblacklight
-        return unless ENV["LIGHT"] == "geoblacklight"
-        append_to_file "Gemfile", '"geoblacklight", "~> 4.4"'
-      end
-
-      def include_blacklight_allmaps_solrdocument
-        return unless ENV["LIGHT"] == "blacklight"
-        inject_into_file "app/models/solr_document.rb", after: "include Blacklight::Solr::Document" do
-          "\n include Blacklight::Allmaps::SolrDocument"
-        end
-      end
-
-      def add_gbl_tabbed_viewer
-        return unless ENV["LIGHT"] == "geoblacklight"
-        # Use the tabbed viewer
-        inject_into_file "app/controllers/catalog_controller.rb", after: "config.show.partials << \"show_default_viewer_container\"" do
-          "\n
-    # Blacklight::Allmaps Tabbed Viewer
-    config.show.partials << \"show_allmaps_tabbed_viewer_container\""
-        end
-
-        # Remove the default viewer
-        gsub_file("app/controllers/catalog_controller.rb", "config.show.partials << \"show_default_viewer_container\"", "#config.show.partials << \"show_default_viewer_container\"")
-      end
-
-      def add_bl_allmaps_viewer
-        return unless ENV["LIGHT"] == "blacklight"
-        # Use the allmaps viewer
-        inject_into_file "app/controllers/catalog_controller.rb", after: "#config.show.thumbnail_field = 'thumbnail_path_ss'" do
-          "\n
-    # Blacklight::Allmaps Viewer
-    config.show.partials.insert(1, :blacklight_allmaps)"
-        end
-      end
-
-      def add_bl_georeferenced_facet
-        return unless ENV["LIGHT"] == "blacklight"
-        inject_into_file "app/controllers/catalog_controller.rb", after: "config.add_facet_field 'subject_era_ssim', label: 'Era'" do
-          "\n    config.add_facet_field 'bl_georeferenced_bsi', label: 'Allmaps Georeferenced'"
-        end
-      end
     end
   end
 end

data/lib/generators/blacklight/allmaps/geoblacklight_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Blacklight
+  module Allmaps
+    class GeoblacklightGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc <<-DESCRIPTION
+        This generator makes the following changes to your application:
+        1. Adds stylesheets to application.scss
+        2. Adds GeoBlacklight to Gemfile
+        3. Adds Blacklight::Allmaps configuration to CatalogController
+        4. Adds Blacklight::Allmaps Tabbed Viewer to CatalogController
+      DESCRIPTION
+
+      def add_gbl_stylesheets
+        append_to_file "app/assets/stylesheets/application.scss" do
+          "@import 'blacklight/allmaps/base';"
+        end
+      end
+
+      def add_geoblacklight
+        append_to_file "Gemfile", '"geoblacklight", "~> 4.4"'
+      end
+
+      def add_configuration
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.raw_endpoint.enabled = true" do
+          "\n
+    # Blacklight::Allmaps Viewer
+    config.default_solr_unique_key = \"id\"
+    config.default_georeferenced_field = \"gbl_georeferenced_b\""
+        end
+      end
+
+      def add_gbl_tabbed_viewer
+        # Use the tabbed viewer
+        inject_into_file "app/controllers/catalog_controller.rb", after: "config.show.partials << \"show_default_viewer_container\"" do
+          "\n
+    # Blacklight::Allmaps Tabbed Viewer
+    config.show.partials << \"show_allmaps_tabbed_viewer_container\""
+        end
+
+        # Remove the default viewer
+        gsub_file("app/controllers/catalog_controller.rb", "config.show.partials << \"show_default_viewer_container\"", "#config.show.partials << \"show_default_viewer_container\"")
+      end
+    end
+  end
+end

data/lib/generators/blacklight/allmaps/install_generator.rb

@@ -13,6 +13,16 @@ module Blacklight
         generate "blacklight:allmaps:config"
       end
 
+      def generate_blacklight_config
+        return unless ENV["LIGHT"] == "blacklight"
+        generate "blacklight:allmaps:blacklight"
+      end
+
+      def generate_geoblacklight_config
+        return unless ENV["LIGHT"] == "geoblacklight"
+        generate "blacklight:allmaps:geoblacklight"
+      end
+
       def generate_models
         generate "blacklight:allmaps:models"
       end