geoblacklight_sidecar_images 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a8eb8793e9bc01499aa73ada433ccd2b545c4381
-  data.tar.gz: b62ea3956e24e52f58fc82d5ae0bc6122ec1fd63
+SHA256:
+  metadata.gz: c72cc3fac516c465122adca9f440104db7d2012588d4562de7c467134208d758
+  data.tar.gz: 3c6ab484395eb53f804d1c6f916de049be21d3d18f09c9201055a87dcc226009
 SHA512:
-  metadata.gz: e7e1f1a1084046921f213aac5c1a9ae73cb2e3ef5112455a33bf36dd5f66871a06f456d3fabb0c19e967676e2bfd155fb11832cfcc3e446355487d437fc34301
-  data.tar.gz: 1cb4ced8521c6e4778379d784901196a832b2c5989f0523c2ca092f8d22c495f0a7c66e20ec5e97f2d0f40d75addcd2ca27713567ee12b65d50e3674e5805a4c
+  metadata.gz: 3ce1fe5b78fa81dac0c70f09e73d7cdcdddb06136ccff8c4b75ab80a42dabc205800ddd59ce320f2ac62d8c7916be0b6713f46199d4a8a9f1ca2dba973896dc3
+  data.tar.gz: cd1e00e5b1781c95a409cbdfd8c73ef62c48c3ada88eda5a640c4cac4e0209627f40aee71a5d178ac9a4e0796f902af10dacf7f44212c9c860c7fa630a5c1d32

data/.rubocop.yml

@@ -18,7 +18,7 @@ AllCops:
 
 Lint/RescueException:
   Exclude:
-  - 'lib/generators/geoblacklight_sidecar_images/templates/services/image_service.rb'
+  - 'app/services/geoblacklight_sidecar_images/image_service.rb'
 
 Metrics/BlockLength:
   Exclude:
@@ -29,12 +29,12 @@ Metrics/LineLength:
   Exclude:
   - 'spec/**/*'
   - 'Rakefile'
-  - 'lib/generators/geoblacklight_sidecar_images/templates/services/image_service.rb'
+  - 'app/services/geoblacklight_sidecar_images/image_service.rb'
 
 # TODO: Refactor large methods.
 Metrics/ClassLength:
   Exclude:
-  - 'lib/generators/geoblacklight_sidecar_images/templates/services/image_service.rb'
+  - 'app/services/geoblacklight_sidecar_images/image_service.rb'
 
 Metrics/AbcSize:
   Max: 28
@@ -44,7 +44,7 @@ Metrics/MethodLength:
   Exclude:
   - 'spec/**/*'
   - 'Rakefile'
-  - 'lib/generators/geoblacklight_sidecar_images/templates/services/image_service.rb'
+  - 'app/services/geoblacklight_sidecar_images/image_service.rb'
 
 # TODO: Add top-level class and module documentation.
 Style/Documentation:

data/.travis.yml

@@ -8,12 +8,12 @@ notifications:
   email: false
 
 rvm:
-  - 2.4.5
+  - 2.5.3
 
 matrix:
   include:
-    - rvm: 2.4.5
-      env: "RAILS_VERSION=5.2.1"
+    - rvm: 2.5.3
+      env: "RAILS_VERSION=5.2.2"
 
 before_install:
   - gem update --system
@@ -21,7 +21,7 @@ before_install:
   - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
 
 env:
- - "RAILS_VERSION=5.2.1 "
+ - "RAILS_VERSION=5.2.2"
 
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -37,8 +37,8 @@ if File.exist?(file)
   end
 else
   Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
-  gem 'geoblacklight', '~> 1.9'
-  gem 'mini_magick'
+  gem 'geoblacklight', '~> 2.0'
+  gem 'mini_magick', '~> 4.9.4'
   gem 'image_processing', '~> 1.6'
   gem 'mimemagic', '~> 0.3'
   gem 'statesman', '~> 3.4'

data/README.md

@@ -1,8 +1,8 @@
 # GeoBlacklight Sidecar Images
 
