em-ftpd-fsd 0.1.0

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

@@ -0,0 +1,69 @@
+# 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
+
+      # Add callbacks methods to base class.
+      # @example Usage
+      #   class BasicDriver
+      #     include EM::FTPD::FSD::Base
+      #
+      #     before :put_file, :some_method
+      #     after :delete_file, :some_other_method
+      #
+      #     def some_method( path, tmp_path )
+      #       ...
+      #     end
+      #
+      #     def some_other_method( path, value )
+      #       ...
+      #     end
+      #   end
+      module Hooks
+
+        # Set a method to be called before FTP command is executed
+        # That method will be invoked with same arguments that FTP command
+        # @param [Symbol] command FTP command to be hooked
+        # @param [Symbol] method Method to be called before FTP command
+        def before( command, method )
+          before_hooks[command] = method
+        end
+
+        # Set a method to be called after FTP command is executed
+        # That method will be invoked with same arguments that FTP command and
+        # an extra parameter containig the value yielded by the FTP command
+        # @param [Symbol] command FTP command to be hooked
+        # @param [Symbol] method Method to be called after FTP command
+        def after( command, method )
+          after_hooks[command] = method
+        end
+
+        # Defined hooks to be executed before FTP commands
+        # @return [Array] List of methods to be called before FTP commands
+        def before_hooks
+          @before_hooks ||= {}
+        end
+
+        # Defined hooks to be executed after FTP commands
+        # @return [Array] List of methods to be called after FTP commands
+        def after_hooks
+          @after_hooks ||= {}
+        end
+      end
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  describe "included methods" do
+    subject{ BasicDriver.new( DriverConfig ) }
+
+    it{ should respond_to( :authenticate ) }
+    it{ should respond_to( :dir_contents ) }
+    it{ should respond_to( :delete_file ) }
+    it{ should respond_to( :change_dir ) }
+    it{ should respond_to( :delete_dir ) }
+    it{ should respond_to( :make_dir ) }
+    it{ should respond_to( :get_file ) }
+    it{ should respond_to( :put_file ) }
+    it{ should respond_to( :rename ) }
+    it{ should respond_to( :bytes ) }
+  end
+end

