class HammerCLIForeman::ExceptionHandler

Public Instance Methods

mappings() click to toggle source
Calls superclass method
# File lib/hammer_cli_foreman/exception_handler.rb, line 7
def mappings
  super + [
    [HammerCLIForeman::OperationNotSupportedError, :handle_unsupported_operation],
    [RestClient::InternalServerError, :handle_internal_error],
    [RestClient::Forbidden, :handle_forbidden],
    [RestClient::UnprocessableEntity, :handle_unprocessable_entity],
    [RestClient::MovedPermanently, :handle_moved_permanently],
    [RestClient::BadRequest, :handle_bad_request],
    [HammerCLIForeman::Api::UnauthorizedError, :handle_foreman_unauthorized],
    [HammerCLIForeman::Api::SessionExpired, :handle_sesion_expired],
    [ArgumentError, :handle_argument_error],
  ]
end

Protected Instance Methods

handle_argument_error(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 60
def handle_argument_error(e)
  print_error e.message
  log_full_error e
  HammerCLI::EX_USAGE
end
handle_bad_request(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 109
def handle_bad_request(e)
  print_error "#{e.message}#{response_message(e.response)}"
  log_full_error e
  HammerCLI::EX_DATAERR
end
handle_forbidden(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 67
def handle_forbidden(e)
  if e.response
    response = JSON.parse(e.response)
    error = response['error']
    if error && error['message'] && error['details']
      message = error['message'] + "\n" + error['details']
    end
  end
  message ||= _("Forbidden - server refused to process the request.")

  print_error message
  log_full_error e
  HammerCLI::EX_NOPERM
end
handle_foreman_error(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 96
def handle_foreman_error(e)
  begin
    response = JSON.parse(e.response)
    response = HammerCLIForeman.record_to_common_format(response) unless response.has_key?('message')
    message = response['message'] || e.message
  rescue JSON::ParserError => parse_e
    message = e.message
  end

  print_error message
  log_full_error e
end
handle_foreman_unauthorized(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 28
def handle_foreman_unauthorized(e)
  print_error e.message
  log_full_error e
  HammerCLI::EX_UNAUTHORIZED
end
handle_internal_error(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 54
def handle_internal_error(e)
  handle_foreman_error(e)
  HammerCLI::EX_SOFTWARE
end
handle_moved_permanently(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 42
def handle_moved_permanently(e)
  error = [_("Redirection of API call detected.")]
  https_message = _("It seems hammer is configured to use HTTP and the server prefers HTTPS.")
  error << https_message if strip_protocol(e.response.headers[:location]) == strip_protocol(e.response.request.url)
  error << _("Update your server url configuration.")
  error << _("You can set 'follow_redirects' to one of :default or :always to enable redirects following.")
  print_error error.join("\n")
  log_full_error e
  HammerCLI::EX_CONFIG
end
handle_not_found(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 90
def handle_not_found(e)
  handle_foreman_error(e)
  HammerCLI::EX_NOT_FOUND
end
handle_sesion_expired(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 23
def handle_sesion_expired(e)
  log_full_error e
  HammerCLI::EX_RETRY
end
handle_unprocessable_entity(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 34
def handle_unprocessable_entity(e)
  response = JSON.parse(e.response)
  response = HammerCLIForeman.record_to_common_format(response) unless response.has_key?('message')
  print_error response['message'] || response['full_messages']
  HammerCLI::EX_DATAERR
end
handle_unsupported_operation(e) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 83
def handle_unsupported_operation(e)
  print_error e.message
  log_full_error e
  HammerCLI::EX_UNAVAILABLE
end
rake_command() click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 144
def rake_command
  "foreman-rake apipie:cache"
end
ssl_cert_instructions() click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 115
def ssl_cert_instructions
  host_url = HammerCLI::Settings.get(:_params, :host) || HammerCLI::Settings.get(:foreman, :host)
  uri = URI.parse(host_url)
  ssl_option = HammerCLI::SSLOptions.new.get_options(uri)
  if uri.host.nil?
    host = '<FOREMAN_HOST>'
    cert_name = "#{host}.crt"
  else
    host = uri.to_s
    cert_name = "#{uri.host}.crt"
  end

  cmd = "hammer --fetch-ca-cert #{host}"

  if !ssl_option[:ssl_ca_path].nil? || !ssl_option[:ssl_ca_file].nil?
    instructions = _("The following configuration option were used for the SSL connection:" ) + "\n"
    instructions << "  ssl_ca_path = #{ssl_option[:ssl_ca_path]}\n" unless ssl_option[:ssl_ca_path].nil?
    instructions << "  ssl_ca_file = #{ssl_option[:ssl_ca_file]}\n" unless ssl_option[:ssl_ca_file].nil?
    instructions << "\n" + _("Make sure the location contains an unexpired and valid CA certificate for %s.") % host_url
  else
    instructions = _("You can use hammer to fetch the CA certificate from the server. Be aware that hammer cannot verify whether the certificate is correct and you should verify its authenticity after downloading it.")
    instructions << "\n\n" + _("Download the certificate as follows:")
    instructions << "\n\n  $ #{cmd}\n\n"
  end

  _("Make sure you configured the correct URL and have the server's CA certificate installed on your system.") +
      "\n\n" + instructions
end

Private Instance Methods

response_message(response) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 150
def response_message(response)
  message = JSON.parse(response)["error"]["message"]
  "\n  #{message}"
rescue JSON::ParserError
  ''
end
strip_protocol(url) click to toggle source
# File lib/hammer_cli_foreman/exception_handler.rb, line 157
def strip_protocol(url)
  url.gsub(%r'^http(s)?://','').gsub(%r'//', '/')
end