geoblacklight 2.3.0

data/lib/generators/geoblacklight/templates/webpacker.yml

@@ -0,0 +1,67 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  resolved_paths: []
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  extensions:
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development: &development
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    compress: true
+    disable_host_check: true
+    use_local_ip: false
+    quiet: false
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    watch_options:
+      ignored: /node_modules/
+
+
+test:
+  <<: *development
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/lib/generators/geoblacklight/webpacker_generator.rb

@@ -0,0 +1,35 @@
+require 'rails/generators'
+
+module Geoblacklight
+  class Webpacker < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Integrate Webpacker for GeoBlacklight'
+
+    def webpacker_install
+      run 'bundle exec rails webpacker:install'
+    end
+
+    def webpacker_config
+      copy_file 'webpacker.yml', 'config/webpacker.yml'
+    end
+
+    def procfile
+      copy_file 'Procfile', 'Procfile'
+    end
+
+    def javascript_install
+      # This overrides the default dependencies specified using
+      # webpacker:install
+      copy_file 'package.json', 'package.json'
+      yarn_available = system('yarn --version')
+      if yarn_available
+        run 'yarn install'
+        run 'yarn upgrade'
+      else
+        run 'npm install'
+        run 'npm update'
+      end
+    end
+  end
+end

data/lib/geoblacklight.rb

@@ -0,0 +1,50 @@
+require 'active_support/dependencies'
+require 'geoblacklight/engine'
+
+module Geoblacklight
+  require 'geoblacklight/bounding_box'
+  require 'geoblacklight/catalog_helper_override'
+  require 'geoblacklight/constants'
+  # require 'geoblacklight/controller_override'
+  require 'geoblacklight/exceptions'
+  require 'geoblacklight/geoblacklight_helper_behavior'
+  require 'geoblacklight/view_helper_override'
+  require 'geoblacklight/item_viewer'
+  require 'geoblacklight/wms_layer'
+  require 'geoblacklight/wms_layer/feature_info_response'
+  require 'geoblacklight/download'
+  require 'geoblacklight/download/geojson_download'
+  require 'geoblacklight/download/geotiff_download'
+  require 'geoblacklight/download/kmz_download'
+  require 'geoblacklight/download/shapefile_download'
+  require 'geoblacklight/download/hgl_download'
+  require 'geoblacklight/metadata'
+  require 'geoblacklight/metadata/base'
+  require 'geoblacklight/metadata/fgdc'
+  require 'geoblacklight/metadata/html'
+  require 'geoblacklight/metadata/iso19139'
+  require 'geoblacklight/metadata_transformer'
+  require 'geoblacklight/metadata_transformer/base'
+  require 'geoblacklight/metadata_transformer/fgdc'
+  require 'geoblacklight/metadata_transformer/iso19139'
+  require 'geoblacklight/reference'
+  require 'geoblacklight/references'
+  require 'geoblacklight/routes'
+  require 'geoblacklight/relation/descendants'
+  require 'geoblacklight/relation/ancestors'
+  require 'geoblacklight/relation/relation_response'
+
+  def self.inject!
+    # CatalogController.send(:include, Geoblacklight::ControllerOverride)
+    CatalogController.send(:include, Geoblacklight::CatalogHelperOverride)
+    CatalogController.send(:include, Geoblacklight::ViewHelperOverride)
+    CatalogController.send(:helper, Geoblacklight::ViewHelperOverride) unless
+      CatalogController.helpers.is_a?(Geoblacklight::ViewHelperOverride)
+    SearchHistoryController.send(:helper, Geoblacklight::ViewHelperOverride) unless
+      SearchHistoryController.helpers.is_a?(Geoblacklight::ViewHelperOverride)
+  end
+
+  def self.logger
+    ::Rails.logger
+  end
+end

data/lib/geoblacklight/bounding_box.rb

@@ -0,0 +1,45 @@
+module Geoblacklight
+  ##
+  # Transforms and parses a bounding box for various formats
+  class BoundingBox
+    ##
+    # @param [String, Integer, Float] west
+    # @param [String, Integer, Float] south
+    # @param [String, Integer, Float] east
+    # @param [String, Integer, Float] north
+    def initialize(west, south, east, north)
+      @west = west
+      @south = south
+      @east = east
+      @north = north
+      # TODO: check for valid Geometry and raise if not
+    end
+
+    ##
+    # Returns a bounding box in ENVELOPE syntax
+    # @return [String]
+    def to_envelope
+      "ENVELOPE(#{west}, #{east}, #{north}, #{south})"
+    end
+
+    ##
+    # Create a Geoblacklight::BoundingBox from a Solr rectangle syntax
+    # @param [String] bbox as "W S E N"
+    # @return [Geoblacklight::BoundingBox]
+    def self.from_rectangle(rectangle)
+      rectangle_array = rectangle.split(' ')
+      message = 'Bounding box should be a string in Solr rectangle syntax e.g."W S E N"'
+      fail Geoblacklight::Exceptions::WrongBoundingBoxFormat, message if rectangle_array.count != 4
+      new(
+        rectangle_array[0],
+        rectangle_array[1],
+        rectangle_array[2],
+        rectangle_array[3]
+      )
+    end
+
+    private
+
+    attr_reader :west, :south, :east, :north
+  end
+end

