geoblacklight_sidecar_images 0.5.1 → 0.6.0

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GeoblacklightSidecarImages
+  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_sidecar_images/image_service/iiif.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GeoblacklightSidecarImages
+  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_sidecar_images/image_service/image_map_layer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GeoblacklightSidecarImages
+  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_sidecar_images/image_service/tiled_map_layer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GeoblacklightSidecarImages
+  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_sidecar_images/image_service/wms.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GeoblacklightSidecarImages
+  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['layer_id_s']}" \
+          "&WIDTH=#{size}" \
+          "&HEIGHT=#{size}"
+      end
+    end
+  end
+end

data/geoblacklight_sidecar_images.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.version     = GeoblacklightSidecarImages::VERSION
   s.authors     = ['Eric Larson', 'Eliot Jordan']
   s.email       = ['ewlarson@umn.edu']
-  s.homepage    = 'https://github.com/ewlarson/geoblacklight_sidecar_images'
+  s.homepage    = 'https://github.com/geoblacklight/geoblacklight_sidecar_images'
   s.summary     = 'Store local copies of remote imagery in GeoBlacklight'
   s.license     = 'Apache 2.0'
 
@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'geoblacklight', '~> 1.9'
-  s.add_dependency 'mini_magick', '~> 4.8'
+  s.add_dependency 'geoblacklight', '~> 2.0'
+  s.add_dependency 'mini_magick', '~> 4.9.4'
   s.add_dependency 'image_processing', '~> 1.6'
   s.add_dependency 'statesman', '~> 3.4'
   s.add_dependency 'mimemagic', '~> 0.3'
@@ -27,9 +27,9 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'byebug'
   s.add_development_dependency 'capybara'
-  s.add_development_dependency 'chromedriver-helper'
+  s.add_development_dependency 'webdrivers'
   s.add_development_dependency 'database_cleaner', '~> 1.3'
-  s.add_development_dependency 'engine_cart', '~> 1.0'
+  s.add_development_dependency 'engine_cart', '~> 2.2'
   s.add_development_dependency 'rspec-rails', '~> 3.0'
   s.add_development_dependency 'rubocop', '~> 0.60.0'
   s.add_development_dependency 'rubocop-rspec', '~> 1.30.0'

data/lib/generators/geoblacklight_sidecar_images/install_generator.rb

@@ -16,23 +16,23 @@ GBLSI_THUMBNAIL_FIELD: 'thumbnail_path_ss'"
       end
     end
 
-    def generate_geoblacklight_example_docs
+    def generate_gblsci_assets
+      copy_file 'gblsci.scss', 'app/assets/stylesheets/gblsci.scss'
+    end
+
+    def generate_gblsci_example_docs
       generate 'geoblacklight_sidecar_images:example_docs'
     end
 
-    def generate_geoblacklight_jobs
+    def generate_gblsci_jobs
       generate 'geoblacklight_sidecar_images:jobs'
     end
 
-    def generate_geoblacklight_models
+    def generate_gblsci_models
       generate 'geoblacklight_sidecar_images:models'
     end
 
-    def generate_geoblacklight_services
-      generate 'geoblacklight_sidecar_images:services'
-    end
-
-    def generate_geoblacklight_views
+    def generate_gblsci_views
       generate 'geoblacklight_sidecar_images:views'
     end
 
@@ -40,7 +40,7 @@ GBLSI_THUMBNAIL_FIELD: 'thumbnail_path_ss'"
       rake 'active_storage:install'
     end
 
-    def generate_geoblacklight_config
+    def generate_gblsci_config
       generate 'geoblacklight_sidecar_images:config'
     end
 

data/lib/generators/geoblacklight_sidecar_images/jobs_generator.rb

@@ -8,14 +8,9 @@ module GeoblacklightSidecarImages
 
     desc <<-DESCRIPTION
       This generator makes the following changes to your application:
-       1. Copies jobs files to host app/jobs
-       2. Configures a default development environment queue adapter
+       1. Configures a default development environment queue adapter
     DESCRIPTION
 
-    def create_store_image_jobs
-      copy_file 'jobs/store_image_job.rb', 'app/jobs/store_image_job.rb'
-    end
-
     def config_development_jobs_queue_adapter
       job_config = <<-"JOBS"
         config.active_job.queue_adapter = :inline

data/lib/generators/geoblacklight_sidecar_images/models_generator.rb

@@ -42,34 +42,6 @@ module GeoblacklightSidecarImages
       inject_into_file 'app/models/solr_document.rb', sidecar, before: /^end/
     end
 
