spectre-ftp 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13456bf294907a5b79f995804c119d803a1a565e6b93520d924ee7429e0defca
+  data.tar.gz: edaa3c30ad479bfe490086f9d3ec6268befa9b6cd26b445790f403cc4884aafe
+SHA512:
+  metadata.gz: 5105ff5be1c42b1d163ebea6b5844b770df74be2cb1f97ab1f239e89c9837c939ad6f115688bd105da273ffda6b41e8ece9cbd83b999b6f4a69c4977258380e1
+  data.tar.gz: 3310db259c6786404503daff0a05286c60c9aa1af01eae59c85e9aab2e27c76ec22bb7d4ff2018328a9139b254086e11ab6586f682c92f4f3942aa7fb41b4172

data/lib/spectre/ftp.rb

@@ -0,0 +1,195 @@
+require 'net/ftp'
+require 'net/sftp'
+require 'logger'
+require 'json'
+
+
+module Spectre
+  module FTP
+    @@cfg = {}
+
+    class FTPConnection < DslClass
+      def initialize host, username, password, opts, logger
+        @__logger = logger
+        @__session = nil
+
+        @__host = host
+        @__username = username
+        @__password = password
+        @__opts = opts
+      end
+
+      def connect!
+        return unless @__session == nil or @__session.closed?
+        @__logger.info "Connecting to '#{@__host}' with user '#{@__username}'"
+        @__session = Net::FTP.new(@__host, @__opts)
+        @__session.login @__username, @__password
+      end
+
+      def close
+        return unless @__session and not @__session.closed?
+        @__session.close
+      end
+
+      def can_connect?
+        begin
+          connect!
+          return true
+        rescue
+          return false
+        end
+      end
+
+      def download remotefile, to: File.basename(remotefile)
+        connect!
+        @__logger.info "Downloading '#{@__username}@#{@__host}:#{File.join @__session.pwd, remotefile}' to '#{File.expand_path to}'"
+        @__session.getbinaryfile(remotefile, to)
+      end
+
+      def upload localfile, to: File.basename(localfile)
+        connect!
+        @__logger.info "Uploading '#{File.expand_path localfile}' to '#{@__username}@#{@__host}:#{File.join @__session.pwd, to}'"
+        @__session.putbinaryfile(localfile, to)
+      end
+
+      def list
+        connect!
+        file_list = @__session.list
+        @__logger.info "Listing file in #{@__session.pwd}\n#{file_list}"
+        file_list
+      end
+    end
+
+
+    class SFTPConnection < DslClass
+      def initialize host, username, opts, logger
+        opts[:non_interactive] = true
+
+        @__logger = logger
+        @__session = nil
+        @__host = host
+        @__username = username
+        @__opts = opts
+      end
+
+      def connect!
+        return unless @__session == nil or @__session.closed?
+        @__logger.info "Connecting to '#{@__host}' with user '#{@__username}'"
+        @__session = Net::SFTP.start(@__host, @__username, @__opts)
+        @__session.connect!
+      end
+
+      def close
+        return unless @__session and not @__session.closed?
+        # @__session.close!
+      end
+
+      def can_connect?
+        begin
+          connect!
+          return true
+        rescue
+          return false
+        end
+      end
+
+      def download remotefile, to: File.basename(remotefile)
+        @__logger.info "Downloading '#{@__username}@#{@__host}:#{remotefile}' to '#{File.expand_path to}'"
+        connect!
+        @__session.download!(remotefile, to)
+      end
+
+      def upload localfile, to: File.basename(localfile)
+        @__logger.info "Uploading '#{File.expand_path localfile}' to '#{@__username}@#{@__host}:#{to}'"
+        connect!
+        @__session.upload!(localfile, to)
+      end
+
+      def stat path
+        connect!
+        file_info = @__session.stat! path
+        @__logger.info "Stat '#{path}'\n#{JSON.pretty_generate file_info.attributes}"
+        file_info.attributes
+      end
+
+      def exists path
+        begin
+          file_info = @__session.stat! path
+
+        rescue Net::SFTP::StatusException => e
+          return false if e.description == 'no such file'
+          raise e
+        end
+
+        return true
+      end
+    end
+
+
+    class << self
+      def ftp name, config={}, &block
+        raise "FTP connection '#{name}' not configured" unless @@cfg.key?(name) or config.count > 0
+        cfg = @@cfg[name] || {}
+
+        host = config[:host] || cfg['host'] || name
+        username = config[:username] || cfg['username']
+        password = config[:password] || cfg['password']
+
+        opts = {}
+        opts[:ssl] = config[:ssl]
+        opts[:port] = config[:port] || cfg['port'] || 21
+
+        @@logger.info "Connecting to #{host} with user #{username}"
+
+        ftp_conn = FTPConnection.new(host, username, password, opts, @@logger)
+
+        begin
+          ftp_conn.instance_eval &block
+        ensure
+          ftp_conn.close
+        end
+      end
+
+      def sftp name, config={}, &block
+        raise "FTP connection '#{name}' not configured" unless @@cfg.key?(name) or config.count > 0
+
+        cfg = @@cfg[name] || {}
+
+        host = config[:host] || cfg['host'] || name
+        username = config[:username] || cfg['username']
+        password = config[:password] || cfg['password']
+
+        opts = {}
+        opts[:password] = password
+        opts[:port] = config[:port] || cfg['port'] || 22
+        opts[:keys] = [cfg['key']] if cfg.key? 'key'
+        opts[:passphrase] = cfg['passphrase'] if cfg.key? 'passphrase'
+
+        opts[:auth_methods] = []
+        opts[:auth_methods].push 'publickey' if opts[:keys]
+        opts[:auth_methods].push 'password' if opts[:password]
+
+        sftp_con = SFTPConnection.new(host, username, opts, @@logger)
+
+        begin
+          sftp_con.instance_eval &block
+        ensure
+          sftp_con.close
+        end
+      end
+    end
+
+    Spectre.register do |config|
+      @@logger = ::Logger.new config['log_file'], progname: 'spectre/ftp'
+
+      if config.key? 'ftp'
+
+        config['ftp'].each do |name, cfg|
+          @@cfg[name] = cfg
+        end
+      end
+    end
+
+    Spectre.delegate :ftp, :sftp, to: self
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: spectre-ftp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Neubauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: spectre-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Adds FTP access functionality to the spectre framework
+email:
+- me@christianneubauer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spectre/ftp.rb
+homepage: https://bitbucket.org/cneubaur/spectre-ftp
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://bitbucket.org/cneubaur/spectre-ftp
+  source_code_uri: https://bitbucket.org/cneubaur/spectre-ftp
+  changelog_uri: https://bitbucket.org/cneubaur/spectre-ftp/src/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: FTP module for spectre
+test_files: []