geoblacklight_admin 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8589ee3941b3bd4731accf0443452335f51b8f3f52a823e5c26306a089ccda0
-  data.tar.gz: 8bf6d3d0a966b7ab815f79a89822f27549827f0a63dc00c8beae73048e1f8b8e
+  metadata.gz: 5514d1f3dfc7ba946eb58f955e9c3cfc76b073aeafcc86d0f62e3807bf013aba
+  data.tar.gz: 34c448fd3cb662cabf2f3f6cfd2f82b3b5166f681d7e4c0c3ef542ecad575893
 SHA512:
-  metadata.gz: d1208b0966517c76db7276b26c0c17e50a595c8a120fc14ae5fd7144d448e53b345feb9614db1e41076562644756e7487e75f1146d652b8753f9a156bb7ab5bb
-  data.tar.gz: 9cc8bc7a90157496e0d755f580ff1856317baaaa4bde49057388a97d5239aec1074523ecb3e8f40449381170245fcd9b70dd349d6751149077cda7483fe91d68
+  metadata.gz: 2dcfb661be04c25e22a1941471c06b1dabcf6ee14744fe2faf815172e32b2a00b06639a808fb35f5bb05fef8ef8b0ddde038c8a786b45d38f5aff3aa856c648a
+  data.tar.gz: 38a23540721636da43ee97a2068f10ed127a85b380ecb6d84f1c1ee0045848295b100d781f48762b0204d738530cccdfbd3578ef1927ff87bbe8f6c55349c61a

data/README.md

@@ -77,6 +77,7 @@ bundle exec rails server
 ### Lint App
 ```bash
 standardrb .
+standardrb --fix
 ```
 
 ### Test App

data/app/controllers/admin/document_downloads_controller.rb

@@ -82,7 +82,7 @@ module Admin
 
       respond_to do |format|
         if DocumentDownload.destroy_all(params.dig(:document_download, :downloads, :file))
-          format.html { redirect_to admin_document_downloads_path, notice: "Download Links were created destroyed." }
+          format.html { redirect_to admin_document_downloads_path, notice: "Download Links were destroyed." }
         else
           format.html { redirect_to admin_document_downloads_path, notice: "Download Links could not be destroyed." }
         end

data/app/controllers/admin/ids_controller.rb

@@ -141,6 +141,9 @@ module Admin
       # Publication State
       config.add_facet_field Settings.FIELDS.B1G_PUBLICATION_STATE, show: false
 
+      # Import ID
+      config.add_facet_field Settings.FIELDS.B1G_IMPORT_ID, label: "Import ID", show: false
+
       # Resouce Class
       config.add_facet_field Settings.FIELDS.RESOURCE_CLASS, show: false
 

data/app/controllers/admin/imports_controller.rb

@@ -14,8 +14,8 @@ module Admin
     # GET /imports/1
     # GET /imports/1.json
     def show
-      @pagy_failed, @import_failed_documents = pagy(@import.import_documents.not_in_state(:success), items: 100)
-      @pagy_success, @import_success_documents = pagy(@import.import_documents.in_state(:success), items: 100)
+      @pagy_failed, @import_failed_documents = pagy(@import.import_documents.not_in_state(:success), items: 50)
+      @pagy_success, @import_success_documents = pagy(@import.import_documents.in_state(:success), items: 50)
     end
 
     # GET /imports/new

data/app/helpers/geoblacklight_admin_helper.rb

@@ -115,4 +115,34 @@ module GeoblacklightAdminHelper
       ""
     end
   end
+
+  def link_to_admin_import(import)
+    path = admin_documents_path(
+      {
+        f: {b1g_geom_import_id_ssi: [import]}
+      }
+    )
+
+    link_to import.name, path
+  end
+
+  def link_to_gbl_import(label, import, state = false)
+    path = if state
+      blacklight_path(
+        {
+          f: {b1g_geom_import_id_ssi: [import]},
+          publication_state: state
+        }
+      )
+    else
+      blacklight_path(
+        {
+          f: {b1g_geom_import_id_ssi: [import]},
+          publication_state: "*"
+        }
+      )
+    end
+
+    link_to(label, path)
+  end
 end

data/app/jobs/bulk_action_collect_documents.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# BulkActionCollectDocuments class
+class BulkActionCollectDocuments < ApplicationJob
+  queue_as :priority
+
+  def perform(bulk_action_id)
+    bulk_action = BulkAction.find(bulk_action_id)
+    bulk_action.collect_documents
+  end
+end

