ruby-changes:62934
From: TOMITA <ko1@a...>
Date: Mon, 14 Sep 2020 17:27:10 +0900 (JST)
Subject: [ruby-changes:62934] 141404e898 (master): [ruby/net-smtp] Net::SMTP.start arguments are keyword arguments
https://git.ruby-lang.org/ruby.git/commit/?id=141404e898 From 141404e898b7320682d4ac83e47fc53642d031bd Mon Sep 17 00:00:00 2001 From: TOMITA Masahiro <tommy@t...> Date: Sun, 19 Jul 2020 21:25:25 +0900 Subject: [ruby/net-smtp] Net::SMTP.start arguments are keyword arguments The helo argument is not important, but the helo argument must be specified to specify the user and secret arguments. If helo, user, secret, and authtype arguments are keyword arguments, it is not necessary to specify the helo argument. https://github.com/ruby/net-smtp/commit/269774deac diff --git a/lib/net/smtp.rb b/lib/net/smtp.rb index 52c5d81..a195f26 100644 --- a/lib/net/smtp.rb +++ b/lib/net/smtp.rb @@ -146,8 +146,8 @@ module Net https://github.com/ruby/ruby/blob/trunk/lib/net/smtp.rb#L146 # The SMTP server will judge whether it should send or reject # the SMTP session by inspecting the HELO domain. # - # Net::SMTP.start('your.smtp.server', 25, - # 'mail.from.domain') { |smtp| ... } + # Net::SMTP.start('your.smtp.server', 25 + # helo: 'mail.from.domain') { |smtp| ... } # # === SMTP Authentication # @@ -157,15 +157,15 @@ module Net https://github.com/ruby/ruby/blob/trunk/lib/net/smtp.rb#L157 # SMTP.start/SMTP#start. # # # PLAIN - # Net::SMTP.start('your.smtp.server', 25, 'mail.from.domain', - # 'Your Account', 'Your Password', :plain) + # Net::SMTP.start('your.smtp.server', 25 + # user: 'Your Account', secret: 'Your Password', authtype: :plain) # # LOGIN - # Net::SMTP.start('your.smtp.server', 25, 'mail.from.domain', - # 'Your Account', 'Your Password', :login) + # Net::SMTP.start('your.smtp.server', 25 + # user: 'Your Account', secret: 'Your Password', authtype: :login) # # # CRAM MD5 - # Net::SMTP.start('your.smtp.server', 25, 'mail.from.domain', - # 'Your Account', 'Your Password', :cram_md5) + # Net::SMTP.start('your.smtp.server', 25 + # user: 'Your Account', secret: 'Your Password', authtype: :cram_md5) # class SMTP < Protocol VERSION = "0.1.0" @@ -402,11 +402,15 @@ module Net https://github.com/ruby/ruby/blob/trunk/lib/net/smtp.rb#L402 # # + # :call-seq: + # start(address, port = nil, helo: 'localhost', user: nil, secret: nil, authtype: nil) { |smtp| ... } + # start(address, port = nil, helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... } + # # Creates a new Net::SMTP object and connects to the server. # # This method is equivalent to: # - # Net::SMTP.new(address, port).start(helo_domain, account, password, authtype) + # Net::SMTP.new(address, port).start(helo: helo_domain, user: account, secret: password, authtype: authtype) # # === Example # @@ -450,10 +454,15 @@ module Net https://github.com/ruby/ruby/blob/trunk/lib/net/smtp.rb#L454 # * Net::ReadTimeout # * IOError # - def SMTP.start(address, port = nil, helo = 'localhost', - user = nil, secret = nil, authtype = nil, - &block) # :yield: smtp - new(address, port).start(helo, user, secret, authtype, &block) + def SMTP.start(address, port = nil, *args, helo: nil, + user: nil, secret: nil, password: nil, authtype: nil, + &block) + raise ArgumentError, "wrong number of arguments (given #{args.size + 2}, expected 1..6)" if args.size > 4 + helo ||= args[0] || 'localhost' + user ||= args[1] + secret ||= password || args[2] + authtype ||= args[3] + new(address, port).start(helo: helo, user: user, secret: secret, authtype: authtype, &block) end # +true+ if the SMTP session has been started. @@ -462,6 +471,10 @@ module Net https://github.com/ruby/ruby/blob/trunk/lib/net/smtp.rb#L471 end # + # :call-seq: + # start(helo: 'localhost', user: nil, secret: nil, authtype: nil) { |smtp| ... } + # start(helo = 'localhost', user = nil, secret = nil, authtype = nil) { |smtp| ... } + # # Opens a TCP connection and starts the SMTP session. # # === Parameters @@ -488,7 +501,7 @@ module Net https://github.com/ruby/ruby/blob/trunk/lib/net/smtp.rb#L501 # # require 'net/smtp' # smtp = Net::SMTP.new('smtp.mail.server', 25) - # smtp.start(helo_domain, account, password, authtype) do |smtp| + # smtp.start(helo: helo_domain, user: account, secret: password, authtype: authtype) do |smtp| # smtp.send_message msgstr, 'from@e...', ['dest@e...'] # end # @@ -512,8 +525,13 @@ module Net https://github.com/ruby/ruby/blob/trunk/lib/net/smtp.rb#L525 # * Net::ReadTimeout # * IOError # - def start(helo = 'localhost', - user = nil, secret = nil, authtype = nil) # :yield: smtp + def start(*args, helo: nil, + user: nil, secret: nil, password: nil, authtype: nil) + raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0..4)" if args.size > 4 + helo ||= args[0] || 'localhost' + user ||= args[1] + secret ||= password || args[2] + authtype ||= args[3] if block_given? begin do_start helo, user, secret, authtype diff --git a/test/net/smtp/test_smtp.rb b/test/net/smtp/test_smtp.rb index 90c92e0..507caee 100644 --- a/test/net/smtp/test_smtp.rb +++ b/test/net/smtp/test_smtp.rb @@ -184,17 +184,99 @@ module Net https://github.com/ruby/ruby/blob/trunk/test/net/smtp/test_smtp.rb#L184 end end + def test_start + port = fake_server_start + smtp = Net::SMTP.start('localhost', port) + smtp.quit + end + + def test_start_with_position_argument + port = fake_server_start(helo: 'myname', user: 'account', password: 'password') + smtp = Net::SMTP.start('localhost', port, 'myname', 'account', 'password', :plain) + smtp.quit + end + + def test_start_with_keyword_argument + port = fake_server_start(helo: 'myname', user: 'account', password: 'password') + smtp = Net::SMTP.start('localhost', port, helo: 'myname', user: 'account', secret: 'password', authtype: :plain) + smtp.quit + end + + def test_start_password_is_secret + port = fake_server_start(helo: 'myname', user: 'account', password: 'password') + smtp = Net::SMTP.start('localhost', port, helo: 'myname', user: 'account', password: 'password', authtype: :plain) + smtp.quit + end + + def test_start_invalid_number_of_arguments + err = assert_raise ArgumentError do + Net::SMTP.start('localhost', 25, 'myname', 'account', 'password', :plain, :invalid_arg) + end + assert_equal('wrong number of arguments (given 7, expected 1..6)', err.message) + end + + def test_start_instance + port = fake_server_start + smtp = Net::SMTP.new('localhost', port) + smtp.start + smtp.quit + end + + def test_start_instance_with_position_argument + port = fake_server_start(helo: 'myname', user: 'account', password: 'password') + smtp = Net::SMTP.new('localhost', port) + smtp.start('myname', 'account', 'password', :plain) + smtp.quit + end + + def test_start_instance_with_keyword_argument + port = fake_server_start(helo: 'myname', user: 'account', password: 'password') + smtp = Net::SMTP.new('localhost', port) + smtp.start(helo: 'myname', user: 'account', secret: 'password', authtype: :plain) + smtp.quit + end + + def test_start_instance_password_is_secret + port = fake_server_start(helo: 'myname', user: 'account', password: 'password') + smtp = Net::SMTP.new('localhost', port) + smtp.start(helo: 'myname', user: 'account', password: 'password', authtype: :plain) + smtp.quit + end + + def test_start_instance_invalid_number_of_arguments + smtp = Net::SMTP.new('localhost') + err = assert_raise ArgumentError do + smtp.start('myname', 'account', 'password', :plain, :invalid_arg) + end + assert_equal('wrong number of arguments (given 5, expected 0..4)', err.message) + end + private def accept(servers) - loop do - readable, = IO.select(servers.map(&:to_io)) - readable.each do |r| - sock, = r.accept_nonblock(exception: false) - next if sock == :wait_readable - return sock + Socket.accept_loop(servers) { |s, _| break s } + end + + def fake_server_start(helo: 'localhost', user: nil, password: nil) + servers = Socket.tcp_server_sockets('localhost', 0) + Thread.start do + Thread.current.abort_on_exception = true + sock = accept(servers) + sock.puts "220 ready\r\n" + assert_equal("EHLO #{helo}\r\n", sock.gets) + sock.puts "220-servername\r\n220 AUTH PLAIN\r\n" + if user + credential = ["\0#{user}\0#{password}"].pack('m0') + assert_equal("AUTH PLAIN #{credential}\r\n", sock.gets) + sock.puts "235 2.7.0 Authentication successful\r\n" end + assert_equal("QUIT\r\n", sock.gets) + sock.puts "221 2.0.0 Bye\r\n" + sock.close + servers.each(&:close) end + port = servers[0].local_address.ip_port + return port end end end -- cgit v0.10.2 -- ML: ruby-changes@q... Info: http://www.atdot.net/~ko1/quickml/