droxi 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55c2e238628368cdd91abd0fb76a31cb0b217159
-  data.tar.gz: bf2bec767b3e0b80bf264a2784fc9b2c3cda15a6
+  metadata.gz: fd104f683fa09123fc4146c2536d47c440139454
+  data.tar.gz: be57a75ccca1e2c18cca4e9e71df753b5df2f5d7
 SHA512:
-  metadata.gz: 18f9cad5986b95260f0c9743231bff2c5a9bc634d7fa61a39ead74664d8c61a2a803b31a91bfd96df2a7acbecf381aa04c8d13c378ad2aaa0d08e94fdbf94f0d
-  data.tar.gz: 0414164a2564a94de66d758422ef65e213909952a3dc69f4fb1dd10265f01cb000f7d5debb10afd302116d55f47979656720bf4b9866dc5db859d059272a7a2b
+  metadata.gz: 45416d90dec9c6ea116b7c360efcdd0b336e5d6b7933cba981173a9d7337f0bac89798f5b8db13332c77e79da385f4b77e1c334c9410892303051f229e8a61ee
+  data.tar.gz: d7c3403cf8cdd2684fb5f0f051473802792a9bb1680b28cc5447d1537df63a61befd0b09744854752bc6e1ac1092b725d455211458d298c423ea398f9fc72ede

data/README.md

