dbox 0.1.0 → 0.2.0

data/README.md

@@ -9,9 +9,15 @@ An easy way to push and pull your Dropbox folders, with fine-grained control ove
 Installation
 ------------
 
+### Install dbox
+
+```sh
+$ gem install dbox
+```
+
 ### Get developer keys
 
-* Follow the instructions at https://www.dropbox.com/developers/quickstart to create a Dropbox development application, and copy the application keys.
+* Follow the instructions at https://www.dropbox.com/developers/quickstart to create a Dropbox development application, and copy the application keys. Unless you get your app approved for production status, these keys will only work with the account you create them under, so make sure you are logged in with the account you want to access from dbox.
 
 * Now either set the keys as environment variables:
 
@@ -65,16 +71,16 @@ Usage
 $ dbox authorize
 ```
 
-### Clone an existing Dropbox folder
+### Create a new Dropbox folder
 
 ```sh
-$ dbox clone <remote_path> [<local_path>]
+$ dbox create <remote_path> [<local_path>]
 ```
 
-### Create a new Dropbox folder
+### Clone an existing Dropbox folder
 
 ```sh
-$ dbox create <remote_path> [<local_path>]
+$ dbox clone <remote_path> [<local_path>]
 ```
 
 ### Pull (download changes from Dropbox)

data/Rakefile

@@ -17,19 +17,15 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :default => :test
+task :default => :spec

data/TODO.txt

@@ -1,6 +1,5 @@
-* Add tests
-* Add proper logger
-* See if pull re-creates locally-deleted files (it shouldn't)
+* More helpers in specs (and string style paths instead of join all over the place)
+* Have pull, push, etc return a list of changed files
 * Look down directory tree until you hit a .dropbox.db file
 * Solve upload -> re-download issue
 * Add rename_remote command

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/dbox

@@ -5,14 +5,26 @@ require "dbox"
 
 # usage line
 def usage
-  "Usage:
-  dbox authorize
-  export DROPBOX_AUTH_KEY=abcdef012345678
-  export DROPBOX_AUTH_SECRET=876543210fedcba
-  dbox create <remote_path> [<local_path>]
-  dbox clone <remote_path> [<local_path>]
-  dbox pull
-  dbox push"
+  <<_EOF
+Usage: dbox <commond> [<args>]
+
+Commands:
+  authorize                            Generate auth keys
+  create <remote_path> [<local_path>]  Create a new Dropbox folder
+  clone <remote_path> [<local_path>]   Clone an existing Dropbox folder
+  pull [<local_path>]                  Pull chonges from Dropbox
+  push [<local_path>]                  Push changes to Dropbox
+
+Environment varables needed for everything:
+  export DROPBOX_APP_KEY=cmlrrjd3j0gbend
+  export DROPBOX_APP_SECRET=uvuulp75xf9jffl
+
+Environment varables needed for everything other than authorize:
+  export DROPBOX_AUTH_KEY=v4d7l1rez1czksn
+  export DROPBOX_AUTH_SECRET=pqej9rmnj0i1gcxr4
+
+See http://github.com/kenpratt/dbox for examples and more information
+_EOF
 end
 def print_usage_and_quit; puts usage; exit 1; end
 

data/dbox.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dbox}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Ken Pratt}]
+  s.date = %q{2011-05-14}
+  s.description = %q{An easy-to-use Dropbox client with fine-grained control over syncs.}
+  s.email = %q{ken@kenpratt.net}
+  s.executables = [%q{dbox}]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "TODO.txt",
+    "VERSION",
+    "bin/dbox",
+    "dbox.gemspec",
+    "lib/dbox.rb",
+    "lib/dbox/api.rb",
+    "lib/dbox/db.rb",
+    "lib/dbox/loggable.rb",
+    "spec/dbox_spec.rb",
+    "spec/spec_helper.rb",
+    "vendor/dropbox-client-ruby/LICENSE",
+    "vendor/dropbox-client-ruby/README",
+    "vendor/dropbox-client-ruby/Rakefile",
+    "vendor/dropbox-client-ruby/config/testing.json.example",
+    "vendor/dropbox-client-ruby/lib/dropbox.rb",
+    "vendor/dropbox-client-ruby/manifest",
+    "vendor/dropbox-client-ruby/test/authenticator_test.rb",
+    "vendor/dropbox-client-ruby/test/client_test.rb",
+    "vendor/dropbox-client-ruby/test/util.rb"
+  ]
+  s.homepage = %q{http://github.com/kenpratt/dbox}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.1}
+  s.summary = %q{Dropbox made easy.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/dbox.rb

@@ -6,7 +6,9 @@ require "dropbox"
 require "fileutils"
 require "time"
 require "yaml"
+require "logger"
 
+require "dbox/loggable"
 require "dbox/api"
 require "dbox/db"
 
@@ -42,7 +44,7 @@ module Dbox
   def self.clean_remote_path(path)
     if path
       path.sub(/\/$/,'')
-      path[0] == "/" ? path : "/#{path}"
+      path[0].chr == "/" ? path : "/#{path}"
     else
       raise "Missing remote path"
     end

data/lib/dbox/api.rb

@@ -1,9 +1,9 @@
 module Dbox
   class API
+    include Loggable
+
     def self.authorize
-      puts conf.inspect
       auth = Authenticator.new(conf)
-      puts auth.inspect
       authorize_url = auth.get_request_token
       puts "Please visit the following URL in your browser, log into Dropbox, and authorize the app you created.\n\n#{authorize_url}\n\nWhen you have done so, press [ENTER] to continue."
       STDIN.readline
@@ -43,31 +43,42 @@ module Dbox
 
     def metadata(path = "/")
       path = escape_path(path)
-      puts "[api] fetching metadata for #{path}"
-      @client.metadata(@conf["root"], path)
+      log.debug "Fetching metadata for #{path}"
+      begin
+        case res = @client.metadata(@conf["root"], path)
+        when Hash
+          res
+        when Net::HTTPNotFound
+          raise "Remote path does not exist"
+        else
+          raise "Unexpected result from GET /metadata: #{res.inspect}"
+        end
+      rescue DropboxError => e
+        raise "Server error -- might be a hiccup, please try your request again (#{e.message})"
+      end
     end
 
     def create_dir(path)
       path = escape_path(path)
-      puts "[api] creating #{path}"
+      log.info "Creating #{path}"
       @client.file_create_folder(@conf["root"], path)
     end
 
     def delete_dir(path)
       path = escape_path(path)
-      puts "[api] deleting #{path}"
+      log.info "Deleting #{path}"
       @client.file_delete(@conf["root"], path)
     end
 
     def get_file(path)
       path = escape_path(path)
-      puts "[api] downloading #{path}"
+      log.info "Downloading #{path}"
       @client.get_file(@conf["root"], path)
     end
 
     def put_file(path, file_obj)
       path = escape_path(path)
-      puts "[api] uploading #{path}"
+      log.info "Uploading #{path}"
       dir = File.dirname(path)
       name = File.basename(path)
       @client.put_file(@conf["root"], dir, name, file_obj)
@@ -75,7 +86,7 @@ module Dbox
 
     def delete_file(path)
       path = escape_path(path)
-      puts "[api] deleting #{path}"
+      log.info "Deleting #{path}"
       @client.file_delete(@conf["root"], path)
     end
 

data/lib/dbox/db.rb

@@ -1,27 +1,23 @@
 module Dbox
   class DB
+    include Loggable
+
     DB_FILE = ".dropbox.db"
 
     attr_accessor :local_path
 
     def self.create(remote_path, local_path)
-      puts "[db] Creating remote folder: #{remote_path}"
+      log.info "Creating remote folder: #{remote_path}"
       api.create_dir(remote_path)
       clone(remote_path, local_path)
     end
 
     def self.clone(remote_path, local_path)
-      puts "[db] Cloning #{remote_path} into #{local_path}"
-      case res = api.metadata(remote_path)
-      when Hash
-        raise "Remote path error" unless remote_path == res["path"]
-        db = new(local_path, res)
-        db.pull
-      when Net::HTTPNotFound
-        raise "Remote path does not exist"
-      else
-        raise "Clone failed: #{res.inspect}"
-      end
+      log.info "Cloning #{remote_path} into #{local_path}"
+      res = api.metadata(remote_path)
+      raise "Remote path error" unless remote_path == res["path"]
+      db = new(local_path, res)
+      db.pull
     end
 
     def self.load(local_path)
@@ -124,6 +120,8 @@ module Dbox
     end
 
     class DropboxBlob
+      include Loggable
+
       attr_reader :path, :revision, :modified_at
 
       def initialize(db, res)
@@ -235,7 +233,7 @@ module Dbox
       def pull
         prev = self.clone
         prev.freeze
-        puts "[db] pulling"
+        log.info "Pulling changes"
         res = api.metadata(remote_path)
         update(res)
         if contents_hash != prev.contents_hash
@@ -247,7 +245,7 @@ module Dbox
       def push
         prev = self.clone
         prev.freeze
-        puts "[db] pushing"
+        log.info "Pushing changes"
         res = gather_info(@path)
         update(res)
         reconcile(prev, :up)
@@ -305,7 +303,7 @@ module Dbox
       end
 
       def create_local
-        puts "[fs] creating dir #{local_path}"
+        log.info "Creating dir: #{local_path}"
         saving_parent_timestamp do
           FileUtils.mkdir_p(local_path)
           update_file_timestamp
@@ -313,14 +311,14 @@ module Dbox
       end
 
       def delete_local
-        puts "[fs] deleting dir #{local_path}"
+        log.info "Deleting dir: #{local_path}"
         saving_parent_timestamp do
           FileUtils.rm_r(local_path)
         end
       end
 
       def update_local
-        puts "[fs] updating dir #{local_path}"
+        log.info "Updating dir: #{local_path}"
         update_file_timestamp
       end
 
@@ -356,7 +354,7 @@ module Dbox
       end
 
       def create_local
-        puts "[fs] creating file #{local_path}"
+        log.info "Creating file: #{local_path}"
         saving_parent_timestamp do
           download
           update_file_timestamp
@@ -364,14 +362,14 @@ module Dbox
       end
 
       def delete_local
-        puts "[fs] deleting file #{local_path}"
+        log.info "Deleting file: #{local_path}"
         saving_parent_timestamp do
           FileUtils.rm_rf(local_path)
         end
       end
 
       def update_local
-        puts "[fs] updating file #{local_path}"
+        log.info "Updating file: #{local_path}"
         download
         update_file_timestamp
       end

data/lib/dbox/loggable.rb

@@ -0,0 +1,34 @@
+module Dbox
+  module Loggable
+    def self.included receiver
+      receiver.extend ClassMethods
+    end
+
+    module ClassMethods
+      def log
+        Dbox.log
+      end
+    end
+
+    def log
+      Dbox.log
+    end
+  end
+
+  def self.log
+    @logger ||= setup_logger
+  end
+
+  def self.setup_logger
+    if defined?(LOGGER)
+      LOGGER
+    elsif defined?(Rails.logger)
+      Rails.logger
+    else
+      l = Logger.new(STDOUT)
+      l.level = Logger::INFO
+      l.formatter = proc {|severity, datetime, progname, msg| "[#{severity}] #{msg}\n" }
+      l
+    end
+  end
+end

data/spec/dbox_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+include FileUtils
+
+describe Dbox do
+  before(:each) do
+    cd LOCAL_TEST_PATH
+    @name = randname()
+    @local = File.join(LOCAL_TEST_PATH, @name)
+    @remote = File.join(REMOTE_TEST_PATH, @name)
+  end
+
+  describe "#create" do
+    it "creates the local directory" do
+      Dbox.create(@remote)
+      File.exists?(@local).should be_true
+    end
+
+    xit "should fail if the remote already exists" do
+      Dbox.create(@remote)
+      rm_rf @local
+      expect { Dbox.create(@remote) }.to raise_error("Remote path already exists")
+      File.exists?(@local).should be_false
+    end
+  end
+
+  describe "#clone" do
+    it "creates the local directory" do
+      Dbox.create(@remote)
+      rm_rf @local
+      File.exists?(@local).should be_false
+      Dbox.clone(@remote)
+      File.exists?(@local).should be_true
+    end
+
+    it "should fail if the remote does not exist" do
+      expect { Dbox.clone(@remote) }.to raise_error("Remote path does not exist")
+      File.exists?(@local).should be_false
+    end
+  end
+
+  describe "#pull" do
+    it "should fail if the local dir is missing" do
+      expect { Dbox.pull(@local) }.to raise_error(/No DB file found/)
+    end
+
+    it "should fail if the remote dir is missing" do
+      Dbox.create(@remote)
+      modify_dbfile {|s| s.sub(/^remote_path: \/.*$/, "remote_path: /#{randname()}") }
+      expect { Dbox.pull(@local) }.to raise_error("Remote path does not exist")
+    end
+
+    it "should be able to pull" do
+      Dbox.create(@remote)
+      expect { Dbox.pull(@local) }.to_not raise_error
+    end
+
+    it "should be able to pull from inside the dir" do
+      Dbox.create(@remote)
+      cd @local
+      expect { Dbox.pull }.to_not raise_error
+    end
+
+    it "should be able to pull changes" do
+      Dbox.create(@remote)
+      File.exists?("#{@local}/hello.txt").should be_false
+
+      cd ALTERNATE_LOCAL_TEST_PATH
+      Dbox.clone(@remote)
+      cd @name
+      touch "hello.txt"
+      Dbox.push
+
+      expect { Dbox.pull(@local) }.to_not raise_error
+      File.exists?("#{@local}/hello.txt").should be_true
+    end
+
+    it "should be able to pull after deleting a file and not have the file re-created" do
+      Dbox.create(@remote)
+      cd @name
+      touch "hello.txt"
+      Dbox.push
+      Dbox.pull
+      rm "hello.txt"
+      Dbox.pull
+      File.exists?("#{@local}/hello.txt").should be_false
+    end
+  end
+
+  describe "#push" do
+    it "should fail if the local dir is missing" do
+      expect { Dbox.push(@local) }.to raise_error(/No DB file found/)
+    end
+
+    it "should be able to push" do
+      Dbox.create(@remote)
+      expect { Dbox.push(@local) }.to_not raise_error
+    end
+
+    it "should be able to push from inside the dir" do
+      Dbox.create(@remote)
+      cd @local
+      expect { Dbox.push }.to_not raise_error
+    end
+
+    it "should be able to push new file" do
+      Dbox.create(@remote)
+      touch File.join(@local, "foo.txt")
+      expect { Dbox.push(@local) }.to_not raise_error
+    end
+
+    it "should create the remote dir if it is missing" do
+      Dbox.create(@remote)
+      touch File.join(@local, "foo.txt")
+      @new_name = randname()
+      @new_remote = File.join(REMOTE_TEST_PATH, @new_name)
+      modify_dbfile {|s| s.sub(/^remote_path: \/.*$/, "remote_path: #{@new_remote}") }
+      expect { Dbox.push(@local) }.to_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "rspec"
+require "dbox"
+require "fileutils"
+
+LOCAL_TEST_PATH = File.expand_path(File.join(File.dirname(__FILE__), "..", "tmp", "test_dirs"))
+ALTERNATE_LOCAL_TEST_PATH = File.join(LOCAL_TEST_PATH, "alternate")
+FileUtils.mkdir_p(LOCAL_TEST_PATH)
+FileUtils.mkdir_p(ALTERNATE_LOCAL_TEST_PATH)
+
+REMOTE_TEST_PATH = "/dbox_test_dirs"
+
+LOGGER = Logger.new(File.expand_path(File.join(File.dirname(__FILE__), "..", "tmp", "test.log")))
+
+def randname
+  u = `uuidgen`.chomp
+  "test-#{u}"
+end
+
+def modify_dbfile
+  dbfile = File.join(@local, Dbox::DB::DB_FILE)
+  s = File.open(dbfile, "r").read
+  s = yield s
+  File.open(dbfile, "w") {|f| f << s }
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dbox
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ken Pratt
@@ -35,11 +35,13 @@ files:
 - TODO.txt
 - VERSION
 - bin/dbox
+- dbox.gemspec
 - lib/dbox.rb
 - lib/dbox/api.rb
 - lib/dbox/db.rb
-- test/helper.rb
-- test/test_dbox.rb
+- lib/dbox/loggable.rb
+- spec/dbox_spec.rb
+- spec/spec_helper.rb
 - vendor/dropbox-client-ruby/LICENSE
 - vendor/dropbox-client-ruby/README
 - vendor/dropbox-client-ruby/Rakefile

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'dbox'
-
-class Test::Unit::TestCase
-end

data/test/test_dbox.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestDbox < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end