geoblacklight 0.7.0 → 0.7.1

data/app/views/catalog/metadata.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'metadata' %>

data/app/views/catalog/metadata.js.erb

@@ -0,0 +1,7 @@
+<div class="modal-header">
+  <button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
+  <h1 class="modal-title">Metadata</h1>
+  <div class="modal-body">
+    <%= render partial: 'metadata' %>
+  </div>
+</div>

data/config/locales/geoblacklight.en.yml

@@ -21,3 +21,6 @@ en:
     references:
       wms: 'Web Mapping Service (WMS)'
       wfs: 'Web Feature Service (WFS)'
+      iso19139: 'ISO 19139'
+      mods: 'MODS'
+      fgdc: 'FGDC'

data/geoblacklight.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'font-awesome-rails', '~> 4.1.0.0'
   spec.add_dependency 'rails_config'
   spec.add_dependency 'faraday'
+  spec.add_dependency 'coderay'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.3.2'

data/lib/generators/geoblacklight/templates/catalog_controller.rb

@@ -208,6 +208,8 @@ class CatalogController < ApplicationController
 
     # Custom tools for GeoBlacklight
     config.add_show_tools_partial :web_services, if: proc { |_context, _config, options| (Settings.WEBSERVICES_SHOWN & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
+    config.add_show_tools_partial :metadata, if: proc { |_context, _config, options| (Settings.METADATA_SHOWN & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
+    config.add_show_tools_partial :downloads, partial: 'downloads'
   end
 
 

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

@@ -1,9 +1,15 @@
 #Main Solr geometry field used for spatial search and bounding box. Should be type 'rpt'
-GEOMETRY_FIELD: 'solr_bbox'
+GEOMETRY_FIELD: 'solr_geom'
 
 # Institution deployed at
 INSTITUTION: 'Stanford'
 
+# Metadata shown in tool panel
+METADATA_SHOWN:
+  - 'fgdc'
+  - 'iso19139'
+  - 'mods'
+
 # (For external Download) timeout and open_timeout parameters for Faraday
 TIMEOUT_DOWNLOAD: 16
 

data/lib/geoblacklight.rb

@@ -17,6 +17,7 @@ module Geoblacklight
   require 'geoblacklight/download/kmz_download'
   require 'geoblacklight/download/shapefile_download'
   require 'geoblacklight/download/hgl_download'
+  require 'geoblacklight/metadata'
   require 'geoblacklight/reference'
   require 'geoblacklight/references'
   require 'geoblacklight/routes'

data/lib/geoblacklight/controller_override.rb

@@ -18,5 +18,9 @@ module Geoblacklight
     def web_services
       @response, @document = get_solr_response_for_doc_id params[:id]
     end
+
+    def metadata
+      @response, @document = get_solr_response_for_doc_id params[:id]
+    end
   end
 end

data/lib/geoblacklight/download.rb

@@ -1,72 +1,84 @@
-class Download
-  def initialize(document, options = {})
-    @document = document
-    @options = options
-  end
+module Geoblacklight
+  class Download
+    def initialize(document, options = {})
+      @document = document
+      @options = options
+    end
 
-  def downloadable?
-    @document.downloadable?
-  end
+    def downloadable?
+      @document.downloadable?
+    end
 
-  def file_name
-    "#{@document[:layer_slug_s]}-#{@options[:type]}.#{@options[:extension]}"
-  end
+    def file_name
+      "#{@document[:layer_slug_s]}-#{@options[:type]}.#{@options[:extension]}"
+    end
 
-  def file_path
-    "#{Rails.root}/tmp/cache/downloads/#{file_name}"
-  end
+    def file_path
+      "#{Rails.root}/tmp/cache/downloads/#{file_name}"
+    end
 
-  def download_exists?
-    File.file?(file_path)
-  end
+    def download_exists?
+      File.file?(file_path)
+    end
 
-  def get
-    if download_exists?
-      file_name
-    else
-      create_download_file
+    def get
+      if download_exists?
+        file_name
+      else
+        create_download_file
+      end
     end
-  end
 
-  def create_download_file
-    download = initiate_download
-    unless download.present?
-      raise Geoblacklight::Exceptions::ExternalDownloadFailed
+    def create_download_file
+      download = initiate_download
+      unless download.present?
+        raise Geoblacklight::Exceptions::ExternalDownloadFailed
+      end
+      File.open("#{file_path}.tmp", 'wb')  do |file|
+        if download.headers['content-type'] == @options[:content_type]
+          file.write download.body
+        else
+          fail Geoblacklight::Exceptions::WrongDownloadFormat
+        end
+      end
+      File.rename("#{file_path}.tmp", file_path)
+      file_name
+    rescue Geoblacklight::Exceptions::ExternalDownloadFailed
+      Geoblacklight.logger.error 'Download from external server failed'
+      nil
+    rescue Geoblacklight::Exceptions::WrongDownloadFormat => error
+      Geoblacklight.logger.error "#{error} expected #{@options[:content_type]} received #{download.headers['content-type']}"
+      File.delete("#{file_path}.tmp")
+      nil
     end
-    File.open("#{file_path}.tmp", 'wb')  do |file|
-      if download.headers['content-type'] == @options[:content_type]
-        file.write download.body
-      else
-        fail Geoblacklight::Exceptions::WrongDownloadFormat
+
+    def initiate_download
+      url = @document.references.send(@options[:service_type]).endpoint
+      url += '/reflect' if @options[:reflect]
+      conn = Faraday.new(url: url)
+      conn.get do |request|
+        request.params = @options[:request_params]
+        request.options = {
+          timeout: timeout,
+          open_timeout: timeout
+        }
       end
+    rescue Faraday::Error::ConnectionFailed => error
+      Geoblacklight.logger.error error.inspect
+      nil
+    rescue Faraday::Error::TimeoutError => error
+      Geoblacklight.logger.error error.inspect
+      nil
     end
-    File.rename("#{file_path}.tmp", file_path)
-    file_name
-  rescue Geoblacklight::Exceptions::ExternalDownloadFailed
-    Geoblacklight.logger.error 'Download from external server failed'
-    nil
-  rescue Geoblacklight::Exceptions::WrongDownloadFormat => error
-    Geoblacklight.logger.error "#{error} expected #{@options[:content_type]} received #{download.headers['content-type']}"
-    File.delete("#{file_path}.tmp")
-    nil
-  end
 
-  def initiate_download
-    url = @document.references.send(@options[:service_type]).endpoint
-    url += '/reflect' if @options[:reflect]
-    conn = Faraday.new(url: url)
-    conn.get do |request|
-      request.params = @options[:request_params]
-      request.options = {
-        timeout: Settings.TIMEOUT_DOWNLOAD,
-        open_timeout: Settings.TIMEOUT_DOWNLOAD
-      }
+    private
+
+    ##
+    # Returns timeout for the download request. `timeout` passed as an option to
+    # the Geoblacklight::Download class
+    # @returns [Fixnum] download timeout in seconds
+    def timeout
+      @options[:timeout] || Settings.TIMEOUT_DOWNLOAD || 20
     end
-  rescue Faraday::Error::ConnectionFailed => error
-    Geoblacklight.logger.error error.inspect
-    nil
-  rescue Faraday::Error::TimeoutError => error
-    Geoblacklight.logger.error error.inspect
-    nil
   end
 end

data/lib/geoblacklight/download/geojson_download.rb

@@ -1,20 +1,22 @@
-class GeojsonDownload < Download
-  GEOJSON_DOWNLOAD_PARAMS = {
-    service: 'wfs',
-    version: '2.0.0',
-    request: 'GetFeature',
-    srsName: 'EPSG:4326',
-    outputformat: 'application/json'
-  }
+module Geoblacklight
+  class GeojsonDownload < Geoblacklight::Download
+    GEOJSON_DOWNLOAD_PARAMS = {
+      service: 'wfs',
+      version: '2.0.0',
+      request: 'GetFeature',
+      srsName: 'EPSG:4326',
+      outputformat: 'application/json'
+    }
 
-  def initialize(document)
-    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'
-    })
+    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

@@ -1,18 +1,20 @@
-class GeotiffDownload < Download
-  GEOTIFF_DOWNLOAD_PARAMS = {
-    format: 'image/geotiff',
-    width: 4096
-  }
+module Geoblacklight
+  class GeotiffDownload < Geoblacklight::Download
+    GEOTIFF_DOWNLOAD_PARAMS = {
+      format: 'image/geotiff',
+      width: 4096
+    }
 
-  def initialize(document)
-    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
-    })
+    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

