droxi 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7475e5467fb8a2cce45ca783361e37dcfe2f2361
-  data.tar.gz: 71a443989f3ef75df19997850f865fef2bac27fe
+  metadata.gz: ed8c5f6d9c0df8aff83fc755d298fda9dda25adf
+  data.tar.gz: f882a46c0a98a0f4f69cb88f3610fc403abc23e3
 SHA512:
-  metadata.gz: 20b0e20d19722a326203d48a5b5232203c88ebeecb809c94e084ebb223de4c97a756de512959e667d6dca5224e71ef82d587f1870d215fc75b795a16ff9edff3
-  data.tar.gz: 09afb109d29dd70c2d77add8a3557a9442f58cb02deda624731022bf4eb73ad500e9d2ebe2876bf7115b7a690fd16d74e144f8e7f58801e27c187523b6191c9e
+  metadata.gz: c5cbb62624375b1515ff9e7de15167ead211bb535dd427a87954c3a585865e5d25ba90236a0f717c4a491b307d6bbb01fdd430dbee3c4edfaf43e8c49a30b3da
+  data.tar.gz: 4c9b4bc88008c441cb8f7284be5c90470b147233f134dceb035e9dc681e3ce303168220ecfdea5deb27f2bac94fad43109aeb52b3da18d23bafa730ba8b5580d

data/droxi.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'droxi'
-  s.version     = '0.0.4'
-  s.date        = '2014-06-03'
+  s.version     = '0.0.5'
+  s.date        = '2014-06-04'
   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

@@ -59,12 +59,14 @@ module Commands
 
     private
 
+    # Return +true+ if the given number of arguments is acceptable for the
+    # command, +false+ otherwise.
     def num_args_ok?(num_args)
       args = @usage.split.drop(1)
       min_args = args.reject { |arg| arg.start_with?('[') }.length
       if args.empty?
         max_args = 0
-      elsif args.last.end_with?('...')
+      elsif args.any? { |arg| arg.end_with?('...') }
         max_args = num_args
       else
         max_args = args.length
@@ -96,6 +98,18 @@ module Commands
     end
   )
 
+  # Copy remote files.
+  CP = Command.new(
+    'cp 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', :file_copy)
+    end
+  )
+
   # Terminate the session.
   EXIT = Command.new(
     'exit',
@@ -132,14 +146,12 @@ module Commands
         if path.is_a?(GlobError)
           output.call("get: #{path}: No such file or directory")
         else
-          begin
+          try_and_handle(DropboxError, output) do
             contents = client.get_file(path)
             File.open(File.basename(path), 'wb') do |file|
               file.write(contents)
             end
             output.call("#{File.basename(path)} <- #{path}")
-          rescue DropboxError => error
-            output.call(error.to_s)
           end
         end
       end
@@ -240,11 +252,9 @@ module Commands
         if path.is_a?(GlobError)
           output.call("media: #{path}: No such file or directory")
         else
-          begin
+          try_and_handle(DropboxError, output) do
             url = client.media(path)['url']
             output.call("#{File.basename(path)} -> #{url}")
-          rescue DropboxError => error
-            output.call(error.to_s)
           end
         end
       end
@@ -257,16 +267,26 @@ module Commands
     "Create remote directories.",
     lambda do |client, state, args, output|
       args.each do |arg|
-        begin
+        try_and_handle(DropboxError, output) do
           path = state.resolve_path(arg)
           state.cache[path] = client.file_create_folder(path)
-        rescue DropboxError => error
-          output.call(error.to_s)
         end
       end
     end
   )
 
+  # Move/rename remote files.
+  MV = Command.new(
+    'mv 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', :file_move)
+    end
+  )
+
   # Upload a local file.
   PUT = Command.new(
     'put LOCAL_FILE [REMOTE_FILE]',
@@ -283,14 +303,12 @@ module Commands
       end
       to_path = state.resolve_path(to_path)
 
-      begin
+      try_and_handle(Exception, output) do 
         File.open(File.expand_path(from_path), 'rb') do |file|
           data = client.put_file(to_path, file)
           state.cache[data['path']] = data
           output.call("#{from_path} -> #{data['path']}")
         end
-      rescue Exception => error
-        output.call(error.to_s)
       end
     end
   )
