Class: Josh::Messages

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

Direct Known Subclasses

Respond

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lang = :en) ⇒ Object

initialize method

Parameters:

  • lang (String) (defaults to: :en)

Author:

Since:

  • 1 Dec 2016



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

def initialize(lang = :en)
  I18n.default_locale = lang
end

Instance Attribute Details

#code ⇒ Object

setter and getter varibules



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

def code
  @code
end

#config ⇒ Object

setter and getter varibules



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

def config
  @config
end

#error(code) ⇒ Object

The error message

Parameters:

  • code (Object)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



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

def error
  @error
end

#error_code ⇒ Object

setter and getter varibules



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

def error_code
  @error_code
end

#headers ⇒ Object

setter and getter varibules



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

def headers
  @headers
end

#lang ⇒ Object

setter and getter varibules



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

def lang
  @lang
end

#text ⇒ Object

setter and getter varibules



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

def text
  @text
end

Instance Method Details

#connection_refused ⇒ Object

Database connection is refused

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



143
144
145
146
147
148
 
# File 'lib/respond.rb', line 143

def connection_refused
  self.set_status_code(445)
      .set_status_text('failed')
      .set_error_code(5445)
      .respond_with_message
end

#delete_failed(message = nil) ⇒ Object

Delete action is failed

Parameters:

  • message (String) (defaults to: nil)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/respond.rb', line 90

def delete_failed(message = nil)
  if message == nil
    message = I18n.t "respond.failed.delete"
  end

  self.set_status_code(447)
      .set_status_text('failed')
      .set_error_code(5447)
      .respond_with_message(message)
end

#delete_succeeded(message = nil) ⇒ Object

Delete action is succeed

Parameters:

  • message (String) (defaults to: nil)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



39
40
41
42
43
44
45
46
47
 
# File 'lib/respond.rb', line 39

def delete_succeeded(message = nil)
  if message == nil
    message = I18n.t "respond.success.delete"
  end

  self.set_status_code(200)
      .set_status_text('success')
      .respond_with_message(message)
end

#insert_failed(message = nil) ⇒ Object

Insert action is failed

Parameters:

  • message (String) (defaults to: nil)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/respond.rb', line 126

def insert_failed(message = nil)
  if message == nil
    message = I18n.t "respond.failed.insert"
  end

  self.set_status_code(448)
      .set_status_text('failed')
      .set_error_code(5448)
      .respond_with_message(message)
end

#insert_succeeded(message = nil) ⇒ Object

Insert action is succeed

Parameters:

  • message (String) (defaults to: nil)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



73
74
75
76
77
78
79
80
81
 
# File 'lib/respond.rb', line 73

def insert_succeeded(message = nil)
  if message == nil
    message = I18n.t "respond.success.insert"
  end

  self.set_status_code(200)
      .set_status_text('success')
      .respond_with_message(message)
end

#method_not_allowed ⇒ Object

Method is not allowed

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



182
183
184
185
186
187
 
# File 'lib/respond.rb', line 182

def method_not_allowed
  self.set_status_code(405)
      .set_status_text('failed')
      .set_error_code(5405)
      .respond_with_message
end

#not_found ⇒ Object

Page requested is not found

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



156
157
158
159
160
161
 
# File 'lib/respond.rb', line 156

def not_found
  self.set_status_code(404)
      .set_status_text('failed')
      .set_error_code(5404)
      .respond_with_message
end

#request_field_duplicated ⇒ Object

The request field is duplicated

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



221
222
223
224
225
226
 
# File 'lib/respond.rb', line 221

def request_field_duplicated
  self.set_status_code(400)
      .set_status_text('failed')
      .set_error_code(1004)
      .respond_with_message
end

#request_field_notfound ⇒ Object

The request field is not found

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



208
209
210
211
212
213
 
# File 'lib/respond.rb', line 208

def request_field_notfound
  self.set_status_code(446)
      .set_status_text('failed')
      .set_error_code(1001)
      .respond_with_message
end

#succeed(data) ⇒ Object

Request succeeded and contains json result

Parameters:

  • data (Object)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



26
27
28
29
30
 
# File 'lib/respond.rb', line 26

def succeed(data)
  self.set_status_code(200)
      .set_status_text('success')
      .respond_with_result(data)
end

#update_failed(message = nil) ⇒ Object

Update action is succeed

Parameters:

  • message (String) (defaults to: nil)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/respond.rb', line 108

def update_failed(message = nil)
  if message == nil
    message = I18n.t "respond.failed.update"
  end

  self.set_status_code(449)
      .set_status_text('failed')
      .set_error_code(5449)
      .respond_with_message(message)
end

#update_succeeded(message = nil) ⇒ Object

Update action is succeed

Parameters:

  • message (String) (defaults to: nil)

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



56
57
58
59
60
61
62
63
64
 
# File 'lib/respond.rb', line 56

def update_succeeded(message = nil)
  if message == nil
    message = I18n.t "respond.success.update"
  end

  self.set_status_code(200)
      .set_status_text('success')
      .respond_with_message(message)
end

#validation_errors(message = nil) ⇒ Object

There ara validation errors

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



195
196
197
198
199
200
 
# File 'lib/respond.rb', line 195

def validation_errors(message = nil)
  self.set_status_code(420)
      .set_status_text('failed')
      .set_error_code(5420)
      .respond_with_message(message)
end

#wrong_parameters ⇒ Object

Wrong parameters are entered

Returns:

  • (Object)

Author:

Since:

  • 1 Dec 2016



169
170
171
172
173
174
 
# File 'lib/respond.rb', line 169

def wrong_parameters
  self.set_status_code(406)
      .set_status_text('failed')
      .set_error_code(5406)
      .respond_with_message
end