filestore 0.0.2 → 0.0.3

data/lib/filestore.rb

@@ -1,108 +1,297 @@
 #
 # filestore.rb
 # @author Thomas Stätter
-# @date 09.07.2012
-# @description Library using a file system as storage for arbitrary files
+# @date 2012/11/07
+# @description
 #
 
-$:.unshift('.')
-
-require 'uuidtools'
-require 'fileutils'
-require 'action.rb'
+require 'meta_manager.rb'
 require 'log.rb'
-require 'meta.rb'
+require 'etc'
+require 'yaml'
+require 'fileutils'
+require 'uuidtools'
 
 module FileStore
-
+	#
+	# Base exception class used for errors occurring in this module
+	#
 	class FileStoreException < Exception
 	end
-
-	class FileStore
-		@@STORE_ROOT = 'filestore'
-		@@DELETED_ROOT = 'deleted'
-		
-		def initialize(basePath = ".", metaManager)
-			raise FileStoreException, "Invalid base path given" if (basePath.nil? or 
-				not File.exists?(basePath) or
-				not File.directory?(basePath) or
-				not basePath.is_a?(String) or
-				basePath == '')
-		
-			@storePath = File.join(basePath, @@STORE_ROOT)
-			@deletedPath = File.join(basePath, @@DELETED_ROOT)
+	#
+	# Main library class implementing a simple file store used for storing and managing 
+	# arbitrary files
+	#
+	class SimpleFileStore
+		# Name of the lock file
+		STORE_LOCK_FILE = ".locked"
+		# Name of the meta file describing the current file store
+		META_FILE = "filestore.yaml"
+		# The base name of the file store directory
+		STORE_ROOT = 'filestore'
+		# The base name of the directory for storing deleted files
+		DELETED_ROOT = 'deleted'
+		# The base name of the directory storing files extracted from file store by a 
+		# rollback action 
+		ROLLBACK_ROOT = 'rollback'
+		#
+		# Accessors for important properties
+		#
+		attr_reader :metaManager, :rootPath, :storePath, :deletedPath, :rollbackPath, :metaFile
+		#
+		# Initializes a new instance of SimpleFileStore
+		# @param metaManager The meta data manager instance to be used by this store
+		# @param rootPath The path where the file store resides
+		#
+		def initialize(metaManager, rootPath = '.')
+			raise FileStoreException, "Root path already locked" if SimpleFileStore.is_directory_locked?(rootPath)		
+			raise FileStoreException, "FileStore root path #{rootPath} doesn't exist" if not File.directory?(rootPath)
+			raise FileStoreException, "FileStore root path #{rootPath} isn't writable" if not File.writable?(rootPath)
+			raise FileStoreException, "No meta data manager given" if metaManager.nil?
+			raise FileStoreException, "Meta data manager must be of type FileStore::MetaManager" if not metaManager.is_a?(MetaManager)
+			
+			@metaManager = metaManager
+			@rootPath = rootPath
+			@storePath = File.join(@rootPath, STORE_ROOT)
+			@deletedPath = File.join(@rootPath, DELETED_ROOT)
+			@rollbackPath = File.join(@rootPath, ROLLBACK_ROOT)
+			@metaFile = File.join(@rootPath, META_FILE)
+			@locked = false
 			
 			begin
-				FileUtils.mkdir_p(@storePath) if not Dir.exists?(@storePath)
-				FileUtils.mkdir_p(@deletedPath) if not Dir.exists?(@deletedPath)
-			rescue StandardError => e
-				raise FileStoreException, "Couldn't create store directories", e.backtrace
+				# Try to recover existing store
+				SimpleFileStore.recover_store(self)
+			rescue FileStoreException => e
+				# Recovery failed, trying to create the store
+				SimpleFileStore.create_store(self)
 			end
 			
-			# needs no specific exception handling dew to the fact, that the directories
-			# could be created
-			@logger = Log.new(basePath)
+			lock
+		end
+		#
+		# Adds a file to the store
+		# @param file The file to be stored
+		# @param meta Optional meta data to be stored along with the physical file
+		# @param shouldMove Determines wether to original file should be deleted
+		# @returns The newly created ID for the file
+		#
+		def add(file, meta = {}, shouldMove = true)
+			raise FileStoreException, "File #{file} not found" if not File.exists?(file)
+			raise FileStoreException, "File #{file} isn't readable" if not File.readable?(file)
+			raise FileStoreException, "File #{file} can't be removed" if not File.writable?(file)
 			
-			raise FileStoreException, "No meta manager given" if not metaManager.is_a? MetaManager
-			@metaManager = metaManager
+			meta = {} if meta.nil?
+			id = ""
+			
+			begin
+				dir = SimpleFileStore.get_daily_directory(@storePath)
+				Logger.instance.logger.info "Adding file #{file} to directory #{dir}"
+				id = SimpleFileStore.get_id(self)
+				Logger.instance.logger.info "Using file id #{id}"
+				dstPath = File.join(dir, id)
+				Logger.instance.logger.info "Created destination path #{dstPath}"
+			
+				shouldMove ? Logger.instance.logger.info("Moving file") : Logger.instance.logger.info("Copying file")
+				shouldMove ? (FileUtils.mv(file, dstPath)) : (FileUtils.copy_file(file, dstPath))
+			rescue Exception => e
+				raise FileStoreException, "Couldn't add file #{file} to store.", e.backtrace
+			end
+			
+			meta[:path] = dstPath
+			@metaManager.add_or_update(id, meta)
+			
+			return id
 		end
