Class: Nsrr::Models::Dataset

Inherits:
Object
  • Object
show all
Defined in:
lib/nsrr/models/dataset.rb

Overview

Allows dataset and dataset file information to be retrieved, as well as allowing dataset files to be downloaded.

Direct Known Subclasses

Dataset

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(json = {}, token = nil) ⇒ Dataset

Returns a new instance of Dataset.



31
32
33
34
35
36
37
 
# File 'lib/nsrr/models/dataset.rb', line 31

def initialize(json = {}, token = nil)
  @slug = json["slug"]
  @name = json["name"]
  @files = {}
  @download_token = token
  @downloaded_folders = []
end

Instance Attribute Details

#download_token ⇒ Object

Returns the value of attribute download_token.



28
29
30
 
# File 'lib/nsrr/models/dataset.rb', line 28

def download_token
  @download_token
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



29
30
31
 
# File 'lib/nsrr/models/dataset.rb', line 29

def name
  @name
end

#slug ⇒ Object (readonly)

Returns the value of attribute slug.



29
30
31
 
# File 'lib/nsrr/models/dataset.rb', line 29

def slug
  @slug
end

Class Method Details

.find(slug, token = nil) ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/nsrr/models/dataset.rb', line 20

def self.find(slug, token = nil)
  (json, _status) = Nsrr::Helpers::JsonRequest.get(
    "#{Nsrr::WEBSITE}/api/v1/datasets/#{slug}.json",
    auth_token: token
  )
  new(json, token) if json
end

Instance Method Details

#create_folder(folder) ⇒ Object 



136
137
138
139
140
 
# File 'lib/nsrr/models/dataset.rb', line 136

def create_folder(folder)
  puts "      create".white + " #{folder}"
  FileUtils.mkdir_p folder
  @folders_created += 1
end

#create_folder_for_path(full_path) ⇒ Object 



129
130
131
132
133
134
 
# File 'lib/nsrr/models/dataset.rb', line 129

def create_folder_for_path(full_path)
  files(full_path).collect(&:folder).uniq.each do |folder|
    current_folder = ::File.join(slug.to_s, folder.to_s)
    create_folder(current_folder)
  end
end

#download(full_path = nil, *args) ⇒ Object

Options include: method:

"md5"       => [default] Checks if a downloaded file exists with the exact md5 as the online version, if so, skips that file
"fresh"     => Downloads every file without checking if it was already downloaded
"fast"      => Only checks if a download file exists with the same file size as the online version, if so, skips that file

depth:

"recursive" => [default] Downloads files in selected path folder and all subfolders
"shallow"   => Only downloads files in selected path folder



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/nsrr/models/dataset.rb', line 60

def download(full_path = nil, *args)
  options = Nsrr::Helpers::HashHelper.symbolize_keys(args.first || {})
  options[:method] ||= "md5"
  options[:depth] ||= "recursive"
  @folders_created = 0
  @files_downloaded = 0
  @downloaded_bytes = 0
  @files_skipped = 0
  @files_failed = 0

  begin
    puts "           File Check: " + options[:method].to_s.white
    puts "           File Regex: " + options[:file].inspect.white
    puts "                Depth: " + options[:depth].to_s.white
    puts ""
    if @download_token.nil?
      @download_token = Nsrr::Helpers::Authorization.get_token(@download_token)
    end

    @start_time = Time.now

    download_helper(full_path, options)
  rescue Interrupt, IRB::Abort
    puts "\n   Interrupted".red
  end

  @downloaded_megabytes = @downloaded_bytes / (1024 * 1024)

  puts "\nFinished in #{Time.now - @start_time} seconds." if @start_time
  puts "\n#{@folders_created} folder#{"s" if @folders_created != 1} created".white + ", " +
       "#{@files_downloaded} file#{"s" if @files_downloaded != 1} downloaded".green + ", " +
       "#{@downloaded_megabytes} MiB#{"s" if @downloaded_megabytes != 1} downloaded".green + ", " +
       "#{@files_skipped} file#{"s" if @files_skipped != 1} skipped".blue + ", " +
       "#{@files_failed} file#{"s" if @files_failed != 1} failed".send(@files_failed.zero? ? :white : :red) + "\n\n"
  nil
end

#download_helper(full_path, options) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/nsrr/models/dataset.rb', line 97

def download_helper(full_path, options)
  return if @downloaded_folders.include?(full_path)
  @downloaded_folders << full_path

  create_folder_for_path(full_path)

  files(full_path).select(&:is_file).each do |file|
    unless file.file_name.match?(options[:file])
      puts "     skipped".blue + " #{file.file_name}"
      @files_skipped += 1
      next
    end

    current_folder = ::File.join(slug.to_s, file.folder.to_s)
    result = file.download(options[:method], current_folder, @download_token)
    case result
    when "fail"
      @files_failed += 1
    when "skip"
      @files_skipped += 1
    else
      @files_downloaded += 1
      @downloaded_bytes += result
    end
  end
  if options[:depth] == "recursive"
    files(full_path).reject(&:is_file).each do |file|
      download_helper(file.full_path, options)
    end
  end
end

#files(path = nil) ⇒ Object 



39
40
41
42
43
44
45
46
 
# File 'lib/nsrr/models/dataset.rb', line 39

def files(path = nil)
  @files[path] ||= begin
    url = "#{Nsrr::WEBSITE}/api/v1/datasets/#{@slug}/files.json"
    params = { auth_token: @download_token, path: path }
    (json, _status) = Nsrr::Helpers::JsonRequest.get(url, params)
    (json || []).collect { |file_json| Nsrr::Models::File.new(file_json) }
  end
end

#folders(path = nil) ⇒ Object 



48
49
50
 
# File 'lib/nsrr/models/dataset.rb', line 48

def folders(path = nil)
  files(path).select { |f| !f.is_file }.collect(&:file_name)
end