@@ -304,14 +322,13 @@ module Commands
         if path.is_a?(GlobError)
           output.call("rm: #{path}: No such file or directory")
         else
-          begin
+          try_and_handle(DropboxError, output) do
             client.file_delete(path)
-            state.cache.delete(path)
-          rescue DropboxError => error
-            output.call(error.to_s)
+            state.cache_remove(path)
           end
         end
       end
+      check_pwd(state)
     end
   )
 
@@ -327,11 +344,9 @@ module Commands
         if path.is_a?(GlobError)
           output.call("share: #{path}: No such file or directory")
         else
-          begin
+          try_and_handle(DropboxError, output) do
             url = client.shares(path)['url']
             output.call("#{File.basename(path)} -> #{url}")
-          rescue DropboxError => error
-            output.call(error.to_s)
           end
         end
       end
@@ -356,6 +371,16 @@ 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)
+    yield
+  rescue exception_class => error
+    output.call(error.to_s)
+  end
+
+  # Run a command with the given name, or print an error message if usage is
+  # incorrect or no such command exists.
   def self.try_command(command_name, args, client, state)
     if NAMES.include?(command_name)
       begin
@@ -369,6 +394,8 @@ module Commands
     end
   end
 
+  # Split a +String+ into tokens, allowing for backslash-escaped spaces, and
+  # return the resulting +Array+.
   def self.tokenize(string)
     string.split.reduce([]) do |list, token|
       list << if !list.empty? && list.last.end_with?('\\')
@@ -379,6 +406,7 @@ module Commands
     end
   end
 
+  # Return a +String+ of information about a remote file for ls -l.
   def self.long_info(state, path, name)
     meta = state.metadata(state.resolve_path(path), false)
     is_dir = meta['is_dir'] ? 'd' : '-'
@@ -388,6 +416,8 @@ module Commands
     "#{is_dir} #{size} #{mtime.strftime(format_str)} #{name}"
   end
 
+  # Yield lines of output for the ls command executed on the given file paths
+  # and names.
   def self.list(state, paths, names, long)
     if long
       paths.zip(names).each { |path, name| yield long_info(state, path, name) }
@@ -396,6 +426,7 @@ module Commands
     end
   end
 
+  # Run a command in the system shell and yield lines of output.
   def self.shell(cmd)
     IO.popen(cmd) do |pipe|
       pipe.each_line { |line| yield line.chomp if block_given? }
@@ -405,4 +436,54 @@ 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.
+  def self.expand(state, paths, preserve_root, output, cmd_name)
+    state.expand_patterns(paths, true).map do |item|
+      if item.is_a?(GlobError)
+        output.call("#{cmd_name}: #{item}: no such file or directory")
+        nil
+      else
+        item
+      end
+    end.compact
+  end
+
+  # Copies or moves the file at +source+ to +dest+ and passes a description of
+  # the operation to the output +Proc+.
+  def self.copy_move(method, source, dest, client, state, output)
+    from_path, to_path = [source, dest].map { |p| state.resolve_path(p) }
+    try_and_handle(DropboxError, output) do
+      metadata = client.send(method, from_path, to_path)
+      state.cache_remove(from_path) if method == :file_move
+      state.cache_add(metadata)
+      output.call("#{source} -> #{dest}")
+    end
+  end
+
+  # Execute a 'mv' or 'cp' operation depending on arguments given.
+  def self.cp_mv(client, state, args, output, cmd, method)
+    sources = expand(state, args.take(args.length - 1), true, output, cmd)
+    dest = state.resolve_path(args.last)
+
+    if sources.length == 1 && !state.directory?(dest)
+      copy_move(method, sources[0], args.last, client, state, output)
+    else
+      if state.metadata(dest)
+        sources.each do |source|
+          to_path = args.last.chomp('/') + '/' + File.basename(source)
+          copy_move(method, source, to_path, client, state, output)
+        end
+      else
+        output.call("#{cmd}: #{args.last}: no such directory")
+      end
+    end
+  end
+
+  # If the remote working directory does not exist, move up the directory
+  # tree until at a real location.
+  def self.check_pwd(state)
+    state.pwd = File.dirname(state.pwd) until state.metadata(state.pwd)
+  end
+
 end

