vortex_client 0.7.0 → 0.7.2

data/README.rdoc

@@ -1,7 +1,8 @@
 = Vortex Client
 
-A set of utilities for managing content in the web content management system "Vortex":http://www.usit.uio.no/it/vortex/.
-All operations are done by using the webdav protocol.
+A Ruby API for the "Vortex":http://www.usit.uio.no/it/vortex/ Content Management System developed at the
+University of Oslo in Norway by IT Services department.
+The Ruby API uses the WebDAV protocol, supported by Vortex, to manage content.
 
 
 = Publishing content
@@ -50,11 +51,11 @@ If your'e having problems installing the xml parser nokogiri on is x:  http://wi
 Also how to compile ruby 1.9.1 on os x http://wonko.com/post/how-to-compile-ruby-191
 On ubuntu openssl can be an issue http://blog.maxaller.name/2009/02/ruby-19-and-openssl-on-ubuntu/
 
-= Using KeyChain authentication on OS X
+= Storing passwords in KeyChain on OS X
 
-To retrieve password from KeyChain on OS X, use the option :use_osx_keychain => true.
+To retrieve password from KeyChain on OS X, use the option :osx_keychain => true.
 
-   vortex = Vortex::Connection.new("https://www-dav.server.com", :use_osx_keychain => true)
+   vortex = Vortex::Connection.new("https://www-dav.server.com", :osx_keychain => true)
 
 When running for the first time, ruby prompts for the password. Username must be
 the same both locally and on the server.

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.2

data/examples/create_personpresentations.rb

@@ -131,7 +131,7 @@ end
 
 # src_url = 'https://nyweb3-dav.uio.no/konv/ubo/'
 src_url = 'https://nyweb1-dav.uio.no/personer/genererte-presentasjoner/econ/'
-@vortex = Vortex::Connection.new(src_url, :use_osx_keychain => true)
+@vortex = Vortex::Connection.new(src_url, :osx_keychain => true)
 
 # puts "Restore from backup..."
 # delete(src_url)

data/examples/disable_right_column.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'vortex_client'
 
-vortex = Vortex::Connection.new('https://nyweb2-dav.uio.no/', :use_osx_keychain => true)
+vortex = Vortex::Connection.new('https://nyweb2-dav.uio.no/', :osx_keychain => true)
 # url = 'https://nyweb2-dav.uio.no/for-ansatte/aktuelt/hf-aktuelt-mod/utg2/index.html'
 url = '/for-ansatte/aktuelt/hf-aktuelt-mod/utg2/index.html'
 snippet = '<hideAdditionalContent xmlns="http://www.uio.no/vrtx/__vrtx/ns/structured-resources">true</hideAdditionalContent>'

data/examples/download_and_upload_pdf.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'vortex_client'
+require 'open-uri'
+require 'uri'
+require 'pathname'
+
+# Download and upload a binary file to Vortex
+
+url = 'http://www.hlsenteret.no/248/267/Bakgrunn_Rwanda.pdf'
+content = open(url).read
+
+filename = Pathname.new( URI.parse(url).path ).basename.to_s
+
+vortex = Vortex::Connection.new("https://vortex-dav.uio.no/")
+vortex.cd('/brukere/thomasfl/')
+vortex.put_string(filename, content)

data/examples/import_static_site.rb

@@ -12,7 +12,7 @@ class MigrateSuicidologi
   attr :vortex, :uri
 
   def initialize(url)
-    @vortex = Vortex::Connection.new(url,:use_osx_keychain => true)
+    @vortex = Vortex::Connection.new(url,:osx_keychain => true)
     @uri = URI.parse(url)
   end
 

