1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ruby/net-http] Enhanced RDoc for Net::HTTP

Browse Source 
https://github.com/ruby/net-http/commit/e65a3d9f11
This commit is contained in:
BurdetteLamar 2023-02-07 15:40:05 +00:00 committed by git
parent a641f6422c
commit 2c7fe9c0a6
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
lib/net/http.rb
View File

@ -1472,12 +1472,15 @@ module Net #:nodoc:
attr_reader :proxy_pass attr_reader :proxy_pass
end end
# True if requests for this connection will be proxied # Returns +true+ if a proxy server is defined, +false+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy? def proxy?
!!(@proxy_from_env ? proxy_uri : @proxy_address) !!(@proxy_from_env ? proxy_uri : @proxy_address)
end end
# True if the proxy for this connection is determined from the environment # Returns +true+ if the proxy server is defined in the environment,
# +false+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_from_env? def proxy_from_env?
@proxy_from_env @proxy_from_env
end end
@ -1491,7 +1494,8 @@ module Net #:nodoc:
@proxy_uri || nil @proxy_uri || nil
end end
# The address of the proxy server, if one is configured. # Returns the address of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_address def proxy_address
if @proxy_from_env then if @proxy_from_env then
proxy_uri&.hostname proxy_uri&.hostname
@ -1500,7 +1504,8 @@ module Net #:nodoc:
end end
end end
# The port of the proxy server, if one is configured. # Returns the port number of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_port def proxy_port
if @proxy_from_env then if @proxy_from_env then
proxy_uri&.port proxy_uri&.port
@ -1509,7 +1514,8 @@ module Net #:nodoc:
end end
end end
# The username of the proxy server, if one is configured. # Returns the user name of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_user def proxy_user
if @proxy_from_env if @proxy_from_env
user = proxy_uri&.user user = proxy_uri&.user
@ -1519,7 +1525,8 @@ module Net #:nodoc:
end end
end end
# The password of the proxy server, if one is configured. # Returns the password of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_pass def proxy_pass
if @proxy_from_env if @proxy_from_env
pass = proxy_uri&.password pass = proxy_uri&.password