nsrr 0.2.0 → 0.3.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69a067a927b05ad944da6faccfdf79b6d470f940
-  data.tar.gz: fb46592c764214c6f6c8d3a854911d128c1336df
+  metadata.gz: 47192f16e29c8348a3806bf5b664d6f122772460
+  data.tar.gz: 2eb61ae1eb977358192775ca3fb4970eab77fe27
 SHA512:
-  metadata.gz: 18a1d58c5c4a82bed071492dc3598ae57e4273b1fc37d42b71cac834fc9d0157adaa58cd171c8f4c87bf4d45e68b28ce1b4a454f3864dd1600669758c3b4f069
-  data.tar.gz: 73557b26b0f68b376011a701ee105a3909c0c80e28c6700e00e9921de2ebadfd74f9c6b7507bc35b3e332c40d56cd6bc86f5711780beca02fe757c7291ac61a1
+  metadata.gz: c18289ef636386f3bfa9160ae229df05d6601db3f6160a0ce4143d26c04debc94afb0fb29d00feec8fedcc03e990f5010d2015ca63e64911b690045c1f3cbf6d
+  data.tar.gz: e9f5a51cd80df55a8a0fbad3651ee93222e890e5a1220b328507d98a69fe75db75e7fec8c94e7139accaf572c2886d0fac420802574ccb9d0d9ea2ba05169c67

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.3.0
+
+### Enhancements
+- **Download Command**
+  - The `nsrr download` command can now download single files
+    - Ex: `nsrr download shhs/datasets/CHANGELOG.md`
+  - User tokens are stripped of extra whitespace to avoid common authentication
+    issues
+- **Gem Changes**
+  - Updated to Ruby 2.3.0
+  - Updated to colorize 0.7.7
+  - Updated to simplecov 0.11.2
+  - Removed minitest-reporters
+  - Bundler is now a required dependency
+
+### Bug Fix
+- Fixed an issue that flooded test output with uninitialized string class instance variable `@disable_colorization`
+
 ## 0.2.0 (May 29, 2015)
 
 ### Enhancements

data/LICENSE

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

data/README.md

@@ -8,7 +8,7 @@ The official ruby gem built to simplify file downloads and dataset integration t
 
 ## Prerequisites
 
