geoblacklight_sidecar_images 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc93c6c4a8f6d2660d5b56b672c6cf1c335a3b2f
-  data.tar.gz: 2e0427f83e4e4a4046de0717ade4bf356ed08779
+  metadata.gz: 3233e1aaff539c85ba41a37cd3e87b7a8ff083d7
+  data.tar.gz: 330ef9966073b81e5fdc539287e25ef2333b98f8
 SHA512:
-  metadata.gz: 9693ebfde32f4c886734d1a42aa65b2027cec8093d9d3720bfb2903642d4cf036ab5a830a280234852ff3038d7fe29076672bb9dc34a9ee5ca616957a890438d
-  data.tar.gz: ed64611169594cfbdd8e83f8823a3df3f5ac31caa49d21293d32f276cb0ba9dbd07935da0055ff88b29a623a306942aa5a5f268714c937f4dc514718565ac95b
+  metadata.gz: 5a8af424a1f10bec71d607c4997810b054aab5948b662a83cdf2325ed3005cf90d6dc0bd0b5a496a2a0303d454941b38b968e9c81c3fd8b3c56a97fc36ebfcf7
+  data.tar.gz: d3fa62b61a58cbb07edd93ad94b1e93c2e652d9a06947a2011c9a40ffa30afd8949e33e3d68c3d7072f8c085bb3d82f794592c4f2984f6552e9b5711a2272542

data/.rubocop.yml

@@ -19,6 +19,14 @@ AllCops:
   - 'template.rb'
   - Gemfile
 
+Lint/RescueException:
+  Exclude:
+  - 'lib/generators/geoblacklight_sidecar_images/templates/services/image_service.rb'
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'
+    
 Metrics/LineLength:
   Max: 100
   Exclude:

data/README.md

