Module: PatientHttp::RequestHelper::ClassMethods

Includes:

HttpMethodHelpers

Defined in:

lib/patient_http/request_helper.rb

Instance Method Summary

• #async_request(method, url, callback:, headers: nil, body: nil, json: nil, params: nil, timeout: nil, raise_error_responses: nil, callback_args: nil, preprocessors: nil, processor: nil) ⇒ Object

  Builds and dispatches an asynchronous HTTP request.

• #async_request_template ⇒ RequestTemplate^? private

  Returns the RequestTemplate defined for this class or its ancestors, or nil if none is defined.

• #request_template(base_url: nil, headers: {}, params: nil, timeout: 30, preprocessors: nil, processor: nil) ⇒ void

  Defines a default request template for this class.

Methods included from HttpMethodHelpers

#async_delete, #async_get, #async_patch, #async_post, #async_put

Instance Method Details

#async_request(method, url, callback:, headers: nil, body: nil, json: nil, params: nil, timeout: nil, raise_error_responses: nil, callback_args: nil, preprocessors: nil, processor: nil) ⇒ Object

Builds and dispatches an asynchronous HTTP request.

When a request template is configured, the request is built from the template. Otherwise, it is built directly from the provided arguments.

Parameters:

• method (Symbol) —

  HTTP method (:get, :post, :put, :patch, :delete)

• url (String) —

  absolute URL or path (when using a request template)

• callback (Class, String) —

  callback class to handle the response

• headers (Hash, nil) (defaults to: nil) —

  request headers

• body (String, nil) (defaults to: nil) —

  raw request body

• json (Hash, Array, nil) (defaults to: nil) —

  JSON payload encoded by the request layer

• params (Hash, nil) (defaults to: nil) —

  query parameters

• timeout (Numeric, nil) (defaults to: nil) —

  timeout in seconds for this request

• raise_error_responses (Boolean, nil) (defaults to: nil) —

  when true, non-success responses are reported as errors

• callback_args (Hash, nil) (defaults to: nil) —

  JSON-compatible callback arguments

• preprocessors (String, Symbol, Array<String, Symbol>, nil) (defaults to: nil) —

  names of preprocessors registered on the configuration to apply to the request when it is sent

• processor (String, Symbol, nil) (defaults to: nil) —

  name of the processor that should execute the request

Returns:

• (Object) —

  return value from the registered request handler

# File 'lib/patient_http/request_helper.rb', line 153

def async_request(
  method,
  url,
  callback:,
  headers: nil,
  body: nil,
  json: nil,
  params: nil,
  timeout: nil,
  raise_error_responses: nil,
  callback_args: nil,
  preprocessors: nil,
  processor: nil
)
  template = async_request_template
  kwargs = {body: body, json: json, headers: headers, params: params, timeout: timeout, preprocessors: preprocessors, processor: processor}
  request = if template
    template.request(method, url, **kwargs)
  else
    Request.new(method, url, **kwargs)
  end

  PatientHttp.execute(
    request: request,
    callback: callback,
    callback_args: callback_args,
    raise_error_responses: raise_error_responses
  )
end

#async_request_template ⇒ RequestTemplate^?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the RequestTemplate defined for this class or its ancestors, or nil if none is defined. This allows subclasses to inherit the request template from their parent class if they don't define their own.

Returns:

• (RequestTemplate, nil) —

  the request template for this class or its ancestors

# File 'lib/patient_http/request_helper.rb', line 189

def async_request_template
  return @patient_http_request_template if @patient_http_request_template
  return superclass.async_request_template if superclass.include?(PatientHttp::RequestHelper)

  nil
end

#request_template(base_url: nil, headers: {}, params: nil, timeout: 30, preprocessors: nil, processor: nil) ⇒ void

This method returns an undefined value.

Defines a default request template for this class.

Requests created with the helper methods merge these defaults unless explicitly overridden.

Parameters:

• base_url (String, nil) (defaults to: nil) —

  optional base URL used to resolve relative request URLs

• headers (Hash) (defaults to: {}) —

  default headers for requests

• params (Hash, nil) (defaults to: nil) —

  default query parameters for requests

• timeout (Float) (defaults to: 30) —

  default timeout in seconds

• preprocessors (String, Symbol, Array<String, Symbol>, nil) (defaults to: nil) —

  default names of preprocessors registered on the configuration to apply to requests

• processor (String, Symbol, nil) (defaults to: nil) —

  default processor name for requests

# File 'lib/patient_http/request_helper.rb', line 121

def request_template(base_url: nil, headers: {}, params: nil, timeout: 30, preprocessors: nil, processor: nil)
  @patient_http_request_template = RequestTemplate.new(
    base_url: base_url,
    headers: headers,
    params: params,
    timeout: timeout,
    preprocessors: preprocessors,
    processor: processor
  )
end