geoblacklight 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 336d18ec6cafab94ffffefb1bab4ea094d00a236
-  data.tar.gz: 5c2897ee61afa85bc2cad7cc76c5c44e2fc2b1ee
+  metadata.gz: a76208f38c8360b0a7ac9d53f6bea129aa127c7f
+  data.tar.gz: cab96dd5acfb95ebb2313061eedb342be66fc086
 SHA512:
-  metadata.gz: 2520695818063a834b764469d3874269ab69e27cb640093c233f35af57982b62f99fd08818178ca27ebf6ac8d43d12c42ad6b3ca3e2cde0db155162b74a50ee5
-  data.tar.gz: 09a53748f413c5f1a77c0852eae201a758ddd67194a0452671b67bd1878468c68cf4e6b85920f9ef251e9feb5b5bb29e929d1d9ad75ec030d61aafc36371e295
+  metadata.gz: 52d058b189f45f3009b8071bf2ea5db8811b1d2965d6995432ebe25897fabe86c79c68068245158388fbd4efc9a6b5658ab8d68fcd3bd1e7a72318b1800e5d88
+  data.tar.gz: 1deb25f8b97b1954559efa2105d364dd69be7ad8ad69d9c736ddbb0cc9fef2c16c0a882fef063a3b7b8ff507d740f42e75126b0a2ee3c163a10fb72a07ab7dcc

data/app/controllers/download_controller.rb

@@ -1,6 +1,22 @@
 class DownloadController < ApplicationController
   include Blacklight::SolrHelper
 
+  rescue_from Geoblacklight::Exceptions::ExternalDownloadFailed do |exception|
+    Geoblacklight.logger.error exception.message + ' ' + exception.url
+    flash[:danger] = view_context
+                     .content_tag(:span,
+                                  flash_error_message(exception),
+                                  data: {
+                                    download: 'error',
+                                    download_id: params[:id],
+                                    download_type: "generated-#{params[:type]}"
+                                  })
+    respond_to do |format|
+      format.json { render json: flash, response: response }
+      format.html { render json: flash, response: response }
+    end
+  end
+
   def show
     @response, @document = get_solr_response_for_doc_id params[:id]
     restricted_should_authenticate
@@ -37,28 +53,43 @@ class DownloadController < ApplicationController
     end
   end
 
+  protected
+
+  ##
+  # Creates an error flash message with failed download url
+  # @param [Geoblacklight::Exceptions::ExternalDownloadFailed] Download failed
+  # exception
+  # @return [String] error message to display in flash 
+  def flash_error_message(exception)
+    if exception.url
+      message = t('geoblacklight.download.error_with_url',
+                  link: view_context
+                        .link_to(exception.url,
+                                 exception.url,
+                                 target: 'blank'))
+                .html_safe
+    else
+      message = t('geoblacklight.download.error')
+    end
+  end
+
   private
 
   def check_type
-    case params[:type]
+    response = case params[:type]
     when 'shapefile'
-      response = Geoblacklight::ShapefileDownload.new(@document).get
+      Geoblacklight::ShapefileDownload.new(@document).get
     when 'kmz'
-      response = Geoblacklight::KmzDownload.new(@document).get
+      Geoblacklight::KmzDownload.new(@document).get
     when 'geojson'
-      response = Geoblacklight::GeojsonDownload.new(@document).get
+      Geoblacklight::GeojsonDownload.new(@document).get
     when 'geotiff'
-      response = Geoblacklight::GeotiffDownload.new(@document).get
+      Geoblacklight::GeotiffDownload.new(@document).get
     end
-    response
   end
 
   def validate(response)
-    if response.nil?
-      flash[:danger] = view_context.content_tag(:span, t('geoblacklight.download.error'), data: { download: 'error', download_id: params[:id], download_type: "generated-#{params[:type]}"})
-    else
-      flash[:success] = view_context.link_to(t('geoblacklight.download.success', title: response), download_file_path(response), data: { download: 'trigger', download_id: params[:id], download_type: "generated-#{params[:type]}"})
-    end
+    flash[:success] = view_context.link_to(t('geoblacklight.download.success', title: response), download_file_path(response), data: { download: 'trigger', download_id: params[:id], download_type: "generated-#{params[:type]}"})
   end
 
   # Checks whether a document is public, if not require user to authenticate

