webdavtools 0.0.1 → 0.0.4

data/README.rdoc

@@ -5,21 +5,25 @@
 
 == DESCRIPTION:
 
-WebDAVTools is a Ruby library for creating scripts to administrate content
-and properties on servers that supports the WebDAV protocol. It can be used
-to publish content to CMS systems like Plone and Content repositories like
-Apache JackRabbit, that support the WebDAV protocol.
+WebDAVTools is a WebDAV client written in Ruby for managing
+content on webservers that support the WebDAV extensions.
+
 
 == Requirements
 
-Unix and the command line utility curl installed.
+The command line utility curl installed. Available from
+http://curl.haxx.se/ or on linux:
+
+  sudo apt-get install curl
 
 == LIRBRARY SYNOPSIS:
 
   require 'rubygems'
   require 'webdavtools'
 
-  # Basic recursive tree walking
+  # Print url of all files in webdav folder recursively
+  # with basic tree walking
+
   url = 'http://test.webdav.org/dav/'
   WebDAV.find(url, :recursive => true) do |item|
     puts item.href
@@ -27,31 +31,40 @@ Unix and the command line utility curl installed.
 
 == COMMAND LINE UTILITES:
 
-WebDAVTools includes a small set of command line utilities, that should be familiar to unix users.
-By using commands like wdcd to set current working url, wdls to list files and wdpwd to print
-current working url, users can access files and folders on webdav servers. At the moment
-only authentication by adding usernames and passwords to ~/.netrc file is supported.
+WebDAVTools includes the command line utility 'wdav'. It should be somewhat familiar to unix users.
+By using commands like 'wdav cd url' to set current working url, 'wdav ls' to list files and 'wdav pwd'
+to print current working url, users can access files, folders and their properties on webdav servers.
 
+The only authentication method supported at the method is by reading usernames and passwords from
+a file named ~/.netrc. If username is missing, 'wdav' will print out instructions for what to
+add to the .netrc file.
 
 == COMMAND LINE SYNOPSIS:
 
-  >wdcd http://test.webdav.org/dav/
+  >wdav cd http://test.webdav.org/dav/
   http://test.webdav.org/dav/
-  >wdls
+  >wdav ls
   images/
   index.html
-  >wdpwd
+  >wdav pwd
   http://test.webdav.org/dav/
 
 == INSTALL:
 
-  [sudo] gem sources -a http://gems.github.com
   [sudo] gem install webdavtools
 
 or
 
   git clone git://github.com/thomasfl/webdavtools.git
   cd webdavtools
-  rake install
+  gem build Rakefile
+  sudo gem install webdavtools-x.x.x.gem
+
+== Background:
 
+There has been posted a few examples on the web of how to make a WebDAV client.
+The problem is that they all seem to support only one type of username and password
+authentication. WebDAVTools instead uses the command line tool 'curl' to do all the
+authentication and networking. To avoid handling authentication all togheter, curl
+are told to look up all usernames and passwords are in a file named ~/.netrc.
 

data/bin/wdav

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'webdavtools'
+
+def print_usage
+  puts "usage: wdav COMMAND [ARGS]"
+  puts ""
+  puts "Available wdav commands:"
+  puts "   ls       List files on webdav server"
+  puts "   pwd      Print current working url"
+  puts "   cd       Change current working url"
+  puts "   props    Print webdav properties for url"
+  puts ""
+  puts "See 'wdav COMMAND -h' for more information on a specific command."
+  exit
+end
+
+command =  ARGV[0]
+if(command == "-h" or command =~ /help/ or command =~ /\?/) then
+  print_usage
+end
+
+if(command == "-v" or command =~ /version/ ) then
+  puts "wdav version " + WebDAV.version
+  exit
+end
+
+case command
+  when "ls" then
+    require 'webdavtools/wdav_ls'
+  when "pwd"
+    require 'webdavtools/wdav_pwd'
+  when "cd"
+    require 'webdavtools/wdav_cd'
+  when "props"
+    require 'webdavtools/wdav_props'
+#  when "put"
+#    require 'webdavtools/wdav_put'
+  else
+    puts "Unknown command :'" + command + "'"
+    print_usage
+end

data/lib/webdavtools.rb

@@ -1,88 +1,22 @@
 # -*- coding: utf-8 -*-
