OpenUriAndWrite is an easy to use gem to makes writing files to WebDAV enabled webservers as easy as writing to local files. The gem prompts for username and password when needed. On OSX passwords can be stored encrypted in the keychain. This is a wrapper for the Net::Dav gem.
Creating files on webserver is straight forward.
require 'rubygems'
require 'open-uri-and-write'
open("http://www.ruby-lang.org/open_uri_and_write.html","w") {|f|
f.puts "<h1>OpenUriAndWrite</h1>"
}Delete file on server:
File.delete("http://www.ruby-lang.org/open_uri_and_write.html")Create directory on server:
Dir.mkdir("http://www.ruby-lang.org/open_uri_and_write") $ gem install open-uri-and-write
OSX users that wishes to store passwords on the keychain need to install this in addition:
$ gem install keychain_services
By default the scripts prompts for username and password. The username and hostname are stored in the file ~/.open-uri-and-write-usernames, so the next time only the password has to be typed in. On OSX the password is stored encrypted in the keychain.
Default behaviour if no username or password is set:
$ ruby webdav_test.rb
Username for www.example.com: scott
Password for '[email protected]: *****
Username and hostname stored in /Users/thomasf/.open-uri-and-write-usernames
$ ruby webdav_test.rb
Password for '[email protected]: *****
Credentials can also supplied as environment variables or options.
Supplying credentials with the DAVUSER and DAVPASS environment variables:
$ export DAVUSER=scott
$ export DAVPASS=tiger
$ ruby webdav_test.rb
Setting username and password in ruby:
ENV['DAVUSER'] = 'scott'
ENV['DAVPASS'] = 'tiger'Another option is to supply username and password as arguments to open:
file = open('https://www.example.com/', 'w', :username => 'scott', :password => 'tiger')On OS X passwords typed in by the user will be stored encrypted in the Keychain and reused later.
$ export DAVUSER=scott
$ ruby webdav_test.rb
Password for '[email protected]': *****
Password for '[email protected]' stored on OS X KeyChain.
The next time this script is executed, it will not prompt for username and password.
Note that if you have stored a misspelled password on the OSX Keychain, then you will have to delete it manually with Keychain Access application.
In difference to files and directories on local filesystems, files and directories on WebDAV servers can have as many custom properties as you want. Properties are set with File.propfind() and set with File.proppatch().
file = File.open('http://www.ruby-lang.org/open_uri_and_write.html','w')
file.proppatch('<D:Author>Thomas Flemming</D:Author>')
properties_as_xml = Dir.propfind("http://www.ruby-lang.org")If no filemode is specified when using open on url, the 'open-uri' gem will be used to read.
puts open("http://www.ruby-lang.org").read() # Use 'open-uri'
open('http://www.ruby-lang.org/my_page.html','w').puts("<h1>HTML</h1>") # Use 'open-uri-and-write'To not interfer with the 'open-uri' standard library, the 'open-uri-and-write' gem is only active in file modes 'w','a','w+','a+' and 'r+'.
-
r Read-only mode. The file pointer is placed at the beginning of the file. This is the default mode.
-
w Write-only mode. Overwrites the file if the file exists. If the file does not exist, creates a new file for writing.
-
a Write-only mode. The file pointer is at the end of the file if the file exists. That is, the file is in the append mode. If the file does not exist, it creates a new file for writing.
-
r+ Read-write mode. The file pointer will be at the beginning of the file.
-
w+ Read-write mode. Overwrites the existing file if the file exists. If the file does not exist, creates a new file for reading and writing.
-
a+ Read and write mode. The file pointer is at the end of the file if the file exists. The file opens in the append mode. If the file does not exist, it creates a new file for reading and writing.
To run all tests:
$ rake spec
The tests will start a webserver with webdav at startup, and close it down before finishing.
This is work in progress. You can write files and crate directories, but there's still work to do on reading directories and at the time only filemodes "r", "w" and "a" is supported.
More protocols like FTP, SCP and Amazon S3 would be useful.
Misspelled password stored on the OSX Keychain, have to be deleted manually with the Keychain Access application.
- Tanaka Akira for the inspirational 'open-uri' standard ruby library.
- Miron Cuperman for the work done on 'net/dav' gem used to access webdav servers.
- Chris Roberts and the rest of the DAV4Rack for the WebDAV implementation in ruby used for testing this gem.
OpenUriAndWrite is distributed under the Apache License, Version 2.0.
Thomas Flemming