-		
-		def <<(path)
-			id = ''
+		#
+		# Retrieves a file identified by it's ID
+		# @param id The files ID to retrieve
+		# @returns A hash of file object (:path) and corresponding meta data (:data)
+		#			representing the file in the store
+		#
+		def get(id)
+			raise FileStoreException, "No ID given" if id.nil? or id == ''
+			raise FileStoreException, "No file for ID #{id} found" if not @metaManager.has_id?(id)
 			
-			if File.exists?(path) and File.readable?(path) then
-				id = UUIDTools::UUID.random_create.to_s
-				action = AddAction.new(id)
+			md = @metaManager.get_data(id)
+			path = md[:path]
+
+			raise FileStoreException, "No valid meta data found for ID #{id}" if md.nil? or not File.exists?(path)
+			
+			return { :path => File.new(path), :data => md }
+		end
+		#
+		# Moves a file from the current to the deleted store
+		# @param id The ID identifying the file to be moved
+		#
+		def remove(id)
+			raise FileStoreException, "No file ID given for removal" if id == '' or id.nil?
+			raise FileStoreException, "File ID for removal not found in store" if not @metaManager.has_id?(id)
+			
+			file = @metaManager.get_data(id)[:path]
+			
+			begin
+				@metaManager.remove(id)
 				
-				action.execute {
-					dstPath = move(@storePath, id, path)
-					
-					raise "Couldn't move file" if dstPath == ''
-					
-					@metaManager << MetaData.new(id, { MetaData::FIELD_PATH => dstPath })
-				}
+				dir = SimpleFileStore.get_daily_directory(@deletedPath)
+				dstPath = File.join(dir, id)
 				
-				@logger << action
-			else
-				raise FileStoreException, "File is not readable"
+				FileUtils.move(file, dstPath)
+			rescue Exception => e
+				raise FileStoreException, "Couldn't move file #{file} to deleted store.\n#{e.message}"
 			end
-			
-			id
 		end
-		
-		def -(id)
-			if @metaManager[id] != nil then
-				action = DeleteAction.new(id)
-				
-				action.execute {
-					raise "Couldn't move file" if move(@deletedPath, id, @metaManager[id].path) == ''
-					@metaManager - id
-				}
+		#
+		# Restores a file identified by it's id
+		# @param id The file ID
+		#
+		def restore(id)
+			raise FileStoreException, "No file ID given for restore" if id == '' or id.nil?
+			
+			md = @metaManager.restore(id)
+			file = md[:path]
+			
+			begin
+				dir = SimpleFileStore.get_daily_directory(@storePath)
+				dstPath = File.join(dir, id)
 				
-				@logger << action
-			else
-				raise FileStoreException, "Key not found"
+				FileUtils.move(file, dstPath)
+			rescue Exception => e
+				raise FileStoreException, "Couldn't restore file #{file} from deleted store.\n#{e.message}"
+				#
+				# Delete restored entry from metaManager
+				@metaManager.delete(id)
 			end
 		end
+		#
+		# Shuts down the file store
+		#
+		def shutdown
+			@metaManager.shutdown
+			
+			release_lock
+		end
+		#
+		# Determines wether this store is locked
+		#
+		def locked?
+			return @locked
+		end
 		
 		private
 		
-		def move(basePath, id, srcPath)
-			dstPath = ''
+		#
+		# Release the lock from the store
+		#
+		def release_lock
+			begin
+				File.delete File.join(@rootPath, STORE_LOCK_FILE)
+				@locked = false
+			rescue Exception => e
+				raise FileStoreException, "Couldn't release lock from #{@storePath}.\n#{e.message}"
+			end
+		end
+		#
+		# Locks the current instance of file store as well as the corresponding path on
+		# the file system using a hidden file
+		#
+		def lock
+			begin
+				FileUtils.touch File.join(@rootPath, STORE_LOCK_FILE)
+				@locked = true
+			rescue Exception => e
+				raise FileStoreException, "Couldn't lock the store in path #{@storePath}.\n#{e.message}"
+			end
+		end
+		#
+		# Determines wether the store path is already locked by another instance
+		# of SimpleFileStore
+		#
+		def self.is_directory_locked?(rootPath)
+			return File.exists?(File.join(rootPath, SimpleFileStore::STORE_LOCK_FILE))
+		end
+		#
+		# Creates a new file ID
+		# @returns A string representing the file's ID
+		#
+		def self.get_id(store)
+			for i in 0..2 do	
+				id = UUIDTools::UUID.random_create.to_s
+				
+				return id if not store.metaManager.has_id?(id) 
+			end
+			
+			raise FileStoreException, "Couldn't find unique ID"
+		end
+		#
+		# Returns the currently used directory
+		#
+		def self.get_daily_directory(base)
+			date = Date.today
+			dir = File.join(base, date.year.to_s, date.month.to_s, date.day.to_s)
 			
 			begin
