geo_works 0.1.0

data/app/runners/geo_works/runners/raster_derivatives.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module Runners
+    class RasterDerivatives < Hydra::Derivatives::Runner
+      def self.processor_class
+        GeoWorks::Processors::Raster::Processor
+      end
+    end
+  end
+end

data/app/runners/geo_works/runners/vector_derivatives.rb

@@ -0,0 +1,9 @@
+module GeoWorks
+  module Runners
+    class VectorDerivatives < Hydra::Derivatives::Runner
+      def self.processor_class
+        GeoWorks::Processors::Vector::Processor
+      end
+    end
+  end
+end

data/app/schemas/geo_works/basic_geo_metadata_optional.rb

@@ -0,0 +1,40 @@
+module GeoWorks
+  class BasicGeoMetadataOptional < ActiveTriples::Schema
+    #
+    # The following properties are inherited from Curation Concerns' metadata
+    #
+    # @see https://github.com/projecthydra/hyrax/blob/v1.6.0/app/models/concerns/hyrax/basic_metadata.rb
+    # Optional:
+    #   :contributor
+    #   :creator
+    #   :date_created (DC.created)
+    #   :description
+    #   :identifier
+    #   :language
+    #   :part_of
+    #   :publisher
+    #   :resource_type (DC.type)
+    #   :rights (license)
+    #   :rights
+    #   :source
+    #   :subject
+    #   :tag (DC11.relation)
+    #
+
+    # Defines the placenames related to the layer
+    # @example
+    #   image.spatial = [ 'France', 'Spain' ]
+    property :spatial, predicate: ::RDF::Vocab::DC.spatial
+
+    # Defines the temporal coverage of the layer
+    # @example
+    #   vector.temporal = [ '1998-2006', 'circa 2000' ]
+    property :temporal, predicate: ::RDF::Vocab::DC.temporal
+
+    # Defines the issued date for the layer, using XML Schema dateTime format
+    #   (YYYY-MM-DDThh:mm:ssZ).
+    # @example
+    #   vector.issued = '2001-01-01T00:00:00Z'
+    property :issued, predicate: ::RDF::Vocab::DC.issued, multiple: false
+  end
+end

data/app/schemas/geo_works/basic_geo_metadata_required.rb

@@ -0,0 +1,25 @@
+module GeoWorks
+  class BasicGeoMetadataRequired < ActiveTriples::Schema
+    #
+    # The following properties are inherited from Curation Concerns' metadata
+    #
+    # @see https://github.com/projecthydra/hyrax/blob/v1.6.0/app/models/concerns/hyrax/required_metadata.rb
+    # Required:
+    #   :title
+    #   :date_uploaded (DC.dateSubmitted)
+    #   :date_modified (DC.modified)
+    #
+
+    # Defines the bounding box for the layer.
+    # We always assert units of decimal degrees and EPSG:4326 projection.
+    # @see http://dublincore.org/documents/dcmi-box/
+    # @example
+    #   vector.coverage = 'northlimit=43.039; eastlimit=-69.856; southlimit=42.943; westlimit=-71.032; units=degrees; projection=EPSG:4326'
+    property :coverage, predicate: ::RDF::Vocab::DC11.coverage, multiple: false
+
+    # Defines the institution which holds the layer
+    # @example
+    #   raster.provenance = 'Stanford University'
+    property :provenance, predicate: ::RDF::Vocab::DC.provenance, multiple: false
+  end
+end

data/app/schemas/geo_works/file_set_metadata_required.rb

@@ -0,0 +1,5 @@
+module GeoWorks
+  class FileSetMetadataRequired < ActiveTriples::Schema
+    property :geo_mime_type, predicate: RDF::Vocab::EBUCore.hasMimeType, multiple: false
+  end
+end

data/app/services/geo_works/authority_service.rb

@@ -0,0 +1,29 @@
+module GeoWorks
+  module AuthorityService
+    extend ActiveSupport::Concern
+
+    included do
+      mattr_accessor :authority
+    end
+
+    class_methods do
+      def select_options
+        authority.all.map do |element|
+          [element[:label], element[:id]]
+        end
+      end
+
+      def label(id)
+        (authority.find(id) || {}).fetch('term', nil)
+      end
+
+      def code(id)
+        (authority.find(id) || {}).fetch('code', nil)
+      end
+
+      def include?(id)
+        !authority.find(id).nil? && !authority.find(id).empty?
+      end
+    end
+  end
+end

data/app/services/geo_works/delivery/geoserver.rb

