geoblacklight_admin 0.0.1

data/app/jobs/import_run_job.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# ImportRunJob class
+class ImportRunJob < ApplicationJob
+  queue_as :default
+
+  def perform(import)
+    data = CSV.parse(import.csv_file.download.force_encoding("UTF-8"), headers: true)
+
+    data.each do |doc|
+      extract_hash = doc.to_h
+
+      converted_data = import.convert_data(extract_hash)
+
+      kithe_document = {
+        title: converted_data[GeoblacklightAdmin::Schema.instance.solr_fields[:title]],
+        json_attributes: converted_data,
+        friendlier_id: converted_data[GeoblacklightAdmin::Schema.instance.solr_fields[:id]],
+        import_id: import.id
+      }
+
+      # Capture document for import attempt
+      import_document = ImportDocument.create(kithe_document)
+
+      # Add import document to background job queue
+      ImportDocumentJob.perform_later(import_document)
+    rescue => e
+      logger.debug "\n\nCANNOT IMPORT: #{extract_hash.inspect}"
+      logger.debug "Error: #{e.inspect}\n\n"
+      next
+    end
+  end
+end

data/app/models/active_storage_attachment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# ActiveStorageAttachment
+class ActiveStorageAttachment < ApplicationRecord
+end

data/app/models/active_storage_blob.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# ActiveStorageBlob
+class ActiveStorageBlob < ApplicationRecord
+end

data/app/models/api_search_builder.rb

@@ -0,0 +1,12 @@
+class ApiSearchBuilder < Blacklight::SearchBuilder
+  include Blacklight::Solr::SearchBuilderBehavior
+  include BlacklightAdvancedSearch::AdvancedSearchBuilder
+  # include B1gDateRangeQueryConcern::RangeLimitBuilder
+
+  self.default_processor_chain += [:add_advanced_parse_q_to_solr, :add_advanced_search_to_solr]
+
+  # Remove GBL Spatial, otherwise it will hide all suppressed docs
+  #   from API search results
+  #
+  # include Geoblacklight::SpatialSearchBehavior
+end

data/app/models/application_record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# ApplicationRecord
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/blacklight_api.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# BlacklightApi
+class BlacklightApi
+  include HTTParty
+  default_timeout 300
+
+  base_uri BLACKLIGHT_JSON_API
+
+  def initialize(**args)
+    defaults = {
+      q: "*",
+      page: 1,
+      sort: "score+desc%2C+dc_title_sort+asc",
+      rows: 20
+    }
+
+    @options = defaults.merge(**args)
+    append_facets(@options[:f], @options)
+    append_daterange(@options[:f], @options)
+    @options.compact!
+  end
+
+  def fetch
+    @fetch ||= self.class.get("/", query: @options)
+  end
+
+  def results
+    fetch["data"]
+  end
+
+  def facets
+    fetch["included"]&.filter_map { |s| s if s["type"] == "facet" }
+  end
+
+  def sorts
+    fetch["included"].filter_map { |s| s if s["type"] == "sort" }
+  end
+
+  def meta
+    fetch["meta"]
+  end
+
+  def links
+    fetch["links"]
+  end
+
+  def load_all
+    results.map { |result| Document.find_by(friendlier_id: result["id"]) }
+  end
+
+  def pluck(field)
+    load_all.pluck(field.to_sym)
+  end
+
+  private
+
+  def append_facets(facets, options)
+    options[:f] = facets if facets.present?
+    options
+  end
+
+  def prep_daterange(daterange)
+    start_date, end_date = daterange.split(" - ")
+    start_date = Date
+      .strptime(start_date, "%m/%d/%Y")
+      .beginning_of_day
+      .to_time
+      .strftime("%Y-%m-%dT%H:%M:%S")
+
+    end_date = Date
+      .strptime(end_date, "%m/%d/%Y")
+      .end_of_day
+      .to_time
+      .strftime("%Y-%m-%dT%H:%M:%S")
+
+    [start_date, end_date]
+  end
+
+  def append_daterange(_daterange, options)
+    return if options[:daterange].nil?
+
+    unless options[:daterange].empty?
+      start_date, end_date = prep_daterange(options[:daterange])
+      if options[:f].present?
+        options[:f][:date_created_drsim] = "[#{start_date} TO #{end_date}]"
+      else
+        options[:f] = {date_created_drsim: "[#{start_date} TO #{end_date}]"}
+      end
+    end
+    options
+  end
+end

data/app/models/blacklight_api_facets.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# BlacklightApiFacets
+class BlacklightApiFacets
+  include HTTParty
+  base_uri BLACKLIGHT_JSON_API_FACETS
+
+  def fetch
+    @fetch ||= self.class.get("/", query: {})
+  end
+
+  def facets
+    fetch["included"].filter_map { |s| s if s["type"] == "facet" } if fetch["included"].present?
+  end
+end