@@ -1,17 +1,19 @@
-class HglDownload < Download
-  def initialize(document, email)
+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'
-    })
-  end
+      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
+    def get
+      initiate_download
+    end
   end
 end

data/lib/geoblacklight/download/kmz_download.rb

@@ -1,14 +1,16 @@
-class KmzDownload < 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 }
-  
-  def initialize(document)
-    request_params = KMZ_DOWNLOAD_PARAMS.merge(layers: document[:layer_id_s], bbox: document.bounding_box_as_wsen.split(' ').join(', '))
-    super(document, {
-      type: 'kmz',
-      extension: 'kmz',
-      request_params: request_params,
-      content_type: 'application/vnd.google-earth.kmz',
-      service_type: 'wms'
-    })
+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 }
+    
+    def initialize(document, options = {})
+      request_params = KMZ_DOWNLOAD_PARAMS.merge(layers: document[:layer_id_s], bbox: document.bounding_box_as_wsen.split(' ').join(', '))
+      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

@@ -1,14 +1,16 @@
-class ShapefileDownload < Download
-  SHAPEFILE_DOWNLOAD_PARAMS = { service: 'wfs', version: '2.0.0', request: 'GetFeature', srsName: 'EPSG:4326', outputformat: 'SHAPE-ZIP' }
-  
-  def initialize(document)
-    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'
-    })
+module Geoblacklight
+  class ShapefileDownload < Geoblacklight::Download
+    SHAPEFILE_DOWNLOAD_PARAMS = { service: 'wfs', version: '2.0.0', request: 'GetFeature', srsName: 'EPSG:4326', outputformat: 'SHAPE-ZIP' }
+
+    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

