nsrr 0.1.0.beta3 → 0.1.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 264d749d9908c859da8beac680941e7cf1d87ac3
-  data.tar.gz: 6bb9f5bbb9f3dd79c522fa98e7543781ef8ad87a
+  metadata.gz: 9e5739cb4683537e512b1b4463f237bbd70a3247
+  data.tar.gz: 6059f16342f257f7282f40f78b6bc2fb7fe9464d
 SHA512:
-  metadata.gz: 4ce4aacec2ce0cde8cc1fb459cacb60874fe6816efcb134baa0801b916ecc047631778504255eb4edaad6767a13fc4bd54850c9d290ba6d06a5a6784da17d75a
-  data.tar.gz: cc22609fb152fca49f7cf8a516b5a637749cc74a4e2d9f41951780c99eb5b2e2e3e4e9d4d1388f597e620bfc2cb910228b5351a7d6ad5401ddc62e4430c1982a
+  metadata.gz: 36389482d66a709f8fda17d9dfc0caa0e020fe947f67ddb8a1d3f9a6dafdbc35df6fd63470e62cc4f0e76ad400fd6dbdec986b239bd5a18362a1312e1d8bcc47
+  data.tar.gz: b3823a0956ce76fc9077cfb7bee1fc8821021e9bbe3c203d9c922f339b0c3ea5888a46829f3916da6e9027997b964f440068608b567599104e6676b5188d3073

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 ## 0.1.0
 
 ### Enhancements
+- Added a `nsrr download` command that allows users to download partial or entire datasets
+  - Example: `nsrr download shhs`
 - Added a `nsrr console` command that allows users to access and download datasets and files
   - Datasets can be loaded in the console environment
     - `d = Dataset.find 'shhs'`

data/README.md

@@ -26,6 +26,46 @@ Or install it yourself as:
 
 ## Usage
 
