filestore 0.0.19 → 0.0.20

data/lib/filestore.rb

@@ -19,7 +19,9 @@ LIBS = [
   'uuidtools',
   'fileutils',
   'yaml',
-  'etc'
+  'etc',
+  'socket',
+  'base64'
 ]
 FILESTORE_FILES = [
   #
@@ -31,7 +33,9 @@ FILESTORE_FILES = [
   'memory_meta',
   'simple_store',
   'multitenant_store',
-  'factory'
+  'factory',
+  'webdav/webdav',
+  'webdav_store'
 ]
 #
 # Loads required 3rd party libs as defined in FileStore::LIBS

data/lib/filestore/factory.rb

@@ -208,4 +208,47 @@ module FileStore
       end
     end
   end
+  
+  module WebDAV
+    #
+    # WebDAVStore factory class
+    #
+    class WebDAVStoreFactory
+      #
+      # Creates a WebDAV file-store instance
+      #
+      # Arguments:
+      #   root_path: The base path directory
+      #   host: The WebDAV host
+      #   prefix: The path prefix for any URL
+      #   port (optional): The WebDAV port
+      #   user (optional): HTTP user
+      #   password (optional): HTTP password 
+      #   observable (optional): Determines wether this instance should support observation
+      #   logger (optional): The logging facility
+      #
+      # Returns:
+      #   A new instance of WebDAVStore
+      #
+      def self.create(root_path, host, prefix, port = 80, user = '', password = '', observable = false, logger = StdoutLogger)
+        store = nil
+        
+        begin
+          store = WebDAVStore.new host, port, user, password, root_path, logger
+          store.connection.path_prefix = prefix
+          
+          if observable then
+            logger.debug "Extending instance with module 'ObservedSubject'"
+            
+            store.extend ObservedSubject
+            store.initialize_obs 
+          end
+        rescue FileStoreException => e
+          logger.debug "Couldn't create webdav store.\nReason: #{e.message}"
+        end
+        
+        return store
+      end
+    end
+  end
 end

data/lib/filestore/observer.rb

@@ -11,9 +11,12 @@ module FileStore
   #
   class ObserverAction
     TYPE_DEFAULT        = "DEFAULT"
+    TYPE_DAV_ADD        = "WEBDAV_ADD_FILE"
+    TYPE_DAV_REMOVE     = "WEBDAV_REMOVE_FILE"
     TYPE_STORE_ADD      = "STORE_ADD_FILE"
     TYPE_STORE_REMOVE   = "STORE_REMOVE_FILE"
     TYPE_STORE_GET      = "STORE_GET_FILE"
+    TYPE_DAV_GET        = "WEBDAV_GET_FILE"
     TYPE_STORE_RESTORE  = "STORE_RESTORE_FILE"
     TYPE_STORE_SHUTDOWN = "STORE_SHUTDOWN"
     TYPE_MSTORE_CREATE  = "MSTORE_CREATE_TENANT"
@@ -23,6 +26,7 @@ module FileStore
     TYPE_META_REMOVE    = "META_REMOVE_FILE"
     TYPE_META_RESTORE   = "META_RESTORE_FILE"
     TYPE_META_SHUTDOWN  = "META_SHUTDOWN"
+    TYPE_DAV_SHUTDOWN   = "DAV_SHUTDOWN"
     #
     # Attribute accessors for instance variable defining the type of
     # action

data/lib/filestore/simple_store.rb

@@ -78,7 +78,7 @@ module FileStore
 					(@logger.info("Copying file"); FileUtils.copy_file(file, dstPath))
 				
 				inform ObserverAction.new(:type => ObserverAction::TYPE_STORE_ADD, 
-          :objects => [file, meta], :msg => "Added file to file store") if self.is_a?(ObservedSubject)
+          :objects => { :file => file, :meta => meta }, :msg => "Added file to file store") if self.is_a?(ObservedSubject)
 			rescue Exception => e
 				raise FileStoreException, "Couldn't add file #{file} to store.", e.backtrace
 			end

