dropbox 0.0.2 → 0.0.5

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/
+.DS_Store
+*.gem

data/README.markdown

@@ -0,0 +1,10 @@
+DropBox
+=======
+
+A simple Ruby API for DropBox
+
+Usage
+-----
+
+    d = DropBox.new("you@email.com","password!")
+    p d.list("/")

data/Rakefile

@@ -1,22 +1,35 @@
 require 'rubygems'
 require 'rake'
+require 'spec/rake/spectask'
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "dropbox"
-    gem.summary = %Q{A simple Ruby API for DropBox }
-    gem.description = <<-DESC
-A simple Ruby API for DropBox 
-DESC
-    gem.email = ""
-    gem.homepage = ""
-    gem.authors  = []
-    gem.files =  FileList["[A-Z]*", "{lib}/**/*"]
-
-    gem.add_dependency("nokogiri")
-    gem.add_dependency("mechanize")
+    open("VERSION") do |f|
+      gem.version = f.read
+    end
+    gem.summary = %Q{A Simple DropBox API in Ruby}
+    gem.description = %Q{A Simple DropBox API in Ruby}
+    gem.email = "tys@tvg.ca"
+    gem.homepage = "http://github.com/tvongaza/DropBox"
+    gem.authors = ["Tys von Gaza","JP Hastings-Spital","Chris Searle","Nicholas A. Evans"]
+    gem.add_development_dependency "Shoulda"
+    gem.add_dependency "mechanize"
+    gem.add_dependency "nokogiri"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('examples') do |t|
+  t.spec_files = FileList['examples/**/*.rb']
+  t.libs << 'lib'
+  t.spec_opts = %w[-c -fs]
+  t.ruby_opts = %w[-rubygems]
 end
+
+task :default => :examples

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.5

data/examples/dropbox_spec.rb

