class VCR::HTTPInteraction::HookAware - vcr-2.3.0 Documentation

Public Instance Methods

Source

# File lib/vcr/structs.rb, line 532
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

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

ignore! ()

Source

# File lib/vcr/structs.rb, line 517
def ignore!
  @ignored = true
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?

ignored? ()

Source

# File lib/vcr/structs.rb, line 523
def ignored?
  !!@ignored
end

@return [Boolean] whether or not this HTTP interaction should be ignored. @see ignore!

Private Instance Methods

filter_hash! (hash, text, replacement_text)

Source

# File lib/vcr/structs.rb, line 553
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

filter_object! (object, text, replacement_text)

Source

# File lib/vcr/structs.rb, line 540
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