droxi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa77e9e1c5c65c6d9552b77bee94b0c4395b4a74
-  data.tar.gz: 404cfd0e77d97c811daa867f544b6a2faf440a4a
+  metadata.gz: db93fae1cb4f2b8945d7bac19ad38940817f2f6e
+  data.tar.gz: 8a8d36e14900fefebba6a090dae94df16cbe7c64
 SHA512:
-  metadata.gz: 273cb971fa6a4412c44aafe050e33767063cb4d0c38203858e8b8e6988c19b1884c4c99b688dffdc7cbb661a8e3851a9322ee6fcd2ca3b3f487964eae0a869ac
-  data.tar.gz: 7c18c86aef2cdfb0cb46c571bf01db930ab87b396ac6ee1f6b5e26de758151b4ce0eb16ce3775245b173cb6eb50579c8e3df1f71a14c0985a3978bde474f7123
+  metadata.gz: 8212f5b0d45da0538697258becc8d3f7e6971c6e9b72e66b2fee4aa001c78a4831fc3fe1358384e1a0b574c423a46bc5ebf4264ef647dc359150035a28aaeddb
+  data.tar.gz: 99355ccb042b1f05b784d19e4c8ba723c248ce51c292514be89575d1d6ba2a34a3ec468e05c3eafcc77b5ff8af79b3986ed52931b9333b9beea14a51cf031833

data/bin/droxi

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require_relative '../lib/droxi'
-Droxi.run(*(ARGV.reject { |arg| arg == '--debug' }))
+Droxi.run(ARGV.dup)

data/droxi.1.template

@@ -2,7 +2,7 @@
 .SH NAME
 droxi \- ftp-like command-line interface to Dropbox
 .SH SYNOPSIS
-droxi [COMMAND] [ARGUMENT]...
+droxi [OPTION]... [COMMAND] [ARGUMENT]...
 .SH DESCRIPTION
 A command-line Dropbox interface inspired by GNU coreutils, GNU ftp, and lftp.
 Features include smart tab completion, globbing, and interactive help. If
@@ -10,5 +10,12 @@ invoked without arguments, runs in interactive mode. If invoked with arguments,
 parses the arguments as a command invocation, executes the command, and exits.
 .SH COMMANDS
 %{commands}
+.SH OPTIONS
+.TP
+--debug
+Enable the 'debug' command for the session.
+.TP
+--version
+Print version information and exit.
 .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     = '0.1.1'
-  s.date        = '2014-06-06'
+  s.version     = IO.read('lib/droxi.rb')[/VERSION = '(.+)'/, 1]
+  s.date        = '2014-06-07'
   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

@@ -20,22 +20,19 @@ module Commands
     attr_reader :description
 
     # Create a new +Command+ with the given metadata and a +Proc+ specifying
-    # its behavior. The +Proc+ will receive four arguments: the
-    # +DropboxClient+, the +State+, an +Array+ of command-line arguments, and
-    # a +Proc+ to be called for output.
+    # its behavior. The +Proc+ will receive three arguments: the
+    # +DropboxClient+, the +State+, and an +Array+ of command-line arguments.
     def initialize(usage, description, procedure)
       @usage = usage
       @description = description.squeeze(' ')
       @procedure = procedure
     end
 
-    # Attempt to execute the +Command+, yielding lines of output if a block is
-    # given. Raises a +UsageError+ if an invalid number of command-line
-    # arguments is given.
+    # Attempt to execute the +Command+. Raises a +UsageError+ if an invalid
+    # number of command-line arguments is given.
     def exec(client, state, *args)
       fail UsageError, @usage unless num_args_ok?(args.size)
-      block = proc { |line| yield line if block_given? }
-      @procedure.yield(client, state, args, block)
+      @procedure.yield(client, state, args)
     end
 
     # Return a +String+ describing the type of argument at the given index.
@@ -71,7 +68,8 @@ module Commands
      Dropbox root. With a remote directory name as the argument, changes to \
      that directory. With - as the argument, changes to the previous working \
      directory.",