data/lib/geoblacklight/catalog_helper_override.rb

@@ -0,0 +1,13 @@
+module Geoblacklight
+  module CatalogHelperOverride
+    ##
+    # Removes spatial query from params
+    # @param [Symbol] symbol of field to be removed
+    # @param [Hash] request parameters
+    def remove_spatial_filter_group(field, source_params = params)
+      p = source_params.dup
+      p.delete(field.to_s)
+      p
+    end
+  end
+end

data/lib/geoblacklight/constants.rb

@@ -0,0 +1,28 @@
+module Geoblacklight
+  # Module to declare application level constants and lookup hash
+  module Constants
+    URI = {
+      download: 'http://schema.org/downloadUrl',
+      fgdc: 'http://www.opengis.net/cat/csw/csdgm',
+      geojson: 'http://geojson.org/geojson-spec.html',
+      html: 'http://www.w3.org/1999/xhtml',
+      iiif: 'http://iiif.io/api/image',
+      iiif_manifest: 'http://iiif.io/api/presentation#manifest',
+      iso19139: 'http://www.isotc211.org/schemas/2005/gmd',
+      mods: 'http://www.loc.gov/mods/v3',
+      shapefile: 'http://www.esri.com/library/whitepapers/pdfs/shapefile.pdf',
+      url: 'http://schema.org/url',
+      wcs: 'http://www.opengis.net/def/serviceType/ogc/wcs',
+      wfs: 'http://www.opengis.net/def/serviceType/ogc/wfs',
+      wms: 'http://www.opengis.net/def/serviceType/ogc/wms',
+      hgl: 'http://schema.org/DownloadAction',
+      feature_layer: 'urn:x-esri:serviceType:ArcGIS#FeatureLayer',
+      tiled_map_layer: 'urn:x-esri:serviceType:ArcGIS#TiledMapLayer',
+      dynamic_map_layer: 'urn:x-esri:serviceType:ArcGIS#DynamicMapLayer',
+      image_map_layer: 'urn:x-esri:serviceType:ArcGIS#ImageMapLayer',
+      data_dictionary: 'http://lccn.loc.gov/sh85035852',
+      index_map: 'https://openindexmaps.org',
+      oembed: 'https://oembed.com'
+    }.freeze
+  end
+end

data/lib/geoblacklight/download.rb

@@ -0,0 +1,108 @@
+module Geoblacklight
+  class Download
+    def initialize(document, options = {})
+      @document = document
+      @options = options
+    end
+
+    def downloadable?
+      @document.downloadable?
+    end
+
+    def file_name
+      "#{@document.id}-#{@options[:type]}.#{@options[:extension]}"
+    end
+
+    def self.file_path
+      Settings.DOWNLOAD_PATH || "#{Rails.root}/tmp/cache/downloads"
+    end
+
+    def file_path_and_name
+      "#{self.class.file_path}/#{file_name}"
+    end
+
+    def download_exists?
+      File.file?(file_path_and_name)
+    end
+
+    def get
+      if download_exists?
+        file_name
+      else
+        create_download_file
+      end
+    end
+
+    ##
+    # Creates temporary file on file system and renames it if download completes
+    # successfully. Will raise and rescue if the wrong file format is downloaded
+    # @return [String] filename of the completed download
+    def create_download_file
+      download = initiate_download
+
+      File.open("#{file_path_and_name}.tmp", 'wb') do |file|
+        fail Geoblacklight::Exceptions::WrongDownloadFormat unless matches_mimetype?(download)
+        file.write download.body
+      end
+      File.rename("#{file_path_and_name}.tmp", file_path_and_name)
+      file_name
+    rescue Geoblacklight::Exceptions::WrongDownloadFormat => error
+      Geoblacklight.logger.error "#{error} expected #{@options[:content_type]} "\
+                                 "received #{download.headers['content-type']}"
+      File.delete("#{file_path_and_name}.tmp")
+      raise Geoblacklight::Exceptions::ExternalDownloadFailed, message: 'Wrong download type'
+    end
+
+    ##
+    # Initiates download from a remote source url using the `request_params`.
+    # Will catch Faraday::ConnectionFailed and
+    # Faraday::TimeoutError
+    # @return [Faraday::Request] returns a Faraday::Request object
+    def initiate_download
+      conn = Faraday.new(url: url)
+      conn.get do |request|
+        request.params = @options[:request_params]
+        request.options.timeout = timeout
+        request.options.open_timeout = timeout
+      end
+    rescue Faraday::ConnectionFailed
+      raise Geoblacklight::Exceptions::ExternalDownloadFailed,
+            message: 'Download connection failed',
+            url: conn.url_prefix.to_s
+    rescue Faraday::TimeoutError
+      raise Geoblacklight::Exceptions::ExternalDownloadFailed,
+            message: 'Download timed out',
+            url: conn.url_prefix.to_s
+    end
+
+    ##
+    # Creates a download url for the object
+    # @return [String]
+    def url_with_params
+      url + '/?' + URI.encode_www_form(@options[:request_params])
+    end
+
+    private
+
+    def matches_mimetype?(download)
+      MIME::Type.simplified(download.headers['content-type']) == @options[:content_type]
+    end
+
+    ##
+    # Returns timeout for the download request. `timeout` passed as an option to
+    # the Geoblacklight::Download class
+    # @return [Fixnum] download timeout in seconds
+    def timeout
+      @options[:timeout] || Settings.TIMEOUT_DOWNLOAD || 20
+    end
+
+    ##
+    # URL for download
+    # @return [String] URL that is checked in download
+    def url
+      url = @document.references.send(@options[:service_type]).endpoint
+      url += '/reflect' if @options[:reflect]
+      url
+    end
+  end
+end

