Class: Async::HTTP::Endpoint

Inherits:
IO::Endpoint::Generic
  • Object
show all
Defined in:
lib/async/http/endpoint.rb

Overview

Represents a way to connect to a remote HTTP server.

Constant Summary collapse

SCHEMES = 
{
	"http" => URI::HTTP,
	"https" => URI::HTTPS,
	"ws" => URI::WS,
	"wss" => URI::WSS,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, endpoint = nil, **options) ⇒ Endpoint

Returns a new instance of Endpoint.

Parameters:

  • scheme (Hash) —

    a customizable set of options

  • hostname (Hash) —

    a customizable set of options

  • port (Hash) —

    a customizable set of options

  • ssl_context (Hash) —

    a customizable set of options

  • alpn_protocols (Hash) —

    a customizable set of options

Raises:

  • (ArgumentError) 


71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/async/http/endpoint.rb', line 71

def initialize(url, endpoint = nil, **options)
	super(**options)
	
	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.



103
104
105
 
# File 'lib/async/http/endpoint.rb', line 103

def url
  @url
end

Class Method Details

.[](url) ⇒ Object

Coerce the given object into an endpoint.



58
59
60
61
62
63
64
 
# File 'lib/async/http/endpoint.rb', line 58

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.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/async/http/endpoint.rb', line 44

def self.for(scheme, hostname, path = "/", **options)
	# TODO: Consider using URI.for once it becomes available:
	uri_klass = SCHEMES.fetch(scheme.downcase) do
		raise ArgumentError, "Unsupported scheme: #{scheme.inspect}"
	end
	
	self.new(
		uri_klass.new(scheme, nil, hostname, nil, nil, path, nil, nil, nil).normalize,
		**options
	)
end

.parse(string, endpoint = nil, **options) ⇒ Object 



33
34
35
36
37
 
# File 'lib/async/http/endpoint.rb', line 33

def self.parse(string, endpoint = nil, **options)
	url = URI.parse(string).normalize
	
	return self.new(url, endpoint, **options)
end

Instance Method Details

#address ⇒ Object 



105
106
107
 
# File 'lib/async/http/endpoint.rb', line 105

def address
	endpoint.address
end

#alpn_protocols ⇒ Object 



163
164
165
 
# File 'lib/async/http/endpoint.rb', line 163

def alpn_protocols
	@options.fetch(:alpn_protocols) {self.protocol.names}
end

#authority(ignore_default_port = true) ⇒ Object 



144
145
146
147
148
149
150
 
# File 'lib/async/http/endpoint.rb', line 144

def authority(ignore_default_port = true)
	if ignore_default_port and default_port?
		@url.hostname
	else
		"#{@url.hostname}:#{port}"
	end
end

#bind(*arguments, &block) ⇒ Object 



215
216
217
 
# File 'lib/async/http/endpoint.rb', line 215

def bind(*arguments, &block)
	endpoint.bind(*arguments, &block)
end

#build_endpoint(endpoint = nil) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/async/http/endpoint.rb', line 192

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 



219
220
221
 
# File 'lib/async/http/endpoint.rb', line 219

def connect(&block)
	endpoint.connect(&block)
end

#default_port ⇒ Object 



123
124
125
 
# File 'lib/async/http/endpoint.rb', line 123

def default_port
	secure? ? 443 : 80
end

#default_port? ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/async/http/endpoint.rb', line 127

def default_port?
	port == default_port
end

#each ⇒ Object 



223
224
225
226
227
228
229
 
# File 'lib/async/http/endpoint.rb', line 223

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 



207
208
209
 
# File 'lib/async/http/endpoint.rb', line 207

def endpoint
	@endpoint ||= build_endpoint
end

#endpoint=(endpoint) ⇒ Object 



211
212
213
 
# File 'lib/async/http/endpoint.rb', line 211

def endpoint=(endpoint)
	@endpoint = build_endpoint(endpoint)
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
 
# File 'lib/async/http/endpoint.rb', line 235

def eql? other
	self.key.eql? other.key
end

#hash ⇒ Object 



239
240
241
 
# File 'lib/async/http/endpoint.rb', line 239

def hash
	self.key.hash
end

#hostname ⇒ Object

The hostname is the server we are connecting to:



136
137
138
 
# File 'lib/async/http/endpoint.rb', line 136

def hostname
	@options[:hostname] || @url.hostname
end

#inspect ⇒ Object 



99
100
101
 
# File 'lib/async/http/endpoint.rb', line 99

def inspect
	"\#<#{self.class} #{self.to_url} #{@options.inspect}>"
end

#key ⇒ Object 



231
232
233
 
# File 'lib/async/http/endpoint.rb', line 231

def key
	[@url, @options]
end

#localhost? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/async/http/endpoint.rb', line 167

def localhost?
	@url.hostname =~ /^(.*?\.)?localhost\.?$/
end

#path ⇒ Object

Return the path and query components of the given URL.



153
154
155
156
157
158
159
160
161
 
# File 'lib/async/http/endpoint.rb', line 153

def path
	buffer = @url.path || "/"
	
	if query = @url.query
		buffer = "#{buffer}?#{query}"
	end
	
	return buffer
end

#port ⇒ Object 



131
132
133
 
# File 'lib/async/http/endpoint.rb', line 131

def port
	@options[:port] || @url.port || default_port
end

#protocol ⇒ Object 



113
114
115
116
117
118
119
120
121
 
# File 'lib/async/http/endpoint.rb', line 113

def protocol
	@options.fetch(:protocol) do
		if secure?
			Protocol::HTTPS
		else
			Protocol::HTTP
		end
	end
end

#scheme ⇒ Object 



140
141
142
 
# File 'lib/async/http/endpoint.rb', line 140

def scheme
	@options[:scheme] || @url.scheme
end

#secure? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/async/http/endpoint.rb', line 109

def secure?
	["https", "wss"].include?(self.scheme)
end

#ssl_context ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/async/http/endpoint.rb', line 180

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.



172
173
174
175
176
177
178
 
# File 'lib/async/http/endpoint.rb', line 172

def ssl_verify_mode
	if self.localhost?
		OpenSSL::SSL::VERIFY_NONE
	else
		OpenSSL::SSL::VERIFY_PEER
	end
end

#to_s ⇒ Object 



95
96
97
 
# File 'lib/async/http/endpoint.rb', line 95

def to_s
	"\#<#{self.class} #{self.to_url} #{@options}>"
end

#to_url ⇒ Object 



85
86
87
88
89
90
91
92
93
 
# File 'lib/async/http/endpoint.rb', line 85

def to_url
	url = @url.dup
	
	unless default_port?
		url.port = self.port
	end
	
	return url
end