-				date = Date.today
-				dstPath = File.join(basePath, date.year.to_s, date.month.to_s, date.day.to_s, id)
-				dstDir = File.dirname(dstPath)
+				FileUtils.mkdir_p(dir) if not File.directory?(dir)
+			rescue Exception => e
+				raise FileStoreException, "Can't create daily directory #{dir}.\n#{e.message}"
+			end
+			
+			raise FileStoreException, "Daily directory #{dir} isn't writable" if not File.writable?(dir)
+			return dir
+		end
+		#
+		# Setup for a new file store directory
+		# @param store The file store instance to set up
+		#
+		def self.create_store(store)
+			Logger.instance.logger.info "Trying to create store in #{store.storePath}"
+			# Try to create needed directories
+			begin
+				FileUtils.mkdir [store.storePath, store.deletedPath, store.rollbackPath]
+			rescue Errno::ENOENT => e
+				raise FileStoreException, "One ore more system directories couldn't be created.\n#{e.message}"
+			end
+			# Try to create hidden meta file
+			begin
+				meta = { :created_at => Date.today.strftime('%d.%m.%Y %H:%M:%S:%L'), 
+					:storePath => store.storePath,
+					:deletedPath => store.deletedPath,
+					:rollbackPath => store.rollbackPath,
+					:created_by => Etc.getlogin
+				}
 				
-				(FileUtils.mkdir_p(dstDir) and puts "creating #{dstDir}") if not Dir.exists?(dstDir)
-				FileUtils.mv(srcPath, dstPath)
+				File.open(store.metaFile, "w+") do |fh|
+					YAML.dump(meta, fh)
+				end
+				
+				#
+				# Creation was successful
+				#
+			rescue Exception => e
+				raise FileStoreException, "Meta file #{store.metaFile} couldn't be created.\n#{e.message}"
+			end
+		end
+		#
+		# Recover an existing file store
+		# @param store The file store instance to recover
+		#
+		def self.recover_store(store)
+			# trying to recover existing file store
+			begin
+				Logger.instance.logger.info "Trying to recover store from #{store.metaFile}"
+				meta = YAML.load_file(store.metaFile)
+				
+				raise FileStoreException, "Store directory not found" if not File.directory?(meta[:storePath])
+				raise FileStoreException, "Deleted directory not found" if not File.directory?(meta[:deletedPath])
+				raise FileStoreException, "Rollback directory not found" if not File.directory?(meta[:rollbackPath])
+				
+				#
+				# Recovery was successful
+				#
 			rescue Exception => e
-				raise FileStoreException, "Couldn't move file", e.backtrace
-			ensure
-				return dstPath
+				raise FileStoreException, "Unable to recover file store from path #{store.rootPath}.\n#{e.message}"
 			end
 		end
+		
 	end
 
 end

data/lib/log.rb

@@ -1,39 +1,28 @@
 #
 # log.rb
 # @author Thomas Stätter
-# @date 09.07.2012
-# @description Library using a file system as storage for arbitrary files
+# @date 2012/11/07
+# @description 
 #
-$:.unshift('.')
-
-require 'filestore.rb'
+require 'date'
+require 'log4r'
+require 'singleton'
 
 module FileStore
-
-	class Log
-		FILE = 'filestore-actions.log'
-		
-		def initialize(path = '.')
-			begin
-				@logPath = File.join(path, FILE)
-				@logFile = File.new(@logPath, 'a+')
-			rescue StandardError => e
-				raise FileStoreException, "Initialization of logger failed", e.backtrace
-			end
-		end
-		
-		def <<(action)
-			return if not action.is_a? Action				
-			
-			@logFile.puts action.to_s
-		end
+	#
+	# Logging facility class
+	#
+	class Logger
+		include Singleton
 		
-		def close
-			begin
-				@logFile.close
-			rescue StandardError => e
-				raise FileStoreException, "Couldn't properly close the logger", e.backtrace
-			end
+		attr_reader :logger
+		#
+		# Creates a new logging facility
+		#
+		def initialize
+			@logger = Log4r::Logger.new 'FileStore'
+			@logger.outputters = Log4r::StdoutOutputter.new(:level => Log4r::WARN, 
+                    	:formatter => Log4r::PatternFormatter.new(:pattern => "[%l] %d - %m"))
 		end
 	end
 

data/lib/memory_meta.rb

