vortex_utils 0.0.1

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/vortex_utils/string_extensions.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+require 'iconv'
+
+# Utilities useful for adding content to Content Management Systems
+
+class String
+
+  # Turn a normal sentence into a valid, readable filename.
+  #
+  # Example:
+  #
+  #    "A small test".to_readable_url
+  #     => "a-small-test"
+  def to_readable_url
+    sentence = self
+    if(sentence.size > 10)then
+      truncated_title = sentence.sub(/:.*/,"").sub(/;/,"").sub(/&/,"").sub(/\(/,"").sub(/\)/,"")
+      html_filename = truncated_title.snake_case
+    else
+      html_filename = sentence.snake_case
+    end
+
+    # Just keep the 100 first chars, to nearest word.
+    if(html_filename.size > 100)then
+      html_filename = html_filename.gsub(/\.html$/,"")
+      html_filename = html_filename[0..100]
+      html_filename = html_filename.gsub(/_[^_]*$/,"") + ".html"
+    end
+    return html_filename
+  end
+
+  def snake_case
+    camel_cased_word_input = self
+    camel_cased_word = camel_cased_word_input + "" # create local copy of string
+    camel_cased_word = camel_cased_word.transliterate_accents
+    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.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 transliterate_accents
+    str = self
+    accents = {
+      ['á','à','â','ä','ã','Ã','Ä','Â','À'] => 'a',
+      ['é','è','ê','ë','Ë','É','È','Ê'] => 'e',
+      ['í','ì','î','ï','I','Î','Ì'] => 'i',
+      ['ó','ò','ô','ö','õ','Õ','Ö','Ô','Ò'] => 'o',
+      ['ñ'] => 'n',
+      ['œ'] => 'e',
+      ['ß'] => 'ss',
+      ['ú','ù','û','ü','U','Û','Ù'] => 'u',
+      ['æ'] => 'ae',
+      ['ø'] => 'o',
+      ['å'] => 'a',
+      ['Æ'] => 'ae',
+      ['Ø'] => 'o',
+      ['Å'] => 'a',
+      ['§'] => ''
+    }
+    accents.each do |ac,rep|
+      ac.each do |s|
+        str.gsub!(s, rep)
+      end
+    end
+
+    # Remove the rest of the accents and special characters
+    conv = Iconv.new("ASCII//TRANSLIT//IGNORE", "UTF-8")
+    str = conv.iconv(str)
+    return str
+  end
+
+end

data/lib/vortex_utils.rb

@@ -0,0 +1,138 @@
+require_relative 'vortex_utils/string_extensions'
+
+# Utilites used to access the Vortex CMS from the WebDAV protocol and do common tasks
+
+require 'net/dav'
+require 'uri'
+require 'highline/import'
+require 'time'
+require 'json'
+
+module Net
+
+  class DAV
+
+    def initialize(uri, *args)
+      @uri = uri
+      @uri = URI.parse(@uri) if @uri.is_a? String
+      @have_curl = false # This defaults to true in Net::DAV
+      @handler = NetHttpHandler.new(@uri)
+      @handler.verify_server = false # This defaults to true in Net::DAV
+      if(args != [])
+        if(args[0][:use_osx_keychain] or args[0][:osx_keychain])then
+
+          # Retrieve password from OS X KeyChain.
+          osx =  (RUBY_PLATFORM =~ /darwin/)
+          if(osx)then
+            require 'osx_keychain'
+            keychain = OSXKeychain.new
+            user = ENV['USER']
+
+            if(args[0][:prompt_for_password])
+              response = `security delete-generic-password -s #{@uri.host}`
+              require 'pry'
+              binding.pry
+            end
+
+            pass = keychain[@uri.host, user ]
+
+            if(pass == nil) then
+              puts "Password not found on OS X KeyChain. "
+              puts "Enter password to store new password on OS X KeyChain."
+              ## @handler.user = ask("Username: ") {|q| q.echo = true}
+              ## Todo: store username in a config file so we can have
+              ## different username locally and on server
+              pass = ask("Password: ") {|q| q.echo = "*"} # false => no echo
+              keychain[@uri.host, user] = pass
+              puts "Password for '#{user}' on '#{@uri.host}' stored on OS X KeyChain."
+              @handler.user = user
+              @handler.pass = pass
+            else
+              @handler.user = user
+              @handler.pass = pass
+            end
+            return @handler
+
+          else
+            puts "Warning: Not running on OS X."
+          end
+
+        end
+        @handler.user = args[0]
+        @handler.pass = args[1]
+      else
+        @handler.user = ask("Username: ") {|q| q.echo = true}
+        @handler.pass = ask("Password: ") {|q| q.echo = "*"} # false => no echo
+      end
+      return @handler
+    end
+
+    # Set the publish date to current timestamp
+    def vortex_publish!(uri)
+      proppatch(uri, '<v:publish-date xmlns:v="vrtx">' + Time.now.httpdate.to_s + '</v:publish-date>')
+    end
+
+    def vortex_publish(uri,time)
+      proppatch(uri, '<v:publish-date xmlns:v="vrtx">' + time.httpdate.to_s + '</v:publish-date>')
+    end
+
+    def vortex_unpublish!(uri)
+      proppatch(uri, '<v:unpublish-date xmlns:v="vrtx">' +Time.now.httpdate.to_s + '</v:unpublish-date>')
+    end
+
+    def vortex_unpublish(uri, time)
+      proppatch(uri, '<v:unpublish-date xmlns:v="vrtx">' + time.httpdate.to_s + '</v:unpublish-date>')
+    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
+
+    def set_vortex_collection_title(uri, title)
+      proppatch(uri,'<v:userTitle xmlns:v="vrtx">' + title.to_s +  '</v:userTitle>')
+    end
+
+    def set_vortex_collection_type(uri, type)
+      proppatch(uri,'<v:collection-type xmlns:v="vrtx">' + type + '</v:collection-type>')
+    end
+
+    def hide_vortex_collection(uri)
+      proppatch(uri, '<hidden xmlns="http://www.uio.no/navigation">true</hidden>')
+    end
+
+  end
+
+
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'vortex_utils'
+
+class Test::Unit::TestCase
+end