-    lambda do |_client, state, args, output|
+    lambda do |_client, state, args|
+      extract_flags('cd', args, '')
       case
       when args.empty? then state.pwd = '/'
       when args.first == '-' then state.pwd = state.oldpwd
@@ -80,7 +78,7 @@ module Commands
         if state.directory?(path)
           state.pwd = path
         else
-          output.call("cd: #{args.first}: no such directory")
+          warn "cd: #{args.first}: no such directory"
         end
       end
     end
@@ -88,13 +86,14 @@ module Commands
 
   # Copy remote files.
   CP = Command.new(
-    'cp REMOTE_FILE... REMOTE_FILE',
+    'cp [-f] REMOTE_FILE... REMOTE_FILE',
     "When given two arguments, copies the remote file or folder at the first \
      path to the second path. When given more than two arguments or when the \
      final argument is a directory, copies each remote file or folder into \
-     that directory.",
-    lambda do |client, state, args, output|
-      cp_mv(client, state, args, output, 'cp')
+     that directory. Will refuse to overwrite existing files unless invoked \
+     with the -f option.",
+    lambda do |client, state, args|
+      cp_mv(client, state, args, 'cp')
     end
   )
 
@@ -104,16 +103,18 @@ module Commands
     "Evaluates the given string as Ruby code and prints the result. Won't \
      work unless the program was invoked with the --debug flag.",
     # rubocop:disable Lint/UnusedBlockArgument, Lint/Eval
-    lambda do |client, state, args, output|
+    lambda do |client, state, args|
       if ARGV.include?('--debug')
         begin
-          output.call(eval(args.join(' ')).inspect)
+          p eval(args.join(' '))
           # rubocop:enable Lint/UnusedBlockArgument, Lint/Eval
+        rescue SyntaxError => error
+          warn error
         rescue => error
-          output.call(error.inspect)
+          warn error.inspect
         end
       else
-        output.call('debug: not enabled.')
+        warn 'debug: not enabled.'
       end
     end
   )
@@ -122,7 +123,8 @@ module Commands
   EXIT = Command.new(
     'exit',
     'Exit the program.',
-    lambda do |_client, state, _args, _output|
+    lambda do |_client, state, args|
+      extract_flags('exit', args, '')
       state.exit_requested = true
     end
   )
@@ -133,12 +135,13 @@ module Commands
     "Clear the client-side cache of remote filesystem metadata. With no \
      arguments, clear the entire cache. If given directories as arguments, \
      (recursively) clear the cache of those directories only.",
-    lambda do |_client, state, args, output|
+    lambda do |_client, state, args|
+      extract_flags('forget', args, '')
       if args.empty?
         state.cache.clear
       else
         args.each do |arg|
-          state.forget_contents(arg) { |line| output.call(line) }
+          state.forget_contents(arg) { |line| warn line }
         end
       end
     end
