Class: Bkblz::Task::DownloadFile

Inherits:
BaseTask
  • Object
show all
Defined in:
lib/bkblz/task/download_file.rb

Constant Summary

Constants included from ClassMethods

ClassMethods::PARAM_SPEC

Instance Attribute Summary

Attributes inherited from BaseTask

#config, #result

Instance Method Summary collapse

Methods inherited from BaseTask

#initialize, #run

Methods included from ClassMethods

#check_one_of, #check_params, #check_required, #run, #task_param, #task_params

Methods included from TaskHelpers

#find_bucket_by_name

Constructor Details

This class inherits a constructor from Bkblz::Task::BaseTask

Instance Method Details

#download_by_id(session, params) ⇒ Object



65
66
67
68
69
70
71
72
# File 'lib/bkblz/task/download_file.rb', line 65

def download_by_id(session, params)
  raise 'missing file id' unless params[:file_id]

  partial_file_info =
    Bkblz::V1::Model::PartialFileInfo.new :file_id => params[:file_id]
  session.send(
    Bkblz::V1::DownloadFileByIdRequest.new partial_file_info).to_model
end

#download_by_name(session, params) ⇒ Object



55
56
57
58
59
60
61
62
63
# File 'lib/bkblz/task/download_file.rb', line 55

def download_by_name(session, params)
  raise 'missing file name' unless params[:file_name]
  raise 'missing bucket name' unless params[:bucket_name]

  bucket = find_bucket_by_name session, params[:bucket_name]
  file = params[:file_name]
  session.send(
    Bkblz::V1::DownloadFileByNameRequest.new bucket, file).to_model
end

#run_internal(session, params) ⇒ Object



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/bkblz/task/download_file.rb', line 18

def run_internal(session, params)
  download_file_info = if params[:use_filename]
                         download_by_name(session, params)
                       else
                         download_by_id(session, params)
                       end

  unless download_file_info.sha1 == Digest::SHA1.hexdigest(download_file_info.body)
    raise "invalid checksum"
  end

  dir_path = params[:dir_path]
  unless ::File.directory? dir_path
    raise "dir_path is not a directory: %s" % dir_path
  end
  unless ::File.writable?(dir_path)
    raise "unable to write to directory %s" % dir_path
  end

  out_file_name = download_file_info.file_name
  unless params[:strip_prefix].nil?
    out_file_name.gsub! params[:strip_prefix], ""
  end

  f_path = ::File.join dir_path, out_file_name
  if ::File.exists?(f_path) && !::File.writable?(f_path)
    raise "unable to write to existing file: %s" % f_path
  end

  ::File.binwrite(f_path, download_file_info.body)

  # This can be expensive, we're momentarily copying the body
  map = download_file_info.to_map
  map[:body] = "<omitted>"
  Bkblz::V1::Model::FileDownload.new map
end