-# File: webdavtools.rb  - WebDAV library
 
 require 'rubygems'
 require 'hpricot'
+require 'tempfile'
+require 'webdavtools/hpricot_extensions'
 
 # :stopdoc:
 
 # Path to curl executable:
-$curl = "/usr/local/bin/curl"
-
-# Templates for curl commands:
-curl_propfind_cmd = <<EOF
-#{$curl}
-  --request PROPFIND
-  --header 'Content-Type: text/xml; charset="utf-8"'
-  --header "Depth: 1"
-  --data-ascii '<?xml version="1.0" encoding="utf-8"?>
-      <DAV:propfind xmlns:DAV="DAV:"><DAV:allprop/></DAV:propfind>'
-  --netrc
-  --silent
-EOF
-CURL_PROPFIND = curl_propfind_cmd.gsub("\n","").gsub(/ +/," ")
-
-curl_proppatch_cmd = <<EOF
-#{$curl}
-  --request PROPPATCH
-  --header 'Content-Type: text/xml; charset="utf-8"'
-  --header "Depth: 1"
-  --data-ascii '<?xml version="1.0"?>
-      <d:propertyupdate xmlns:d="DAV:" xmlns:v="vrtx">
-        <d:set>
-          <d:prop>
-            <!--property-and-value-->
-          </d:prop>
-        </d:set>
-      </d:propertyupdate>'
-  --netrc
-  --silent
-EOF
-CURL_PROPPATCH = curl_proppatch_cmd.gsub("\n","").gsub(/ +/," ")
-
-curl_delete_cmd = <<EOF
-#{$curl}
-  --request DELETE
-  --header 'Content-Type: text/xml; charset="utf-8"'
-  --netrc
-  --silent
-EOF
-CURL_DELETE = curl_delete_cmd.gsub("\n","").gsub(/ +/," ") + " "
-
-curl_mkcol_cmd = <<EOF
-#{$curl}
-  --request MKCOL
-  --header 'Content-Type: text/xml; charset="utf-8"'
-  --netrc
-  --silent
-EOF
-CURL_MKCOL = curl_mkcol_cmd.gsub("\n","").gsub(/ +/," ") + " "
-
-# Disse er ikke i bruk lenger.
-# Lag eventuelt et bibliotek som holder orden
-# på vortex typer ut fra http://vortex-dev.uio.no/vrtx/resourcetypes.txt
-EVENT_FOLDER =   '<v:collection-type xmlns:v="vrtx">event-listing</v:collection-type>' +
-                 '<v:resourceType xmlns:v="vrtx">event-listing</v:resourceType>'
-ARTICLE_FOLDER = '<v:collection-type xmlns:v="vrtx">article-listing</v:collection-type>' +
-                 '<v:resourceType xmlns:v="vrtx">article-listing</v:resourceType>'
+$curl = "curl"
+
+require 'webdavtools/curl_commands'
 
 # :startdoc:
 
-# WebDAV utility functions
+# WebDAV client
 module WebDAV
 
-  # Returns current working url. Used by command line utilites
-  def self.CWURL
-    cwurl = ""
-    File.open("/tmp/cwurl", 'r') {|f| cwurl = f.read() }
-    return cwurl
-  end
-
-  # Sets current working url
-  def self.CWURL=(url)
-    File.open("/tmp/cwurl", 'w') {|f| f.write(url) }
-  end
-
   # :stopdoc:
   VERSION = '0.1.0'
   # :startdoc:
@@ -93,6 +27,21 @@ module WebDAV
     VERSION
   end
 
+  # Returns current working url. Used by command line utilites
+  def self.CWURL
+    cwurl = nil
+    filename = cwurl_filename
+    if(File.exists?(filename))
+      File.open(filename, 'r') {|f| cwurl = f.read() }
+    end
+    return cwurl
+  end
+
+  # Sets current working url
+  def self.CWURL=(url)
+    File.open(cwurl_filename, 'w') {|f| f.write(url) }
+  end
+
   # Get content as string
   # Example:
   #    html = WebDAV.get(url)
@@ -262,7 +211,8 @@ module WebDAV
 
   # Low level WebDAV publish
   # Example:
