nsrr 0.1.1 → 0.2.0.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f8c53c2659b9c4675815c8da96ac1c40eeb03da
-  data.tar.gz: 971bcc2bd566eaa7b1a7c9e55ac52630e3d69cc0
+  metadata.gz: b8c27aa5e00981e30edb2fd1e54be534f2080491
+  data.tar.gz: eedc928285c028bc7355ed1fa6a044978ce37fe7
 SHA512:
-  metadata.gz: 8f09358a58b5a3d2581e20efff43ab614ae1934d5d331220566a0b1e4e3417ded013b8ec416a9da2b855b98d4256fe14e378f864ea4262a1d26fca82a6925294
-  data.tar.gz: 1ca8bff8d3f083e9031354d55507d7e1424cc6758f0e9f9811d6dd9d2dcfafc521a89316b74a20370361cb54a65dbb613cf5d5ccbaf38d999abaf45876ff48cf
+  metadata.gz: b90b6320bedafd5eccf91672344ba0b5b5e27726abf0f3c3719bccdad996528af2a3ea66ca498aaa2b1818aa89068ff9c92d5301772f5b8ace20b7eaa32278f5
+  data.tar.gz: 72b6f6537adb848bc90e303562d7cc24bba363ca31d9b6818e3ba320af966cf7fa4abb96139c33a2a9f79990b3b40ad701047fecdd1e5fc16f38b3765c6c38bc

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.2.0
+
+### 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
+
+### Bug Fixes
+- Fixed an issue preventing public files from being downloaded when an invalid token was entered
+
 ## 0.1.1 (October 23, 2014)
 
 ### Enhancements

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 NSRR
+Copyright (c) 2015 NSRR
 https://github.com/nsrr
 
 

data/README.md

@@ -80,18 +80,18 @@ $ nsrr console
 ```
 > d = Dataset.find 'shhs'
 > d.download
+  Get your token here: https://sleepdata.org/token
+     Enter your token: AUTHORIZED
+           File Check: md5
+                Depth: recursive
 
-     File Integrity Check Method: md5
-                           Depth: recursive
-             Get your token here: https://sleepdata.org/token
-Please enter your download token:
       create shhs/
       create shhs/datasets
-   identical shhs-cvd-dataset-0.4.0.csv
-   identical shhs-data-dictionary-0.4.0-domains.csv
-   identical shhs-data-dictionary-0.4.0-forms.csv
-   identical shhs-data-dictionary-0.4.0-variables.csv
-   identical shhs1-dataset-0.4.0.csv
+   identical shhs-cvd-dataset-0.6.0.csv
+   identical shhs-data-dictionary-0.6.0-domains.csv
+   identical shhs-data-dictionary-0.6.0-forms.csv
+   identical shhs-data-dictionary-0.6.0-variables.csv
+   identical shhs1-dataset-0.6.0.csv
    ...
 ```
 
@@ -115,10 +115,10 @@ 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')
 
-     File Integrity Check Method: fast
-                           Depth: shallow
-             Get your token here: https://sleepdata.org/token
-Please enter your download token:
+  Get your token here: https://sleepdata.org/token
+     Enter your token: AUTHORIZED
+           File Check: md5
+                Depth: recursive
 
       create shhs/edfs/shhs1
     download 100001.EDF
@@ -134,15 +134,15 @@ You can type `Ctrl-C` to pause the download, and retype the command to restart:
 > d = Dataset.find 'shhs'
 > d.download
 
-     File Integrity Check Method: md5
-                           Depth: recursive
-             Get your token here: https://sleepdata.org/token
-Please enter your download token:
+  Get your token here: https://sleepdata.org/token
+     Enter your token: AUTHORIZED
+           File Check: md5
+                Depth: recursive
 
       create shhs/
       create shhs/datasets
-    download shhs-cvd-dataset-0.4.0.csv
-    download shhs-data-dictionary-0.4.0-domains.csv
+    download shhs-cvd-dataset-0.6.0.csv
+    download shhs-data-dictionary-0.6.0-domains.csv
 ^C
     Interrupted
 
