net-ftp 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb3a59b7b4a2153ab8e56bdf8dbad9402c9ae73aeb5dc765a990dc0fe491dd46
-  data.tar.gz: 0c5552bcd67be7ae0087d83345716a8b6014d2d5347348ca72a48c5e1c306a2b
+  metadata.gz: cf9d2560e8bb495195915b83e2fa701ff039c328b06934515ac50f1309025769
+  data.tar.gz: 2231a3b5311f57b6fee02282e8cb41fd717b79cc1f2186d76483db8fd873ff47
 SHA512:
-  metadata.gz: 4a67c6f9918df76bfb390cbaa44216e5180ab8f28c703da4fbf2cc83dccd062d420eb180a7db489a37fdc8dfbb676dee78695b71082a622172e208fa220a4a2c
-  data.tar.gz: b501f9ee7c06712ed74eef5b5f414d9abb772d41f639a4bd71824e58cc62230715f5a23d139ccb0ff6c4cbf3033cb931c5921b9616e6f06c249fdcdcd8547af8
+  metadata.gz: 52f5676aecc77cc97286bbbe6c6649ff9a966e7e161674643593db4cdb1aacdd6080fa25d8f8e3e379b9649125a5dd1167b3292401268141f0924bf618e4e0ad
+  data.tar.gz: 19212687975c12da4fee59c30e620ead52ad0e5a8beccf178de4c74809e43fc662c6cf5a5e084d3b222c19d5bacc4c352bdebb7b2d18939f9762600f9c43b60d

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/test.yml

@@ -7,11 +7,11 @@ jobs:
     name: build (${{ matrix.ruby }} / ${{ matrix.os }})
     strategy:
       matrix:
