geoblacklight_sidecar_images 0.5.1 → 0.6.0

data/app/assets/config/geoblacklight_sidecar_images_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/geoblacklight_sidecar_images .js
-//= link_directory ../stylesheets/geoblacklight_sidecar_images .css

data/app/assets/javascripts/geoblacklight_sidecar_images/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

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

@@ -1,15 +0,0 @@
-/*
- * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/lib/generators/geoblacklight_sidecar_images/services_generator.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-
-module GeoblacklightSidecarImages
-  class ServicesGenerator < Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
-
-    desc <<-DESCRIPTION
-      This generator makes the following changes to your application:
-       1. Creates an app/services directory
-       2. Creates service models within the app/services directory
-    DESCRIPTION
-
-    def create_services
-      directory 'services', 'app/services'
-    end
-  end
-end

data/lib/generators/geoblacklight_sidecar_images/templates/assets/javascripts/geoblacklight.js

@@ -1,9 +0,0 @@
-//= require geoblacklight/geoblacklight
-//= require geoblacklight/basemaps
-//= require geoblacklight/controls
-//= require geoblacklight/viewers
-//= require geoblacklight/modules
-//= require geoblacklight/downloaders
-//= require leaflet-iiif
-//= require esri-leaflet
-//= require readmore.min

data/lib/generators/geoblacklight_sidecar_images/templates/assets/stylesheets/geoblacklight.scss

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

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-class StoreImageJob < ApplicationJob
-  queue_as :default
-
-  def perform(solr_document_id)
-    cat = CatalogController.new
-    _response, document = cat.fetch(solr_document_id)
-
-    metadata = {}
-    metadata['solr_doc_id'] = document.id
-    metadata['solr_version'] = document.sidecar.version
-
-    document.sidecar.image_state.transition_to!(:queued, metadata)
-    ImageService.new(document).store
-  end
-end

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

@@ -1,224 +0,0 @@
-# frozen_string_literal: true
-
-require 'addressable/uri'
-require 'mimemagic'
-
-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
-        "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

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-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

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-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

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-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

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-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

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-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