Class: Async::HTTP::Endpoint
- Inherits:
-
IO::Endpoint::Generic
- Object
- IO::Endpoint::Generic
- Async::HTTP::Endpoint
- Defined in:
- lib/async/http/endpoint.rb
Overview
Represents a way to connect to a remote HTTP server.
Instance Attribute Summary collapse
-
#url ⇒ Object
readonly
Returns the value of attribute url.
Class Method Summary collapse
-
.[](url) ⇒ Object
Coerce the given object into an endpoint.
-
.for(scheme, hostname, path = "/", **options) ⇒ Object
Construct an endpoint with a specified scheme, hostname, optional path, and options.
- .parse(string, endpoint = nil, **options) ⇒ Object
Instance Method Summary collapse
- #address ⇒ Object
- #alpn_protocols ⇒ Object
- #authority(ignore_default_port = true) ⇒ Object
- #bind(*arguments, &block) ⇒ Object
- #build_endpoint(endpoint = nil) ⇒ Object
- #connect(&block) ⇒ Object
- #default_port ⇒ Object
- #default_port? ⇒ Boolean
- #each ⇒ Object
- #endpoint ⇒ Object
- #endpoint=(endpoint) ⇒ Object
- #eql?(other) ⇒ Boolean
- #hash ⇒ Object
-
#hostname ⇒ Object
The hostname is the server we are connecting to:.
-
#initialize(url, endpoint = nil, **options) ⇒ Endpoint
constructor
A new instance of Endpoint.
- #inspect ⇒ Object
- #key ⇒ Object
- #localhost? ⇒ Boolean
-
#path ⇒ Object
Return the path and query components of the given URL.
- #port ⇒ Object
- #protocol ⇒ Object
- #scheme ⇒ Object
- #secure? ⇒ Boolean
- #ssl_context ⇒ Object
-
#ssl_verify_mode ⇒ Object
We don’t try to validate peer certificates when talking to localhost because they would always be self-signed.
- #to_s ⇒ Object
- #to_url ⇒ Object
Constructor Details
#initialize(url, endpoint = nil, **options) ⇒ Endpoint
Returns a new instance of Endpoint.
53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/async/http/endpoint.rb', line 53 def initialize(url, endpoint = nil, **) super(**) raise ArgumentError, "URL must be absolute (include scheme, host): #{url}" unless url.absolute? @url = url if endpoint @endpoint = self.build_endpoint(endpoint) else @endpoint = nil end end |
Instance Attribute Details
#url ⇒ Object (readonly)
Returns the value of attribute url.
85 86 87 |
# File 'lib/async/http/endpoint.rb', line 85 def url @url end |
Class Method Details
.[](url) ⇒ Object
Coerce the given object into an endpoint.
40 41 42 43 44 45 46 |
# File 'lib/async/http/endpoint.rb', line 40 def self.[](url) if url.is_a?(Endpoint) return url else Endpoint.parse(url.to_s) end end |
.for(scheme, hostname, path = "/", **options) ⇒ Object
Construct an endpoint with a specified scheme, hostname, optional path, and options.
28 29 30 31 32 33 34 35 36 |
# File 'lib/async/http/endpoint.rb', line 28 def self.for(scheme, hostname, path = "/", **) # TODO: Consider using URI.for once it becomes available: uri_klass = URI.scheme_list[scheme.upcase] || URI::HTTP self.new( uri_klass.new(scheme, nil, hostname, nil, nil, path, nil, nil, nil).normalize, ** ) end |
.parse(string, endpoint = nil, **options) ⇒ Object
21 22 23 24 25 |
# File 'lib/async/http/endpoint.rb', line 21 def self.parse(string, endpoint = nil, **) url = URI.parse(string).normalize return self.new(url, endpoint, **) end |
Instance Method Details
#address ⇒ Object
87 88 89 |
# File 'lib/async/http/endpoint.rb', line 87 def address endpoint.address end |
#alpn_protocols ⇒ Object
145 146 147 |
# File 'lib/async/http/endpoint.rb', line 145 def alpn_protocols @options.fetch(:alpn_protocols) {self.protocol.names} end |
#authority(ignore_default_port = true) ⇒ Object
126 127 128 129 130 131 132 |
# File 'lib/async/http/endpoint.rb', line 126 def (ignore_default_port = true) if ignore_default_port and default_port? @url.hostname else "#{@url.hostname}:#{port}" end end |
#bind(*arguments, &block) ⇒ Object
197 198 199 |
# File 'lib/async/http/endpoint.rb', line 197 def bind(*arguments, &block) endpoint.bind(*arguments, &block) end |
#build_endpoint(endpoint = nil) ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/async/http/endpoint.rb', line 174 def build_endpoint(endpoint = nil) endpoint ||= tcp_endpoint if secure? # Wrap it in SSL: return ::IO::Endpoint::SSLEndpoint.new(endpoint, ssl_context: self.ssl_context, hostname: @url.hostname, timeout: self.timeout, ) end return endpoint end |
#connect(&block) ⇒ Object
201 202 203 |
# File 'lib/async/http/endpoint.rb', line 201 def connect(&block) endpoint.connect(&block) end |
#default_port ⇒ Object
105 106 107 |
# File 'lib/async/http/endpoint.rb', line 105 def default_port secure? ? 443 : 80 end |
#default_port? ⇒ Boolean
109 110 111 |
# File 'lib/async/http/endpoint.rb', line 109 def default_port? port == default_port end |
#each ⇒ Object
205 206 207 208 209 210 211 |
# File 'lib/async/http/endpoint.rb', line 205 def each return to_enum unless block_given? self.tcp_endpoint.each do |endpoint| yield self.class.new(@url, endpoint, **@options) end end |
#endpoint ⇒ Object
189 190 191 |
# File 'lib/async/http/endpoint.rb', line 189 def endpoint @endpoint ||= build_endpoint end |
#endpoint=(endpoint) ⇒ Object
193 194 195 |
# File 'lib/async/http/endpoint.rb', line 193 def endpoint=(endpoint) @endpoint = build_endpoint(endpoint) end |
#eql?(other) ⇒ Boolean
217 218 219 |
# File 'lib/async/http/endpoint.rb', line 217 def eql? other self.key.eql? other.key end |
#hash ⇒ Object
221 222 223 |
# File 'lib/async/http/endpoint.rb', line 221 def hash self.key.hash end |
#hostname ⇒ Object
The hostname is the server we are connecting to:
118 119 120 |
# File 'lib/async/http/endpoint.rb', line 118 def hostname @options[:hostname] || @url.hostname end |
#inspect ⇒ Object
81 82 83 |
# File 'lib/async/http/endpoint.rb', line 81 def inspect "\#<#{self.class} #{self.to_url} #{@options.inspect}>" end |
#key ⇒ Object
213 214 215 |
# File 'lib/async/http/endpoint.rb', line 213 def key [@url, @options] end |
#localhost? ⇒ Boolean
149 150 151 |
# File 'lib/async/http/endpoint.rb', line 149 def localhost? @url.hostname =~ /^(.*?\.)?localhost\.?$/ end |
#path ⇒ Object
Return the path and query components of the given URL.
135 136 137 138 139 140 141 142 143 |
# File 'lib/async/http/endpoint.rb', line 135 def path buffer = @url.path || "/" if query = @url.query buffer = "#{buffer}?#{query}" end return buffer end |
#port ⇒ Object
113 114 115 |
# File 'lib/async/http/endpoint.rb', line 113 def port @options[:port] || @url.port || default_port end |
#protocol ⇒ Object
95 96 97 98 99 100 101 102 103 |
# File 'lib/async/http/endpoint.rb', line 95 def protocol @options.fetch(:protocol) do if secure? Protocol::HTTPS else Protocol::HTTP end end end |
#scheme ⇒ Object
122 123 124 |
# File 'lib/async/http/endpoint.rb', line 122 def scheme @options[:scheme] || @url.scheme end |
#secure? ⇒ Boolean
91 92 93 |
# File 'lib/async/http/endpoint.rb', line 91 def secure? ['https', 'wss'].include?(self.scheme) end |
#ssl_context ⇒ Object
162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/async/http/endpoint.rb', line 162 def ssl_context @options[:ssl_context] || OpenSSL::SSL::SSLContext.new.tap do |context| if alpn_protocols = self.alpn_protocols context.alpn_protocols = alpn_protocols end context.set_params( verify_mode: self.ssl_verify_mode ) end end |
#ssl_verify_mode ⇒ Object
We don’t try to validate peer certificates when talking to localhost because they would always be self-signed.
154 155 156 157 158 159 160 |
# File 'lib/async/http/endpoint.rb', line 154 def ssl_verify_mode if self.localhost? OpenSSL::SSL::VERIFY_NONE else OpenSSL::SSL::VERIFY_PEER end end |
#to_s ⇒ Object
77 78 79 |
# File 'lib/async/http/endpoint.rb', line 77 def to_s "\#<#{self.class} #{self.to_url} #{@options}>" end |
#to_url ⇒ Object
67 68 69 70 71 72 73 74 75 |
# File 'lib/async/http/endpoint.rb', line 67 def to_url url = @url.dup unless default_port? url.port = self.port end return url end |