file_transfer 0.0.7 → 0.0.9

data/lib/file_transfer.rb

@@ -1,95 +1,95 @@
-require "file_transfer/version"
-require "file_transfer/file_transfer_handler"
-require "file_transfer/generic"
-require "file_transfer/ftp"
-require "file_transfer/sftp"
-require "file_transfer/ftps"
-require "net/ftp"
-require "net/sftp"
-
-##
-# Module for file exchange from a locale directory to a remote directory and vice versa. Supported protocols are:
-#
-# * FTP
-# * SFTP
-# * FTPS
-
-module FileTransfer
-
-  ##
-  # Uploads one or more files to a remote server. To upload files use the locale file paths, not the ruby class File.
-  # Types are:
-  # * <tt>:ftp</tt> - for FTP file upload
-  # * <tt>:ftps</tt> - for FTPS file upload
-  # * <tt>:sftp</tt> - for SFTP file upload
-  #
-  # Options are:
-  # * <tt>:username</tt> - Specifies the username for login to the remote server
-  # * <tt>:password</tt> - Specifies the password for login to the remote server
-  # * <tt>:host</tt> - Specifies the name of the remote server. It could be a DNS name or an IP-Address
-  #   these options are not necessary.
-  # * <tt>:port</tt> - Specifies the port of the remote server. If the remote server listen on the default port,
-  # * <tt>:timeout</tt> - If connection hangs, it is possible to define a timeout in seconds here, where the connection
-  #   will be automatically closed.
-  #
-  # ==Examples
-  # <tt>FileTransfer.upload :ftp,
-  #       {:username => 'foo', :password => 'bar', :host => 'localhost'}, [
-  #       {:from => "/local/1.txt", :to => "/remote/uploads/a_1.txt"},
-  #       {:from => "/local/", :to => "/remote/uploads/"},
-  #       {:from => "/local/pdf/*.pdf", :to => "/remote/uploads/pdf/"},
-  #       {:from => ["/local/1.txt", "/local/2.txt", "/local/txt/*.txt"], :to => "/remote/uploads/txt/"}
-  #       ]
-  # </tt>
-
-  def self.upload(type, options, paths)
-    handler = FileTransferHandler.new type, options
-    result = handler.upload paths
-    handler.close
-    result
-  end
-
-  # <tt>FileTransfer.download :ftp,
-  #       {:username => 'foo', :password => 'bar', :host => 'localhost'}, [
-  #       {:from => "/remote/uploads/a_1.txt", :to => "/local/1.txt"},
-  #       {:from => "/remote/uploads/pdf/*.pdf", :to => "/local/pdf/"},
-  #       {:from => ["/remote/uploads/a_1.txt", "/remote/uploads/a_2.txt", "/remote/uploads/txt/*.txt"], :to => "/local/txt/"}
-  #       ]
-  # </tt>
-
-  def self.download(type, options, paths)
-    handler = FileTransferHandler.new type, options
-    result = handler.download paths
-    handler.close
-    result
-  end
-
-  def self.remove(type, options, paths)
-    handler = FileTransferHandler.new type, options
-    result = handler.remove paths
-    handler.close
-    result
-  end
-
-  def self.rename(type, options, from_path, to_path)
-    handler = FileTransferHandler.new type, options
-    result = handler.rename from_path, to_path
-    handler.close
-    result
-  end
-
-  def self.list(type, options, path)
-    handler = FileTransferHandler.new type, options
-    result = handler.list path
-    handler.close
-    result
-  end
-
-  def self.exists?(type, options, path)
-    handler = FileTransferHandler.new type, options
-    result = handler.exists? path
-    handler.close
-    result
-  end
-
-end
+require "file_transfer/version"
+require "file_transfer/file_transfer_handler"
+require "file_transfer/generic"
+require "file_transfer/ftp"
+require "file_transfer/sftp"
+require "file_transfer/ftps"
+require "net/ftp"
+require "net/sftp"
+
+##
+# Module for file exchange from a locale directory to a remote directory and vice versa. Supported protocols are:
+#
+# * FTP
+# * SFTP
+# * FTPS
+
+module FileTransfer
+
+  ##
+  # Uploads one or more files to a remote server. To upload files use the locale file paths, not the ruby class File.
+  # Types are:
+  # * <tt>:ftp</tt> - for FTP file upload
+  # * <tt>:ftps</tt> - for FTPS file upload
+  # * <tt>:sftp</tt> - for SFTP file upload
+  #
+  # Options are:
+  # * <tt>:username</tt> - Specifies the username for login to the remote server
+  # * <tt>:password</tt> - Specifies the password for login to the remote server
+  # * <tt>:host</tt> - Specifies the name of the remote server. It could be a DNS name or an IP-Address
+  #   these options are not necessary.
+  # * <tt>:port</tt> - Specifies the port of the remote server. If the remote server listen on the default port,
+  # * <tt>:timeout</tt> - If connection hangs, it is possible to define a timeout in seconds here, where the connection
+  #   will be automatically closed.
+  #
+  # ==Examples
+  # <tt>FileTransfer.upload :ftp,
+  #       {:username => 'foo', :password => 'bar', :host => 'localhost'}, [
+  #       {:from => "/local/1.txt", :to => "/remote/uploads/a_1.txt"},
+  #       {:from => "/local/", :to => "/remote/uploads/"},
+  #       {:from => "/local/pdf/*.pdf", :to => "/remote/uploads/pdf/"},
+  #       {:from => ["/local/1.txt", "/local/2.txt", "/local/txt/*.txt"], :to => "/remote/uploads/txt/"}
+  #       ]
+  # </tt>
+
+  def self.upload(type, options, paths)
+    handler = FileTransferHandler.new type, options
+    result = handler.upload paths
+    handler.close
+    result
+  end
+
+  # <tt>FileTransfer.download :ftp,
+  #       {:username => 'foo', :password => 'bar', :host => 'localhost'}, [
+  #       {:from => "/remote/uploads/a_1.txt", :to => "/local/1.txt"},
+  #       {:from => "/remote/uploads/pdf/*.pdf", :to => "/local/pdf/"},
+  #       {:from => ["/remote/uploads/a_1.txt", "/remote/uploads/a_2.txt", "/remote/uploads/txt/*.txt"], :to => "/local/txt/"}
+  #       ]
+  # </tt>
+
+  def self.download(type, options, paths)
+    handler = FileTransferHandler.new type, options
+    result = handler.download paths
+    handler.close
+    result
+  end
+
+  def self.remove(type, options, paths)
+    handler = FileTransferHandler.new type, options
+    result = handler.remove paths
+    handler.close
+    result
+  end
+
+  def self.rename(type, options, from_path, to_path)
+    handler = FileTransferHandler.new type, options
+    result = handler.rename from_path, to_path
+    handler.close
+    result
+  end
+
+  def self.list(type, options, path)
+    handler = FileTransferHandler.new type, options
+    result = handler.list path
+    handler.close
+    result
+  end
+
+  def self.exists?(type, options, path)
+    handler = FileTransferHandler.new type, options
+    result = handler.exists? path
+    handler.close
+    result
+  end
+
+end