data/lib/filestore/webdav/webdav.rb

@@ -0,0 +1,211 @@
+#
+# webdav.rb
+#
+# author: Thomas Stätter
+# date: 2014/02/01
+#
+module FileStore::WebDAV
+  #
+  # Class WebDAVException is used to identify errors occuring
+  # in WebDAV connections
+  #
+  class WebDAVException < Exception
+  end
+  #
+  # Class implementing easy accessor to HTTP response headers
+  #
+  class ResponseHeaders
+    attr_reader :headers, :http_version, :status, :response_text
+    #
+    # Initialize new ResponseHeaders instance
+    #
+    # Arguments:
+    #   text: The raw response text
+    #
+    def initialize(text)
+      @headers = {}
+      @http_version = ''
+      @status = -1
+      @response_text = ''
+      
+      parse text
+    end
+    #
+    # Determines wether the reponse body is XML
+    #
+    # Returns:
+    #   true if content type is appilcation/xml, false otherwise
+    #
+    def is_xml?
+      not (@headers['Content-Type'] =~ /^application\/xml.*/).nil?
+    end
+    #
+    # Determines wether the reponse body is HTML
+    #
+    # Returns:
+    #   true if content type is appilcation/html, false otherwise
+    #
+    def is_html?
+      not (@headers['Content-Type'] =~ /^application\/html.*/).nil?
+    end
+    
+    private
+    #
+    # Parse the reponse text
+    #
+    def parse(text)
+      text.split("\n").each do |line|
+        if line =~ /^.*\:.*$/
+          s = line.split(":")
+      
+          key = s[0].strip
+          value = s[1].strip
+      
+          @headers[key] = value
+        else
+          s = line.split
+          
+          @http_version = s[0]
+          @status = s[1].to_i
+          @response_text = s[2]
+        end
+      end
+    end
+  end
+  #
+  # Class implementing a connector to a HTTP resource via WebDAV
+  #
+  class WebDAV
+    include FileStore::Logger
+    
+    attr_reader :host, :port, :protocol, :chunk_size
+    attr_accessor :credentials, :path_prefix
+    
+    @socket = nil
+   
+    def initialize(host,port=80,protocol='HTTP/1.1',chunk=8096)
+      @host = host.to_s
+      @port = port.to_i
+      @protocol = protocol
+      @chunk_size = chunk.to_i
+      @credentials = {}
+    end
+    
+    def encode_credentials
+      Base64.encode64("#{credentials[:user]}:#{credentials[:password]}").strip
+    end
+   
+    def build_header(method, path, content_length = nil)
+      header = "#{method} #{File.join(@path_prefix, path)} #{@protocol} \r\n"
+      header += "Content-Length: #{content_length}\r\n" unless content_length.nil?
+      header += "Host: #{@host}\r\n"
+      header += "Authorization: Basic #{encode_credentials}\r\n" unless @credentials.empty?
+      header += "User-Agent: WebDAV-Client/0.1\r\n"
+      header += "Connection: close\r\n\r\n"
+      
+      return header
+    end
+   
+    def request(method, path)
+      data = {}
+      buf = ''      
+      begin
+        open
+        header = build_header(method, path)
+        
+        if @socket.write(header) == header.length then
+          while line = @socket.gets # Read lines from socket
+            buf += line
+          end
+          
+          data = { 
+            header: ResponseHeaders.new(buf.split("\r\n\r\n")[0]), 
+            body: buf.split("\r\n\r\n")[1] 
+          }
+        else
+          raise WebDAVException.new "Couldn't send request headers"
+        end
+      rescue Exception => e
+        raise WebDAVException.new "Caught exception while sending request. #{e.message}"
+      ensure
+        close
+      end
+      
+      return data
+    end
+    
+    def delete(path)
+      request('DELETE', path)
+    end
+    
+    def propfind(path)
+      request('PROPFIND', path)
+    end
+   
+    def head(path)
+      request('HEAD', path)
+    end
+   
+    def mkcol(path)
+      request('MKCOL', path)
+    end
+   
+    def put(path, local_file, auto_head = true)
+      if !File.exists?(local_file) || !File.readable?(local_file)
+        raise WebDAVException.new "File not exists or not accessible for reading!"
+      end
+   
+      open
+   
+      datalen = File.size(local_file)
+      header = build_header('PUT', path, datalen)
+   
+      begin
+        if @socket.write(header) == header.length then
+          written = 0
+          File.open(local_file,'r') do |f| 
+            until f.eof? do
+              written += @socket.write f.read(@chunk_size)
+            end
+          end
+   
+          if written == datalen
+            close
+            if !auto_head
+              return true
+            else
+              return head(path)
+            end
+          end
+        end
+      rescue Exception => e
+        raise WebDAVException.new "Caught exception in PUT request. #{e.message}"
+      ensure
+        close
+      end
+    end
+    
+    def get(path)
+      request('GET', path)
+    end
+   
+    def open
+      begin 
+        @socket = TCPSocket.open(@host, @port)
+        return true
+      rescue Exception => e
+        raise WebDAVException.new "Caught exception while opening connection. #{e.message}"
+      end
+    end
+   
+    def close
+      begin
+        return @socket.close
+      rescue 
+        return false
+      end
+    end
+    
+  end
+  
+end