@@ -0,0 +1,104 @@
+#
+# memory_meta.rb
+# @author Thomas Stätter
+# @date 2012/11/08
+# @description
+#
+require 'yaml'
+require 'filestore.rb'
+require 'meta_manager.rb'
+require 'log.rb'
+
+module FileStore
+	#
+	# Class implementing a memory based MetaManager
+	#
+	class MemoryMetaManager < MetaManager
+		# Constant defining the default file path
+		@@FILE = './meta.yaml'
+		# Accessor for the file to store data to
+		attr_reader :file
+		#
+		# Creates a new instance of MemoryMetaManager
+		# @param persistentFile The file where the manager class is persisted to
+		#
+		def initialize(persistentFile = '')
+			@data = Hash.new
+			@removed = Hash.new
+			@file = (persistentFile.nil? or persistentFile == '')? @@FILE : persistentFile
+			
+			begin
+				if File.exists?(@file)
+					Logger.instance.logger.info "loading meta yaml from #{@file}"
+					@mm = YAML.load_file(@file) if File.exists?(@file)
+					Logger.instance.logger.info "Loaded meta yaml: #{@mm}"
+					@data = @mm[:current]
+					@removed = @mm[:removed]
+				else
+					Logger.instance.logger.info "Creating new meta store in #{@file}"
+				end
+			rescue Exception => e
+				raise FileStoreException, "Couldn't load meta data from file #{@file}"				
+			end
+				
+		end
+		#
+		# @see MetaManager::get_data
+		#
+		def get_data(id)
+			raise FileStoreException, "No meta data available for ID #{id}" if not @data.key?(id)
+			
+			return @data[id]
+		end
+		#
+		# @see MetaManager::add_or_update
+		#
+		def add_or_update(id, metaData)
+			raise FileStoreException, "Only hashsets can be added" if not metaData.is_a?(Hash)
+			raise FileStoreException, "Only Strings can be used as keys" if not id.is_a?(String)
+			
+			@data[id] = (@data.key?(id) ? @data[id].merge!(metaData) : @data[id] = metaData)
+		end
+		#
+		# @see MetaManager::remove
+		#
+		def remove(id)
+			raise FileStoreException, "Only Strings can be used as keys" if not id.is_a?(String)
+			raise FileStoreException, "ID #{id} not found in meta store" if not @data.key?(id)
+			
+			@removed[id] = @data[id]
+			@data.delete(id)
+		end
+		#
+		# @see MetaManager::restore
+		#
+		def restore(id)
+			raise FileStoreException, "Only Strings can be used as keys" if not id.is_a?(String)
+			raise FileStoreException, "ID #{id} not found in deleted meta store" if not @removed.key?(id)
+			
+			@data[id] = @removed[id]
+			@removed.delete(id)
+		end
+		#
+		# see MetaManager::shutdown
+		#
+		def shutdown
+			begin
+				File.open(@file, "w+") do |fh|
+					YAML.dump({:current => @data, :removed => @removed}, fh)
+				end
+				
+				@data = nil
+			rescue Exception => e
+				raise FileStoreException, "Couldn't serialize meta manager to file #{@file}.\n#{e.message}"
+			end
+		end
+		#
+		# @see MetaManager::has_id?
+		#
+		def has_id?(id)
+			@data.key?(id)
+		end
+	end
+
+end

data/lib/meta_manager.rb

@@ -0,0 +1,53 @@
+#
+# meta_manager.rb
+# @author Thomas Stätter
+# @date 2012/11/08
+# @description
+#
+
+module FileStore
+	#
+	# Base class for implementing a meta manager class. This class is used for storing
+	# and managing file meta data
+	#
+	class MetaManager
+		#
+		# Returns the data set identified by the given id
+		# @param ID The ID to be looked for
+		# @returns A hashset containing all stored meta data
+		#
+		def get_data(id)
+		end
+		#
+		# Removes a dataset from the collection
+		# @param id The key to identify the data to be deleted
+		#
+		def remove(id)
+		end
+		#
+		# Restores a previously deleted meta data set
+		# @param id The ID of the meta data set to be restored
+		#
+		def restore(id)
+		end
+		#
+		# Adds/updates a dataset to/in the collection
+		# @param id The key to identify the data
+		# @param metaData The actual meta data to store
+		#
+		def add_or_update(id, metaData)
+		end
+		#
+		# Shuts down the manager class and clears all used resources
+		#
+		def shutdown
+		end
+		#
+		# Determines wether a given ID is already in use
+		# @param id The ID to be tested
+		#
+		def has_id?(id)
+		end
+	end
+
+end

data/lib/multitenant_filestore.rb

