Class: Async::HTTP::Endpoint

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

Constant Summary collapse

DEFAULT_ALPN_PROTOCOLS = 
['h2', 'http/1.1'].freeze
LOCALHOST = 
'localhost'.freeze

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

  • port (Hash) —

    a customizable set of options

  • hostname (Hash) —

    a customizable set of options

  • ssl_context (Hash) —

    a customizable set of options

  • alpn_protocols (Hash) —

    a customizable set of options

Raises:

  • (ArgumentError) 


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

def initialize(url, endpoint = nil, **options)
  super(**options)
  
  raise ArgumentError, "URL must be absolute (include scheme, host): #{url}" unless url.absolute?
  
  @url = url
  @endpoint = endpoint
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



70
71
72
 
# File 'lib/async/http/endpoint.rb', line 70

def options
  @options
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



69
70
71
 
# File 'lib/async/http/endpoint.rb', line 69

def url
  @url
end

Class Method Details

.parse(string, **options) ⇒ Object 



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

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

Instance Method Details

#address ⇒ Object 



72
73
74
 
# File 'lib/async/http/endpoint.rb', line 72

def address
  endpoint.address
end

#alpn_protocols ⇒ Object 



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

def alpn_protocols
  @options[:alpn_protocols] || DEFAULT_ALPN_PROTOCOLS
end

#authority ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/async/http/endpoint.rb', line 108

def authority
  if default_port?
    hostname
  else
    "#{hostname}:#{port}"
  end
end

#bind(*args, &block) ⇒ Object 



188
189
190
 
# File 'lib/async/http/endpoint.rb', line 188

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

#build_endpoint(endpoint = nil) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/async/http/endpoint.rb', line 169

def build_endpoint(endpoint = nil)
  endpoint ||= Async::IO::Endpoint.tcp(hostname, port, tcp_options)
  
  if secure?
    # Wrap it in SSL:
    return Async::IO::SSLEndpoint.new(endpoint,
      ssl_context: self.ssl_context,
      hostname: self.hostname,
      timeout: self.timeout,
    )
  end
  
  return endpoint
end

#connect(&block) ⇒ Object 



192
193
194
 
# File 'lib/async/http/endpoint.rb', line 192

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

#default_port ⇒ Object 



88
89
90
 
# File 'lib/async/http/endpoint.rb', line 88

def default_port
  secure? ? 443 : 80
end

#default_port? ⇒ Boolean

Returns:

  • (Boolean) 


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

def default_port?
  port == default_port
end

#each ⇒ Object 



196
197
198
199
200
201
202
 
# File 'lib/async/http/endpoint.rb', line 196

def each
  return to_enum unless block_given?
  
  self.endpoint.each do |endpoint|
    yield self.class.new(@url, endpoint, @options)
  end
end

#endpoint ⇒ Object 



184
185
186
 
# File 'lib/async/http/endpoint.rb', line 184

def endpoint
  @endpoint ||= build_endpoint
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#hash ⇒ Object 



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

def hash
  self.key.hash
end

#hostname ⇒ Object 



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

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

#inspect ⇒ Object 



65
66
67
 
# File 'lib/async/http/endpoint.rb', line 65

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

#key ⇒ Object 



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

def key
  [@url.scheme, @url.userinfo, @url.host, @url.port, @options]
end

#path ⇒ Object

Return the path and query components of the given URL.



117
118
119
120
121
122
123
124
125
 
# File 'lib/async/http/endpoint.rb', line 117

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

#port ⇒ Object 



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

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

#protocol ⇒ Object 



80
81
82
83
84
85
86
 
# File 'lib/async/http/endpoint.rb', line 80

def protocol
  if secure?
    Protocol::HTTPS
  else
    Protocol::HTTP1
  end
end

#scheme ⇒ Object 



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

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

#secure? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/async/http/endpoint.rb', line 76

def secure?
  ['https', 'wss'].include?(@url.scheme)
end

#ssl_context ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/async/http/endpoint.rb', line 145

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.



136
137
138
139
140
141
142
143
 
# File 'lib/async/http/endpoint.rb', line 136

def ssl_verify_mode
  case self.hostname
  when LOCALHOST
    OpenSSL::SSL::VERIFY_NONE
  else
    OpenSSL::SSL::VERIFY_PEER
  end
end

#tcp_options ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/async/http/endpoint.rb', line 157

def tcp_options
  options = @options.dup
  
  options.delete(:scheme)
  options.delete(:port)
  options.delete(:hostname)
  options.delete(:ssl_context)
  options.delete(:alpn_protocols)
  
  return options
end

#to_s ⇒ Object 



61
62
63
 
# File 'lib/async/http/endpoint.rb', line 61

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

#to_url ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'lib/async/http/endpoint.rb', line 51

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