Class: Reply

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

Constant Summary collapse

STATUS_ERROR = 
0
STATUS_SUCCESS = 
1
STATUS_WARNING = 
2

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Reply

Returns a new instance of Reply.



8
9
10
11
12
 
# File 'lib/reply/reply.rb', line 8

def initialize(params={})
  @messages = params[:messages] || []
  @status = params[:status] || STATUS_SUCCESS
  @data = params[:data] || {}
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



2
3
4
 
# File 'lib/reply/reply.rb', line 2

def data
  @data
end

#messages ⇒ Object

Returns the value of attribute messages.



2
3
4
 
# File 'lib/reply/reply.rb', line 2

def messages
  @messages
end

#status ⇒ Object

Returns the value of attribute status.



2
3
4
 
# File 'lib/reply/reply.rb', line 2

def status
  @status
end

Instance Method Details

#add_error(message) ⇒ Object 



34
35
36
37
 
# File 'lib/reply/reply.rb', line 34

def add_error(message)
  add_message(message)
  mark_as_error
end

#add_errors(array) ⇒ Object 



39
40
41
42
 
# File 'lib/reply/reply.rb', line 39

def add_errors(array)
  add_messages(array)
  mark_as_error
end

#add_message(message) ⇒ Object 



18
19
20
 
# File 'lib/reply/reply.rb', line 18

def add_message(message)
  @messages << message
end

#add_messages(array) ⇒ Object 



22
23
24
 
# File 'lib/reply/reply.rb', line 22

def add_messages(array)
  @messages = @messages | array
end

#clear_messages ⇒ Object 



14
15
16
 
# File 'lib/reply/reply.rb', line 14

def clear_messages
  @messages.clear
end

#error? ⇒ Boolean Also known as: failure?

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/reply/reply.rb', line 64

def error?
  @status == STATUS_ERROR
end

#mark_as_error ⇒ Object Also known as: error! 



44
45
46
 
# File 'lib/reply/reply.rb', line 44

def mark_as_error
  @status = STATUS_ERROR
end

#mark_as_success ⇒ Object Also known as: success! 



54
55
56
 
# File 'lib/reply/reply.rb', line 54

def mark_as_success
  @status = STATUS_SUCCESS
end

#mark_as_warning ⇒ Object Also known as: warning! 



49
50
51
 
# File 'lib/reply/reply.rb', line 49

def mark_as_warning
  @status = STATUS_WARNING
end

#replace_messages(array) ⇒ Object 



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

def replace_messages(array)
  @messages = array
end

#replace_messages_with_errors_for(object) ⇒ Object 



30
31
32
 
# File 'lib/reply/reply.rb', line 30

def replace_messages_with_errors_for(object)
  @messages = object.errors.full_messages
end

#success? ⇒ Boolean Also known as: successful?

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/reply/reply.rb', line 59

def success?
  @status == STATUS_SUCCESS
end

#warning? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/reply/reply.rb', line 69

def warning?
  @status == STATUS_WARNING
end