@@ -0,0 +1,148 @@
+#
+# multitenant_filestore.rb
+# @author Thomas Stätter
+# @date 2012/11/21
+# @description
+#
+
+require 'filestore.rb'
+require 'memory_meta.rb'
+require 'log.rb'
+require 'uuidtools'
+require 'fileutils'
+require 'yaml'
+
+module FileStore
+	#
+	# Class implementing a multitenant file store
+	#
+	class MultiTenantFileStore
+		attr_reader :stores
+		#
+		# Initializes a new instance of MultiTenantFileStore
+		# @rootPath The path where all file stores are located
+		#
+		def initialize(rootPath = '.')
+			raise FileStoreException, "Given root path isn't accessable" if not File.directory?(rootPath)
+			
+			@rootPath = rootPath
+			@stores = MultiTenantFileStore.recover(rootPath)
+		end
+		#
+		# Creates a new file store for a tenant
+		# @param id The optional ID of the tenant. If omitted, an ID will be created
+		#			automatically
+		# @returns The tenants ID
+		#
+		def create_tenant_store(id = '')
+			id = UUIDTools::UUID.random_create.to_s if id == '' or id.nil?
+			
+			begin
+				path = File.join(@rootPath, id)
+				FileUtils.mkdir path
+				mm = MemoryMetaManager.new(File.join(path, "meta.yaml"))
+				sfs = SimpleFileStore.new(mm, path)
+			
+				@stores[id] = sfs
+			rescue Exception => e
+				raise FileStoreException, "Couldn't create multitenant store.\n#{e.message}"
+			end
+			
+			return id
+		end
+		#
+		# Permanently removes a tenant's store
+		# @param id The tenant's ID
+		#
+		def remove_tenant_store(id)
+			raise FileStoreException, "Tenant #{id} can't be removed. Not registered." if not @stores.key?(id)
+			
+			begin
+				@stores.delete(id)
+				FileUtils.remove_dir File.join(@rootPath, id)
+			rescue Exception => e
+				raise FileStoreException, "Couldn't delete tenant #{id}.\n#{e.message}"
+			end
+		end
+		#
+		# Returns the complete file store for a given tenant
+		# @param id The tenant's id
+		# @returns An instance of FileStore::SimpleFileStore
+		#
+		def get_tenant_store(id)
+			raise FileStoreException, "Tenant #{id} not registered. No file store given." if not @stores.key?(id)
+			
+			return @stores[id]
+		end
+		#
+		# Adds a file to the tenant's store
+		# @param tenant The tenant's ID
+		# @param file The file to be added
+		# @param md Optional meta data
+		#
+		def add_to_tenant(tenant, file, md = {})
+			raise FileStoreException, "Tenant #{id} not registered. File can't be added." if not @stores.key?(tenant)
+			
+			@stores[tenant].add(file, md)
+		end
+		#
+		# Removes a file from the tenant's store
+		# @param tenant The tenant's ID
+		# @param id The ID of the file to be removed
+		#
+		def remove_from_tenant(tenant, id)
+			raise FileStoreException, "Tenant #{id} not registered. File can't be removed." if not @stores.key?(tenant)
+			
+			@stores[tenant].remove(id)
+		end
+		#
+		# Retrieves a file from the tenant's store
+		# @param tenant The tenant's ID
+		# @param id The file's ID
+		# @returns A hash containing the file object (:path) and the corresponding meta
+		# 			data (:data)
+		#
+		def get_from_tenant(tenant, id)
+			raise FileStoreException, "Given tenant #{tenant} isn't registered" if not @stores.key?(tenant)
+			
+			return @stores[tenant].get(id)
+		end
+		#
+		# Shuts down this multitenant store
+		#
+		def shutdown
+			# Shut down any tenant store
+			@stores.values.each do |s|
+				s.shutdown
+			end
+		end
+		
+		private
+		#
+		# Recovers a multitenant store
+		# @param rootPath The base path of the multitenant store
+		#
+		def self.recover(rootPath)
+			raise FileStoreException, "Root path #{rootPath} isn't a valid multitenant store" if not File.directory?(rootPath)
+			
+			stores = {}
+			
+			Dir.glob(File.join(rootPath, "*")).each { |e|
+				begin
+					if File.directory?(e)
+						tenant = File.basename(e)
+						mm = MemoryMetaManager.new(File.join(e, "meta.yaml"))
+						sfs = SimpleFileStore.new(mm, e)
+				
+						stores[tenant] = sfs
+					end
+				rescue Exception => e
+					Logger.instance.logger.error "Couldn't create store for tenant #{tenant}.\n#{e.message}"
+				end
+			}
+			
+			return stores
+		end
+	end
+
+end

data/test/tc_filestore.rb

@@ -1,60 +1,31 @@
-#!/usr/bin/env ruby
 #
 # tc_filestore.rb
 # @author Thomas Stätter
-# @date 10.07.2012
-# @description Unit test for classes in filestore.rb
+# @date 2012/11/14
+# @description Test script
 #
-# execute test using: ruby -I ../lib/ tc_filestore.rb
+# call: ruby -I ../lib/ tc_filestore.rb
+#
+require_relative '../lib/filestore.rb'
+require_relative '../lib/memory_meta.rb'
+
+include FileStore
+
+basePath = "/Users/thomas/Documents/DEV/ruby/FileStoreGEM/test/store_test"
+testFile = "/Users/thomas/Documents/DEV/ruby/FileStoreGEM/test/testfile.txt"
+
+begin
+	mm = MemoryMetaManager.new(File.join(basePath, "meta.yaml"))
+	sfs = SimpleFileStore.new(mm, basePath)
+	id = sfs.add(testFile, {:hugo => 'boss'}, false)
 
-require "test/unit"
-require '../lib/filestore.rb'
+	puts id
+	puts "Enter something to finish"
+	enter = gets 
 
