spectre-ftp 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a902a8c177730c407b7828f6b60d6bf592402d2b7b5b6103b2c13fdb1ca77ce
-  data.tar.gz: a7612890b94aafb60c3723e0b9515ea0f8859d62578f0ce1cee30767517d41fc
+  metadata.gz: 78abb94631853f8555a1c8140d6ff635d9c52da476df9fcca459b04bc4e56e7a
+  data.tar.gz: 640cfafddb1a3c1893c8ce28d3ca85aa884e4ac0b82e368fcc015a9ff1c54eda
 SHA512:
-  metadata.gz: 2680bc0403cf0eb0e57a039bd42103a72de3b1d8ea303f1a39a00100ff978932c7c6c317fe99333a2c858f7325b90a7b0bf14b56923aac8accd8c007aa91be08
-  data.tar.gz: 739171c88d9513517b143f4d106b2d352457d914a373653093494d93ac89e8aa817badf8fc3dbdaa8b37ab5bde3d8be2d8559285409cef5949c24374da1c6f05
+  metadata.gz: e0d15287e01e895a164404b1259a44e8ca0e06ef08c7da4d0a8d7992d6294df72d748177bc133ee72c904d0be6e8f3f60554c38e44d0bd65d24d22952d555957
+  data.tar.gz: b39d5b16b6f081cb24eb3d49021a1075400b8379c71e25667cba32252f7dae078689281bca2739016cf6f5f057939088f41a2b47bede388cd6b2407c297593fa

data/lib/spectre/ftp.rb

@@ -3,12 +3,11 @@ require 'net/sftp'
 require 'logger'
 require 'json'
 
-
 module Spectre
   module FTP
-    @@cfg = {}
+    class FTPConnection
+      include Spectre::Delegate if defined? Spectre::Delegate
 
-    class FTPConnection < DslClass
       def initialize host, username, password, opts, logger
         @__logger = logger
         @__session = nil
@@ -28,7 +27,7 @@ module Spectre
       end
 
       def connect!
-        return unless @__session == nil or @__session.closed?
+        return unless @__session.nil? or @__session.closed?
 
         @__logger.info "Connecting to '#{@__host}' with user '#{@__username}'"
         @__session = Net::FTP.new(@__host, @__opts)
@@ -36,29 +35,34 @@ module Spectre
       end
 
       def close
-        return unless @__session and not @__session.closed?
+        return unless @__session and !@__session.closed?
 
         @__session.close
       end
 
       def can_connect?
-        begin
-          connect!
-          return true
-        rescue
-          return false
-        end
+        connect!
+        true
+      rescue StandardError
+        false
       end
 
       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
 
@@ -70,10 +74,10 @@ module Spectre
       end
     end
 
-    class SFTPConnection < DslClass
-      def initialize host, username, opts, logger
-        opts[:non_interactive] = true
+    class SFTPConnection
+      include Spectre::Delegate if defined? Spectre::Delegate
 
+      def initialize host, username, opts, logger
         @__logger = logger
         @__session = nil
         @__host = host
@@ -100,26 +104,24 @@ module Spectre
       end
 
       def connect!
-        return unless @__session == nil or @__session.closed?
+        return unless @__session.nil? or @__session.closed?
 
-        @__logger.info "Connecting to '#{@__host}' with user '#{@__username}'"
+        @__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?
+        return if @__session.nil? or @__session.closed?
 
-        # @__session.close!
+        @__session.close_channel
       end
 
       def can_connect?
-        begin
-          connect!
-          return true
-        rescue
-          return false
-        end
+        connect!
+        true
+      rescue StandardError
+        false
       end
 
       def download remotefile, to: File.basename(remotefile)
@@ -150,14 +152,20 @@ module Spectre
           raise e
         end
 
-        return true
+        true
       end
     end
 
+    class Client
+      include Spectre::Delegate if defined? Spectre::Delegate
 
-    class << self
-      def ftp name, config={}, &block
-        cfg = @@cfg[name] || {}
+      def initialize config, logger
+        @config = config['ftp'] || {}
+        @logger = logger
+      end
+
+      def ftp(name, config = {}, &)
+        cfg = @config[name] || {}
 
         host = config[:host] || cfg['host'] || name
         username = config[:username] || cfg['username']
@@ -167,17 +175,17 @@ module Spectre
         opts[:ssl] = config[:ssl]
         opts[:port] = config[:port] || cfg['port'] || 21
 
-        ftp_conn = FTPConnection.new(host, username, password, opts, @@logger)
+        ftp_conn = FTPConnection.new(host, username, password, opts, @logger)
 
         begin
-          ftp_conn.instance_eval &block
+          ftp_conn.instance_eval(&)
         ensure
           ftp_conn.close
         end
       end
 
-      def sftp name, config={}, &block
-        cfg = @@cfg[name] || {}
+      def sftp(name, config = {}, &)
+        cfg = @config[name] || {}
 
         host = config[:host] || cfg['host'] || name
         username = config[:username] || cfg['username']
@@ -193,27 +201,18 @@ module Spectre
         opts[:auth_methods].push 'publickey' if opts[:keys]
         opts[:auth_methods].push 'password' if opts[:password]
 
-        sftp_con = SFTPConnection.new(host, username, opts, @@logger)
+        opts[:non_interactive] = true
+
+        sftp_con = SFTPConnection.new(host, username, opts, @logger)
 
         begin
-          sftp_con.instance_eval &block
+          sftp_con.instance_eval(&)
         ensure
           sftp_con.close
         end
       end
     end
-
-    Spectre.register do |config|
-      @@logger = Spectre::Logging::ModuleLogger.new(config, '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
+
+  Engine.register(FTP::Client, :ftp, :sftp) if defined? Engine
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: spectre-ftp
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Christian Neubauer
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ftp
@@ -38,21 +37,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: spectre-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.14.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.14.0
-description: Adds FTP functionality to the spectre framework
+description: A simple FTP wrapper for nice readability. Is compatible with spectre-core.
 email:
 - christian.neubauer@ionos.com
 executables: []
@@ -62,12 +47,11 @@ files:
 - lib/spectre/ftp.rb
 homepage: https://github.com/ionos-spectre/spectre-ftp
 licenses:
-- MIT
+- GPL-3.0-or-later
 metadata:
   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:
 - lib
@@ -75,15 +59,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
-summary: FTP module for spectre
+summary: Standalone FTP wrapper compatible with spectre
 test_files: []