data/config/locales/geoblacklight.en.yml

@@ -5,6 +5,7 @@ en:
       success: 'Your file %{title} is ready for download'
       hgl_success: 'You should receive an email when your download is ready'
       error: 'Sorry, the requested file could not be downloaded'
+      error_with_url: 'Sorry, the requested file could not be downloaded, try downloading it directly from: %{link}'
     home:
       headline: 'Explore and discover...'
       search_heading: 'Find the maps and data you need'

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

@@ -207,9 +207,9 @@ class CatalogController < ApplicationController
     config.spell_max = 5
 
     # 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'
+    config.add_show_tools_partial :web_services, if: proc { |_context, _config, options| options[:document] && (Settings.WEBSERVICES_SHOWN & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
+    config.add_show_tools_partial :metadata, if: proc { |_context, _config, options| options[:document] && (Settings.METADATA_SHOWN & options[:document].references.refs.map(&:type).map(&:to_s)).any? }
+    config.add_show_tools_partial :downloads, partial: 'downloads', if: proc { |_context, _config, options| options[:document] }
   end
 
 

data/lib/geoblacklight/download.rb

@@ -29,11 +29,12 @@ module Geoblacklight
       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
-      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
@@ -43,18 +44,18 @@ module Geoblacklight
       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
+      raise Geoblacklight::Exceptions::ExternalDownloadFailed, message: 'Wrong download type'
     end
 
+    ##
+    # Initiates download from a remote source url using the `request_params`.
+    # Will catch Faraday::Error::ConnectionFailed and
+    # Faraday::Error::TimeoutError 
+    # @return [Faraday::Request] returns a Faraday::Request object
     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]
@@ -64,11 +65,9 @@ module Geoblacklight
         }
       end
     rescue Faraday::Error::ConnectionFailed => error
-      Geoblacklight.logger.error error.inspect
-      nil
+      raise Geoblacklight::Exceptions::ExternalDownloadFailed, message: 'Download connection failed', url: conn.url_prefix.to_s
     rescue Faraday::Error::TimeoutError => error
-      Geoblacklight.logger.error error.inspect
-      nil
+      raise Geoblacklight::Exceptions::ExternalDownloadFailed, message: 'Download timed out', url: conn.url_prefix.to_s
     end
 
     private
@@ -76,9 +75,18 @@ module Geoblacklight
     ##
     # Returns timeout for the download request. `timeout` passed as an option to
     # the Geoblacklight::Download class
-    # @returns [Fixnum] download timeout in seconds
+    # @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/exceptions.rb

@@ -1,6 +1,23 @@
 module Geoblacklight
   module Exceptions
     class ExternalDownloadFailed < StandardError
+      def initialize(options = {})
+        @options = options
+      end
+
+      ##
+      # URL tried from failed download
+      # @return [String] 
+      def url
+        @options[:url].to_s
+      end
+
+      ##
+      # Message passed from a failed download
+      # @return [String]
+      def message
+        @options[:message].to_s
+      end
     end
     class WrongDownloadFormat < StandardError
     end

data/lib/geoblacklight/version.rb

@@ -1,3 +1,3 @@
 module Geoblacklight
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/spec/controllers/download_controller_spec.rb

@@ -26,7 +26,7 @@ describe Geoblacklight::DownloadController, type: :controller do
     end
     describe 'public file' do
       it 'should initiate download creation' do
-        get 'show', id: 'mit-us-ma-e25zcta5dct-2000'
+        get 'show', id: 'mit-us-ma-e25zcta5dct-2000', type: 'shapefile'
         expect(response.status).to eq 200
       end
     end

