1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
# Represents the response returned from the server from an HTTP request.
#
# @api abstract
# @api public
class Puppet::HTTP::Response
# @return [URI] the response url
attr_reader :url
# Create a response associated with the URL.
#
# @param [URI] url
# @param [Integer] HTTP status
# @param [String] HTTP reason
def initialize(url, code, reason)
@url = url
@code = code
@reason = reason
end
# Return the response code.
#
# @return [Integer] Response code for the request
#
# @api public
def code
@code
end
# Return the response message.
#
# @return [String] Response message for the request
#
# @api public
def reason
@reason
end
# Returns the entire response body. Can be used instead of
# `Puppet::HTTP::Response.read_body`, but both methods cannot be used for the
# same response.
#
# @return [String] Response body for the request
#
# @api public
def body
raise NotImplementedError
end
# Streams the response body to the caller in chunks. Can be used instead of
# `Puppet::HTTP::Response.body`, but both methods cannot be used for the same
# response.
#
# @yield [String] Streams the response body in chunks
#
# @raise [ArgumentError] raise if a block is not given
#
# @api public
def read_body(&block)
raise NotImplementedError
end
# Check if the request received a response of success (HTTP 2xx).
#
# @return [Boolean] Returns true if the response indicates success
#
# @api public
def success?
200 <= @code && @code < 300
end
# Get a header case-insensitively.
#
# @param [String] name The header name
# @return [String] The header value
#
# @api public
def [](name)
raise NotImplementedError
end
# Yield each header name and value. Returns an enumerator if no block is given.
#
# @yieldparam [String] header name
# @yieldparam [String] header value
#
# @api public
def each_header(&block)
raise NotImplementedError
end
# Ensure the response body is fully read so that the server is not blocked
# waiting for us to read data from the socket. Also if the caller streamed
# the response, but didn't read the data, we need a way to drain the socket
# before adding the connection back to the connection pool, otherwise the
# unread response data would "leak" into the next HTTP request/response.
#
# @api public
def drain
body
true
end
end
|
