Class: VCR::Request::Typed

Inherits:
self
  • Object
show all
Defined in:
lib/vcr/structs.rb

Overview

Decorates a VCR::Request with its current type.

Direct Known Subclasses

FiberAware

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request, type) ⇒ Typed

Returns a new instance of Typed.

Parameters:

  • request (Request)

    the request

  • type (Symbol)

    the type. Should be one of :ignored, :stubbed, :recordable or :unhandled.


240
241
242
243
# File 'lib/vcr/structs.rb', line 240

def initialize(request, type)
  @type = type
  super(request)
end

Instance Attribute Details

#typeSymbol (readonly)

Returns One of :ignored, :stubbed, :recordable or :unhandled.

Returns:

  • (Symbol)

    One of :ignored, :stubbed, :recordable or :unhandled.


236
237
238
# File 'lib/vcr/structs.rb', line 236

def type
  @type
end

Instance Method Details

#externally_stubbed?Boolean

Returns whether or not this request is being stubbed by an external library (such as WebMock).

Returns:

  • (Boolean)

    whether or not this request is being stubbed by an external library (such as WebMock).

See Also:


261
262
263
# File 'lib/vcr/structs.rb', line 261

def externally_stubbed?
  type == :externally_stubbed
end

#ignored?Boolean

Returns whether or not this request is being ignored.

Returns:

  • (Boolean)

    whether or not this request is being ignored


246
247
248
# File 'lib/vcr/structs.rb', line 246

def ignored?
  type == :ignored
end

#real?Boolean

Note:

VCR allows :ignored and :recordable requests to be made for real.

Returns whether or not this request will be made for real.

Returns:

  • (Boolean)

    whether or not this request will be made for real.


277
278
279
# File 'lib/vcr/structs.rb', line 277

def real?
  ignored? || recordable?
end

#recordable?Boolean

Returns whether or not this request will be recorded.

Returns:

  • (Boolean)

    whether or not this request will be recorded.


266
267
268
# File 'lib/vcr/structs.rb', line 266

def recordable?
  type == :recordable
end

#stubbed?Boolean

Returns whether or not this request will be stubbed. It may be stubbed by an external library or by VCR.

Returns:

  • (Boolean)

    whether or not this request will be stubbed. It may be stubbed by an external library or by VCR.

See Also:


285
286
287
# File 'lib/vcr/structs.rb', line 285

def stubbed?
  stubbed_by_vcr? || externally_stubbed?
end

#stubbed_by_vcr?Boolean

Returns whether or not this request is being stubbed by VCR.

Returns:

  • (Boolean)

    whether or not this request is being stubbed by VCR

See Also:


253
254
255
# File 'lib/vcr/structs.rb', line 253

def stubbed_by_vcr?
  type == :stubbed_by_vcr
end

#unhandled?Boolean

Returns whether or not VCR knows how to handle this request.

Returns:

  • (Boolean)

    whether or not VCR knows how to handle this request.


271
272
273
# File 'lib/vcr/structs.rb', line 271

def unhandled?
  type == :unhandled
end