data/lib/geoblacklight/download/geojson_download.rb

@@ -0,0 +1,22 @@
+module Geoblacklight
+  class GeojsonDownload < Geoblacklight::Download
+    GEOJSON_DOWNLOAD_PARAMS = {
+      service: 'wfs',
+      version: '2.0.0',
+      request: 'GetFeature',
+      srsName: 'EPSG:4326',
+      outputformat: 'application/json'
+    }.freeze
+
+    def initialize(document, options = {})
+      request_params = GEOJSON_DOWNLOAD_PARAMS.merge(typeName: document[:layer_id_s])
+      super(document, {
+        type: 'geojson',
+        extension: 'json',
+        request_params: request_params,
+        content_type: 'application/json',
+        service_type: 'wfs'
+      }.merge(options))
+    end
+  end
+end

data/lib/geoblacklight/download/geotiff_download.rb

@@ -0,0 +1,20 @@
+module Geoblacklight
+  class GeotiffDownload < Geoblacklight::Download
+    GEOTIFF_DOWNLOAD_PARAMS = {
+      format: 'image/geotiff',
+      width: 4096
+    }.freeze
+
+    def initialize(document, options = {})
+      request_params = GEOTIFF_DOWNLOAD_PARAMS.merge(layers: document[:layer_id_s])
+      super(document, {
+        type: 'geotiff',
+        extension: 'tif',
+        request_params: request_params,
+        content_type: 'image/geotiff',
+        service_type: 'wms',
+        reflect: true
+      }.merge(options))
+    end
+  end
+end

data/lib/geoblacklight/download/hgl_download.rb

@@ -0,0 +1,18 @@
+module Geoblacklight
+  class HglDownload < Geoblacklight::Download
+    def initialize(document, email, options = {})
+      request_params = {
+        'LayerName' => document[:layer_id_s].sub(/^cite:/, ''),
+        'UserEmail' => email
+      }
+      super(document, {
+        request_params: request_params,
+        service_type: 'hgl'
+      }.merge(options))
+    end
+
+    def get
+      initiate_download
+    end
+  end
+end

data/lib/geoblacklight/download/kmz_download.rb

@@ -0,0 +1,22 @@
+module Geoblacklight
+  class KmzDownload < Geoblacklight::Download
+    KMZ_DOWNLOAD_PARAMS = { service: 'wms',
+                            version: '1.1.0',
+                            request: 'GetMap',
+                            srsName: 'EPSG:900913',
+                            format: 'application/vnd.google-earth.kmz',
+                            width: 2000, height: 2000 }.freeze
+
+    def initialize(document, options = {})
+      bbox_wsen = document.bounding_box_as_wsen.split(' ').join(', ')
+      request_params = KMZ_DOWNLOAD_PARAMS.merge(layers: document[:layer_id_s], bbox: bbox_wsen)
+      super(document, {
+        type: 'kmz',
+        extension: 'kmz',
+        request_params: request_params,
+        content_type: 'application/vnd.google-earth.kmz',
+        service_type: 'wms'
+      }.merge(options))
+    end
+  end
+end

data/lib/geoblacklight/download/shapefile_download.rb

@@ -0,0 +1,20 @@
+module Geoblacklight
+  class ShapefileDownload < Geoblacklight::Download
+    SHAPEFILE_DOWNLOAD_PARAMS = { service: 'wfs',
+                                  version: '2.0.0',
+                                  request: 'GetFeature',
+                                  srsName: 'EPSG:4326',
+                                  outputformat: 'SHAPE-ZIP' }.freeze
+
+    def initialize(document, options = {})
+      request_params = SHAPEFILE_DOWNLOAD_PARAMS.merge(typeName: document[:layer_id_s])
+      super(document, {
+        type: 'shapefile',
+        extension: 'zip',
+        request_params: request_params,
+        content_type: 'application/zip',
+        service_type: 'wfs'
+      }.merge(options))
+    end
+  end
+end