Exception: FloopFloop::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/floopfloop/error.rb

Overview

Single exception type raised on every non-2xx response and on network / timeout failures. Inspect ‘#code` (a String matching the taxonomy the Node / Python / Go / Rust SDKs share) to branch, not the class — unknown server codes pass through verbatim in `#code` rather than raising a subclass we’d have to keep in sync.

Known codes: UNAUTHORIZED, FORBIDDEN, VALIDATION_ERROR, RATE_LIMITED, NOT_FOUND, CONFLICT, SERVICE_UNAVAILABLE, SERVER_ERROR, NETWORK_ERROR, TIMEOUT, BUILD_FAILED, BUILD_CANCELLED, UNKNOWN.

Example:

begin
  client.projects.status("p_1")
rescue FloopFloop::Error => e
  case e.code
  when "RATE_LIMITED"  then sleep(e.retry_after || 5)
  when "UNAUTHORIZED"  then abort "Check your FLOOP_API_KEY."
  else raise
  end
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code:, message:, status: 0, request_id: nil, retry_after: nil) ⇒ Error

Returns a new instance of Error.



28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/floopfloop/error.rb', line 28

def initialize(code:, message:, status: 0, request_id: nil, retry_after: nil)
  @code        = code
  @status      = status
  @request_id  = request_id
  @retry_after = retry_after
  # Stash the raw message in our own ivar. Ruby's Exception#message
  # and Exception#to_s call each other by default, so if we override
  # #to_s and call #message from inside it we hit infinite recursion
  # on Ruby 3.1+. Reading @raw_message directly avoids the loop.
  @raw_message = message
  super(message)
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



26
27
28
 
# File 'lib/floopfloop/error.rb', line 26

def code
  @code
end

#request_id ⇒ Object (readonly)

Returns the value of attribute request_id.



26
27
28
 
# File 'lib/floopfloop/error.rb', line 26

def request_id
  @request_id
end

#retry_after ⇒ Object (readonly)

Returns the value of attribute retry_after.



26
27
28
 
# File 'lib/floopfloop/error.rb', line 26

def retry_after
  @retry_after
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



26
27
28
 
# File 'lib/floopfloop/error.rb', line 26

def status
  @status
end

Class Method Details

.parse_retry_after(header) ⇒ Object

Parse a Retry-After header value per RFC 7231 — accepts either delta-seconds or HTTP-date. Returns nil on unparseable / empty.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/floopfloop/error.rb', line 61

def self.parse_retry_after(header)
  return nil if header.nil? || header.empty?

  begin
    secs = Float(header)
    return nil if secs.negative?

    return secs
  rescue ArgumentError
    # Fall through to HTTP-date parsing.
  end

  begin
    require "time"
    when_ = Time.httpdate(header)
    delta = when_ - Time.now
    return [delta, 0].max
  rescue ArgumentError
    nil
  end
end

Instance Method Details

#message ⇒ Object

#message returns the raw server-side message so ‘err.message` is the string the backend sent. #to_s returns the prettified “floop: [CODE STATUS] message (request X)” form useful for logging. By default Ruby’s Exception has both delegate to each other, but splitting them cleanly lets callers choose.



46
47
48
 
# File 'lib/floopfloop/error.rb', line 46

def message
  @raw_message
end

#to_s ⇒ Object 



50
51
52
53
54
55
56
57
 
# File 'lib/floopfloop/error.rb', line 50

def to_s
  parts = +"floop: ["
  parts << code.to_s
  parts << " #{status}" unless status.nil? || status.zero?
  parts << "] #{@raw_message}"
  parts << " (request #{request_id})" if request_id
  parts
end