droxi 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c42bb596852aacff40852b70646a1a74c49930ff
-  data.tar.gz: a1cae76af97bc5064f2ee567035d5a50c6e768c9
+  metadata.gz: 9e5303c28f4ee1e364769a554be98314b4c3c953
+  data.tar.gz: 5170d5affcbf11282c0a2c8e305c0c553ca961b6
 SHA512:
-  metadata.gz: 1a4b91bca5b16d9bc98b3ab37fde5e5404ec86eb8ffc0f28426657a6555882efa34849b020c410205665044a4e2abe34bce85928e011d5d13b4417a2debe2486
-  data.tar.gz: b5fa9257afa11b305124d823efa38dc32c3c8fffc577a094ce6f0b249bccdce1d89f8f95cf4e28114da916a074782c94a96503be0b84d8ec4449c44fe42436b5
+  metadata.gz: 335e2e4caa00193fb73a0f912ac819ba23b677ba42bb0185de8a143fc7fdb98bf9c5d51724df7ef7da4bd238b231e052f13b686ea17c52f0da4960a947aef294
+  data.tar.gz: ea91d29b4b67e3384f3605bb884f4ea07edb828bf6fac7e3c084d6e7320af748c9af878f378330dfd5b81cec1a92c4bd0f0a8f07113be46a61f65f6f4751d040

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Brandon Mulcahy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+droxi
+=====
+
+ftp-like command-line [Dropbox](https://www.dropbox.com/home) interface in
+[Ruby](https://www.ruby-lang.org/en/)
+
+installation
+------------
+
+    gem install droxi
+
+features
+--------
+
+- interface inspired by
+  [GNU coreutils](http://www.gnu.org/software/coreutils/),
+  [GNU ftp](http://www.gnu.org/software/inetutils/), and
+  [lftp](http://lftp.yar.ru/)
+- context-sensitive tab completion and path globbing
+- upload, download, and share files
+- man page and interactive help

data/Rakefile

@@ -0,0 +1,56 @@
+task :default => :test
+
+desc 'run unit tests'
+task :test do
+  sh 'ruby spec/all.rb'
+end
+
+desc 'run program'
+task :run do
+  require_relative 'lib/droxi'
+  Droxi.run
+end
+
+desc 'install gem'
+task :gem do
+  sh 'rm *.gem'
+  sh 'gem build droxi.gemspec'
+  sh 'gem install ./droxi-*.gem'
+end
+
+desc 'install man page (must have root permissions)'
+task :man do
+  gemspec = IO.read('droxi.gemspec')
+
+  def date(gemspec)
+    require 'time'
+    Time.parse(/\d{4}-\d{2}-\d{2}/.match(gemspec)[0]).strftime('%B %Y')
+  end
+
+  def commands
+    require_relative 'lib/droxi/commands'
+    Commands::NAMES.sort.map do |name|
+      cmd = Commands.const_get(name.upcase.to_sym)
+      ".TP\n#{cmd.usage}\n#{cmd.description}\n"
+    end.join.strip
+  end
+
+  contents = IO.read('droxi.1.template').
+    sub('{date}', date(gemspec)).
+    sub('{version}', /\d+\.\d+\.\d+/.match(gemspec)[0]).
+    sub('{commands}', commands)
+
+  Dir.mkdir('build') unless Dir.exists?('build')
+  IO.write('build/droxi.1', contents)
+
+  prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
+  install_path = "#{prefix}/share/man/man1"
+
+  require 'fileutils'
+  begin
+    FileUtils.mkdir_p(install_path)
+    FileUtils.cp('build/droxi.1', install_path)
+  rescue
+    puts 'Failed to install man page. This target must be run as root.'
+  end
+end

data/droxi.1.template

@@ -0,0 +1,9 @@
+.TH DROXI 1 "{date}" "droxi {version}"
+.SH NAME
+droxi \- ftp-like command-line interface to Dropbox
+.SH SYNOPSIS
+droxi
+.SH COMMANDS
+{commands}
+.SH AUTHOR
+Written by Brandon Mulcahy (brandon@jangler.info).

data/droxi.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = 'droxi'
+  s.version     = '0.0.1'
+  s.date        = '2014-06-02'
+  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 smart tab \
+                   completion, globbing, and interactive help.".squeeze(' ')
+  s.authors     = ['Brandon Mulcahy']
+  s.email       = 'brandon@jangler.info'
+  s.files       = `git ls-files`.split
+  s.homepage    = 'https://github.com/jangler/droxi'
+  s.license     = 'MIT'
+
+  s.executables << 'droxi'
+  s.add_runtime_dependency 'dropbox-sdk', '~> 1.6', '>= 1.6.1'
+  s.required_ruby_version = '>= 2.0.0'
+end

data/lib/droxi.rb

@@ -19,7 +19,13 @@ module Droxi
     puts '2. Click "Allow" (you might have to log in first)'
     puts '3. Copy the authorization code'
     print 'Enter the authorization code here: '
-    code = gets.strip
+    code = $stdin.gets
+    if code
+      code.strip!
+    else
+      puts
+      exit
+    end
 
     # This will fail if the user gave us an invalid authorization code
     begin
@@ -128,10 +134,11 @@ module Droxi
     end
 
     begin
-      while line = Readline.readline(prompt(info, state), true)
+      while !state.exit_requested &&
+            line = Readline.readline(prompt(info, state), true)
         Commands.exec(line.chomp, client, state)
       end
-      puts
+      puts if !line
     rescue Interrupt
       puts
     end

data/lib/droxi/commands.rb

@@ -25,7 +25,9 @@ module Commands
     def num_args_ok?(num_args)
       args = @usage.split.drop(1)
       min_args = args.reject { |arg| arg.start_with?('[') }.length
-      if args.last.end_with?('...')
+      if args.empty?
+        max_args = 0
+      elsif args.last.end_with?('...')
         max_args = num_args
       else
         max_args = args.length
@@ -62,6 +64,14 @@ module Commands
     end
   )
 
+  EXIT = Command.new(
+    'exit',
+    "Exit the program.",
+    lambda do |client, state, args, output|
+      state.exit_requested = true
+    end
+  )
+
   GET = Command.new(
     'get REMOTE_FILE...',
     "Download each specified remote file to a file of the same name in the \
@@ -220,9 +230,10 @@ module Commands
 
   SHARE = Command.new(
     'share REMOTE_FILE...',
-    "Get URLs to share remote files. Shareable links created on Dropbox are \
-     time-limited, but don't require any authentication, so they can be given \
-     out freely. The time limit should allow at least a day of shareability.",
+    "Create Dropbox links to publicly share remote files. The links are \
+     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|
       state.expand_patterns(client, args).each do |path|
         begin

data/lib/droxi/state.rb

@@ -2,13 +2,14 @@ require_relative 'settings'
 
 class State
   attr_reader :oldpwd, :pwd, :cache
-  attr_accessor :local_oldpwd
+  attr_accessor :local_oldpwd, :exit_requested
 
   def initialize
     @pwd = '/'
     @oldpwd = Settings[:oldpwd] || '/'
     @local_oldpwd = Dir.pwd
     @cache = {}
+    @exit_requested = false
   end
 
   def have_all_info_for(path)

data/spec/all.rb

@@ -0,0 +1,4 @@
+# Run all spec tests
+Dir.glob('spec/*_spec.rb').each do |spec|
+  require_relative File.basename(spec, '.rb')
+end

data/spec/commands_spec.rb

@@ -0,0 +1,206 @@
+require 'dropbox_sdk'
+require 'minitest/autorun'
+
+require_relative '../lib/droxi/commands'
+require_relative '../lib/droxi/settings'
+require_relative '../lib/droxi/state'
+
+def ignore(error_class)
+  begin
+    yield
+  rescue error_class
+  end
+end
+
+def put_temp_file(client, state)
+  `echo hello > #{TEMP_FILENAME}`
+  open(TEMP_FILENAME, 'rb') do |file|
+    Commands::PUT.exec(client, state, TEMP_FILENAME,
+                       "/#{TEST_FOLDER}/#{TEMP_FILENAME}")
+  end
+  `rm #{TEMP_FILENAME}`
+end
+
+def delete_temp_file(client, state)
+  Commands::RM.exec(client, state, "/#{TEST_FOLDER}/#{TEMP_FILENAME}")
+end
+
+def get_output(cmd, client, state, *args)
+  lines = []
+  Commands.const_get(cmd).exec(client, state, *args) { |line| lines << line }
+  lines
+end
+
+describe Commands do
+  original_dir = Dir.pwd
+
+  client = DropboxClient.new(Settings[:access_token])
+  state = State.new
+
+  TEMP_FILENAME = 'test.txt'
+  TEMP_FOLDER = 'test'
+  TEST_FOLDER = 'testing'
+
+  ignore(DropboxError) { client.file_delete("/#{TEST_FOLDER}") }
+  ignore(DropboxError) { client.file_create_folder("/#{TEST_FOLDER}") }
+
+  describe 'when executing a shell command' do
+    it 'must yield the output' do
+      lines = []
+      Commands.shell('echo testing') { |line| lines << line }
+      lines.must_equal(['testing'])
+    end
+  end
+
+  describe 'when executing the cd command' do
+    it 'must change to the root directory when given no args' do
+      state.pwd = '/testing'
+      Commands::CD.exec(client, state)
+      state.pwd.must_equal '/'
+    end
+
+    it 'must change to the previous directory when given -' do
+      state.pwd = '/testing'
+      state.pwd = '/'
+      Commands::CD.exec(client, state, '-')
+      state.pwd.must_equal '/testing'
+    end
+
+    it 'must change to the stated directory when given 1 arg' do
+      state.pwd = '/'
+      Commands::CD.exec(client, state, '/testing')
+      state.pwd.must_equal '/testing'
+    end
+
+    it 'must set previous directory correctly' do
+      state.pwd = '/testing'
+      state.pwd = '/'
+      Commands::CD.exec(client, state, '/testing')
+      state.oldpwd.must_equal '/'
+    end
+
+    it 'must not change to a bogus directory' do
+      state.pwd = '/'
+      Commands::CD.exec(client, state, '/bogus_dir')
+      state.pwd.must_equal '/'
+    end
+  end
+
+  describe 'when executing the get command' do
+    it 'must get a file of the same name when given args' do
+      Dir.chdir(original_dir)
+      put_temp_file(client, state)
+      Commands::GET.exec(client, state, '/testing/test.txt')
+      delete_temp_file(client, state)
+      `ls test.txt`.chomp.must_equal 'test.txt'
+      `rm test.txt`
+    end
+  end
+
+  describe 'when executing the lcd command' do
+    it 'must change to home directory when given no args' do
+      Dir.chdir(original_dir)
+      Commands::LCD.exec(client, state)
+      Dir.pwd.must_equal File.expand_path('~')
+    end
+
+    it 'must change to specific directory when specified' do
+      Dir.chdir(original_dir)
+      Commands::LCD.exec(client, state, '/home')
+      Dir.pwd.must_equal File.expand_path('/home')
+    end
+
+    it 'must set oldpwd correctly' do
+      Dir.chdir(original_dir)
+      oldpwd = Dir.pwd
+      Commands::LCD.exec(client, state, '/')
+      state.local_oldpwd.must_equal oldpwd
+    end
+
+    it 'must change to previous directory when given -' do
+      Dir.chdir(original_dir)
+      oldpwd = Dir.pwd
+      Commands::LCD.exec(client, state, '/')
+      Commands::LCD.exec(client, state, '-')
+      Dir.pwd.must_equal oldpwd
+    end
+
+    it 'must fail if given bogus directory name' do
+      Dir.chdir(original_dir)
+      pwd = Dir.pwd
+      oldpwd = state.local_oldpwd
+      Commands::LCD.exec(client, state, '/bogus_dir')
+      Dir.pwd.must_equal pwd
+      state.local_oldpwd.must_equal oldpwd
+    end
+  end
+
+  describe 'when executing the ls command' do
+    it 'must list the working directory contents when given no args' do
+      Commands::MKDIR.exec(client, state, '/testing/test')
+      state.pwd = '/testing'
+      lines = []
+      Commands::LS.exec(client, state) { |line| lines << line }
+      lines.must_equal(['test  '])
+      Commands::RM.exec(client, state, '/testing/test')
+    end
+
+    it 'must list the stated directory contents when given args' do
+      state.pwd = '/'
+      Commands::MKDIR.exec(client, state, '/testing/test')
+      lines = []
+      Commands::LS.exec(client, state, '/testing') { |line| lines << line }
+      lines.must_equal(['test  '])
+      Commands::RM.exec(client, state, '/testing/test')
+    end
+  end
+
+  describe 'when executing the mkdir command' do
+    it 'must create a directory when given args' do
+      Commands::MKDIR.exec(client, state, '/testing/test')
+      client.metadata('/testing/test')['is_deleted'].wont_equal true
+      Commands::RM.exec(client, state, '/testing/test')
+    end
+  end
+
+  describe 'when executing the put command' do
+    it 'must put a file of the same name when given 1 arg' do
+      Dir.chdir(original_dir)
+      state.pwd = '/testing'
+      `echo hello > test.txt`
+      Commands::PUT.exec(client, state, 'test.txt')
+      `rm test.txt`
+      client.metadata('/testing/test.txt')['is_deleted'].wont_equal true
+      Commands::RM.exec(client, state, '/testing/test.txt')
+    end
+
+    it 'must put a file with the stated name when given 2 args' do
+      Dir.chdir(original_dir)
+      state.pwd = '/testing'
+      `echo hello > test.txt`
+      Commands::PUT.exec(client, state, 'test.txt', 'dest.txt')
+      `rm test.txt`
+      client.metadata('/testing/dest.txt')['is_deleted'].wont_equal true
+      Commands::RM.exec(client, state, '/testing/dest.txt')
+    end
+  end
+
+  describe 'when executing the share command' do
+    it 'must yield URL when given file path' do
+      put_temp_file(client, state)
+      to_path = "/#{TEST_FOLDER}/#{TEMP_FILENAME}"
+      lines = get_output(:SHARE, client, state, to_path)
+      delete_temp_file(client, state)
+      lines.length.must_equal 1
+      /https:\/\/.+\..+\//.match(lines[0]).wont_equal nil
+    end
+  end
+
+  describe 'when executing the rm command' do
+    it 'must remove the remote file when given args' do
+      Commands::MKDIR.exec(client, state, '/testing/test')
+      Commands::RM.exec(client, state, '/testing/test')
+      client.metadata('/testing/test')['is_deleted'].must_equal true
+    end
+  end
+end

data/spec/settings_spec.rb

@@ -0,0 +1,56 @@
+require 'minitest/autorun'
+
+require_relative '../lib/droxi/settings'
+
+describe Settings do
+  KEY, VALUE = :test_key, :test_value
+
+  describe 'when attempting access with a bogus key' do
+    it 'must return nil' do
+      Settings.delete(KEY)
+      Settings[KEY].must_equal nil
+    end
+  end
+
+  describe 'when attempting access with a valid key' do
+    it 'must return the associated value' do
+      Settings[KEY] = VALUE
+      Settings[KEY].must_equal VALUE
+    end
+  end
+
+  describe 'when assigning a value to a key' do
+    it 'must assign the value to the key and return the value' do
+      Settings.delete(KEY)
+      (Settings[KEY] = VALUE).must_equal VALUE
+      Settings[KEY].must_equal VALUE
+    end
+  end
+
+  describe 'when deleting a bogus key' do
+    it 'must return nil' do
+      Settings.delete(KEY)
+      Settings.delete(KEY).must_equal nil
+    end
+  end
+
+  describe 'when deleting a valid key' do
+    it 'must delete the key and return the associated value' do
+      Settings[KEY] = VALUE
+      Settings.delete(KEY).must_equal VALUE
+      Settings[KEY].must_equal nil
+    end
+  end
+
+  describe 'when checking inclusion of a key' do
+    it 'must return true for valid keys' do
+      Settings[KEY] = VALUE
+      Settings.include?(KEY).must_equal true
+    end
+
+    it 'must return false for bogus keys' do
+      Settings.delete(KEY)
+      Settings.include?(KEY).must_equal false
+    end
+  end
+end

data/spec/state_spec.rb

@@ -0,0 +1,51 @@
+require 'minitest/autorun'
+
+require_relative '../lib/droxi/state'
+require_relative '../lib/droxi/settings'
+
+describe State do
+  describe 'when initializing' do
+    it 'must set pwd to root' do
+      State.new.pwd.must_equal '/'
+    end
+
+    it 'must set oldpwd to saved oldpwd' do
+      if Settings.include?(:oldpwd)
+        State.new.oldpwd.must_equal Settings[:oldpwd]
+      end
+    end
+  end
+
+  describe 'when setting pwd' do
+    it 'must change pwd and set oldpwd to previous pwd' do
+      state = State.new
+      state.pwd = '/testing'
+      state.pwd.must_equal '/testing'
+      state.pwd = '/'
+      state.oldpwd.must_equal '/testing'
+    end
+  end
+
+  describe 'when resolving path' do
+    state = State.new
+
+    it 'must resolve root to itself' do
+      state.resolve_path('/').must_equal '/'
+    end
+
+    it 'must resolve qualified path to itself' do
+      state.pwd = '/alpha'
+      state.resolve_path('/beta').must_equal '/beta'
+    end
+
+    it 'must resolve unqualified path to relative path' do
+      state.pwd = '/alpha'
+      state.resolve_path('beta').must_equal '/alpha/beta'
+    end
+
+    it 'must resolve .. to upper directory' do
+      state.pwd = '/alpha/beta/gamma'
+      state.resolve_path('../..').must_equal '/alpha'
+    end
+  end
+end

metadata

@@ -1,41 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: droxi
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Brandon Mulcahy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-01 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dropbox_sdk
+  name: dropbox-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.6.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: ftp-like command-line interface to Dropbox
+        version: 1.6.1
+description: a command-line Dropbox interface inspired by GNU coreutils, GNU ftp,
+  and lftp. features smart tab completion, globbing, and interactive help.
 email: brandon@jangler.info
 executables:
 - droxi
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- Rakefile
 - bin/droxi
+- droxi.1.template
+- droxi.gemspec
 - lib/droxi.rb
 - lib/droxi/commands.rb
 - lib/droxi/settings.rb
 - lib/droxi/state.rb
+- spec/all.rb
+- spec/commands_spec.rb
+- spec/settings_spec.rb
+- spec/state_spec.rb
 homepage: https://github.com/jangler/droxi
 licenses:
 - MIT
@@ -48,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -59,5 +75,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: droxi
+summary: ftp-like command-line interface to Dropbox
 test_files: []