data/spec/file_transfer/file_transfer_handler_spec.rb

@@ -1,152 +1,152 @@
-require "spec_helper"
-
-RSpec.configure do |c|
-  c.filter_run_excluding :transaction => true
-end
-
-module FileTransfer
-
-  describe FileTransferHandler do
-
-    describe "#_upload", :transaction => true do
-
-    end
-
-    describe "#upload" do
-
-      #it "should return an Array of JPG Files from one Folder" do
-      #  instance = FileTransferHandler.new :ftp, {}
-      #  this_path = File.dirname(__FILE__)
-      #  paths = {:from => ["#{this_path}/../test_files/folder2", "*.jpg"], :to => "/remote_path/"}
-      #  instance.stub(:_upload).and_return(true)
-      #  result = instance.upload(paths)
-      #  Dir.chdir(paths[:from][0])
-      #  result_array = Dir[paths[:from][1]]
-      #  result.should be_kind_of(Array)
-      #  result.should match_array(result_array)
-      #
-      #  puts "--BEGIN OF TEST"
-      #  puts result
-      #  puts "--END OF TEST"
-      #end
-      #
-      #it "should return an Array of JPG Files from all Subfolders incl. Root-Folder" do
-      #  instance = FileTransferHandler.new :ftp, {}
-      #  this_path = File.dirname(__FILE__)
-      #  paths = {:from => ["#{this_path}/../test_files/", "**/*.jpg"], :to => "/remote_path/"}
-      #  instance.stub(:_upload).and_return(true)
-      #  result = instance.upload(paths)
-      #  Dir.chdir(paths[:from][0])
-      #  result_array = Dir[paths[:from][1]]
-      #  result.should be_kind_of(Array)
-      #  result.should match_array(result_array)
-      #
-      #  puts "--BEGIN OF TEST"
-      #  puts result
-      #  puts "--END OF TEST"
-      #end
-
-      it "should list from OTTO SFTP" do
-        instance = FileTransferHandler.new :sftp, {
-            :host => "sftp-dmz.otto.de",
-            :username => "eosch",
-            :password => "hot}Orm1",
-            :port => 22
-        }
-        puts instance.list("/").inspect
-      end
-
-      it "should upload a test-file to OTTO SFTP" do
-        instance = FileTransferHandler.new :sftp, {
-            :host => "sftp-dmz.otto.de",
-            :username => "eosch",
-            :password => "hot}Orm1",
-            :port => 22
-        }
-        this_path = File.dirname(__FILE__)
-        paths = {:from => "#{this_path}/../test_files/empty_file.csv", :to => "/eosch/in/test/empty_file_1.csv"}
-        result = instance.upload(paths)
-        Dir.chdir("#{this_path}/../test_files/")
-        result_array = Dir["*.csv"]
-
-        result.should be_kind_of(Array)
-        #result.should match_array(result_array)
-
-        puts "--BEGIN OF TEST"
-        puts result
-        puts "--END OF TEST"
-      end
-
-      it "should download the test-file from OTTO SFTP" do
-        instance = FileTransferHandler.new :sftp, {
-            :host => "sftp-dmz.otto.de",
-            :username => "eosch",
-            :password => "hot}Orm1",
-            :port => 22
-        }
-        this_path = File.dirname(__FILE__)
-        paths = {:from => "/eosch/in/test/empty_file_1.csv", :to => "#{this_path}/../test_files/empty_file_from_sftp.csv"}
-        result = instance.download(paths)
-        Dir.chdir("#{this_path}/../test_files/")
-        result_array = Dir["*.csv"]
-
-        result.should be_kind_of(Array)
-        #result.should match_array(result_array)
-
-        puts "--BEGIN OF TEST"
-        puts result
-        puts "--END OF TEST"
-      end
-
-      it "should rename the test-file from OTTO SFTP" do
-        instance = FileTransferHandler.new :sftp, {
-            :host => "sftp-dmz.otto.de",
-            :username => "eosch",
-            :password => "hot}Orm1",
-            :port => 22
-        }
-        result = instance.rename "/eosch/in/test/empty_file_1.csv", "/eosch/in/test/empty_file_1.csv_old"
-      end
-
-      #it "should return an Array of various Files" do
-      #  instance = FileTransferHandler.new :ftp, {}
-      #  this_path = File.dirname(__FILE__)
-      #  paths = [
-      #    {:from => [
-      #        ["#{this_path}/../test_files/", "**/*.txt"],
-      #        "#{this_path}/../test_files/folder1/"
-      #      ],
-      #      :to => "/remote_path/"
-      #    },
-      #    {:from => ["#{this_path}/../test_files/folder2/", "[jt]*.jpg"], :to => "/remote_path/"}
-      #  ]
-      #
-      #  instance.stub(:_upload).and_return(true)
-      #  result = instance.upload(paths)
-      #
-      #  Dir.chdir(paths[0][:from][0][0])
-      #  result_array = Dir[paths[0][:from][0][1]]
-      #
-      #  Dir.chdir(paths[0][:from][1])
-      #  Dir["*.*"].each do |f|
-      #    result_array.push f
-      #  end
-      #
-      #  Dir.chdir(paths[1][:from][0])
-      #  Dir[paths[1][:from][1]].each do |f|
-      #    result_array.push f
-      #  end
-      #
-      #  result.should be_kind_of(Array)
-      #  result.should match_array(result_array)
-      #
-      #  puts "--BEGIN OF TEST"
-      #  puts result
-      #  puts "--END OF TEST"
-      #end
-
-    end
-
-  end
-
+require "spec_helper"
+
+RSpec.configure do |c|
+  c.filter_run_excluding :transaction => true
+end
+
+module FileTransfer
+
+  describe FileTransferHandler do
+
+    describe "#_upload", :transaction => true do
+
+    end
+
+    describe "#upload" do
+
+      #it "should return an Array of JPG Files from one Folder" do
+      #  instance = FileTransferHandler.new :ftp, {}
+      #  this_path = File.dirname(__FILE__)
+      #  paths = {:from => ["#{this_path}/../test_files/folder2", "*.jpg"], :to => "/remote_path/"}
+      #  instance.stub(:_upload).and_return(true)
+      #  result = instance.upload(paths)
+      #  Dir.chdir(paths[:from][0])
+      #  result_array = Dir[paths[:from][1]]
+      #  result.should be_kind_of(Array)
+      #  result.should match_array(result_array)
+      #
+      #  puts "--BEGIN OF TEST"
+      #  puts result
+      #  puts "--END OF TEST"
+      #end
+      #
+      #it "should return an Array of JPG Files from all Subfolders incl. Root-Folder" do
+      #  instance = FileTransferHandler.new :ftp, {}
+      #  this_path = File.dirname(__FILE__)
+      #  paths = {:from => ["#{this_path}/../test_files/", "**/*.jpg"], :to => "/remote_path/"}
+      #  instance.stub(:_upload).and_return(true)
+      #  result = instance.upload(paths)
+      #  Dir.chdir(paths[:from][0])
+      #  result_array = Dir[paths[:from][1]]
+      #  result.should be_kind_of(Array)
+      #  result.should match_array(result_array)
+      #
+      #  puts "--BEGIN OF TEST"
+      #  puts result
+      #  puts "--END OF TEST"
+      #end
+
+      it "should list from OTTO SFTP" do
+        instance = FileTransferHandler.new :sftp, {
+            :host => "sftp-dmz.otto.de",
+            :username => "eosch",
+            :password => "hot}Orm1",
+            :port => 22
+        }
+        puts instance.list("/").inspect
+      end
+
+      it "should upload a test-file to OTTO SFTP" do
+        instance = FileTransferHandler.new :sftp, {
+            :host => "sftp-dmz.otto.de",
+            :username => "eosch",
+            :password => "hot}Orm1",
+            :port => 22
+        }
+        this_path = File.dirname(__FILE__)
+        paths = {:from => "#{this_path}/../test_files/empty_file.csv", :to => "/eosch/in/test/empty_file_1.csv"}
+        result = instance.upload(paths)
+        Dir.chdir("#{this_path}/../test_files/")
+        result_array = Dir["*.csv"]
+
+        result.should be_kind_of(Array)
+        #result.should match_array(result_array)
+
+        puts "--BEGIN OF TEST"
+        puts result
+        puts "--END OF TEST"
+      end
+
+      it "should download the test-file from OTTO SFTP" do
+        instance = FileTransferHandler.new :sftp, {
+            :host => "sftp-dmz.otto.de",
+            :username => "eosch",
+            :password => "hot}Orm1",
+            :port => 22
+        }
+        this_path = File.dirname(__FILE__)
+        paths = {:from => "/eosch/in/test/empty_file_1.csv", :to => "#{this_path}/../test_files/empty_file_from_sftp.csv"}
+        result = instance.download(paths)
+        Dir.chdir("#{this_path}/../test_files/")
+        result_array = Dir["*.csv"]
+
+        result.should be_kind_of(Array)
+        #result.should match_array(result_array)
+
+        puts "--BEGIN OF TEST"
+        puts result
+        puts "--END OF TEST"
+      end
+
+      it "should rename the test-file from OTTO SFTP" do
+        instance = FileTransferHandler.new :sftp, {
+            :host => "sftp-dmz.otto.de",
+            :username => "eosch",
+            :password => "hot}Orm1",
+            :port => 22
+        }
+        result = instance.rename "/eosch/in/test/empty_file_1.csv", "/eosch/in/test/empty_file_1.csv_old"
+      end
+
+      #it "should return an Array of various Files" do
+      #  instance = FileTransferHandler.new :ftp, {}
+      #  this_path = File.dirname(__FILE__)
+      #  paths = [
+      #    {:from => [
+      #        ["#{this_path}/../test_files/", "**/*.txt"],
+      #        "#{this_path}/../test_files/folder1/"
+      #      ],
+      #      :to => "/remote_path/"
+      #    },
+      #    {:from => ["#{this_path}/../test_files/folder2/", "[jt]*.jpg"], :to => "/remote_path/"}
+      #  ]
+      #
+      #  instance.stub(:_upload).and_return(true)
+      #  result = instance.upload(paths)
+      #
+      #  Dir.chdir(paths[0][:from][0][0])
+      #  result_array = Dir[paths[0][:from][0][1]]
+      #
+      #  Dir.chdir(paths[0][:from][1])
+      #  Dir["*.*"].each do |f|
+      #    result_array.push f
+      #  end
+      #
+      #  Dir.chdir(paths[1][:from][0])
+      #  Dir[paths[1][:from][1]].each do |f|
+      #    result_array.push f
+      #  end
+      #
+      #  result.should be_kind_of(Array)
+      #  result.should match_array(result_array)
+      #
+      #  puts "--BEGIN OF TEST"
+      #  puts result
+      #  puts "--END OF TEST"
+      #end
+
+    end
+
+  end
+
 end