@@ -28,7 +28,8 @@ features
   [GNU ftp](http://www.gnu.org/software/inetutils/), and
   [lftp](http://lftp.yar.ru/)
 - context-sensitive tab completion and path globbing
-- upload, download, organize, and share files
+- upload, download, organize, search, and share files
+- file revision control
 - man page and interactive help
 
 developer features

data/Rakefile

@@ -80,6 +80,11 @@ task :build do
   build_page
 end
 
+desc 'build html version of man page'
+task :html do
+  sh 'groff -man -T html build/droxi.1 > build/droxi.html'
+end
+
 PREFIX = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
 BIN_PATH = "#{PREFIX}/bin"
 MAN_PATH = "#{PREFIX}/share/man/man1"

data/droxi.1.template

@@ -18,7 +18,13 @@ Pass a string to be executed by the local shell.
 --debug
 Enable the 'debug' command for the session.
 .TP
+--help
+Print help information and exit.
+.TP
 --version
 Print version information and exit.
+.SH BUGS
+If you find one, please use https://github.com/jangler/droxi/issues to report
+it, or contact me via email.
 .SH AUTHOR
 Written by Brandon Mulcahy (brandon@jangler.info).

data/droxi.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'droxi'
   s.version     = IO.read('lib/droxi.rb')[/VERSION = '(.+)'/, 1]
-  s.date        = '2014-06-08'
+  s.date        = '2014-06-09'
   s.summary     = 'ftp-like command-line interface to Dropbox'
   s.description = "A command-line Dropbox interface inspired by GNU \
                    coreutils, GNU ftp, and lftp. Features include smart tab \

data/lib/droxi/commands.rb

@@ -212,6 +212,32 @@ module Commands
     end
   )
 
+  # Get remote file revisions.
+  HISTORY = Command.new(
+    'history REMOTE_FILE',
+    "Print a list of revisions for a remote file. The file can be restored to \
+     a previous revision using the 'restore' command and a revision ID given \
+     by this command.",
+    lambda do |client, state, args|
+      extract_flags('history', args, '')
+      path = state.resolve_path(args.first)
+      if !state.metadata(path) || state.directory?(path)
+        warn "history: #{args.first}: no such file"
+      else
+        try_and_handle(DropboxError) do
+          client.revisions(path).each do |rev|
+
+            size = rev['size'].sub(/ (.)B/, '\1').sub(' bytes', '').rjust(7)
+            mtime = Time.parse(rev['modified'])
+            current_year = (mtime.year == Time.now.year)
+            format_str = current_year ? '%b %e %H:%M' : '%b %e  %Y'
+            puts "#{size} #{mtime.strftime(format_str)} #{rev['rev']}"
+          end
+        end
+      end
+    end
+  )
+
   # Change the local working directory.
   LCD = Command.new(
     'lcd [LOCAL_DIR]',
@@ -355,6 +381,24 @@ module Commands
     end
   )
 
+  # Restore a remove file to a previous version.
+  RESTORE = Command.new(
+    'restore REMOTE_FILE REVISION_ID',
+    "Restore a remote file to a previous version. Use the 'history' command \
+     to get a list of IDs for previous revisions of the file.",
+    lambda do |client, state, args|
+      extract_flags('restore', args, '')
+      path = state.resolve_path(args.first)
+      if !state.metadata(path) || state.directory?(path)
+        warn "restore: #{args.first}: no such file"
+      else
+        try_and_handle(DropboxError) do
+          client.restore(path, args.last)
+        end
+      end
+    end
+  )
+
   # Remove remote files.
   RM = Command.new(
     'rm [-r] REMOTE_FILE...',
@@ -409,6 +453,25 @@ module Commands
     end
   )
 
+  # Search for remote files.
+  SEARCH = Command.new(
+    'search REMOTE_DIR SUBSTRING...',
+    "List remote files in a directory or its subdirectories with names that \
+     contain all given substrings.",
+    lambda do |client, state, args|
+      extract_flags('search', args, '')
+      path = state.resolve_path(args.first)
+      unless state.directory?(path)
+        warn "search: #{args.first}: no such directory"
+        return
+      end
+      query = args.drop(1).join(' ')
+      try_and_handle(DropboxError) do
+        client.search(path, query).each { |result| puts result['path'] }
+      end
+    end
+  )
+
   # Get permanent links to remote files.
   SHARE = Command.new(
     'share REMOTE_FILE...',

data/lib/droxi.rb

@@ -5,11 +5,20 @@ require_relative 'droxi/commands'
 require_relative 'droxi/complete'
 require_relative 'droxi/settings'
 require_relative 'droxi/state'
+require_relative 'droxi/text'
 
 # Command-line Dropbox client module.
 module Droxi
   # Version number of the program.
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
+
+  # Message to display when invoked with the --help option.
+  HELP_TEXT =
+    "If you've installed this program using Rake or the AUR package, you " \
+    'should also have the man page installed on your system. `man droxi` ' \
+    "should do the trick. Otherwise--meaning you've probably installed it " \
+    "as a Ruby gem--you don't, which is a shame. In that case, you can " \
+    'access the man page at http://jangler.info/man/droxi in HTML form.'
 
   # Run the client.
   def self.run(args)
@@ -20,7 +29,10 @@ module Droxi
     args.shift(options.size)
 
     args.empty? ? run_interactive(client, state) : invoke(args, client, state)
-
+  rescue DropboxAuthError => error
+    warn error
+    Settings.delete(:access_token)
+  ensure
     Settings.save
   end
 
@@ -30,10 +42,9 @@ module Droxi
   # +Array+ of the extracted options.
   def self.handle_options(args)
     options = args.take_while { |s| s.start_with?('--') }
-    if options.include?('--version')
-      puts "droxi v#{VERSION}"
-      exit
-    end
+    puts "droxi v#{VERSION}" if options.include?('--version')
+    Text.wrap(HELP_TEXT).each { |s| puts s } if options.include?('--help')
+    exit if %w(--help --version).any? { |s| options.include?(s) }
     options
   end
 

data/spec/cache_spec.rb

@@ -0,0 +1,88 @@
+require 'minitest/autorun'
+
+require_relative '../lib/droxi/cache'
+
+describe Cache do
+  before do
+    @cache = Cache.new
+  end
+
+  def file(path)
+    { 'path' => path, 'is_dir' => false }
+  end
+
+  def dir(path)
+    { 'path' => path, 'is_dir' => true, 'contents' => [] }
+  end
+
+  describe 'when adding file metadata to the cache' do
+    it 'must associate the path with the metadata hash' do
+      @cache.add(file('/file'))
+      @cache['/file'].wont_be_nil
+    end
+
+    it 'must associate the path with its parent directory' do
+      @cache.add(dir('/dir'))
+      @cache.add(file('/dir/file'))
+      @cache['/dir']['contents'].size.must_equal 1
+    end
+
+    it 'must not duplicate data associated with parent directory' do
+      @cache.add(dir('/dir'))
+      @cache.add(file('/dir/file'))
+      @cache.add(file('/dir/file'))
+      @cache['/dir']['contents'].size.must_equal 1
+    end
+
+    it 'must add and associate directory contents' do
+      folder = dir('/dir')
+      contents = 3.times.map { |i| file("/dir/file#{i}") }
+      folder['contents'] = contents
+      @cache.add(folder)
+      @cache.size.must_equal 4
+    end
+  end
+
+  describe 'when removing a path from the cache' do
+    it 'must delete the metadata from the hash' do
+      @cache.add(file('/file'))
+      @cache.remove('/file')
+      @cache.must_be :empty?
+    end
+
+    it 'must delete the metadata from the parent directory' do
+      @cache.add(dir('/dir'))
+      @cache.add(file('/dir/file'))
+      @cache.remove('/dir/file')
+      @cache['/dir']['contents'].must_be :empty?
+    end
+
+    it 'must delete contents recursively' do
+      @cache.add(dir('/dir'))
+      @cache.add(file('/dir/file'))
+      @cache.remove('/dir')
+      @cache.must_be :empty?
+    end
+  end
+
+  describe 'when querying whether the cache has full info on a path' do
+    it 'must return true for files' do
+      @cache.add(file('/file'))
+      @cache.full_info?('/file').must_equal true
+    end
+
+    it 'must return false for fictional files' do
+      @cache.full_info?('/file').wont_equal true
+    end
+
+    it 'must return false for directories without contents' do
+      @cache.add('path' => '/dir', 'is_dir' => true)
+      @cache.full_info?('/dir').wont_equal true
+    end
+
+    it 'must return true for directories with contents' do
+      @cache.add(dir('/dir'))
+      @cache.full_info?('/dir').must_equal true
+    end
+  end
+end

data/spec/commands_spec.rb

@@ -257,6 +257,30 @@ describe Commands do
     end
   end
 
+  describe 'when executing the history command' do
+    before do
+      state.pwd = TestUtils::TEST_ROOT
+      @history = proc do |*args|
+        capture_io { Commands::HISTORY.exec(client, state, *args) }
+      end
+    end
+
+    it 'must give the revision history of a given file' do
+      TestUtils.structure(client, state, 'test.txt')
+      out, _ = @history.call('test.txt')
+      out.lines.size.must_be :>=, 1
+    end
+
+    it 'must fail when given a bogus filename or directory name' do
+      TestUtils.structure(client, state, 'test')
+      %w(bogus test).each do |arg|
+        _, err = @history.call(arg)
+        err.lines.size.must_equal 1
+        err.start_with?('history: ').must_equal true
+      end
+    end
+  end
+
   describe 'when executing the lcd command' do
     it 'must change to home directory when given no args' do
       prev_pwd = Dir.pwd
@@ -478,6 +502,32 @@ describe Commands do
     end
   end
 
+  describe 'when executing the restore command' do
+    before do
+      state.pwd = TestUtils::TEST_ROOT
+      @restore = proc do |*args|
+        capture_io { Commands::RESTORE.exec(client, state, *args) }
+      end
+    end
+
+    it 'must set the revision of a file' do
+      TestUtils.structure(client, state, 'test.txt')
+      out, _ = capture_io { Commands::HISTORY.exec(client, state, 'test.txt') }
+      rev = out.split.last
+      _, err = @restore.call('test.txt', rev)
+      err.must_be :empty?
+    end
+
+    it 'must fail when given a bogus filename or directory name' do
+      TestUtils.structure(client, state, 'test')
+      %w(bogus test).each do |arg|
+        _, err = @restore.call(arg, 'n/a')
+        err.lines.size.must_equal 1
+        err.start_with?('restore: ').must_equal true
+      end
+    end
+  end
+
   describe 'when executing the share command' do
     before do
       @share = proc do |*args|
@@ -486,8 +536,8 @@ describe Commands do
     end
 
     it 'must yield URL when given file path' do
-      TestUtils.structure(client, state, 'test.txt')
-      out, _ = @share.call('/testing/test.txt')
+      TestUtils.structure(client, state, 'share.txt')
+      out, _ = @share.call('/testing/share.txt')
       out.lines.size.must_equal 1
       %r{https://.+\..+/}.match(out).wont_be_nil
     end
@@ -511,17 +561,16 @@ describe Commands do
     end
 
     it 'must remove the remote file when given args' do
-      TestUtils.structure(client, state, 'test.txt')
-      @rm.call('/testing/test.txt')
-      state.metadata('/testing/test.txt').must_be_nil
+      TestUtils.structure(client, state, 'file.txt')
+      @rm.call('/testing/file.txt')
+      state.metadata('/testing/file.txt').must_be_nil
     end
 
     it 'must change pwd to existing dir if the current one is removed' do
-      # FIXME: I don't know why this test fails. It works in practice.
-      # TestUtils.structure(client, state, 'one', 'one/two')
-      # Commands::CD.exec(client, state, '/testing/one/two')
-      # Commands::RM.exec(client, state, '..')
-      # state.pwd.must_equal('/testing')
+      TestUtils.structure(client, state, 'one', 'one/two')
+      Commands::CD.exec(client, state, '/testing/one/two')
+      Commands::RM.exec(client, state, '-r', '..')
+      state.pwd.must_equal('/testing')
     end
 
     it 'must fail with UsageError when given no args' do
@@ -549,6 +598,29 @@ describe Commands do
     end
   end
 
+  describe 'when executing the search command' do
+    before do
+      state.pwd = TestUtils::TEST_ROOT
+      @search = proc do |*args|
+        capture_io { Commands::SEARCH.exec(client, state, *args) }
+      end
+    end
+
+    it 'must list files iff they match the given substrings' do
+      TestUtils.exact_structure(client, state,
+                                'hello.txt', 'world.txt',
+                                'hi.txt', 'hello.md')
+      out, _ = @search.call('.', 'o', 'txt')
+      out.split("\n").must_equal ['/testing/hello.txt', '/testing/world.txt']
+    end
+
+    it 'must fail if given a bogus directory name' do
+      _, err = @search.call('bogus', 'substring')
+      err.lines.size.must_equal 1
+      err.start_with?('search: ').must_equal true
+    end
+  end
+
   describe 'when executing the help command' do
     before do
       @help = proc do |*args|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droxi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Brandon Mulcahy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dropbox-sdk
@@ -52,6 +52,7 @@ files:
 - lib/droxi/state.rb
 - lib/droxi/text.rb
 - spec/all.rb
+- spec/cache_spec.rb
 - spec/commands_spec.rb
 - spec/complete_spec.rb
 - spec/settings_spec.rb
@@ -83,3 +84,4 @@ signing_key:
 specification_version: 4
 summary: ftp-like command-line interface to Dropbox
 test_files: []
+has_rdoc: