Files

Class/Module Index [+]

Quicksearch

God::Conditions::HttpResponseCode

Condition Symbol :http_response_code Type: Poll

Trigger based on the response from an HTTP request.

Paramaters

 Required
   +host+ is the hostname to connect [required]
   --one of code_is or code_is_not--
   +code_is+ trigger if the response code IS one of these
             e.g. 500 or '500' or [404, 500] or %w{404 500}
   +code_is_not+ trigger if the response code IS NOT one of these
                 e.g. 200 or '200' or [200, 302] or %w{200 302}
Optional
   +port+ is the port to connect (default 80)
   +path+ is the path to connect (default '/')
   +headers+ is the hash of HTTP headers to send (default none)
   +times+ is the number of times after which to trigger (default 1)
           e.g. 3 (times in a row) or [3, 5] (three out of fives times)
   +timeout+ is the time to wait for a connection (default 60.seconds)
   +ssl+ should the connection use ssl (default false)

Examples

Trigger if the response code from www.example.com/foo/bar is not a 200 (or if the connection is refused or times out:

on.condition(:http_response_code) do |c|
  c.host = 'www.example.com'
  c.path = '/foo/bar'
  c.code_is_not = 200
end

Trigger if the response code is a 404 or a 500 (will not be triggered by a connection refusal or timeout):

on.condition(:http_response_code) do |c|
  c.host = 'www.example.com'
  c.path = '/foo/bar'
  c.code_is = [404, 500]
end

Trigger if the response code is not a 200 five times in a row:

on.condition(:http_response_code) do |c|
  c.host = 'www.example.com'
  c.path = '/foo/bar'
  c.code_is_not = 200
  c.times = 5
end

Trigger if the response code is not a 200 or does not respond within 10 seconds:

on.condition(:http_response_code) do |c|
  c.host = 'www.example.com'
  c.path = '/foo/bar'
  c.code_is_not = 200
  c.timeout = 10
end

Attributes

ca_file[RW]
code_is[RW]
code_is_not[RW]
headers[RW]
host[RW]
path[RW]
port[RW]
ssl[RW]
timeout[RW]
times[RW]

Public Class Methods

new() click to toggle source
# File lib/god/conditions/http_response_code.rb, line 79
def initialize
  super
  self.port = 80
  self.path = '/'
  self.headers = {}
  self.times = [1, 1]
  self.timeout = 60.seconds
  self.ssl = false
  self.ca_file = nil
end

Public Instance Methods

prepare() click to toggle source
# File lib/god/conditions/http_response_code.rb, line 90
def prepare
  self.code_is = Array(self.code_is).map { |x| x.to_i } if self.code_is
  self.code_is_not = Array(self.code_is_not).map { |x| x.to_i } if self.code_is_not

  if self.times.kind_of?(Integer)
    self.times = [self.times, self.times]
  end

  @timeline = Timeline.new(self.times[1])
  @history = Timeline.new(self.times[1])
end
reset() click to toggle source
# File lib/god/conditions/http_response_code.rb, line 102
def reset
  @timeline.clear
  @history.clear
end
test() click to toggle source
# File lib/god/conditions/http_response_code.rb, line 115
def test
  response = nil

  connection = Net::HTTP.new(self.host, self.port)
  connection.use_ssl = self.port == 443 ? true : self.ssl
  connection.verify_mode = OpenSSL::SSL::VERIFY_NONE if connection.use_ssl?

  if connection.use_ssl? && self.ca_file
    pem = File.read(self.ca_file)
    connection.ca_file = self.ca_file
    connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
  end

  connection.start do |http|
    http.read_timeout = self.timeout
    response = http.get(self.path, self.headers)
  end

  actual_response_code = response.code.to_i
  if self.code_is && self.code_is.include?(actual_response_code)
    pass(actual_response_code)
  elsif self.code_is_not && !self.code_is_not.include?(actual_response_code)
    pass(actual_response_code)
  else
    fail(actual_response_code)
  end
rescue Errno::ECONNREFUSED
  self.code_is ? fail('Refused') : pass('Refused')
rescue Errno::ECONNRESET
  self.code_is ? fail('Reset') : pass('Reset')
rescue EOFError
  self.code_is ? fail('EOF') : pass('EOF')
rescue Timeout::Error
  self.code_is ? fail('Timeout') : pass('Timeout')
rescue Errno::ETIMEDOUT
  self.code_is ? fail('Timedout') : pass('Timedout')
rescue Exception => failure
  self.code_is ? fail(failure.class.name) : pass(failure.class.name)
end
valid?() click to toggle source
# File lib/god/conditions/http_response_code.rb, line 107
def valid?
  valid = true
  valid &= complain("Attribute 'host' must be specified", self) if self.host.nil?
  valid &= complain("One (and only one) of attributes 'code_is' and 'code_is_not' must be specified", self) if
    (self.code_is.nil? && self.code_is_not.nil?) || (self.code_is && self.code_is_not)
  valid
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.