@@ -146,19 +149,25 @@ module Commands
 
   # Download remote files.
   GET = Command.new(
-    'get REMOTE_FILE...',
+    'get [-f] REMOTE_FILE...',
     "Download each specified remote file to a file of the same name in the \
-     local working directory.",
-    lambda do |client, state, args, output|
+     local working directory. Will refuse to overwrite existing files unless \
+     invoked with the -f option.",
+    lambda do |client, state, args|
+      flags = extract_flags('get', args, '-f')
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("get: #{path}: no such file or directory")
+          warn "get: #{path}: no such file or directory"
         else
-          try_and_handle(DropboxError, output) do
-            contents = client.get_file(path)
-            basename = File.basename(path)
-            File.open(basename, 'wb') { |file| file.write(contents) }
-            output.call("#{basename} <- #{path}")
+          basename = File.basename(path)
+          try_and_handle(DropboxError) do
+            if flags.include?('-f') || !File.exist?(basename)
+              contents = client.get_file(path)
+              IO.write(basename, contents, mode: 'wb')
+              puts "#{basename} <- #{path}"
+            else
+              warn "get: #{basename}: local file already exists"
+            end
           end
         end
       end
@@ -170,17 +179,18 @@ module Commands
     'help [COMMAND]',
     "Print usage and help information about a command. If no command is \
      given, print a list of commands instead.",
-    lambda do |_client, _state, args, output|
+    lambda do |_client, _state, args|
+      extract_flags('help', args, '')
       if args.empty?
-        Text.table(NAMES).each { |line| output.call(line) }
+        Text.table(NAMES).each { |line| puts line }
       else
         cmd_name = args.first
         if NAMES.include?(cmd_name)
           cmd = const_get(cmd_name.upcase.to_s)
-          output.call(cmd.usage)
-          Text.wrap(cmd.description).each { |line| output.call(line) }
+          puts cmd.usage
+          Text.wrap(cmd.description).each { |line| puts line }
         else
-          output.call("Unrecognized command: #{cmd_name}")
+          warn "help: #{cmd_name}: no such command"
         end
       end
     end
@@ -193,7 +203,8 @@ module Commands
      home directory. With a local directory name as the argument, changes to \
      that directory. With - as the argument, changes to the previous working \
      directory.",
-    lambda do |_client, state, args, output|
+    lambda do |_client, state, args|
+      extract_flags('lcd', args, '')
       path = case
              when args.empty? then File.expand_path('~')
              when args.first == '-' then state.local_oldpwd
@@ -209,7 +220,7 @@ module Commands
         state.local_oldpwd = Dir.pwd
         Dir.chdir(path)
       else
-        output.call("lcd: #{args.first}: no such file or directory")
+        warn "lcd: #{args.first}: no such file or directory"
       end
     end
   )
@@ -222,13 +233,13 @@ module Commands
      arguments, list the contents of the directories. When given remote files \
      as arguments, list the files. If the -l option is given, display \
      information about the files.",
-    lambda do |_client, state, args, output|
-      long = args.delete('-l')
+    lambda do |_client, state, args|
+      long = extract_flags('ls', args, '-l').include?('-l')
 
       files, dirs = [], []
       state.expand_patterns(args, true).each do |path|
         if path.is_a?(GlobError)
-          output.call("ls: #{path}: no such file or directory")
+          warn "ls: #{path}: no such file or directory"
         else
           type = state.directory?(path) ? dirs : files
           type << path
@@ -238,16 +249,16 @@ module Commands
       dirs << state.pwd if args.empty?
 
       # First list files.
-      list(state, files, files, long) { |line| output.call(line) }
-      output.call('') unless dirs.empty? || files.empty?
+      list(state, files, files, long) { |line| puts line }
+      puts unless dirs.empty? || files.empty?
 
       # Then list directory contents.
       dirs.each_with_index do |dir, i|
-        output.call(dir + ':') if dirs.size + files.size > 1
+        puts "#{dir}:" if dirs.size + files.size > 1
         contents = state.contents(dir)
         names = contents.map { |path| File.basename(path) }
-        list(state, contents, names, long) { |line| output.call(line) }
-        output.call('') if i < dirs.size - 1
+        list(state, contents, names, long) { |line| puts line }
+        puts if i < dirs.size - 1
       end
     end
   )
@@ -257,14 +268,15 @@ module Commands
     'media REMOTE_FILE...',
     "Create Dropbox links to publicly share remote files. The links are \
      time-limited and link directly to the files themselves.",
-    lambda do |client, state, args, output|
+    lambda do |client, state, args|
+      extract_flags('media', args, '')
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("media: #{path}: no such file or directory")
+          warn "media: #{path}: no such file or directory"
         else
-          try_and_handle(DropboxError, output) do
+          try_and_handle(DropboxError) do
             url = client.media(path)['url']
-            output.call("#{File.basename(path)} -> #{url}")
+            puts "#{File.basename(path)} -> #{url}"
           end
         end
       end