+### Download files from a dataset
+
+**Note:** You can type `Ctrl-C` to pause downloads and resume later by retyping the command.
+
+Download an entire dataset.
+
+```console
+$ nsrr download shhs
+```
+
+Download a subfolder of a dataset.
+
+```console
+$ nsrr download shhs/forms
+```
+
+Download a folder without downloading contents of subfolders. By default, when not specified, the command will recursively download all contents of the specified folder and subfolders.
+
+```console
+$ nsrr download shhs/datasets --shallow
+```
+
+Continue an in progress download and only compare file sizes. By default, when a downloaded file already exists, the command will do an MD5 file comparison to verify the file is identical to the one on the server. The MD5 comparison is exact, but can be slow on older machines. If you want a quick check, you can tell the command to simply compare the file sizes of the local file and the file on the server which speeds up the comparison process, however it may in some cases be inaccurate.
+
+```console
+$ nsrr download shhs --fast
+```
+
+Redownload all files and overwrite any existing downloaded files.
+
+```console
+$ nsrr download shhs --fresh
+```
+
+You can combine the file check flag with the folder depth flag as well.
+
+```console
+$ nsrr download shhs/datasets --shallow --fast
+```
+
 ### Open the console and download entire datasets
 
 ```console

data/lib/nsrr/commands/download.rb

@@ -0,0 +1,62 @@
+require 'colorize'
+
+require 'nsrr/models/all'
+
+module Nsrr
+  module Commands
+    class Download
+      class << self
+        def run(*args)
+          new(*args).run
+        end
+      end
+
+      attr_reader :dataset_slug, :folder, :file_comparison, :depth
+
+      def initialize(argv)
+        (@token, argv) = parse_parameter_with_value(argv, ['token'], '')
+        (@file_comparison, argv) = parse_parameter(argv, ['fast', 'fresh', 'md5'], 'md5')
+        (@depth, argv) = parse_parameter(argv, ['shallow', 'recursive'], 'recursive')
+        @dataset_slug = argv[1].to_s.split('/').first
+        @folder = (argv[1].to_s.split('/')[1..-1] || []).join('/')
+      end
+
+      def run
+        @dataset = Dataset.find @dataset_slug
+        if @dataset
+          @dataset.download_token = @token
+          @dataset.download(@folder, depth: @depth, method: @file_comparison)
+        else
+          if @dataset_slug == nil
+            puts "Please specify a dataset: " + "nsrr download DATASET".colorize(:white)
+          else
+            puts "The dataset " + "#{@dataset_slug}".colorize(:white) + " was not found."
+          end
+          puts "Read more on the download command here:"
+          puts "  " + "https://github.com/nsrr/nsrr-gem".colorize( :blue ).on_white.underline
+        end
+      end
+
+      private
+
+      def parse_parameter(argv, options, default)
+        result = default
+        options.each do |option|
+          result = option if argv.delete "--#{option}"
+        end
+        return [result, argv]
+      end
+
+      def parse_parameter_with_value(argv, options, default)
+        result = default
+        options.each do |option|
+          argv.each do |arg|
+            result = arg.gsub(/^--#{option}=/, '') if arg =~ /^--#{option}=\w/
+          end
+        end
+
+        return [result, argv]
+      end
+    end
+  end
+end

data/lib/nsrr/models/dataset.rb

@@ -1,5 +1,6 @@
 require 'colorize'
 require 'fileutils'
+require 'irb'
 
 require 'nsrr/helpers/constants'
 require 'nsrr/helpers/hash_helper'
@@ -19,6 +20,7 @@ module Nsrr
         end
       end
 
+      attr_accessor :download_token
       attr_reader :slug, :name
 
       def initialize(json = {})
@@ -73,11 +75,11 @@ module Nsrr
 
         @downloaded_megabytes = @downloaded_bytes / (1024 * 1024)
 
-        puts "\nFinished in #{Time.now - @start_time} seconds."
+        puts "\nFinished in #{Time.now - @start_time} seconds." if @start_time
         puts "\n#{@folders_created} folder#{"s" if @folders_created != 1} created".colorize(:white) + ", " +
              "#{@files_downloaded} file#{"s" if @files_downloaded != 1} downloaded".colorize(:green) + ", " +
              "#{@downloaded_megabytes} MiB#{"s" if @downloaded_megabytes != 1} downloaded".colorize(:green) + ", " +
-             "#{@files_skipped} file#{"s" if @files_skipped != 1} skipped".colorize(:blue) + ", " +
+             "#{@files_skipped} file#{"s" if @files_skipped != 1} skipped".colorize(:light_blue) + ", " +
              "#{@files_failed} file#{"s" if @files_failed != 1} failed".colorize(:red) + "\n\n"
         nil
       end
@@ -107,15 +109,15 @@ module Nsrr
       end
 
       def create_folder(folder)
-        puts "      create".colorize( :white ) + " #{folder}"
+        puts "      create".colorize(:white) + " #{folder}"
         FileUtils.mkdir_p folder
         @folders_created += 1
       end
 
       def set_download_token
-        puts  "             Get your token here: " + "https://sleepdata.org/token".colorize( :blue ).on_white.underline
+        puts  "             Get your token here: " + "#{Nsrr::WEBSITE}/token".colorize( :blue ).on_white.underline
         print "Please enter your download token: "
-        @download_token = gets.chomp
+        @download_token =  STDIN.gets.chomp
       end
 
     end

data/lib/nsrr/models/file.rb

@@ -52,17 +52,17 @@ module Nsrr
         download_request.get
 
         if download_request.error.to_s == ''
-          puts "    download".colorize( :green ) + " #{@name}"
+          puts "    download".colorize(:green) + " #{@name}"
           download_request.file_size
         else
-          puts "      failed".colorize( :red ) + " #{@name}"
+          puts "      failed".colorize(:red) + " #{@name}"
           puts "             #{download_request.error}"
           'fail'
         end
       end
 
       def skip
-        puts "   identical".colorize( :blue ) + " #{self.name}"
+        puts "   identical".colorize(:light_blue) + " #{self.name}"
         'skip'
       end
 

data/lib/nsrr/version.rb

@@ -3,7 +3,7 @@ module Nsrr
     MAJOR = 0
     MINOR = 1
     TINY = 0
-    BUILD = "beta3" # nil, "pre", "rc", "rc2"
+    BUILD = "beta4" # nil, "pre", "rc", "rc2"
 
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end

data/lib/nsrr.rb

@@ -1,7 +1,10 @@
+require 'colorize'
+
 require "nsrr/version"
 
 Nsrr::COMMANDS = {
   'c' => :console,
+  'd' => :download,
   'v' => :version
 }
 
@@ -13,23 +16,11 @@ module Nsrr
   def self.console(argv)
     require 'nsrr/commands/console'
     Nsrr::Commands::Console.start(argv)
-    # console = Nsrr::Commands::Console.new(argv)
-    # console.start
-    # `#{File.expand_path('../', __FILE__)}/nsrr/commands/console2`
-
-
-    # require 'irb'
-    # require 'irb/completion'
-    # IRB.setup nil
-    # IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
-    # require 'irb/ext/multi-irb'
-    # IRB.irb nil, self
-
-    # require 'irb'
-    # ARGV.clear
-    # @a = "hello"
-    # IRB.start
+  end
 
+  def self.download(argv)
+    require 'nsrr/commands/download'
+    Nsrr::Commands::Download.run(argv)
   end
 
   def self.help(argv)
@@ -40,12 +31,16 @@ Usage: nsrr COMMAND [ARGS]
 The most common nsrr commands are:
   [c]onsole         Load an interactive console to access
                     and download datasets and files
+  [d]ownload        Download all or some files in a DATASET
   [v]ersion         Returns the version of nsrr gem
 
 Commands can be referenced by the first letter:
   Ex: `nsrr v`, for version
 
 EOT
+    puts "Read more on the download command here:"
+    puts "  " + "https://github.com/nsrr/nsrr-gem".colorize( :blue ).on_white.underline
+    puts "\n"
   end
 
   def self.version(argv)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nsrr
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta3
+  version: 0.1.0.beta4
 platform: ruby
 authors:
 - Remo Mueller
@@ -96,6 +96,7 @@ files:
 - bin/nsrr
 - lib/nsrr.rb
 - lib/nsrr/commands/console.rb
+- lib/nsrr/commands/download.rb
 - lib/nsrr/helpers/constants.rb
 - lib/nsrr/helpers/download_request.rb
 - lib/nsrr/helpers/hash_helper.rb