Class: PatientHttp::RequestTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/patient_http/request_template.rb

Overview

The RequestTemplate is used to build HTTP requests with shared configuration.

Use RequestTemplate when you need to make multiple requests to the same API with shared configuration (base URL, headers, timeout).

The RequestTemplate handles building HTTP requests with proper URL joining, header merging, and parameter encoding.

Examples:

Basic usage

template = PatientHttp::RequestTemplate.new(
  base_url: "https://api.example.com",
  headers: {"Authorization" => "Bearer token"},
  timeout: 60
)
request = template.get("/users/123")

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url: nil, headers: {}, params: nil, timeout: 30, preprocessors: nil) ⇒ RequestTemplate

Initializes a new RequestTemplate.

Parameters:

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

    Base URL for relative URIs

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

    Default headers for all requests

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

    Default query parameters to add to all requests

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

    Default request timeout in seconds

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

    Default preprocessors to apply to all requests



37
38
39
40
41
42
43
 
# File 'lib/patient_http/request_template.rb', line 37

def initialize(base_url: nil, headers: {}, params: nil, timeout: 30, preprocessors: nil)
  @base_url = base_url
  @headers = HttpHeaders.new(headers)
  @params = params
  @timeout = timeout
  @preprocessors = preprocessors
end

Instance Attribute Details

#base_url ⇒ String, ...

Returns Base URL for relative URIs.

Returns:

  • (String, URI::HTTP, nil) —

    Base URL for relative URIs



21
22
23
 
# File 'lib/patient_http/request_template.rb', line 21

def base_url
  @base_url
end

#headers ⇒ HttpHeaders

Returns Default headers for all requests.

Returns:



24
25
26
 
# File 'lib/patient_http/request_template.rb', line 24

def headers
  @headers
end

#timeout ⇒ Float

Returns Default request timeout in seconds.

Returns:

  • (Float) —

    Default request timeout in seconds



27
28
29
 
# File 'lib/patient_http/request_template.rb', line 27

def timeout
  @timeout
end

Instance Method Details

#delete(uri, **kwargs) ⇒ Request

Convenience method for DELETE requests.

Parameters:

  • uri (String, URI::HTTP) —

    URI path to request

  • kwargs (Hash) —

    additional options (see #request)

Returns:



116
117
118
 
# File 'lib/patient_http/request_template.rb', line 116

def delete(uri, **kwargs)
  request(:delete, uri, **kwargs)
end

#get(uri, **kwargs) ⇒ Request

Convenience method for GET requests.

Parameters:

  • uri (String, URI::HTTP) —

    URI path to request

  • kwargs (Hash) —

    additional options (see #request)

Returns:



80
81
82
 
# File 'lib/patient_http/request_template.rb', line 80

def get(uri, **kwargs)
  request(:get, uri, **kwargs)
end

#patch(uri, **kwargs) ⇒ Request

Convenience method for PATCH requests.

Parameters:

  • uri (String, URI::HTTP) —

    URI path to request

  • kwargs (Hash) —

    additional options (see #request)

Returns:



107
108
109
 
# File 'lib/patient_http/request_template.rb', line 107

def patch(uri, **kwargs)
  request(:patch, uri, **kwargs)
end

#post(uri, **kwargs) ⇒ Request

Convenience method for POST requests.

Parameters:

  • uri (String, URI::HTTP) —

    URI path to request

  • kwargs (Hash) —

    additional options (see #request)

Returns:



89
90
91
 
# File 'lib/patient_http/request_template.rb', line 89

def post(uri, **kwargs)
  request(:post, uri, **kwargs)
end

#put(uri, **kwargs) ⇒ Request

Convenience method for PUT requests.

Parameters:

  • uri (String, URI::HTTP) —

    URI path to request

  • kwargs (Hash) —

    additional options (see #request)

Returns:



98
99
100
 
# File 'lib/patient_http/request_template.rb', line 98

def put(uri, **kwargs)
  request(:put, uri, **kwargs)
end

#request(method, uri, body: nil, json: nil, headers: nil, params: nil, timeout: nil, preprocessors: nil) ⇒ Request

Build an async HTTP request. Returns a Request object.

Parameters:

  • method (Symbol) —

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

  • uri (String, URI::HTTP) —

    URI path to request (joined with base_url if relative)

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

    request body

  • json (Object, nil) (defaults to: nil) —

    JSON object to serialize (cannot use with body)

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

    additional headers to merge with client headers

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

    query parameters to add to URL

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

    preprocessors to apply to the request (overrides the template default)

Returns:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/patient_http/request_template.rb', line 56

def request(method, uri, body: nil, json: nil, headers: nil, params: nil, timeout: nil, preprocessors: nil)
  full_uri = @base_url ? URI.join(@base_url, uri.to_s) : URI(uri)

  merged_headers = headers&.any? ? @headers.merge(headers) : @headers
  merged_params = @params ? (@params.merge(params || {})) : params

  # Create request with all parameters
  Request.new(
    method,
    full_uri.to_s,
    headers: merged_headers.to_h,
    body: body,
    json: json,
    params: merged_params,
    timeout: timeout || @timeout,
    preprocessors: preprocessors || @preprocessors
  )
end