@@ -275,9 +287,10 @@ module Commands
   MKDIR = Command.new(
     'mkdir REMOTE_DIR...',
     'Create remote directories.',
-    lambda do |client, state, args, output|
+    lambda do |client, state, args|
+      extract_flags('mkdir', args, '')
       args.each do |arg|
-        try_and_handle(DropboxError, output) do
+        try_and_handle(DropboxError) do
           path = state.resolve_path(arg)
           metadata = client.file_create_folder(path)
           state.cache.add(metadata)
@@ -288,35 +301,42 @@ module Commands
 
   # Move/rename remote files.
   MV = Command.new(
-    'mv REMOTE_FILE... REMOTE_FILE',
+    'mv [-f] REMOTE_FILE... REMOTE_FILE',
     "When given two arguments, moves the remote file or folder at the first \
      path to the second path. When given more than two arguments or when the \
      final argument is a directory, moves each remote file or folder into \
-     that directory.",
-    lambda do |client, state, args, output|
-      cp_mv(client, state, args, output, 'mv')
+     that directory. Will refuse to overwrite existing files unless invoked \
+     with the -f option.",
+    lambda do |client, state, args|
+      cp_mv(client, state, args, 'mv')
     end
   )
 
   # Upload a local file.
   PUT = Command.new(
-    'put LOCAL_FILE [REMOTE_FILE]',
+    'put [-f] LOCAL_FILE [REMOTE_FILE]',
     "Upload a local file to a remote path. If the remote path names a \
      directory, the file will be placed in that directory. If a remote file \
-     of the same name already exists, Dropbox will rename the upload. When \
-     given only a local file path, the remote path defaults to a file of the \
-     same name in the remote working directory.",
-    lambda do |client, state, args, output|
+     of the same name already exists, Dropbox will rename the upload unless \
+     the -f option is given, in which case the remote file will be \
+     overwritten. When given only a local file path, the remote path defaults \
+     to a file of the same name in the remote working directory.",
+    lambda do |client, state, args|
+      flags = extract_flags('put', args, '-f')
       from_path = args.first
       to_path = (args.size == 2) ? args[1] : File.basename(from_path)
       to_path = state.resolve_path(to_path)
       to_path << "/#{from_path}" if state.directory?(to_path)
 
-      try_and_handle(Exception, output) do
+      try_and_handle(StandardError) do
         File.open(File.expand_path(from_path), 'rb') do |file|
+          if flags.include?('-f') && state.metadata(to_path)
+            client.file_delete(to_path)
+            state.cache.remove(to_path)
+          end
           data = client.put_file(to_path, file)
           state.cache.add(data)
-          output.call("#{from_path} -> #{data['path']}")
+          puts "#{from_path} -> #{data['path']}"
         end
       end
     end
@@ -324,14 +344,49 @@ module Commands
 
   # Remove remote files.
   RM = Command.new(
-    'rm REMOTE_FILE...',
-    'Remove each specified remote file or directory.',
-    lambda do |client, state, args, output|
+    'rm [-r] REMOTE_FILE...',
+    "Remove each specified remote file. If the -r option is given, will \
+     also remove directories recursively.",
+    lambda do |client, state, args|
+      flags = extract_flags('rm', args, '-r')
+      state.expand_patterns(args).each do |path|
+        if path.is_a?(GlobError)
+          warn "rm: #{path}: no such file or directory"
+        else
+          if state.directory?(path) && !flags.include?('-r')
+            warn "rm: #{path}: is a directory"
+            next
+          end
+          try_and_handle(DropboxError) do
+            client.file_delete(path)
+            state.cache.remove(path)
+          end
+        end
+      end
+      check_pwd(state)
+    end
+  )
+
+  # Remove remote directories.
+  RMDIR = Command.new(
+    'rmdir REMOTE_DIR...',
+    'Remove each specified empty remote directory.',
+    lambda do |client, state, args|
+      extract_flags('rmdir', args, '')
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("rm: #{path}: no such file or directory")
+          warn "rmdir: #{path}: no such file or directory"
         else
-          try_and_handle(DropboxError, output) do
+          unless state.directory?(path)
+            warn "rmdir: #{path}: not a directory"
+            next
+          end
+          contents = state.metadata(path)['contents']
+          if contents && !contents.empty?
+            warn "rmdir: #{path}: directory not empty"
+            next
+          end
+          try_and_handle(DropboxError) do
             client.file_delete(path)
             state.cache.remove(path)
           end
@@ -348,14 +403,15 @@ module Commands
      shortened and direct to 'preview' pages of the files. Links created by \
      this method are set to expire far enough in the future so that \
      expiration is effectively not an issue.",
-    lambda do |client, state, args, output|
+    lambda do |client, state, args|
+      extract_flags('share', args, '')
       state.expand_patterns(args).each do |path|
         if path.is_a?(GlobError)
-          output.call("share: #{path}: no such file or directory")
+          warn "share: #{path}: no such file or directory"
         else
-          try_and_handle(DropboxError, output) do
+          try_and_handle(DropboxError) do
             url = client.shares(path)['url']
-            output.call("#{File.basename(path)} -> #{url}")
+            puts "#{File.basename(path)} -> #{url}"
           end
         end
       end
@@ -385,11 +441,11 @@ module Commands
   private
 
   # Attempt to run the associated block, handling the given type of +Exception+
-  # by passing its +String+ representation to an output +Proc+.
-  def self.try_and_handle(exception_class, output)
+  # by issuing a warning using its +String+ representation.
+  def self.try_and_handle(exception_class)
     yield
   rescue exception_class => error
-    output.call(error.to_s)
+    warn error
   end
 
   # Run a command with the given name, or print an error message if usage is
@@ -400,10 +456,10 @@ module Commands
         command = const_get(command_name.upcase.to_sym)
         command.exec(client, state, *args) { |line| puts line }
       rescue UsageError => error
-        puts "Usage: #{error}"
+        warn "Usage: #{error}"
       end
     else
-      puts "droxi: #{command_name}: command not found"
+      warn "droxi: #{command_name}: command not found"
     end
   end
 
@@ -438,12 +494,12 @@ module Commands
     yield error.to_s if block_given?
   end
 
-  # Return an +Array+ of paths from an +Array+ of globs, passing error messages
-  # to the output +Proc+ for non-matches.
+  # Return an +Array+ of paths from an +Array+ of globs, printing error
+  # messages if +output+ is true.
   def self.expand(state, paths, preserve_root, output, cmd)
     state.expand_patterns(paths, preserve_root).map do |item|
       if item.is_a?(GlobError)
-        output.call("#{cmd}: #{item}: no such file or directory") if output
+        warn "#{cmd}: #{item}: no such file or directory" if output
         nil
       else
         item
@@ -451,42 +507,49 @@ module Commands
     end.compact
   end
 
-  # Copies or moves a file and passes a description of the operation to the
-  # output +Proc+.
-  def self.copy_move(method, args, client, state, output)
+  def self.overwrite(path, client, state)
+    return unless state.metadata(path)
+    client.file_delete(path)
+    state.cache.remove(path)
+  end
+
+  # Copies or moves a file.
+  def self.copy_move(method, args, flags, client, state)
     from_path, to_path = args.map { |p| state.resolve_path(p) }
-    try_and_handle(DropboxError, output) do
+    try_and_handle(DropboxError) do
+      overwrite(to_path, client, state) if flags.include?('-f')
       metadata = client.send(method, from_path, to_path)
       state.cache.remove(from_path) if method == :file_move
       state.cache.add(metadata)
-      output.call("#{args.first} -> #{args[1]}")
+      puts "#{args.first} -> #{args[1]}"
     end
   end
 
   # Execute a 'mv' or 'cp' operation depending on arguments given.
-  def self.cp_mv(client, state, args, output, cmd)
-    sources = expand(state, args.take(args.size - 1), true, output, cmd)
+  def self.cp_mv(client, state, args, cmd)
+    flags = extract_flags(cmd, args, '-f')
+    sources = expand(state, args.take(args.size - 1), true, true, cmd)
     method = (cmd == 'cp') ? :file_copy : :file_move
     dest = state.resolve_path(args.last)
 
     if sources.size == 1 && !state.directory?(dest)
-      copy_move(method, [sources.first, args.last], client, state, output)
+      copy_move(method, [sources.first, args.last], flags, client, state)
     else
-      cp_mv_to_dir(args, client, state, cmd, output)
+      cp_mv_to_dir(args, flags, client, state, cmd)
     end
   end
 
   # Copies or moves files into a directory.
-  def self.cp_mv_to_dir(args, client, state, cmd, output)
-    sources = expand(state, args.take(args.size - 1), true, nil, cmd)
+  def self.cp_mv_to_dir(args, flags, client, state, cmd)
+    sources = expand(state, args.take(args.size - 1), true, false, cmd)
     method = (cmd == 'cp') ? :file_copy : :file_move
     if state.metadata(state.resolve_path(args.last))
       sources.each do |source|
         to_path = args.last.chomp('/') + '/' + File.basename(source)
-        copy_move(method, [source, to_path], client, state, output)
+        copy_move(method, [source, to_path], flags, client, state)
       end
     else
-      output.call("#{cmd}: #{args.last}: no such directory")
+      warn "#{cmd}: #{args.last}: no such directory"
     end
   end
 
@@ -495,4 +558,18 @@ module Commands
   def self.check_pwd(state)
     (state.pwd = File.dirname(state.pwd)) until state.metadata(state.pwd)
   end
+
+  # Removes flags (e.g. -f) from the +Array+ and returns an +Array+ of the
+  # removed flags. Prints warnings if the flags are not in the given +String+
+  # of valid flags (e.g. '-rf').
+  def self.extract_flags(cmd, args, valid_flags)
+    tokens = args.take_while { |s| s[/^-\w+$/] }
+    args.shift(tokens.size)
+
+    # Process compound flags like -rf into -r, -f.
+    flags = tokens.join.chars.uniq.drop(1).map { |c| "-#{c}" }
+    invalid_flags = flags.reject { |f| valid_flags[f[1]] }
+    invalid_flags.each { |f| warn "#{cmd}: #{f}: invalid option" }
+    flags
+  end
 end

data/lib/droxi/complete.rb

@@ -33,7 +33,7 @@ module Complete
   # Return a +String+ representing the type of tab-completion that should be
   # performed, given the current line buffer state.
   def self.completion_type(tokens)
-    index = tokens.size
+    index = tokens.drop_while { |token| token[/^-\w+$/] }.size
     if index <= 1
       'COMMAND'
     elsif Commands::NAMES.include?(tokens.first)

data/lib/droxi.rb

@@ -8,24 +8,40 @@ require_relative 'droxi/state'
 
 # Command-line Dropbox client module.
 module Droxi
+  # Version number of the program.
+  VERSION = '0.1.2'
+
   # Run the client.
-  def self.run(*args)
+  def self.run(args)
     client = DropboxClient.new(access_token)
     state = State.new(client)
 
-    if args.empty?
-      run_interactive(client, state)
-    else
-      with_interrupt_handling do
-        Commands.exec(join_cmd(args), client, state)
-      end
-    end
+    options = handle_options(args)
+    args.shift(options.size)
+
+    args.empty? ? run_interactive(client, state) : invoke(args, client, state)
 
     Settings.save
   end
 
   private
 
+  # Handles command-line options extracted from an +Array+ and returns an
+  # +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
+    options
+  end
+
+  # Invokes a single command formed by joining an +Array+ of +String+ args.
+  def self.invoke(args, client, state)
+    with_interrupt_handling { Commands.exec(join_cmd(args), client, state) }
+  end
+
   # Return a +String+ of joined command-line args, adding backslash escapes for
   # spaces.
   def self.join_cmd(args)