data/lib/geoblacklight/engine.rb

@@ -5,6 +5,7 @@ require 'rails_config'
 require 'faraday'
 require 'blacklight_range_limit'
 require 'nokogiri'
+require 'coderay'
 
 module Geoblacklight
   class Engine < ::Rails::Engine

data/lib/geoblacklight/metadata.rb

@@ -0,0 +1,41 @@
+module Geoblacklight
+  class Metadata
+
+    ##
+    # Instantiates a Geoblacklight::Metadata object used for retrieving and
+    # formatting metadata
+    # @param reference [Geoblacklight::Reference] the reference object
+    def initialize(reference)
+      @reference = reference
+    end
+
+    ##
+    # Handles metadata and returns the retrieved metadata or an error message if
+    # something went wrong
+    # @return [String] returned metadata string
+    def metadata
+      response = retrieve_metadata
+      if response.nil? || response.status == 404
+        Geoblacklight.logger.error "Could not reach #{@reference.endpoint}"
+        return "Could not reach #{@reference.endpoint}"
+      else
+        return response.body
+      end
+    end
+
+    ##
+    # Retrieves metadata from a url source
+    # @return [Faraday::Response, nil] Faraday::Response or nil if there is a
+    # connection error
+    def retrieve_metadata
+      conn = Faraday.new(url: @reference.endpoint)
+      conn.get
+    rescue Faraday::Error::ConnectionFailed => error
+      Geoblacklight.logger.error error.inspect
+      nil
+    rescue Faraday::Error::TimeoutError => error
+      Geoblacklight.logger.error error.inspect
+      nil
+    end
+  end
+end