data/spec/file_operations/authentication_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+
+  # The driver has been configured in spec_helper using
+  #   user     admin
+  #   password root
+  describe "#authenticate" do
+    context "when user and password are correct" do
+      it "yield true" do
+        expect{ |b| driver.authenticate( "admin", "root", &b ) }.to yield_with_args( true )
+      end
+    end
+
+    context "when user is not correct" do
+      it "yield false" do
+        expect{ |b| driver.authenticate( "root", "root", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when password is not correct" do
+      it "yield false" do
+        expect{ |b| driver.authenticate( "admin", "admin", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when neither user nor password are correct" do
+      it "yield false" do
+        expect{ |b| driver.authenticate( "god", "1234", &b ) }.to yield_with_args( false )
+      end
+    end
+  end
+end

data/spec/file_operations/bytes_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#bytes" do
+    context "when the file exist" do
+      it "yields the size of the specified file" do
+        ensure_file_exist( "/test_file" )
+
+        expect do |b|
+          driver.bytes( "/test_file", &b )
+        end.to yield_with_args( File.size( FTPRoot + "/test_file" ) )
+      end
+    end
+
+    context "when the file does not exist" do
+      it "yields nil" do
+        ensure_file_does_not_exist( "/test_file" )
+
+        expect{ |b| driver.bytes( "/test_file", &b ) }.to yield_with_args( nil )
+      end
+    end
+
+    context "when the file is out of ftp folder" do
+      it "yields nil" do
+        ensure_file_exist( "/../out_of_ftp_file" )
+
+        expect{ |b| driver.bytes( "/../out_of_ftp_file", &b ) }.to yield_with_args( nil )
+      end
+    end
+  end
+end

data/spec/file_operations/change_dir_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#change_dir" do
+    context "when the directory exist" do
+      it "yields true" do
+        ensure_dir_exist( "/test_dir" )
+
+        expect{ |b| driver.change_dir( "/test_dir", &b ) }.to yield_with_args( true )
+      end
+    end
+
+    context "when the directory does not exists" do
+      it "yields false" do
+        ensure_dir_does_not_exist( "/test_dir" )
+
+        expect{ |b| driver.change_dir( "/test_dir", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when the directory is out of ftp folder" do
+      it "yields false" do
+        ensure_dir_exist( "/../out_of_ftp_dir" )
+
+        expect{ |b| driver.change_dir( "/../out_of_ftp_dir", &b ) }.to yield_with_args( false )
+      end
+    end
+  end
+end

data/spec/file_operations/delete_dir_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#delete_dir" do
+    context "when directory exist" do
+      before do
+        ensure_dir_exist( "/test_dir" )
+      end
+
+      it "yields true" do
+        expect{ |b| driver.delete_dir( "/test_dir", &b ) }.to yield_with_args( true )
+      end
+
+      it "deletes the directory" do
+        driver.delete_dir( "/test_dir"){ |value| }
+        File.directory?( FTPRoot + "/test_dir" ).should be_false
+      end
+    end
+
+    context "when the directory does not exists" do
+      it "yields false" do
+        ensure_dir_does_not_exist( "/test_dir" )
+
+        expect{ |b| driver.delete_dir( "/test_dir", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when the directory is out of ftp folder" do
+      before do
+        ensure_dir_exist( "/../out_of_ftp_dir" )
+      end
+
+      it "yields false" do
+        expect{ |b| driver.delete_dir( "/../out_of_ftp_dir", &b ) }.to yield_with_args( false )
+      end
+
+      it "does not delete the directory" do
+        driver.delete_dir( "/../out_of_ftp_dir"){ |value| }
+        File.directory?( FTPRoot + "/../out_of_ftp_dir" ).should be_true
+      end
+    end
+  end
+end

data/spec/file_operations/delete_file_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#delete_file" do
+
+    context "when the file exist" do
+      before do
+        ensure_file_exist( "/test_file" )
+      end
+
+      it "yields true" do
+        expect{ |b| driver.delete_file( "/test_file", &b ) }.to yield_with_args( true )
+      end
+
+      it "deletes the file" do
+        driver.delete_file( "/test_file"){ |value| }
+        File.exist?( FTPRoot + "/test_file" ).should be_false
+      end
+    end
+
+    context "when the file does not exists" do
+      it "yields false" do
+        ensure_file_does_not_exist( "/test_file" )
+        expect{ |b| driver.delete_file( "/test_file", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when the file is out of ftp folder" do
+      before do
+        ensure_file_exist( "/../out_of_ftp_file" )
+      end
+
+      it "yields false" do
+        expect{ |b| driver.delete_file( "/../out_of_ftp_file", &b ) }.to yield_with_args( false )
+      end
+
+      it "does not delete the file" do
+        driver.delete_file( "/test_file"){ |value| }
+        File.exist?( FTPRoot + "/../out_of_ftp_file" ).should be_true
+      end
+    end
+  end
+end

data/spec/file_operations/dir_contents_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#dir_contents" do
+    context "when path route to existing resource" do
+      before do
+        ensure_dir_exist( "/test_dir" )
+        ensure_file_exist( "/test_dir/test_file2" )
+        ensure_file_exist( "/test_dir/test_file1" )
+      end
+
+      context "when resource is a directory" do
+        it "yields an array of DirectoryItem's" do
+          expect do |b|
+            driver.dir_contents( "/test_dir", &b )
+          end.to yield_with_args( Array )
+        end
+      end
+
+      context "when resource is a file" do
+        it "yields nil" do
+          expect{ |b| driver.dir_contents( "/test_dir/test_file1", &b ) }.to yield_with_args( nil )
+        end
+      end
+    end
+
+    context "when the directory does not exist" do
+      it "yields nil" do
+        ensure_dir_does_not_exist( "/test_dir" )
+
+        expect{ |b| driver.dir_contents( "/test_dir", &b ) }.to yield_with_args( nil )
+      end
+    end
+
+    context "when directory is out of ftp folder" do
+      it "yields nil" do
+        ensure_dir_exist( "/../out_of_ftp_dir" )
+
+        expect{ |b| driver.dir_contents( "/out_of_ftp_dir", &b ) }.to yield_with_args( nil )
+      end
+    end
+  end
+end

data/spec/file_operations/get_file_spec.rb

@@ -0,0 +1,31 @@
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#get_file" do
+    context "when file exist" do
+      it "yields a string with the file data to send to the client" do
+        ensure_file_exist( "/test_file" )
+
+        expect{ |b| driver.get_file( "/test_file", &b ) }.to yield_with_args(
+          File.read( FTPRoot + "/test_file" )
+        )
+      end
+    end
+
+    context "when file does not exist" do
+      it "yields nil" do
+        ensure_file_does_not_exist( "/test_file" )
+
+        expect{ |b| driver.get_file( "/test_file", &b ) }.to yield_with_args( nil )
+      end
+    end
+
+    context "when file is out of ftp folder" do
+      it "yields nil" do
+        ensure_file_exist( "/../out_of_ftp_file" )
+
+        expect{ |b| driver.get_file( "/../out_of_ftp_file", &b ) }.to yield_with_args( nil )
+      end
+    end
+  end
+end

data/spec/file_operations/make_dir_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#make_dir" do
+
+    context "when directory does not exist" do
+      before do
+        ensure_dir_does_not_exist( "/test_dir" )
+      end
+
+      it "yields true" do
+        expect{ |b| driver.make_dir( "/test_dir", &b ) }.to yield_with_args( true )
+      end
+
+      it "creates the directory" do
+        driver.make_dir( "/test_dir"){ |value| }
+        File.directory?( FTPRoot + "/test_dir" ).should be_true
+      end
+    end
+
+    context "when the directory exists" do
+      it "yields false" do
+        ensure_dir_exist( "/test_dir" )
+
+        expect{ |b| driver.make_dir( "/test_dir", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when the directory is out of ftp folder" do
+      before do
+      ensure_dir_does_not_exist( "/../out_of_ftp_dir" )
+      end
+      it "yields false" do
+        expect{ |b| driver.make_dir( "/../out_of_ftp_dir", &b ) }.to yield_with_args( false )
+      end
+
+      it "does not create the directory" do
+        driver.make_dir( "/../out_of_ftp_dir" ){ |value| }
+        File.directory?( FTPRoot + "/../out_of_ftp_dir" ).should be_false
+      end
+    end
+
+
+  end
+end

data/spec/file_operations/put_file_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#put_file" do
+    context "when the destination file does not exist" do
+      before do
+        ensure_file_does_not_exist( "/new_file" )
+        ensure_file_exist( "/tmp_file" )
+      end
+
+      it "yields an integer indicating the number of bytes received" do
+        file_size = File.size( FTPRoot + "/tmp_file" )
+
+        expect{ |b| driver.put_file( "/new_file", FTPRoot + "/tmp_file", &b ) }.to yield_with_args( file_size )
+      end
+
+      it "creates a new file in destination path" do
+        driver.put_file( "/new_file", FTPRoot + "/tmp_file" ){ |value| }
+
+        File.exist?( FTPRoot + "/new_file" ).should be_true
+      end
+    end
+
+    context "when the destination file already exist" do
+      before do
+        ensure_file_exist( "/new_file" )
+        ensure_file_exist( "/tmp_file" )
+      end
+
+      it "yields an integer indicating the number of bytes received" do
+        file_size = File.size( FTPRoot + "/tmp_file" )
+
+        expect{ |b| driver.put_file( "/tmp_file", FTPRoot + "/new_file", &b ) }.to yield_with_args( file_size )
+      end
+
+      it "creates a new file in destination path" do
+        driver.put_file( "/new_file", "/tmp_file" ){ |value| }
+
+        File.exist?( FTPRoot + "/new_file" ).should be_true
+      end
+    end
+
+    context "when destination path is out of ftp folder" do
+      before do
+        ensure_file_exist( "/../out_of_ftp_file" )
+        ensure_file_exist( "/tmp_file" )
+      end
+
+      it "yields nil" do
+        expect{ |b| driver.put_file( "/new_file", "/../out_of_ftp_file", &b ) }.to yield_with_args( false )
+      end
+    end
+  end
+end