vortex_client 0.1.0 → 0.2.0

data/README.rdoc

@@ -3,6 +3,7 @@
 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.
 
+
 = Publishing content
 
 To publish an article.
@@ -35,6 +36,10 @@ To create a folder named "2010" in the "/news/" folder.
    collection = Vortex::ArticleListingCollection.new(:title => "News for 2009", :foldername => "2009")
    vortex.create(collection)
 
+= Documentation
+
+RDoc: http://rdoc.info/projects/thomasfl/vortex_client/
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/vortex_client/string_utils.rb

@@ -1,10 +1,9 @@
 # -*- coding: utf-8 -*-
-require 'cgi'
 require 'iconv'
 
 module Vortex
 
-  "String utilities"
+  # String utilities
 
   class StringUtils
 
@@ -27,17 +26,6 @@ module Vortex
         html_filename = html_filename[0..100]
         html_filename = html_filename.gsub(/_[^_]*$/,"") + ".html"
       end
-
-      html_filename = html_filename.gsub("!","")
-      html_filename = html_filename.sub(/^_/, "")
-      html_filename = html_filename.gsub("»", "")
-      html_filename = html_filename.gsub("%", "")
-
-      h1 = html_filename
-      html_filename = CGI::escape(html_filename) # URLencode just to be safe
-      if(html_filename != h1)
-        warn "create_filename_from_title() could not create a valid filename " + html_filename
-      end
       return html_filename
     end
 
@@ -47,27 +35,23 @@ module Vortex
       camel_cased_word = camel_cased_word.to_s.gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1\2').
         gsub(/([a-z\d])([A-Z])/,'\1\2').downcase
-      camel_cased_word = camel_cased_word.to_s.gsub(/ /,'-')
-      camel_cased_word = camel_cased_word.gsub(/_+/,"_")
 