data/app/models/blacklight_api_ids.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# BlacklightApi
+class BlacklightApiIds
+  include HTTParty
+  default_timeout 300
+
+  base_uri BLACKLIGHT_JSON_API_IDS
+
+  def initialize(args = {})
+    defaults = {
+      q: "*",
+      page: 1,
+      sort: "score+desc%2C+dc_title_sort+asc",
+      rows: 1000
+    }
+
+    @options = defaults.merge(**args)
+    append_facets(@options[:f], @options)
+    append_daterange(@options[:f], @options)
+    @options.compact!
+  end
+
+  def fetch
+    Rails.logger.debug { "BlacklightApiIds > fetch > query: #{@options.inspect}" }
+
+    @fetch ||= self.class.get("/", query: @options)
+  end
+
+  def results
+    fetch["data"]
+  end
+
+  def facets
+    fetch["included"]&.filter_map { |s| s if s["type"] == "facet" }
+  end
+
+  def sorts
+    fetch["included"].filter_map { |s| s if s["type"] == "sort" }
+  end
+
+  def meta
+    fetch["meta"]
+  end
+
+  def links
+    fetch["links"]
+  end
+
+  def load_all
+    results.map { |result| Document.find_by(friendlier_id: result["id"]) }
+  end
+
+  def pluck(field)
+    load_all.pluck(field.to_sym)
+  end
+
+  private
+
+  def append_facets(facets, options)
+    options[:f] = facets if facets.present?
+    options
+  end
+
+  def prep_daterange(daterange)
+    start_date, end_date = daterange.split(" - ")
+    start_date = Date
+      .strptime(start_date, "%m/%d/%Y")
+      .beginning_of_day
+      .to_time
+      .strftime("%Y-%m-%dT%H:%M:%S")
+
+    end_date = Date
+      .strptime(end_date, "%m/%d/%Y")
+      .end_of_day
+      .to_time
+      .strftime("%Y-%m-%dT%H:%M:%S")
+
+    [start_date, end_date]
+  end
+
+  def append_daterange(_daterange, options)
+    Rails.logger.debug { "BlacklightApiIds > Append daterange (start): #{options.inspect}" }
+
+    return if options[:daterange].nil?
+
+    unless options[:daterange].empty?
+      start_date, end_date = prep_daterange(options[:daterange])
+
+      Rails.logger.debug { "BlacklightApiIds > Prep daterange: #{start_date.inspect} TO #{end_date.inspect}}" }
+
+      if options[:f].present?
+        options[:f][:date_created_drsim] = "[#{start_date} TO #{end_date}]"
+      else
+        options[:f] = {date_created_drsim: "[#{start_date} TO #{end_date}]"}
+      end
+    end
+
+    Rails.logger.debug { "BlacklightApiIds > Append daterange (end): #{options.inspect}" }
+
+    options
+  end
+end

data/app/models/bookmark.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Bookmark
+class Bookmark < ApplicationRecord
+  belongs_to :user, polymorphic: true
+  belongs_to :document, polymorphic: true
+
+  def document_type
+    value = super if defined?(super)
+    value &&= value.constantize
+    value || default_document_type
+  end
+
+  def default_document_type
+    SolrDocument
+  end
+end

data/app/models/bulk_action.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "uri"
+require "cgi"
+
+# BulkAction
+class BulkAction < ApplicationRecord
+  # Callbacks
+  after_create_commit :collect_documents
+
+  # Associations
+  has_many :documents, class_name: "BulkActionDocument", autosave: false, dependent: :destroy
+
+  has_many :bulk_action_transitions, autosave: false, dependent: :destroy
+
+  # Validations
+  validates :scope, :field_name, :field_value, presence: true
+
+  # States
+  include Statesman::Adapters::ActiveRecordQueries[
+    transition_class: BulkActionTransition,
+    initial_state: :created
+  ]
+
+  def state_machine
+    @state_machine ||= BulkActionStateMachine.new(self, transition_class: BulkActionTransition)
+  end
+
+  def run!
+    # @TODO: guard this call for validation?
+
+    # Queue Job
+    BulkActionRunJob.perform_later(self)
+
+    # Capture State
+    # state_machine.transition_to!(:imported)
+    # save
+  end
+
+  def check_run_state
+    return if state_machine.current_state == "complete"
+
+    state_machine.transition_to!(:complete) if documents.in_state(:queued).blank?
+  end
+
+  def revert!
+    # Queue Revert Job
+    BulkActionRevertJob.perform_later(self)
+  end
+
+  private
+
+  def collect_documents
+    cgi = CGI.unescape(scope)
+    uri = URI.parse(cgi)
+    if uri.path.include?("fetch")
+      fetch_documents(uri)
+    else
+      api_documents(uri)
+    end
+  end
+
+  def fetch_documents(uri)
+    qargs = Rack::Utils.parse_nested_query(uri.query)
+    fetch_documents = Document.where(friendlier_id: qargs["ids"])
+    create_documents(fetch_documents)
+  end
+
+  def api_documents(uri)
+    qargs = Rack::Utils.parse_nested_query(uri.query)
+    query_params = {q: qargs["q"], f: qargs["f"], page: qargs["page"], rows: 1_000_000}
+    api_documents = BlacklightApiIds.new(**query_params)
+    create_documents(api_documents.load_all)
+  end
+
+  def create_documents(documents)
+    documents.collect do |doc|
+      BulkActionDocument.create(
+        document_id: doc.id,
+        friendlier_id: doc.friendlier_id,
+        version: doc.current_version,
+        bulk_action_id: id
+      )
+    rescue
+      logger.debug("BULK ACTION BAD DOC: #{doc.inspect}")
+    end
+  end
+end

