vortex_client 0.3.0 → 0.3.1

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "thomas.flemming@usit.uio.no"
     gem.homepage = "http://github.com/thomasfl/vortex_client"
     gem.authors = ["Thomas Flemming"]
+    gem.executables = ["vrtx-sync"]
     gem.add_dependency "net_dav", ">= 0.4.1"
     gem.add_dependency "highline", ">= 1.5.1"
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/bin/vrtx-sync

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'uri'
+require 'vortex_client'
+
+# vrtx-sync: keep local files synced with webdav content
+#
+# Author: Thomas Flemming, thomasfl(at)usit.uio.no
+# MIT License 2010
+
+def print_usage
+  puts "usage: #{$0} URI [URI2 URI3..]"
+  puts ""
+  puts "Downloads resource from webdav server. File is "
+  puts "uploaded back to webdav server when file us updated"
+  puts "on local disk. "
+  exit
+end
+
+def download(url, vortex)
+  filename = url[/[^\/]*$/,0]
+  file = File.new(filename, "w")
+  begin
+    file.puts vortex.get(url).to_s
+  rescue Net::HTTPServerException => e
+    puts "Server error: " + e.to_s + " " + url
+    exit
+  end
+  path = file.path
+  file.close
+  return path
+end
+
+
+# Monitor files
+class FileMon
+
+  def initialize(filenames)
+    @last_mtimes = { }
+    filenames.each do |filename|
+      raise "File does not exist: " + filename unless File.exist?(filename)
+      @last_mtimes[filename] = File.stat(filename).mtime
+    end
+    @filenames = filenames
+  end
+
+  def run(sleep=1, &on_update)
+    loop do
+      Kernel.sleep sleep until file_updated?
+      yield @updated_file
+    end
+  end
+
+  def file_updated?
+    @filenames.each do |filename|
+      mtime = File.stat(filename).mtime
+      updated = @last_mtimes[filename] < mtime
+      @last_mtimes[filename] = mtime
+      if(updated)
+        @updated_file = filename
+        return true
+      end
+    end
+    return false
+  end
+
+end
+
+
+if $*.size < 1
+  print_usage
+end
+
+url = $*[0]
+if(ENV['DAVUSER'] and ENV['DAVPASS'])
+  vortex = Vortex::Connection.new(url, ENV['DAVUSER'], ENV['DAVPASS'])
+else
+  vortex = Vortex::Connection.new(url)
+end
+
+downloaded_files = { }
+$*.each do |url|
+  puts "Downloading: " + url
+  filename = download(url, vortex)
+  downloaded_files[filename] = url
+end
+
+FileMon.new(downloaded_files.keys).run do |filename|
+  url = downloaded_files[filename]
+  file = File.open(filename, "rb")
+  contents = file.read
+  puts "Uploading " + filename + " => " + url
+  vortex.put_string(url, contents)
+end

data/lib/vortex_client.rb

@@ -63,10 +63,9 @@ module Vortex
     def publish(object)
       if(object.is_a? HtmlArticle)
         uri = @uri.merge(object.url)
-        # puts "URL: '" + uri.to_s
+        # puts "DEBUG: '" + object.properties
         self.put_string(uri, object.content)
         self.proppatch(uri, object.properties)
-        # puts object.properties
         return uri.to_s
       else
         warn "Unknown vortex resource: " + object.class.to_s
@@ -83,6 +82,7 @@ module Vortex
     def create(object)
       if(object.is_a? ArticleListingCollection)
         uri = @uri.merge(object.url)
+        # puts "DEBUG: uri: " + uri.to_s
         self.mkdir(uri)
         self.proppatch(uri, object.properties)
         return uri.to_s
@@ -128,6 +128,213 @@ module Vortex
       if(@url)
         @url
       else