data/app/jobs/geoblacklight_admin/store_image_job.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class StoreImageJob < ApplicationJob
+    queue_as :default
+
+    def perform(solr_document_id)
+      document = Document.find_by_friendlier_id(solr_document_id)
+      GeoblacklightAdmin::ImageService.new(document).store
+    end
+  end
+end

data/app/models/asset.rb

@@ -0,0 +1,13 @@
+class Asset < Kithe::Asset
+  include AttrJson::Record::QueryScopes
+
+  set_shrine_uploader(AssetUploader)
+
+  # AttrJSON
+  attr_json :thumbnail, :boolean, default: "false"
+  attr_json :derivative_storage_type, :string, default: "public"
+
+  DERIVATIVE_STORAGE_TYPE_LOCATIONS = {
+    "public" => :kithe_derivatives
+  }.freeze
+end

data/app/models/bulk_action.rb

@@ -6,7 +6,9 @@ require "cgi"
 # BulkAction
 class BulkAction < ApplicationRecord
   # Callbacks
-  after_create_commit :collect_documents
+  after_create do
+    BulkActionCollectDocuments.perform_later(id)
+  end
 
   # Associations
   has_many :documents, class_name: "BulkActionDocument", autosave: false, dependent: :destroy
@@ -38,9 +40,10 @@ class BulkAction < ApplicationRecord
   end
 
   def check_run_state
-    return if state_machine.current_state == "complete"
+    nil if state_machine.current_state == "complete"
 
-    state_machine.transition_to!(:complete) if documents.in_state(:queued).blank?
+    # @TODO / background job for collecting documents
+    # state_machine.transition_to!(:complete) if documents.in_state(:queued).blank?
   end
 
   def revert!
@@ -48,8 +51,6 @@ class BulkAction < ApplicationRecord
     BulkActionRevertJob.perform_later(self)
   end
 
-  private
-
   def collect_documents
     cgi = CGI.unescape(scope)
     uri = URI.parse(cgi)
@@ -60,6 +61,8 @@ class BulkAction < ApplicationRecord
     end
   end
 
+  private
+
   def fetch_documents(uri)
     qargs = Rack::Utils.parse_nested_query(uri.query)
     fetch_documents = Document.where(friendlier_id: qargs["ids"])

data/app/models/bulk_actions/change_publication_state.rb

@@ -0,0 +1,21 @@
+module BulkActions
+  # Subclass for ChangePublicationState
+  class ChangePublicationState < BulkAction
+    # Add specific methods and validations for ChangePublicationState here
+  end
+
+  # Subclass for PublishDocument
+  class PublishDocument < BulkAction
+    # Add specific methods and validations for PublishDocument here
+  end
+
+  # Subclass for UnpublishDocument
+  class UnpublishDocument < BulkAction
+    # Add specific methods and validations for UnpublishDocument here
+  end
+
+  # Subclass for DraftDocument
+  class DraftDocument < BulkAction
+    # Add specific methods and validations for DraftDocument here
+  end
+end

data/app/models/concerns/geoblacklight_admin/publication_state_search_behavior.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  module PublicationStateSearchBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.default_processor_chain += [:publication_state_records]
+    end
+
+    ##
+    # Show/Hide records by publication state in search
+    # Defaults to "published" items only
+    # publication_state: ['published', 'unpublished', 'draft']
+    # @param [Blacklight::Solr::Request]
+    # @return [Blacklight::Solr::Request]
+    def publication_state_records(solr_params)
+      solr_params[:fq] ||= []
+      solr_params[:fq] << if blacklight_params["publication_state"]
+        "b1g_publication_state_s:#{blacklight_params["publication_state"]}"
+      else
+        "b1g_publication_state_s:published"
+      end
+    end
+  end
+end

data/app/models/document/date_validator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Date Validation
+#
+# ex. Bad date field type value
+# "foo" is not a date
+# "2023-12-5" is a date
+class Document
+  # DateValidator
+  class DateValidator < ActiveModel::Validator
+    def validate(record)
+      # Assume true
+      valid_date = true
+
+      date_elements = Element.where(field_type: "date")
+
+      # Sane date values?
+      date_elements.each do |element|
+        unless record.send(element.solr_field).nil?
+          Rails.logger.debug("Date Validator")
+          Rails.logger.debug("Dates: #{record.send(element.solr_field).inspect}")
+          record.send(element.solr_field).each do |date|
+            Rails.logger.debug("\nDate: #{date}")
+            valid_date = proper_date(record, element, date, valid_date)
+
+            break if !valid_date
+          end
+        end
+      end
+
+      valid_date
+    end
+
+    def proper_date(record, element, date, valid_date)
+      if date.blank?
+        valid_date = true
+      elsif date.class != Date
+        valid_date = false
+        record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[element.to_sym], "Bad date field type.")
+      end
+
+      Rails.logger.debug("#{date} - #{valid_date}")
+      valid_date
+    end
+  end
+end

