file_transfer 0.0.1

data/lib/file_transfer/file_transfer_handler.rb

@@ -0,0 +1,85 @@
+module FileTransfer
+
+  class FileTransferHandler
+
+    def initialize(type, options)
+      @type = type
+      @options = options
+      @ftp_obj = get_ftp_obj type, options
+    end
+
+    def upload(paths)
+      paths = normalize_paths paths
+      all_file_paths = []
+      # Loop over Path Specs
+      paths.each do |path|
+        # Make sure it's an Array of from-Paths
+        path[:from] = [path[:from]] unless path[:from].kind_of?(Array) && path[:from][0].kind_of?(Array)
+        # Loop over Path From Specs
+        path[:from].each do |path_pattern|
+          path_pattern = [path_pattern] unless path_pattern.kind_of?(Array)
+          file_paths = []
+          if File.exists?(path_pattern[0]) && File.directory?(path_pattern[0])
+            path_pattern[1] = "*.*" if path_pattern.length < 2
+            Dir.chdir(path_pattern[0])
+            file_paths = Dir.glob(path_pattern[1])
+          elsif File.exists?(path_pattern[0])
+            file_paths = [path_pattern[0]]
+          end
+          file_paths.each do |file_path|
+            _upload file_path, path[:to]
+            all_file_paths.push file_path
+          end
+        end
+      end
+      all_file_paths
+    end
+
+    def download(paths)
+      paths = normalize_paths paths
+      all_file_paths = []
+      # Loop over Path Specs
+      paths.each do |path|
+        # Make sure it's an Array of from-Paths
+        path[:from] = [path[:from]] unless path[:from].kind_of?(Array) && path[:from][0].kind_of?(Array)
+        # Loop over Path From Specs
+        path[:from].each do |path_pattern|
+          _download path_pattern, path[:to]
+          all_file_paths.push path_pattern
+        end
+      end
+      all_file_paths
+    end
+
+    def close
+      @ftp_obj.close
+    end
+
+    private
+
+      def normalize_paths(paths)
+        response = paths.kind_of?(Array) ? paths : [paths]
+        Marshal.load(Marshal.dump(response))
+      end
+
+      def get_ftp_obj(type, options)
+        if type == :ftp
+          Ftp.new options
+        elsif type == :sftp
+          Sftp.new options
+        elsif type == :ftps
+          Ftps.new options
+        end
+      end
+
+      def _upload(from_path, to_path)
+        @ftp_obj.upload from_path, to_path
+      end
+
+      def _download(from_path, to_path)
+        @ftp_obj.download from_path, to_path
+      end
+
+  end
+
+end

data/lib/file_transfer/ftp.rb

@@ -0,0 +1,83 @@
+require "net/ftp"
+
+module FileTransfer
+  class Ftp < Generic
+
+    def initialize(options = {})
+      super(options)
+      @ftp = Net::FTP.new
+      @ftp.passive = true
+    end
+
+    def list(dir, options = {})
+      connect if @ftp.closed?
+      timeout(60) do
+        @ftp.chdir dir
+        result = @ftp.nlst
+        if options.has_key? :file_type
+          result = result.select { |file_name| file_name.end_with? options[:file_type] }
+        end
+        result
+      end
+    end
+
+    def upload(from_path, to_path)
+      to_path = split_path(to_path)
+      connect if @ftp.closed?
+      timeout(300) do
+        @ftp.chdir to_path[:file_path]
+        @ftp.putbinaryfile(from_path)
+      end
+    end
+
+    def download(from_path, to_path)
+      from_path = split_path(from_path)
+      connect if @ftp.closed?
+      timeout(300) do
+        @ftp.chdir from_path[:file_path]
+        @ftp.getbinaryfile(to_path, from_path[:file_name])
+        "#{from_path[:file_path]}/#{from_path[:file_name]}"
+      end
+    end
+
+    def move(from_path, to_path)
+      from_path = split_path(from_path)
+      to_path = split_path(to_path)
+      connect if @ftp.closed?
+      timeout(60) do
+        @ftp.chdir from_path[:file_path]
+        @ftp.rename from_path[:file_name], "#{to_path[:file_path]}/#{to_path[:file_name]}" if exist?("#{from_path[:file_name]}/#{from_path[:file_path]}")
+      end
+    end
+
+    def exist?(file_path)
+      connect if @ftp.closed?
+      timeout(60) do
+        result = @ftp.list "#{file_path}"
+        result && result.size > 0
+      end
+    end
+
+    def close
+      unless @ftp.closed?
+        timeout(30) do
+          @ftp.close
+        end
+      end
+    end
+
+    def to_s
+      "FtpClient {@host => #{@host},  @username => #{@username}, @password => ***}"
+    end
+
+    private
+    def connect
+      timeout(30) do
+        @ftp.connect(@host, @port)
+        @ftp.login(@username, @password) if @username && @password
+      end
+    end
+
+
+  end
+end

data/lib/file_transfer/ftps.rb

@@ -0,0 +1,5 @@
+module FileTransfer
+  class Ftps
+    # To change this template use File | Settings | File Templates.
+  end
+end

data/lib/file_transfer/generic.rb

