rest-ftp-daemon-remote-sftp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bb96f905d1eb45cc56f7c8a8a62ef3e71eaf0ab
+  data.tar.gz: 1c4080c35b01ed4e06566a141baa14dce2518c36
+SHA512:
+  metadata.gz: ff8c7a982685dae01ee53cd9aee901cf6a777b21278e217fd80f66361e2c8f729ccc08bec8f224276fbfcc3ea4a5105689c2a775a10a641d116fb0b3198bad76
+  data.tar.gz: 2d2a2046f30da6b2e2aa93012f7253626b222bf40e7405f6f2b0f88727e76df78519ce67278e67d2d8cdcd3cc02dca3453cc1158b15583707207cc48c05ccf7e

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1 @@
+# rest-ftp-daemon-remote-sftp

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+require "rubygems"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = false
+end
+
+# Load my own tasks
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+# Run specs by default
+desc "Run all tests"
+task default: [:spec, :rubocop]

data/lib/plugins/rest-ftp-daemon/remote/remote_sftp.rb

@@ -0,0 +1,158 @@
+# Dependencies
+require "net/sftp"
+require "rbnacl"
+require "bcrypt_pbkdf"
+
+# Register this handler
+module URI
+  class SFTP < Generic
+    DEFAULT_PORT = 22
+  end
+  @@schemes["SFTP"]   = SFTP
+end
+
+# Handle sFTP transfers for Remote class
+module RestFtpDaemon::Remote
+  class RemoteSFTP < RemoteBase
+
+    # Class options
+    attr_reader :sftp
+
+    # URI schemes handled by this plugin
+    def self.handles
+      [URI::SFTP]
+    end
+
+    def initialize target, job, config
+      # Call daddy's initialize() first
+      super
+    end
+
+    def connect
+      super
+
+      # Debug level
+      if debug_enabled
+        verbosity = Logger::DEBUG 
+      else
+        verbosity = false
+      end
+
+      # Connect remote server
+      @sftp = Net::SFTP.start(@target.host.to_s, @target.user.to_s,
+          password: @target.password.to_s,
+          verbose: verbosity,
+          port: @target.port,
+          non_interactive: true,
+          timeout: DEFAULT_SFTP_TIMEOUT
+          )
+    # rescue NotImplementedError => exception
+    #   raise RemoteConnectError, "RemoteConnectError: #{exception.class}: #{exception.message}"
+
+    rescue Exception => exception
+      raise RemoteConnectError, "#{exception.class}: #{exception.message}"
+    end
+
+    def size_if_exists target
+      log_debug "size_if_exists [#{target.name}]"
+      stat = @sftp.stat! target.path_abs
+
+    rescue Net::SFTP::StatusException
+      return false
+    else
+      return stat.size
+    end
+
+    def remote_try_delete target
+      log_debug "remote_try_delete [#{target.name}]"
+      @sftp.remove target.path_abs
+
+    rescue Net::SFTP::StatusException
+      log_debug "#{LOG_INDENT}[#{target.name}] file not found"
+    else
+      log_debug "#{LOG_INDENT}[#{target.name}] removed"
+    end
+
+    def mkdir directory
+      log_debug "mkdir [#{directory}]"
+      @sftp.mkdir! directory
+
+      rescue StandardError => ex
+        raise TargetPermissionError, ex.message
+    end
+
+    def chdir_or_create directory, mkdir = false
+      # Init, extract my parent name and my own name
+      log_debug "chdir_or_create mkdir[#{mkdir}] dir[#{directory}]"
+      parent, _current = split_path(directory)
+
+      # Access this directory
+      begin
+        @sftp.opendir! directory
+
+      rescue Net::SFTP::StatusException => _e
+        # If not allowed to create path, that's over, we're stuck
+        return false unless mkdir
+
+        # Recurse upward
+        chdir_or_create parent, mkdir
+
+        # Now I was able to chdir into my parent, create the current directory
+        mkdir directory
+
+        # Finally retry the chdir
+        retry
+      else
+        return true
+      end
+
+      # We should never get here
+      raise JobTargetShouldBeDirectory
+    end
+
+    def push source, target, &callback
+      # Push init
+      raise RestFtpDaemon::AssertionFailed, "push/sftp" if @sftp.nil?
+
+      # Do the transfer
+      @sftp.upload! source.path_abs, target.path_abs do |event, _uploader, *args|
+        case event
+        when :open then
+          # args[0] : file metadata
+        when :put then
+          # args[0] : file metadata
+          # args[1] : byte offset in remote file
+          # args[2] : data being written (as string)
+          # puts "writing #{args[2].length} bytes to #{args[0].remote} starting at #{args[1]}"
+
+          # Update job status after this block transfer
+          yield args[2].length, target.name
+
+        when :close then
+          # args[0] : file metadata
+        when :mkdir
+          # args[0] : remote path name
+        when :finish
+        end
+
+      end
+    end
+
+    def move source, target
+      @sftp.rename! source.path_abs, target.path_abs, 0x00000001
+    end
+
+    def close
+      log_debug "remote close"
+    end
+
+    def connected?
+      @sftp && !@sftp.closed?
+    end
+  
+    def debug_enabled
+      @config[:debug_sftp]
+    end
+
+  end
+end

data/rest-ftp-daemon-remote-s3.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+
+  # Project version
+  spec.version                    = "0.0.1"
+
+  # Project description
+  spec.name                       = "rest-ftp-daemon-remote-sftp"
+  spec.authors                    = ["Bruno MEDICI"]
+  spec.email                      = "rftpd-project@bmconseil.com"
+  spec.description                = "rest-ftp-daemon plugin: sFTP"
+  spec.summary                    = "rest-ftp-daemon plugin: transfer files with sFTP"
+  spec.homepage                   = "http://github.com/bmedici/#{spec.name}"
+  spec.licenses                   = ["MIT"]
+  spec.date                       = Time.now.strftime("%Y-%m-%d")
+
+  # List files and executables
+  spec.files                      = `git ls-files -z`.split("\x0")
+  spec.executables                = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths              = ["lib"]
+  spec.required_ruby_version      = ">= 2.3"
+
+  # Runtime dependencies
+  spec.add_runtime_dependency     "net-sftp"
+  spec.add_runtime_dependency     "rbnacl", '>= 3.2', '< 5.0'
+  spec.add_runtime_dependency     "rbnacl-libsodium"
+  spec.add_runtime_dependency     "bcrypt_pbkdf"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rest-ftp-daemon-remote-sftp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruno MEDICI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rbnacl-libsodium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'rest-ftp-daemon plugin: sFTP'
+email: rftpd-project@bmconseil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/plugins/rest-ftp-daemon/remote/remote_sftp.rb
+- rest-ftp-daemon-remote-s3.gemspec
+homepage: http://github.com/bmedici/rest-ftp-daemon-remote-sftp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: 'rest-ftp-daemon plugin: transfer files with sFTP'
+test_files: []