data/app/models/document.rb

@@ -5,6 +5,13 @@ class Document < Kithe::Work
   include AttrJson::Record::QueryScopes
   include ActiveModel::Validations
 
+  delegate :viewer_protocol, to: :item_viewer
+  delegate :viewer_endpoint, to: :item_viewer
+
+  def item_viewer
+    GeoblacklightAdmin::ItemViewer.new(references)
+  end
+
   attr_accessor :skip_callbacks
 
   has_paper_trail ignore: [:publication_state]
@@ -50,6 +57,7 @@ class Document < Kithe::Work
     references_json.include?("downloadUrl")
   end
 
+  validates_with Document::DateValidator
   validates_with Document::DateRangeValidator
   validates_with Document::BboxValidator
   validates_with Document::GeomValidator
@@ -68,12 +76,15 @@ class Document < Kithe::Work
   attr_json :dct_references_s, Document::Reference.to_type, array: true, default: -> { [] }
 
   # Index Transformations - *_json functions
-  def references_json
+  def references
     references = ActiveSupport::HashWithIndifferentAccess.new
     send(GeoblacklightAdmin::Schema.instance.solr_fields[:reference]).each do |ref|
       references[Document::Reference::REFERENCE_VALUES[ref.category.to_sym][:uri]] = ref.value
     end
-    references = apply_downloads(references)
+    apply_downloads(references)
+  end
+
+  def references_json
     references.to_json
   end
 
@@ -121,8 +132,109 @@ class Document < Kithe::Work
     value = prefix + format.to_s
     value.html_safe
   end
+
+  ##
+  # GBL SolrDocument convience methods
+  #
+  def available?
+    public? || same_institution?
+  end
+
+  def public?
+    rights_field_data.present? && rights_field_data.casecmp("public").zero?
+  end
+
+  def local_restricted?
+    local? && restricted?
+  end
+
+  def local?
+    local = send(Settings.FIELDS.PROVIDER) || ""
+    local.casecmp(Settings.INSTITUTION_LOCAL_NAME)&.zero?
+  end
+
+  def restricted?
+    rights_field_data.blank? || rights_field_data.casecmp("restricted").zero?
+  end
+
+  def rights_field_data
+    send(Settings.FIELDS.ACCESS_RIGHTS) || ""
+  end
+
+  def downloadable?
+    (direct_download || download_types.present? || iiif_download) && available?
+  end
+
+  def direct_download
+    references.download.to_hash if references.download.present?
+  end
+
+  def display_note
+    send(Settings.FIELDS.DISPLAY_NOTE) || ""
+  end
+
+  def hgl_download
+    references.hgl.to_hash if references.hgl.present?
+  end
+
+  def oembed
+    references.oembed.endpoint if references.oembed.present?
+  end
+
+  def same_institution?
+    institution = send(Settings.FIELDS.PROVIDER) || ""
+    institution.casecmp(Settings.INSTITUTION.downcase).zero?
+  end
+
+  def iiif_download
+    references.iiif.to_hash if references.iiif.present?
+  end
+
+  def data_dictionary_download
+    references.data_dictionary.to_hash if references.data_dictionary.present?
+  end
+
+  def external_url
+    references.url&.endpoint
+  end
+
+  def itemtype
+    "http://schema.org/Dataset"
+  end
+
+  def geom_field
+    send(Settings.FIELDS.GEOMETRY) || ""
+  end
+
+  def geometry
+    # @TODO
+    # @geometry ||= Geoblacklight::Geometry.new(geom_field)
+  end
+
+  def wxs_identifier
+    send(Settings.FIELDS.WXS_IDENTIFIER) || ""
+  end
+
+  def file_format
+    send(Settings.FIELDS.FORMAT) || ""
+  end
+
+  ##
+  # Provides a convenience method to access a SolrDocument's References
+  # endpoint url without having to check and see if it is available
+  # :type => a string which if its a Geoblacklight::Constants::URI key
+  #          will return a coresponding Geoblacklight::Reference
+  def checked_endpoint(type)
+    type = references.send(type)
+    type.endpoint if type.present?
+  end
+
   ### End / From GBL
 
+  def thumbnail
+    members.find { |m| m.respond_to?(:thumbnail) }
+  end
+
   def access_json
     access = {}
     access_urls.each { |au| access[au.institution_code] = au.access_url }

data/app/models/document_access.rb

