davclient 0.0.5 → 0.0.6

data/LICENSE

@@ -0,0 +1,53 @@
+DavClient (davclient and the dav utility) is copyrighted free software by Thomas Flemming
+<thomas dot flemming at usit dot uio do no> and contributors. You can redistribute it
+and/or modify it under either the terms of the GPL2 or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+     a) place your modifications in the Public Domain or otherwise make them
+     Freely Available, such as by posting said modifications to Usenet or an
+     equivalent medium, or by allowing the author to include your
+     modifications in the software.
+
+     b) use the modified software only within your corporation or
+        organization.
+
+     c) rename any non-standard executables so the names do not conflict with
+     standard executables, which must also be provided.
+
+     d) make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or executable
+   form, provided that you do at least ONE of the following:
+
+     a) distribute the executables and library files of the software,
+     together with instructions (in the manual page or equivalent) on where
+     to get the original distribution.
+
+     b) accompany the distribution with the machine-readable source of the
+     software.
+
+     c) give non-standard executables non-standard names, with
+        instructions on where to get the original software distribution.
+
+     d) make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial). But some files in the distribution
+   are not written by the author, so that they are not under this terms.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/Manifest

@@ -0,0 +1,31 @@
+LICENSE
+Manifest
+README.rdoc
+Rakefile
+bin/dav
+davclient.gemspec
+examples/remove_ds_store.rb
+examples/simple_find.rb
+lib/davclient.rb
+lib/davclient/curl_commands.rb
+lib/davclient/dav-ls.rb
+lib/davclient/dav-propfind.rb
+lib/davclient/dav-put.rb
+lib/davclient/davcli.rb
+lib/davclient/hpricot_extensions.rb
+lib/davclient/simple.rb
+tests/dav.rb
+tests/tc_dav-cat.rb
+tests/tc_dav-cd.rb
+tests/tc_dav-cp.rb
+tests/tc_dav-delete.rb
+tests/tc_dav-get.rb
+tests/tc_dav-ls.rb
+tests/tc_dav-mkcol.rb
+tests/tc_dav-mv.rb
+tests/tc_dav-propfind.rb
+tests/tc_dav-put.rb
+tests/tc_webdav_basic.rb
+tests/tc_webdav_publish.rb
+tests/test_helper.rb
+tests/ts_davclient.rb

data/README.rdoc

@@ -5,9 +5,7 @@
 
 == DESCRIPTION:
 
-A scriptable WebDAV command line client for
-
-WebDAV command line client written in Ruby for managing content on
+A scriptable WebDAV command line client for Ruby for managing content on
 webservers that support the WebDAV extensions.
 
 This is still very much work in progress. Especially the command line interface
@@ -43,30 +41,71 @@ on how to add username etc. to the '~/.netrc' file.
 
 == COMMAND LINE SYNOPSIS:
 
-  >dav cd http://test.webdav.org/dav/
+  bash $ dav cd http://test.webdav.org/dav/
   http://test.webdav.org/dav/
-  >dav ls
+  bash $ dav ls
   images/
   index.html
-  >dav pwd
+  bash $ dav pwd
   http://test.webdav.org/dav/
+  bash $ get ./index.html
+  bash $ dav --help
+  usage: dav COMMAND [ARGS]
+
+  Available dav commands:
+     ls        List files on webdav server
+     pwd       Print current working url
+     cd        Change current working url
+     cp        Copy resource
+     mv        Move resource
+     rm        Remove resource
+     cat       Print content of resource
+     mkdir     Create remote collection (directory) (mkcol alias)
+     get       Download resource
+     put       Upload local file
+     propfind  Print webdav properties for url
+     mkcol     Make collection
+     options   Display webservers WebDAV options
+     edit      Edit contents of remote file with editor
+
+== USE WITH IRB:
+
+IRB can also be used as an interactive dav console:
+
+  bash $ irb -rubygems -rdavclient/simple
+  >> cd "https://webdav.org/projects/"
+  => "https://webdav.org/projects/"
+  >> pwd
+  => "https://webdav.org/projects/"
+  >> content = get "index.html"
+  => "index.html"
+  >> ls
+  index.html
+  >> cd ".."
+  => "https://webdav.org/"
+
 
 == INSTALL:
 