-  #  WebDAV.publish("https://dav.example.org/index.html","<h1>Hello</h1>",nil)
+  #
+  #   WebDAV.publish("https://dav.example.org/index.html","<h1>Hello</h1>",nil)
   def self.publish(url, string, props)
     self.put_string(url, string)
     if(props)then
@@ -271,7 +221,7 @@ module WebDAV
   end
 
 
-  # PUT content
+  # PUT content of string
   # Example:
   #  WebDAV.put("https://dav.webdav.org/file.html", "<html><h1>Test</h1></html>"
   def self.put_string(url, html)
@@ -299,14 +249,19 @@ module WebDAV
     return execute_curl_cmd(curl_put_cmd)
   end
 
-  # TODO  ????
-  def put_html_file(url_folder, filename, html)
-    # Write html
-  end
-
 
   private
 
+  # Returns filename /tmp/cwurl.#pid that holds the current working directory
+  # for the shell's pid
+  def self.cwurl_filename
+    tmp_file = Tempfile.new("dummy").path
+    basename = File.basename(tmp_file)
+    tmp_folder = tmp_file.gsub(basename, "")
+    return tmp_folder +  "cwurl." + Process.ppid.to_s
+  end
+
+  # Display instructions for adding credentials to .netrc file
   def self.display_unauthorized_message(href)
     puts "Error: 401 Unauthorized: " + href
     href.match(/^http.*\/\/([^\/]*)/)
@@ -331,114 +286,3 @@ module WebDAV
   end
 
 end
-
-# TODO Extract to ruby sourcefile
-
-# Add custom functionality to the xml parser (monkey patching):
-module Hpricot
-
-
-  # TODO: url method as alias for href
-
-  class Elem
-
-    def method_missing(method_name, *args)
-      if(args.size == 0) then
-        return property(method_name.to_s)
-      end
-      raise "Method missing"
-    end
-
-    def href()
-      self.at("d:href").innerText
-    end
-
-    def isCollection?()
-      self.at("d:collection") != nil
-    end
-
-  end
-
-  # TODO Not used. Delete???
-  def type_convert_value(value)
-    if(returnValue == "true")then
-      return true
-    end
-    if(returnValue == "false")then
-      return false
-    end
-    # Number format???
-    ## Dato format
-    return returnValue
-  end
-
-  # TODO: Make list of recognized namespace prefixes configurable
-  # Get property.
-  # Example:
-  #    page = WebDAV.find(url)
-  #    print page.property("published-date")
-  def property(name)
-
-    property = property = self.at(name)
-    if(property)then
-      returnValue = property.innerText
-      return returnValue
-    end
-
-    property = property = self.at(name.downcase)
-    if(property)then
-      return property.innerText
-    end
-
-    vrtx_property = self.at("v:" + name)
-    if(vrtx_property)then
-      return vrtx_property.innerText
-    end
-
-    vrtx_property = self.at("v:" + name.downcase)
-    if(vrtx_property)then
-      return vrtx_property.innerText
-    end
-
-    dav_property = self.at("d:" +name)
-    if( dav_property)then
-      return dav_property.innerText
-    end
-
-    dav_property = self.at("d:" +name.downcase)
-    if( dav_property)then
-      return dav_property.innerText
-    end
-
-    return nil
-  end
-
-  def basename
-    File.basename(self.at("d:href").innerText)
-  end
-
-  # TODO: Move to vortex_lib.rb
-  def dateProperty(name)
-    date = self.property(name)
-    if(date =~ /\dZ$/)then
-      # Fix for bug in vortex:
-      #
-      # Some date properties are in xmlshcema datetime format, but
-      # all tough the time seems to be localtime the timezone is
-      # specified as Z not CEST. Fix is to set timezone and add
-      # 2 hours.
-      date = date.gsub(/\dZ$/," CEST")
-      time = Time.parse(date)
-      time = time + (60 * 60 * 2)
-      return time
-    end
-    time = Time.parse(date)
-    return time
-  end
-
-  # Set the items WebDAV properties. Properties must be a string with XML.
-  def proppatch(properties)
-    WebDAV.proppatch(href, properties)
-  end
-
-end