@@ -3,12 +3,16 @@
 [![Build Status](https://travis-ci.org/ewlarson/geoblacklight_sidecar_images.svg?branch=master)](https://travis-ci.org/ewlarson/geoblacklight_sidecar_images)
 [![Maintainability](https://api.codeclimate.com/v1/badges/88c14165af5459963011/maintainability)](https://codeclimate.com/github/ewlarson/geoblacklight_sidecar_images/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/ewlarson/geoblacklight_sidecar_images/badge.svg?branch=master)](https://coveralls.io/github/ewlarson/geoblacklight_sidecar_images?branch=master)
+[![Gem Version](https://badge.fury.io/rb/geoblacklight_sidecar_images.svg)](https://badge.fury.io/rb/geoblacklight_sidecar_images)
 
 Store local copies of remote imagery in GeoBlacklight.
 
 ## Description
 This GeoBlacklight plugin helps capture remote images from geo web services and save them locally. It borrows the concept of a [SolrDocumentSidecar](https://github.com/projectblacklight/spotlight/blob/master/app/models/spotlight/solr_document_sidecar.rb) from [Spotlight](https://github.com/projectblacklight/spotlight), to have an ActiveRecord-based "sidecar" to match each non-AR SolrDocument. This allows us to use [carrierwave](https://github.com/carrierwaveuploader/carrierwave) to attach images to our documents.
 
+### Example Screenshot
+![Screenshot](screenshot.png)
+
 ## Requirements
 
 * [GeoBlacklight](https://github.com/geoblacklight/geoblacklight)
@@ -65,6 +69,25 @@ rake geoblacklight_sidecar_images:images:precache_all
 rake geoblacklight_sidecar_images:images:precache_id['minnesota-iiif-jpg-83f4648a-125c-4000-a12f-aba2b432e7cd']
 ```
 
+## Prioritize Solr Thumbnail Field URIs
+
+If you add a thumbnail uri to your geoblacklight solr documents...
+
+### Example Doc
+
+```json
+{
+  ...
+  "dc_format_s":"TIFF",
+  "dc_creator_sm":["Minnesota. Department of Highways."],
+  "thumbnail_path_ss":"https://umedia.lib.umn.edu/sites/default/files/imagecache/square300/reference/562/image/jpeg/1089695.jpg",
+  "dc_type_s":"Still image",
+  ...
+}
+```
+
+Then you can edit your GeoBlacklight settings.yml file to point at that solr field (Settings.GBLSI_THUMBNAIL_FIELD). Any docs in your index that have a value for that field will harvest the image at that URI instead of trying to retrieve an image via IIIF or the other web services.
+
 ## Development
 
 ```bash
@@ -77,8 +100,8 @@ Now you'll have an instance of GBLSI running. Follow the rake tasks above to ing
 
 ## TODOs
 
-* 0.0.1 - Initial gem
-* 0.1.0 - Forgo attaching placeholder imagery
-* 0.2.0 - Prioritize local thumbnail solr field
+* ~~0.0.1 - Initial gem~~
+* ~~0.1.0 - Prioritize local thumbnail solr field~~
+* 0.2.0 - Forgo attaching placeholder imagery
 * 0.3.0 - Add Statesman (state machine library)
-* Future - Rails 5.2 branch / ActionStorage
+* 1.0.0 - Rails 5.2 branch / Switch to ActionStorage

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError

data/app/controllers/geoblacklight_sidecar_images/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoblacklightSidecarImages
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception

data/app/helpers/geoblacklight_sidecar_images/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoblacklightSidecarImages
   module ApplicationHelper
   end

data/app/jobs/geoblacklight_sidecar_images/application_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoblacklightSidecarImages
   class ApplicationJob < ActiveJob::Base
   end

data/app/mailers/geoblacklight_sidecar_images/application_mailer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoblacklightSidecarImages
   class ApplicationMailer < ActionMailer::Base
     default from: 'from@example.com'

data/app/models/geoblacklight_sidecar_images/application_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoblacklightSidecarImages
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true

data/config/routes.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 GeoblacklightSidecarImages::Engine.routes.draw do
 end

data/lib/generators/geoblacklight_sidecar_images/install_generator.rb

@@ -11,7 +11,8 @@ module GeoblacklightSidecarImages
 "INSTITUTION_LOCAL_NAME: 'Princeton'
 INSTITUTION_GEOSERVER_URL: 'https://geoserver.princeton.edu'
 PROXY_GEOSERVER_URL: 'http://localhost:3000'
-PROXY_GEOSERVER_AUTH: 'Basic base64encodedusername:password'"
+PROXY_GEOSERVER_AUTH: 'Basic base64encodedusername:password'
+GBLSI_THUMBNAIL_FIELD: 'thumbnail_path_ss'"
       end
     end
 

data/lib/generators/geoblacklight_sidecar_images/templates/jobs/store_image_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class StoreImageJob < ApplicationJob
   queue_as :default
 

data/lib/generators/geoblacklight_sidecar_images/templates/models/concerns/wms_rewrite_concern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WmsRewriteConcern
   extend Geoblacklight::SolrDocument
 

data/lib/generators/geoblacklight_sidecar_images/templates/models/solr_document_sidecar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # Metadata for indexed documents
 class SolrDocumentSidecar < ApplicationRecord

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/mime'
 
 class ImageService
@@ -65,6 +67,19 @@ class ImageService
     Settings.PROXY_GEOSERVER_AUTH != 'Basic base64encodedusername:password'
   end
 
+  # Tests if local thumbnail method is configured
+  def gblsi_thumbnail_field?
+    Settings.GBLSI_THUMBNAIL_FIELD
+  end
+
+  def gblsi_thumbnail_uri
+    if gblsi_thumbnail_field? && @document[Settings.GBLSI_THUMBNAIL_FIELD]
+      @document[Settings.GBLSI_THUMBNAIL_FIELD]
+    else
+      false
+    end
+  end
+
   def placeholder_base_path
     Rails.root.join('app', 'assets', 'images')
   end
@@ -111,6 +126,10 @@ class ImageService
     placeholder_data[:type]
   rescue Faraday::Error::TimeoutError
     placeholder_data[:type]
+
+  # Rescuing Exception intentionally
+  rescue Exception
+    placeholder_data[:type]
   end
 
   # Gets thumbnail image from URL. On error, returns document's placeholder image.
@@ -134,7 +153,9 @@ class ImageService
   # dct references is used instead.
   def image_url
     @image_url ||= begin
-      if restricted_scanned_map?
+      if gblsi_thumbnail_uri
+        gblsi_thumbnail_uri
+      elsif restricted_scanned_map?
         image_reference
       elsif restricted_wms_layer? && !geoserver_credentials_valid?
         image_reference

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/dynamic_map_layer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ImageService
   module DynamicMapLayer
     ##

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/iiif.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ImageService
   module Iiif
     ##

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/image_map_layer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ImageService
   module ImageMapLayer
     ##

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/tiled_map_layer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ImageService
   module TiledMapLayer
     ##

data/lib/generators/geoblacklight_sidecar_images/templates/services/image_service/wms.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ImageService
   module Wms
     ##

data/lib/generators/geoblacklight_sidecar_images/templates/uploaders/image_uploader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ImageUploader < CarrierWave::Uploader::Base
   # Include RMagick or MiniMagick support:
   # include CarrierWave::RMagick

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

@@ -1,13 +1,5 @@
 <% # 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='more-info-area-split'>
-      <div class='status-icons'>
-        <%= render partial: 'header_icons', locals: { document: document } %>
-      </div>
-      <div class="thumbnail">
-        <img src="<%=document.sidecar.image_url%>"/>
-      </div>
-    </div>
   <div class="document-wrapper">
     <h3 class="index_title col-sm-9s cosl-lg-10 text-span">
       <% counter = document_counter_with_offset(document_counter) %>
@@ -17,10 +9,15 @@
       <%= 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>
-        <small>
-          <%= geoblacklight_present(:index_fields_display, document) %>
-        </small>
+      <div class='media'>
+        <div class='media-left'>
+          <img class='media-object' src="<%=document.sidecar.image_url(:square)%>"/>
+        </div>
+        <div class='media-body'>
+          <small>
+            <%= geoblacklight_present(:index_fields_display, document) %>
+          </small>
+        </div>
       </div>
     </div>
   </div>

data/lib/geoblacklight_sidecar_images.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'geoblacklight_sidecar_images/engine'
 
 module GeoblacklightSidecarImages

data/lib/geoblacklight_sidecar_images/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoblacklightSidecarImages
   class Engine < ::Rails::Engine
     isolate_namespace GeoblacklightSidecarImages

data/lib/geoblacklight_sidecar_images/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoblacklightSidecarImages
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/spec/fixtures/files/umn_solr_thumb.json

@@ -0,0 +1,34 @@
+{
+  "dc_description_s":"Cartographic Details: Scale approximately 1:1,530,000. Description based on: 1932 sheet. Each sheet lists the Commissioner of highways and the Chief Engineer. On verso: Distance tables for various cities in Minnesota.",
+  "layer_modified_dt":"2017-06-12T13:36:50Z",
+  "solr_geom":"ENVELOPE(-97.2509765625, -90.9228515625, 49.3787965644, 43.4648808289)",
+  "dct_references_s":"{\"http://schema.org/url\":\"http://purl.umn.edu/231125\",\"http://schema.org/downloadUrl\":\"https://umedia.lib.umn.edu/sites/default/files/archive/562/image/tiff/1089695.tif\",\"http://iiif.io/api/image\":\"https://umedia.lib.umn.edu/fcgi-bin/iipsrv.fcgi?IIIF=sites/default/files/reference/562/image/jp2/1089695.jp2/info.json\"}",
+  "dc_rights_s":"Public",
+  "uuid":"aaf63e35-3d5f-4e62-b59d-377f008e9aad",
+  "dct_provenance_s":"Minnesota",
+  "dc_subject_sm":["Roads -- Minnesota -- Maps",
+    "Minnesota -- Distances -- Tables",
+    "Minnesota -- Maps",
+    "Maps"],
+  "dct_temporal_sm":["1925"],
+  "layer_slug_s":"aaf63e35-3d5f-4e62-b59d-377f008e9aad",
+  "dc_format_s":"TIFF",
+  "dc_creator_sm":["Minnesota. Department of Highways."],
+  "thumbnail_path_ss":"https://umedia.lib.umn.edu/sites/default/files/imagecache/square300/reference/562/image/jpeg/1089695.jpg",
+  "dc_type_s":"Still image",
+  "dc_identifier_s":"aaf63e35-3d5f-4e62-b59d-377f008e9aad",
+  "dc_relation_sm":["http://sws.geonames.org/5037779/about/rdf"],
+  "dct_isPartOf_sm":["John R. Borchert Map Library"],
+  "solr_year_i":1925,
+  "dct_spatial_sm":["Minnesota, United States"],
+  "dc_publisher_sm":["The Department"],
+  "layer_id_s":"urn:aaf63e35-3d5f-4e62-b59d-377f008e9aad",
+  "georss_box_s":"43.4648808289 -97.2509765625 49.3787965644 -90.9228515625",
+  "dc_title_s":"Condition map of Minnesota Trunk Highways : a 7,000 mile primary system showing national and state markings",
+  "dct_issued_s":"1925",
+  "georss_polygon_s":"43.4648808289 -97.2509765625 49.3787965644 -97.2509765625 49.3787965644 -90.9228515625 43.4648808289 -90.9228515625 43.4648808289 -97.2509765625",
+  "layer_geom_type_s":"Paper Map",
+  "dc_language_s":"eng",
+  "timestamp":"2017-06-12T22:01:27.649Z",
+  "centroid_s":"46.42183869665,-94.0869140625"
+}

data/spec/models/solr_document_sidecar_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_helper'
 
 describe SolrDocumentSidecar do

data/spec/models/solr_document_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_helper'
 
 describe Geoblacklight::SolrDocument do

data/spec/rails_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ENV['RAILS_ENV'] ||= 'test'
 
 require 'spec_helper'

data/spec/services/image_service_spec.rb

@@ -1,15 +1,29 @@
+# frozen_string_literal: true
+
 require 'rails_helper'
 
 describe ImageService do
-  let(:iiif_document) { SolrDocument.new(json_data('umn_iiif_jpg')) }
+  let(:iiif_document) { SolrDocument.new(json_data('umich_iiif_jpg')) }
   let(:iiif_imgsvc) { ImageService.new(iiif_document) }
   let(:wms_document) { SolrDocument.new(json_data('public_polygon_mit')) }
-  let(:wms_imgsvc) { ImageService.new(iiif_document) }
+  let(:wms_imgsvc) { ImageService.new(wms_document) }
+  let(:thumb_document) { SolrDocument.new(json_data('umn_solr_thumb')) }
+  let(:thumb_imgsvc) { ImageService.new(thumb_document) }
 
   describe '#store' do
     it 'should respond to store' do
       expect(iiif_imgsvc).to respond_to(:store)
     end
+
+    it 'should prioritize settings thumbnail field' do
+      expect(thumb_imgsvc.send(:gblsi_thumbnail_field?)).to be_truthy
+      expect(thumb_imgsvc.send(:image_url)).to eq 'https://umedia.lib.umn.edu/sites/default/files/imagecache/square300/reference/562/image/jpeg/1089695.jpg'
+    end
+
+    it 'should choose references if no settings thumbnail field value' do
+      expect(wms_imgsvc.send(:gblsi_thumbnail_field?)).to be_truthy
+      expect(wms_imgsvc.send(:image_url)).to include 'wms'
+    end
   end
 
   context '#iiif' do

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 def json_data(filename)
   file_content = file_fixture("#{filename}.json").read

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight_sidecar_images
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Eric Larson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -275,6 +275,7 @@ files:
 - lib/geoblacklight_sidecar_images/engine.rb
 - lib/geoblacklight_sidecar_images/version.rb
 - lib/tasks/geoblacklight_sidecar_images_tasks.rake
+- screenshot.png
 - solr/conf/_rest_managed.json
 - solr/conf/admin-extra.html
 - solr/conf/elevate.xml
@@ -314,6 +315,7 @@ files:
 - spec/fixtures/files/umn_iiif_jpg.json
 - spec/fixtures/files/umn_metro_result1.json
 - spec/fixtures/files/umn_metro_result2.json
+- spec/fixtures/files/umn_solr_thumb.json
 - spec/fixtures/files/umn_state_result1.json
 - spec/fixtures/files/umn_state_result2.json
 - spec/models/solr_document_sidecar_spec.rb
@@ -371,6 +373,7 @@ test_files:
 - spec/fixtures/files/umn_iiif_jpg.json
 - spec/fixtures/files/umn_metro_result1.json
 - spec/fixtures/files/umn_metro_result2.json
+- spec/fixtures/files/umn_solr_thumb.json
 - spec/fixtures/files/umn_state_result1.json
 - spec/fixtures/files/umn_state_result2.json
 - spec/models/solr_document_sidecar_spec.rb