em-ftpd-fsd 0.1.0

data/spec/file_operations/rename_spec.rb

@@ -0,0 +1,76 @@
+describe EM::FTPD::FSD::Base do
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "#rename" do
+    context "when the source file exist" do
+      before do
+        ensure_file_exist( "/test_file" )
+      end
+
+      context "when the destination file does not exist" do
+        before do
+          ensure_file_does_not_exist( "/renamed" )
+        end
+
+        it "yield true" do
+          expect{ |b| driver.rename( "/test_file", "/renamed", &b ) }.to yield_with_args( true )
+        end
+
+        it "renames the source file to destination file" do
+          driver.rename( "/test_file", "/renamed" ){ |value| }
+          File.exist?( FTPRoot + "/test_file" ).should be_false
+          File.exist?( FTPRoot + "/renamed" ).should be_true
+        end
+      end
+
+      context "when the destination file do exist" do
+        before do
+          ensure_file_exist( "/renamed" )
+        end
+
+        it "yield true" do
+          expect{ |b| driver.rename( "/test_file", "/renamed", &b ) }.to yield_with_args( true )
+        end
+
+        it "renames the source file" do
+          driver.rename( "/test_file", "/renamed" ){ |value| }
+          File.exist?( FTPRoot + "/test_file" ).should be_false
+          File.exist?( FTPRoot + "/renamed" ).should be_true
+        end
+      end
+    end
+
+    context "when the source file does not exist" do
+      before do
+        ensure_file_does_not_exist( "/test_file" )
+        ensure_file_does_not_exist( "/renamed" )
+      end
+
+      it "yield false" do
+        expect{ |b| driver.rename( "/test_file", "/renamed", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when source path is out of ftp folder" do
+      before do
+        ensure_file_exist( "/../out_of_ftp_file" )
+        ensure_file_does_not_exist( "/renamed" )
+      end
+
+      it "yield false" do
+        expect{ |b| driver.rename( "/../out_of_ftp_file", "/renamed", &b ) }.to yield_with_args( false )
+      end
+    end
+
+    context "when destination path is out of ftp folder" do
+      before do
+        ensure_file_exist( "/tets_file" )
+        ensure_file_does_not_exist( "/../out_of_ftp_file" )
+      end
+
+      it "yield false" do
+        expect{ |b| driver.rename( "/test_file", "/../out_of_ftp_file", &b ) }.to yield_with_args( false )
+      end
+    end
+  end
+end

data/spec/hooks_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe EM::FTPD::FSD::Base do
+  class BasicDriver
+    before :delete_file, :some_method
+    after :make_dir, :some_other
+
+    def some_method( file )
+    end
+
+    def some_other( dir, value )
+    end
+  end
+
+  let( :driver ){ BasicDriver.new( DriverConfig ) }
+
+  describe "Hooks" do
+    context "when a before hooked ftp command is called" do
+      it "also calls the given method with passed arguments" do
+        ensure_file_exist( "/test_file" )
+
+        driver.should_receive( :some_method ).with( File.expand_path( FTPRoot + "/test_file" ) )
+        driver.delete_file( "/test_file" ){ |value| }
+      end
+    end
+
+    context "when an after hooked ftp command is called" do
+      it "also calls the given method with passed arguments and yielded value" do
+        ensure_dir_does_not_exist( "/test_dir" )
+
+        driver.should_receive( :some_other ).with( File.expand_path( FTPRoot + "/test_dir" ), true )
+        driver.make_dir( "/test_dir" ){ |value| }
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# Require code coverage using .simplecov file
+require 'simplecov'
+
+# REquire the gem itself
+require 'em-ftpd-fsd'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f }
+
+# Set up FTP folder
+FTPRoot = "#{File.dirname( __FILE__ )}/support/ftp_root"
+
+# Basic driver configuration
+DriverConfig = {
+  base_path: FTPRoot,
+  authentication: {
+    plain: {
+      user: "admin",
+      password: "root"
+    }
+  }
+}
+
+# Dummy class to do the testing
+class BasicDriver
+  include EM::FTPD::FSD::Base
+end
+
+RSpec.configure do |config|
+  config.include FilesHelper
+
+  # Prepare the file system for test
+  config.before :suite do
+    Dir.mkdir( FTPRoot ) unless File.directory?( FTPRoot )
+  end
+
+  config.after :suite do
+    File.delete( FTPRoot + "/../out_of_ftp_file" ) if File.exist?( FTPRoot + "/../out_of_ftp_file" )
+    FileUtils.rm_rf( FTPRoot + "/../out_of_ftp_dir" ) if File.exist?( FTPRoot + "/../out_of_ftp_dir" )
+    FileUtils.rm_rf( FTPRoot )
+  end
+end

data/spec/support/files_helper.rb

@@ -0,0 +1,36 @@
+module FilesHelper
+  def ensure_file_exist( path )
+    ensure_entity( path, :file )
+  end
+
+  def ensure_file_does_not_exist( path )
+    ensure_entity( path, :file, false )
+  end
+
+  def ensure_dir_exist( path )
+    ensure_entity( path, :dir )
+  end
+
+  def ensure_dir_does_not_exist( path )
+    ensure_entity( path, :dir, false )
+  end
+
+  def ensure_entity( relative_path, type, existence = true )
+    path = FTPRoot + relative_path
+
+    case type
+      when :file
+        FileUtils.touch( path ) if( existence and not File.exist?( path ) )
+        File.delete( path ) if( File.exist?( path ) and not existence )
+
+        File.exist?( path ).should( existence ? be_true : be_false )
+      when :dir
+        Dir.mkdir( path ) if( existence and not File.directory?( path ) )
+        FileUtils.rm_rf( path ) if( File.directory?( path ) and not existence )
+
+        File.directory?( path ).should( existence ? be_true : be_false )
+      else
+        fail "Object have to be either file or directory"
+      end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: em-ftpd-fsd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Luis Ciudad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &4528020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2.1
+  type: :development
+  prerelease: false
+  version_requirements: *4528020
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &4526820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *4526820
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &4544280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *4544280
+description: Very simple file system driver for EM-FTPD server; including common FTP
+  commands, authentication and before and after operation hooks.
+email: lciudad@nosolosoftware.biz
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+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
+homepage: https://github.com/nanocity/em-ftpd-fsd
+licenses:
+- GPLv3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3903833410681499953
+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: File System Driver for EM-FTPD server
+test_files: []