data/lib/webdavtools/curl_commands.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+# Templates for curl commands:
+curl_propfind_cmd = <<EOF
+#{$curl}
+  --request PROPFIND
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --header "Depth: 1"
+  --data-ascii '<?xml version="1.0" encoding="utf-8"?>
+      <DAV:propfind xmlns:DAV="DAV:"><DAV:allprop/></DAV:propfind>'
+  --netrc
+  --silent
+EOF
+CURL_PROPFIND = curl_propfind_cmd.gsub("\n","").gsub(/ +/," ")
+
+curl_proppatch_cmd = <<EOF
+#{$curl}
+  --request PROPPATCH
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --header "Depth: 1"
+  --data-ascii '<?xml version="1.0"?>
+      <d:propertyupdate xmlns:d="DAV:" xmlns:v="vrtx">
+        <d:set>
+          <d:prop>
+            <!--property-and-value-->
+          </d:prop>
+        </d:set>
+      </d:propertyupdate>'
+  --netrc
+  --silent
+EOF
+CURL_PROPPATCH = curl_proppatch_cmd.gsub("\n","").gsub(/ +/," ")
+
+curl_delete_cmd = <<EOF
+#{$curl}
+  --request DELETE
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --netrc
+  --silent
+EOF
+CURL_DELETE = curl_delete_cmd.gsub("\n","").gsub(/ +/," ") + " "
+
+curl_mkcol_cmd = <<EOF
+#{$curl}
+  --request MKCOL
+  --header 'Content-Type: text/xml; charset="utf-8"'
+  --netrc
+  --silent
+EOF
+CURL_MKCOL = curl_mkcol_cmd.gsub("\n","").gsub(/ +/," ") + " "

data/lib/webdavtools/hpricot_extensions.rb

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'hpricot'
+
+# Extensions to hpricot xml parser
+module Hpricot
+
+
+  # TODO: url method as alias for href
+
+  class Elem
+
+    def method_missing(method_name, *args)
+      if(args.size == 0) then
+        return property(method_name.to_s)
+      end
+      raise "Method missing"
+    end
+
+    def href()
+      self.at("d:href").innerText
+    end
+
+    def isCollection?()
+      self.at("d:collection") != nil
+    end
+
+  end
+
+  # TODO Not used. Delete???
+  def type_convert_value(value)
+    if(returnValue == "true")then
+      return true
+    end
+    if(returnValue == "false")then
+      return false
+    end
+    # Number format???
+    ## Dato format
+    return returnValue
+  end
+
+  # TODO: Make list of recognized namespace prefixes configurable
+  # Get property.
+  # Example:
+  #    page = WebDAV.find(url)
+  #    print page.property("published-date")
+  def property(name)
+
+    property = property = self.at(name)
+    if(property)then
+      returnValue = property.innerText
+      return returnValue
+    end
+
+    property = property = self.at(name.downcase)
+    if(property)then
+      return property.innerText
+    end
+
+    vrtx_property = self.at("v:" + name)
+    if(vrtx_property)then
+      return vrtx_property.innerText
+    end
+
+    vrtx_property = self.at("v:" + name.downcase)
+    if(vrtx_property)then
+      return vrtx_property.innerText
+    end
+
+    dav_property = self.at("d:" +name)
+    if( dav_property)then
+      return dav_property.innerText
+    end
+
+    dav_property = self.at("d:" +name.downcase)
+    if( dav_property)then
+      return dav_property.innerText
+    end
+
+    return nil
+  end
+
+  def basename
+    File.basename(self.at("d:href").innerText)
+  end
+
+  # TODO: Move to vortex_lib.rb
+  def dateProperty(name)
+    date = self.property(name)
+    if(date =~ /\dZ$/)then
+      # Fix for bug in vortex:
+      #
+      # Some date properties are in xmlshcema datetime format, but
+      # all tough the time seems to be localtime the timezone is
+      # specified as Z not CEST. Fix is to set timezone and add
+      # 2 hours.
+      date = date.gsub(/\dZ$/," CEST")
+      time = Time.parse(date)
+      time = time + (60 * 60 * 2)
+      return time
+    end
+    time = Time.parse(date)
+    return time
+  end
+
+  # Set the items WebDAV properties. Properties must be a string with XML.
+  def proppatch(properties)
+    WebDAV.proppatch(href, properties)
+  end
+
+end

data/{bin/wdcd → lib/webdavtools/wdav_cd.rb}

@@ -1,8 +1,8 @@
-#!/usr/bin/env ruby
+# Handle 'wdav cd URL' commands
 require 'rubygems'
 require 'webdavtools'
 