data/lib/filestore/webdav_store.rb

@@ -0,0 +1,153 @@
+#
+# webdav_store.rb
+#
+# author: Thomas Stätter
+# date: 2014/02/01
+#
+module FileStore::WebDAV
+	#
+	# Main library class implementing a WebDAV file store used for storing and managing 
+	# arbitrary files
+	#
+	class WebDAVStore
+	  include FileStore::Logger
+		#
+		# Accessors for important properties
+		#
+		attr_reader :host, :port, :root_path, :connection, :user, :password
+		#
+		# Initializes a new instance of SimpleFileStore
+		#
+		# Arguments:
+		# 	root_path: The path where the file store resides
+		#   logger: The logging facility
+		#
+		def initialize(host, port, user, password, root_path = '/', logger = StdoutLogger)
+			@host = host
+			@port = port
+			@user = user
+			@password = password
+			@root_path = root_path
+			
+			initialize_connection
+		end
+		#
+		# Adds a file to the store
+		#
+		# Arguments:
+		# 	file: The file to be stored
+		#
+		# Returns:
+		#	  The file path or nil
+		#
+		def add(file)
+			raise FileStoreException, "File #{file} not found" if not File.exists?(file)
+			raise FileStoreException, "File #{file} isn't readable" if not File.readable?(file)
+			
+			f_path = File.basename file
+			remote_path = File.join @root_path, f_path
+			
+			begin
+				result = @connection.put remote_path, file
+
+				raise "Couldn't upload file, response code isn't of type 2xx" unless (result[:header].status.to_s =~ /2\d{2}/)
+				
+				inform ObserverAction.new(:type => ObserverAction::TYPE_DAV_ADD, 
+          :objects => { :file => remote_path, :meta => meta }, :msg => "Added file to remote file store") if self.is_a?(ObservedSubject)
+			rescue Exception => e
+				raise FileStoreException, "Couldn't put file '#{file}' to remote store URL '#{remote_path}'.\n#{e.backtrace.join("\n")}"
+			end
+			
+			return remote_path
+		end
+		#
+		# Retrieves a file identified by it's path
+		#
+		# Arguments:
+		# 	file: The file path to get from the remote store
+		#
+		# Returns: 
+		#	A hash of file object (:path) and corresponding meta data (:data)
+		#			representing the file in the store
+		#
+		def get(file)
+			raise FileStoreException, "No file given" if file.nil? or file == ''
+			
+			# Retrieve data from the store
+			result = @connection.get file
+			
+			unless result[:body].nil?
+  			inform ObserverAction.new(:type => ObserverAction::TYPE_DAV_GET, 
+          :objects => [file], :msg => "Returning file from the remote store")  if self.is_a?(ObservedSubject)
+          
+        return { :path => file, :data => result[:body] }
+			else
+			  return {}
+			end
+			
+		end
+		#
+		# Deletes a file from the remote store
+		#
+		# Arguments:
+		# 	file: The remote file path
+		#
+		def remove(file)
+			raise FileStoreException, "No file given for removal" if (file == '' or file.nil?)
+			
+			begin
+				result = @connection.delete file
+				
+				if result[:header].status.to_s =~ /2\d{2}/
+  				inform ObserverAction.new(:type => ObserverAction::TYPE_DAV_REMOVE, 
+            :objects => [id], :msg => "Deleted file from remote store") if self.is_a?(ObservedSubject)
+        else
+          raise "Response code isn't of class 2xx"
+        end
+			rescue Exception => e
+				raise FileStoreException, "Couldn't remove file '#{file}' from remote store.\n#{e.message}"
+			end
+		end
+		#
+		# Shuts down the file store
+		#
+		def shutdown
+			@connection.close
+			
+			inform ObserverAction.new(:type => ObserverAction::TYPE_DAV_SHUTDOWN, 
+        :msg => "WebDAV store shutdown")  if self.is_a?(ObservedSubject)
+		end
+		
+		private
+		#
+		# Initialize the HTTP connection
+		#
+		def initialize_connection
+		  @connection = WebDAV.new @host, @port
+		  @connection.credentials = { :user => @user, :password => @password }
+		end
+		#
+		# Creates the directory if it doesn't exist
+		#
+		# Arguments:
+		#   path: The path to be tested or created
+		#
+		def ensure_path(path)
+		  ret = false
+		  remote_path = File.join(@root_path, path)
+		  result = @connection.propfind(remote_path)
+		  
+		  if result[:header].status.to_s =~ /2\d{2}/
+		    # Directory exists
+		    ret = true
+		  else
+		    # Directory must be created
+		    result = @connection.mkcol remote_path
+		    ret = true if (result[:header].status.to_s =~ /2\d{2}/)
+		  end
+		  
+		  ret
+		end
+	end
+
+end

