net_dav 0.0.2 → 0.1.0

data/README.rdoc

@@ -4,8 +4,19 @@ Net::Dav library, in the style of Net::HTTP
 
 Installing the gem:
 
-  sudo gem install net_dav
+  gem install net_dav
 
 If you're having install issues with nokogiri on Mac OS X read
 http://wiki.github.com/tenderlove/nokogiri/what-to-do-if-libxml2-is-being-a-jerk
 
+== Usage
+
+  Net::DAV.start("https://localhost.localdomain/xyz/") { |dav|
+    find('.', :recursive => true) do | item |
+       item.content = item.content.gsub(/silly/i, "funny")
+    end
+  end
+
+  (Note that if you want to use "." to refer to the origin URL, it should
+  end with a slash, otherwise it is assumed that the last component is a file
+  and "." will refer to the parent.)

data/Rakefile

@@ -36,7 +36,7 @@ task :spec => :check_dependencies
 
 task :default => :spec
 
-task :release => [:clean, :gemspec, 'gemcutter:release']
+task :dist => [:clean, :release]
 
 task :clean do
   Dir.glob("**/*~").each do |file|

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/bin/dav

@@ -8,6 +8,23 @@ dav_user = ENV['DAVUSER']
 dav_pass = ENV['DAVPASS']
 cmd = $*[0]
 
+def print_usage
+  puts "usage: #{$0} COMMAND [ARGS]"
+  puts ""
+  puts "Available commands:"
+  puts "    ls         List file or directory at URL"
+  puts "    lsr        List file or directory recursively at URL"
+  puts "    get        Get file from URL to stdout or to FILE"
+  puts "    put        Put file from FILE to URL"
+  puts "    mkdir      Create directory at URL"
+  puts "    gsub       Replace content at URL from REGEXP to VALUE"
+  exit
+end
+
+if $*.size < 2
+  print_usage
+end
+
 case cmd
 when 'put'
   url = URI.parse $*[2]
@@ -40,15 +57,23 @@ res = Net::DAV.start(url) { |dav|
     end
   when 'lsr'
     dav.find(url.path, :recursive => true) do |item|
-      puts "#{item[:size]}\t#{item[:uri]}"
+      puts "#{item.size}\t#{item.uri}"
     end
   when 'ls'
     dav.find(url.path) do |item|
-      puts "#{item[:size]}\t#{item[:uri]}"
+      puts "#{item.size}\t#{item.uri}"
     end
   when 'mkdir'
     dav.mkdir(url.path)
+  when 'gsub'
+    re = Regexp.compile($*[2])
+    val = $*[3]
+    dav.find(url.path) do |item|
+      if (item.type == :file)
+	item.content = item.content.gsub(re, val)
+      end
+    end
   else
-    puts "unknown command"
+    print_usage
   end
 }

data/lib/net/dav/item.rb

@@ -0,0 +1,47 @@
+module Net
+  class DAV
+    # Hold items found using Net::DAV#find
+    class Item
+      # URI of item
+      attr_reader :uri
+
+      # Size of item if a file
+      attr_reader :size
+
+      # Type of item - :directory or :file
+      attr_reader :type
+
+      # Synonym for uri
+      def url
+	@uri
+      end
+
+      def initialize(dav, uri, type, size) #:nodoc:
+	@uri = uri
+	@size = size
+	@type = type
+	@dav = dav
+      end
+
+      # Get content from server if needed and return as string
+      def content
+	return @content unless @content.nil?
+	@content = @dav.get(@uri.path)
+      end
+
+      # Put content to server
+      def content=(str)
+	@dav.put_string(@uri.path, str)
+	@content = str
+      end
+
+      def to_s #:nodoc:
+	"#<Net::DAV::Item URL:#{@uri.to_s} type:#{@type}>"
+      end
+
+      def inspect #:nodoc:
+	"#<Net::DAV::Item URL:#{@uri.to_s} type:#{@type}>"
+      end
+    end
+  end
+end

data/lib/net/dav.rb

@@ -1,8 +1,10 @@
 require 'net/https'
 require 'uri'
 require 'nokogiri'
+require 'net/dav/item'
 
 module Net #:nodoc:
+  # Implement a WebDAV client
   class DAV
     # Seconds to wait until reading one block (by one system call).
     # If the DAV object cannot read a block in this many seconds,
@@ -35,7 +37,7 @@ module Net #:nodoc:
     #
     #  res = Net::DAV.start(url) do |dav|
     #    dav.find(url.path) do |item|
-    #      puts item.inspect
+    #      puts "#{item.uri} is size #{item.size}"
     #    end
     #  end
     def self.start(uri, &block) # :yield: dav
@@ -52,6 +54,7 @@ module Net #:nodoc:
       when "http"
 	@http = Net::HTTP.new(@uri.host, @uri.port)
       when "https"
+	@http = Net::HTTPS.new(@uri.host, @uri.port)
       else
 	raise "unknown uri scheme"
       end
@@ -91,13 +94,14 @@ module Net #:nodoc:
       Nokogiri::XML.parse(res.body)
     end
 
-    # Find files and directories
+    # Find files and directories, yields Net::DAV::Item
     #
     # Examples:
     #
     #  res = Net::DAV.start(url) do |dav|
     #    dav.find(url.path, :recursive => true) do |item|
-    #      puts item.inspect
+    #      puts "#{item.type} #{item.uri}"
+    #      puts item.content
     #    end
     #  end
     def find(path, options = {})
@@ -106,16 +110,21 @@ module Net #:nodoc:
       path.sub!(/\/$/, '')
       doc./('.//x:response', namespaces).each do |item|
 	uri = @uri.merge(item.xpath("x:href", namespaces).inner_text)
-	next if uri.path == path || uri.path == path + "/"
-	res = {}
-	res[:uri] = uri
-	res[:size] = item.%(".//x:getcontentlength", namespaces).inner_text rescue nil
-	res[:type] = item.%(".//x:collection", namespaces) ? :directory : :file
-	yield res
-	if options[:recursive] && res[:type] == :directory
+	size = item.%(".//x:getcontentlength", namespaces).inner_text rescue nil
+	type = item.%(".//x:collection", namespaces) ? :directory : :file
+	res = Item.new(self, uri, type, size)
+	if type == :file
+	  yield res
+	elsif uri.path == path || uri.path == path + "/"
+	  # This is the top-level dir, skip it
+	elsif options[:recursive] && type == :directory
+	  yield res
+	  # This is a subdir, recurse
 	  find(uri.path, options) do |sub_res|
 	    yield sub_res
 	  end
+	else
+	  yield res
 	end
       end
     end
@@ -170,6 +179,25 @@ module Net #:nodoc:
       res.body
     end
 
+    # Stores the content of a string to a URL
+    #
+    # Example:
+    #   dav.put(url.path, "hello world")
+    #
+    def put_string(path, str)
+      req = Net::HTTP::Put.new(path)
+      req.content_type = 'text/xml; charset="utf-8"'
+      req.body = str
+      #req['transfer-encoding'] = 'chunked'
+      if (@user)
+	req.basic_auth @user, @pass
+      end
+      res = @http.request(req)
+      res.value
+      res.body
+    end
+
+
     # Makes a new directory (collection)
     def mkdir(path)
       req = Net::HTTP::Mkcol.new(path)

data/net_dav.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{net_dav}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Miron Cuperman"]
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "bin/dav",
      "lib/net/dav.rb",
+     "lib/net/dav/item.rb",
      "net_dav.gemspec",
      "spec/net_dav_spec.rb",
      "spec/spec.opts",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: net_dav
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Miron Cuperman
@@ -50,6 +50,7 @@ files:
 - VERSION
 - bin/dav
 - lib/net/dav.rb
+- lib/net/dav/item.rb
 - net_dav.gemspec
 - spec/net_dav_spec.rb
 - spec/spec.opts