@@ -152,15 +152,15 @@ Finished in 4.384734 seconds.
 
 > d.download
 
-     File Integrity Check Method: md5
-                           Depth: recursive
-             Get your token here: https://sleepdata.org/token
-Please enter your download token:
+  Get your token here: https://sleepdata.org/token
+     Enter your token: AUTHORIZED
+           File Check: md5
+                Depth: recursive
 
       create shhs/
       create shhs/datasets
-   identical shhs-cvd-dataset-0.4.0.csv
-   identical shhs-data-dictionary-0.4.0-domains.csv
+   identical shhs-cvd-dataset-0.6.0.csv
+   identical shhs-data-dictionary-0.6.0-domains.csv
 ^C
     Interrupted
 

data/lib/nsrr/commands/download.rb

@@ -1,6 +1,7 @@
 require 'colorize'
 
 require 'nsrr/models/all'
+require 'nsrr/helpers/authorization'
 
 module Nsrr
   module Commands
@@ -11,7 +12,7 @@ module Nsrr
         end
       end
 
-      attr_reader :dataset_slug, :folder, :file_comparison, :depth
+      attr_reader :token, :dataset_slug, :folder, :file_comparison, :depth
 
       def initialize(argv)
         (@token, argv) = parse_parameter_with_value(argv, ['token'], '')
@@ -21,19 +22,27 @@ module Nsrr
         @folder = (argv[1].to_s.split('/')[1..-1] || []).join('/')
       end
 
+      # Run with Authorization
       def run
-        @dataset = Dataset.find @dataset_slug
-        if @dataset
-          @dataset.download_token = @token
-          @dataset.download(@folder, depth: @depth, method: @file_comparison)
-        else
+        begin
           if @dataset_slug == nil
             puts "Please specify a dataset: " + "nsrr download DATASET".colorize(:white)
+            puts "Read more on the download command here:"
+            puts "  " + "https://github.com/nsrr/nsrr-gem".colorize( :blue ).on_white.underline
           else
-            puts "The dataset " + "#{@dataset_slug}".colorize(:white) + " was not found."
+            @token = Nsrr::Helpers::Authorization.get_token(@token) if @token.to_s == ''
+            @dataset = Dataset.find(@dataset_slug, @token)
+            if @dataset
+              @dataset.download(@folder, depth: @depth, method: @file_comparison)
+            else
+              puts "\nThe dataset " + "#{@dataset_slug}".colorize(:white) + " was not found."
+              auth_section = (@token.to_s == '' ? '' : "/a/#{@token}" )
+              datasets = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}#{auth_section}/datasets.json")
+              puts "Did you mean one of: #{datasets.collect{|d| d['slug'].colorize(:white)}.sort.join(', ')}" if datasets and datasets.size > 0
+            end
           end
-          puts "Read more on the download command here:"
-          puts "  " + "https://github.com/nsrr/nsrr-gem".colorize( :blue ).on_white.underline
+        rescue Interrupt
+          puts "\nINTERRUPTED".colorize(:red)
         end
       end
 

data/lib/nsrr/helpers/authorization.rb

@@ -0,0 +1,22 @@
+require 'nsrr/helpers/json_request'
+
+module Nsrr
+  module Helpers
+    class Authorization
+      def self.get_token(token)
+        puts  "  Get your token here: " + "#{Nsrr::WEBSITE}/token".colorize( :blue ).on_white.underline
+        print "     Enter your token: "
+        token = STDIN.noecho(&:gets).chomp if token.to_s.strip == ''
+
+        response = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}/account/#{token}/profile.json")
+
+        if response.kind_of?(Hash) and response['authenticated']
+          puts "AUTHORIZED".colorize(:green) + " as " + "#{response['first_name']} #{response['last_name']}".colorize( :white )
+        else
+          puts "UNAUTHORIZED".colorize(:red) + " Public Access Only"
+        end
+        token
+      end
+    end
+  end
+end

data/lib/nsrr/models/dataset.rb

@@ -6,16 +6,18 @@ require 'io/console'
 require 'nsrr/helpers/constants'
 require 'nsrr/helpers/hash_helper'
 require 'nsrr/helpers/json_request'
