Class: OxTenderAbstract::Result

Inherits:
Object
  • Object
show all
Defined in:
lib/oxtenderabstract/result.rb

Overview

Result structure for API operations

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(success:, data: nil, error: nil, metadata: {}) ⇒ Result

Returns a new instance of Result.



8
9
10
11
12
13
 
# File 'lib/oxtenderabstract/result.rb', line 8

def initialize(success:, data: nil, error: nil, metadata: {})
  @success = success
  @data = data
  @error = error
  @metadata = metadata
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



6
7
8
 
# File 'lib/oxtenderabstract/result.rb', line 6

def data
  @data
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



6
7
8
 
# File 'lib/oxtenderabstract/result.rb', line 6

def error
  @error
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



6
7
8
 
# File 'lib/oxtenderabstract/result.rb', line 6

def metadata
  @metadata
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



6
7
8
 
# File 'lib/oxtenderabstract/result.rb', line 6

def success
  @success
end

Class Method Details

.failure(error, metadata = {}) ⇒ Object 



27
28
29
 
# File 'lib/oxtenderabstract/result.rb', line 27

def self.failure(error, metadata = {})
  new(success: false, error:, metadata:)
end

.success(data, metadata = {}) ⇒ Object 



23
24
25
 
# File 'lib/oxtenderabstract/result.rb', line 23

def self.success(data, metadata = {})
  new(success: true, data:, metadata:)
end

Instance Method Details

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/oxtenderabstract/result.rb', line 19

def failure?
  !@success
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/oxtenderabstract/result.rb', line 15

def success?
  @success
end