-[![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)
+[![Build Status](https://travis-ci.org/geoblacklight/geoblacklight_sidecar_images.svg?branch=master)](https://travis-ci.org/geoblacklight/geoblacklight_sidecar_images)
+[![Maintainability](https://api.codeclimate.com/v1/badges/88c14165af5459963011/maintainability)](https://codeclimate.com/github/geoblacklight/geoblacklight_sidecar_images/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/geoblacklight/geoblacklight_sidecar_images/badge.svg?branch=master)](https://coveralls.io/github/geoblacklight/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.
@@ -52,7 +52,7 @@ $ bin/rails db:migrate
 Create a new GeoBlacklight instance with the GBLSI code
 
 ```bash
-$ rails new app-name -m https://raw.githubusercontent.com/ewlarson/geoblacklight_sidecar_images/master/template.rb
+$ rails new app-name -m https://raw.githubusercontent.com/geoblacklight/geoblacklight_sidecar_images/master/template.rb
 
 ```
 
@@ -64,7 +64,8 @@ $ rails new app-name -m https://raw.githubusercontent.com/ewlarson/geoblacklight
 ```
 
 ```bash
-bundle exec rake gblsci:sample_data:ingest['<FULL_LOCAL_PATH_TO>/geoblacklight_sidecar_images/spec/fixtures/files']
+  # Index the GBL test fixtures
+bundle exec rake gblsci:sample_data:seed
 ```
 
 ## Rake tasks
@@ -206,10 +207,10 @@ bundle exec rake ci
 
 # Launch test app server
 cd .internal_test_app/
-rake geoblacklight:server
+bundle exec rake geoblacklight:server
 
 # Load test fixtures
-bundle exec rake gblsci:sample_data:ingest['<FULL_LOCAL_PATH_TO>/geoblacklight_sidecar_images/spec/fixtures/files']
+bundle exec rake gblsci:sample_data:seed
 
 # Run harvest
 bundle exec rake gblsci:images:harvest_all

data/Rakefile

@@ -17,11 +17,8 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
 require 'engine_cart/rake_task'
-EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
 require 'geoblacklight_sidecar_images/version'
 
-EngineCart.fingerprint_proc = EngineCart.rails_fingerprint_proc
-
 task ci: ['engine_cart:generate'] do
   ENV['environment'] = 'test'
 

data/app/assets/stylesheets/geoblacklight_sidecar_images/_gblsci.scss

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ */
+ 
+@import 'modules/results';

data/app/assets/stylesheets/geoblacklight_sidecar_images/application.scss

@@ -0,0 +1,10 @@
+// GBLSCI results
+.media {
+  img,span {
+    min-width: 100px;
+    text-align: center;
+  }
+  span.icon.square {
+    font-size:3rem;
+  }
+}

data/app/assets/stylesheets/geoblacklight_sidecar_images/modules/_results.scss

@@ -0,0 +1,10 @@
+// GBLSCI results
+.media {
+  img,span {
+    min-width: 100px;
+    text-align: center;
+  }
+  span.icon.square {
+    font-size:3rem;
+  }
+}

data/app/jobs/geoblacklight_sidecar_images/store_image_job.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GeoblacklightSidecarImages
+  class StoreImageJob < ApplicationJob
+    queue_as :default
+
+    def perform(solr_document_id)
+      document = Geoblacklight::SolrDocument.find(solr_document_id)
+
+      metadata = {}
+      metadata['solr_doc_id'] = document.id
+      metadata['solr_version'] = document.sidecar.version
+
+      document.sidecar.image_state.transition_to!(:queued, metadata)
+      GeoblacklightSidecarImages::ImageService.new(document).store
+    end
+  end
+end

data/{lib/generators/geoblacklight_sidecar_images/templates → app}/models/sidecar_image_state_machine.rb

@@ -15,7 +15,7 @@ class SidecarImageStateMachine
   transition from: :initialized,  to: %i[queued processing]
   transition from: :queued,       to: %i[queued processing]
   transition from: :processing,   to: %i[queued processing placeheld succeeded failed]
-  transition from: :placeheld,    to: %i[queued processing]
+  transition from: :placeheld,    to: %i[queued processing failed]
   transition from: :failed,       to: %i[queued processing]
   transition from: :succeeded,    to: %i[queued processing]
 end

data/{lib/generators/geoblacklight_sidecar_images/templates → app}/models/solr_document_sidecar.rb

@@ -5,8 +5,8 @@
 class SolrDocumentSidecar < ApplicationRecord
   include Statesman::Adapters::ActiveRecordQueries
 
-  belongs_to :document, required: true, polymorphic: true
-  has_many :sidecar_image_transitions, autosave: false
+  belongs_to :document, optional: false, polymorphic: true
+  has_many :sidecar_image_transitions, autosave: false, dependent: :destroy
   has_one_attached :image
 
   # If the sidecar solr document is updated, re-fetch thumbnail image
@@ -45,6 +45,6 @@ class SolrDocumentSidecar < ApplicationRecord
 
   def reimage
     image.purge if image.attached?
-    StoreImageJob.perform_later(document.id)
+    GeoblacklightSidecarImages::StoreImageJob.perform_later(document.id)
   end
 end

data/app/services/geoblacklight_sidecar_images/image_service.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require 'addressable/uri'
+require 'mimemagic'
+
+module GeoblacklightSidecarImages
+  class ImageService
+    attr_reader :document
+    attr_writer :metadata, :logger
+
+    def initialize(document)
+      @document = document
+
+      @metadata = {}
+      @metadata['solr_doc_id'] = document.id
+      @metadata['solr_version'] = @document.sidecar.version
+      @metadata['placeheld'] = false
+
+      @document.sidecar.image_state.transition_to!(:processing, @metadata)
+
+      @logger ||= ActiveSupport::TaggedLogging.new(
+        Logger.new(
+          Rails.root.join('log', "image_service_#{Rails.env}.log")
+        )
+      )
+    end
+
+    # Stores the document's image in ActiveStorage
+    # @return [Boolean]
+    #
+    def store
+      # Gentle hands
+      sleep(1)
+
+      io_file = image_tempfile(@document.id)
+
+      if io_file.nil? || @metadata['placeheld'] == true
+        @document.sidecar.image_state.transition_to!(:placeheld, @metadata)
+      else
+        attach_io(io_file)
+      end
+
+      log_output
+    rescue Exception => invalid
+      @metadata['exception'] = invalid.inspect
+      @document.sidecar.image_state.transition_to!(:failed, @metadata)
+
+      log_output
+    end
+
+    private
+
+    def image_tempfile(document_id)
+      @metadata['viewer_protocol']      = @document.viewer_protocol
+      @metadata['image_url']            = image_url
+      @metadata['service_url']          = service_url
+      @metadata['gblsi_thumbnail_uri']  = gblsi_thumbnail_uri
+
+      return nil unless image_data && @metadata['placeheld'] == false
+
+      temp_file = Tempfile.new([document_id, '.tmp'])
+      temp_file.binmode
+      temp_file.write(image_data)
+      temp_file.rewind
+
+      @metadata['image_tempfile'] = temp_file.inspect
+      temp_file
+    end
+
+    def attach_io(io)
+      # Remote content-type headers are untrustworthy
+      # Pull the mimetype and file extension via MimeMagic
+      mm = MimeMagic.by_magic(File.open(io))
+
+      @metadata['MimeMagic_type'] = mm.type
+      @metadata['MimeMagic_mediatype'] = mm.mediatype
+      @metadata['MimeMagic_subtype'] = mm.subtype
+
+      if mm.mediatype == 'image'
+        @document.sidecar.image.attach(
+          io: io,
+          filename: "#{@document.id}.#{mm.subtype}",
+          content_type: mm.type
+        )
+        @document.sidecar.image_state.transition_to!(:succeeded, @metadata)
+      else
+        @document.sidecar.image_state.transition_to!(:placeheld, @metadata)
+      end
+    end
+
+    # Returns geoserver auth credentials if the document is a restriced Local WMS layer.
+    def geoserver_credentials
+      return unless restricted_wms_layer?
+
+      Settings.PROXY_GEOSERVER_AUTH.gsub('Basic ', '')
+    end
+
+    # Tests if geoserver credentials are set beyond the default.
+    def geoserver_credentials_valid?
+      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
+
+    # Generates hash containing thumbnail mime_type and image.
+    def image_data
+      return nil unless image_url
+
+      remote_image
+    end
+
+    # Gets thumbnail image from URL. On error, placehold image.
+    def remote_image
+      auth = geoserver_credentials
+
+      uri = Addressable::URI.parse(image_url)
+
+      return nil unless uri.scheme.include?('http')
+
+      conn = Faraday.new(url: uri.normalize.to_s) do |b|
+        b.use FaradayMiddleware::FollowRedirects
+        b.adapter :net_http
+      end
+
+      conn.options.timeout = timeout
+      conn.authorization :Basic, auth if auth
+      conn.get.body
+    rescue Faraday::Error::ConnectionFailed
+      @metadata['error'] = 'Faraday::Error::ConnectionFailed'
+      @metadata['placeheld'] = true
+      nil
+    rescue Faraday::Error::TimeoutError
+      @metadata['error'] = 'Faraday::Error::TimeoutError'
+      @metadata['placeheld'] = true
+      nil
+    end
+
+    # Returns the thumbnail url.
+    # If the layer is restriced Local WMS, and the geoserver credentials
+    # have not been set beyond the default, then a thumbnail url from
+    # dct references is used instead.
+    def image_url
+      @image_url ||= begin
+        if gblsi_thumbnail_uri
+          gblsi_thumbnail_uri
+        elsif restricted_scanned_map?
+          image_reference
+        elsif restricted_wms_layer? && !geoserver_credentials_valid?
+          image_reference
+        else
+          service_url || image_reference
+        end
+      end
+    end
+
+    # Checks if the document is Local restriced access and is a scanned map.
+    def restricted_scanned_map?
+      @document.local_restricted? && @document['layer_geom_type_s'] == 'Image'
+    end
+
+    # Checks if the document is Local restriced access and is a wms layer.
+    def restricted_wms_layer?
+      @document.local_restricted? && @document.viewer_protocol == 'wms'
+    end
+
+    # Gets the url for a specific service endpoint if the item is
+    # public, has the same institution as the GBL instance, and the viewer
+    # protocol is not 'map' or nil. A module name is then dynamically generated
+    # from the viewer protocol, and if it's loaded, the image_url
+    # method is called.
+    def service_url
+      @service_url ||=
+        begin
+          return unless @document.available?
+
+          protocol = @document.viewer_protocol
+          if protocol == 'map' || protocol.nil?
+            @metadata['error'] = 'Unsupported viewer protocol'
+            @metadata['placeheld'] = true
+            return nil
+          end
+          "GeoblacklightSidecarImages::ImageService::#{protocol.camelcase}".constantize.image_url(@document, image_size)
+        rescue NameError
+          @metadata['error'] = 'service_url NameError'
+          @metadata['placeheld'] = true
+          return nil
+        end
+    end
+
+    # Retreives a url to a static thumbnail from the document's dct_references field, if it exists.
+    def image_reference
+      return nil if @document[@document.references.reference_field].nil?
+
+      JSON.parse(@document[@document.references.reference_field])['http://schema.org/thumbnailUrl']
+    end
+
+    # Default image size.
+    def image_size
+      1500
+    end
+
+    # Faraday timeout value.
+    def timeout
+      30
+    end
+
+    # Capture metadata within image harvest log
+    def log_output
+      @metadata['state'] = @document.sidecar.image_state.current_state
+      @metadata.each do |key, value|
+        @logger.tagged(@document.id, key.to_s) { @logger.info value }
+      end
+    end
+  end
+end