data/examples/make_links_relative.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'nokogiri'
+require 'vortex_client'
+require 'pathname'
+require 'json'
+
+def make_links_relative(dav_url)
+  vortex = Vortex::Connection.new(dav_url, :osx_keychain => true)
+  vortex.cd(URI.parse(dav_url).path.to_s)
+  count = 0
+  vortex.find('.', :recursive => true, :filename=>/\.html$/) do |item|
+    count = count + 1
+    puts "Checking    : " + count.to_s + ": " + item.url.to_s
+
+    json_data = JSON.parse(item.content)
+    content = json_data["properties"]["content"]
+    dirty = false
+    doc = Nokogiri::HTML(content)
+    doc.css('a').each do |element|
+      href = element['href']
+      if(href and href[/^\//])then
+        pathname_from = Pathname.new( URI.parse(item.url.to_s).path.to_s )
+        pathname_to   = Pathname.new( URI.parse(href.to_s).path.to_s )
+        new_href = pathname_to.relative_path_from(pathname_from.parent).to_s
+        element['href'] = new_href
+        puts "              " + href + " => " + new_href
+        dirty = true
+      end
+    end
+    if(dirty)then
+      json_data["properties"]["content"] = doc.to_s
+      item.content = json_data.to_json
+      puts "Updating    : " + item.url.to_s
+      puts
+    end
+  end
+
+end
+
+url = ARGV[0]
+if(not(url))then
+  puts "Usage: make_links_relative URL"
+  puts
+  puts "Example: make_links_relative https://www-dav.vortex-demo.uio.no/tmp/relativiser/ "
+  puts "Looks for links in vortex documents stored as json. Takes a vortex webdav url as"
+  puts "parameter. Searches recursively through subfolders."
+else
+  make_links_relative(url)
+end

data/examples/propfind_proppatch.rb

@@ -1,7 +1,8 @@
 require 'rubygems'
 require 'vortex_client'
 
-vortex = Vortex::Connection.new("https://www-dav.vortex-demo.uio.no/", :use_osx_keychain => true)
+vortex = Vortex::Connection.new("https://www-dav.vortex-demo.uio.no/", :osx_keychain => true)
 props = vortex.propfind('/index.html')
+puts props
 
 vortex.proppatch('/index.html','<v:title xmlns:v="vrtx">Forside vortex demo</v:title>')

data/examples/publish_json.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'vortex_client'
+require 'json'
+
+vortex = Vortex::Connection.new("https://vortex-dav.uio.no/", :osx_keychain => true)
+
+data = {
+  :resourcetype => "structured-article",
+  :properties => {
+    :title => "Hello world",
+    :introduction => "Short introduction",
+    :content => "<p>Longer body</p>",
+    :author => "Thomas Flemming"}
+}
+
+uri = URI.parse('/brukere/thomasfl/nyheter/json_test.html')
+vortex.put_string(uri,data.to_json)
+
+vortex.proppatch(uri, '<v:publish-date xmlns:v="vrtx">' + Time.now.httpdate.to_s + '</v:publish-date>')
+

data/examples/scrape_holocaust.rb

@@ -26,7 +26,7 @@ require 'pp'
 # - Hvorfor konverteres og publiseres /konv/kunnskapsbasen/-a-hrefhttp-.html
 # - Håndtere /konv/kunnskapsbasen/hl-senterets-kunnskapsbase.html spesielt?
 
-@vortex = Vortex::Connection.new("https://nyweb4-dav.uio.no", :use_osx_keychain => true)
+@vortex = Vortex::Connection.new("https://nyweb4-dav.uio.no", :osx_keychain => true)
 
 # Simple logger
 def log(str)
@@ -252,7 +252,6 @@ EOF
 end
 
 def scrape_article(url)
-  # puts "Scraping article: " + url
   doc = Nokogiri::HTML.parse(open(url))
   doc.encoding = 'utf-8'
   if(doc.css(".article .title").size() == 0)then

data/examples/unpublish.rb

@@ -5,7 +5,7 @@ require 'vortex_client'
 #
 # Find all files recursively under '/people' with name 'index.html', and set "unpublished-date" to now.
 
-@vortex = Vortex::Connection.new("https://nyweb2-dav.uio.no/", :use_osx_keychain => true)
+@vortex = Vortex::Connection.new("https://nyweb2-dav.uio.no/", :osx_keychain => true)
 @vortex.find('/people/', :recursive => true, :filename=>/\.html$/) do |item|
   item.proppatch('<v:unpublish-date xmlns:v="vrtx">'+Time.now.httpdate.to_s+'</v:unpublish-date>')
 end

data/lib/vortex_client.rb

@@ -2,6 +2,7 @@
 require 'net/dav'
 require 'vortex_client/string_utils'
 require 'vortex_client/person'
+require 'vortex_client/utilities'
 require 'highline/import'
 require 'time'
 
@@ -165,6 +166,46 @@ module Vortex
       end
     end
 
+    # Create path - create all folders in the given path if they do not exist.
+    #
+    # Default is article-listing folder and the foldername used as title.
+    #
+    # Example:
+    #
+    #   create_path('/folders/to/be/created/')
+    #   create_path('/folders/to/be/created/', :type => "event-listing", :title => "Testing")
+    def create_path(dest_path, *args)
+      title = nil
+      if(args.size > 0)then
+        type = args[0][:type]
+        title = args[0][:title]
+      end
+      if(not(type))then
+        type = "article-listing"
+      end
+
+      destination_path = "/"
+      dest_path.split("/").each do |folder|
+        if(folder != "")then
+          folder = folder.downcase
+          destination_path = destination_path + folder + "/"
+          if( not(exists?(destination_path)) )then
+            mkdir(destination_path)
+            proppatch(destination_path,'<v:collection-type xmlns:v="vrtx">' + type + '</v:collection-type>')
+            if(title)then
+              proppatch(destination_path,'<v:userTitle xmlns:v="vrtx">' + title.to_s +  '</v:userTitle>')
+            end
+          end
+        end
+      end
+      return destination_path
+    end
+
+    # Returns current working directory on vortex/webdav server as string.
+    def cwd
+      return cd("").to_s
+    end
+
     private
 
     # Disable Net::DAV.credentials

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vortex_client
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Thomas Flemming
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-30 00:00:00 +02:00
+date: 2011-07-12 00:00:00 +02:00
 default_executable: vrtx-sync
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,13 +86,16 @@ files:
 - examples/create_personpresentations.rb
 - examples/dice.gif
 - examples/disable_right_column.rb
+- examples/download_and_upload_pdf.rb
 - examples/import_static_site.rb
 - examples/ldap_util.rb
+- examples/make_links_relative.rb
 - examples/no_right_margin.rb
 - examples/person_presentation.rb
 - examples/propfind_proppatch.rb
 - examples/publish_article.rb
 - examples/publish_event.rb
+- examples/publish_json.rb
 - examples/scrape_hero_publications.rb
 - examples/scrape_holocaust.rb
 - examples/scrape_holocaust_related_links.rb
@@ -117,10 +120,6 @@ files:
 - test/test_vortex_pic.rb
 - test/test_vortex_tags.rb
 - test/test_vortex_utils.rb
-- examples/replace_spike.rb
-- examples/search_replace_documents_frontpage.rb
-- examples/test_searc_replace.rb
-- examples/upload_image_flymake.rb
 has_rdoc: true
 homepage: http://github.com/thomasfl/vortex_client
 licenses: []
@@ -160,25 +159,24 @@ test_files:
 - examples/create_collection.rb
 - examples/create_personpresentations.rb
 - examples/disable_right_column.rb
+- examples/download_and_upload_pdf.rb
 - examples/import_static_site.rb
 - examples/ldap_util.rb
+- examples/make_links_relative.rb
 - examples/no_right_margin.rb
 - examples/person_presentation.rb
 - examples/propfind_proppatch.rb
 - examples/publish_article.rb
 - examples/publish_event.rb
-- examples/replace_spike.rb
+- examples/publish_json.rb
 - examples/scrape_hero_publications.rb
 - examples/scrape_holocaust.rb
 - examples/scrape_holocaust_related_links.rb
 - examples/scrape_vortex_search.rb
 - examples/search_replace_documents.rb
-- examples/search_replace_documents_frontpage.rb
 - examples/sitemap.rb
-- examples/test_searc_replace.rb
 - examples/unpublish.rb
 - examples/upload_image.rb
-- examples/upload_image_flymake.rb
 - test/helper.rb
 - test/test_acl.rb
 - test/test_date_conversion.rb

data/examples/replace_spike.rb

@@ -1,42 +0,0 @@
-require 'rubygems'
-require 'vortex_client'
-require 'json'
-require 'scrape_vortex_search'
-require 'pp'
-require 'uri'
-
-# Replace text in json document on server
-# Optional resourcetype can
-def replace(host, path, from, to, *resourcetype)
-  verbose = false
-  host = host.sub(/\/$/,'')
-  uri = URI.parse(path)
-  url = host + uri.path
-  url = url.sub(/\/$/,'/index.html')
-
-  vortex = Vortex::Connection.new(host,:use_osx_keychain => true)
-  vortex.find(url) do |item|
-
-    data = nil
-    begin
-      data = JSON.parse(item.content)
-    rescue
-      if(verbose)then
-        puts "Warning. Bad document. Not json: " + item.uri.to_s
-      end
-      return 0
-    end
-
-    if(resourcetype[0] and resourcetype[0].class == String and data["resourcetype"] != resourcetype[0] )then
-      if(verbose)then
-        puts "Warning: resourcetype not: " + resourcetype[0]
-      end
-      return 0
-    end
-
-    puts "Oppdaterer: " + item.uri.to_s
-    new_content = item.content.sub(from,to)
-    item.content = new_content
-    return 1
-  end
-end

data/examples/search_replace_documents_frontpage.rb

@@ -1,88 +0,0 @@
-# -*- coding: utf-8 -*-
-# Search and replace a set of sentences in a set of folders on vortex webdav server.
-#
-#
-# for alle forside-dokumenter på jus.uio.no, tf.uio.no, hf.uio.no, uv.uio.no, sv.uio.no, odontologi.uio.no
-#
-#
-# Author: Thomas Flemming 2010 thomasfl@usit.uio.no
-
-require 'rubygems'
-require 'vortex_client'
-require 'json'
-require 'scrape_vortex_search'
-require 'pp'
-require 'uri'
-
-replacements = {
-   "Ansettelsesforhold ved UiO" => "Ansettelsesforhold for alle ansatte ved UiO",
-   "Arbeidsstøtte ved UiO" => "Arbeidsstøtte for alle ansatte ved UiO",
-   "Drift og servicefunksjoner ved UiO" =>"Drift og servicefunksjoner for alle ansatte ved UiO",
-   "Kompetanseutvikling ved UiO" => "Kompetanseutvikling for alle ansatte ved UiO"
-}
-
-hosts = [
-  "https://www-dav.hf.uio.no/",
-  "https://www-dav.odont.uio.no",
-  "https://www-dav.jus.uio.no/",
-  "https://www-dav.tf.uio.no/",
-  "https://www-dav.uv.uio.no/",
-  "https://www-dav.sv.uio.no/"
-]
-
-# Opens a json document in vortex.
-#
-# Example:
-#
-#     with_json_doc(path) do |dav_item, json_data|
-#        puts json_data["resourcetype"]
-#        dav_item.content = dav_item.content.sub('Oxford','UiO')
-#     end
-
-def with_json_doc(url)
-  vortex = Vortex::Connection.new(url,:use_osx_keychain => true)
-  if(not(vortex.exists?(url)))then
-    puts "Warning: Can't find " + url
-    return -1
-  end
-  vortex.find(url) do |item|
-    begin
-      data = JSON.parse(item.content)
-      yield item, data
-    rescue
-      return -1
-    end
-  end
-end
-
-hosts.each do |host|
-  search_host = host.sub("www-dav","www")
-  replacements.each do |from, to|
-    puts "Replacing: '#{from}' => '#{to}'"
-    search_results = vortex_search(search_host, from)
-    # TODO remove not( /(\.html)|\// alt untatt '.../' eller 'html'
-    search_results.delete_if {|x| x =~ /\.pdf$/} # Remove pdf files
-    count = 0
-    search_results.each do |path|
-      if(not(path =~ /\.html$/))then
-        path = path + "index.html"
-      end
-      # count = count + replace(host, path, from, to, "frontpage")
-      path = path.sub(/^http:/, 'https:').sub(/\/\/www\./,'//www-dav.')
-      with_json_doc(path) do |item, data|
-        if(data["resourcetype"] == "frontpage")then
-          puts "Updating:" + path
-          item.content = item.content.sub(from,to)
-
-          if(item.content.to_s =~ Regexp.new(from))then
-            puts "Warning: Not updated."
-          else
-            count = count + 1
-          end
-        end
-      end
-    end
-    puts "Updated #{count.to_s} documents."
-    puts
-  end
-end

data/examples/test_searc_replace.rb

@@ -1,3 +0,0 @@
-require 'rubygems'
-
-puts 'Start'

data/examples/upload_image_flymake.rb

@@ -1,8 +0,0 @@
-require 'rubygems'
-require 'vortex_client'
-
-# Upload a binary file to Vortex
-vortex = Vortex::Connection.new("https://vortex-dav.uio.no/")
-vortex.cd('/brukere/thomasfl/')
-content = open("dice.gif", "rb") {|io| io.read }
-vortex.put_string("dice_6.gif", content)