-class TestFileStore < Test::Unit::TestCase
-	BASE_PATH = "./data"
-	
-	def test_init
-		# should work
-		assert_nothing_raised { FileStore::FileStore.new(BASE_PATH, FileStore::MemoryMetaManager.new {{}}) }
-		# shouldn't work, invalid path
-		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new("/some/invalid/path", FileStore::MemoryMetaManager.new {{}}) }
-		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new("", FileStore::MemoryMetaManager.new {{}}) }
-		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new(nil, FileStore::MemoryMetaManager.new {{}}) }
-		# shouldn't work, invalid MetaManager
-		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new(BASE_PATH, {}) }
-		assert_raise(FileStore::FileStoreException) { FileStore::FileStore.new(BASE_PATH, nil) }
-	end
-	
-	def test_add
-		mm = FileStore::MemoryMetaManager.new {
-			data = {}
-			
-			Dir.glob(File.join(BASE_PATH, "**", "*")).each { |f|
-				if not File.directory?(f) and File.basename(f) != FileStore::Log::FILE then
-					data[File.basename(f)] = File.absolute_path(f)
-				end
-			}
-			
-			data
-		}
-		fs = FileStore::FileStore.new(BASE_PATH, mm)
-		id = fs << './move_from/test-file-to-move'
-	
-		assert_not_nil(id, "Returned ID can't be nil")	
-		assert_not_same(id, '', "Returned ID can't be empty")
-		assert_instance_of(String, id, "Weird ID returned: #{id}")
-		# should raise an exception
-		assert_raise(FileStore::FileStoreException) { fs << '/some/invalid/file' }
-		
-		# restore the test file
-		`touch ./move_from/test-file-to-move`
-	end
-	
-	def test_remove
-		fs = FileStore::FileStore.new(BASE_PATH, FileStore::MemoryMetaManager.new {{}})
-		
-		# should raise an exception
-		assert_raise(FileStore::FileStoreException) { fs - 'adsfasdf' }
-	end
-	
+	sfs.remove(id)
+	sfs.shutdown
+rescue Exception => e
+	puts e
+	sfs.shutdown if not sfs.nil?
 end

data/test/tc_multitenant.rb

@@ -0,0 +1,29 @@
+#
+# tc_multitenant.rb
+# @author Thomas Stätter
+# @date 2012/11/21
+# @description Test script
+#
+# call: ruby -I ../lib/ tc_multitenant.rb
+#
+require_relative '../lib/multitenant_filestore.rb'
+require 'fileutils'
+
+include FileStore
+
+basePath = "/Users/thomas/Documents/DEV/ruby/FileStoreGEM/test/multi_store_test"
+testFile = "/Users/thomas/Documents/DEV/ruby/FileStoreGEM/test/testfile.txt"
+
+begin
+	mtfs = MultiTenantFileStore.new basePath
+	tenant = mtfs.create_tenant_store
+	mtfs.add_to_tenant tenant, testFile, { :hugo => "boss" }
+	
+	puts mtfs.stores
+	mtfs.shutdown
+rescue Exception => e
+	puts e
+	puts e.backtrace
+end
+
+FileUtils.touch testFile

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filestore
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
@@ -33,6 +33,28 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.10
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Organizes a file storage using the file system and some meta data
 email: thomas.staetter@gmail.com
 executables: []
@@ -40,15 +62,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/filestore.rb
-- lib/action.rb
+- lib/memory_meta.rb
 - lib/log.rb
-- lib/meta.rb
-- test/ts_gem.rb
-- test/tc_action.rb
-- test/tc_log.rb
-- test/tc_meta.rb
+- lib/meta_manager.rb
+- lib/multitenant_filestore.rb
 - test/tc_filestore.rb
-- test/move_from/test-file-to-move
+- test/tc_multitenant.rb
 homepage: https://www.xing.com/profile/thomas.staetter
 licenses: []
 post_install_message: 
@@ -68,16 +87,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- gem uuidtools
+- gem uuidtools, log4r
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple file storage
 test_files:
-- test/ts_gem.rb
-- test/tc_action.rb
-- test/tc_log.rb
-- test/tc_meta.rb
 - test/tc_filestore.rb
-- test/move_from/test-file-to-move
+- test/tc_multitenant.rb

data/lib/action.rb

@@ -1,56 +0,0 @@
-#
-# action.rb
-# @author Thomas Stätter
-# @date 09.07.2012
-# @description Library using a file system as storage for arbitrary files
-#
-$:.unshift('.')
-
-require 'filestore.rb'
-
-module FileStore
-
-	class Action
-		@@DATE_FORMAT = '%d.%m.%Y %H:%M:%S:%L'
-		
-		@@STATUS_NOT_STARTED 	= "NOT STARTED"
-		@@STATUS_SUCCESS 		= "SUCCESS"
-		@@STATUS_FAILURE		= "FAILURE"
-		
-		@type = 'UNDEFINED'
-		
-		def initialize(id)
-			raise FileStoreException, "No identifier given for action" if id.nil?
-			raise FileStoreException, "Identifier can only be of type String or Numeric" if (not id.is_a?(String) and not id.is_a?(Numeric))
-			raise FileStoreException, "Identifier can't be empty" if id.is_a?(String) and id == ''
-			
-			@identifier = id
-			@status = @@STATUS_NOT_STARTED
-		end
-		
-		def execute(&block)
-			@start = Date.today.strftime @@DATE_FORMAT
-			
-			begin
-				block.call
-				@end = Date.today.strftime @@DATE_FORMAT
-			rescue Exception => e
-				@status = @@STATUS_FAILURE
-				raise FileStoreException, 'Caught exception while executing action', e.backtrace
-			else
-				@status = @@STATUS_SUCCESS
-			end
-		end
-		
-		def to_s
-			"#{@status} - #{@start} - #{self.class.name} - #{@msg} - #{@end} - #{@identifier}"
-		end
-	end
-	
-	class AddAction < Action
-	end
-	
-	class DeleteAction < Action
-	end
-
-end