data/spec/file_transfer/generic_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module FileTransfer
+  describe Generic do
+
+    describe '.new' do
+      context 'when options are empty' do
+        let(:generic) { Generic.new }
+
+        it 'sets default host to localhost' do
+          expect(generic.host).to eq('localhost')
+        end
+
+        it 'sets default username to anonymous' do
+          expect(generic.username).to eq('anonymous')
+        end
+
+        it 'sets default password to empty string' do
+          expect(generic.password).to eq('')
+        end
+
+        it 'sets default keys to empty array' do
+          expect(generic.keys).to eq([])
+        end
+
+        it 'sets default port to 21' do
+          expect(generic.port).to eq(21)
+        end
+
+        it 'sets default timeout to 300' do
+          expect(generic.timeout_seconds).to eq(300)
+        end
+      end
+
+      context 'when options are defined' do
+        before do
+          @generic = Generic.new(:host => 'test.com', :username => 'test_usr', :password => 'test_pw', :keys => 'test.pk', :port => 22, :timeout => 500)
+        end
+
+        it 'sets host to options[:host]' do
+          expect(@generic.host).to eq('test.com')
+        end
+
+        it 'sets username to options[:username]' do
+          expect(@generic.username).to eq('test_usr')
+        end
+
+        it 'sets password to options[:password]' do
+          expect(@generic.password).to eq('test_pw')
+        end
+
+        it 'sets keys to options[:keys]' do
+          expect(@generic.keys).to eq(%w(test.pk))
+        end
+
+        it 'sets port to options[:port]' do
+          expect(@generic.port).to eq(22)
+        end
+
+        it 'sets timeout to options[:timeout]' do
+          expect(@generic.timeout_seconds).to eq(500)
+        end
+      end
+    end
+  end
+end

data/spec/file_transfer/sftp_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module FileTransfer
+  describe Sftp do
+
+    describe '.new' do
+      context 'when port is defined in options parameter' do
+        it 'sets port from options' do
+          sftp = Sftp.new :port => 23
+          expect(sftp.port).to eq(23)
+        end
+      end
+
+      context 'when no port is defined in options parameter' do
+        it 'sets default port 22' do
+          sftp = Sftp.new
+          expect(sftp.port).to be(22)
+        end
+      end
+    end
+  end
+end