geo_works 0.1.0

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

@@ -0,0 +1,53 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class DateBuilder
+        attr_reader :geo_concern
+
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+        end
+
+        # Builds date fields such as layer year and modified date.
+        # @param [AbstractDocument] discovery document
+        def build(document)
+          document.layer_year = layer_year
+          document.layer_modified = layer_modified
+          document.issued = issued
+        end
+
+        private
+
+          # Returns a year associated with the layer. Taken from first
+          # value in temporal.
+          # @return [Integer] year
+          def layer_year
+            date = geo_concern.temporal.first
+            year = date.match(/(?<=\D|^)(\d{4})(?=\D|$)/)
+            year ? year[0].to_i : nil
+          rescue
+            ''
+          end
+
+          # Returns the date the work was modified.
+          # @return [String] date in XMLSchema format.
+          def layer_modified
+            datetime = geo_concern.layer_modified
+            # TODO: Rails 4 doesn't implement the timezone correctly -- it adds "+00:00" not "Z"
+            Rails::VERSION::MAJOR == 4 ? datetime.utc.strftime('%FT%TZ') : datetime.utc.xmlschema
+          end
+
+          # Returns the date the layer was issued.
+          # @return [String] date in XMLSchema format.
+          def issued
+            datetime = geo_concern.issued.first
+            datetime = DateTime.parse(datetime.to_s).utc
+            # TODO: Rails 4 doesn't implement the timezone correctly -- it adds "+00:00" not "Z"
+            Rails::VERSION::MAJOR == 4 ? datetime.utc.strftime('%FT%TZ') : datetime.utc.xmlschema
+          rescue
+            ''
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class DocumentHelper
+        include Rails.application.routes.url_helpers
+        include ActionDispatch::Routing::PolymorphicRoutes
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class DocumentPath
+        attr_reader :geo_concern
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+        end
+
+        # Returns url for geo concern show page.
+        # @return [String] geo concern show page url
+        def to_s
+          document_helper.polymorphic_url(geo_concern, host: host, protocol: protocol)
+        end
+
+        # Returns url for downloading the original file.
+        # @return [String] original file download url
+        def file_download
+          return unless file_set
+          hyrax_url_helpers.download_url(file_set, host: host, protocol: protocol)
+        end
+
+        # Returns url for downloading the metadata file.
+        # @param [String] metadata file format to download
+        # @return [String] metadata download url
+        def metadata_download(format)
+          return unless metadata_file_set
+          path = hyrax_url_helpers.download_url(metadata_file_set, host: host, protocol: protocol)
+          mime_type = metadata_file_set.solr_document[:geo_mime_type_ssim].first
+          path if MetadataFormatService.label(mime_type) == format
+        end
+
+        # Returns url for thumbnail image.
+        # @return [String] thumbnail url
+        def thumbnail
+          return unless file_download
+          "#{file_download}?file=thumbnail"
+        end
+
+        private
+
+          # Returns the first geo file set presenter attached to work.
+          # @return [FileSetPresenter] geo file set presenter
+          def file_set
+            return unless geo_concern.geo_file_set_presenters
+            geo_concern.geo_file_set_presenters.first
+          end
+
+          # Returns the first metadata file set presenter attached to work.
+          # @return [FileSetPresenter] metadata file set presenter
+          def metadata_file_set
+            return unless geo_concern.external_metadata_file_set_presenters
+            geo_concern.external_metadata_file_set_presenters.first
+          end
+
+          # Instantiates a DocumentHelper object.
+          # Used for access to rails url_helpers and poymorphic routes.
+          # @return [DocumentHelper] document helper
+          def document_helper
+            @helper ||= DocumentHelper.new
+          end
+
+          def hyrax_url_helpers
+            Hyrax::Engine.routes.url_helpers
+          end
+
+          # Indicates if the ssl is enabled.
+          # @return [Boolean] use ssl
+          def ssl?
+            geo_concern.request.protocol == 'https://'
+          end
+
+          # Returns protocol to use in url. Depends on ssl status.
+          # @return [Boolean] http protocol
+          def protocol
+            if ssl?
+              :https
+            else
+              :http
+            end
+          end
+
+          # Returns hostname (with port) to use in url.
+          # @return [String] hostname
+          def host
+            geo_concern.request.host_with_port
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class LayerInfoBuilder
+        attr_reader :geo_concern
+
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+        end
+
+        # Builds fields about the geospatial file such as geometry and format.
+        # @param [AbstractDocument] discovery document
+        def build(document)
+          document.geom_type = geom_type
+          document.format = format
+        end
+
+        private
+
+          # Uses parent work class to determine file geometry type.
+          # These geom types are used in geoblacklight documents.
+          # @return [String] file geometry type
+          def geom_type
+            case geo_concern.class.to_s
+            when /ImageWorkShowPresenter/
+              'Scanned Map'
+            when /RasterWorkShowPresenter/
+              'Raster'
+            when /VectorWorkShowPresenter/
+              vector_geom_type
+            end
+          end
+
+          # Uses file mime type to determine file format.
+          # @return [String] file format code
+          def format
+            if ImageFormatService.include? geo_mime_type
+              ImageFormatService.code(geo_mime_type)
+            elsif RasterFormatService.include? geo_mime_type
+              RasterFormatService.code(geo_mime_type)
+            elsif VectorFormatService.include? geo_mime_type
+              VectorFormatService.code(geo_mime_type)
+            end
+          end
+
+          # Returns the geometry for a vector file.
+          # @return [String] vector geometry
+          def vector_geom_type
+            # TODO: Get the geom type as part of a geo characterization service.
+            # "Point, Line, Polygon, Mixed"
+            'Mixed'
+          end
+
+          # Returns the 'geo' mime type of the first file attached to the work.
+          # @return [String] file mime type
+          def geo_mime_type
+            file_sets = geo_concern.geo_file_set_presenters
+            return if file_sets.nil? || file_sets.empty?
+            return unless (mime_types = file_sets.first.solr_document[:geo_mime_type_ssim])
+            mime_types.first
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class ReferencesBuilder
+        attr_reader :geo_concern, :path
+
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+          @path = DocumentBuilder.root_path_class.new(geo_concern)
+        end
+
+        # Builds service reference fields such as thumbnail and download url.
+        # @param [AbstractDocument] discovery document
+        def build(document)
+          document.wxs_identifier = wxs_identifier
+          build_metadata_refs(document)
+          build_download_refs(document)
+        end
+
+        private
+
+          # Builds metadata file references.
+          # @param [AbstractDocument] discovery document
+          def build_metadata_refs(document)
+            document.fgdc = fgdc
+            document.iso19139 = iso19139
+            document.mods = mods
+          end
+
+          # Builds geospatial file download references.
+          # @param [AbstractDocument] discovery document
+          def build_download_refs(document)
+            document.download = download
+            document.url = url
+            document.thumbnail = thumbnail
+            document.wxs_identifier = wxs_identifier
+            document.wms_path = wms_path
+            document.wfs_path = wfs_path
+          end
+
+          # Returns the identifier to use with WMS/WFS/WCS services.
+          # @return [String] wxs indentifier
+          def wxs_identifier
+            wxs.identifier
+          end
+
+          # Returns the wms server url.
+          # @return [String] wms server url
+          def wms_path
+            wxs.wms_path
+          end
+
+          # Returns the wfs server url.
+          # @return [String] wfs server url
+          def wfs_path
+            wxs.wfs_path
+          end
+
+          # Returns a url to access further descriptive information.
+          # @return [String] work show page url
+          def url
+            path.to_s
+          end
+
+          # Returns a direct file download url
+          # @return [String] direct file  url
+          def download
+            path.file_download
+          end
+
+          # Returns an FGDC metadata document download url
+          # @return [String] FGDC metadata document url
+          def fgdc
+            path.metadata_download('FGDC')
+          end
+
+          # Returns an ISO19139 metadata document download url
+          # @return [String] ISO19139 metadata document url
+          def iso19139
+            path.metadata_download('ISO19139')
+          end
+
+          # Returns an MODS metadata document download url
+          # @return [String] MODS metadata document url
+          def mods
+            path.metadata_download('MODS')
+          end
+
+          # Returns a thumbnail file url
+          # @return [String] thumbnail url
+          def thumbnail
+            path.thumbnail
+          end
+
+          def wxs
+            @wxs ||= Wxs.new(geo_concern)
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class SlugBuilder
+        attr_reader :geo_concern
+
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+        end
+
+        def build(document)
+          document.slug = slug
+        end
+
+        # Returns the document slug for use in discovery systems.
+        # @return [String] document slug
+        def slug
+          return geo_concern.id unless geo_concern.provenance
+          "#{geo_concern.provenance.parameterize}-#{geo_concern.id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class SpatialBuilder
+        attr_reader :geo_concern
+
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+        end
+
+        # Builds spatial fields such as bounding box and solr geometry.
+        # @param [AbstractDocument] discovery document
+        def build(document)
+          document.solr_coverage = to_solr
+        end
+
+        private
+
+          # Parses coverage field from geo work and instantiates a coverage object.
+          # @return [GeoWorks::Coverage] coverage object
+          def coverage
+            @coverage ||= GeoWorks::Coverage.parse(geo_concern.coverage.first)
+          end
+
+          # Returns the coverage in solr format. For example:
+          # `ENVELOPE(minX, maxX, maxY, minY)`
+          # @see 'https://cwiki.apache.org/confluence/display/solr/Spatial+Search'
+          # @return [String] coverage in solr format
+          def to_solr
+            "ENVELOPE(#{coverage.w}, #{coverage.e}, #{coverage.n}, #{coverage.s})"
+          rescue
+            ''
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module GeoWorks
+  module Discovery
+    class DocumentBuilder
+      class Wxs
+        attr_reader :geo_concern
+        def initialize(geo_concern)
+          @geo_concern = geo_concern
+          @config = GeoWorks::GeoServer.config[visibility].try(:with_indifferent_access)
+        end
+
+        # Returns the identifier to use with WMS/WFS/WCS services.
+        # @return [String] wxs indentifier
+        def identifier
+          return unless geo_file_set?
+          return file_set.id unless @config && visibility
+          "#{@config[:workspace]}:#{file_set.id}" if @config[:workspace]
+        end
+
+        # Returns the wms server url.
+        # @return [String] wms server url
+        def wms_path
+          return unless @config && visibility && geo_file_set?
+          "#{path}/#{@config[:workspace]}/wms"
+        end
+
+        # Returns the wfs server url.
+        # @return [String] wfs server url
+        def wfs_path
+          return unless @config && visibility && geo_file_set?
+          "#{path}/#{@config[:workspace]}/wfs"
+        end
+
+        private
+
+          # Gets the representative file set.
+          # @return [FileSet] representative file set
+          def file_set
+            @file_set ||= begin
+              representative_id = geo_concern.solr_document.representative_id
+              file_set_id = [representative_id]
+              geo_concern.member_presenters(file_set_id).first
+            end
+          end
+
+          # Tests if the file set is a geo file set.
+          # @return [Bool]
+          def geo_file_set?
+            return false unless file_set
+            @file_set_ids ||= geo_concern.geo_file_set_presenters.map(&:id)
+            @file_set_ids.include? file_set.id
+          end
+
+          # Returns the file set visibility if it's open and authenticated.
+          # @return [String] file set visibility
+          def visibility
+            return unless file_set
+            visibility = file_set.solr_document.visibility
+            visibility if valid_visibilities.include? visibility
+          end
+
+          def valid_visibilities
+            [Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC,
+             Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED]
+          end
+
+          # Geoserver base url.
+          # @return [String] geoserver base url
+          def path
+            @config[:url].chomp('/rest')
+          end
+      end
+    end
+  end
+end