geo_works 0.1.0

data/app/controllers/concerns/geo_works/file_sets_controller_behavior.rb

@@ -0,0 +1,31 @@
+module GeoWorks
+  module FileSetsControllerBehavior
+    extend ActiveSupport::Concern
+    included do
+      self.show_presenter = ::FileSetPresenter
+      self.form_class = Hyrax::Forms::FileSetEditForm
+    end
+
+    # Render geo file sets form if parent is a geo work
+    def new
+      if geo?
+        render 'geo_works/file_sets/new'
+      else
+        super
+      end
+    end
+
+    # inject mime_type into permitted params
+    def file_set_params
+      super.tap do |permitted_params|
+        permitted_params[:geo_mime_type] = params[:file_set][:geo_mime_type]
+      end
+    end
+
+    protected
+
+      def geo?
+        parent.image_work? || parent.raster_work? || parent.vector_work?
+      end
+  end
+end

data/app/controllers/concerns/geo_works/geoblacklight_controller_behavior.rb

@@ -0,0 +1,29 @@
+module GeoWorks
+  module GeoblacklightControllerBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      def geoblacklight
+        respond_to do |f|
+          f.json do
+            if builder.to_hash.fetch(:error, nil)
+              render json: builder, status: 404
+            else
+              render json: builder
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+      def document_class
+        Discovery::GeoblacklightDocument
+      end
+
+      def builder
+        @builder ||= Discovery::DocumentBuilder.new(presenter, document_class.new)
+      end
+  end
+end

data/app/controllers/concerns/geo_works/image_works_controller_behavior.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module ImageWorksControllerBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.show_presenter = GeoWorks::ImageWorkShowPresenter
+    end
+  end
+end

data/app/controllers/concerns/geo_works/raster_works_controller_behavior.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module RasterWorksControllerBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.show_presenter = GeoWorks::RasterWorkShowPresenter
+    end
+  end
+end

data/app/controllers/concerns/geo_works/vector_works_controller_behavior.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module VectorWorksControllerBehavior
+    extend ActiveSupport::Concern
+
+    included do
+      self.show_presenter = GeoWorks::VectorWorkShowPresenter
+    end
+  end
+end

data/app/forms/geo_works/basic_geo_metadata_form.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module BasicGeoMetadataForm
+    extend ActiveSupport::Concern
+    included do
+      self.terms += [:spatial, :temporal, :coverage, :issued]
+      self.required_fields += [:coverage]
+    end
+  end
+end

data/app/forms/geo_works/external_metadata_file_form.rb

@@ -0,0 +1,8 @@
+module GeoWorks
+  module ExternalMetadataFileForm
+    extend ActiveSupport::Concern
+    included do
+      self.terms += [:should_populate_metadata]
+    end
+  end
+end

data/app/forms/geo_works/georeferenced_form.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module GeoreferencedForm
+    extend ActiveSupport::Concern
+
+    included do
+      self.terms += [:cartographic_projection]
+    end
+  end
+end

data/app/forms/hyrax/image_work_form.rb

@@ -0,0 +1,7 @@
+module Hyrax
+  class ImageWorkForm < Hyrax::Forms::WorkForm
+    include ::GeoWorks::BasicGeoMetadataForm
+    include ::GeoWorks::ExternalMetadataFileForm
+    self.model_class = ::ImageWork
+  end
+end

data/app/forms/hyrax/raster_work_form.rb

@@ -0,0 +1,8 @@
+module Hyrax
+  class RasterWorkForm < Hyrax::Forms::WorkForm
+    include ::GeoWorks::BasicGeoMetadataForm
+    include ::GeoWorks::GeoreferencedForm
+    include ::GeoWorks::ExternalMetadataFileForm
+    self.model_class = ::RasterWork
+  end
+end

data/app/forms/hyrax/vector_work_form.rb

@@ -0,0 +1,8 @@
+module Hyrax
+  class VectorWorkForm < Hyrax::Forms::WorkForm
+    include ::GeoWorks::BasicGeoMetadataForm
+    include ::GeoWorks::GeoreferencedForm
+    include ::GeoWorks::ExternalMetadataFileForm
+    self.model_class = ::VectorWork
+  end
+end

data/app/helpers/geo_works/application_helper.rb

