Class: Errbit::Result

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

Overview

Outcome of a Client#notify call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, status_code: nil, id: nil, created_at: nil, error: nil) ⇒ Result

Returns a new instance of Result.



20
21
22
23
24
25
26
 
# File 'lib/errbit/result.rb', line 20

def initialize(status:, status_code: nil, id: nil, created_at: nil, error: nil)
  @status = status
  @status_code = status_code
  @id = id
  @created_at = created_at
  @error = error
end

Instance Attribute Details

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



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

def error
  @error
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



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

def status
  @status
end

#status_code ⇒ Object (readonly)

Returns the value of attribute status_code.



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

def status_code
  @status_code
end

Class Method Details

.failure(status_code:, error:) ⇒ Object 



16
17
18
 
# File 'lib/errbit/result.rb', line 16

def self.failure(status_code:, error:)
  new(status: :failure, status_code: status_code, error: error)
end

.ignored ⇒ Object 



8
9
10
 
# File 'lib/errbit/result.rb', line 8

def self.ignored
  new(status: :ignored)
end

.success(status_code:, id:, created_at:) ⇒ Object 



12
13
14
 
# File 'lib/errbit/result.rb', line 12

def self.success(status_code:, id:, created_at:)
  new(status: :success, status_code: status_code, id: id, created_at: created_at)
end

Instance Method Details

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/errbit/result.rb', line 36

def failure?
  status == :failure
end

#ignored? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/errbit/result.rb', line 32

def ignored?
  status == :ignored
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/errbit/result.rb', line 28

def success?
  status == :success
end