data/lib/meta.rb

@@ -1,81 +0,0 @@
-#
-# meta.rb
-# @author Thomas Stätter
-# @date 10.07.2012
-# @description Library using a file system as storage for arbitrary files
-#
-$:.unshift('.')
-
-require 'filestore.rb'
-
-module FileStore
-
-	class MetaManager
-		
-		def initialize 
-			yield 
-		end
-		
-		def <<(md)
-		end
-		
-		def -(id)
-		end
-		
-	end
-	
-	class MemoryMetaManager < MetaManager
-		
-		def initialize
-			# must be a hash object
-			@mgmt = super
-			
-			raise FileStoreException, "MemoryMetamanager needs a not nil hash object for initialization" if not @mgmt.is_a?(Hash) or @mgmt.nil?
-		end
-		
-		def <<(md)
-			raise FileStoreException, "Can't add 'nil' to the store" if md.nil?
-			raise FileStoreException, "Only objects of type 'FileStore::MetaData' can be added to the store" if not md.instance_of?(MetaData)
-			
-			@mgmt[md.key] = md
-		end
-		
-		def -(id)
-			raise FileStoreException, "Can't remove 'nil' from the store" if id.nil?
-			
-			@mgmt.delete(id) if @mgmt.has_key?(id)
-		end
-		
-		def [](id)
-			raise FileStoreException, "Can't read 'nil' from the store" if id.nil?
-			
-			return @mgmt[id] if @mgmt.has_key?(id)
-			nil
-		end
-		
-	end
-	
-	class MetaData
-		FIELD_PATH 		= 'path'
-		FIELD_FILENAME 	= 'filename'
-	
-		attr_reader :key, :data
-	
-		def initialize(key, data)
-			raise FileStoreException, "No identifier given for meta data" if key.nil?
-			raise FileStoreException, "Identifier can only be of type String or Numeric" if (not key.is_a?(String) and not key.is_a?(Numeric))
-			raise FileStoreException, "No data given" if data.nil?
-			raise FileStoreException, "Data can only be of type Hash" if not data.is_a?(Hash)
-			raise FileStoreException, "Identifier can't be empty" if key.is_a?(String) and key == ''
-			
-			@key = key
-			@data = data
-		end
-		
-		def path
-			@data[FIELD_PATH]
-		end
-				
-	end
-
-end

data/test/tc_action.rb

@@ -1,48 +0,0 @@
-#!/usr/bin/env ruby
-#
-# tc_action.rb
-# @author Thomas Stätter
-# @date 10.07.2012
-# @description Unit test for classes in meta.rb
-#
-
-# execute test using: ruby -I ../lib/ tc_action.rb
-
-require "test/unit"
-require "../lib/filestore.rb"
-
-class TestAction < Test::Unit::TestCase
-
-	def test_init
-		# initialization of an instance of FileStore::Action should raise an
-		# exception if no identifier is given or the identifier is not a string or
-		# numeric
-		assert_raise(FileStore::FileStoreException, ArgumentError) { FileStore::Action.new }
-		assert_raise(FileStore::FileStoreException, ArgumentError) { FileStore::Action.new(nil) }
-		assert_raise(FileStore::FileStoreException, ArgumentError) { FileStore::Action.new([]) }
-		# identifier can't be an empty string if it's a String
-		assert_raise(FileStore::FileStoreException) { FileStore::Action.new('') }
-		assert_nothing_raised(Exception) { FileStore::Action.new("asdf") }
-		assert_nothing_raised(Exception) { FileStore::Action.new(213123) }
-	end
-	
-	def test_execute
-		# execution should fail if no block is given
-		assert_raise(TypeError, FileStore::FileStoreException) {
-			action = FileStore::Action.new("asdf")
-			action.execute
-		}
-	end
-	
-	def test_string
-		# execution shouldn't fail in any case
-		assert_nothing_raised(Exception) { FileStore::Action.new("asdf").to_s }
-		assert_nothing_raised(Exception) { FileStore::Action.new(123).to_s }
-		assert_nothing_raised(Exception) { 
-			action = FileStore::Action.new("asdf")
-			action.execute {}
-			action.to_s
-		}
-	end
-
-end