-      camel_cased_word = camel_cased_word.gsub(/\//,"_")
-      camel_cased_word = camel_cased_word.gsub(/\?/,"")
-
-      camel_cased_word = camel_cased_word.gsub(/\(.*\)/,"")
-      camel_cased_word = camel_cased_word.gsub(/'/,"")
-      camel_cased_word = camel_cased_word.gsub(/:/,"")
-      camel_cased_word = camel_cased_word.gsub(/\./,"")    # Dot's ('.') don't look good in url's
-      camel_cased_word = camel_cased_word.gsub(",","")     # Commas don't look good in url's
-      camel_cased_word = camel_cased_word.gsub(/"/,"")     # and not '"' either
-      camel_cased_word = camel_cased_word.gsub("§","")     # Paragraps are no good
+      camel_cased_word = camel_cased_word.to_s.gsub(/ /,'-')
+      camel_cased_word = camel_cased_word.to_s.gsub(/^_/,'')
       camel_cased_word = camel_cased_word.gsub("__","_")
+
+      # sanitize the string
+      camel_cased_word = camel_cased_word.gsub(/[^a-z._0-9 -]/i, "").
+        tr(".", "_").gsub(/(\s+)/, "_").gsub(/_/, '-').downcase
+      camel_cased_word = camel_cased_word.to_s.gsub(/--*/,'-')
       return camel_cased_word
     end
 
 
     # Filter accents and some special characters
     def self.remove_accents(str)
-      accents = { ['á','à','â','ä','ã','Ã','Ä','Â','À'] => 'a',
+      accents = {
+        ['á','à','â','ä','ã','Ã','Ä','Â','À'] => 'a',
         ['é','è','ê','ë','Ë','É','È','Ê'] => 'e',
         ['í','ì','î','ï','I','Î','Ì'] => 'i',
         ['ó','ò','ô','ö','õ','Õ','Ö','Ô','Ò'] => 'o',
@@ -80,6 +64,7 @@ module Vortex
         ['Æ'] => 'ae',
         ['Ø'] => 'o',
         ['Å'] => 'a',
+        ['§'] => ''
       }
       accents.each do |ac,rep|
         ac.each do |s|
@@ -87,8 +72,8 @@ module Vortex
         end
       end
 
-      # Remove the rest of the accents
-      conv = Iconv.new("ASCII//TRANSLIT", "UTF-8")
+      # Remove the rest of the accents and special characters
+      conv = Iconv.new("ASCII//TRANSLIT//IGNORE", "UTF-8")
       str = conv.iconv(str)
       return str
     end

data/lib/vortex_client.rb

@@ -1,6 +1,7 @@
 require 'net/dav'
 require 'vortex_client/string_utils'
 require 'highline/import'
+require 'time'
 
 # Utilities for managing content in the web content management system Vortex.
 # All calls are done with the webdav protocol.
@@ -67,6 +68,7 @@ module Vortex
         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
       end
@@ -90,7 +92,14 @@ module Vortex
   end
 
 
-  # HtmlArticle: Plain HTML files with title, introduction and keywords set as webdav properties.
+  # 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
@@ -116,13 +125,29 @@ module Vortex
       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 != "")
-        props += '<v:published-date xmlns:v="vrtx">' + date + '</v:published-date>' +
-        '<d:getlastmodified>' + date + '</d:getlastmodified>' +
+        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

data/test/test_vortex_article_publish.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require 'helper'
+
+class TestVortexClientUtils < Test::Unit::TestCase
+  include Vortex
+
+  def setup
+    if(not(@vortex))
+      user = ENV['DAVUSER']
+      pass = ENV['DAVPASS']
+      @vortex = Connection.new("https://vortex-dav.uio.no/",user, pass)
+    end
+  end
+
+  should "publish articles" do
+    url = 'https://vortex-dav.uio.no/brukere/thomasfl/nyheter/sample-title-2.html'
+    if(@vortex.exists?(url))
+      @vortex.delete(url)
+    end
+
+    @vortex.cd('/brukere/thomasfl/nyheter/')
+    article = Vortex::HtmlArticle.new(:title => "Sample Title 2",
+                                      :introduction => "Sample introduction",
+                                      :body => "<p>Hello world</p>",
+                                      ## :date => Time.now,
+                                      :publishedDate => "05.01.2010 12:00",
+                                      :author => "Thomas Flemming")
+
+    @vortex.publish(article)
+    assert @vortex.exists?(url)
+  end
+
+end
+

data/test/test_vortex_utils.rb

@@ -2,16 +2,19 @@
 require 'helper'
 
 class TestVortexClientUtils < Test::Unit::TestCase
+  include Vortex
 
-  should "run all tests" do
-    assert true
-  end
+  should "make sentence in to valid url withthout any url encoding" do
+    assert_equal "hei-pa-deg", StringUtils.create_filename("Hei på deg")
+    assert StringUtils.create_filename('áàâäãÃÄÂÀ') =~ /^a*$/
+    assert StringUtils.create_filename('éèêëËÉÈÊ') =~ /^e*$/
+    assert StringUtils.create_filename('íìîïIÎÌ') => /^i*$/
+    assert StringUtils.create_filename('óòôöõÕÖÔÒ') => /^o*$/
 
-  should "prompt for password if enviroment variable DAVUSER is not set" do
-    # @vortex = Vortex::Connection.new("https://vortex-dav.uio.no/")
-    # ENV['DAVUSER'] = nil
-    # content = @vortex.get('https://vortex-dav.uio.no/brukere/thomasfl/test/test_1.html')
-    # assert content.match('html.*body')
+    #      0000000001111111111222222222233333333334
+    #      1234567890123456789012345678901234567890
+    str = 'start! to ()[]{}__@__\/?/.,"§_»_%##!!!end;:stripped'
+    assert_equal 'start-to-end', StringUtils.create_filename(str)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vortex_client
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Thomas Flemming
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-21 00:00:00 +01:00
+date: 2010-01-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,5 +93,6 @@ specification_version: 3
 summary: Vortex CMS client
 test_files: 
 - test/helper.rb
+- test/test_vortex_article_publish.rb
 - test/test_vortex_client.rb
 - test/test_vortex_utils.rb