forked from vcr/vcr
-
Notifications
You must be signed in to change notification settings - Fork 15
/
structs.rb
556 lines (483 loc) · 16.5 KB
/
structs.rb
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
require 'base64'
require 'delegate'
require 'time'
module VCR
# @private
module Normalizers
# @private
module Body
def self.included(klass)
klass.extend ClassMethods
end
# @private
module ClassMethods
def body_from(hash_or_string)
return hash_or_string unless hash_or_string.is_a?(Hash)
hash = hash_or_string
if hash.has_key?('base64_string')
string = Base64.decode64(hash['base64_string'])
force_encode_string(string, hash['encoding'])
else
try_encode_string(hash['string'], hash['encoding'])
end
end
if "".respond_to?(:encoding)
def force_encode_string(string, encoding)
return string unless encoding
string.force_encoding(encoding)
end
def try_encode_string(string, encoding)
return string if encoding.nil? || string.encoding.name == encoding
# ASCII-8BIT just means binary, so encoding to it is nonsensical
# and yet "\u00f6".encode("ASCII-8BIT") raises an error.
# Instead, we'll force encode it (essentially just tagging it as binary)
return string.force_encoding(encoding) if encoding == "ASCII-8BIT"
string.encode(encoding)
rescue EncodingError => e
struct_type = name.split('::').last.downcase
warn "VCR: got `#{e.class.name}: #{e.message}` while trying to encode the #{string.encoding.name} " +
"#{struct_type} body to the original body encoding (#{encoding}). Consider using the " +
"`:preserve_exact_body_bytes` option to work around this."
return string
end
else
def force_encode_string(string, encoding)
string
end
def try_encode_string(string, encoding)
string
end
end
end
def initialize(*args)
super
if body && !body.is_a?(String)
raise ArgumentError, "#{self.class} initialized with an invalid body: #{body.inspect}."
end
# Ensure that the body is a raw string, in case the string instance
# has been subclassed or extended with additional instance variables
# or attributes, so that it is serialized to YAML as a raw string.
# This is needed for rest-client. See this ticket for more info:
# http://github.com/myronmarston/vcr/issues/4
self.body = String.new(body.to_s)
end
private
def serializable_body
if VCR.configuration.preserve_exact_body_bytes_for?(self)
base_body_hash(body).merge('base64_string' => Base64.encode64(body))
else
base_body_hash(body).merge('string' => body)
end
end
if ''.respond_to?(:encoding)
def base_body_hash(body)
{ 'encoding' => body.encoding.name }
end
else
def base_body_hash(body)
{ }
end
end
end
# @private
module Header
def initialize(*args)
super
normalize_headers
end
private
def normalize_headers
new_headers = {}
@normalized_header_keys = Hash.new {|h,k| k }
headers.each do |k, v|
val_array = case v
when Array then v
when nil then []
else [v]
end
new_headers[String.new(k)] = convert_to_raw_strings(val_array)
@normalized_header_keys[k.downcase] = k
end if headers
self.headers = new_headers
end
def header_key(key)
key = @normalized_header_keys[key.downcase]
key if headers.has_key? key
end
def get_header(key)
key = header_key(key)
headers[key] if key
end
def edit_header(key, value = nil)
if key = header_key(key)
value ||= yield headers[key]
headers[key] = Array(value)
end
end
def delete_header(key)
if key = header_key(key)
@normalized_header_keys.delete key.downcase
headers.delete key
end
end
def convert_to_raw_strings(array)
# Ensure the values are raw strings.
# Apparently for Paperclip uploads to S3, headers
# get serialized with some extra stuff which leads
# to a seg fault. See this issue for more info:
# https://github.com/myronmarston/vcr/issues#issue/39
array.map do |v|
case v
when String; String.new(v)
when Array; convert_to_raw_strings(v)
else v
end
end
end
end
end
# @private
module OrderedHashSerializer
def each
@ordered_keys.each do |key|
yield key, self[key]
end
end
if RUBY_VERSION =~ /1.9/
# 1.9 hashes are already ordered.
def self.apply_to(*args); end
else
def self.apply_to(hash, keys)
hash.instance_variable_set(:@ordered_keys, keys)
hash.extend self
end
end
end
# The request of an {HTTPInteraction}.
#
# @attr [Symbol] method the HTTP method (i.e. :head, :options, :get, :post, :put, :patch or :delete)
# @attr [String] uri the request URI
# @attr [String, nil] body the request body
# @attr [Hash{String => Array<String>}] headers the request headers
class Request < Struct.new(:method, :uri, :body, :headers)
include Normalizers::Header
include Normalizers::Body
def initialize(*args)
skip_port_stripping = false
if args.last == :skip_port_stripping
skip_port_stripping = true
args.pop
end
super(*args)
self.method = self.method.to_s.downcase.to_sym if self.method
self.uri = without_standard_port(self.uri) unless skip_port_stripping
end
# Builds a serializable hash from the request data.
#
# @return [Hash] hash that represents this request and can be easily
# serialized.
# @see Request.from_hash
def to_hash
{
'method' => method.to_s,
'uri' => uri,
'body' => serializable_body,
'headers' => headers
}.tap { |h| OrderedHashSerializer.apply_to(h, members) }
end
# Constructs a new instance from a hash.
#
# @param [Hash] hash the hash to use to construct the instance.
# @return [Request] the request
def self.from_hash(hash)
method = hash['method']
method &&= method.to_sym
new method,
hash['uri'],
body_from(hash['body']),
hash['headers'],
:skip_port_stripping
end
@@object_method = Object.instance_method(:method)
def method(*args)
return super if args.empty?
@@object_method.bind(self).call(*args)
end
# Decorates a {Request} with its current type.
class Typed < DelegateClass(self)
# @return [Symbol] One of `:ignored`, `:stubbed`, `:recordable` or `:unhandled`.
attr_reader :type
# @param [Request] request the request
# @param [Symbol] type the type. Should be one of `:ignored`, `:stubbed`, `:recordable` or `:unhandled`.
def initialize(request, type)
@type = type
super(request)
end
# @return [Boolean] whether or not this request is being ignored
def ignored?
type == :ignored
end
# @return [Boolean] whether or not this request is being stubbed by VCR
# @see #externally_stubbed?
# @see #stubbed?
def stubbed_by_vcr?
type == :stubbed_by_vcr
end
# @return [Boolean] whether or not this request is being stubbed by an
# external library (such as WebMock or FakeWeb).
# @see #stubbed_by_vcr?
# @see #stubbed?
def externally_stubbed?
type == :externally_stubbed
end
# @return [Boolean] whether or not this request will be recorded.
def recordable?
type == :recordable
end
# @return [Boolean] whether or not VCR knows how to handle this request.
def unhandled?
type == :unhandled
end
# @return [Boolean] whether or not this request will be made for real.
# @note VCR allows `:ignored` and `:recordable` requests to be made for real.
def real?
ignored? || recordable?
end
# @return [Boolean] whether or not this request will be stubbed.
# It may be stubbed by an external library or by VCR.
# @see #stubbed_by_vcr?
# @see #externally_stubbed?
def stubbed?
stubbed_by_vcr? || externally_stubbed?
end
undef method
end
# Provides fiber-awareness for the {VCR::Configuration#around_http_request} hook.
class FiberAware < DelegateClass(Typed)
# Yields the fiber so the request can proceed.
#
# @return [VCR::Response] the response from the request
def proceed
Fiber.yield
end
# Builds a proc that allows the request to proceed when called.
# This allows you to treat the request as a proc and pass it on
# to a method that yields (at which point the request will proceed).
#
# @return [Proc] the proc
def to_proc
lambda { proceed }
end
undef method
end
private
def without_standard_port(uri)
return uri if uri.nil?
u = URI(uri)
return uri unless [['http', 80], ['https', 443]].include?([u.scheme, u.port])
u.port = nil
u.to_s
end
end
# The response of an {HTTPInteraction}.
#
# @attr [ResponseStatus] status the status of the response
# @attr [Hash{String => Array<String>}] headers the response headers
# @attr [String] body the response body
# @attr [nil, String] http_version the HTTP version
class Response < Struct.new(:status, :headers, :body, :http_version)
include Normalizers::Header
include Normalizers::Body
# Builds a serializable hash from the response data.
#
# @return [Hash] hash that represents this response
# and can be easily serialized.
# @see Response.from_hash
def to_hash
{
'status' => status.to_hash,
'headers' => headers,
'body' => serializable_body,
'http_version' => http_version
}.tap { |h| OrderedHashSerializer.apply_to(h, members) }
end
# Constructs a new instance from a hash.
#
# @param [Hash] hash the hash to use to construct the instance.
# @return [Response] the response
def self.from_hash(hash)
new ResponseStatus.from_hash(hash.fetch('status', {})),
hash['headers'],
body_from(hash['body']),
hash['http_version']
end
# Updates the Content-Length response header so that it is
# accurate for the response body.
def update_content_length_header
edit_header('Content-Length') { body ? body.bytesize.to_s : '0' }
end
# The type of encoding.
#
# @return [String] encoding type
def content_encoding
enc = get_header('Content-Encoding') and enc.first
end
# Checks if the type of encoding is one of "gzip" or "deflate".
def compressed?
%w[ gzip deflate ].include? content_encoding
end
# Decodes the compressed body and deletes evidence that it was ever compressed.
#
# @return self
# @raise [VCR::Errors::UnknownContentEncodingError] if the content encoding
# is not a known encoding.
def decompress
self.class.decompress(body, content_encoding) { |new_body|
self.body = new_body
update_content_length_header
delete_header('Content-Encoding')
}
return self
end
begin
require 'zlib'
require 'stringio'
HAVE_ZLIB = true
rescue LoadError
HAVE_ZLIB = false
end
# Decode string compressed with gzip or deflate
#
# @raise [VCR::Errors::UnknownContentEncodingError] if the content encoding
# is not a known encoding.
def self.decompress(body, type)
unless HAVE_ZLIB
warn "VCR: cannot decompress response; Zlib not available"
return
end
case type
when 'gzip'
args = [StringIO.new(body)]
args << { :encoding => 'ASCII-8BIT' } if ''.respond_to?(:encoding)
yield Zlib::GzipReader.new(*args).read
when 'deflate'
yield Zlib::Inflate.inflate(body)
when 'identity', NilClass
return
else
raise Errors::UnknownContentEncodingError, "unknown content encoding: #{type}"
end
end
end
# The response status of an {HTTPInteraction}.
#
# @attr [Integer] code the HTTP status code
# @attr [String] message the HTTP status message (e.g. "OK" for a status of 200)
class ResponseStatus < Struct.new(:code, :message)
# Builds a serializable hash from the response status data.
#
# @return [Hash] hash that represents this response status
# and can be easily serialized.
# @see ResponseStatus.from_hash
def to_hash
{
'code' => code, 'message' => message
}.tap { |h| OrderedHashSerializer.apply_to(h, members) }
end
# Constructs a new instance from a hash.
#
# @param [Hash] hash the hash to use to construct the instance.
# @return [ResponseStatus] the response status
def self.from_hash(hash)
new hash['code'], hash['message']
end
end
# Represents a single interaction over HTTP, containing a request and a response.
#
# @attr [Request] request the request
# @attr [Response] response the response
# @attr [Time] recorded_at when this HTTP interaction was recorded
class HTTPInteraction < Struct.new(:request, :response, :recorded_at)
def initialize(*args)
super
self.recorded_at ||= Time.now
end
# Builds a serializable hash from the HTTP interaction data.
#
# @return [Hash] hash that represents this HTTP interaction
# and can be easily serialized.
# @see HTTPInteraction.from_hash
def to_hash
{
'request' => request.to_hash,
'response' => response.to_hash,
'recorded_at' => recorded_at.httpdate
}.tap do |hash|
OrderedHashSerializer.apply_to(hash, members)
end
end
# Constructs a new instance from a hash.
#
# @param [Hash] hash the hash to use to construct the instance.
# @return [HTTPInteraction] the HTTP interaction
def self.from_hash(hash)
new Request.from_hash(hash.fetch('request', {})),
Response.from_hash(hash.fetch('response', {})),
Time.httpdate(hash.fetch('recorded_at'))
end
# @return [HookAware] an instance with additional capabilities
# suitable for use in `before_record` and `before_playback` hooks.
def hook_aware
HookAware.new(self)
end
# Decorates an {HTTPInteraction} with additional methods useful
# for a `before_record` or `before_playback` hook.
class HookAware < DelegateClass(HTTPInteraction)
def initialize(http_interaction)
@ignored = false
super
end
# Flags the HTTP interaction so that VCR ignores it. This is useful in
# a {VCR::Configuration#before_record} or {VCR::Configuration#before_playback}
# hook so that VCR does not record or play it back.
# @see #ignored?
def ignore!
@ignored = true
end
# @return [Boolean] whether or not this HTTP interaction should be ignored.
# @see #ignore!
def ignored?
!!@ignored
end
# Replaces a string in any part of the HTTP interaction (headers, request body,
# response body, etc) with the given replacement text.
#
# @param [#to_s] text the text to replace
# @param [#to_s] replacement_text the text to put in its place
def filter!(text, replacement_text)
text, replacement_text = text.to_s, replacement_text.to_s
return self if [text, replacement_text].any? { |t| t.empty? }
filter_object!(self, text, replacement_text)
end
private
def filter_object!(object, text, replacement_text)
if object.respond_to?(:gsub)
object.gsub!(text, replacement_text) if object.include?(text)
elsif Hash === object
filter_hash!(object, text, replacement_text)
elsif object.respond_to?(:each)
# This handles nested arrays and structs
object.each { |o| filter_object!(o, text, replacement_text) }
end
object
end
def filter_hash!(hash, text, replacement_text)
filter_object!(hash.values, text, replacement_text)
hash.keys.each do |k|
new_key = filter_object!(k.dup, text, replacement_text)
hash[new_key] = hash.delete(k) unless k == new_key
end
end
end
end
end