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) 


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

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.



101
102
103
 
# File 'lib/async/http/endpoint.rb', line 101

def url
  @url
end

Class Method Details

.[](url) ⇒ Object

Coerce the given object into an endpoint.



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

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.



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

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 



31
32
33
34
35
 
# File 'lib/async/http/endpoint.rb', line 31

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

Instance Method Details

#address ⇒ Object 



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

def address
  endpoint.address
end

#alpn_protocols ⇒ Object 



161
162
163
 
# File 'lib/async/http/endpoint.rb', line 161

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

#authority(ignore_default_port = true) ⇒ Object 



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

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 



213
214
215
 
# File 'lib/async/http/endpoint.rb', line 213

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

#build_endpoint(endpoint = nil) ⇒ Object 



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

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 



217
218
219
 
# File 'lib/async/http/endpoint.rb', line 217

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

#default_port ⇒ Object 



121
122
123
 
# File 'lib/async/http/endpoint.rb', line 121

def default_port
  secure? ? 443 : 80
end

#default_port? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/async/http/endpoint.rb', line 125

def default_port?
  port == default_port
end

#each ⇒ Object 



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

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 



205
206
207
 
# File 'lib/async/http/endpoint.rb', line 205

def endpoint
  @endpoint ||= build_endpoint
end

#endpoint=(endpoint) ⇒ Object 



209
210
211
 
# File 'lib/async/http/endpoint.rb', line 209

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

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


233
234
235
 
# File 'lib/async/http/endpoint.rb', line 233

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

#hash ⇒ Object 



237
238
239
 
# File 'lib/async/http/endpoint.rb', line 237

def hash
  self.key.hash
end

#hostname ⇒ Object

The hostname is the server we are connecting to:



134
135
136
 
# File 'lib/async/http/endpoint.rb', line 134

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

#inspect ⇒ Object 



97
98
99
 
# File 'lib/async/http/endpoint.rb', line 97

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

#key ⇒ Object 



229
230
231
 
# File 'lib/async/http/endpoint.rb', line 229

def key
  [@url, @options]
end

#localhost? ⇒ Boolean

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/async/http/endpoint.rb', line 165

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

#path ⇒ Object

Return the path and query components of the given URL.



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

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

#port ⇒ Object 



129
130
131
 
# File 'lib/async/http/endpoint.rb', line 129

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

#protocol ⇒ Object 



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

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

#scheme ⇒ Object 



138
139
140
 
# File 'lib/async/http/endpoint.rb', line 138

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

#secure? ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/async/http/endpoint.rb', line 107

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

#ssl_context ⇒ Object 



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

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.



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

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

#to_s ⇒ Object 



93
94
95
 
# File 'lib/async/http/endpoint.rb', line 93

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

#to_url ⇒ Object 



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

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