-You must have **Ruby 2.0+ installed** on your system to use the NSRR gem.
+You must have **Ruby 2.2+ installed** on your system to use the NSRR gem.
 
 - [Install Ruby on Windows](http://rubyinstaller.org/)
 - [Install Ruby on Mac](https://github.com/remomueller/documentation/blob/master/macosx/140-install-ruby.md)
@@ -24,19 +24,14 @@ Install it yourself as:
 gem install nsrr --no-ri --no-rdoc
 ```
 
-Or add this line to your application's Gemfile:
-
-```
-gem 'nsrr'
-```
-
-And then execute:
+**NOTE:** There is a bug in newer versions of RubyGems that prevent the NSRR gem
+from running correctly. If you run into issues, downgrade RubyGems using the
+following command:
 
 ```console
-bundle
+gem update --system 2.4.8 --no-ri --no-rdoc
 ```
 
-
 ## Usage
 
 ### Download files from a dataset
@@ -200,3 +195,45 @@ nsrr version
 ```console
 nsrr help
 ```
+
+## Common Issues
+
+### Errors Running Ruby in Windows Command Prompt
+
+In some cases when using Ruby on Windows through the Command Prompt, it is
+necessary to open the Command Prompt in **administrator mode** for the NSRR gem
+to work. This may be due to how Ruby was installed (for admins only), or the
+location the files are being downloaded to (a root directory C: for example).
+
+It is recommended to use the gem without elevated privileges first in any case
+(to download directly to Desktop for example) before using admin privileges for
+the Ruby gem.
+
+### Issue "'method_missing': undefined method 'this'" when running NSRR commands
+
+There is a bug in newer versions of RubyGems that prevent the NSRR gem
+from running correctly. If you run into issues, downgrade RubyGems using the
+following command:
+
+The following versions of RubyGems cause issues while running NSRR commands:
+
+- `2.5.0`
+- `2.5.1`
+- `2.5.2`
+- `2.6.0`
+- `2.6.1`
+- `2.6.2`
+
+You can check which version you have installed by typing:
+
+```console
+gem -v
+```
+
+You can fix this error by reverting to the last stable version of RubyGems,
+`2.4.8`.
+
+```console
+gem update --system 2.4.8 --no-ri --no-rdoc
+```
+

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
@@ -5,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
 task default: :test

data/bin/nsrr

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require File.expand_path('../../lib/nsrr', __FILE__)
 

data/lib/nsrr.rb

@@ -1,17 +1,19 @@
-require 'colorize'
+# frozen_string_literal: true
 
-require "nsrr/version"
+require 'colorize'
+require 'nsrr/version'
 
 Nsrr::COMMANDS = {
   'c' => :console,
   'd' => :download,
   'u' => :update,
   'v' => :version
-}
+}.freeze
 
+# Exposes certain commands for access from the command line.
 module Nsrr
   def self.launch(argv)
-    self.send((Nsrr::COMMANDS[argv.first.to_s.scan(/\w/).first] || :help), argv)
+    send((Nsrr::COMMANDS[argv.first.to_s.scan(/\w/).first] || :help), argv)
   end
 
   def self.console(argv)
@@ -29,7 +31,7 @@ module Nsrr
     Nsrr::Commands::Update.start(argv)
   end
 
-  def self.help(argv)
+  def self.help(_)
     puts <<-EOT
 
 Usage: nsrr COMMAND [ARGS]
@@ -45,13 +47,12 @@ 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 '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)
+  def self.version(_)
     puts "Nsrr #{Nsrr::VERSION::STRING}"
   end
-
 end

data/lib/nsrr/commands/console.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'irb'
 require 'irb/completion'
 require 'nsrr/models/all'
 
 module Nsrr
   module Commands
+    # Allows console to be started with the NSRR environment.
     class Console
       class << self
         def start(*args)
@@ -13,7 +16,7 @@ module Nsrr
 
       attr_reader :console
 
-      def initialize(argv)
+      def initialize(_argv)
         ARGV.clear
         @console = IRB
       end
@@ -22,7 +25,6 @@ module Nsrr
         puts "Loading environment (Nsrr #{Nsrr::VERSION::STRING})"
         @console.start
       end
-
     end
   end
 end

data/lib/nsrr/commands/download.rb

@@ -1,10 +1,13 @@
-require 'colorize'
+# frozen_string_literal: true
 
+require 'colorize'
 require 'nsrr/models/all'
 require 'nsrr/helpers/authorization'
 
 module Nsrr
   module Commands
+    # Downloads a folder or a file from the NSRR webserver. Folders can be
+    # downloaded recursively.
     class Download
       class << self
         def run(*args)
@@ -12,38 +15,35 @@ module Nsrr
         end
       end
 
-      attr_reader :token, :dataset_slug, :folder, :file_comparison, :depth
+      attr_reader :token, :dataset_slug, :full_path, :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('/')
+        @full_path = (argv[1].to_s.split('/')[1..-1] || []).join('/')
       end
 
       # Run with Authorization
       def run
-        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
+        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
+          @token = Nsrr::Helpers::Authorization.get_token(@token) if @token.to_s == ''
+          @dataset = Dataset.find(@dataset_slug, @token)
+          if @dataset
+            @dataset.download(@full_path, depth: @depth, method: @file_comparison)
           else
-            @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
+            puts "\nThe dataset " + @dataset_slug.to_s.colorize(:white) + ' was not found.'
+            (datasets, _status) = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}/datasets.json", auth_token: @token)
+            puts "Did you mean one of: #{datasets.collect { |d| d['slug'].colorize(:white)}.sort.join(', ') }" if datasets && datasets.size > 0
           end
-        rescue Interrupt
-          puts "\nINTERRUPTED".colorize(:red)
         end
+      rescue Interrupt
+        puts "\nINTERRUPTED".colorize(:red)
       end
 
       private

data/lib/nsrr/commands/update.rb

@@ -1,9 +1,11 @@
-require 'colorize'
+# frozen_string_literal: true
 
+require 'colorize'
 require 'nsrr/helpers/json_request'
 
 module Nsrr
   module Commands
+    # Command to check if there is an updated version of the gem available.
     class Update
       class << self
         def start(*args)
@@ -15,23 +17,21 @@ module Nsrr
       end
 
       def start
-        json = Nsrr::Helpers::JsonRequest.get("https://rubygems.org/api/v1/gems/nsrr.json")
-
+        (json, _status) = Nsrr::Helpers::JsonRequest.get('https://rubygems.org/api/v1/gems/nsrr.json')
         if json
           if json['version'] == Nsrr::VERSION::STRING
-            puts "The nsrr gem is " + "up-to-date".colorize(:green) + "!"
+            puts 'The nsrr gem is ' + 'up-to-date'.colorize(:green) + '!'
           else
             puts
             puts "A newer version (v#{json['version']}) is available! Type the following command to update:"
             puts
-            puts "  gem install nsrr --no-ri --no-rdoc".colorize(:white)
+            puts '  gem install nsrr --no-ri --no-rdoc'.colorize(:white)
             puts
           end
         else
-          puts "Unable to connect to RubyGems.org. Please try again later."
+          puts 'Unable to connect to RubyGems.org. Please try again later.'
         end
       end
-
     end
   end
 end

data/lib/nsrr/helpers/authorization.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 require 'nsrr/helpers/json_request'
 
 module Nsrr
   module Helpers
+    # Helper to verify that user is authenticated.
     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: "
+        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 == ''
-
-        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 )
+        token.strip!
+        (response, _status) = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}/api/v1/account/profile.json", auth_token: token)
+        if response.is_a?(Hash) && response['authenticated']
+          puts 'AUTHORIZED'.colorize(:green) + ' as ' + "#{response['first_name']} #{response['last_name']}".colorize(:white)
         else
-          puts "UNAUTHORIZED".colorize(:red) + " Public Access Only"
+          puts 'UNAUTHORIZED'.colorize(:red) + ' Public Access Only'
         end
         token
       end

data/lib/nsrr/helpers/constants.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Nsrr::WEBSITE = "https://sleepdata.org"

data/lib/nsrr/helpers/download_request.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'net/http'
 require 'uri'
 
 module Nsrr
   module Helpers
+    # Downloads a file to a specified folder.
     class DownloadRequest
       class << self
         def get(*args)
@@ -14,49 +17,44 @@ module Nsrr
       attr_reader :url, :error, :file_size
 
       def initialize(url, download_folder)
-        begin
-          escaped_url = URI.escape(url)
-          @url = URI.parse(escaped_url)
-          @http = Net::HTTP.new(@url.host, @url.port)
-          if @url.scheme == 'https'
-            @http.use_ssl = true
-            @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          end
-          @download_folder = download_folder
-          @file_size = 0
-        rescue => e
-          @error = 'Invalid Token'
+        escaped_url = URI.escape(url)
+        @url = URI.parse(escaped_url)
+        @http = Net::HTTP.new(@url.host, @url.port)
+        if @url.scheme == 'https'
+          @http.use_ssl = true
+          @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
+        @download_folder = download_folder
+        @file_size = 0
+      rescue
+        @error = 'Invalid Token'
       end
 
       # Writes file segments to disk immediately instead of storing in memory
       def get
+        return unless @error.nil?
         local_file = ::File.open(@download_folder, 'wb')
-        begin
-          partial = true
-          @http.request_get(@url.path) do |response|
-            case response.code when '200'
-              response.read_body do |segment|
-                local_file.write(segment)
-              end
-              @file_size = ::File.size(@download_folder)
-              partial = false
-            when '302'
-              @error = 'Token Not Authorized to Access Specified File'
-            else
-              @error = "#{response.code} #{response.class.name}"
+        partial = true
+        @http.request_get(@url.path) do |response|
+          case response.code
+          when '200'
+            response.read_body do |segment|
+              local_file.write(segment)
             end
+            @file_size = ::File.size(@download_folder)
+            partial = false
+          when '302'
+            @error = 'Token Not Authorized to Access Specified File'
+          else
+            @error = "#{response.code} #{response.class.name}"
           end
-        rescue => e # Net::ReadTimeout, SocketError
-          @error = "(#{e.class}) #{e.message}"
-        ensure
-          local_file.close()
-          ::File.delete(@download_folder) if partial and ::File.exist?(@download_folder)
         end
+      rescue => e # Net::ReadTimeout, SocketError
+        @error = "(#{e.class}) #{e.message}"
+      ensure
+        local_file.close if local_file
+        ::File.delete(@download_folder) if partial && ::File.exist?(@download_folder)
       end
-
     end
   end
 end
-
-

data/lib/nsrr/helpers/hash_helper.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Nsrr
   module Helpers
+    # Converts hash with string keys into hash with keys as symbols.
     class HashHelper
       def self.symbolize_keys(hash)
         hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

data/lib/nsrr/helpers/json_request.rb

@@ -1,43 +1,93 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'net/http'
 require 'json'
+require 'cgi'
 
 module Nsrr
   module Helpers
+    # Aids in generating JSON requests for GET, POST, and PATCH.
     class JsonRequest
       class << self
-        def get(*args)
-          new(*args).get
+        def get(url, *args)
+          new(url, *args).get
+        end
+
+        def post(url, *args)
+          new(url, *args).post
+        end
+
+        def patch(url, *args)
+          new(url, *args).patch
         end
       end
 
       attr_reader :url
 
-      def initialize(url)
-        begin
-          @url = URI.parse(url)
-          @http = Net::HTTP.new(@url.host, @url.port)
-          if @url.scheme == 'https'
-            @http.use_ssl = true
-            @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          end
-        rescue
+      def initialize(url, args = {})
+        @params = nested_hash_to_params(args)
+        @url = URI.parse(url)
+
+        @http = Net::HTTP.new(@url.host, @url.port)
+        if @url.scheme == 'https'
+          @http.use_ssl = true
+          @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         end
+      rescue
+        @error = "Invalid URL: #{url.inspect}"
+        puts @error.colorize(:red)
       end
 
       def get
-        begin
-          req = Net::HTTP::Get.new(@url.path)
-          response = @http.start do |http|
-            http.request(req)
+        return unless @error.nil?
+        full_path = @url.path
+        query = ([@url.query] + @params).flatten.compact.join('&')
+        full_path += "?#{query}" if query.to_s != ''
+        response = @http.start do |http|
+          http.get(full_path)
+        end
+        [JSON.parse(response.body), response]
+      rescue => e
+        puts "GET Error: #{e}".colorize(:red)
+      end
+
+      def post
+        return unless @error.nil?
+        response = @http.start do |http|
+          http.post(@url.path, @params.flatten.compact.join('&'))
+        end
+        [JSON.parse(response.body), response]
+      rescue => e
+        puts "POST ERROR: #{e}".colorize(:red)
+        nil
+      end
+
+      def patch
+        @params << '_method=patch'
+        post
+      end
+
+      def nested_hash_to_params(args)
+        args.collect do |key, value|
+          key_value_to_string(key, value, nil)
+        end
+      end
+
+      def key_value_to_string(key, value, scope = nil)
+        current_scope = (scope ? "#{scope}[#{key}]" : key)
+        if value.is_a? Hash
+          value.collect do |k,v|
+            key_value_to_string(k, v, current_scope)
+          end.join('&')
+        elsif value.is_a? Array
+          value.collect do |v|
+            key_value_to_string('', v, current_scope)
           end
-          JSON.parse(response.body)
-        rescue
-          nil
+        else
+          "#{current_scope}=#{CGI.escape(value.to_s)}"
         end
       end
     end
   end
 end
-
-

data/lib/nsrr/models/all.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'nsrr/models/dataset'

data/lib/nsrr/models/dataset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'colorize'
 require 'fileutils'
 require 'irb'
@@ -12,10 +14,11 @@ require 'nsrr/models/file'
 
 module Nsrr
   module Models
+    # Allows dataset and dataset file information to be retrieved, as well as
+    # allowing dataset files to be downloaded.
     class Dataset
       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")
+        (json, _status) = Nsrr::Helpers::JsonRequest.get("#{Nsrr::WEBSITE}/api/v1/datasets/#{slug}.json", auth_token: token)
         if json
           new(json, token)
         else
@@ -31,18 +34,20 @@ module Nsrr
         @name = json['name']
         @files = {}
         @download_token = token
+        @downloaded_folders = []
       end
 
       def files(path = nil)
         @files[path] ||= begin
-          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)}
+          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
 
       def folders(path = nil)
-        self.files(path).select{|f| !f.is_file}.collect{|f| f.name}
+        files(path).select { |f| !f.is_file }.collect(&:file_name)
       end
 
       # Options include:
@@ -53,7 +58,7 @@ module Nsrr
       # depth:
       #   'recursive' => [default] Downloads files in selected path folder and all subfolders
       #   'shallow'   => Only downloads files in selected path folder
-      def download(path = nil, *args)
+      def download(full_path = nil, *args)
         options = Nsrr::Helpers::HashHelper.symbolize_keys(args.first || {})
         options[:method] ||= 'md5'
         options[:depth] ||= 'recursive'
@@ -64,16 +69,16 @@ module Nsrr
         @files_failed = 0
 
         begin
-          puts "           File Check: " + options[:method].to_s.colorize(:white)
-          puts "                Depth: " + options[:depth].to_s.colorize(:white)
-          puts ""
-          if @download_token == nil
+          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
 
-          download_helper(path, options)
+          download_helper(full_path, options)
         rescue Interrupt, IRB::Abort
           puts "\n   Interrupted".colorize(:red)
         end
@@ -81,21 +86,25 @@ module Nsrr
         @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".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(:light_blue) + ", " +
-             "#{@files_failed} file#{"s" if @files_failed != 1} failed".colorize(:red) + "\n\n"
+        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(:light_blue) + ', ' +
+             "#{@files_failed} file#{'s' if @files_failed != 1} failed".colorize(@files_failed == 0 ? :white : :red) + "\n\n"
         nil
       end
 
-      def download_helper(path, options)
-        current_folder = ::File.join(self.slug.to_s, path.to_s)
-        create_folder(current_folder) if self.files(path).count > 0
+      def download_helper(full_path, options)
+        return if @downloaded_folders.include?(full_path)
+        @downloaded_folders << full_path
+
+        create_folder_for_path(full_path)
 
-        self.files(path).select{|f| f.is_file}.each do |file|
+        files(full_path).select(&:is_file).each do |file|
+          current_folder = ::File.join(slug.to_s, file.folder.to_s)
           result = file.download(options[:method], current_folder, @download_token)
-          case result when 'fail'
+          case result
+          when 'fail'
             @files_failed += 1
           when 'skip'
             @files_skipped += 1
@@ -104,21 +113,25 @@ module Nsrr
             @downloaded_bytes += result
           end
         end
-
         if options[:depth] == 'recursive'
-          self.files(path).select{|f| !f.is_file}.each do |file|
-            folder = [path, file.name].compact.join('/')
-            self.download_helper(folder, options)
+          files(full_path).reject(&:is_file).each do |file|
+            download_helper(file.full_path, options)
           end
         end
       end
 
+      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
+
       def create_folder(folder)
-        puts "      create".colorize(:white) + " #{folder}"
+        puts '      create'.colorize(:white) + " #{folder}"
         FileUtils.mkdir_p folder
         @folders_created += 1
       end
-
     end
   end
 end

data/lib/nsrr/models/file.rb

@@ -1,22 +1,25 @@
-# Models a downloadable file or folder
-require 'digest/md5'
+# frozen_string_literal: true
 
+require 'digest/md5'
 require 'nsrr/helpers/constants'
 require 'nsrr/helpers/download_request'
 
 module Nsrr
   module Models
+    # Models a downloadable file or folder
     class File
-      attr_reader :name, :is_file, :web_file_size, :web_checksum
+      attr_reader :dataset_slug, :full_path, :folder, :file_name, :is_file, :file_size, :file_checksum_md5, :archived
 
       def initialize(json = {})
-        @name = json['file_name']
-        @web_checksum = json['checksum']
-        @is_file = json['is_file']
-        @web_file_size = json['file_size']
         @dataset_slug = json['dataset']
-        @file_path = json['file_path']
-        @latest_checksum = ""
+        @full_path = json['full_path']
+        @folder = json['folder']
+        @file_name = json['file_name']
+        @is_file = json['is_file']
+        @file_size = json['file_size']
+        @file_checksum_md5 = json['file_checksum_md5']
+        @archived = json['archived']
+        @latest_checksum = ''
         @latest_file_size = -1
       end
 
@@ -51,78 +54,73 @@ module Nsrr
       # If the file check fails, the file is downloaded a second time and rechecked.
       # 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_folder = ::File.join(Dir.pwd, path.to_s, @file_name.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_url = "#{Nsrr::WEBSITE}/datasets/#{@dataset_slug}/files#{auth_section}/m/nsrr-gem-v#{Nsrr::VERSION::STRING.gsub('.', '-')}/#{@full_path.to_s}"
         download_request = Nsrr::Helpers::DownloadRequest.new(download_url, download_folder)
         download_request.get
-
         download_success = false
-
         if download_request.error.to_s == ''
           # Check to see if the file downloaded correctly
           # If the file size doesn't match, attempt one additional download
           download_success = did_download_succeed?(method, path)
-
           unless download_success
             download_request = Nsrr::Helpers::DownloadRequest.new(download_url, download_folder)
             download_request.get
-
             download_success = did_download_succeed?(method, path)
           end
         end
-
         if download_request.error.to_s == '' and download_success
-          puts "  downloaded".colorize(:green) + " #{@name}"
+          puts "  downloaded".colorize(:green) + " #{@file_name}"
           download_request.file_size
         elsif download_request.error.to_s == ''
-          puts "      failed".colorize(:red) + " #{@name}"
+          puts "      failed".colorize(:red) + " #{@file_name}"
           if method == 'fast'
-            puts "             File size mismatch, expected: #{@web_file_size}"
+            puts "             File size mismatch, expected: #{@file_size}"
             puts "                                   actual: #{@latest_file_size}"
           else
-            puts "             File checksum mismatch, expected: #{@web_checksum}"
+            puts "             File checksum mismatch, expected: #{@file_checksum_md5}"
             puts "                                       actual: #{@latest_checksum}"
           end
           ::File.delete(download_folder) if ::File.exist?(download_folder)
           'fail'
         else
-          puts "      failed".colorize(:red) + " #{@name}"
+          puts '      failed'.colorize(:red) + " #{@file_name}"
           puts "             #{download_request.error}"
           'fail'
         end
       end
 
       def skip
-        puts "   identical".colorize(:light_blue) + " #{self.name}"
+        puts '   identical'.colorize(:light_blue) + " #{file_name}"
         'skip'
       end
 
       def md5_matches?(path)
-        @web_checksum == local_checksum(path)
+        @file_checksum_md5 == local_checksum(path)
       end
 
       def local_checksum(path)
-        download_folder = ::File.join(Dir.pwd, path.to_s, self.name.to_s)
+        download_folder = ::File.join(Dir.pwd, path.to_s, file_name.to_s)
         @latest_checksum = if ::File.exist?(download_folder)
-          Digest::MD5.file(download_folder).hexdigest
-        else
-          ""
-        end
+                             Digest::MD5.file(download_folder).hexdigest
+                           else
+                             ''
+                           end
         @latest_checksum
       end
 
       def file_size_matches?(path)
-        @web_file_size == local_filesize(path)
+        @file_size == local_filesize(path)
       end
 
       def local_filesize(path)
-        download_folder = ::File.join(Dir.pwd, path.to_s, self.name.to_s)
+        download_folder = ::File.join(Dir.pwd, path.to_s, file_name.to_s)
         @latest_file_size = if ::File.exist?(download_folder)
-          ::File.size(download_folder)
-        else
-          -1
-        end
+                              ::File.size(download_folder)
+                            else
+                              -1
+                            end
         @latest_file_size
       end
 
@@ -133,8 +131,6 @@ module Nsrr
           md5_matches?(path)
         end
       end
-
     end
   end
 end
-

data/lib/nsrr/version.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Nsrr
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 2
+    MINOR = 3
     TINY = 0
-    BUILD = nil # "pre", "rc", "rc2", nil
+    BUILD = 'beta1' # 'pre', 'beta1', 'beta2', 'rc', 'rc2', nil
 
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end

data/nsrr.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 # Compiling the Gem
 # gem build nsrr.gemspec
@@ -12,24 +13,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'nsrr/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "nsrr"
+  spec.name          = 'nsrr'
   spec.version       = Nsrr::VERSION::STRING
-  spec.authors       = ["Remo Mueller"]
-  spec.email         = ["remosm@gmail.com"]
-  spec.summary       = %q{The official ruby gem to simplify file downloads and dataset integration tasks for the NSRR website, https://sleepdata.org}
-  spec.description   = %q{The official ruby gem to simplify file downloads and dataset integration tasks for the NSRR website, https://sleepdata.org}
-  spec.homepage      = "https://github.com/nsrr/nsrr-gem"
-  spec.license       = "CC BY-NC-SA 3.0"
+  spec.authors       = ['Remo Mueller']
+  spec.email         = ['remosm@gmail.com']
+  spec.summary       = 'The official ruby gem to simplify file downloads and dataset integration tasks for the NSRR website, https://sleepdata.org'
+  spec.description   = 'The official ruby gem to simplify file downloads and dataset integration tasks for the NSRR website, https://sleepdata.org'
+  spec.homepage      = 'https://github.com/nsrr/nsrr-gem'
+  spec.license       = 'CC BY-NC-SA 3.0'
 
   spec.files = Dir['{bin,lib}/**/*'] + ['CHANGELOG.md', 'LICENSE', 'Rakefile', 'README.md', 'nsrr.gemspec']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rake"
-  spec.add_dependency "minitest"
-  spec.add_dependency "minitest-reporters"
-  spec.add_dependency "colorize", "~> 0.7.3"
-
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_dependency 'bundler', '~> 1.11'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'minitest'
+  spec.add_dependency 'colorize', '~> 0.7.7'
 end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: nsrr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0.beta1
 platform: ruby
 authors:
 - Remo Mueller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -58,28 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.7.7
 description: The official ruby gem to simplify file downloads and dataset integration
   tasks for the NSRR website, https://sleepdata.org
 email:
@@ -123,12 +109,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.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: The official ruby gem to simplify file downloads and dataset integration