+require 'nsrr/helpers/authorization'
 
 require 'nsrr/models/file'
 
 module Nsrr
   module Models
     class Dataset
-      def self.find(slug)
-        json = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}/datasets/#{slug}.json")
+      def self.find(slug, token = nil)
+        auth_section = (token.to_s == '' ? '' : "/a/#{token}")
+        json = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}#{auth_section}/datasets/#{slug}.json")
         if json
-          new(json)
+          new(json, token)
         else
           nil
         end
@@ -24,16 +26,17 @@ module Nsrr
       attr_accessor :download_token
       attr_reader :slug, :name
 
-      def initialize(json = {})
+      def initialize(json = {}, token = nil)
         @slug = json['slug']
         @name = json['name']
         @files = {}
-        @download_token = nil
+        @download_token = token
       end
 
       def files(path = nil)
         @files[path] ||= begin
-          json = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}/datasets/#{@slug}/json_manifest/#{path}")
+          auth_section = (@download_token.to_s == '' ? '' : "/a/#{@download_token}" )
+          json = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}/datasets/#{@slug}#{auth_section}/json_manifest/#{path}")
           (json || []).collect{|file_json| Nsrr::Models::File.new(file_json)}
         end
       end
@@ -61,10 +64,11 @@ module Nsrr
         @files_failed = 0
 
         begin
-          if @download_token.to_s == ''
-            puts "     File Integrity Check Method: " + options[:method].to_s.colorize(:white)
-            puts "                           Depth: " + options[:depth].to_s.colorize(:white)
-            set_download_token()
+          puts "           File Check: " + options[:method].to_s.colorize(:white)
+          puts "                Depth: " + options[:depth].to_s.colorize(:white)
+          puts ""
+          if @download_token == nil
+            @download_token = Nsrr::Helpers::Authorization.get_token(@download_token)
           end
 
           @start_time = Time.now
@@ -115,13 +119,6 @@ module Nsrr
         @folders_created += 1
       end
 
-      def set_download_token
-        puts  "             Get your token here: " + "#{Nsrr::WEBSITE}/token".colorize( :blue ).on_white.underline
-        print "Please enter your download token: "
-        @download_token = STDIN.noecho(&:gets).chomp
-        puts ""
-      end
-
     end
   end
 end

data/lib/nsrr/models/file.rb

@@ -52,7 +52,8 @@ module Nsrr
       # If the second download and check fail, the file is marked as failed, and the downloader continues to the subsequent file.
       def force_download(path, token, method)
         download_folder = ::File.join(Dir.pwd, path.to_s, @name.to_s)
-        download_url = "#{Nsrr::WEBSITE}/datasets/#{@dataset_slug}/files/a/#{token}/m/nsrr-gem-v#{Nsrr::VERSION::STRING.gsub('.', '-')}/#{@file_path.to_s}"
+        auth_section = (token.to_s == '' ? '' : "/a/#{token}")
+        download_url = "#{Nsrr::WEBSITE}/datasets/#{@dataset_slug}/files#{auth_section}/m/nsrr-gem-v#{Nsrr::VERSION::STRING.gsub('.', '-')}/#{@file_path.to_s}"
         download_request = Nsrr::Helpers::DownloadRequest.new(download_url, download_folder)
         download_request.get
 

data/lib/nsrr/version.rb

@@ -1,9 +1,9 @@
 module Nsrr
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY = 1
-    BUILD = nil # nil, "pre", "rc", "rc2"
+    MINOR = 2
+    TINY = 0
+    BUILD = "rc" # nil, "pre", "rc", "rc2"
 
     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.1.1
+  version: 0.2.0.rc
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -98,6 +98,7 @@ files:
 - lib/nsrr/commands/console.rb
 - lib/nsrr/commands/download.rb
 - lib/nsrr/commands/update.rb
+- lib/nsrr/helpers/authorization.rb
 - lib/nsrr/helpers/constants.rb
 - lib/nsrr/helpers/download_request.rb
 - lib/nsrr/helpers/hash_helper.rb
@@ -122,12 +123,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: The official ruby gem to simplify file downloads and dataset integration