vrtx 0.0.2

data/README.rdoc

@@ -0,0 +1,62 @@
+= Vrtx
+
+== DESCRIPTION:
+
+Command line utility for managing content in the open source content management system Vortex.
+
+Vortex is fully manageable via the WebDAV server extensions. The
+vrtx command line utility is a subproject of the general WebDAV client
+davclient.rubyforge.org.
+
+== Requirements
+
+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 'vrtx'
+
+  url = 'http://test.webdav.org/dav/'
+  Vortex.cd(url)
+  Vortex.publish("Title", "Introducion")
+
+
+== COMMAND LINE UTILITES:
+
+Vortex inlcudes the command line utility 'vrtx'. Use 'vrx cd url' to set current working url
+and 'vrtx ls' to list content of a collection (directory).
+
+== COMMAND LINE SYNOPSIS:
+
+  >vrtx cd http://test.webdav.org/dav/
+  http://test.webdav.org/dav/
+  >vrtx ls
+  images/
+  index.html
+  >vrtx pwd
+  http://test.webdav.org/dav/
+  >vrtx publish --title "Title" --introduction "Intro"
+  Published "Title" to: http://test.webdav.org/dav/title.html
+
+== INSTALL:
+
+  [sudo] gem install vrxt
+
+or
+
+  git clone git://github.com/thomasfl/vrtx.git
+  cd vrtx
+  gem build Rakefile
+  sudo gem install vrxt-x.x.x.gem
+
+== Background:
+
+The library is suitable for creating scripts that update content on webservers
+with the CMS Vortex and WebDAV http extions installed.
+
+See also "DavClient":http://github.com/thomasfl/davclient/tree/master
+