+        if(filename)
+          filename
+        end
+        if(title)
+          StringUtils.create_filename(title) + ".html"
+        else
+          warn "Article must have either a full url or title. "
+        end
+      end
+    end
+
+    def properties
+      props = '<v:resourceType xmlns:v="vrtx">article</v:resourceType>' +
+        '<v:xhtml10-type xmlns:v="vrtx">article</v:xhtml10-type>' +
+        '<v:userSpecifiedCharacterEncoding xmlns:v="vrtx">utf-8</v:userSpecifiedCharacterEncoding>'
+
+      if(@publishedDate and @publishedDate != "")
+        if(@publishedDate.kind_of? Time)
+          @publishedDate = @publishedDate.httpdate.to_s
+        end
+        props += '<v:published-date xmlns:v="vrtx">' + @publishedDate + '</v:published-date>'
+      end
+
+      if(date and date != "")
+        if(date.kind_of? Time)
+          date = @date.httpdate.to_s
+        end
+        if(@publishedDate == nil or @publishedDate != "")
+          props += '<v:published-date xmlns:v="vrtx">' + date + '</v:published-date>'
+        end
+        props += '<d:getlastmodified>' + date + '</d:getlastmodified>' +
+        '<v:contentLastModified xmlns:v="vrtx">' + date + '</v:contentLastModified>' +
+        '<v:propertiesLastModified xmlns:v="vrtx">' + date + '</v:propertiesLastModified>' +
+        '<v:creationTime xmlns:v="vrtx">' + date + '</v:creationTime>'
+      end
+      if(title)
+        props += '<v:userTitle xmlns:v="vrtx">' + title + '</v:userTitle>'
+      end
+      if(owner)
+        props += '<owner xmlns="vrtx">' + owner + '</owner>'
+      end
+      if(introduction and introduction != "")
+        props += '<introduction xmlns="vrtx">' + introduction + '</introduction>'
+      end
+      if(author and author != "")
+        props += '<v:authors xmlns:v="vrtx">' +
+          '<vrtx:values xmlns:vrtx="http://vortikal.org/xml-value-list">' +
+             '<vrtx:value>' + author + '</vrtx:value>' +
+           '</vrtx:values>' +
+        '</v:authors>'
+      end
+
+      if(tags and tags.kind_of?(Array) and tags.size > 0)
+        props += '<v:tags xmlns:v="vrtx">' +
+          '<vrtx:values xmlns:vrtx="http://vortikal.org/xml-value-list">'
+        tags.each do |tag|
+            props += "<vrtx:value>#{tag}</vrtx:value>"
+        end
+        props += '</vrtx:values></v:tags>'
+      end
+
+      return props
+    end
+
+    def content
+      content = '<!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>' +
+        ' <link href="http://www.uio.no/profil/kupu/kupucontentstyles.css" type="text/css" rel="stylesheet"/>' +
+        '</head><body>'
+      if(body)
+        content += body
+      end
+      content += '</body></html>'
+    end
+
+  end
+
+
+  # Plain HTML files with title, introduction and keywords set as webdav properties.
+  #
+  # Examples:
+  #
+  #   article = HtmlArticle.new(:title => "Sample Title",
+  #                             :introduction => "Introduction",
+  #                             :body => "<p>Hello world</p>")
+  #   vortex.publish(article)
+  class HtmlArticle < PlainFile
+
+    attr_accessor :title, :introduction, :body, :filename, :modifiedDate, :publishedDate, :owner, :url, :author, :date, :tags
+
+    # Create a new article of type html-article: plain html file with introduction stored as a webdav property.
+    def initialize(options={})
+      options.each{|k,v|send("#{k}=",v)}
+    end
+
+    def url
+      if(@url)
+        @url
+      else
+        if(filename)
+          filename
+        end
+        if(title)
+          StringUtils.create_filename(title) + ".html"
+        else
+          warn "Article must have either a full url or title. "
+        end
+      end
+    end
+
+    def properties
+      props = '<v:resourceType xmlns:v="vrtx">article</v:resourceType>' +
+        '<v:xhtml10-type xmlns:v="vrtx">article</v:xhtml10-type>' +
+        '<v:userSpecifiedCharacterEncoding xmlns:v="vrtx">utf-8</v:userSpecifiedCharacterEncoding>'
+
+      if(@publishedDate and @publishedDate != "")
+        if(@publishedDate.kind_of? Time)
+          @publishedDate = @publishedDate.httpdate.to_s
+        end
+        props += '<v:published-date xmlns:v="vrtx">' + @publishedDate + '</v:published-date>'
+      end
+
+      if(date and date != "")
+        if(date.kind_of? Time)
+          date = @date.httpdate.to_s
+        end
+        if(@publishedDate == nil or @publishedDate != "")
+          props += '<v:published-date xmlns:v="vrtx">' + date + '</v:published-date>'
+        end
+        props += '<d:getlastmodified>' + date + '</d:getlastmodified>' +
+        '<v:contentLastModified xmlns:v="vrtx">' + date + '</v:contentLastModified>' +
+        '<v:propertiesLastModified xmlns:v="vrtx">' + date + '</v:propertiesLastModified>' +
+        '<v:creationTime xmlns:v="vrtx">' + date + '</v:creationTime>'
+      end
+      if(title)
+        props += '<v:userTitle xmlns:v="vrtx">' + title + '</v:userTitle>'
+      end
+      if(owner)
+        props += '<owner xmlns="vrtx">' + owner + '</owner>'
+      end
+      if(introduction and introduction != "")
+        props += '<introduction xmlns="vrtx">' + introduction + '</introduction>'
+      end
+      if(author and author != "")
+        props += '<v:authors xmlns:v="vrtx">' +
+          '<vrtx:values xmlns:vrtx="http://vortikal.org/xml-value-list">' +
+             '<vrtx:value>' + author + '</vrtx:value>' +
+           '</vrtx:values>' +
+        '</v:authors>'
+      end
+
+      if(tags and tags.kind_of?(Array) and tags.size > 0)
+        props += '<v:tags xmlns:v="vrtx">' +
+          '<vrtx:values xmlns:vrtx="http://vortikal.org/xml-value-list">'
+        tags.each do |tag|
+            props += "<vrtx:value>#{tag}</vrtx:value>"
+        end
+        props += '</vrtx:values></v:tags>'
+      end
+
+      return props
+    end
+
+    def content
+      content = '<!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>' +
+        ' <link href="http://www.uio.no/profil/kupu/kupucontentstyles.css" type="text/css" rel="stylesheet"/>' +
+        '</head><body>'
+      if(body)
+        content += body
+      end
+      content += '</body></html>'
+    end
+
+  end
+
+
+
+  # Event
+  #
+  # Examples:
+  #
+  #   event = HtmlEvent.new(:title => "Sample Event",
+  #                         :introduction => "Introduction",
+  #                         :body => "<p>Hello world</p>",
+  #                         :startDatetime => Time.now,
+  #                         :endDatetime => Time.now + (60*60*60),
+  #                         :venue => "Vilhelm Bjerkes hus, Rom 207" )
+  #   vortex.publish(article)
+  class HtmlEvent < PlainFile
+
+    attr_accessor :title, :introduction, :body, :filename, :modifiedDate, :publishedDate, :owner, :url, :author, :date, :tags
+
+    # Create a new article of type html-article: plain html file with introduction stored as a webdav property.
+    def initialize(options={})
+      options.each{|k,v|send("#{k}=",v)}
+    end
+
+    def url
+      if(@url)
+        @url
+      else
+        if(filename)
+          filename
+        end
         if(title)
           StringUtils.create_filename(title) + ".html"
         else
@@ -177,7 +384,7 @@ module Vortex
         '</v:authors>'
       end
 
-      if(tags and tags.kind_of?(Array))
+      if(tags and tags.kind_of?(Array) and tags.size > 0)
         props += '<v:tags xmlns:v="vrtx">' +
           '<vrtx:values xmlns:vrtx="http://vortikal.org/xml-value-list">'
         tags.each do |tag|
@@ -204,7 +411,7 @@ module Vortex
   end
 
 
-  # Vortex article stored as JSON data.
+  # Vortex article stored as JSON data. This is just a stub.
   class StructuredArticle < PlainFile
 
     attr_accessor :title, :introduction, :content, :filename, :modifiedDate, :publishedDate, :owner, :url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vortex_client
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Thomas Flemming
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-08 00:00:00 +01:00
-default_executable: 
+date: 2010-01-21 00:00:00 +01:00
+default_executable: vrtx-sync
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net_dav
@@ -44,8 +44,8 @@ dependencies:
     version: 
 description: Utility for managing content on Vortex web content management system through webdav
 email: thomas.flemming@usit.uio.no
-executables: []
-
+executables: 
+- vrtx-sync
 extensions: []
 
 extra_rdoc_files: