em-ftpd-fsd 0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+group :development do
+  gem 'yard', '~> 0.8.2.1'
+  gem 'redcarpet', '~> 2.2.2'
+  gem 'jeweler', '~> 1.8.4'
+end
+
+group :test do
+  gem 'rspec', '~> 2.12.0'
+  gem 'simplecov', '~> 0.7.1'
+end

data/README.md

@@ -0,0 +1,21 @@
+# Event Machine FTPD File System Driver
+em-ftpd-fsd is a simple driver to be used with EventMachine FTP gem (em-ftpd) that use
+file system as a persistence layer.
+
+It implements basic ftp operations, authentication and callbacks (before and after)
+
+# Usage
+To use the driver, first you have to create a class that includes EM::FTPD::FSD::Base class.
+
+    require 'em-ftpd-fsd'
+
+    class BasicDriver
+      include EM::FTPD::FSD::Base
+    end
+
+Then you can create a configuration file for em-ftpd as usual using that class as driver.
+
+# EM-FTPD
+EM-FTP is not required by this driver explicitly, you have to require it or add it to your Gemfile.
+By now, em-ftpd has no activity and many forks has been created so you can pick any existing repository
+not only the offically supported gem.

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "em-ftpd-fsd"
+  gem.homepage = "https://github.com/nanocity/em-ftpd-fsd"
+  gem.license = "GPLv3"
+  gem.summary = %Q{File System Driver for EM-FTPD server}
+  gem.description = %Q{Very simple file system driver for EM-FTPD server; including common FTP commands, authentication and before and after operation hooks.}
+  gem.email = "lciudad@nosolosoftware.biz"
+  gem.authors = ["Luis Ciudad"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'yard'
+YARD::Rake::YardocTask.new( :doc ) do |t|
+  t.options = [ "-m", "markdown", "-r", "README.md" ]
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new( :spec )

data/VERSION

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

data/em-ftpd-fsd.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "em-ftpd-fsd"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luis Ciudad"]
+  s.date = "2012-11-15"
+  s.description = "Very simple file system driver for EM-FTPD server; including common FTP commands, authentication and before and after operation hooks."
+  s.email = "lciudad@nosolosoftware.biz"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".simplecov",
+    "COPYING",
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "em-ftpd-fsd.gemspec",
+    "lib/em-ftpd-fsd.rb",
+    "lib/em-ftpd-fsd/authentication/plain.rb",
+    "lib/em-ftpd-fsd/base.rb",
+    "lib/em-ftpd-fsd/directory_item.rb",
+    "lib/em-ftpd-fsd/file_operations.rb",
+    "lib/em-ftpd-fsd/hooks.rb",
+    "spec/base_spec.rb",
+    "spec/file_operations/authentication_spec.rb",
+    "spec/file_operations/bytes_spec.rb",
+    "spec/file_operations/change_dir_spec.rb",
+    "spec/file_operations/delete_dir_spec.rb",
+    "spec/file_operations/delete_file_spec.rb",
+    "spec/file_operations/dir_contents_spec.rb",
+    "spec/file_operations/get_file_spec.rb",
+    "spec/file_operations/make_dir_spec.rb",
+    "spec/file_operations/put_file_spec.rb",
+    "spec/file_operations/rename_spec.rb",
+    "spec/hooks_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/files_helper.rb"
+  ]
+  s.homepage = "https://github.com/nanocity/em-ftpd-fsd"
+  s.licenses = ["GPLv3"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "File System Driver for EM-FTPD server"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, ["~> 0.8.2.1"])
+      s.add_development_dependency(%q<redcarpet>, ["~> 2.2.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<yard>, ["~> 0.8.2.1"])
+      s.add_dependency(%q<redcarpet>, ["~> 2.2.2"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<yard>, ["~> 0.8.2.1"])
+    s.add_dependency(%q<redcarpet>, ["~> 2.2.2"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/lib/em-ftpd-fsd.rb

@@ -0,0 +1,23 @@
+# This file is part of em-ftpd-fsd.
+#
+# em-ftpd-fsd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# em-ftpd-fsd is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with em-ftpd-fsd.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'fileutils'
+
+require 'em-ftpd-fsd/authentication/plain'
+
+require 'em-ftpd-fsd/file_operations'
+require 'em-ftpd-fsd/directory_item'
+require 'em-ftpd-fsd/hooks'
+require 'em-ftpd-fsd/base'

data/lib/em-ftpd-fsd/authentication/plain.rb

@@ -0,0 +1,46 @@
+# This file is part of em-ftpd-fsd.
+#
+# em-ftpd-fsd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# em-ftpd-fsd is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with em-ftpd-fsd.  If not, see <http://www.gnu.org/licenses/>.
+
+module EM
+  module FTPD
+    module FSD
+
+      # Holds different authentication mechanisims
+      module Authentication
+
+        # Simple plain authentication
+        module Plain
+
+          # Configure the authentication module
+          # @param [Hash] opts
+          # @option opts user Username
+          # @option opts password Password
+          def configure_authentication( opts )
+            @auth_user     = opts[:user]
+            @auth_password = opts[:password]
+          end
+
+          # Check if stored username and password validates given user and password
+          # @param [String] user Username
+          # @param [String] password Password
+          # @yield [Boolean] True if username and password are correct
+          def authenticate( user, password, &block )
+            yield ( @auth_user == user && @auth_password == password )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/em-ftpd-fsd/base.rb

@@ -0,0 +1,144 @@
+# This file is part of em-ftpd-fsd.
+#
+# em-ftpd-fsd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# em-ftpd-fsd is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with em-ftpd-fsd.  If not, see <http://www.gnu.org/licenses/>.
+
+# Event Machine
+module EM
+
+  # File Transport Protocol Driver
+  module FTPD
+
+    # File System Driver
+    module FSD
+
+      # Base module to include in custom drivers
+      module Base
+
+        # Supported FTP commands.
+        COMMANDS = {
+          bytes:        { on_error_value: nil   },
+          dir_contents: { on_error_value: nil   },
+          get_file:     { on_error_value: nil   },
+          change_dir:   { on_error_value: false },
+          delete_dir:   { on_error_value: false },
+          delete_file:  { on_error_value: false },
+          rename:       { on_error_value: false },
+          make_dir:     { on_error_value: false },
+          put_file:     { on_error_value: false },
+        }
+
+        # Extend hooks module to load 'before' and 'after' class functions
+        def self.included( klass )
+          klass.extend( EM::FTPD::FSD::Hooks )
+        end
+
+        # Initiliaze the driver with basic options
+        # @param [Hash] options Options
+        # @option options base_path Base directory for FTP server
+        # @option options authentication Authentication module to load
+        # @example Default options for authentication
+        #   {
+        #     plain: {
+        #       user:     "admin",
+        #       password: "root"
+        #     }
+        #   }
+        def initialize( options = {} )
+          opts = {
+            base_path: Dir.pwd,
+            authentication: {
+              plain: {
+                user:     "admin",
+                password: "root"
+              }
+            }
+          }.merge( options )
+
+          load_auth_module( opts[:authentication] )
+
+          @base_path = opts[:base_path]
+        end
+
+        # Absolute path to FTP base directory.
+        # @return [String] Full path to FTP base folder.
+        def base_path
+          File.expand_path( @base_path || "" )
+        end
+
+        # Metaprogrammed redirection to FTP commands defined by FileOperation class.
+        # @param [Symbol] method Method called
+        # @param [Array] args All arguments received by called method
+        # @param [Block] block Block to be yield by called method
+        # @raise [NoMethodError] if method is not supported by driver
+        # @raise [ArgumentError] if no block is passed to yield value
+        # @yield [Object] Return value from file specific operation
+        def method_missing( method, *args, &block )
+          raise NoMethodError, "#{method}"    unless COMMANDS.include?( method )
+          raise ArgumentError, "Block needed" unless block_given?
+
+          yield ftp_methods( method, args )
+        end
+
+        # Return true if obj respond to given method or method correspond to an
+        # implemented ftp command.
+        # @param [Symbol] method Given method
+        # @return [Boolean] Return true if obj respond to given method.
+        def respond_to?( method, include_private = false )
+          super( method, include_private ) || COMMANDS.include?( method )
+        end
+
+        private
+
+        def ftp_methods( method, args )
+          # We have to map each ftp path to a local file system path to check 
+          # permissions, but when command is 'put_file' the second argument
+          # is an absolute path to temporary that should not be converted
+          tmp_file = args.delete_at( 1 ) if method == :put_file
+          args = args.map{ |arg| file_system_path( arg ) }
+
+          begin
+            # Bypass permissions for second argument if method is put_file
+            args.each{ |arg| check_file_system_permissions!( arg ) }
+            args.insert( 1, tmp_file ) if method == :put_file
+
+            send( self.class.before_hooks[method], *args ) if self.class.before_hooks[method]
+            value = EM::FTPD::FSD::FileOperations.send( method, *args )
+            send( self.class.after_hooks[method], *(args << value) ) if self.class.after_hooks[method]
+
+            return value
+          rescue Exception
+            return COMMANDS[method][:on_error_value]
+          end
+        end
+
+        def file_system_path( ftp_path )
+          "#{base_path}#{ftp_path}"
+        end
+
+        def check_file_system_permissions!( path )
+          unless File.expand_path( path ).include? base_path
+            raise SecurityError, "File system path out of FTP folder"
+          end
+        end
+
+        def load_auth_module( opts )
+          auth_mod = EM::FTPD::FSD::Authentication.const_get( opts.keys.first.to_s.capitalize )
+
+          self.class.send( :include, auth_mod )
+          configure_authentication( opts.values.first )
+        end
+      end
+    end
+  end
+end

data/lib/em-ftpd-fsd/directory_item.rb

@@ -0,0 +1,52 @@
+# This file is part of em-ftpd-fsd.
+#
+# em-ftpd-fsd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# em-ftpd-fsd is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with em-ftpd-fsd.  If not, see <http://www.gnu.org/licenses/>.
+
+module EM
+  module FTPD
+    module FSD
+
+      # This is a copy of original DirectoryItem class found in yob's repository.
+      # The goal of duplication is not to required em-ftpd.
+      #
+      # Given gem official repository is not active and there are a lot of forks
+      # it is better to redefine this class here and be able to use em-ftpd from any
+      # source that tie the entire driver to a one repository.
+      class DirectoryItem
+
+        # Fields for DirectoryItem
+        ATTRS = [:name, :owner, :group, :size, :time, :permissions, :directory]
+
+        attr_accessor(*ATTRS)
+
+        # Initializer method
+        # @param [Hash] options
+        # @option options name
+        # @option options name
+        # @option options owner
+        # @option options group
+        # @option options size
+        # @option options time
+        # @option options permissions
+        # @option options directory
+        def initialize(options)
+          options.each do |attr, value|
+            self.send("#{attr}=", value)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/em-ftpd-fsd/file_operations.rb

@@ -0,0 +1,98 @@
+# This file is part of em-ftpd-fsd.
+#
+# em-ftpd-fsd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# em-ftpd-fsd is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with em-ftpd-fsd.  If not, see <http://www.gnu.org/licenses/>.
+
+module EM
+  module FTPD
+    module FSD
+
+      # Implements file system specific operations to be used by the base driver
+      class FileOperations
+
+        # Gives information about the directory content
+        # @param [String] path Absolute path to the directory
+        # @yield [Array] List of DirectoryItem-ish containing information about
+        #   directory. Nil if there were errors or the path is not correct.
+        def self.dir_contents( path )
+          Dir.entries( path ).map do |filename|
+            EM::FTPD::FSD::DirectoryItem.new(
+              name:      filename,
+              size:      File.size?( "#{path}/#{filename}" ),
+              directory: File.directory?( "#{path}/#{filename}" )
+            )
+          end
+        end
+
+        # File size for the given file
+        # @param [String] path Absolute path to file
+        # @yield [Fixnum] File size or nil if there were errors or the path is not correct
+        def self.bytes( path )
+          File.size( path )
+        end
+
+        # Change current directory
+        # @param [String] path Absolute path to the directory
+        # @yield [Boolean] True if the change was correct false in other case
+        def self.change_dir( path )
+          !!File.directory?( path )
+        end
+
+        # Removes the given directory
+        # @param [String] path Absolute path to the directory
+        # @yield [Boolean] True if the deletion was correct false in other case
+        def self.delete_dir( path )
+          !!Dir.delete( path )
+        end
+
+        # Removes the given file
+        # @param [String] path Absolute path to the file
+        # @yield [Boolean] True if the deletion was correct false in other case
+        def self.delete_file( path )
+          !!File.delete( path )
+        end
+
+        # Moves the given file to a new location
+        # @param [String] from_path Absolute path to existing file
+        # @param [String] to_path Absolute path to new file
+        # @yield [Boolean] True if file was moved without errors, false otherwise
+        def self.rename( from_path, to_path )
+          !!File.rename( from_path, to_path )
+        end
+
+        # Creates a new directory
+        # @param [String] path Absolute path to the new directory
+        # @yield [Boolean] True if the new directory was created false in other case
+        def self.make_dir( path )
+          !!Dir.mkdir( path )
+        end
+
+        # Send a file to the client
+        # @param [String] path Absolute path to the file
+        # @yield [String] File content or nil if the file does not exist or an error ocurred
+        def self.get_file( path )
+          File.read( path )
+        end
+
+        # Upload a new file to FTP server
+        # @param [String] path Absolute path to final location of the file
+        # @param [String] tmp_path Absolute path to temporary file created by server
+        # @yield [Fixnum] New uploaded file size or false if there were an error
+        def self.put_file( path, tmp_path )
+          FileUtils.copy( tmp_path, path )
+          File.size( tmp_path )
+        end
+      end
+    end
+  end
+end