@@ -0,0 +1,118 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'rgeoserver'
+require 'yaml'
+require 'erb'
+
+module GeoWorks
+  module Delivery
+    class Geoserver
+      attr_reader :config, :workspace_name, :file_set, :file_path
+
+      def initialize(file_set, file_path)
+        @file_set = file_set
+        @file_path = file_path
+        @config = fetch_config
+        @workspace_name = @config[:workspace]
+        validate!
+      end
+
+      def catalog
+        @catalog ||= RGeoServer.catalog(config)
+      end
+
+      def publish
+        case type
+        when :vector
+          publish_vector
+        when :raster
+          publish_raster
+        end
+      rescue StandardError => e
+        Rails.logger.error("GeoServer delivery job failed with: #{e}")
+      end
+
+      private
+
+        def fetch_config
+          raise ArgumentError, "FileSet visibility must be open or authenticated" unless visibility
+          GeoWorks::GeoServer.config[visibility]
+        end
+
+        def visibility
+          return file_set.visibility if file_set.visibility == 'open'
+          return file_set.visibility if file_set.visibility == 'authenticated'
+        end
+
+        def validate!
+          %w(url user password).map(&:to_sym).each do |k|
+            raise ArgumentError, "Missing #{k} in configuration" unless config[k].present?
+          end
+        end
+
+        def type
+          return :vector if file_path =~ /\.zip$/
+          return :raster if file_path =~ /\.tif$/
+          raise ArgumentError, "Not a ZIPed Shapefile or GeoTIFF: #{file_path}"
+        end
+
+        def workspace
+          workspace = RGeoServer::Workspace.new catalog, name: workspace_name
+          workspace.save if workspace.new?
+          workspace
+        end
+
+        def datastore
+          @datastore ||= RGeoServer::DataStore.new catalog, workspace: workspace,
+                                                            name: file_set.id
+        end
+
+        def coveragestore
+          @coveragestore ||= RGeoServer::CoverageStore.new catalog, workspace: workspace,
+                                                                    name: file_set.id
+        end
+
+        def base_path(path)
+          path.gsub(Hyrax.config.derivatives_path.to_s, '')
+        end
+
+        def shapefile_dir
+          "#{File.dirname(file_path)}/#{File.basename(file_path, '.zip')}"
+        end
+
+        def persist_coveragestore
+          url = "file:///#{@config[:derivatives_path]}#{base_path(file_path)}"
+          coveragestore.url = url
+          coveragestore.enabled = 'true'
+          coveragestore.data_type = 'GeoTIFF'
+          coveragestore.save
+        end
+
+        def persist_coverage
+          coverage = RGeoServer::Coverage.new catalog, workspace: workspace,
+                                                       coverage_store: coveragestore,
+                                                       name: coveragestore.name
+          coverage.title = coveragestore.name
+          coverage.metadata_links = []
+          coverage.save
+        end
+
+        def publish_vector
+          # Delete existing shapefile
+          FileUtils.rm_rf(shapefile_dir)
+
+          # Unzip derivative shapefiles
+          system "unzip -o #{file_path} -d #{shapefile_dir}"
+
+          shape_path = Dir.glob("#{shapefile_dir}/*.shp").first
+          raise Errno::ENOENT, 'Shapefile not found' unless shape_path
+          url = "file:///#{@config[:derivatives_path]}#{base_path(shape_path)}"
+          datastore.upload_external url, publish: true
+        end
+
+        def publish_raster
+          persist_coveragestore
+          persist_coverage
+        end
+    end
+  end
+end

data/app/services/geo_works/delivery_service.rb

@@ -0,0 +1,11 @@
+module GeoWorks
+  class DeliveryService
+    attr_reader :geoserver
+
+    def initialize(file_set, file_path)
+      @geoserver = GeoWorks::Delivery::Geoserver.new(file_set, file_path)
+    end
+
+    delegate :publish, to: :geoserver
+  end
+end

data/app/services/geo_works/discovery.rb

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

data/app/services/geo_works/discovery/abstract_document.rb

@@ -0,0 +1,37 @@
+module GeoWorks
+  module Discovery
+    class AbstractDocument
+      attr_accessor :identifier, :provenance, :creator, :subject, :spatial, :temporal,
+                    :title, :description, :access_rights, :language, :issued,
+                    :publisher, :slug, :solr_coverage, :layer_year,
+                    :layer_modified, :geom_type, :format, :resource_type, :wxs_identifier,
+                    :dct_references, :fgdc, :iso19139, :mods, :download, :url, :thumbnail,
+                    :wxs_identifier, :wms_path, :wfs_path
+
+      # Cleans the document hash by removing unused fields.
+      # @param [Hash] document hash
+      # @return [Hash] cleaned document hash
+      def clean_document(hash)
+        hash.delete_if do |_k, v|
+          begin
+            v.nil? || v.empty?
+          rescue
+            false
+          end
+        end
+      end
+
+      def to_hash(_arg)
+        raise 'this method should be overriden and return the document as a hash'
+      end
+
+      def to_json(_arg)
+        raise 'this method should be overriden and return the document as json'
+      end
+
+      def to_xml(_arg)
+        raise 'this method should be overriden and return the document as xml'
+      end
+    end
+  end
+end

