class Geoblacklight::Download

Public Class Methods

file_path() click to toggle source
# File lib/geoblacklight/download.rb, line 18
def self.file_path
  Settings.DOWNLOAD_PATH || Rails.root.join("tmp", "cache", "downloads")
end
new(document, options = {}) click to toggle source
# File lib/geoblacklight/download.rb, line 5
def initialize(document, options = {})
  @document = document
  @options = options
end

Public Instance Methods

create_download_file() click to toggle source

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

# File lib/geoblacklight/download.rb, line 42
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
download_exists?() click to toggle source
# File lib/geoblacklight/download.rb, line 26
def download_exists?
  File.file?(file_path_and_name)
end
downloadable?() click to toggle source
# File lib/geoblacklight/download.rb, line 10
def downloadable?
  @document.downloadable?
end
file_name() click to toggle source
# File lib/geoblacklight/download.rb, line 14
def file_name
  "#{@document.id}-#{@options[:type]}.#{@options[:extension]}"
end
file_path_and_name() click to toggle source
# File lib/geoblacklight/download.rb, line 22
def file_path_and_name
  "#{self.class.file_path}/#{file_name}"
end
get() click to toggle source
# File lib/geoblacklight/download.rb, line 30
def get
  if download_exists?
    file_name
  else
    create_download_file
  end
end
initiate_download() click to toggle source

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

# File lib/geoblacklight/download.rb, line 63
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
url_with_params() click to toggle source

Creates a download url for the object @return [String]

# File lib/geoblacklight/download.rb, line 83
def url_with_params
  url + "/?" + URI.encode_www_form(@options[:request_params])
end

Private Instance Methods

matches_mimetype?(download) click to toggle source
# File lib/geoblacklight/download.rb, line 89
def matches_mimetype?(download)
  MIME::Type.simplified(download.headers["content-type"]) == @options[:content_type]
end
timeout() click to toggle source

Returns timeout for the download request. ‘timeout` passed as an option to the Geoblacklight::Download class @return [Fixnum] download timeout in seconds

# File lib/geoblacklight/download.rb, line 97
def timeout
  @options[:timeout] || Settings.TIMEOUT_DOWNLOAD || 20
end
url() click to toggle source

URL for download @return [String] URL that is checked in download

# File lib/geoblacklight/download.rb, line 104
def url
  url = @document.references.send(@options[:service_type]).endpoint
  url += "/reflect" if @options[:reflect]
  url
end