Class: Basecamp::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/basecamp/http.rb

Overview

Wraps an HTTP response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body:, status:, headers:) ⇒ Response

Returns a new instance of Response.



818
819
820
821
822
 
# File 'lib/basecamp/http.rb', line 818

def initialize(body:, status:, headers:)
  @body = body
  @status = status
  @headers = headers
end

Instance Attribute Details

#body ⇒ String (readonly)

Returns response body.

Returns:

  • (String) —

    response body



810
811
812
 
# File 'lib/basecamp/http.rb', line 810

def body
  @body
end

#headers ⇒ Hash (readonly)

Returns response headers.

Returns:

  • (Hash) —

    response headers



816
817
818
 
# File 'lib/basecamp/http.rb', line 816

def headers
  @headers
end

#status ⇒ Integer (readonly)

Returns HTTP status code.

Returns:

  • (Integer) —

    HTTP status code



813
814
815
 
# File 'lib/basecamp/http.rb', line 813

def status
  @status
end

Instance Method Details

#json ⇒ Hash, Array

Parses the response body as JSON, normalizing Person-shaped objects.

Returns:

  • (Hash, Array) 


826
827
828
829
830
831
832
833
 
# File 'lib/basecamp/http.rb', line 826

def json
  @json ||= begin
    Security.check_body_size!(@body, Security::MAX_RESPONSE_BODY_BYTES)
    result = JSON.parse(@body)
    Http.normalize_person_ids(result)
    result
  end
end

#success? ⇒ Boolean

Returns whether the response was successful (2xx).

Returns:

  • (Boolean) 


837
838
839
 
# File 'lib/basecamp/http.rb', line 837

def success?
  status >= 200 && status < 300
end