@@ -0,0 +1,4 @@
+module GeoWorks
+  module ApplicationHelper
+  end
+end

data/app/helpers/geo_works/bounding_box_helper.rb

@@ -0,0 +1,73 @@
+module GeoWorks
+  module BoundingBoxHelper
+    ##
+    # Builds HTML string for bounding box selector tool.
+    # Calls boundingBoxSelector javascript function and
+    # passes the id of the location input element that it binds to.
+    # @param [Symbol] name of property that holds bounding box string
+    # @return[String]
+    def bbox(property)
+      markup = ''
+      markup << %(<div id='bbox'></div>)
+      markup << bbox_display_inputs
+      markup << bbox_script_tag(property)
+      markup.html_safe
+    end
+
+    ##
+    # Returns markup for a row of read only bounding box inputs.
+    # @return[String]
+    # rubocop:disable MethodLength
+    def bbox_display_inputs
+      %(
+        <div class="row bbox-inputs">
+          <div class="col-md-3">
+            <div class="input-group">
+              <span class="input-group-addon"><div>North</div></span>
+              <input readonly id="bbox-north" type="text" class="form-control bbox-input">
+            </div>
+          </div>
+          <div class="col-md-3">
+            <div class="input-group">
+              <span class="input-group-addon"><div>East</div></span>
+              <input readonly id="bbox-east" type="text" class="form-control bbox-input">
+            </div>
+          </div>
+          <div class="col-md-3">
+            <div class="input-group">
+              <span class="input-group-addon"><div>South</div></span>
+              <input readonly id="bbox-south" type="text" class="form-control bbox-input">
+            </div>
+          </div>
+          <div class="col-md-3">
+            <div class="input-group">
+              <span class="input-group-addon"><div>West</div></span>
+              <input readonly id="bbox-west" type="text" class="form-control bbox-input">
+            </div>
+          </div>
+        </div>
+      )
+    end
+    # rubocop:enable MethodLength
+
+    ##
+    # Returns script tag markup for loading the bounding box selector.
+    # @param[Symbol] name of property that holds bounding box string
+    # @return[String] script tag
+    def bbox_script_tag(property)
+      %(
+        <script>
+          boundingBoxSelector({inputId: #{bbox_input_id(property)}});
+        </script>
+      )
+    end
+
+    ##
+    # Returns id of location input that is bound to bbox selector.
+    # @param [Symbol] name of property that holds bounding box string
+    # @return[String] id of location input element
+    def bbox_input_id(property)
+      "#{curation_concern.class.name.underscore}_#{property}"
+    end
+  end
+end

data/app/helpers/geo_works/file_set_actions_helper.rb

@@ -0,0 +1,31 @@
+module GeoWorks
+  module FileSetActionsHelper
+    def file_set_actions(presenter, locals = {})
+      render file_set_actions_partial(presenter),
+             locals.merge(file_set: presenter)
+    end
+
+    def file_set_actions_partial(file_set)
+      format = file_set_actions_format(file_set)
+      'geo_works/file_sets/actions/' +
+        if format
+          format
+        else
+          'default_actions'
+        end
+    end
+
+    def file_set_actions_format(file_set)
+      geo_mime_type = file_set.solr_document.fetch(:geo_mime_type_ssim, []).first
+      if GeoWorks::ImageFormatService.include?(geo_mime_type)
+        'image_actions'
+      elsif GeoWorks::VectorFormatService.include?(geo_mime_type)
+        'vector_actions'
+      elsif GeoWorks::RasterFormatService.include?(geo_mime_type)
+        'raster_actions'
+      elsif GeoWorks::MetadataFormatService.include?(geo_mime_type)
+        'metadata_actions'
+      end
+    end
+  end
+end

data/app/helpers/geo_works/geo_works_helper.rb

@@ -0,0 +1,22 @@
+module GeoWorks
+  module GeoWorksHelper
+    # Returns human readable name of child geo work type.
+    # @param [GeoWorksShowPresenter] geo work show presenter
+    # @return[String]
+    def child_geo_works_type(presenter)
+      case presenter.class.to_s
+      when /ImageWorkShowPresenter/
+        'Raster'
+      when /RasterWorkShowPresenter/
+        'Vector'
+      end
+    end
+
+    # Returns human readable name of geo work type.
+    # @param [GeoWorksShowPresenter] geo work show presenter
+    # @return[String]
+    def geo_work_type(presenter)
+      presenter.human_readable_type.sub('Work', '')
+    end
+  end
+end

data/app/helpers/geo_works/populate_metadata_helper.rb

@@ -0,0 +1,7 @@
+module GeoWorks
+  module PopulateMetadataHelper
+    def external_metadata_file_presenters
+      GeoWorksShowPresenter.new(curation_concern, nil).external_metadata_file_set_presenters
+    end
+  end
+end

data/app/jobs/geoblacklight_job.rb

@@ -0,0 +1,10 @@
+require 'uri'
+
+# Loads geoblacklight
+class GeoblacklightJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(message)
+    GeoWorks::GeoblacklightEventProcessor.new(message).process
+  end
+end

data/app/jobs/geoserver_delivery_job.rb

@@ -0,0 +1,36 @@
+require 'uri'
+
+##
+# Delivers derivatives to external services, like GeoServer
+##
+class GeoserverDeliveryJob < ActiveJob::Base
+  queue_as Hyrax.config.ingest_queue_name
+
+  attr_reader :file_set
+
+  ##
+  # Precondition is that all derivatives are created and saved.
+  # @param [FileSet] file_set
+  # @param [String] content_url contains the display copy to deliver
+  def perform(message)
+    @file_set = ActiveFedora::Base.find(message['id'])
+    uri = URI.parse(content_url)
+    return if uri.path == ''
+    GeoWorks::DeliveryService.new(file_set, uri.path).publish
+  end
+
+  def content_url
+    case file_set.geo_mime_type
+    when *GeoWorks::RasterFormatService.select_options.map(&:last)
+      return derivatives_service.send(:derivative_url, 'display_raster')
+    when *GeoWorks::VectorFormatService.select_options.map(&:last)
+      return derivatives_service.send(:derivative_url, 'display_vector')
+    else
+      return ''
+    end
+  end
+
+  def derivatives_service
+    GeoWorks::FileSetDerivativesService.new(file_set)
+  end
+end

data/app/models/concerns/geo_works/ability.rb

@@ -0,0 +1,12 @@
+module GeoWorks
+  module Ability
+    extend ActiveSupport::Concern
+    included do
+      self.ability_logic += [:geo_works_permissions]
+    end
+
+    def geo_works_permissions
+      alias_action :geoblacklight, to: :read
+    end
+  end
+end

data/app/models/concerns/geo_works/basic_geo_metadata.rb

@@ -0,0 +1,21 @@
+module GeoWorks
+  # Attributes and methods for basic geospatial metadata used by Works
+  module BasicGeoMetadata
+    extend ActiveSupport::Concern
+
+    included do
+      apply_schema ::GeoWorks::BasicGeoMetadataRequired,
+                   ActiveFedora::SchemaIndexingStrategy.new(
+                     ActiveFedora::Indexers::GlobalIndexer.new(
+                       [:stored_searchable, :facetable, :symbol]
+                     )
+                   )
+      apply_schema ::GeoWorks::BasicGeoMetadataOptional,
+                   ActiveFedora::SchemaIndexingStrategy.new(
+                     ActiveFedora::Indexers::GlobalIndexer.new(
+                       [:stored_searchable, :facetable, :symbol]
+                     )
+                   )
+    end
+  end
+end

data/app/models/concerns/geo_works/external_metadata_file_behavior.rb

@@ -0,0 +1,31 @@
+module GeoWorks
+  # Attributes and methods for vector metadata files
+  module ExternalMetadataFileBehavior
+    extend ActiveSupport::Concern
+    include ::GeoWorks::Extractors::Iso19139Helper
+    include ::GeoWorks::Extractors::FgdcHelper
+    include ::GeoWorks::Extractors::ModsHelper
+
+    # Extracts properties from the constitutent external metadata file
+    # @example
+    #   extract_iso19139_metadata
+    #   extract_fgdc_metadata
+    #   extract_mods_metadata
+    # @return [Hash]
+    def extract_metadata
+      raise ArgumentError, "MIME type unspecified or not configured" if schema.blank?
+      fn = "extract_#{schema.downcase}_metadata"
+      raise ArgumentError, "Unsupported metadata standard: #{schema}" unless respond_to?(fn.to_sym)
+      send(fn, metadata_xml)
+    end
+
+    # Retrives data from PCDM::File
+    def metadata_xml
+      Nokogiri::XML(original_file.content)
+    end
+
+    def schema
+      (MetadataFormatService.label(geo_mime_type) || '').parameterize(separator: '_')
+    end
+  end
+end

data/app/models/concerns/geo_works/extractors/fgdc_helper.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module Extractors
+    module FgdcHelper
+      def extract_fgdc_metadata(doc)
+        GeoWorks::Extractors::FgdcMetadataExtractor.new(doc).to_hash
+      end
+    end
+  end
+end

data/app/models/concerns/geo_works/extractors/fgdc_metadata_extractor.rb

@@ -0,0 +1,114 @@
+module GeoWorks
+  module Extractors
+    class FgdcMetadataExtractor
+      attr_reader :doc
+      def initialize(doc)
+        @doc = doc
+      end
+
+      def to_hash
+        metadata_required.merge(metadata_optional)
+      end
+
+      def metadata_required
+        {
+          coverage: coverage,
+          creator: creators,
+          description: [doc.at_xpath('//idinfo/descript/abstract').text],
+          title: [doc.at_xpath('//idinfo/citation/citeinfo/title').text]
+        }.compact
+      end
+
+      def metadata_optional
+        {
+          issued: issued,
+          publisher: publishers,
+          spatial: placenames,
+          subject: keywords,
+          temporal: timeperiods
+        }.compact
+      end
+
+      def coverage
+        doc.at_xpath('//idinfo/spdom/bounding').tap do |node|
+          return GeoWorks::Coverage.new(
+            coverage_coordinate(node, 'north'),
+            coverage_coordinate(node, 'east'),
+            coverage_coordinate(node, 'south'),
+            coverage_coordinate(node, 'west')
+          ).to_s
+        end
+        nil
+      end
+
+      def coverage_coordinate(node, direction)
+        node.at_xpath("#{direction}bc").text.to_f
+      end
+
+      def issued
+        doc.at_xpath('//idinfo/citation/citeinfo/pubdate').tap do |node|
+          return node.text[0..3].to_i unless node.nil? # extract year only
+        end
+        nil
+      end
+
+      def timeperiods
+        ::GeoWorks::TimePeriod.new(
+          extract_multivalued('//idinfo/keywords/temporal/tempkey'), doc
+        ).value
+      end
+
+      def publishers
+        extract_multivalued('//idinfo/citation/citeinfo/pubinfo/publish')
+      end
+
+      def creators
+        extract_multivalued('//idinfo/citation/citeinfo/origin')
+      end
+
+      def placenames
+        extract_multivalued('//idinfo/keywords/place/placekey')
+      end
+
+      def keywords
+        keywords = extract_multivalued('//idinfo/keywords/theme/themekey')
+        keywords.map! { |k| TOPIC_CATEGORIES[k.to_sym].present? ? TOPIC_CATEGORIES[k.to_sym] : k }
+        keywords.uniq!
+        keywords.present? ? keywords : nil
+      end
+
+      # ISO 19115 Topic Category
+      TOPIC_CATEGORIES = {
+        farming: 'Farming',
+        biota: 'Biology and Ecology',
+        climatologyMeteorologyAtmosphere: 'Climatology, Meteorology and Atmosphere',
+        boundaries: 'Boundaries',
+        elevation: 'Elevation',
+        environment: 'Environment',
+        geoscientificinformation: 'Geoscientific Information',
+        health: 'Health',
+        imageryBaseMapsEarthCover: 'Imagery and Base Maps',
+        intelligenceMilitary: 'Military',
+        inlandWaters: 'Inland Waters',
+        location: 'Location',
+        oceans: 'Oceans',
+        planningCadastre: 'Planning and Cadastral',
+        structure: 'Structures',
+        transportation: 'Transportation',
+        utilitiesCommunication: 'Utilities and Communication',
+        society: 'Society'
+      }.freeze
+
+      private
+
+        def extract_multivalued(xpath)
+          values = []
+          doc.xpath(xpath).each do |node|
+            values << node.text.strip
+          end
+          values.uniq!
+          values.present? ? values : nil
+        end
+    end
+  end
+end