@@ -15,8 +15,9 @@ class DocumentAccess < ApplicationRecord
     ::CSV.foreach(file.path, headers: true) do |row|
       logger.debug("CSV Row: #{row.to_hash}")
       document_access = DocumentAccess.find_or_initialize_by(friendlier_id: row[0], institution_code: row[1])
-      document_access.update(row.to_hash)
+      document_access.update!(row.to_hash)
     end
+    true
   end
 
   def self.destroy_all(file)
@@ -25,6 +26,7 @@ class DocumentAccess < ApplicationRecord
       logger.debug("CSV Row: #{row.to_hash}")
       DocumentAccess.destroy_by(id: row[0], friendlier_id: row[1])
     end
+    true
   end
 
   def to_csv

data/app/models/document_download.rb

@@ -15,8 +15,9 @@ class DocumentDownload < ApplicationRecord
     ::CSV.foreach(file.path, headers: true) do |row|
       logger.debug("CSV Row: #{row.to_hash}")
       document_download = DocumentDownload.find_or_initialize_by(friendlier_id: row[0], label: row[1], value: row[2])
-      document_download.update(row.to_hash)
+      document_download.update!(row.to_hash)
     end
+    true
   end
 
   def self.destroy_all(file)
@@ -25,6 +26,7 @@ class DocumentDownload < ApplicationRecord
       logger.debug("CSV Row: #{row.to_hash}")
       DocumentDownload.destroy_by(id: row[0], friendlier_id: row[1])
     end
+    true
   end
 
   def to_csv

data/app/models/element.rb

@@ -28,6 +28,7 @@ class Element < ApplicationRecord
     text
     integer
     boolean
+    date
     datetime
   ].freeze
 

data/app/services/geoblacklight_admin/image_service/dynamic_map_layer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class ImageService
+    module DynamicMapLayer
+      ##
+      # Formats and returns a thumbnail url from an ESRI Dynamic Map Layer endpoint.
+      # @param [SolrDocument]
+      # @return [String] image url
+      def self.image_url(document, _size)
+        "#{document.viewer_endpoint}/info/thumbnail/thumbnail.png"
+      end
+    end
+  end
+end

data/app/services/geoblacklight_admin/image_service/iiif.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class ImageService
+    module Iiif
+      ##
+      # Formats and returns a thumbnail url from an International Image
+      # Interoperability Framework endpoint.
+      # @param [SolrDocument]
+      # @param [Integer] thumbnail size
+      # @return [String] iiif thumbnail url
+      def self.image_url(document, size)
+        "#{document.viewer_endpoint.gsub("info.json", "")}full/#{size},/0/default.jpg"
+      end
+    end
+  end
+end

data/app/services/geoblacklight_admin/image_service/image_map_layer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class ImageService
+    module ImageMapLayer
+      ##
+      # Formats and returns a thumbnail url from an ESRI Image Map Layer endpoint.
+      # information about the layer.
+      # @param [SolrDocument]
+      # @param [Integer] thumbnail size
+      # @return [String] thumbnail url
+      def self.image_url(document, _size)
+        "#{document.viewer_endpoint}/info/thumbnail/thumbnail.png"
+      end
+    end
+  end
+end

data/app/services/geoblacklight_admin/image_service/tiled_map_layer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class ImageService
+    module TiledMapLayer
+      ##
+      # Formats and returns an image url from an ESRI Tiled Map Layer endpoint.
+      # @param [SolrDocument]
+      # @return [String] image url
+      def self.image_url(document, _size)
+        "#{document.viewer_endpoint}/info/thumbnail/thumbnail.png"
+      end
+    end
+  end
+end

data/app/services/geoblacklight_admin/image_service/wms.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GeoblacklightAdmin
+  class ImageService
+    module Wms
+      ##
+      # Formats and returns a thumbnail url from a Web Map Service endpoint.
+      # This utilizes the GeoServer specific 'reflect' service to generate
+      # parameters like bbox that are difficult to tweak without more detailed
+      # information about the layer.
+      # @param [SolrDocument]
+      # @param [Integer] thumbnail size
+      # @return [String] wms thumbnail url
+      def self.image_url(document, size)
+        # Swap proxy url with princeton geoserver url.
+        # Thumbnail requests send geoserver auth.
+        endpoint = document.viewer_endpoint.gsub(Settings.PROXY_GEOSERVER_URL,
+          Settings.INSTITUTION_GEOSERVER_URL)
+        "#{endpoint}/reflect?" \
+          "&FORMAT=image%2Fpng" \
+          "&TRANSPARENT=TRUE" \
+          "&LAYERS=#{document["gbl_wxsIdentifier_s"]}" \
+          "&WIDTH=#{size}" \
+          "&HEIGHT=#{size}"
+      end
+    end
+  end
+end