+If you can type the command 'curl' in your terminal window, everything is ok.
+
+DavClient uses the command line utility cURL to interact with servers.
+Curl comes preinstalled on Mac OS X. It can also be downloaded from
+http://curl.haxx.se/ . If you are using debian or ubuntu, it
+can be installed with apt-get:
+
+  sudo apt-get install curl
+
+Then install DavClient:
+
   [sudo] gem install davclient
 
 or
 
   git clone git://github.com/thomasfl/davclient.git
   cd davclient
-  gem build Rakefile
-  sudo gem install davclient-x.x.x.gem
+  sudo rake install
 
-Curl comes preinstalled on Mac OS X. It can be downloaded from
-http://curl.haxx.se/ . If you are using debian or ubuntu, it
-can be installed by:
-
-  sudo apt-get install curl
 
 == Background:
 

data/Rakefile

@@ -0,0 +1,94 @@
+# Rakefile for DavClient   -*- ruby -*-
+# Usage:
+#
+#     rake package      Create gem
+#     rake rdoc         Create doc
+#     rake upload-docs  Upload docs to rubyforge
+#
+#     rake install      Create and install gem
+#     rake manifest     Create manifest
+#     rake release      Release to rubyforge
+
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+GEM_VERSION = "0.0.6"
+
+spec = Gem::Specification.new do |s|
+  s.name = "davclient"
+  s.version = GEM_VERSION
+  s.author = "Thomas Flemming"
+  s.email = "thomasfl@usit.uio.no"
+  s.homepage = "http://folk.uio.no/thomasfl"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Command line WebDAV client and Ruby library."
+  s.description = "WebDAV command line client written in Ruby for managing " +
+                  "content on webservers that support the WebDAV extensions."
+  s.requirements << "cURL command line tool available from http://curl.haxx.se/"
+  s.requirements << "Servername, username and password must be supplied in ~/.netrc file."
+  s.files = ["lib/davclient.rb","lib/davclient/hpricot_extensions.rb",
+             "lib/davclient/curl_commands.rb", "bin/dav", "lib/davclient/davcli.rb",
+             "lib/davclient/dav-put.rb", "lib/davclient/dav-ls.rb",
+             "lib/davclient/dav-propfind.rb"]
+  s.executables = ["dav"]
+  s.require_path = "lib"
+  s.rubyforge_project = "davclient"
+  #  s.test_files = FileList["{test}/**/*test.rb"].to_a
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.add_dependency("hpricot", ">= 0.6")
+  s.add_dependency("ZenTest", ">= 3.5") # For tests
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+
+
+html_dir = 'doc/html'
+library = 'Ruby DavClient'
+Rake::RDocTask.new('rdoc') do |t|
+  t.rdoc_files.include('README.rdoc',
+                       'lib/davclient.rb',
+                       'lib/davclient/hpricot_extensions.rb',
+                       'lib/davclient/simple.rb')
+  t.main = 'README.rdoc'
+  t.title = "#{library} API documentation"
+  t.rdoc_dir = html_dir
+end
+
+rubyforge_user = 'thomasfl'
+rubyforge_project = 'davclient'
+rubyforge_path = "/var/www/gforge-projects/#{rubyforge_project}/"
+desc 'Upload documentation to RubyForge.'
+task 'upload-docs' => ['rdoc'] do
+  sh "scp -r #{html_dir}/* " +
+    "#{rubyforge_user}@rubyforge.org:#{rubyforge_path}"
+end
+
+
+website_dir = 'site'
+desc 'Update project website to RubyForge.'
+task 'upload-site' do
+  sh "scp -r #{website_dir}/* " +
+    "#{rubyforge_user}@rubyforge.org:/var/www/gforge-projects/project/"
+end
+
+desc 'Update API docs and project website to RubyForge.'
+task 'publish' => ['upload-docs', 'upload-site']
+
+
+
+require 'echoe'
+
+Echoe.new('davclient',  GEM_VERSION) do |p|
+  p.description    = "Command line WebDAV client and Ruby library."
+  p.url            = "http://davclient.rubyforge.org/davclient"
+  p.author         = "Thomas Flemming"
+  p.email          = "thomasfl@usit.uio.no"
+  p.ignore_pattern = ["svn_user.yml", "svn_project.rake"]
+  p.project        = "davclient"
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/davclient.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{davclient}
+  s.version = "0.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Flemming"]
+  s.date = %q{2009-09-22}
+  s.default_executable = %q{dav}
+  s.description = %q{Command line WebDAV client and Ruby library.}
+  s.email = %q{thomasfl@usit.uio.no}
+  s.executables = ["dav"]
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "bin/dav", "lib/davclient.rb", "lib/davclient/curl_commands.rb", "lib/davclient/dav-ls.rb", "lib/davclient/dav-propfind.rb", "lib/davclient/dav-put.rb", "lib/davclient/davcli.rb", "lib/davclient/hpricot_extensions.rb", "lib/davclient/simple.rb"]
+  s.files = ["LICENSE", "Manifest", "README.rdoc", "Rakefile", "bin/dav", "davclient.gemspec", "examples/remove_ds_store.rb", "examples/simple_find.rb", "lib/davclient.rb", "lib/davclient/curl_commands.rb", "lib/davclient/dav-ls.rb", "lib/davclient/dav-propfind.rb", "lib/davclient/dav-put.rb", "lib/davclient/davcli.rb", "lib/davclient/hpricot_extensions.rb", "lib/davclient/simple.rb", "tests/dav.rb", "tests/tc_dav-cat.rb", "tests/tc_dav-cd.rb", "tests/tc_dav-cp.rb", "tests/tc_dav-delete.rb", "tests/tc_dav-get.rb", "tests/tc_dav-ls.rb", "tests/tc_dav-mkcol.rb", "tests/tc_dav-mv.rb", "tests/tc_dav-propfind.rb", "tests/tc_dav-put.rb", "tests/tc_webdav_basic.rb", "tests/tc_webdav_publish.rb", "tests/test_helper.rb", "tests/ts_davclient.rb"]
+  s.homepage = %q{http://davclient.rubyforge.org/davclient}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Davclient", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{davclient}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Command line WebDAV client and Ruby library.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/examples/remove_ds_store.rb

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'davclient'
+
+# Remove all resources (files) named ".DS_Store"
+
+url = ARGV[0]
+
+WebDAV.find(url, :recursive => true ) do | item |
+  puts item.href if(item.isCollection?)
+  if(item.basename == ".DS_Store")
+    puts "Removing: " + item.href
+    WebDAV.delete(item.href)
+  end
+end

data/examples/simple_find.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'davclient/simple'
+
+# Simply print the url of all files and collections on server
+
+cd "https://vortex-dav.uio.no/brukere/thomasfl/"
+
+find do |item|
+  puts item.href
+end

data/lib/davclient/hpricot_extensions.rb

@@ -6,8 +6,6 @@ require 'hpricot'
 # Extensions to the Hpricot XML parser.
 module Hpricot
 
-
-
   class Elem
 
     # Makes properties available as simple method calls.

data/lib/davclient/simple.rb

@@ -0,0 +1,44 @@
+# A minimalistic API for interacting with WebDAV servers.
+#
+# If commands needs to Simple WebDAV API for use in scripts where namespacing is not necessary.
+
+# :stopdoc:
+
+require 'davclient'
+require 'davclient/dav-ls'
+
+# :startdoc:
+
+# Change working directory.
+#
+# Examples:
+#
+#    require 'davclient/simple'
+#
+#    cd("https://example.webdav.org/collection/")
+#    content = get("index.html")
+#    print content
+def cd(args)
+  WebDAV.cd(args)
+end
+
+def pwd
+  WebDAV.CWURL
+end
+
+def find(*args, &block)
+  WebDAV.find(*args, &block)
+end
+
+def ls(*args)
+  if(args == [])
+    LsCLI.ls([WebDAV.CWURL])
+  else
+    LsCLI.ls(*args)
+  end
+end
+
+def get(args)
+  WebDAV.get(args)
+end
+

data/lib/davclient.rb

@@ -15,7 +15,16 @@ require 'davclient/curl_commands'
 
 # :startdoc:
 
-# WebDAV client
+# Main WebDAV client. Current working URL is stored in a tempfile named /tmp/cwurl.pid, where pid is the parent process.
+# Username an password is stored in the ~/.netrc file. This means there is no need to set up any sessions or connections.
+#
+# If a change directory command is executed with a relative path, like for instance WebDAV.cd("../collection"), it will
+# raise an exception if current working url has not been set. First a change directory command is executed it should
+# use an absolute URL, like for instance WebDAV.cd("https://www.webdav.org/collection/").
+#
+# If using an URL with a server name not found in the ~/.netrc file, instructions for adding
+# the necessary servername, username and password will be printed to stdout.
+#
 module WebDAV
 
   # :stopdoc:
@@ -28,9 +37,9 @@ module WebDAV
     VERSION
   end
 
-  # Returns current working url. Used by command line utilites
+  # Returns current working url.
   def self.CWURL
-    return $CWURL if($CWURL) # Used by tests
+    return $CWURL if($CWURL)
     cwurl = nil
     filename = cwurl_filename
     if(File.exists?(filename))
@@ -54,14 +63,17 @@ module WebDAV
       # url = url + "/" if(not(url =~ /\/$/))
 
       if(not(url =~ /^http.?:\/\//))then
-        warn "#{$0}: Error: illegal url: " + url
-        exit
+        raise "illegal url: " + url
       end
     end
     return url
   end
 
-  # Returns true if url is a collection
+  # Boolean function that returns true if url is a collection
+  #
+  # Example:
+  #
+  #    WebDAV.isCollection("../test.html") => false
   def self.isCollection?(url)
     url = absoluteUrl(url)
     url = url + "/" if(not(url =~ /\/$/))
@@ -74,6 +86,9 @@ module WebDAV
   end
 
   # Change current working url. Takes relative pathnames.
+  # First time this method is called, an absolute URL
+  # must be used. Raises exception if servername is not
+  # found in ~/.netrc file.
   #
   # Examples:
   #
@@ -91,10 +106,12 @@ module WebDAV
     end
   end
 
-  # Sets current working url by storing url in a tempfile with parent process pid
+  # Sets current working url.
+  #
+  # Current working url is stored in aa tempfile with parent process pid
   # as part of the filename.
   def self.CWURL=(url)
-    $CWURL = url # Used by tests
+    $CWURL = url
     File.open(cwurl_filename, 'w') {|f| f.write(url) }
   end
 
@@ -118,8 +135,9 @@ module WebDAV
   # Example:
   #
   #   WebDAV.proppatch("https://dav.webdav.org/folder","<contentLastModified>2007-12-12 12:00:00 GMT</contentLastModified>
-  def self.proppatch(href, property)
-    curl_command = CURL_PROPPATCH + " \""+href+"\""
+  def self.proppatch(url, property)
+    url = absoluteUrl(url)
+    curl_command = CURL_PROPPATCH + " \""+url+"\""
     curl_command = curl_command.gsub("<!--property-and-value-->",property)
     response = exec_curl(curl_command)
     if(not(response =~ /200 OK/)) then
@@ -131,7 +149,8 @@ module WebDAV
   # Get WebDAV properties
   #
   # Examples:
-  #   item = propfind(url)                - Returns a Hpricot::Elem object
+  #
+  #   item = propfind(url)                - Returns an Hpricot::Elem object
   #
   #   xml = propfind(url, :xml => true)   - Returns xml for debugging.
   def self.propfind(*args)
@@ -181,9 +200,37 @@ module WebDAV
   #    puts folder.href
   #  end
   #
+  # If no url is specified, current working url is used.
+  #
+  #       cd("https://webdav.org")
+  #       find() do |item|
+  #         print item.title
+  #       end
   def self.find(*args, &block)
-    href = args[0]
-    options = args[1]
+
+    if(args.size == 0)
+      href = self.CWURL
+    elsif(args.size == 1)
+      if(args[0].class == String)
+        href = args[0]
+      else
+        options = args[0]
+      end
+    elsif(args.size == 2)
+      href = args[0]
+      options = args[1]
+    else
+      raise "Illegal number of arguments."
+    end
+
+    if(href == nil )
+      if(WebDAV.CWURL == nil)
+        raise "no current working url set"
+      else
+        href = WebDAV.CWURL
+      end
+    end
+
     type = nil
     recursive = false
     if(options)then
@@ -219,7 +266,7 @@ module WebDAV
 
         else
           # Filter result set
-          if((type == "collection" or type == "folder") and item.collection )then
+          if((type == "collection" or type == "folder" or type == "directory") and item.isCollection? )then
             items_filtered.push(item)
             if(block) then
               yield item

data/tests/dav.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+# This script is used to execute the 'dav' command line utility
+# without re-installing the ruby gem
+
+require 'test_helper'
+require 'rubygems'
+require 'davclient'
+require 'davclient/davcli'
+
+DavCLI.dav(ARGV)
+

data/tests/tc_dav-cat.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+require 'rubygems'
+require 'davclient'
+require 'davclient'
+require 'davclient/davcli'
+require 'test/unit'
+require 'test/zentest_assertions'
+
+
+class TestDavCat < Test::Unit::TestCase
+
+  def cat(*args)
+    out, err = util_capture do
+      DavCLI.cat(*args)
+    end
+    return [out.string, err.string]
+  end
+
+  def test_basic_cat
+    url = "https://vortex-dav.uio.no/brukere/thomasfl/testfile.html"
+    content = WebDAV.get(url)
+
+    out, err = cat([url])
+    assert_equal  content , out
+  end
+
+  def test_relative_urls
+    WebDAV.cd("https://vortex-dav.uio.no/brukere/thomasfl/")
+    content = WebDAV.get("testfile.html")
+    assert content
+  end
+
+end

data/tests/tc_dav-cd.rb

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'test/unit'
+require 'test_helper'
+require 'davclient'
+require 'davclient/davcli'
+require 'test/zentest_assertions'
+
+class TestWDavCd < Test::Unit::TestCase
+
+  def cd(*args)
+    out, err = util_capture do
+      DavCLI.cd(*args)
+    end
+    return ["", ""]
+    return [out.string, err.string]
+  end
+
+  def test_basic_cd
+    url = "https://vortex-dav.uio.no/prosjekter/it-avisa/nyheter/2006/"
+    out, err = cd([url])
+    assert_equal url, WebDAV.CWURL
+  end
+
+  def test_pathname
+    url = "https://vortex-dav.uio.no/prosjekter/it-avisa/nyheter/2006/"
+    out, err = cd([url])
+    assert_equal url, WebDAV.CWURL
+    out, err = cd([".."])
+    assert_equal url = "https://vortex-dav.uio.no/prosjekter/it-avisa/nyheter/", WebDAV.CWURL
+
+    out, err = WebDAV.cd("../../../brukere/thomasfl/")
+    assert_equal "https://vortex-dav.uio.no/brukere/thomasfl/", WebDAV.CWURL
+
+    exception = false
+    begin
+      out, err = WebDAV.cd(["../../../../../../"])
+    rescue Exception
+      exception = true
+    end
+    assert exception, "Should have raised an exception"
+
+  end
+
+end

data/tests/tc_dav-cp.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+require 'test_helper'
+require 'rubygems'
+require 'davclient'
+require 'davclient/davcli'
+require 'test/unit'
+require 'test/zentest_assertions'
+
+class TestCP < Test::Unit::TestCase
+
+  def cp(*args)
+    out, err = util_capture do
+      DavCLI.cp(*args)
+    end
+    return [out.string, err.string]
+  end
+
+  def test_cp
+    $DEBUG = false
+    src = "https://vortex-dav.uio.no/brukere/thomasfl/testfile.html"
+    dest = "https://vortex-dav.uio.no/brukere/thomasfl/testfile_copy.html"
+    WebDAV.delete(dest)
+    assert !WebDAV.exists?(dest)
+
+    WebDAV.cp(src,dest)
+    assert WebDAV.exists?(dest)
+  end
+
+  def test_propfind_command_line
+    src = "https://vortex-dav.uio.no/brukere/thomasfl/testfile.html"
+    dest = "https://vortex-dav.uio.no/brukere/thomasfl/testfile_copy.html"
+    WebDAV.delete(dest)
+    assert !WebDAV.exists?(dest)
+
+    out, err = cp([src,dest])
+    assert WebDAV.exists?(dest)
+
+    # Relative url
+    WebDAV.delete(dest)
+    assert !WebDAV.exists?(dest)
+
+
+    WebDAV.cd("https://vortex-dav.uio.no/brukere/thomasfl/")
+    dest = "testfile_copy.html"
+
+    out, err = cp([src,dest])
+    assert WebDAV.exists?(dest)
+  end
+
+
+end