Class: Seahorse::Client::Request

Inherits:
Object
  • Object
show all
Includes:
HandlerBuilder
Defined in:
lib/seahorse/client/request.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from HandlerBuilder

#handle, #handle_request, #handle_response, #handler_for, #new_handler

Constructor Details

#initialize(handlers, context) ⇒ Request

Returns a new instance of Request.

Parameters:



11
12
13
14
 
# File 'lib/seahorse/client/request.rb', line 11

def initialize(handlers, context)
  @handlers = handlers
  @context = context
end

Instance Attribute Details

#context ⇒ RequestContext (readonly)

Returns:



20
21
22
 
# File 'lib/seahorse/client/request.rb', line 20

def context
  @context
end

#handlers ⇒ HandlerList (readonly)

Returns:



17
18
19
 
# File 'lib/seahorse/client/request.rb', line 17

def handlers
  @handlers
end

Instance Method Details

#send_request(options = {}, &block) ⇒ Response

Sends the request, returning a Seahorse::Client::Response object.

response = request.send_request

# Streaming Responses

By default, HTTP responses are buffered into memory. This can be bad if you are downloading large responses, e.g. large files. You can avoid this by streaming the response to a block or some other target.

## Streaming to a File

You can stream the raw HTTP response body to a File, or any IO-like object, by passing the ‘:target` option.

# create a new file at the given path
request.send_request(target: '/path/to/target/file')

# or provide an IO object to write to
File.open('photo.jpg', 'wb') do |file|
  request.send_request(target: file)
end

**Please Note**: The target IO object may receive ‘#truncate(0)` if the request generates a networking error and bytes have already been written to the target.

## Block Streaming

Pass a block to ‘#send_request` and the response will be yielded in chunks to the given block.

# stream the response data
request.send_request do |chunk|
  file.write(chunk)
end

**Please Note**: When streaming to a block, it is not possible to retry failed requests.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :target (String, IO) —

    When specified, the HTTP response body is written to target. This is helpful when you are sending a request that may return a large payload that you don’t want to load into memory.

Returns:



70
71
72
73
 
# File 'lib/seahorse/client/request.rb', line 70

def send_request(options = {}, &block)
  @context[:response_target] = options[:target] || block
  @handlers.to_stack.call(@context)
end