nsrr 0.2.0.rc → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8c27aa5e00981e30edb2fd1e54be534f2080491
-  data.tar.gz: eedc928285c028bc7355ed1fa6a044978ce37fe7
+  metadata.gz: 69a067a927b05ad944da6faccfdf79b6d470f940
+  data.tar.gz: fb46592c764214c6f6c8d3a854911d128c1336df
 SHA512:
-  metadata.gz: b90b6320bedafd5eccf91672344ba0b5b5e27726abf0f3c3719bccdad996528af2a3ea66ca498aaa2b1818aa89068ff9c92d5301772f5b8ace20b7eaa32278f5
-  data.tar.gz: 72b6f6537adb848bc90e303562d7cc24bba363ca31d9b6818e3ba320af966cf7fa4abb96139c33a2a9f79990b3b40ad701047fecdd1e5fc16f38b3765c6c38bc
+  metadata.gz: 18a1d58c5c4a82bed071492dc3598ae57e4273b1fc37d42b71cac834fc9d0157adaa58cd171c8f4c87bf4d45e68b28ce1b4a454f3864dd1600669758c3b4f069
+  data.tar.gz: 73557b26b0f68b376011a701ee105a3909c0c80e28c6700e00e9921de2ebadfd74f9c6b7507bc35b3e332c40d56cd6bc86f5711780beca02fe757c7291ac61a1

data/CHANGELOG.md

@@ -1,9 +1,10 @@
-## 0.2.0
+## 0.2.0 (May 29, 2015)
 
 ### Enhancements
 - The `nsrr download` command now allows users to download files from private datasets
 - The `nsrr download` command provides better feedback on the validity of the authorization token provided by the user
-- Use of Ruby 2.2.1 is now recommended
+- Use of Ruby 2.2.2 is now recommended
+- Added text to inform users that input is hidden while entering token
 
 ### Bug Fixes
 - Fixed an issue preventing public files from being downloaded when an invalid token was entered

data/README.md

@@ -16,17 +16,25 @@ You must have **Ruby 2.0+ installed** on your system to use the NSRR gem.
 
 ## Installation
 
+The following commands can be run in **Command Prompt** on Windows, and in **Terminal** on Mac OS X.
+
 Install it yourself as:
 
-    $ gem install nsrr --no-ri --no-rdoc
+```console
+gem install nsrr --no-ri --no-rdoc
+```
 
 Or add this line to your application's Gemfile:
 
-    gem 'nsrr'
+```
+gem 'nsrr'
+```
 
 And then execute:
 
-    $ bundle
+```console
+bundle
+```
 
 
 ## Usage
@@ -38,49 +46,50 @@ And then execute:
 Download an entire dataset.
 
 ```console
-$ nsrr download shhs
+nsrr download shhs
 ```
 
 Download a subfolder of a dataset.
 
 ```console
-$ nsrr download shhs/forms
+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
+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
+nsrr download shhs --fast
 ```
 
 Redownload all files and overwrite any existing downloaded files.
 
 ```console
-$ nsrr download shhs --fresh
+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
+nsrr download shhs/datasets --shallow --fast
 ```
 
 ### Open the console and download entire datasets
 
 ```console
-$ nsrr console
+nsrr console
 ```
 
 ```
-> d = Dataset.find 'shhs'
-> d.download
+d = Dataset.find 'shhs'
+d.download
   Get your token here: https://sleepdata.org/token
+  Your input is hidden while entering token.
      Enter your token: AUTHORIZED
            File Check: md5
                 Depth: recursive
@@ -112,10 +121,11 @@ $ nsrr console
 For example to download only the shhs1 edfs folder and skip MD5 file validation:
 
 ```
-> d = Dataset.find 'shhs'
-> d.download('edfs/shhs1', method: 'fast', depth: 'shallow')
+d = Dataset.find 'shhs'
+d.download('edfs/shhs1', method: 'fast', depth: 'shallow')
 
   Get your token here: https://sleepdata.org/token
+  Your input is hidden while entering token.
      Enter your token: AUTHORIZED
            File Check: md5
                 Depth: recursive
@@ -131,10 +141,11 @@ For example to download only the shhs1 edfs folder and skip MD5 file validation:
 You can type `Ctrl-C` to pause the download, and retype the command to restart:
 
 ```
-> d = Dataset.find 'shhs'
-> d.download
+d = Dataset.find 'shhs'
+d.download
 
   Get your token here: https://sleepdata.org/token
+  Your input is hidden while entering token.
      Enter your token: AUTHORIZED
            File Check: md5
                 Depth: recursive
@@ -146,13 +157,14 @@ You can type `Ctrl-C` to pause the download, and retype the command to restart:
 ^C
     Interrupted
 
-Finished in 4.384734 seconds.
+  Finished in 4.384734 seconds.
 
-1 folder created, 2 files downloaded, 60 MiBs downloaded, 0 files skipped, 0 files failed
+  1 folder created, 2 files downloaded, 60 MiBs downloaded, 0 files skipped, 0 files failed
 
-> d.download
+d.download
 
   Get your token here: https://sleepdata.org/token
+  Your input is hidden while entering token.
      Enter your token: AUTHORIZED
            File Check: md5
                 Depth: recursive
@@ -164,27 +176,27 @@ Finished in 4.384734 seconds.
 ^C
     Interrupted
 
-Finished in 2.384734 seconds.
+  Finished in 2.384734 seconds.
 
-1 folder created, 0 files downloaded, 0 MiBs downloaded, 2 files skipped, 0 files failed
+  1 folder created, 0 files downloaded, 0 MiBs downloaded, 2 files skipped, 0 files failed
 ```
 
 ### Update the NSRR gem
 
 To make sure you're using the latest stable version of the NSRR gem, you can run the following command:
 
-```
+```console
 nsrr update
 ```
 
 ### Show the version of the NSRR gem
 
-```
+```console
 nsrr version
 ```
 
 ### Show the available commands of the NSRR gem
 
-```
+```console
 nsrr help
 ```

data/lib/nsrr/helpers/authorization.rb

@@ -5,6 +5,7 @@ module Nsrr
     class Authorization
       def self.get_token(token)
         puts  "  Get your token here: " + "#{Nsrr::WEBSITE}/token".colorize( :blue ).on_white.underline
+        puts  "  Your input is hidden while entering token.".colorize(:white)
         print "     Enter your token: "
         token = STDIN.noecho(&:gets).chomp if token.to_s.strip == ''
 

data/lib/nsrr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nsrr
 version: !ruby/object:Gem::Version
-  version: 0.2.0.rc
+  version: 0.2.0
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -123,9 +123,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6