Class: Ezid::Response Private

Inherits:
SimpleDelegator
  • Object
show all
Defined in:
lib/ezid/responses/response.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A response from the EZID service.

Constant Summary collapse

SUCCESS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Success response status

"success"
ERROR =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Error response status

"error"

Instance Method Summary collapse

Instance Method Details

#content ⇒ Array

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The body of the response split into: status line and rest of body

Returns:

  • (Array) —

    status line, rest of body



31
32
33
 
# File 'lib/ezid/responses/response.rb', line 31

def content
  @content ||= body.split(/\r?\n/, 2)
end

#error? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Whether the outcome was an error

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/ezid/responses/response.rb', line 49

def error?
  outcome == ERROR
end

#exception ⇒ Ezid::Error

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns an exception instance if there was an error

Returns:



61
62
63
 
# File 'lib/ezid/responses/response.rb', line 61

def exception
  @exception ||= (error? && Error.new(message))
end

#message ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The EZID status message

Returns:

  • (String) —

    the message



43
44
45
 
# File 'lib/ezid/responses/response.rb', line 43

def message
  status.last
end

#outcome ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The outcome of the request - “success” or “error”

Returns:

  • (String) —

    the outcome



37
38
39
 
# File 'lib/ezid/responses/response.rb', line 37

def outcome
  status.first
end

#status ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The response status – “success” or “error”

Returns:

  • (String) —

    the status



19
20
21
 
# File 'lib/ezid/responses/response.rb', line 19

def status
  @status ||= status_line.split(/: /)
end

#status_line ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The status line of the response

Returns:

  • (String) —

    the status line



25
26
27
 
# File 'lib/ezid/responses/response.rb', line 25

def status_line
  content[0]
end

#success? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Whether the outcome was a success

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/ezid/responses/response.rb', line 55

def success?
  outcome == SUCCESS
end

#uri_path ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The URI path of the request

Returns:

  • (String) —

    the path



67
68
69
 
# File 'lib/ezid/responses/response.rb', line 67

def uri_path
  __getobj__.uri.path
end