Class: SuggestGrid::MetadataController

Inherits:
BaseController show all
Defined in:
lib/suggestgrid/controllers/metadata_controller.rb

Constant Summary collapse

@@instance = 
MetadataController.new

Instance Attribute Summary

Attributes inherited from BaseController

#http_call_back, #http_client

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #initialize, #validate_parameters, #validate_response

Constructor Details

This class inherits a constructor from SuggestGrid::BaseController

Class Method Details

.instance ⇒ Object

Singleton instance of the controller class



7
8
9
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 7

def self.instance
  @@instance
end

Instance Method Details

#delete_all_items ⇒ Object

Deletes All Items

Returns:

  • MessageResponse response from the API call



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 405

def delete_all_items

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/items'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.delete _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#delete_all_users ⇒ Object

Deletes All Users

Returns:

  • MessageResponse response from the API call



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 194

def delete_all_users

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/users'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.delete _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#delete_item(item_id) ⇒ Object

Delete An Item

Parameters:

  • item_id (String) —

    Required parameter: The item id to delete its metadata.

Returns:

  • MessageResponse response from the API call



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 372

def delete_item(item_id)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/items/{item_id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'item_id' => item_id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.delete _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#delete_user(user_id) ⇒ Object

Deletes a User

Parameters:

  • user_id (String) —

    Required parameter: The user id to delete its metadata.

Returns:

  • MessageResponse response from the API call



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 161

def delete_user(user_id)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/users/{user_id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'user_id' => user_id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.delete _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#get_item(item_id) ⇒ Object

Gets An Item

Parameters:

  • item_id (String) —

    Required parameter: The item id to get its metadata.

Returns:

  • Metadata response from the API call



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 299

def get_item(item_id)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/items/{item_id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'item_id' => item_id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 404
    raise ErrorResponseErrorException.new 'Item does not exists.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return Metadata.from_hash(decoded)
end

#get_items(size = nil, from = nil) ⇒ Object

Gets Items

Parameters:

  • size (Long) (defaults to: nil) —

    Optional parameter: The number of the users response. Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter must be string represetation of an integer like “1”.

  • from (Long) (defaults to: nil) —

    Optional parameter: The number of users to be skipped from the response. Defaults to 0. Must be bigger than or equal to 0. This parameter must be string represetation of an integer like “1”.

Returns:

  • ItemsResponse response from the API call



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 336

def get_items(size = nil,
              from = nil)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/items'
  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'size' => size,
    'from' => from
  }, array_serialization: Configuration.array_serialization
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return ItemsResponse.from_hash(decoded)
end

#get_user(user_id) ⇒ Object

Gets A User

Parameters:

  • user_id (String) —

    Required parameter: The user id to get its metadata.

Returns:

  • Metadata response from the API call



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 88

def get_user(user_id)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/users/{user_id}'
  _query_builder = APIHelper.append_url_with_template_parameters _query_builder, {
    'user_id' => user_id
  }
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 404
    raise ErrorResponseErrorException.new 'User does not exists.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return Metadata.from_hash(decoded)
end

#get_users(size = nil, from = nil) ⇒ Object

Gets Users

Parameters:

  • size (Long) (defaults to: nil) —

    Optional parameter: The number of the users response. Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter must be string represetation of an integer like “1”.

  • from (Long) (defaults to: nil) —

    Optional parameter: The number of users to be skipped from the response. Defaults to 0. Must be bigger than or equal to 0. This parameter must be string represetation of an integer like “1”.

Returns:

  • UsersResponse response from the API call



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 125

def get_users(size = nil,
              from = nil)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/users'
  _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
    'size' => size,
    'from' => from
  }, array_serialization: Configuration.array_serialization
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json'
  }

  # prepare and execute HttpRequest
  _request = @http_client.get _query_url, headers: _headers
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 0
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return UsersResponse.from_hash(decoded)
end

#post_bulk_items(items) ⇒ Object

Posts Items

Parameters:

  • items (Collection) —

    Required parameter: List of item metadata, whose size is limited to 10 thousand.

Returns:

  • BulkPostResponse response from the API call



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 259

def post_bulk_items(items)
    body = ''
    items.each do |item|
        body += "#{item.to_json}\n"
    end

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/items/_bulk'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'text/plain; charset=utf-8'
  }

  # prepare and execute HttpRequest
  _request = @http_client.post _query_url, headers: _headers, parameters: body
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise ErrorResponseErrorException.new 'Body is missing.', _context
  elsif _context.response.status_code == 413
    raise ErrorResponseErrorException.new 'Bulk request maximum line count exceeded.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return BulkPostResponse.from_hash(decoded)
end

#post_bulk_users(users) ⇒ Object

Posts Users

Parameters:

  • users (Collection) —

    Required parameter: List of user metadata, whose size is limited to 10 thousand.

Returns:

  • BulkPostResponse response from the API call



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 48

def post_bulk_users(users)
    body = ''
    users.each do |user|
        body += "#{user.to_json}\n"
    end

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/users/_bulk'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'text/plain; charset=utf-8'
  }

  # prepare and execute HttpRequest
  _request = @http_client.post _query_url, headers: _headers, parameters: body
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise ErrorResponseErrorException.new 'Body is missing.', _context
  elsif _context.response.status_code == 413
    raise ErrorResponseErrorException.new 'Bulk request maximum line count exceeded.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return BulkPostResponse.from_hash(decoded)
end

#post_item(item) ⇒ Object

Posts An Item

Parameters:

  • item (Metadata) —

    Required parameter: The metadata to be saved. Metadata format has its restrictions.

Returns:

  • MessageResponse response from the API call



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 225

def post_item(item)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/items'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # prepare and execute HttpRequest
  _request = @http_client.post _query_url, headers: _headers, parameters: item.to_json
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise DetailedErrorResponseErrorException.new 'Metadata is invalid.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end

#post_user(user) ⇒ Object

Posts a User

Parameters:

  • user (Metadata) —

    Required parameter: The metadata to be saved. Metadata format has its restrictions.

Returns:

  • MessageResponse response from the API call



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/suggestgrid/controllers/metadata_controller.rb', line 14

def post_user(user)

  # prepare query url
  _query_builder = Configuration.base_uri.dup
  _query_builder << '/v1/users'
  _query_url = APIHelper.clean_url _query_builder

  # prepare headers
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # prepare and execute HttpRequest
  _request = @http_client.post _query_url, headers: _headers, parameters: user.to_json
  BasicAuth.apply(_request)
  _context = execute_request(_request)

  # validate response against endpoint and global error codes
  if _context.response.status_code == 400
    raise DetailedErrorResponseErrorException.new 'Metadata is invalid.', _context
  elsif !_context.response.status_code.between?(200, 208)
    raise ErrorResponseErrorException.new 'Unexpected internal error.', _context
  end
  validate_response(_context)

  # return appropriate response type
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  return MessageResponse.from_hash(decoded)
end