Savon

Heavy metal SOAP client

GitHub RubyGems

Observer Hooks

Savon has one global way of adding observers to any request.

class Observer
  def notify(operation_name, builder, globals, locals)
    nil
  end
end

Savon.observers << Observer.new

Savon calls the #notify method of every observer in the order they were added and passes the name of the operation that is being called, the builder which can be asked for the generated request XML and any global and local options.

In the previous example, we’re explicitly returning nil from the #notify method to allow Savon to continue and execute the request. But you can also return a Savon::Transport::Response to mock the request. Only the last registered observer’s return value decides: if it returns a Savon::Transport::Response the request is mocked, and if it returns nil the request executes — an earlier observer’s response is discarded. Returning anything else raises Savon::Error. (Returning an HTTPI::Response still works but is deprecated.)

class Observer
  def notify(operation_name, builder, globals, locals)
    code    = 200
    headers = {}
    body    = ""

    Savon::Transport::Response.new(code, headers, body)
  end
end

Savon.observers << Observer.new

Clear the observers if you don’t need them.

Savon.observers.clear