data/test/tc_webdav.rb

@@ -0,0 +1,130 @@
+#
+# tc_webdav.rb
+#
+# @author Thomas Stätter
+# @date 2014/02/01
+# @description Test script
+#
+require './classes.rb'
+require 'test/unit'
+
+include FileStore::WebDAV
+
+class TestWebDAV < Test::Unit::TestCase
+  
+  def setup
+    @host = 'owncloud.strawanzen.at'
+    @credentials = { :user => 'demo', :password => 'demo' }
+    @path = '/files'
+    @test_file = 'testfile.txt'
+    @webdav = WebDAV.new @host
+    @remote_dir = File.join(@path, 'new@dir')
+    
+    @webdav.logger = StdoutLogger
+    @webdav.credentials = @credentials
+    @webdav.path_prefix = '/remote.php/webdav/'
+    
+    File.open(@test_file, "w+") do |f|
+      f.write("lorem ipsum")
+    end
+  end
+  
+  def teardown
+    FileUtils.rm(@test_file) if File.exists?(@test_file)
+  end
+  
+  def test_01_connect
+       puts "=" * 80
+       puts "TestWebDAV::test_connect"
+       puts "=" * 80
+       result = {}
+       
+       assert_nothing_raised(Exception) { result = @webdav.propfind(@path) }
+       assert_not_nil(result[:header])
+       assert_not_nil(result[:body])
+       assert_match(/2\d{2}/, result[:header].status.to_s, "[TestWebDAV::test_connect] Response code isn't of class 2xx")
+       assert(result[:header].is_xml?, "[TestWebDAV::test_connect] Response is not XML")
+  end
+    
+  def test_02_put
+       puts "=" * 80
+       puts "TestWebDAV::test_put"
+       puts "=" * 80
+       
+       # result = {}
+       upload = File.join(@path, @test_file)
+       
+       assert_nothing_raised(WebDAVException) {
+         puts "[TestWebDAV::test_put] Uploading file '#{@test_file}' to '#{upload}'" 
+         result = @webdav.put upload, @test_file
+       }
+       # assert_match(/2\d{2}/, result[:header].status.to_s, "Response code isn't of class 2xx")
+  end
+     
+  def test_03_propfind
+       puts "=" * 80
+       puts "TestWebDAV::test_propfind"
+       puts "=" * 80
+       
+       upload = File.join(@path, @test_file)
+       result = {}
+       
+       assert_nothing_raised(WebDAVException) {
+         puts "[TestWebDAV::test_propfind] Reading info for '#{upload}'" 
+         result = @webdav.propfind upload
+       }
+       assert_match(/2\d{2}/, result[:header].status.to_s, "[TestWebDAV::test_propfind] Response code isn't of class 2xx")
+  end
+     
+  def test_04_mkcol
+       puts "=" * 80
+       puts "TestWebDAV::test_mkcol"
+       puts "=" * 80
+       
+       result = {}
+       
+       assert_nothing_raised(WebDAVException) {
+         puts "[TestWebDAV::test_mkcol] Creating directory file '#{@remote_dir}'" 
+         result = @webdav.mkcol @remote_dir
+       }
+       assert_match(/2\d{2}/, result[:header].status.to_s, "[TestWebDAV::test_mkcol] Response code isn't of class 2xx")
+  end
+  
+  def test_05_get
+    puts "=" * 80
+    puts "TestWebDAV::test_get"
+    puts "=" * 80
+    
+    result = {}
+    remote_file = File.join(@path, @test_file)
+    
+    assert_nothing_raised(WebDAVException) {
+      puts "[TestWebDAV::test_get] Trying to get remote file '#{remote_file}'" 
+      result = @webdav.get remote_file
+      puts "[TestWebDAV::test_get] Got file contents: #{result[:body]}"
+    }
+    assert_match(/2\d{2}/, result[:header].status.to_s, "[TestWebDAV::test_get] Response code isn't of class 2xx")
+    assert_not_nil(result[:body], "[TestWebDAV::test_get] No data given")
+  end
+  
+  def test_06_delete
+    puts "=" * 80
+    puts "TestWebDAV::test_delete"
+    puts "=" * 80
+    
+    upload = File.join(@path, @test_file)
+    result = {}
+    
+    assert_nothing_raised(WebDAVException) {
+      puts "[TestWebDAV::test_delete] Deleting file '#{upload}'" 
+      result = @webdav.delete upload
+    }
+    assert_match(/2\d{2}/, result[:header].status.to_s, "[TestWebDAV::test_delete] Response code isn't of class 2xx")
+    assert_nothing_raised(WebDAVException) {
+      puts "[TestWebDAV::test_delete] Deleting directory '#{@remote_dir}'" 
+      result = @webdav.delete @remote_dir
+    }
+    assert_match(/2\d{2}/, result[:header].status.to_s, "[TestWebDAV::test_delete] Response code isn't of class 2xx")
+  end
+  
+end