data/lib/droxi/complete.rb

@@ -11,7 +11,7 @@ module Complete
     end
   end
 
-  # Returns an +Array+ of potential local tab-completions for a +String+.
+  # Return an +Array+ of potential local tab-completions for a +String+.
   def self.local(string)
     dir = local_search_path(string)
     name = string.end_with?('/') ? '' : File.basename(string)
@@ -24,7 +24,7 @@ module Complete
     end
   end
 
-  # Returns an +Array+ of potential local tab-completions for a +String+,
+  # Return an +Array+ of potential local tab-completions for a +String+,
   # including only directories.
   def self.local_dir(string)
     local(string).select { |result| result.end_with?('/') }
@@ -42,7 +42,7 @@ module Complete
     strip_filename(collapse(path))
   end
 
-  # Returns an +Array+ of potential remote tab-completions for a +String+.
+  # Return an +Array+ of potential remote tab-completions for a +String+.
   def self.remote(string, state)
     dir = remote_search_path(string, state)
     name = string.end_with?('/') ? '' : File.basename(string)
@@ -57,7 +57,7 @@ module Complete
     end
   end
 
-  # Returns an +Array+ of potential remote tab-completions for a +String+,
+  # Return an +Array+ of potential remote tab-completions for a +String+,
   # including only directories.
   def self.remote_dir(string, state)
     remote(string, state).select { |result| result.end_with?('/') }
@@ -65,6 +65,7 @@ module Complete
 
   private
 
+  # Return the name of the directory indicated by a path.
   def self.strip_filename(path)
     if path != '/'
       path.end_with?('/') ? path.sub(/\/$/, '') : File.dirname(path)
@@ -73,10 +74,13 @@ module Complete
     end
   end
 
+  # Return a version of a path with .. and . resolved to appropriate
+  # directories.
   def self.collapse(path)