@@ -0,0 +1,49 @@
+module FileTransfer
+
+  class Generic
+
+    attr_accessor :host, :username, :password, :port
+
+    def initialize(options = {})
+      @host = options[:host] || "localhost"
+      @username = options[:username] || "anonymous"
+      @password = options[:password] || ""
+      @port = options[:port] || 21
+    end
+
+    def list(dir, filter="")
+    end
+
+    def upload(from_path, to_path)
+    end
+
+    def download(from_path, to_path)
+    end
+
+    def move(file_name, from_dir, to_dir)
+    end
+
+    def exist?(file_path)
+    end
+
+    def close
+    end
+
+    protected
+
+      def split_path(path)
+        {:file_path => File.dirname(path), :file_name => File.basename(path)}
+      end
+
+      def timeout(seconds, &block)
+        Timeout.timeout(seconds.to_i) do
+          block.call(Hash.new)
+        end
+      end
+
+      def connect
+      end
+
+  end
+
+end

data/lib/file_transfer/sftp.rb

@@ -0,0 +1,32 @@
+module FileTransfer
+
+  class Sftp < Generic
+
+    def initialize(options = {})
+      options[:port] ||= 22
+      super(options)
+      connect
+    end
+
+    def download(from_path, to_path)
+      @sftp.download! from_path, to_path
+    end
+
+    def upload(from_path, to_path)
+      @sftp.upload! from_path, to_path
+    end
+
+    private
+
+      def connect
+        @sftp = Net::SFTP.start(@host, @username, :password => @password, :port => @port)
+      end
+
+      def timeout(seconds, &block)
+        Timeout.timeout(seconds.to_i) do
+          block.call
+        end
+      end
+
+  end
+end

data/lib/file_transfer/version.rb

@@ -0,0 +1,3 @@
+module FileTransfer # :nodoc:
+  VERSION = "0.0.1"  # :nodoc:
+end

data/lib/file_transfer.rb

@@ -0,0 +1,71 @@
+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
+    handler.upload paths
+    handler.close
+  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
+    handler.download paths
+    handler.close
+  end
+
+  def self.exists?(type, options, path)
+    handler = FileTransferHandler.new type, options
+    handler.exists? path
+    handler.close
+  end
+
+end

data/spec/file_transfer/file_transfer_handler_spec.rb

@@ -0,0 +1,132 @@
+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 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 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/spec_helper.rb

@@ -0,0 +1,19 @@
+require "file_transfer"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/test_files/empty_file.csv

@@ -0,0 +1 @@
+COL1,COL2,COL3

data/spec/test_files/folder1/text_3.txt

@@ -0,0 +1 @@
+abc

data/spec/test_files/folder1/text_4.txt

@@ -0,0 +1 @@
+abc

data/spec/test_files/folder2/text_1.txt

@@ -0,0 +1 @@
+abc

data/spec/test_files/folder2/text_6.txt

@@ -0,0 +1 @@
+abc

data/spec/test_files/text_1.txt

@@ -0,0 +1 @@
+abc

data/spec/test_files/text_2.txt

@@ -0,0 +1 @@
+abc

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: file_transfer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- impac GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jruby-pageant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: File Transfer Handler for multiple Protocols
+email:
+- info@impac.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/file_transfer/file_transfer_handler.rb
+- lib/file_transfer/ftp.rb
+- lib/file_transfer/ftps.rb
+- lib/file_transfer/generic.rb
+- lib/file_transfer/sftp.rb
+- lib/file_transfer/version.rb
+- lib/file_transfer.rb
+- spec/file_transfer/file_transfer_handler_spec.rb
+- spec/spec_helper.rb
+- spec/test_files/Chrysanthemum.jpg
+- spec/test_files/Desert.jpg
+- spec/test_files/empty_file.csv
+- spec/test_files/folder1/Koala.jpg
+- spec/test_files/folder1/Lighthouse.jpg
+- spec/test_files/folder1/text_3.txt
+- spec/test_files/folder1/text_4.txt
+- spec/test_files/folder2/Jellyfish.jpg
+- spec/test_files/folder2/Penguins.jpg
+- spec/test_files/folder2/text_1.txt
+- spec/test_files/folder2/text_6.txt
+- spec/test_files/folder2/Tulips.jpg
+- spec/test_files/Hydrangeas.jpg
+- spec/test_files/text_1.txt
+- spec/test_files/text_2.txt
+homepage: http://www.impac.ch
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Transfer Files from and to FTP/SFTP/FTPS
+test_files:
+- spec/file_transfer/file_transfer_handler_spec.rb
+- spec/spec_helper.rb
+- spec/test_files/Chrysanthemum.jpg
+- spec/test_files/Desert.jpg
+- spec/test_files/empty_file.csv
+- spec/test_files/folder1/Koala.jpg
+- spec/test_files/folder1/Lighthouse.jpg
+- spec/test_files/folder1/text_3.txt
+- spec/test_files/folder1/text_4.txt
+- spec/test_files/folder2/Jellyfish.jpg
+- spec/test_files/folder2/Penguins.jpg
+- spec/test_files/folder2/text_1.txt
+- spec/test_files/folder2/text_6.txt
+- spec/test_files/folder2/Tulips.jpg
+- spec/test_files/Hydrangeas.jpg
+- spec/test_files/text_1.txt
+- spec/test_files/text_2.txt