data/app/models/bulk_action_document.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# BulkActionDocument class
+class BulkActionDocument < ApplicationRecord
+  has_many :bulk_action_document_transitions, autosave: false, dependent: :destroy
+
+  include Statesman::Adapters::ActiveRecordQueries[
+    transition_class: BulkActionDocumentTransition,
+    initial_state: :queued
+  ]
+
+  def state_machine
+    @state_machine ||= BulkActionDocumentStateMachine.new(self, transition_class: BulkActionDocumentTransition)
+  end
+
+  # @TODO: Needed?
+  def to_hash
+    {
+      friendlier_id: friendlier_id
+    }
+  end
+end

data/app/models/bulk_action_document_state_machine.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# BulkActionDocument Statesman
+class BulkActionDocumentStateMachine
+  include Statesman::Machine
+
+  state :created, initial: true
+  state :queued
+  state :success
+  state :failed
+
+  transition from: :created, to: %i[queued success]
+  transition from: :queued, to: %i[queued success failed]
+  transition from: :success, to: %i[queued success failed]
+  transition from: :failed, to: %i[queued success failed]
+end

data/app/models/bulk_action_document_transition.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Add BulkActionDocument Statesman Transitions
+class BulkActionDocumentTransition < ApplicationRecord
+  include Statesman::Adapters::ActiveRecordTransition
+
+  belongs_to :bulk_action_document, inverse_of: :bulk_action_document_transitions
+
+  after_destroy :update_most_recent, if: :most_recent?
+
+  private
+
+  def update_most_recent
+    last_transition = bulk_action_document.bulk_action_document_transitions.order(:sort_key).last
+    return if last_transition.blank?
+
+    last_transition.update_column(:most_recent, true)
+  end
+end

data/app/models/bulk_action_state_machine.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# BulkAction Statesman
+class BulkActionStateMachine
+  include Statesman::Machine
+
+  state :created, initial: true
+  state :queued
+  state :complete
+  state :failed
+  state :reverted
+
+  transition from: :created, to: %i[queued complete failed]
+  transition from: :queued, to: %i[created queued complete failed]
+  transition from: :complete, to: %i[queued reverted]
+end

data/app/models/bulk_action_transition.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Add BulkAction Statesman Transitions
+class BulkActionTransition < ApplicationRecord
+  include Statesman::Adapters::ActiveRecordTransition
+
+  # If your transition table doesn't have the default `updated_at` timestamp column,
+  # you'll need to configure the `updated_timestamp_column` option, setting it to
+  # another column name (e.g. `:updated_on`) or `nil`.
+  #
+  # self.updated_timestamp_column = :updated_on
+  # self.updated_timestamp_column = nil
+
+  belongs_to :bulk_action, inverse_of: :bulk_action_transitions
+
+  after_destroy :update_most_recent, if: :most_recent?
+
+  private
+
+  def update_most_recent
+    last_transition = bulk_action.bulk_action_transitions.order(:sort_key).last
+    return if last_transition.blank?
+
+    last_transition.update_column(:most_recent, true)
+  end
+end