-    def create_solr_document_sidecar
-      copy_file(
-        'models/solr_document_sidecar.rb',
-        'app/models/solr_document_sidecar.rb'
-      )
-    end
-
-    def create_sidecar_image_transition
-      copy_file(
-        'models/sidecar_image_transition.rb',
-        'app/models/sidecar_image_transition.rb'
-      )
-    end
-
-    def create_sidecar_image_state_machine
-      copy_file(
-        'models/sidecar_image_state_machine.rb',
-        'app/models/sidecar_image_state_machine.rb'
-      )
-    end
-
-    def create_wms_rewrite_concern
-      copy_file(
-        'models/concerns/wms_rewrite_concern.rb',
-        'app/models/concerns/wms_rewrite_concern.rb'
-      )
-    end
-
     def include_wms_rewrite_solrdocument
       inject_into_file(
         'app/models/solr_document.rb',

data/lib/generators/geoblacklight_sidecar_images/templates/gblsci.scss

@@ -0,0 +1,3 @@
+/*
+*= require geoblacklight_sidecar_images/application
+*/

data/lib/generators/geoblacklight_sidecar_images/templates/views/catalog/_index_split_default.html.erb

@@ -1,33 +1,33 @@
 <% # header bar for doc items in index view -%>
 <%= content_tag :div, class: 'documentHeader row', data: { layer_id: document.id, bbox: document.bounding_box_as_wsen } do %>
-  <div class="document-wrapper">
-    <h3 class="index_title col-sm-9s cosl-lg-10 text-span">
-      <% counter = document_counter_with_offset(document_counter) %>
-      <span class="document-counter">
-        <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
-      </span>
-      <%= link_to_document document, document_show_link_field(document), counter: counter, title: document[blacklight_config.index.title_field] %>
-    </h3>
-    <div class='col-xs-12'>
-      <div class='media'>
-        <div class='media-left'>
-          <% if document.sidecar.image.attached? %>
-            <% if document.sidecar.image.variable? %>
-              <%= image_tag document.sidecar.image.variant(resize: "100x100"), {class: 'media-object'} %>
-            <% else %>
-              <%= image_tag document.sidecar.image, {class: 'media-object'} %>
-            <% end %>
-          <% else %>
-            <span title="<%=document[Settings.FIELDS.GEOM_TYPE]%>">
-              <%= geoblacklight_icon(document[Settings.FIELDS.GEOM_TYPE]) %>
-            </span>
-          <% end %>
-        </div>
-        <div class='media-body'>
-          <small>
-            <%= geoblacklight_present(:index_fields_display, document) %>
-          </small>
-        </div>
+  <div class='status-icons'>
+    <%= render partial: 'header_icons', locals: { document: document } %>
+  </div>
+  <h3 class="index_title col-sm-9s cosl-lg-10 text-span">
+    <% counter = document_counter_with_offset(document_counter) %>
+    <span class="document-counter">
+      <%= t('blacklight.search.documents.counter', :counter => counter) if counter %>
+    </span>
+    <%= link_to_document document, counter: counter, title: document[blacklight_config.index.title_field] %>
+  </h3>
+
+  <div class='col-md-12 more-info-area'>
+    <div class='media'>
+      <% if document.sidecar.image.attached? %>
+        <% if document.sidecar.image.variable? %>
+          <%= image_tag document.sidecar.image.variant(resize: "100x100"), {class: 'mr-3'} %>
+        <% else %>
+          <%= image_tag document.sidecar.image, {class: 'mr-3'} %>
+        <% end %>
+      <% else %>
+        <span class="icon square mr-3" title="<%=document[Settings.FIELDS.GEOM_TYPE]%>">
+          <%= geoblacklight_icon(document[Settings.FIELDS.GEOM_TYPE]) %>
+        </span>
+      <% end %>
+      <div class='media-body'>
+        <small>
+          <%= geoblacklight_present(:index_fields_display, document) %>
+        </small>
       </div>
     </div>
   </div>

data/lib/geoblacklight_sidecar_images/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GeoblacklightSidecarImages
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/lib/tasks/geoblacklight_sidecar_images_tasks.rake

@@ -3,9 +3,8 @@ require 'csv'
 namespace :gblsci do
   namespace :sample_data do
     desc 'Ingests a directory of geoblacklight.json files'
-    task :ingest, [:directory] => :environment do |_t, args|
-      args.with_defaults(directory: 'data')
-      Dir.glob(File.join(args[:directory], '**', '*.json')).each do |fn|
+    task seed: :environment do
+      Dir.glob(File.join(Rails.root, 'solr', 'geoblacklight', 'example_docs', '**', '*.json')).each do |fn|
         puts "Ingesting #{fn}"
         begin
           Blacklight.default_index.connection.add(JSON.parse(File.read(fn)))
@@ -38,7 +37,7 @@ namespace :gblsci do
         results.docs.each do |document|
           sleep(1)
           begin
-            StoreImageJob.perform_later(document.id)
+            GeoblacklightSidecarImages::StoreImageJob.perform_later(document.id)
           rescue Blacklight::Exceptions::RecordNotFound
             next
           end
@@ -84,10 +83,9 @@ namespace :gblsci do
         puts "#{state} - #{sidecars.size}"
 
         sidecars.each do |sc|
-          cat = CatalogController.new
           begin
-            resp, doc = cat.fetch(sc.document_id)
-            StoreImageJob.perform_later(doc.id)
+            document = Geoblacklight::SolrDocument.find(sc.document_id)
+            GeoblacklightSidecarImages::StoreImageJob.perform_later(document.id)
           rescue
             puts "orphaned / #{sc.document_id}"
           end
@@ -121,14 +119,14 @@ namespace :gblsci do
         sidecars.each do |sc|
           cat = CatalogController.new
           begin
-            resp, doc = cat.fetch(sc.document_id)
+            document = Geoblacklight::SolrDocument.find(sc.document_id)
             writer << [
               sc.id,
               sc.document_id,
               sc.image_state.current_state,
-              doc._source['layer_geom_type_s'],
-              doc._source['dc_title_s'],
-              doc._source['dct_provenance_s'],
+              document._source['layer_geom_type_s'],
+              document._source['dc_title_s'],
+              document._source['dct_provenance_s'],
               sc.image_state.last_transition.metadata['exception'],
               sc.image_state.last_transition.metadata['viewer_protocol'],
               sc.image_state.last_transition.metadata['image_url'],
@@ -163,9 +161,8 @@ namespace :gblsci do
       # Remove all images
       sidecars = SolrDocumentSidecar.all
       sidecars.each do |sc|
-        cat = CatalogController.new
         begin
-          resp, doc = cat.fetch(sc.document_id)
+          document = Geoblacklight::SolrDocument.find(sc.document_id)
         rescue
           sc.destroy
           puts "orphaned / #{sc.document_id} / destroyed"

data/solr/conf/schema.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<schema name="geoblacklight-schema" version="1.6">
+<schema name="geoblacklight-schema" version="1.7">
   <uniqueKey>layer_slug_s</uniqueKey>
   <fields>
     <field name="_version_" type="long"   stored="true" indexed="true"/>
@@ -64,6 +64,8 @@
     <dynamicField name="*_pt"   type="location"     stored="true" indexed="true"/>
     <dynamicField name="*_bbox" type="location_rpt" stored="true" indexed="true"/><!-- deprecated -->
     <dynamicField name="*_geom" type="location_rpt" stored="true" indexed="true"/>
+    <dynamicField name="*_bboxtype" type="bbox" stored="true" indexed="true"/>
+
   </fields>
 
   <types>
@@ -123,7 +125,6 @@
       <analyzer>
         <tokenizer class="solr.StandardTokenizerFactory"/>
         <filter class="solr.StopFilterFactory" ignoreCase="true" words="stopwords_en.txt"/>
-        <filter class="solr.StandardFilterFactory"/>
         <filter class="solr.LowerCaseFilterFactory"/>
         <filter class="solr.RemoveDuplicatesTokenFilterFactory"/>
       </analyzer>
@@ -133,7 +134,6 @@
     <fieldType class="solr.TextField" name="textSuggest" positionIncrementGap="100">
       <analyzer>
         <tokenizer class="solr.KeywordTokenizerFactory"/>
-        <filter class="solr.StandardFilterFactory"/>
         <filter class="solr.LowerCaseFilterFactory"/>
         <filter class="solr.RemoveDuplicatesTokenFilterFactory"/>
       </analyzer>
@@ -144,6 +144,11 @@
 
     <fieldType name="location_rpt" class="solr.SpatialRecursivePrefixTreeFieldType"
                geo="true" distErrPct="0.025" maxDistErr="0.001" distanceUnits="kilometers"/>
+    <!-- Adding field type for bboxField that enables, among other things, overlap ratio calculations -->
+    <fieldType name="bbox" class="solr.BBoxField"
+           geo="true" distanceUnits="kilometers" numberType="pdouble" />
+    <fieldType name="pdouble" class="solr.DoublePointField" docValues="true"/>
+
 
   </types>
 
@@ -187,4 +192,7 @@
   <copyField source="dct_provenance_s" dest="suggest"/>
   <copyField source="dc_subject_sm" dest="suggest"/>
   <copyField source="dct_spatial_sm" dest="suggest"/>
+
+  <!-- for bbox value -->
+  <copyField source="solr_geom" dest="solr_bboxtype"/>
 </schema>

data/solr/conf/solrconfig.xml

@@ -20,15 +20,15 @@
      this file, see http://wiki.apache.org/solr/SolrConfigXml.
 -->
 <config>
-  
+
   <!-- Controls what version of Lucene various components of Solr
        adhere to.  Generally, you want to use the latest version to
        get all bug fixes and improvements. It is highly recommended
        that you fully re-index after changing this setting as it can
        affect both how text is indexed and queried.
   -->
-  <luceneMatchVersion>6.1</luceneMatchVersion>
-  
+  <luceneMatchVersion>7.6</luceneMatchVersion>
+
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lib" />
   <lib dir="${solr.install.dir:../../../..}/contrib/analysis-extras/lucene-libs" />
 
@@ -38,7 +38,7 @@
   <schemaFactory class="ClassicIndexSchemaFactory"/>
 
   <dataDir>${solr.blacklight-core.data.dir:}</dataDir>
-    
+
   <indexConfig>
     <lockType>${solr.lock.type:native}</lockType>
   </indexConfig>

data/spec/fixtures/files/README.md

@@ -0,0 +1,40 @@
+# Listing of GeoBlacklight .json test documents
+
+If you add a new document, please add it to the table below, and indicate its purpose.
+
+| document | purpose |
+| -------- | ------- |
+| actual-papermap1 |Nondigitized paper map with a link to a library catalog|
+| actual-point1 |Point dataset with WMS and WFS|
+| actual-polygon1 |Polygon dataset (no direct download) with WFS, WMS, and FGDC metadata as XML|
+| actual-raster1 |Restricted raster layer with WMS and metadata in MODS and ISO 19139|
+| baruch_ancestor1 |SQLite Database with documentation download. Referenced as parent|
+| baruch_ancestor2 |Geodatabase with documentation download. Referenced as parent|
+| baruch_documentation_download |Point dataset with WMS and WFS, documentation download, and two parent records|
+| bbox-spans-180 |Scanned map with IIIF and direct TIFF download that spans across the 180th meridian|
+| cornell_html_metadata |Point dataset with WMS, WFS, direct download, and FGDC metadata XML and HTML|
+| esri-dynamic-layer-single-layer |ArcGIS Dynamic Map Layer with single layer indicated|
+| esri-feature-layer |ArcGIS Feature Layer - point dataset|
+| esri-image-map-layer |ArcGIS Image Map Layer with GeoTIFF direct download|
+| esri-tiled_map_layer |ArcGIS tiled map layer|
+| esri-wms-layer |Dataset with ArcGIS Dynamic Map Layer, ArcGIS WMS, and direct download|
+| harvard_raster |Raster with WMS and Harvard style download function|
+| iiif-eastern-hemisphere |Eastern hemisphere scanned map with IIIF and direct TIFF download|
+| index_map_point | GeoJSON index map of points |
+| index_map_polygon | GeoJSON index map of polygons, with a downloadUrl for the index itself |
+| index_map_polygon-no-downloadurl | GeoJSON index map of polygons, but lacking a downloadUrl for the index itself |
+| index-map-stanford | old-style (pre-GeoJSON) index map of rectangular polygons |
+| no_spatial |File without geometry type or solr_geometry (will cause error)|
+| princeton-child1.json | Child record for testing the `suppressed_b` property |
+| princeton-child2.json | Child record for testing the `suppressed_b` property |
+| princeton-child3.json | Child record for testing the `suppressed_b` property |
+| princeton-child4.json | Child record for testing the `suppressed_b` property |
+| princeton-parent.json | Parent record for testing the `suppressed_b` property |
+| public_direct_download | includes a tentative `dcat_distribution_sm` property |
+| public_iiif_princeton |Scanned map with IIIF|
+| public_polygon_mit |Polygon shapefile with WMS and WFS|
+| restricted-line |Restricted line layer with WFS, WMS and metadata in MODS and ISO 19139|
+| umn_metro_result1.json |Bounding box of metropolitan area and ArcGIS Dynamic Map Layer|
+| umn_state_result1.json |Bounding box of state area and static image in references|
+| umn_state_result2.json |Bounding box of state area and raster download|
+| uva_slug_colon.json | Multipoint dataset with WMS and WFS and a colon in the slug and layer ID |