@@ -0,0 +1,98 @@
+require 'spec'
+require 'dropbox'
+
+%w[DROPBOX_EMAIL DROPBOX_PASSWORD].each do |var|
+  raise "Need to set #{var} to run the specs." unless ENV[var]
+end
+ENV["DROPBOX_FOLDER_NAMESPACE"] ||= "dropboxrb/specroot"
+
+describe DropBox do
+  before :all do
+    # TODO: check for existance of DROPBOX_FOLDER_NAMESPACE
+    # TODO: ensure the folder starts out empty
+    @connection = connection
+  end
+
+  def connection
+    DropBox.new(ENV["DROPBOX_EMAIL"],
+                ENV["DROPBOX_PASSWORD"],
+                ENV["DROPBOX_FOLDER_NAMESPACE"])
+  end
+
+  def dirent_for(name)
+    @connection.list.find {|f| f["name"] == name }
+  end
+
+  context "uploading a file" do
+    before :all do
+      @file = Tempfile.new("dbrb")
+      @contents = <<-EOF
+        This is a temp file used by the dropbox.rb specs.
+        foo
+        bar
+        baz
+      EOF
+      @file.print @contents
+      @file.flush
+      @basename = File.basename(@file.path)
+      @connection.create(@file.path)
+    end
+    after :all do
+      # TODO: fix the bugs that force us to reset the connection.before deleting the file
+      @connection.login
+      @connection.destroy @basename
+      @file.close!
+    end
+
+    it "should be listed at the toplevel" do
+      @connection.list.map {|f| f["name"] }.should include(@basename)
+    end
+
+    it "should be listed as not a directory" do
+      dirent_for(@basename)["directory"].should be_false
+    end
+
+    it "should have a path relative to the folder namespace (containing query params)" do
+      dirent_for(@basename)["path"].should match(%r{^/#{@basename}\?w=.*$})
+    end
+
+    it "should be retrievable" do
+      path = dirent_for(@basename)["path"]
+      @connection.get(path).should == @contents
+    end
+
+  end
+
+  context "creating a directory at the toplevel" do
+    before { @connection.create_directory("spec_create_dir") }
+    after  { @connection.destroy("spec_create_dir") }
+
+    it "should be listed at the toplevel" do
+      @connection.list.map {|f| f["name"] }.should include("spec_create_dir")
+    end
+
+    it "should be listed as a directory" do
+      dirent_for("spec_create_dir")["directory"].should be_true
+    end
+
+    it "should have a path relative to the folder namespace" do
+      dirent_for("spec_create_dir")["path"].should == "/spec_create_dir"
+    end
+
+    it "should contain only a link to the parent directory" do
+      list = @connection.list("spec_create_dir")
+      list.should have(1).item
+      dir = list.first
+      dir["name"].should == "Parent folder"
+      dir["directory"].should be_true
+      dir["path"].should == ""
+    end
+
+  end
+
+  #context "renaming a file"
+  #context "deleting a file"
+
+end
+
+#describe DropBox, "folder namespace"

data/lib/dropbox.rb

@@ -1 +1,14 @@
-require 'dropbox/dropbox'
+require 'dropbox/dropbox'
+
+## Should I include this?
+require 'delegate'
+ 
+# Allows percentages to be inspected and stringified in human
+# form "33.3%", but kept in a float format for mathmatics
+class Percentage < DelegateClass(Float)
+  def to_s(decimalplaces = 0)
+    (((self * 10**(decimalplaces+2)).round)/10**decimalplaces).to_s+"%"
+  end
+  alias :inspect :to_s
+end
+

data/lib/dropbox/dropbox.rb

@@ -1,8 +1,7 @@
-require 'rubygems'
 require 'nokogiri'
 require 'mechanize'
 
-WWW::Mechanize.html_parser = Nokogiri::HTML
+Mechanize.html_parser = Nokogiri::HTML
 
 # TODO: Tests (mock out expected DropBox output)
 # TODO: Directory object, File object
@@ -13,35 +12,12 @@ class DropBox
 	def initialize(email, password, folder_namespace = "")
 		@email = email
 		@password = password
-		@agent = WWW::Mechanize.new
+		@agent = Mechanize.new
 		@folder_namespace = folder_namespace.gsub(/^\//,"")
 		@logged_in = false
 	end
 	
-	def login
-		page = @agent.get('https://www.dropbox.com/login')
-		login_form = page.forms.detect { |f| f.action == "/login" }
-		login_form.login_email = @email
-		login_form.login_password = @password
-		
-		home_page = @agent.submit(login_form)
-		# todo check if we are logged in! (ie search for email and "Log out"
-		@logged_in = true
-		@token = home_page.at('//script[contains(text(), "TOKEN")]').content.match("TOKEN: '(.*)',$")[1]
-		
-		# check if we have our namespace
-		
-		home_page
-	end
-	
-	def login_filter
-		login unless @logged_in
-	end
-		
-	def list(path = "/")
-		index(path)
-	end
-	
+	# Lists all the files and folders in a given directory
 	def index(path = "/")
  		login_filter
 		path = namespace_path(path)
@@ -58,9 +34,14 @@ class DropBox
 			if match_data = details['url'].match(/^\/browse_plain(.*)$/)
 				details['directory'] = true
 				details['path'] = normalize_namespace(match_data[1])
-			else
+			elsif match_data = details['url'].match(%r{^https?://[^/]*/get(.*)$})
 				details['directory'] = false
-				details['path'] = normalize_namespace(details['url'][33..-1])
+				details['path'] = normalize_namespace(match_data[1])
+      elsif match_data = details['url'].match(%r{^https?://[^/]*/u/\d*/(.*)$})
+          details['directory'] = false
+          details['path'] = "Public/#{match_data[1]}"
+			else
+				raise "could not parse path from Dropbox URL: #{details['url'] }"
 			end
 			
 			details
@@ -69,6 +50,9 @@ class DropBox
 		return listing
 	end
 	
+	alias :list :index
+	
+	# Lists the full history for a file on DropBox
 	def list_history(path)
 		login_filter
 		
@@ -91,11 +75,8 @@ class DropBox
 		
 		return listing
 	end
-
-	def get(path)
-		show(path)
-	end
 	
+	# Downloads the specified file from DropBox
 	def show(path)
 		# change to before filter
 		login_filter
@@ -105,15 +86,18 @@ class DropBox
 		#https://dl-web.dropbox.com/get/testing.txt?w=0ff80d5d&sjid=125987568
 		@agent.get("https://dl-web.dropbox.com/get/#{path}").content
 	end
-		
+	
+	alias :get :show
+	
+	# Creates a directory
 	def create_directory(new_path, destination = "/" )
 		# change to before filter
 		login unless @logged_in
 		destination = namespace_path(destination)
-		@agent.post("/cmd/new#{destination}",{"to_path"=>new_path, "folder"=>"yes", "t" => @token })
-		# check status code
+		@agent.post("/cmd/new#{destination}",{"to_path"=>new_path, "folder"=>"yes", "t" => @token }).code == "200"
 	end
 	
+	# Uploads a file to DropBox under the given filename
 	def create(file, destination = "/")
 		# change to before filter
 		if @logged_in
@@ -122,39 +106,44 @@ class DropBox
 			home_page = login
 		end
 		
-		destination = namespace_path(destination)
-
 		upload_form = home_page.forms.detect{ |f| f.action == "https://dl-web.dropbox.com/upload" }
-		upload_form.dest = "/#{@folder_namespace}/#{destination}"
+		upload_form.dest = namespace_path(destination)
 		upload_form.file_uploads.first.file_name = file if file
 		
-		@agent.submit(upload_form)
-	end
-
-	def update(file, destination = "/")
-		create(file, destination)
+		@agent.submit(upload_form).code == "200"
 	end
 	
+  alias :update :create
+	
+	# Renames a file or folder in the DropBox
 	def rename(file, destination)
 		login_filter
 		file = namespace_path(file)
 		destination = namespace_path(destination)
-		@agent.post("/cmd/rename#{file}", {"to_path"=> destination, "t" => @token })		
+		@agent.post("/cmd/rename#{file}", {"to_path"=> destination, "t" => @token }).code == "200"
 	end
 	
+	# Deletes a file/folder from the DropBox (accepts string path or an array of string paths)
 	def destroy(paths)
 		login_filter
 		paths = [paths].flatten
 		paths = paths.collect { |path| namespace_path(path) }
-		@agent.post("/cmd/delete", {"files"=> paths, "t" => @token })
+		@agent.post("/cmd/delete", {"files"=> paths, "t" => @token }).code == "200"
 	end
 
+  # Permanently deletes a file from the DropBox (no history!) accepts arrays, as #destroy does
 	def purge(paths)
 		login_filter
 		paths = [paths].flatten
 		paths = paths.collect { |path| namespace_path(path) }
-		@agent.post("/cmd/purge", {"files"=> paths, "t" => @token })
+		@agent.post("/cmd/purge", {"files"=> paths, "t" => @token }).code == "200"
 	end
+	
+	# Will give a hash of the amount of space left on the DropBox, the amound used, the calculated amount free (all as a 1 d.p. rounded GB value) and the percentage used (scraped)
+	def usage_stats
+	  login_filter
+	  @agent.get("/account").at('#usage-percent').content.scan(/(\d+(?:\.\d+)?)%\ used\ \((\d+(?:\.\d+)?)([MG])B of (\d+(?:\.\d+)?)GB\)/).collect{|d| {:used => d[1].to_f * ((d[2] == "M") ? 1024 : 1), :total => d[3].to_f, :free => (d[3].to_f - d[1].to_f * ((d[2] == "M") ? 1024 : 1)), :percent => Percentage.new(d[0].to_f/100)} }[0]
+  end
 
 	private
 	def namespace_path(path)
@@ -171,4 +160,27 @@ class DropBox
 		file.gsub(/^\/#{@folder_namespace}/,"")
 	end
 
-end
+  def login
+		page = @agent.get('https://www.dropbox.com/login')
+		login_form = page.forms.detect { |f| f.action == "/login" }
+		login_form.login_email = @email
+		login_form.login_password = @password
+		
+		home_page = @agent.submit(login_form)
+		# todo check if we are logged in! (ie search for email and "Log out"
+		@logged_in = true
+		@token = home_page.at('//script[contains(text(), "TOKEN")]').content.match("TOKEN: '(.*)',$")[1]
+		
+		# check if we have our namespace
+		
+		home_page
+	end
+	
+	def login_filter
+		login unless @logged_in
+	end
+end
+
+# this file doesn't use the standard ruby indent settings, so the following
+# modeline will make sure that the whitespace stays consistent.
+# vim:noexpandtab tabstop=4 shiftwidth=4

metadata

@@ -1,55 +1,79 @@
 --- !ruby/object:Gem::Specification 
 name: dropbox
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
 platform: ruby
-authors: []
-
+authors: 
+- Tys von Gaza
+- JP Hastings-Spital
+- Chris Searle
+- Nicholas A. Evans
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-06 00:00:00 +01:00
+date: 2010-03-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: Shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mechanize
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: |
-  A simple Ruby API for DropBox 
-
-email: ""
+  type: :runtime
+  version_requirements: *id003
+description: A Simple DropBox API in Ruby
+email: tys@tvg.ca
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.markdown
 files: 
-- README
+- .gitignore
+- README.markdown
 - Rakefile
 - VERSION
+- examples/dropbox_spec.rb
 - lib/dropbox.rb
 - lib/dropbox/dropbox.rb
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/tvongaza/DropBox
 licenses: []
 
 post_install_message: 
@@ -61,20 +85,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A simple Ruby API for DropBox
-test_files: []
-
+summary: A Simple DropBox API in Ruby
+test_files: 
+- examples/dropbox_spec.rb

data/README

@@ -1,3 +0,0 @@
-A simple Ruby API for DropBox 
-
-Install with: gem install dropbox (using gemcutter as source)