Class: Google::Apis::Core::HttpCommand

Inherits:
Object
  • Object
show all
Includes:
Logging
Defined in:
lib/google/apis/core/http_command.rb

Overview

Command for HTTP request/response.

Direct Known Subclasses

ApiCommand, BatchCommand

Constant Summary collapse

RETRIABLE_ERRORS =
[Google::Apis::ServerError, Google::Apis::RateLimitError, Google::Apis::TransmissionError]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

#logger

Constructor Details

#initialize(method, url, body: nil) ⇒ HttpCommand

Returns a new instance of HttpCommand

Parameters:

  • method (symbol)

    HTTP method

  • url (String, Addressable::URI, Addressable::Template)

    HTTP URL or template

  • body (String, #read)

    Request body


77
78
79
80
81
82
83
84
85
86
87
# File 'lib/google/apis/core/http_command.rb', line 77

def initialize(method, url, body: nil)
  self.options = Google::Apis::RequestOptions.default.dup
  self.url = url
  self.url = Addressable::Template.new(url) if url.is_a?(String)
  self.method = method
  self.header = Hash.new
  self.body = body
  self.query = {}
  self.params = {}
  @opencensus_span = nil
end

Instance Attribute Details

#body#read

Request body

Returns:

  • (#read)

53
54
55
# File 'lib/google/apis/core/http_command.rb', line 53

def body
  @body
end

#connectionHTTPClient

HTTP Client

Returns:

  • (HTTPClient)

61
62
63
# File 'lib/google/apis/core/http_command.rb', line 61

def connection
  @connection
end

#headerHash

HTTP headers

Returns:

  • (Hash)

49
50
51
# File 'lib/google/apis/core/http_command.rb', line 49

def header
  @header
end

#methodsymbol

HTTP method

Returns:

  • (symbol)

57
58
59
# File 'lib/google/apis/core/http_command.rb', line 57

def method
  @method
end

#optionsGoogle::Apis::RequestOptions

Request options


41
42
43
# File 'lib/google/apis/core/http_command.rb', line 41

def options
  @options
end

#paramsHash

Path params for URL Template

Returns:

  • (Hash)

69
70
71
# File 'lib/google/apis/core/http_command.rb', line 69

def params
  @params
end

#queryHash

Query params

Returns:

  • (Hash)

65
66
67
# File 'lib/google/apis/core/http_command.rb', line 65

def query
  @query
end

#urlString, Addressable::URI

HTTP request URL

Returns:

  • (String, Addressable::URI)

45
46
47
# File 'lib/google/apis/core/http_command.rb', line 45

def url
  @url
end

Instance Method Details

#allow_form_encoding?Boolean

Returns:

  • (Boolean)

330
331
332
# File 'lib/google/apis/core/http_command.rb', line 330

def allow_form_encoding?
  [:post, :put].include?(method) && body.nil?
end

#apply_request_options(req_header)

This method returns an undefined value.

Update the request with any specified options.

Parameters:

  • header (Hash)

    HTTP headers


321
322
323
324
325
326
327
328
# File 'lib/google/apis/core/http_command.rb', line 321

def apply_request_options(req_header)
  if options.authorization.respond_to?(:apply!)
    options.authorization.apply!(req_header)
  elsif options.authorization.is_a?(String)
    req_header['Authorization'] = sprintf('Bearer %s', options.authorization)
  end
  req_header.update(header)
end

#authorization_refreshable?Boolean

Check if attached credentials can be automatically refreshed

Returns:

  • (Boolean)

144
145
146
# File 'lib/google/apis/core/http_command.rb', line 144

def authorization_refreshable?
  options.authorization.respond_to?(:apply!)
end

#check_status(status, header = nil, body = nil, message = nil)

This method returns an undefined value.

Check the response and raise error if needed

Parameters:

  • status (Fixnum)

    HTTP status code of response

  • header (Hash) (defaults to: nil)

    HTTP response headers

  • body (String) (defaults to: nil)

    HTTP response body

  • message (String) (defaults to: nil)

    Error message text

Raises:


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/google/apis/core/http_command.rb', line 212

def check_status(status, header = nil, body = nil, message = nil)
  # TODO: 304 Not Modified depends on context...
  case status
  when 200...300
    nil
  when 301, 302, 303, 307
    message ||= sprintf('Redirect to %s', header['Location'])
    raise Google::Apis::RedirectError.new(message, status_code: status, header: header, body: body)
  when 401
    message ||= 'Unauthorized'
    raise Google::Apis::AuthorizationError.new(message, status_code: status, header: header, body: body)
  when 429
    message ||= 'Rate limit exceeded'
    raise Google::Apis::RateLimitError.new(message, status_code: status, header: header, body: body)
  when 304, 400, 402...500
    message ||= 'Invalid request'
    raise Google::Apis::ClientError.new(message, status_code: status, header: header, body: body)
  when 500...600
    message ||= 'Server error'
    raise Google::Apis::ServerError.new(message, status_code: status, header: header, body: body)
  else
    logger.warn(sprintf('Encountered unexpected status code %s', status))
    message ||= 'Unknown error'
    raise Google::Apis::TransmissionError.new(message, status_code: status, header: header, body: body)
  end
end

#decode_response_body(_content_type, body) ⇒ Object

Process the actual response body. Intended to be overridden by subclasses

Parameters:

  • _content_type (String)

    Content type of body

  • body (String, #read)

    Response body

Returns:

  • (Object)

246
247
248
# File 'lib/google/apis/core/http_command.rb', line 246

def decode_response_body(_content_type, body)
  body
end

#error(err, rethrow: false) {|nil, err| ... }

This method returns an undefined value.

Process an error response

Parameters:

  • err (StandardError)

    Error object

  • rethrow (Boolean)

    True if error should be raised again after handling

Yields:

  • (nil, err)

    if block given

Raises:

  • (StandardError)

    if no block


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
# File 'lib/google/apis/core/http_command.rb', line 269

def error(err, rethrow: false, &block)
  logger.debug { sprintf('Error - %s', PP.pp(err, '')) }
  if err.is_a?(HTTPClient::BadResponseError)
    begin
      res = err.res
      check_status(res.status.to_i, res.header, res.body)
    rescue Google::Apis::Error => e
      err = e
    end
  elsif err.is_a?(HTTPClient::TimeoutError) || err.is_a?(SocketError)
    err = Google::Apis::TransmissionError.new(err)
  end
  block.call(nil, err) if block_given?
  fail err if rethrow || block.nil?
end

#execute(client) {|result, err| ... } ⇒ Object

Execute the command, retrying as necessary

Parameters:

  • client (HTTPClient)

    HTTP client

Yields:

  • (result, err)

    Result or error if block supplied

Returns:

  • (Object)

Raises:


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/google/apis/core/http_command.rb', line 98

def execute(client)
  prepare!
  opencensus_begin_span
  begin
    Retriable.retriable tries: options.retries + 1,
                        base_interval: 1,
                        multiplier: 2,
                        on: RETRIABLE_ERRORS do |try|
      # This 2nd level retriable only catches auth errors, and supports 1 retry, which allows
      # auth to be re-attempted without having to retry all sorts of other failures like
      # NotFound, etc
      auth_tries = (try == 1 && authorization_refreshable? ? 2 : 1)
      Retriable.retriable tries: auth_tries,
                          on: [Google::Apis::AuthorizationError, Signet::AuthorizationError, Signet::RemoteServerError, Signet::UnexpectedStatusError],
                          on_retry: proc { |*| refresh_authorization } do
        execute_once(client).tap do |result|
          if block_given?
            yield result, nil
          end
        end
      end
    end
  rescue => e
    if block_given?
      yield nil, e
    else
      raise e
    end
  end
ensure
  opencensus_end_span
  @http_res = nil
  release!
end

#process_response(status, header, body) ⇒ Object

Check the response and either decode body or raise error

Parameters:

  • status (Fixnum)

    HTTP status code of response

  • header (Hash)

    Response headers

  • body (String, #read)

    Response body

Returns:

  • (Object)

    Response object

Raises:


192
193
194
195
# File 'lib/google/apis/core/http_command.rb', line 192

def process_response(status, header, body)
  check_status(status, header, body)
  decode_response_body(header['Content-Type'].first, body)
end

#success(result) {|result, nil| ... } ⇒ Object

Process a success response

Parameters:

  • result (Object)

    Result object

Yields:

  • (result, nil)

    if block given

Returns:

  • (Object)

    result if no block given


255
256
257
258
259
# File 'lib/google/apis/core/http_command.rb', line 255

def success(result, &block)
  logger.debug { sprintf('Success - %s', safe_object_representation(result)) }
  block.call(result, nil) if block_given?
  result
end