-        ruby: [ '3.0', 2.7, 2.6, 2.5, 2.4, head ]
+        ruby: [ head, '3.1', '3.0', '2.7', '2.6' ]
         os: [ ubuntu-latest, macos-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/lib/net/ftp.rb

@@ -85,7 +85,7 @@ module Net
     end
 
     # :stopdoc:
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
     FTP_PORT = 21
     CRLF = "\r\n"
     DEFAULT_BLOCKSIZE = BufferedIO::BUFSIZE
@@ -98,10 +98,19 @@ module Net
     # When +true+, the connection is in passive mode.  Default: +true+.
     attr_accessor :passive
 
+    # When +true+, use the IP address in PASV responses.  Otherwise, it uses
+    # the same IP address for the control connection.  Default: +false+.
+    attr_accessor :use_pasv_ip
+
     # When +true+, all traffic to and from the server is written
     # to +$stdout+.  Default: +false+.
     attr_accessor :debug_mode
 
+    # Sets or retrieves the output stream for debugging.
+    # Output stream will be used only when +debug_mode+ is set to true.
+    # The default value is +$stdout+.
+    attr_accessor :debug_output
+
     # Sets or retrieves the +resume+ status, which decides whether incomplete
     # transfers are resumed or restarted.  Default: +false+.
     attr_accessor :resume
@@ -191,6 +200,8 @@ module Net
     #             as parameters.
     # private_data_connection::  If true, TLS is used for data connections.
     #                            Default: +true+ when +options+[:ssl] is true.
+    # implicit_ftps::  If true, TLS is established on initial connection.
+    #                  Default: +false+
     # username::  Username for login.  If +options+[:username] is the string
     #             "anonymous" and the +options+[:password] is +nil+,
     #             "anonymous@" is used as a password.
@@ -206,6 +217,9 @@ module Net
     #                          handshake.
     #                          See Net::FTP#ssl_handshake_timeout for
     #                          details.  Default: +nil+.
+    # use_pasv_ip::  When +true+, use the IP address in PASV responses.
+    #                Otherwise, it uses the same IP address for the control
+    #                connection.  Default: +false+.
     # debug_mode::  When +true+, all traffic to and from the server is
     #               written to +$stdout+.  Default: +false+.
     #
@@ -241,6 +255,11 @@ module Net
         else
           @private_data_connection = options[:private_data_connection]
         end
+        if options[:implicit_ftps].nil?
+          @implicit_ftps = false
+        else
+          @implicit_ftps = options[:implicit_ftps]
+        end
       else
         @ssl_context = nil
         if options[:private_data_connection]
@@ -248,6 +267,11 @@ module Net
             "private_data_connection can be set to true only when ssl is enabled"
         end
         @private_data_connection = false
+        if options[:implicit_ftps]
+          raise ArgumentError,
+                "implicit_ftps can be set to true only when ssl is enabled"
+        end
+        @implicit_ftps = false
       end
       @binary = true
       if options[:passive].nil?
@@ -260,12 +284,14 @@ module Net
       else
         @debug_mode = options[:debug_mode]
       end
+      @debug_output = $stdout
       @resume = false
       @bare_sock = @sock = NullSocket.new
       @logged_in = false
       @open_timeout = options[:open_timeout]
       @ssl_handshake_timeout = options[:ssl_handshake_timeout]
       @read_timeout = options[:read_timeout] || 60
+      @use_pasv_ip = options[:use_pasv_ip] || false
       if host
         connect(host, options[:port] || FTP_PORT)
         if options[:username]
@@ -370,19 +396,17 @@ module Net
     # <tt>Errno::ECONNREFUSED</tt>) if the connection cannot be established.
     #
     def connect(host, port = FTP_PORT)
-      if @debug_mode
-        print "connect: ", host, ", ", port, "\n"
-      end
+      debug_print "connect: #{host}:#{port}"
       synchronize do
         @host = host
         @bare_sock = open_socket(host, port)
-        @sock = BufferedSocket.new(@bare_sock, read_timeout: @read_timeout)
-        voidresp
         if @ssl_context
           begin
-            voidcmd("AUTH TLS")
-            ssl_sock = start_tls_session(@bare_sock)
-            @sock = BufferedSSLSocket.new(ssl_sock, read_timeout: @read_timeout)
+            unless @implicit_ftps
+              set_socket(BufferedSocket.new(@bare_sock, read_timeout: @read_timeout))
+              voidcmd("AUTH TLS")
+            end
+            set_socket(BufferedSSLSocket.new(start_tls_session(@bare_sock), read_timeout: @read_timeout), @implicit_ftps)
             if @private_data_connection
               voidcmd("PBSZ 0")
               voidcmd("PROT P")
@@ -391,6 +415,8 @@ module Net
             @sock.close
             raise
           end
+        else
+          set_socket(BufferedSocket.new(@bare_sock, read_timeout: @read_timeout))
         end
       end
     end
@@ -422,9 +448,7 @@ module Net
     # Ensures that +line+ has a control return / line feed (CRLF) and writes
     # it to the socket.
     def putline(line) # :nodoc:
-      if @debug_mode
-        print "put: ", sanitize(line), "\n"
-      end
+      debug_print "put: #{sanitize(line)}"
       if /[\r\n]/ =~ line
         raise ArgumentError, "A line must not contain CR or LF"
       end
@@ -437,9 +461,7 @@ module Net
     def getline # :nodoc:
       line = @sock.readline # if get EOF, raise EOFError
       line.sub!(/(\r\n|\n|\r)\z/n, "")
-      if @debug_mode
-        print "get: ", sanitize(line), "\n"
-      end
+      debug_print "get: #{sanitize(line)}"
       return line
     end
     private :getline
@@ -537,7 +559,6 @@ module Net
         host, port = parse227(sendcmd("PASV"))
       else
         host, port = parse229(sendcmd("EPSV"))
-        #     host, port = parse228(sendcmd("LPSV"))
       end
       return host, port
     end
@@ -1240,7 +1261,7 @@ module Net
     #
     def abort
       line = "ABOR" + CRLF
-      print "put: ABOR\n" if @debug_mode
+      debug_print "put: ABOR"
       @sock.send(line, Socket::MSG_OOB)
       resp = getmultiline
       unless ["426", "226", "225"].include?(resp[0, 3])
@@ -1260,7 +1281,7 @@ module Net
       if /[\r\n]/ =~ line
         raise ArgumentError, "A line must not contain CR or LF"
       end
-      print "put: #{line}\n" if @debug_mode
+      debug_print "put: #{line}"
       @sock.send(line + CRLF, Socket::MSG_OOB)
       return getresp
     end
@@ -1381,31 +1402,18 @@ module Net
         raise FTPReplyError, resp
       end
       if m = /\((?<host>\d+(?:,\d+){3}),(?<port>\d+,\d+)\)/.match(resp)
-        return parse_pasv_ipv4_host(m["host"]), parse_pasv_port(m["port"])
+        if @use_pasv_ip
+          host = parse_pasv_ipv4_host(m["host"])
+        else
+          host = @bare_sock.remote_address.ip_address
+        end
+        return host, parse_pasv_port(m["port"])
       else
         raise FTPProtoError, resp
       end
     end
     private :parse227
 
-    # handler for response code 228
-    # (Entering Long Passive Mode)
-    #
-    # Returns host and port.
-    def parse228(resp) # :nodoc:
-      if !resp.start_with?("228")
-        raise FTPReplyError, resp
-      end
-      if m = /\(4,4,(?<host>\d+(?:,\d+){3}),2,(?<port>\d+,\d+)\)/.match(resp)
-        return parse_pasv_ipv4_host(m["host"]), parse_pasv_port(m["port"])
-      elsif m = /\(6,16,(?<host>\d+(?:,\d+){15}),2,(?<port>\d+,\d+)\)/.match(resp)
-        return parse_pasv_ipv6_host(m["host"]), parse_pasv_port(m["port"])
-      else
-        raise FTPProtoError, resp
-      end
-    end
-    private :parse228
-
     def parse_pasv_ipv4_host(s)
       return s.tr(",", ".")
     end
@@ -1453,6 +1461,13 @@ module Net
     end
     private :parse257
 
+    #
+    # Writes debug message to the debug output stream
+    #
+    def debug_print(msg)
+      @debug_output << msg + "\n" if @debug_mode && @debug_output
+    end
+
     # :stopdoc:
     class NullSocket
       def read_timeout=(sec)

data/net-ftp.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Support for the File Transfer Protocol.}
   spec.description   = %q{Support for the File Transfer Protocol.}
   spec.homepage      = "https://github.com/ruby/net-ftp"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -25,10 +25,8 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z 2>/dev/null`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z 2>/dev/null`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "net-protocol"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-ftp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Shugo Maeda
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-protocol
@@ -45,14 +45,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/net/ftp.rb
 - net-ftp.gemspec
 homepage: https://github.com/ruby/net-ftp
@@ -70,14 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: Support for the File Transfer Protocol.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "net/ftp"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here