data/spec/features/bookmarks_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+feature 'Blacklight Bookmarks' do
+  scenario 'index has created bookmarks' do
+    visit catalog_path 'columbia-columbia-landinfo-global-aet'
+    click_button 'Bookmark'
+    visit bookmarks_path
+    expect(page).to have_css '.document', count: 1
+  end
+end

data/spec/features/download_layer_spec.rb

@@ -7,6 +7,13 @@ feature 'Download layer' do
     find('a', text: 'Download Shapefile').click
     expect(page).to have_css('a', text: 'Your file mit-us-ma-e25zcta5dct-2000-shapefile.zip is ready for download')
   end
+  scenario 'failed download should return message with link to layer', js: true do
+    expect_any_instance_of(Geoblacklight::ShapefileDownload).to receive(:get).and_raise(Geoblacklight::Exceptions::ExternalDownloadFailed.new(message: 'Failed', url: 'http://www.example.com/failed'))
+    visit catalog_path('mit-us-ma-e25zcta5dct-2000')
+    find('a', text: 'Download Shapefile', match: :first).click
+    expect(page).to have_css 'div.alert.alert-danger', text: 'Sorry, the requested file could not be downloaded, try downloading it directly from:'
+    expect(page).to have_css 'a', text: 'http://www.example.com/failed'
+  end
   scenario 'clicking kmz download button should trigger download', js: true do
     expect_any_instance_of(Geoblacklight::KmzDownload).to receive(:get).and_return('mit-us-ma-e25zcta5dct-2000-kmz.kmz')
     visit catalog_path('mit-us-ma-e25zcta5dct-2000')

data/spec/lib/geoblacklight/download_spec.rb

@@ -51,7 +51,7 @@ describe Geoblacklight::Download do
       bad_file = OpenStruct.new(headers: { 'content-type' => 'bad/file' })
       expect(download).to receive(:initiate_download).and_return(bad_file)
       expect(File).to receive(:delete).with("#{download.file_path}.tmp").and_return(nil)
-      expect(download.create_download_file).to eq nil
+      expect { download.create_download_file }.to raise_error(Geoblacklight::Exceptions::ExternalDownloadFailed, 'Wrong download type')
     end
     it 'should create the file, write it, and then rename from tmp if everything is ok' do
       shapefile = OpenStruct.new(headers: {'content-type' => 'application/zip'})
@@ -67,10 +67,11 @@ describe Geoblacklight::Download do
       expect(Faraday).to receive(:new).with(url: 'http://www.example.com/wms').and_return(response)
       download.initiate_download
     end
-    it 'should return nil with a connection failure' do
-      expect(response).to receive(:get).and_return(Faraday::Error::ConnectionFailed)
+    it 'should raise Geoblacklight::Exceptions::ExternalDownloadFailed with a connection failure' do
+      expect(response).to receive(:url_prefix).and_return 'http://www.example.com/wms'
+      expect(response).to receive(:get).and_raise(Faraday::Error::ConnectionFailed.new('Failed'))
       expect(Faraday).to receive(:new).with(url: 'http://www.example.com/wms').and_return(response)
-      expect(download.initiate_download).to be Faraday::ConnectionFailed
+      expect { download.initiate_download }.to raise_error(Geoblacklight::Exceptions::ExternalDownloadFailed)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geoblacklight
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Mike Graves
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -360,6 +360,7 @@ files:
 - spec/controllers/catalog_controller_spec.rb
 - spec/controllers/download_controller_spec.rb
 - spec/factories/user.rb
+- spec/features/bookmarks_spec.rb
 - spec/features/download_layer_spec.rb
 - spec/features/home_page_spec.rb
 - spec/features/iiif_viewer_spec.rb
@@ -433,6 +434,7 @@ test_files:
 - spec/controllers/catalog_controller_spec.rb
 - spec/controllers/download_controller_spec.rb
 - spec/factories/user.rb
+- spec/features/bookmarks_spec.rb
 - spec/features/download_layer_spec.rb
 - spec/features/home_page_spec.rb
 - spec/features/iiif_viewer_spec.rb