data/bin/vrtx

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'davclient'
+require 'davclient/davcli'
+require 'vrtx'
+
+args = VrtxCLI.substitute_urls(ARGV
+DavCLI.dav(args)

data/lib/vrtx/article.rb

@@ -0,0 +1,206 @@
+# -*- coding: utf-8 -*-
+
+class Article
+
+  attr_accessor :url, :hpricotItem, :content
+  attr_reader :vortexResourceType
+
+  def initialize(*args)
+    @url = args[0]
+
+    if(@url =~ /:\/\/[^\/]*dav\./)then
+      item = WebDAV.propfind(url)
+      @vortexResourceType = item.property("v:resourceType")
+      if(vortexResourceType)then
+
+        if(@vortexResourceType == "article")then
+          # do nothing. no conversion necessary
+          @hpricotElem = item
+          @content = WebDAV.get(@url)
+        end
+
+        if(@vortexResourceType == "nyhet")then
+          puts "TODO: Manipulate xml of propierties so it becomes an article instead"
+          @hpricotElem = item
+          @hpricotElem.search("v:resourceType").remove
+
+          puts "class" + @hpricotElem.class.to_s
+
+          element = @hpricotElem.search("d:displayname")
+          element.after "<v:resourceType xmlns:v=\"vrtx\">article</v:resourceType>"
+
+          title = item.property("v:title")
+          element.after "<v:userTitle xmlns:v=\"vrtx\">#{title}</v:userTitle>"
+          @hpricotElem.search("tittel").remove
+
+          publishedDate = @hpricotElem.at("dato").inner_text
+
+
+          puts "TODO: Scrape url"
+
+        end
+
+        if(@vortexResourceType == "managed-xml")then
+          @hpricotElem = item
+          # HTML must be scraped off
+          publicUrl = Vortex.davUrl2webUrl(@url)
+          require 'open-uri'
+          puts "DEBUG: scraping content..."
+          content = ""
+          open(publicUrl) { |f| content=f.read  }
+
+          puts content
+          puts "---------"
+          doc = Hpricot(open(publicUrl))
+          # Make sure we can scrape content, even if content is password protected...
+          # Må logge inn
+          curl_get_cmd = "curl ..."
+          # @content = doc.searchWebDAV.get(@url)
+        end
+
+        # TODO If @vortexResourceType is not recognized, read content
+      end
+      if(item.collection)then
+        @hpricotElem = item
+        @collection = true
+      end
+    else
+      puts "Warning: Not WebDAV url: " + @url
+    end
+
+  end
+
+  def method_missing(method_name, *args)
+    # TODO Detect attribute writers: article.createdBy = thomasfl
+    # puts "DEBUG: Article." + method_name.to_s + "() method missing"
+
+    if(@hpricotElem)then
+      result = @hpricotElem.method_missing(method_name, *args)
+    end
+    if(result == nil)then
+      puts "Warning: Article." + method_name.to_s + "() method missing returns nil"
+    end
+    if(result == "false")then
+      return false
+    end
+    return result
+  end
+
+  # Returns basename of the url for article
+  def basename
+    return File.basename(@url)
+  end
+
+  # Returns url without filname for articles
+  def dirname
+    return File.dirname(@url) + "/"
+  end
+
+
+  # Boolean method that returns true if visualProfile is enabled.
+  def visualProfile
+    # Vortex default behaviour is visualProfile is always turned on
+    # and propfind only return the property <disabled ...> if
+    # visualProfile is disabled.
+    return (not @hpricotElem.property("disabled") == "true")
+  end
+
+  # Set the visualProfile. Value must be boolean
+  def visualProfile=(value)
+    # Sets the visualProfile property by modifying the xml properties
+    if(value.class == TrueClass or value.class == FalseClass ) then
+      if(value == true)then
+        if(@hpricotElem.search("disabled"))then
+          @hpricotElem.search("disabled").remove
+        end
+      end
+      if(value == false)then
+        element = @hpricotElem.search("d:displayname")
+        element.after "<disabled xmlns=\"http://www.uio.no/visual-profile\">true</disabled>"
+      end
+    end
+  end
+
+  # Puts the article to the server
+  def put!()
+    # Publiser en artikkel med eventuelle justeringen.
+    puts "put!: @vortexResourceType: '" + @vortexResourceType + "'"
+    item = @hpricotElem
+
+    if(@vortexResourceType == "nyhet")then
+      # This conversion should be done when article is read!!!
+
+    end
+
+    if(@vortexResourceType == "managed-xml")then
+      # This conversion should be done when article is read!!!
+
+      options = {
+        # :authors => item.authors.strip!, # FIXME: Support multiple authors
+        :characterEncoding => item.characterEncoding.downcase,
+        :creationDate => item.creationDate,
+        :contentLastModified => item.contentLastModified,
+        :propertiesLastModified => item.propertiesLastModified,
+        :owner => item.owner,
+        :propertiesModifiedBy => item.propertiesModifiedBy,
+        :createdBy => item.createdBy,
+        :contentModifiedBy => item.contentModifiedBy }
+
+      require 'pp'
+
+    end
+
+    if(@vortexResourceType == "article")then
+      options = {
+        :authors => item.authors.strip!, # FIXME: Support multiple authors
+        :characterEncoding => item.characterEncoding,
+        :creationDate => item.creationDate,
+        :contentLastModified => item.contentLastModified,
+        :propertiesLastModified => item.propertiesLastModified,
+        :owner => item.owner,
+        :propertiesModifiedBy => item.propertiesModifiedBy,
+        :createdBy => item.createdBy,
+        :contentModifiedBy => item.contentModifiedBy }
+
+    end
+
+    begin
+
+      visualProfile = (not item.property("disabled") == "true")
+      # puts "item.visualProfile: '" + item.visualProfile.to_s + "'"
+      if(not(visualProfile ))
+        options.merge!(:visualProfile => false)
+      end
+
+      # require 'pp'
+      # pp options
+
+      url = @url
+      title = item.title
+      introduction = item.introduction
+      content = @content
+      published_date = item.property("published-date")
+
+      puts "PUT  url:" + url
+      # puts "title:"+ title
+      # puts "introduction:" + introduction.strip!
+      # puts "content:\n------------\n:" + content + "\n--end------"
+      # puts "pbulished-date:" + published_date # , options)
+
+#      Vortex.publish_article(url, title, introduction, content, published_date, options)
+
+    end
+
+
+
+  end
+
+  def update()
+    # Proppatch
+  end
+
+  def inspect
+    "Article. URL: " + @url
+  end
+
+end

data/lib/vrtx.rb

@@ -0,0 +1,262 @@
+# -*- coding: utf-8 -*-
+require 'davclient'
+require 'time'
+
+# Command line utility for Vortex CMS
+#
+# Library for communicating with Vortex CMS server via WebDAV protocol.
+#
+# Documentation for vortex specific properties, see "Resource type tree":
+# http://www.usit.uio.no/it/vortex/arbeidsomrader/metadata/ressurstypetre-2009-06-15.txt
+
+ARTICLE_HTML = <<EOF
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title>##title##</title>
+</head>
+<body>
+  <p>##content##</p>
+</body>
+</html>
+EOF
+
+article_props = <<EOF
+    <v:resourceType xmlns:v="vrtx">article</v:resourceType>
+    <v:xhtml10-type xmlns:v="vrtx">article</v:xhtml10-type>
+    <v:published-date xmlns:v="vrtx">##published-date##</v:published-date>
+    <v:userSpecifiedCharacterEncoding xmlns:v="vrtx">##characterEncoding##</v:userSpecifiedCharacterEncoding>
+    <v:userTitle xmlns:v="vrtx">##usertitle##</v:userTitle>
+EOF
+
+ARTICLE_PROPERTIES = article_props.gsub("\n","").gsub(/ +/," ")
+
+authors_props = <<EOF
+    <v:authors xmlns:v="vrtx">
+      <vrtx:values xmlns:vrtx="http://vortikal.org/xml-value-list">
+        <vrtx:value>##realname##</vrtx:value>
+      </vrtx:values>
+    </v:authors>
+EOF
+AUTHORS = authors_props.gsub("\n","").gsub(/ +/," ")
+
+INTRODUCTION = "<introduction>##introduction##</introduction>"
+
+# Command line utilities
+module VrtxCLI
+
+
+  def self.substitute_urls(args)
+    if(args.grep(/^http:/) or args.grep(/[a-z]*\.[a-z]*\.[a-z]*[\/a-z]*$/) )then
+      new_args = []
+      args.each do |arg|
+        if(arg =~ /^http:/)then
+          arg = Vortex.url2davUrl(arg)
+          puts "Warning: changing url to webdav url: " + arg
+          new_args += [arg]
+        elsif(arg =~ /[a-z]*\.[a-z]*\.[a-z]*[\/a-z]*$/)
+          arg = Vortex.url2davUrl("http://" + arg)
+          new_args += [arg]
+        else
+          new_args += [arg]
+        end
+      end
+      args = new_args
+    end
+    return args
+  end
+
+end
+
+# Utilities for communicating with the Vortex CMS through
+# the WebDAV server interface
+module Vortex
+
+  # TODO: Set a list of default priority xml namespace prefixes
+  #       Can be done by monkey patching WebDAV module
+
+  $defaultCharacterEncoding = 'utf-8'
+
+
+  # Convert WebDAV URL to public web URL
+  # Examples:
+  #   davUrl2webUrl("https://www-dav.uio.no/faq/it/basware.xml") =>  "http://www.uio.no/faq/it/basware.xml"
+  def self.davUrl2webUrl(url)
+    if(url =~ /^https:\/\/([^\/]*)-dav(\..*)/)then
+      return "http://" + $1 + $2
+    end
+  end
+
+  # Convert public/non-webdav url's to vortex-webdav-url's
+  def self.url2davUrl(url)
+    if(url =~ /^http:\/\/([^.]*)(\..*)/) then
+      return "https://" + $1 + "-dav" + $2
+    end
+  end
+
+
+  # Parse datestring
+  # Example:
+  #   Recognizes "19.04.2009 12:00"
+  def self.parse_datestring(datestring)
+    # puts "DEBUG:" + datestring.class.to_s
+
+    if(datestring =~ /\d\d\.\d\d\.\d\d\d\d \d\d:\d\d/)then
+      date = DateTime.strptime(datestring, "%d.%m.%Y %H:%M")
+      # Regexp'en er et hack for å unngå at kl. 12:00 som input returnerer kl.14:00.
+      # Denne koden virker bare i norge. Trenger en måte å få lest ut tidssone på.
+      time = Time.parse(date.to_s.gsub(/\+00:00/,"+02:00"))
+      return time
+    end
+
+    return Time.parse(datestring)
+  end
+
+  # Publish article to Vortex CMS through WebDAV server.
+  def self.publish_article(url, title, introduction, content, published_date, *args)
+
+    if(not published_date)then
+      published_date = Time.now
+    end
+    if(published_date.class == String )
+      published_date = self.parse_datestring(published_date)
+    end
+    if(not title)then
+      title = ""
+    end
+
+    if(content =~ /\<html/ ) then
+      html = content
+    else
+      html = ARTICLE_HTML.gsub(/##title##/, title).gsub(/##content##/, content)
+    end
+
+    properties = ARTICLE_PROPERTIES.gsub(/##published-date##/, published_date.httpdate.to_s)
+    properties = properties.gsub(/##usertitle##/, title)
+
+    characterEncoding = $defaultCharacterEncoding
+
+    if(args)then
+      options = args[0]
+
+      if(options[:visualProfile] != nil and options[:visualProfile]== false)
+        # Default is true
+        properties += "<disabled xmlns=\"http://www.uio.no/visual-profile\">true</disabled>"
+      end
+
+      if(options[:authors])then
+        properties += AUTHORS.gsub(/##realname##/, options[:authors])
+      end
+
+      if(options[:owner])then
+        owner = options[:owner]
+        if(not owner =~ /@/)then
+          owner = owner + "@uio.no"
+        end
+        properties += "<v:owner xmlns:v=\"vrtx\">#{owner}</v:owner>"
+      end
+
+      if(options[:createdBy])then
+        createdBy = options[:createdBy]
+        if(not createdBy =~ /@/)then
+          createdBy = createdBy + "@uio.no"
+        end
+        properties += "<v:createdBy xmlns:v=\"vrtx\">#{createdBy}</v:createdBy>"
+      end
+
+      if(options[:contentModifiedBy])then
+        contentModifiedBy = options[:contentModifiedBy]
+        if(not contentModifiedBy =~ /@/)then
+          contentModifiedBy = contentModifiedBy + "@uio.no"
+        end
+        properties += "<v:contentModifiedBy xmlns:v=\"vrtx\">#{contentModifiedBy}</v:contentModifiedBy>"
+      end
+
+      if(options[:propertiesModifiedBy])then
+        propertiesModifiedBy = options[:propertiesModifiedBy]
+        if(not propertiesModifiedBy =~ /@/)then
+          propertiesModifiedBy = propertiesModifiedBy + "@uio.no"
+        end
+        properties += "<v:propertiesModifiedBy xmlns:v=\"vrtx\">#{propertiesModifiedBy}</v:propertiesModifiedBy>"
+      end
+
+      if(options[:modifiedBy])then
+        modifiedBy = options[:modifiedBy]
+        if(not modifiedBy =~ /@/)then
+          modifiedBy = modifiedBy + "@uio.no"
+        end
+        properties += "<v:contentModifiedBy xmlns:v=\"vrtx\">#{modifiedBy}</v:contentModifiedBy>"
+        properties += "<v:propertiesModifiedBy xmlns:v=\"vrtx\">#{modifiedBy}</v:propertiesModifiedBy>"
+      end
+
+      if(options[:characterEncoding])then
+        characterEncoding = options[:characterEncoding]
+      end
+
+      if(options[:contentLastModified])then
+        contentLastModified = options[:contentLastModified]
+        if(contentLastModified.class == String )
+          contentLastModified = self.parse_datestring(contentLastModified)
+        end
+        properties += "<v:contentLastModified xmlns:v=\"vrtx\">#{contentLastModified.httpdate.to_s}</v:contentLastModified>"
+      end
+
+
+      if(options[:propertiesLastModified])then
+        propertiesLastModified = options[:propertiesLastModified]
+        if(propertiesLastModified.class == String )
+          propertiesLastModified = self.parse_datestring(propertiesLastModified)
+        end
+        properties += "<v:propertiesLastModified xmlns:v=\"vrtx\">#{propertiesLastModified.httpdate.to_s}</v:propertiesLastModified>"
+      end
+
+      if(options[:creationDate])then
+        creationDate = options[:creationDate]
+
+        if(creationDate.class == Time)then
+          creationDateString = creationDate.httpdate.to_s ## xmlschema.to_s
+        end
+
+        if(creationDate.class == String)then
+          creationDateString = parse_datestring(creationDate).httpdate.to_s
+        end
+
+        properties += "<v:creationTime>#{creationDateString}</v:creationTime>"
+      end
+
+    end
+
+    properties = properties.gsub(/##characterEncoding##/, characterEncoding )
+
+    if(introduction) then
+      if(not introduction =~ /^<p>/)then
+        introduction = "<p>" + introduction + "</p>"
+      end
+      introduction = introduction.gsub(/</,"&lt;").gsub(/>/,"&gt;")
+      properties = properties + INTRODUCTION.gsub(/##introduction##/, introduction)
+      properties = properties.gsub("\n","").gsub(/ +/," ")
+    end
+
+    properties = properties.gsub("&amp;","&amp;&amp;")
+    # puts "Properties: " + properties
+
+    WebDAV.publish(url, html, properties )
+    return true
+  end
+
+  class Article
+
+    def initalize(url, *args)
+    end
+
+    def method_missing(method_name, *args)
+      # Detect   article.createdBy = thomasfl
+    end
+
+    def update()
+      # Proppatch
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: vrtx
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Thomas Flemming
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: davclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.5"
+    version: 
+description: Client library and command line tool for managing content on webservers with WebDAV and the open source Vortex CMS.
+email: thomas.flemming@gmail.com
+executables: 
+- vrtx
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/vrtx.rb
+- bin/vrtx
+- lib/vrtx/article.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://folk.uio.no/thomasfl
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- cURL command line tool available from http://curl.haxx.se/
+- Servername, username and password must be supplied in ~/.netrc file.
+rubyforge_project: vrtx
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Command line utility for Vortex CMS.
+test_files: []
+