vortex_client 0.4.0 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/examples/create_collection.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'vortex_client'
+include Vortex
+
+vortex = Vortex::Connection.new("https://vortex-dav.uio.no/", ENV['DAVUSER'], ENV['DAVPASS'])
+vortex.cd('/brukere/thomasfl/events/')
+
+collection = ArticleListingCollection.new(:url => 'my-collection', :title => 'My articles')
+path = vortex.create(collection)
+puts "Created folder: " + path
+
+
+collection = EventListingCollection.new(:title => 'My events')
+path = vortex.create(collection)
+puts "Created folder: " + path

data/examples/publish_article.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'vortex_client'
+include Vortex
+
+vortex = Vortex::Connection.new("https://vortex-dav.uio.no/")
+
+vortex.cd('/brukere/thomasfl/nyheter/')
+article  = HtmlArticle.new(:title => "My new title",
+                           :introduction => "Short introduction",
+                           :body => "<p>Longer body</p>",
+                           :publishedDate => Time.now,
+                           :author => "Thomas Flemming")
+path = vortex.publish(article)
+puts "published " + path
+
+# => published https://vortex-dav.uio.no/brukere/thomasfl/nyheter/my-new-title.html

data/examples/publish_event.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'vortex_client'
+include Vortex
+
+vortex = Vortex::Connection.new("https://vortex-dav.uio.no/")
+vortex.cd('/brukere/thomasfl/events/')
+event = HtmlEvent.new(:title => "My Sample Event 1",
+                      :introduction => "Sample event introduction",
+                      :body => "<p>Hello world</p>",
+                      :startDate => "19.06.2010 17:56",
+                      :endDate =>  "19.06.2010 19:00",
+                      :location => "Forskningsveien 3B",
+                      :mapUrl => "http://maps.google.com/123",
+                      :tags => ["vortex","testing","ruby"],
+                      :publishedDate => "05.01.2010 12:00")
+path = vortex.publish(event)
+puts "published " + path
+

data/lib/vortex_client.rb

@@ -7,44 +7,6 @@ require 'time'
 # All calls are done with the webdav protocol.
 module Vortex
 
-  # Convert norwegian date to Time object with a forgiven regexp
-  #
-  # Examples:
-  #
-  #   t = norwegian_date('1.1.2010')
-  #   t = norwegian_date('22.01.2010')
-  #   t = norwegian_date('22.01.2010 12:15')
-  #   t = norwegian_date('22.01.2010 12:15:20')
-  def norwegian_date(date)
-    if /\A\s*
-            (\d\d?).(\d\d?).(-?\d+)
-            \s?
-            (\d\d?)?:?(\d\d?)?:?(\d\d?)?
-            \s*\z/ix =~ date
-      year = $3.to_i
-      mon = $2.to_i
-      day = $1.to_i
-      hour = $4.to_i
-      min = $5.to_i
-      sec = $6.to_i
-
-      # puts "Debug: #{year} #{mon} #{day} #{hour}:#{min}:#{sec}"
-
-      usec = 0
-      usec = $7.to_f * 1000000 if $7
-      if $8
-        zone = $8
-        year, mon, day, hour, min, sec =
-          apply_offset(year, mon, day, hour, min, sec, zone_offset(zone))
-        Time.utc(year, mon, day, hour, min, sec, usec)
-      else
-        Time.local(year, mon, day, hour, min, sec, usec)
-      end
-    else
-      raise ArgumentError.new("invalid date: #{date.inspect}")
-    end
-  end
-
   class Connection < Net::DAV
 
     # Create a new connection to Vortex. Prompts for username and password if not
@@ -118,7 +80,7 @@ module Vortex
     #   collecion = ArticleListingCollection.new(:url => '/url')
     #   connection.create(collection)
     def create(object)
-      if(object.is_a? ArticleListingCollection)
+      if(object.is_a? Collection)
         uri = @uri.merge(object.url)
         # puts "DEBUG: uri: " + uri.to_s
         self.mkdir(uri)
@@ -139,9 +101,9 @@ module Vortex
   class Resource
   end
 
-
+  # PlainFile: This is the same as 'File' in Vortex.
   class PlainFile < Resource
-    # File in webdav. Named PlainFile so it won't get mixed up with standard File class.
+    # Named PlainFile so it won't get mixed up with standard File class.
   end
 
 
@@ -346,7 +308,7 @@ module Vortex
 
 
 
-  # Event
+  # HtmlEvent: Event document. Article with location, map url, start and end dates.
   #
   # Examples:
   #
@@ -469,7 +431,8 @@ module Vortex
   end
 
 
-  # Vortex article stored as JSON data. This is just a stub.
+  # Vortex article stored as JSON data.
+  # TODO: Fill out the stub.
   class StructuredArticle < PlainFile
 
     attr_accessor :title, :introduction, :content, :filename, :modifiedDate, :publishedDate, :owner, :url
@@ -496,18 +459,32 @@ module Vortex
 
   # Collection (folder)
   class Collection < Resource
-  end
+    attr_accessor :title, :url, :foldername, :name, :introduction, :navigationTitle, :sortByDate, :sortByTitle, :owner
 
-  class ArticleListingCollection < Collection
-    attr_accessor :title, :url, :folderename, :introduction, :navigationTitle, :sortByDate, :sortByTitle, :owner
+    def url
+      if(@url)
+        return @url
+      end
+      if(@foldername)
+        return @foldername
+      end
+      if(@name)
+        return @name
+      end
+      if(@title)
+        return StringUtils.create_filename(title)
+      end
+      return "no-name"
+    end
 
     def initialize(options={})
       options.each{|k,v|send("#{k}=",v)}
     end
 
     def properties()
