class Typhoeus::Expectation

This class represents an expectation. It is part of the stubbing mechanism. An expectation contains an url and options, like a request. They were compared to the request url and options in order to evaluate wether they match. If thats the case, the attached responses were returned one by one.

@example Stub a request and get specified response.

expected = Typhoeus::Response.new
Typhoeus.stub("www.example.com").and_return(expected)

actual = Typhoeus.get("www.example.com")
expected == actual
#=> true

Attributes

from[R]

@api private

options[R]

@api private

url[R]

@api private

Public Class Methods

all() click to toggle source

Returns all expectations.

@example Return expectations.

Typhoeus::Expectation.all

@return [ Array<Typhoeus::Expectation> ] The expectations.

# File lib/typhoeus/expectation.rb, line 36
def all
  @expectations ||= []
end

clear() click to toggle source

Clears expectations. This is handy while testing and you want to make sure, that you don’t get canned responses.

@example Clear expectations.

Typhoeus::Expectation.clear

# File lib/typhoeus/expectation.rb, line 46
def clear
  all.clear
end

find_by(request) click to toggle source

Returns expecation matching the provided request.

@example Find expectation.

Typhoeus::Expectation.find_by(request)

@return [ Expectation ] The matching expectation.

@api private

# File lib/typhoeus/expectation.rb, line 59
def find_by(request)
  all.find do |expectation|
    expectation.matches?(request)
  end
end

new(url, options = {}) click to toggle source

Creates an expactation.

@example Create expactation.

Typhoeus::Expectation.new(url)

@return [ Expectation ] The created expactation.

@api private

# File lib/typhoeus/expectation.rb, line 74
def initialize(url, options = {})
  @url = url
  @options = options
  @response_counter = 0
  @from = nil
end

Public Instance Methods

and_return(response) click to toggle source

Specify what should be returned, when this expactation is hit.

@example Add response.

expectation.and_return(response)

@return [ void ]

# File lib/typhoeus/expectation.rb, line 104
def and_return(response)
  responses << response
end

matches?(request) click to toggle source

Checks wether this expectation matches the provided request.

@example Check if request matches.

expectation.matches? request

@param [ Request ] request The request to check.

@return [ Boolean ] True when matches, else false.

@api private

# File lib/typhoeus/expectation.rb, line 119
def matches?(request)
  url_match?(request.url) &&
    (options ? options.all?{ |k,v| request.original_options[k] == v } : true)
end

response() click to toggle source

Return the response. When there are multiple responses, they were returned one by one.

@example Return response.

expectation.response

@return [ Response ] The response.

@api private

# File lib/typhoeus/expectation.rb, line 146
def response
  response = responses.fetch(@response_counter, responses.last)
  @response_counter += 1
  response.mock = @from || true
  response
end

responses() click to toggle source

Return canned responses.

@example Return responses.

expectation.responses

@return [ Array<Typhoeus::Response> ] The responses.

@api private

# File lib/typhoeus/expectation.rb, line 132
def responses
  @responses ||= []
end

stubbed_from(value) click to toggle source

Set from value to mark an expecation. Useful for other libraries, eg. webmock.

@example Mark expecation.

expecation.from(:webmock)

@param [ String ] value Value to set.

@return [ Expectation ] Returns self.

@api private

# File lib/typhoeus/expectation.rb, line 92
def stubbed_from(value)
  @from = value
  self
end