spectre-ftp 1.0.0 → 1.1.0

checksums.yaml

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

data/lib/spectre/ftp.rb

@@ -19,8 +19,17 @@ module Spectre
         @__opts = opts
       end
 
+      def username user
+        @__username = user
+      end
+
+      def password pass
+        @__password = pass
+      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
@@ -28,6 +37,7 @@ module Spectre
 
       def close
         return unless @__session and not @__session.closed?
+
         @__session.close
       end
 
@@ -42,25 +52,24 @@ module Spectre
 
       def download remotefile, to: File.basename(remotefile)
         connect!
-        @__logger.info "Downloading '#{@__username}@#{@__host}:#{File.join @__session.pwd, remotefile}' to '#{File.expand_path to}'"
+        @__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}'"
+        @__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}"
+        @__logger.info("Listing files in #{@__session.pwd}\n#{file_list}")
         file_list
       end
     end
 
-
     class SFTPConnection < DslClass
       def initialize host, username, opts, logger
         opts[:non_interactive] = true
@@ -72,8 +81,27 @@ module Spectre
         @__opts = opts
       end
 
+      def username user
+        @__username = user
+      end
+
+      def password pass
+        @__opts[:password] = pass
+        @__opts[:auth_methods].push 'password' unless @__opts[:auth_methods].include? 'password'
+      end
+
+      def private_key file_path
+        @__opts[:keys] = [file_path]
+        @__opts[:auth_methods].push 'publickey' unless @__opts[:auth_methods].include? 'publickey'
+      end
+
+      def passphrase phrase
+        @__opts[:passphrase] = phrase
+      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!
@@ -81,6 +109,7 @@ module Spectre
 
       def close
         return unless @__session and not @__session.closed?
+
         # @__session.close!
       end
 
@@ -94,14 +123,14 @@ module Spectre
       end
 
       def download remotefile, to: File.basename(remotefile)
-        @__logger.info "Downloading '#{@__username}@#{@__host}:#{remotefile}' to '#{File.expand_path to}'"
         connect!
+        @__logger.info "Downloading '#{@__username}@#{@__host}:#{remotefile}' to '#{File.expand_path to}'"
         @__session.download!(remotefile, to)
       end
 
       def upload localfile, to: File.basename(localfile)
-        @__logger.info "Uploading '#{File.expand_path localfile}' to '#{@__username}@#{@__host}:#{to}'"
         connect!
+        @__logger.info "Uploading '#{File.expand_path localfile}' to '#{@__username}@#{@__host}:#{to}'"
         @__session.upload!(localfile, to)
       end
 
@@ -114,10 +143,10 @@ module Spectre
 
       def exists path
         begin
-          file_info = @__session.stat! path
-
+          @__session.stat! path
         rescue Net::SFTP::StatusException => e
           return false if e.description == 'no such file'
+
           raise e
         end
 
@@ -128,7 +157,6 @@ module Spectre
 
     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
@@ -139,8 +167,6 @@ module Spectre
         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
@@ -151,8 +177,6 @@ module Spectre
       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
@@ -180,7 +204,7 @@ module Spectre
     end
 
     Spectre.register do |config|
-      @@logger = ::Logger.new config['log_file'], progname: 'spectre/ftp'
+      @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/ftp')
 
       if config.key? 'ftp'
 
@@ -192,4 +216,4 @@ module Spectre
 
     Spectre.delegate :ftp, :sftp, to: self
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectre-ftp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Christian Neubauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-sftp
@@ -16,44 +16,43 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: spectre-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: 1.14.0
   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
+        version: 1.14.0
+description: Adds FTP functionality to the spectre framework
 email:
-- me@christianneubauer.de
+- christian.neubauer@ionos.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/spectre/ftp.rb
-homepage: https://bitbucket.org/cneubaur/spectre-ftp
+homepage: https://github.com/ionos-spectre/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
+  homepage_uri: https://github.com/ionos-spectre/spectre-ftp
+  source_code_uri: https://github.com/ionos-spectre/spectre-ftp
+  changelog_uri: https://github.com/ionos-spectre/spectre-ftp/src/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -62,14 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: FTP module for spectre