-      props = "<v:resourceType xmlns:v=\"vrtx\">article-listing</v:resourceType>" +
-        "<v:collection-type xmlns:v=\"vrtx\">article-listing</v:collection-type>"
+      # props = "<v:resourceType xmlns:v=\"vrtx\">collection</v:resourceType>" +
+      #  "<v:collection-type xmlns:v=\"vrtx\">article-listing</v:collection-type>"
+      props = ""
       if(title and title != "")
         props += "<v:userTitle xmlns:v=\"vrtx\">#{title}</v:userTitle>"
       end
@@ -522,6 +499,74 @@ module Vortex
 
   end
 
+  class ArticleListingCollection < Collection
+
+    def properties()
+      props = super
+      props += "<v:resourceType xmlns:v=\"vrtx\">article-listing</v:resourceType>" +
+        "<v:collection-type xmlns:v=\"vrtx\">article-listing</v:collection-type>"
+      return props
+    end
+
+  end
+
+
+  class EventListingCollection < Collection
+
+    def properties()
+      props = super
+      props += "<v:resourceType xmlns:v=\"vrtx\">event-listing</v:resourceType>" +
+        "<v:collection-type xmlns:v=\"vrtx\">event-listing</v:collection-type>"
+      return props
+    end
+
+  end
+
+
+
+  # Utilities
+  #
+  # Convert norwegian date to Time object with a forgiven regexp
+  #
+  # TODO: Move this somewhere.
+  #
+  # Examples:
+  #
+  #   t = norwegian_date('1.1.2010')
+  #   t = norwegian_date('22.01.2010')
+  #   t = norwegian_date('22.01.2010 12:15')
+  #   t = norwegian_date('22.01.2010 12:15:20')
+  def norwegian_date(date)
+    if /\A\s*
+            (\d\d?).(\d\d?).(-?\d+)
+            \s?
+            (\d\d?)?:?(\d\d?)?:?(\d\d?)?
+            \s*\z/ix =~ date
+      year = $3.to_i
+      mon = $2.to_i
+      day = $1.to_i
+      hour = $4.to_i
+      min = $5.to_i
+      sec = $6.to_i
+
+      # puts "Debug: #{year} #{mon} #{day} #{hour}:#{min}:#{sec}"
+
+      usec = 0
+      usec = $7.to_f * 1000000 if $7
+      if $8
+        zone = $8
+        year, mon, day, hour, min, sec =
+          apply_offset(year, mon, day, hour, min, sec, zone_offset(zone))
+        Time.utc(year, mon, day, hour, min, sec, usec)
+      else
+        Time.local(year, mon, day, hour, min, sec, usec)
+      end
+    else
+      raise ArgumentError.new("invalid date: #{date.inspect}")
+    end
+  end
+
+
 end
 
 

data/test/test_vortex_collection.rb

@@ -12,7 +12,7 @@ class TestVortexCollection < Test::Unit::TestCase
     end
   end
 
-  should "create collection (folder)" do
+  should "create article listing collection (folder)" do
     url = 'https://vortex-dav.uio.no/brukere/thomasfl/nyheter/my-collection'
     if(@vortex.exists?(url))
       @vortex.delete(url)
@@ -26,4 +26,54 @@ class TestVortexCollection < Test::Unit::TestCase
     assert created_path == url
   end
 
+
+  should "create event listing collection (folder)" do
+    url = 'https://vortex-dav.uio.no/brukere/thomasfl/nyheter/event-collection'
+    if(@vortex.exists?(url))
+      @vortex.delete(url)
+    end
+
+    @vortex.cd('/brukere/thomasfl/nyheter/')
+    collection = EventListingCollection.new(:url => 'event-collection', :title => 'Event Collection')
+
+    created_path = @vortex.create(collection)
+
+    assert @vortex.exists?(created_path)
+    assert created_path == url
+  end
+
+
+  should "create collection name from title" do
+    url = 'https://vortex-dav.uio.no/brukere/thomasfl/nyheter/event-collection'
+    if(@vortex.exists?(url))
+      @vortex.delete(url)
+    end
+
+    @vortex.cd('/brukere/thomasfl/nyheter/')
+    collection = EventListingCollection.new(:title => 'Event Collection')
+
+    created_path = @vortex.create(collection)
+
+    assert @vortex.exists?(created_path)
+    assert created_path == url
+  end
+
+
+  should "create collection name from foldername" do
+    url = 'https://vortex-dav.uio.no/brukere/thomasfl/nyheter/event-collection'
+    if(@vortex.exists?(url))
+      @vortex.delete(url)
+    end
+
+    @vortex.cd('/brukere/thomasfl/nyheter/')
+    collection = EventListingCollection.new(:foldername => 'event-collection')
+
+    created_path = @vortex.create(collection)
+
+    assert @vortex.exists?(created_path)
+    assert created_path == url
+  end
+
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vortex_client
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Thomas Flemming
@@ -59,12 +59,17 @@ files:
 - Rakefile
 - VERSION
 - bin/vrtx-sync
+- examples/create_collection.rb
+- examples/publish_article.rb
+- examples/publish_event.rb
 - lib/vortex_client.rb
 - lib/vortex_client/string_utils.rb
 - test/helper.rb
+- test/test_date_conversion.rb
 - test/test_vortex_article_publish.rb
 - test/test_vortex_client.rb
 - test/test_vortex_collection.rb
+- test/test_vortex_event.rb
 - test/test_vortex_tags.rb
 - test/test_vortex_utils.rb
 has_rdoc: true
@@ -104,3 +109,6 @@ test_files:
 - test/test_vortex_event.rb
 - test/test_vortex_tags.rb
 - test/test_vortex_utils.rb
+- examples/create_collection.rb
+- examples/publish_article.rb
+- examples/publish_event.rb