data/test/tc_webdav_store.rb

@@ -0,0 +1,109 @@
+#
+# tc_webdav_store.rb
+#
+# @author Thomas Stätter
+# @date 2014/02/01
+# @description Test script
+#
+require './classes.rb'
+require 'test/unit'
+
+include FileStore::WebDAV
+
+class TestWebDAVStore < FileStoreTest
+  
+  def test_01_init_shutdown
+    puts "=" * 80
+    puts "TestWebDAVStore::test_init_shutdown"
+    puts "=" * 80
+    
+    store = nil
+    
+    assert_nothing_raised(FileStoreException) {
+      store = WebDAVStoreFactory::create 'files', 'owncloud.strawanzen.at', '/remote.php/webdav/', 80, 'demo', 'demo'
+    }
+    assert_nothing_raised(FileStoreException) {
+      store.shutdown
+    }
+  end
+  
+  def test_02_observer_registration
+    puts "=" * 80
+    puts "TestWebDAVStore::test_observer_registration"
+    puts "=" * 80
+    
+    store = nil
+    
+    assert_nothing_raised(FileStoreException) {
+      o1 = ObserverClass.new
+      o1.logger = StdoutLogger
+      
+      store = WebDAVStoreFactory::create 'files/', 'owncloud.strawanzen.at', '/remote.php/webdav/', 80, 'demo', 'demo', true
+      
+      store.register o1
+      store.inform "Some test message"
+      store.shutdown
+    }
+  end
+
+  def test_03_actions_with_observer
+    # puts "=" * 80
+    # puts "TestWebDAVStore::test_actions_with_observer"
+    # puts "=" * 80
+  end
+  
+  def test_04_upload
+    puts "=" * 80
+    puts "TestWebDAVStore::test_upload"
+    puts "=" * 80
+    
+    assert_nothing_raised(FileStoreException) {
+      open(@testFileSimple, 'w') do |f|
+        f.write "lorem ipsum"
+      end
+      
+      store = WebDAVStoreFactory::create 'files', 'owncloud.strawanzen.at', '/remote.php/webdav/', 80, 'demo', 'demo'
+      puts "[TestWebDAVStore::test_upload] Trying to upload '#{@testFileSimple}' to remote store"
+      file = store.add @testFileSimple
+      
+      store.shutdown
+      
+      puts "[TestWebDAVStore::test_upload] Added file '#{file}'"
+    }
+  end
+  
+  def test_05_get
+    puts "=" * 80
+    puts "TestWebDAVStore::test_get"
+    puts "=" * 80
+    
+    remote_file = 'files/testfile.txt'
+    
+    assert_nothing_raised(FileStoreException) {
+      store = WebDAVStoreFactory::create 'files', 'owncloud.strawanzen.at', '/remote.php/webdav/', 80, 'demo', 'demo'
+      puts "[TestWebDAVStore::test_get] Trying to upload '#{remote_file}' to remote store"
+      file = store.get remote_file
+      
+      store.shutdown
+      
+      puts "[TestWebDAVStore::test_upload] Got file '#{file}'"
+    }
+  end
+  
+  def test_06_remove
+    puts "=" * 80
+    puts "TestWebDAVStore::test_remove"
+    puts "=" * 80
+    
+    remote_file = 'files/testfile.txt'
+    
+    assert_nothing_raised(FileStoreException) {
+      store = WebDAVStoreFactory::create 'files', 'owncloud.strawanzen.at', '/remote.php/webdav/', 80, 'demo', 'demo'
+      puts "[TestWebDAVStore::test_remove] Trying to delete '#{remote_file}' from remote store"
+      store.remove remote_file
+      
+      store.shutdown
+    }
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filestore
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -46,12 +46,16 @@ files:
 - lib/filestore/multitenant_store.rb
 - lib/filestore/observer.rb
 - lib/filestore/simple_store.rb
+- lib/filestore/webdav/webdav.rb
+- lib/filestore/webdav_store.rb
 - lib/filestore.rb
 - test/classes.rb
 - test/tc_filestore.rb
 - test/tc_meta.rb
 - test/tc_module.rb
 - test/tc_multitenant.rb
+- test/tc_webdav.rb
+- test/tc_webdav_store.rb
 - test/ts_all.rb
 homepage: https://github.com/tstaetter/filestore-gem
 licenses: []
@@ -72,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- gem uuidtools, log4r
+- gem uuidtools
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
@@ -84,4 +88,6 @@ test_files:
 - test/tc_meta.rb
 - test/tc_module.rb
 - test/tc_multitenant.rb
+- test/tc_webdav.rb
+- test/tc_webdav_store.rb
 - test/ts_all.rb