data/app/models/document/bbox_validator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Bbox Validation
+#
+# ex. Bad X value
+# -100096.7909 is not in boundary
+# Rect(minX=-180.0,maxX=180.0,minY=-90.0,maxY=90.0)
+# input: ENVELOPE(-100096.7909,-90.0574,43.9474,39.9655)
+class Document
+  # BboxValidator
+  class BboxValidator < ActiveModel::Validator
+    def validate(record)
+      # Assume true for empty values
+      valid_geom = true
+
+      # Sane for W,S,E,N?
+      proper_bounding_box(record, valid_geom) unless record.send(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box]).nil?
+
+      valid_geom
+    end
+
+    def proper_bounding_box(record, valid_geom)
+      # Min/Max
+      min_max = [-180.0, -90.0, 180.0, 90.0]
+
+      # "W,S,E,N" to [W,S,E,N]
+      unless record.send(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box]).split(",").nil?
+        geom = record.send(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box]).split(",")
+
+        if geom.empty?
+          valid_geom = true
+        elsif geom.size != 4
+          valid_geom = false
+          record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box], "invalid W,S,E,N syntax")
+        # W
+        elsif geom[0].to_f < min_max[0]
+          valid_geom = false
+          record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box], "invalid minX present")
+        # S
+        elsif geom[1].to_f < min_max[1]
+          valid_geom = false
+          record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box], "invalid minY present")
+        # E
+        elsif geom[2].to_f > min_max[2]
+          valid_geom = false
+          record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box], "invalid maX present")
+        # N
+        elsif geom[3].to_f > min_max[3]
+          valid_geom = false
+          record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box], "invalid maxY present")
+        # Solr - maxY must be >= minY
+        elsif geom[1].to_f >= geom[3].to_f
+          valid_geom = false
+          record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box], "maxY must be >= minY")
+        end
+
+        # Reject ENVELOPE(-118.00.0000,-88.00.0000,51.00.0000,42.00.0000
+        # - Double period float-ish things?
+        geom.each do |val|
+          if val.count(".") >= 2
+            valid_geom = false
+            record.errors.add(GeoblacklightAdmin::Schema.instance.solr_fields[:bounding_box], "invalid ENVELOPE(W,E,N,S) syntax - found multiple periods in a coordinate value.")
+          end
+        end
+      end
+
+      valid_geom
+    end
+  end
+end

data/app/models/document/controlled_lists.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# Constants for various controlled lists for Document attributes.
+#
+# _Removing_ values from here may require data migration in your existing db.
+#
+# ## Display lables via i18n
+# These are the values actually stored in the DB. Display-translated values can be
+# provided via a poorly documented built-in feature of Rails i18n.
+#
+# If you put an I18n value in your locale file (eg config/locales/en.yml) at:
+#     activerecord:
+#       attributes:
+#         work/format:
+#           image: "Really great image"
+#
+# Then you can look it up with Work.human_attribute_name("format.image"). It even
+# does some superclass lookup for you if you have an inheritance hieararchy.
+#
+# ## Some lists elsewhere
+# Controlled values for specific sub-model classes (like Creator) can be found
+# within them, not here. This is only for primitive attributes on Work. (But should
+# we move sub-model lists here too?)
+class Document
+  class ControlledLists
+    PUBLICATION_STATE = %w[draft published unpublished].freeze
+
+    ACCESS_RIGHTS = %w[Public Restricted].freeze
+
+    LAYER_GEOM_TYPES = %w[Point Line Polygon Image Raster Mixed Table Vector].freeze
+
+    B1G_STATUS = %w[Active Inactive Unknown].freeze
+
+    ACCRUAL_PERIODICITY = [
+      "Annual",
+      "Semiannual",
+      "Quarterly",
+      "Monthly",
+      "Irregular",
+      "As Needed",
+      "Once",
+      "Never"
+    ].freeze
+
+    RESOURCE_CLASS = [
+      "Maps",
+      "Datasets",
+      "Imagery",
+      "Collections",
+      "Websites",
+      "Web services",
+      "Other"
+    ].freeze
+
+    SCHEMA_PROVIDER = [
+      "Indiana University",
+      "University of Illinois Urbana-Champaign",
+      "University of Iowa",
+      "University of Maryland",
+      "University of Minnesota",
+      "Michigan State University",
+      "University of Michigan",
+      "Pennsylvania State University",
+      "Purdue University",
+      "University of Wisconsin - Madison",
+      "The Ohio State University",
+      "University of Chicago",
+      "University of Nebraska-Lincoln"
+    ].freeze
+
+    THEME = [
+      "Agriculture",
+      "Biology",
+      "Boundaries",
+      "Climate",
+      "Economy",
+      "Elevation",
+      "Environment",
+      "Events",
+      "Geology",
+      "Health",
+      "Imagery",
+      "Inland waters",
+      "Land cover",
+      "Location",
+      "Military",
+      "Oceans",
+      "Property",
+      "Society",
+      "Structure",
+      "Transportation",
+      "Utilities"
+    ].freeze
+
+    TYPE = [
+      "Image",
+      "Dataset",
+      "Service",
+      "Interactive Resource",
+      "Physical Object",
+      "Collection"
+    ].freeze
+  end
+end