data/test/tc_log.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/env ruby
-#
-# tc_log.rb
-# @author Thomas Stätter
-# @date 10.07.2012
-# @description Unit test for classes in log.rb
-#
-
-# execute test using: ruby -I ../lib/ tc_log.rb
-
-require "test/unit"
-require "../lib/filestore.rb"
-
-class TestLog < Test::Unit::TestCase
-	
-	def test_init
-		# should be working, default path would be '.'
-		assert_nothing_raised { FileStore::Log.new }
-		# should raise an error, because the path is invalid
-		assert_raise(FileStore::FileStoreException){ FileStore::Log.new('/some/invalid/path')  }
-	end
-	
-	def test_log
-		# shouldn't raise any error (but nothing will happen to the log)
-		logger = FileStore::Log.new
-		
-		assert_nothing_raised { 
-			logger << "asdf" 
-			logger << 2343
-			logger << []
-			logger << FileStore::DeleteAction.new("asdf")
-		}
-	end
-	
-	def test_close
-		logger = FileStore::Log.new
-		
-		assert_nothing_raised { logger.close }
-	end
-end

data/test/tc_meta.rb

@@ -1,101 +0,0 @@
-#!/usr/bin/env ruby
-#
-# tc_meta.rb
-# @author Thomas Stätter
-# @date 10.07.2012
-# @description Unit test for classes in meta.rb
-#
-
-# execute test using: ruby -I ../lib/ tc_meta.rb
-
-require "test/unit"
-require "../lib/filestore.rb"
-
-# Test cases for FileStore::MetaData
-class TestMetaData < Test::Unit::TestCase
-	def test_init
-		# arguments 'key' and 'data' must be provided
-		assert_raise(ArgumentError) { FileStore::MetaData.new }
-		# argument 'key' must be of type String or Numeric
-		assert_raise(FileStore::FileStoreException) { FileStore::MetaData.new({},{}) }
-		assert_nothing_raised(FileStore::FileStoreException) { FileStore::MetaData.new('asdf',{}) }
-		assert_nothing_raised(FileStore::FileStoreException) { FileStore::MetaData.new(234,{}) }
-		# identifier may not be an empty string
-		assert_raise(FileStore::FileStoreException) { FileStore::MetaData.new('',{}) }
-		# data argument may not be nil
-		assert_raise(FileStore::FileStoreException) { FileStore::MetaData.new('asdf',nil) }
-	end
-	
-	def test_accessors
-		# attr_readers for key and data may not return nil
-		md = FileStore::MetaData.new(234,{})
-		
-		assert_not_nil(md.key, "Key can't be nil")
-		assert_not_nil(md.data, "Key can't be nil")
-	end
-	
-	def test_path
-		md = FileStore::MetaData.new(234,{ FileStore::MetaData::FIELD_PATH => '/some/path' })
-		# path may only return a string
-		assert_instance_of(String, md.path, "Path can only be of type string")
-		
-		md = FileStore::MetaData.new(234,{})
-		# path may be nil
-		assert_nil(md.path, "Path is not given although it should be there")
-	end
-end
-
-# Test cases for FileStore::MetaManager
-class TestMetaManager < Test::Unit::TestCase
-	def test_init
-		# should raise a type error if no initialize code is given
-		assert_raise(LocalJumpError) { FileStore::MetaManager.new }
-		assert_nothing_raised(Exception) { FileStore::MetaManager.new {} }
-	end
-end
-
-# Test cases for FileStore::MemoryMetaManager
-class TestMemoryMetaManager < Test::Unit::TestCase
-	def test_init
-		# the init block may only return a not nil hash object 
-		assert_raise(FileStore::FileStoreException){ FileStore::MemoryMetaManager.new {""} }
-		assert_raise(FileStore::FileStoreException){ FileStore::MemoryMetaManager.new { } }
-		assert_nothing_raised(FileStore::FileStoreException){ FileStore::MemoryMetaManager.new {{}} }
-	end
-	
-	def test_add
-		mm = FileStore::MemoryMetaManager.new {{}}
-		
-		assert_raise(FileStore::FileStoreException){ mm << nil }
-		assert_raise(FileStore::FileStoreException){ mm << "asdfasdf" }
-		assert_nothing_raised(FileStore::FileStoreException){ 
-			md = FileStore::MetaData.new(234,{})
-			mm << md
-		}
-	end
-	
-	def test_remove
-		mm = FileStore::MemoryMetaManager.new {{}}
-		
-		assert_raise(FileStore::FileStoreException){ mm - nil }
-		assert_nothing_raised(Exception){ 
-			mm - "asdf"
-			mm - 123123
-			mm - []
-			mm - {}
-			mm - FileStore::MetaData.new(234,{})
-		}
-	end
-	
-	def test_read
-		mm = FileStore::MemoryMetaManager.new {{}}
-		
-		assert_raise(FileStore::FileStoreException){ mm[nil] }
-		assert_nothing_raised(Exception){ 
-			mm[[]] 
-			mm["asdf"]
-			mm[2421]
-		}
-		assert_nil(mm[2343], "Nil wasn't returned althought the given key wasn't existing")
-	end
-end

data/test/ts_gem.rb

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-#
-# ts_gem.rb
-# @author Thomas Stätter
-# @date 10.07.2012
-# @description Test suite for the complete gem
-#
-
-# execute test using: ruby -I../lib/ -I. ts_gem.rb
-$:.unshift('.')
-$:.unshift('../lib')
-
-require "test/unit"
-require 'tc_action.rb'
-require 'tc_meta.rb'
-require 'tc_log.rb'
-require 'tc_filestore.rb'