data/app/services/geo_works/discovery/document_builder.rb

@@ -0,0 +1,46 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class_attribute :services, :root_path_class
+
+      # Array of document builder services.
+      # - BasicMetadataBuilder: builds fields such as id, subject, and publisher.
+      # - SpatialBuilder: builds spatial fields such as bounding box and solr geometry.
+      # - DateBuilder: builds date fields such as layer year and modified date.
+      # - ReferencesBuilder: builds service reference fields such as thumbnail and download url.
+      # - LayerInfoBuilder: builds fields about the geospatial file such as geometry and format.
+      # - SlugBuilder: builds the Geoblacklight slug field.
+      self.services = [
+        BasicMetadataBuilder,
+        SpatialBuilder,
+        DateBuilder,
+        ReferencesBuilder,
+        LayerInfoBuilder,
+        SlugBuilder
+      ]
+
+      # Class used to generate urls for links in the document.
+      self.root_path_class = DocumentPath
+
+      def initialize(geo_concern, document)
+        @geo_concern = geo_concern
+        @document = document
+        builders.build(document)
+      end
+
+      attr_reader :geo_concern, :document
+      delegate :to_json, :to_xml, :to_hash, to: :document
+
+      private
+
+        # Instantiates a CompositeBuilder object with an array of
+        # builder instances that are used to create the document.
+        # @return [CompositeBuilder] composite builder for document
+        def builders
+          @builders ||= CompositeBuilder.new(
+            services.map { |service| service.new(geo_concern) }
+          )
+        end
+    end
+  end
+end

data/app/services/geo_works/discovery/document_builder/basic_metadata_builder.rb

@@ -0,0 +1,71 @@
+##
+# Workaround for setting the identifier in the geoblacklight document
+# Remove once
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class BasicMetadataBuilder
+        attr_reader :geo_concern
+
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+        end
+
+        # Builds fields such as id, subject, and publisher.
+        # @param [AbstractDocument] discovery document
+        def build(document)
+          build_simple_attributes(document)
+          build_complex_attributes(document)
+        end
+
+        private
+
+          # Returns an array of attributes to add to document.
+          # @return [Array] attributes
+          def simple_attributes
+            [:creator, :subject, :spatial, :temporal,
+             :title, :provenance, :language, :publisher]
+          end
+
+          # Builds simple metadata attributes.
+          # @param [AbstractDocument] discovery document
+          def build_simple_attributes(document)
+            simple_attributes.each do |a|
+              document.send("#{a}=", geo_concern.send(a.to_s))
+            end
+          end
+
+          # Builds more complex metadata attributes.
+          # @param [AbstractDocument] discovery document
+          def build_complex_attributes(document)
+            document.identifier = identifier
+            document.description = description
+            document.access_rights = geo_concern.solr_document.visibility
+          end
+
+          # Returns the work indentifier. This is (usually) different from the hydra/fedora work id.
+          # The identifier might be an ARK, DOI, PURL, etc.
+          # If identifier is not set, the work id is used.
+          # @return [String] identifier
+          def identifier
+            identifiers = geo_concern.identifier
+            if identifiers.nil? || identifiers.empty?
+              geo_concern.id
+            elsif identifiers.is_a?(String)
+              identifiers
+            else
+              identifiers.first
+            end
+          end
+
+          # Returns the work description. If none is available,
+          # a basic description is created.
+          # @return [String] description
+          def description
+            return geo_concern.description.first if geo_concern.description.first
+            "A #{geo_concern.human_readable_type.downcase} object."
+          end
+      end
+    end
+  end
+end

data/app/services/geo_works/discovery/document_builder/composite_builder.rb

@@ -0,0 +1,21 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class CompositeBuilder
+        attr_reader :services
+
+        def initialize(services)
+          @services = services
+        end
+
+        # Runs each builder service to build a discovery document.
+        # @param [AbstractDocument] discovery document
+        def build(document)
+          services.each do |service|
+            service.build(document)
+          end
+        end
+      end
+    end
+  end
+end