data/test/test_net_dav_extensions.rb

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+require_relative 'helper'
+require 'json'
+
+class NetDAVExtensions < Test::Unit::TestCase
+
+  def setup
+    uri = 'https://www-dav.usit.uio.no/om/organisasjon/web/wapp/ansatte/thomasfl/vortex-script/test/'
+    @dav = Net::DAV.new(uri,:osx_keychain => true)
+  end
+
+  should "delete password from keychain and prompt for password" do
+    # dav = Net::DAV.new("https://www-dav.usit.uio.no/om/organisasjon/web/wapp/ansatte/thomasfl/vortex-script/test/",
+    #                      :osx_keychain => true, :prompt_for_password => true)
+  end
+
+  should "publish article" do
+    tittel = "My little testing article ÆØÅ"
+
+    article = {
+      "resourcetype" => "structured-article",
+      "properties" =>    {
+        "title" => tittel,
+        "introduction" => "Dette er innledningen til artikkelen",
+        "content" => "<p>Her er innholdet i artikkelen</p>"
+      }
+    }
+
+    filename = tittel.to_readable_url + '.html'
+    @dav.put_string(filename, article.to_json)
+    @dav.vortex_publish!(filename)
+    assert @dav.exists?(filename)
+  end
+
+  should "set publish date to 2 days ahead and unpublish date to 3 days" do
+    article = {
+      "resourcetype" => "structured-article",
+      "properties" =>    {
+        "title" => "Test article",
+        "introduction" => "Dette er innledningen til artikkelen",
+        "content" => "<p>Her er innholdet i artikkelen</p>"
+      }
+    }
+    @dav.put_string('test-article.html', article.to_json)
+    @dav.vortex_publish('test-article.html', Time.now + (2*24*60*60))
+    @dav.vortex_unpublish('test-article.html', Time.now + (3*24*60*60))
+  end
+
+  should "create paths and set type" do
+    path = '/om/organisasjon/web/wapp/ansatte/thomasfl/vortex-script/test/'
+    @dav.create_path(path + 'folders/to/be/created', :type => "article-listing")
+    assert(@dav.exists?(path + 'folders/to/be/created'))
+    @dav.delete(path + 'folders')
+    assert( !@dav.exists?(path + 'folders') )
+
+    folder_path = path + 'test_folder'
+    if(@dav.exists?(folder_path))
+      @dav.delete(folder_path)
+    end
+    @dav.mkdir(folder_path)
+    @dav.set_vortex_collection_title(folder_path,'En tittel')
+    @dav.set_vortex_collection_type(folder_path,'article-listing')
+    @dav.hide_vortex_collection(folder_path)
+    @dav.delete(folder_path)
+  end
+
+end

data/test/test_string_extensions.rb

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require_relative 'helper'
+
+class TestStringExtensions < Test::Unit::TestCase
+
+  should "transliterate accents nicesly" do
+    assert "ñâñôñä".transliterate_accents == "nanona"
+  end
+
+  should "snake case sentences" do
+    assert "one two three".snake_case == "one-two-three"
+  end
+
+  should "make sentences into strings usable for readable urls" do
+    assert "this is a çircûmflexed senteñce".to_readable_url == "this-is-a-circumflexed-sentence"
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: vortex_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Flemming
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net_dav
+  requirement: &2156218200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156218200
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &2156217040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156217040
+- !ruby/object:Gem::Dependency
+  name: thoughtbot-shoulda
+  requirement: &2156215100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :development
+  prerelease: false
+  version_requirements: *2156215100
+description: Utilities for managing content on Vortex web content management system
+  through webdav
+email: thomas.flemming@usit.uio.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- lib/vortex_utils.rb
+- lib/vortex_utils/string_extensions.rb
+- test/helper.rb
+- test/test_net_dav_extensions.rb
+- test/test_string_extensions.rb
+homepage: http://github.com/thomasfl/vortex_utils
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Vortex CMS utilites
+test_files:
+- test/helper.rb
+- test/test_net_dav_extensions.rb
+- test/test_string_extensions.rb