Class: Reply

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

Constant Summary collapse

SIMPLE_STATUS_ERROR = 
0
SIMPLE_STATUS_SUCCESS = 
1
SIMPLE_STATUS_WARNING = 
2
SIMPLE_STATUSES = 
[SIMPLE_STATUS_SUCCESS, SIMPLE_STATUS_WARNING, SIMPLE_STATUS_ERROR]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Reply

Returns a new instance of Reply.



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

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

Instance Attribute Details

#data ⇒ Object

simple_status either 0, 1, 2 status can be any code e.g. 200, 401



4
5
6
 
# File 'lib/reply/reply.rb', line 4

def data
  @data
end

#messages ⇒ Object (readonly)

Returns the value of attribute messages.



5
6
7
 
# File 'lib/reply/reply.rb', line 5

def messages
  @messages
end

#simple_status ⇒ Object

Returns the value of attribute simple_status.



5
6
7
 
# File 'lib/reply/reply.rb', line 5

def simple_status
  @simple_status
end

#status ⇒ Object

simple_status either 0, 1, 2 status can be any code e.g. 200, 401



4
5
6
 
# File 'lib/reply/reply.rb', line 4

def status
  @status
end

Instance Method Details

#add_errors(array_or_str) ⇒ Object Also known as: add_error 



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

def add_errors(array_or_str)
  add_messages(array_or_str)
  mark_as_error
end

#add_messages(array_or_str) ⇒ Object Also known as: add_message 



32
33
34
35
 
# File 'lib/reply/reply.rb', line 32

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

#clear_messages ⇒ Object 



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

def clear_messages
  @messages.clear
end

#error? ⇒ Boolean Also known as: failure?

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/reply/reply.rb', line 84

def error?
  @simple_status == SIMPLE_STATUS_ERROR
end

#mark_as_error(msg = nil) ⇒ Object Also known as: error!, fail! 



60
61
62
63
64
 
# File 'lib/reply/reply.rb', line 60

def mark_as_error(msg=nil)
  @simple_status = SIMPLE_STATUS_ERROR
  add_errors(msg) if msg
  self
end

#mark_as_success(msg = nil) ⇒ Object Also known as: success! 



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

def mark_as_success(msg=nil)
  @simple_status = SIMPLE_STATUS_SUCCESS
  add_messages(msg) if msg
  self
end

#mark_as_warning(msg = nil) ⇒ Object Also known as: warning! 



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

def mark_as_warning(msg=nil)
  @simple_status = SIMPLE_STATUS_WARNING
  add_messages(msg) if msg
  self
end

#replace_messages(array_or_str) ⇒ Object 



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

def replace_messages(array_or_str)
  array = wrap_arr(array_or_str)
  @messages = array
end

#replace_messages_with_errors_for(object) ⇒ Object 



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

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

#success? ⇒ Boolean Also known as: successful?

Predicates

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/reply/reply.rb', line 79

def success?
  @simple_status == SIMPLE_STATUS_SUCCESS
end

#warning? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/reply/reply.rb', line 89

def warning?
  @simple_status == SIMPLE_STATUS_WARNING
end