-url = ARGV[0]
+url = ARGV[1]
 if(url =~ /^http/)then
   resource = WebDAV.propfind(url)
   if(resource and resource.isCollection?)then
@@ -24,20 +24,4 @@ elsif(url)then
   puts "DEBUG: type:" + type.to_s
 end
 
-
-exit
-
-if(not url)then
-  url = WebDAV.CWURL
-  if(not url)then
-    puts "wdls: no current working url"
-    puts "Usage: Use 'wdopen url' or 'wdcd [url|dir] to set current working url "
-    exit
-  end
-end
-
-WebDAV.find(url, :recursive => false ) do |item|
-  puts item.href
-end
-
-# TODO only works on collections, should give som info about resources too.
+# TODO Should take a folder name as parameter as well

data/{bin/wdls → lib/webdavtools/wdav_ls.rb}

@@ -1,12 +1,11 @@
-#!/usr/bin/env ruby
+# Handle command 'wdav ls [url]'
 require 'rubygems'
 require 'webdavtools'
 require 'optparse'
-
 options = {}
 
 optparse = OptionParser.new do|opts|
-  opts.banner = "Usage: #{$0} [options] url"
+  opts.banner = "Usage: #{$0} ls [options] url"
 
   opts.on( '-h', '--help', 'Display this screen' ) do
     puts opts
@@ -34,12 +33,12 @@ rescue
 end
 
 
-url = ARGV[0]
+url = ARGV[1]
 if(not url)then
   url = WebDAV.CWURL
   if(not url)then
-    puts "wdls: no current working url"
-    puts "Usage: Use 'wdopen url' or 'wdcd [url|dir] to set current working url "
+    puts "wdav ls: no current working url"
+    puts "Usage: Use 'wdav open url' or 'wdav cd [url|dir] to set current working url"
     exit
   end
 end

data/{bin/wdprops → lib/webdavtools/wdav_props.rb}

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# Handle 'wdav props [URL]' command
 require 'rubygems'
 require 'webdavtools'
 require 'optparse'
@@ -34,8 +34,9 @@ rescue
   exit
 end
 
-url = ARGV[0]
+url = ARGV[1]
 if(not(url)) then
+  # TODO: Use CWURL if not set
   puts "Error: Missing mandatory url"
   puts optparse
   exit

data/lib/webdavtools/wdav_pwd.rb

@@ -0,0 +1,10 @@
+# Handle command 'wdav pwd'
+require 'rubygems'
+require 'webdavtools'
+
+url = WebDAV.CWURL
+if(url)then
+  puts url
+else
+  puts "wdav pwd: no current working url set. Use 'wdav cd url' to set url."
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webdavtools
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors: 
 - Thomas Flemming
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-05 00:00:00 +02:00
+date: 2009-08-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,25 +22,23 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0.6"
     version: 
-description: "WebDAVTools is a Ruby Library and a set of command line utilities for accessing files and folders on WebDAV servers. "
+description: WebDAVTools is a WebDAV client written in Ruby for managing content on webservers that support the WebDAV extensions.
 email: thomas.flemming@gmail.com
 executables: 
-- wdcd
-- wdls
-- wdprops
-- wdput
-- wdpwd
+- wdav
 extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
 files: 
 - lib/webdavtools.rb
-- bin/wdcd
-- bin/wdls
-- bin/wdprops
-- bin/wdput
-- bin/wdpwd
+- lib/webdavtools/hpricot_extensions.rb
+- lib/webdavtools/curl_commands.rb
+- bin/wdav
+- lib/webdavtools/wdav_ls.rb
+- lib/webdavtools/wdav_pwd.rb
+- lib/webdavtools/wdav_cd.rb
+- lib/webdavtools/wdav_props.rb
 - README.rdoc
 has_rdoc: true
 homepage: http://folk.uio.no/thomasfl

data/bin/wdput

@@ -1,3 +0,0 @@
-#!/bin/env ruby
-require 'webdavtools'
-

data/bin/wdpwd

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-require 'rubygems'
-require 'webdavtools'
-
-url = WebDAV.CWURL
-if(url)then
-  puts url
-else
-  puts "wdpwd: no current working url set. Use 'wdcd url' to set url."
-end