-    nil while path.sub!(/[^\/]+\/\.\.\//, '/')
-    nil while path.sub!('./', '')
-    path
+    new_path = path.dup
+    nil while new_path.sub!(/[^\/]+\/\.\.\//, '/')
+    nil while new_path.sub!('./', '')
+    new_path
   end
 
 end

data/lib/droxi/settings.rb

@@ -38,6 +38,7 @@ class Settings
       FileUtils.mkdir_p(File.dirname(CONFIG_FILE_PATH))
       File.open(CONFIG_FILE_PATH, 'w') do |file|
         @@settings.each_pair { |k, v| file.write("#{k}=#{v}\n") }
+        file.chmod(0600)
       end
     end
     nil
@@ -45,11 +46,15 @@ class Settings
 
   private
 
+  # Print a warning for an invalid setting and return an empty +Hash+ (the
+  # result of an invalid setting).
   def Settings.warn_invalid(line)
     warn "invalid setting: #{line}"
     {}
   end
 
+  # Parse a line of the rc file and return a +Hash+ containing the resulting
+  # setting data.
   def Settings.parse(line)
     if /^(.+?)=(.+)$/ =~ line
       key, value = $1.to_sym, $2
@@ -63,6 +68,7 @@ class Settings
     end
   end
 
+  # Read and parse the rc file.
   def Settings.read
     if File.exists?(CONFIG_FILE_PATH)
       File.open(CONFIG_FILE_PATH) do |file|

data/lib/droxi/state.rb

@@ -33,6 +33,28 @@ class State
     @local_oldpwd = Dir.pwd
   end
 
+  # Adds a metadata +Hash+ and its contents to the metadata cache.
+  def cache_add(metadata)
+    @cache[metadata['path']] = metadata
+    if metadata.include?('contents')
+      metadata['contents'].each { |content| cache_add(content) }
+    end
+  end
+
+  # Removes a path from the metadata cache.
+  def cache_remove(path)
+    if directory?(path) && @cache[path].include?('contents')
+      @cache[path]['contents'].each { |item| cache_remove(item['path']) }
+    end
+
+    @cache.delete(path)
+
+    dir = File.dirname(path)
+    if @cache.include?(dir) && @cache[dir].include?('contents')
+      @cache[dir]['contents'].delete_if { |item| item['path'] == path }
+    end
+  end
+
   # Return a +Hash+ of the Dropbox metadata for a file, or +nil+ if the file
   # does not exist.
   def metadata(path, require_contents=true)
@@ -42,15 +64,18 @@ class State
       partial_path = '/' + tokens.take(i).join('/')
       unless have_all_info_for(partial_path, require_contents)
         begin
-          data = @cache[partial_path] = @client.metadata(partial_path)
+          data = @client.metadata(partial_path)
+          if !data['is_deleted']
+            @cache[partial_path] = data 
+            if data.include?('contents')
+              data['contents'].each do |datum|  
+                @cache[datum['path']] = datum
+              end
+            end
+          end
         rescue DropboxError
           return nil
         end
-        if data.include?('contents')
-          data['contents'].each do |datum|  
-            @cache[datum['path']] = datum
-          end
-        end
       end
     end
 
@@ -122,6 +147,8 @@ class State
 
   private
 
+  # Return an +Array+ of file paths matching a glob pattern, or a GlobError if
+  # no files were matched.
   def get_matches(pattern, path, preserve_root)
     dir = File.dirname(path)
     matches = contents(dir).select { |entry| File.fnmatch(path, entry) }
@@ -135,6 +162,7 @@ class State
     end
   end
 
+  # Return +true+ if the path's information is cached, +false+ otherwise.
   def have_all_info_for(path, require_contents=true)
     @cache.include?(path) && (
       !require_contents ||

data/lib/droxi/text.rb

@@ -33,6 +33,7 @@ module Text
 
   private
 
+  # Return the width of the terminal in columns.
   def self.get_columns
     require 'readline'
     begin
@@ -43,6 +44,7 @@ module Text
     end
   end
 
+  # Return an +Array+ of lines of the given items formatted as a table.
   def self.format_table(items, item_width, items_per_line, num_lines)
     num_lines.times.map do |i|
       items[i * items_per_line, items_per_line].map do |item|
@@ -51,6 +53,7 @@ module Text
     end
   end
 
+  # Return a wrapped line of output from the start of the given text.
   def self.get_wrap_segment(text, columns)
     segment, sep, text = text.partition(' ')
     while !text.empty? && segment.length < columns

data/lib/droxi.rb

@@ -28,8 +28,7 @@ module Droxi
 
   private
 
-  # Attempt to authorize the user for app usage. Return +true+ if
-  # authorization was successful, +false+ otherwise.
+  # Attempt to authorize the user for app usage.
   def self.authorize
     app_key = '5sufyfrvtro9zp7'
     app_secret = 'h99ihzv86jyypho'
@@ -46,8 +45,8 @@ module Droxi
     end
   end
 
-  # Get the access token for the user, requesting authorization if no token
-  # exists.
+  # Return the access token for the user, requesting authorization if no saved
+  # token exists.
   def self.get_access_token
     authorize() until Settings.include?(:access_token)
     Settings[:access_token]
@@ -55,7 +54,7 @@ module Droxi
 
   # Return a prompt message reflecting the current state of the application.
   def self.prompt(info, state)
-    "droxi #{info['email']}:#{state.pwd}> "
+    "\rdroxi #{info['email']}:#{state.pwd}> "
   end
 
   # Run the client in interactive mode.
@@ -66,10 +65,11 @@ module Droxi
     init_readline(state)
     with_interrupt_handling { do_interaction_loop(client, state, info) }
 
-    # Set pwd so that the oldpwd setting is saved to pwd
+    # Set pwd before exiting so that the oldpwd setting is saved to pwd
     state.pwd = '/'
   end
 
+  # Set up the Readline library's completion capabilities.
   def self.init_readline(state)
     Readline.completion_proc = proc do |word|
       words = Readline.line_buffer.split
@@ -103,12 +103,16 @@ module Droxi
     end
   end
 
+  # Run the associated block, handling Interrupt errors by printing a blank
+  # line.
   def self.with_interrupt_handling
     yield
   rescue Interrupt
     puts
   end
 
+  # Run the main loop of the program, getting user input and executing it as a
+  # command until an getting input fails or an exit is requested.
   def self.do_interaction_loop(client, state, info)
     while !state.exit_requested &&
           line = Readline.readline(prompt(info, state), true)
@@ -117,6 +121,8 @@ module Droxi
     puts if !line
   end
 
+  # Instruct the user to enter an authorization code and return the code. If
+  # the user gives EOF, exit the program.
   def self.get_auth_code(url)
     puts '1. Go to: ' + url
     puts '2. Click "Allow" (you might have to log in first)'

data/spec/commands_spec.rb

@@ -90,6 +90,38 @@ describe Commands do
     end
   end
 
+  describe 'when executing the cp command' do
+    before do
+      state.pwd = '/testing'
+    end
+
+    after do
+      Commands::RM.exec(client, state, '*')
+    end
+
+    it 'must copy source to dest when given 2 args and last arg is non-dir' do
+      Commands::MKDIR.exec(client, state, 'source')
+      Commands::CP.exec(client, state, 'source', 'dest')
+      ['source', 'dest'].all? do |dir|
+        client.metadata("/testing/#{dir}")
+      end.must_equal true
+    end
+
+    it 'must copy source into dest when given 2 args and last arg is dir' do
+      Commands::MKDIR.exec(client, state, 'source', 'dest')
+      Commands::CP.exec(client, state, 'source', 'dest')
+      client.metadata('/testing/dest/source').wont_equal nil
+    end
+
+    it 'must copy sources into dest when given 3 or more args' do
+      Commands::MKDIR.exec(client, state, 'source1', 'source2', 'dest')
+      Commands::CP.exec(client, state, 'source1', 'source2', 'dest')
+      ['source2', 'source2'].all? do |dir|
+        client.metadata("/testing/dest/#{dir}")
+      end.must_equal true
+    end
+  end
+
   describe 'when executing the forget command' do
     it 'must clear entire cache when given no arguments' do
       Commands::LS.exec(client, state, '/')
@@ -206,6 +238,39 @@ describe Commands do
     end
   end
 
+  describe 'when executing the mv command' do
+    before do
+      state.pwd = '/testing'
+    end
+
+    after do
+      Commands::RM.exec(client, state, '*')
+    end
+
+    it 'must move source to dest when given 2 args and last arg is non-dir' do
+      Commands::MKDIR.exec(client, state, 'source')
+      Commands::MV.exec(client, state, 'source', 'dest')
+      client.metadata('/testing/source')['is_deleted'].must_equal true
+      client.metadata('/testing/dest').wont_equal nil
+    end
+
+    it 'must move source into dest when given 2 args and last arg is dir' do
+      Commands::MKDIR.exec(client, state, 'source', 'dest')
+      Commands::MV.exec(client, state, 'source', 'dest')
+      client.metadata('/testing/source')['is_deleted'].must_equal true
+      client.metadata('/testing/dest/source').wont_equal nil
+    end
+
+    it 'must move sources into dest when given 3 or more args' do
+      Commands::MKDIR.exec(client, state, 'source1', 'source2', 'dest')
+      Commands::MV.exec(client, state, 'source1', 'source2', 'dest')
+      ['source2', 'source2'].all? do |dir|
+        client.metadata("/testing/#{dir}")['is_deleted'].must_equal true
+        client.metadata("/testing/dest/#{dir}")
+      end.must_equal true
+    end
+  end
+
   describe 'when executing the put command' do
     it 'must put a file of the same name when given 1 arg' do
       state.pwd = '/testing'
@@ -239,10 +304,17 @@ describe Commands do
 
   describe 'when executing the rm command' do
     it 'must remove the remote file when given args' do
-      # FIXME: This test fails and I don't know why
-      #Commands::MKDIR.exec(client, state, '/testing/test')
-      #Commands::RM.exec(client, state, '/testing/test')
-      #client.metadata('/testing/test')['is_deleted'].must_equal true
+      Commands::MKDIR.exec(client, state, '/testing/test')
+      Commands::RM.exec(client, state, '/testing/test')
+      client.metadata('/testing/test')['is_deleted'].must_equal true
+    end
+
+    it 'must change pwd to existing dir if the current one is removed' do
+      Commands::MKDIR.exec(client, state, '/testing/one')
+      Commands::MKDIR.exec(client, state, '/testing/one/two')
+      Commands::CD.exec(client, state, '/testing/one/two')
+      Commands::RM.exec(client, state, '..')
+      state.pwd.must_equal('/testing')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droxi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Brandon Mulcahy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dropbox-sdk