Class: App42::Message::QueueService

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

Overview

Manages Asynchronous queues. Allows to create, delete, purge messages, view pending messages and get all messages

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(api_key, secret_key, base_url) ⇒ QueueService

this is a constructor that takes

Parameters:

  • apiKey
  • secretKey
  • baseURL 


29
30
31
32
33
34
35
36
37
 
# File 'lib/message/QueueService.rb', line 29

def initialize(api_key, secret_key, base_url)
  puts "Message Service->initialize"
  @api_key = api_key
  @secret_key = secret_key
  @base_url = base_url
  @resource = "queue"
  @messageResource = "message"
  @version = "1.0"
end

Instance Method Details

#create_pull_queue(queueName, queueDescription) ⇒ Object

Creates a type Pull Queue

Parameters:

  • queueName —

    • The name of the queue which has to be created

  • queueDescription —

    • The description of the queue

Returns:

  • Queue object containing queue name which has been created

Raises:

  • App42Exception



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
84
85
86
87
88
 
# File 'lib/message/QueueService.rb', line 51

def create_pull_queue(queueName, queueDescription)
  puts "Create Pull Queue Called "
  puts "Base url #{@base_url}"
  response = nil;
  messageObj = nil;
  messageObj = Queue.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  util.throwExceptionIfNullOrBlank(queueDescription, "Queue Description");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    body = {'app42' => {"queue"=> {
      "name" => queueName,
      "description" => queueDescription
      }}}.to_json
    puts "Body #{body}"
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
      "type"=>'pull'
    }
    query_params = params.clone
    params.store("body", body)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/pull"
    response = connection.post(signature, resource_url, query_params, body)
    message = QueueResponseBuilder.new()
    messageObj = message.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return messageObj
end

#delete_pull_queue(queueName) ⇒ Object

Deletes the Pull type Queue

Parameters:

  • queueName —

    • The name of the queue which has to be deleted

Returns:

  • App42Response if deleted successfully

Raises:

  • App42Exception



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/message/QueueService.rb', line 101

def delete_pull_queue(queueName)
  puts "Delete Pull Queue Called "
  puts "Base url #{@base_url}"
  response = nil;
  responseObj = App42Response.new();
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
      "type"=>'pull'
    }
    query_params = params.clone
    params.store("queueName", queueName)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/pull/#{queueName}"
    response = connection.delete(signature, resource_url, query_params)
    responseObj.strResponse=(response)
    responseObj.isResponseSuccess=(true)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return responseObj
end

#get_messages(queueName, receiveTimeOut) ⇒ Object

Messages are retrieved and dequeued from the Queue.

Parameters:

  • queueName —

    • The name of the queue which have to be retrieved

  • receiveTimeOut —

    • Receive time out

Returns:

  • Queue object containing messages in the Queue

Raises:

  • App42Exception



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/message/QueueService.rb', line 234

def get_messages(queueName, receiveTimeOut)
  puts "Get Messages Called "
  puts "Base url #{@base_url}"
  response = nil;
  messageObj = nil;
  messageObj = Queue.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  util.throwExceptionIfNullOrBlank(receiveTimeOut, "ReceiveTimeOut");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("queueName", queueName)
    params.store("receiveTimeOut", (receiveTimeOut.to_i).to_s)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/messages/#{queueName}/#{(receiveTimeOut.to_i).to_s}"
    response = connection.get(signature, resource_url, query_params)
    message = QueueResponseBuilder.new()
    messageObj = message.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return messageObj
end

#pending_messages(queueName) ⇒ Object

Messages which are pending to be dequeue. Note: Calling this method does not dequeue the messages in the Queue. The messages stay in the Queue till they are dequeued

Parameters:

  • queueName —

    • The name of the queue from which pending messages have to be fetched

Returns:

  • Queue object containing pending messages in the Queue

Raises:

  • App42Exception



189
190
191
192
193
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
 
# File 'lib/message/QueueService.rb', line 189

def pending_messages(queueName)
  puts "Pending Messages Called "
  puts "Base url #{@base_url}"
  response = nil;
  messageObj = nil;
  messageObj = Queue.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("queueName", queueName)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/pending/#{queueName}"
    response = connection.get(signature, resource_url, query_params)
    message = QueueResponseBuilder.new()
    messageObj = message.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return messageObj
end

#purge_pull_queue(queueName) ⇒ Object

Purges message on the Queue. Note: once the Queue is purged the messages are removed from the Queue and wont be available for dequeueing.

Parameters:

  • queueName —

    • The name of the queue which has to be purged

Returns:

  • Queue object containing queue name which has been purged

Raises:

  • App42Exception



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/message/QueueService.rb', line 145

def purge_pull_queue(queueName)
  puts "Purge Pull Queue Called "
  puts "Base url #{@base_url}"
  response = nil;
  responseObj = App42Response.new();
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
      "type"=>'pull'
    }
    query_params = params.clone
    params.store("queueName", queueName)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@resource}/pull/purge/#{queueName}"
    response = connection.delete(signature, resource_url, query_params)
    responseObj.strResponse=(response)
    responseObj.isResponseSuccess=(true)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return responseObj
end

#receive_message(queueName, receiveTimeOut) ⇒ Object

Pulls all the message from the queue

Parameters:

  • queueName —

    • The name of the queue from which messages have to be pulled

  • receiveTimeOut —

    • Receive time out

Returns:

  • Queue object containing messages which have been pulled

Raises:

  • App42Exception



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
368
 
# File 'lib/message/QueueService.rb', line 336

def receive_message(queueName, receiveTimeOut)
  puts "Receive Message Called "
  puts "Base url #{@base_url}"
  response = nil;
  messageObj = nil;
  messageObj = Queue.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  util.throwExceptionIfNullOrBlank(receiveTimeOut, "ReceiveTimeOut");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("queueName", queueName)
    params.store("receiveTimeOut", "" + (receiveTimeOut.to_i).to_s)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@messageResource}/#{queueName}/#{(receiveTimeOut.to_i).to_s}"
    response = connection.get(signature, resource_url, query_params)
    message = QueueResponseBuilder.new()
    messageObj = message.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return messageObj
end

#receive_message_by_correlation_id(queueName, receiveTimeOut, correlationId) ⇒ Object

Pull message based on the correlation id

Parameters:

  • queueName —

    • The name of the queue from which the message has to be pulled

  • receiveTimeOut —

    • Receive time out

  • correlationId —

    • Correlation Id for which message has to be pulled

Returns:

  • Queue containing message which has pulled based on the correlation id

Raises:

  • App42Exception



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/message/QueueService.rb', line 385

def receive_message_by_correlation_id(queueName, receiveTimeOut, correlationId)
  puts "Receive Message Called "
  puts "Base url #{@base_url}"
  response = nil;
  messageObj = nil;
  messageObj = Queue.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  util.throwExceptionIfNullOrBlank(receiveTimeOut, "ReceiveTimeOut");
  util.throwExceptionIfNullOrBlank(correlationId, "Correlation Id");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("queueName", queueName)
    params.store("receiveTimeOut", "" + (receiveTimeOut.to_i).to_s)
    params.store("correlationId", "" + correlationId)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@messageResource}/#{queueName}/#{(receiveTimeOut.to_i).to_s}/#{correlationId}"
    response = connection.get(signature, resource_url, query_params)
    message = QueueResponseBuilder.new()
    messageObj = message.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return messageObj
end

#remove_message(queueName, messageId) ⇒ Object

Remove message from the queue based on the message id. Note: Once the message is removed it cannot be pulled

Parameters:

  • queueName —

    • The name of the queue from which the message has to be removed

  • messageId —

    • The message id of the message which has to be removed.

Returns:

  • App42Response if removed successfully

Raises:

  • App42Exception



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/message/QueueService.rb', line 434

def remove_message(queueName, messageId)
  puts "Remove Message Called "
  puts "Base url #{@base_url}"
  response = nil;
  responseObj = App42Response.new();
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  util.throwExceptionIfNullOrBlank(messageId, "messageId");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
    }
    query_params = params.clone
    params.store("queueName", queueName)
    params.store("messageId", messageId)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@messageResource}/#{queueName}/#{messageId}"
    response = connection.delete(signature, resource_url, query_params)
    responseObj.strResponse=(response)
    responseObj.isResponseSuccess=(true)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return responseObj
end

#send_message(queueName, msg, exp) ⇒ Object

Send message on the queue with an expiry. The message will expire if it is not pulled/dequeued before the expiry

Parameters:

  • queueName —

    • The name of the queue to which the message has to be sent

  • msg —

    • Message that has to be sent

  • exp —

    • Message expiry time

Returns:

  • Queue object containing message which has been sent with its message id and correlation id

Raises:

  • App42Exception



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/message/QueueService.rb', line 283

def send_message(queueName, msg, exp)
  puts "Get Messages Called "
  puts "Base url #{@base_url}"
  response = nil;
  messageObj = nil;
  messageObj = Queue.new
  util = Util.new
  util.throwExceptionIfNullOrBlank(queueName, "Queue Name");
  util.throwExceptionIfNullOrBlank(msg, "Message");
  util.throwExceptionIfNullOrBlank(exp, "Exipiration");
  begin
    connection = App42::Connection::RESTConnection.new(@base_url)
    body = {'app42' => {"payLoad"=> {
      "message" => msg,
      "expiration" => exp
      }}}.to_json
    puts "Body #{body}"
    query_params = Hash.new
    params = {
      'apiKey'=> @api_key,
      'version' => @version,
      'timeStamp' => util.get_timestamp_utc,
      'queueName' => queueName
    }
    query_params = params.clone
    params.store("body", body)
    puts query_params
    signature = util.sign(@secret_key, params)
    resource_url = "#{@version}/#{@messageResource}/#{queueName}"
    response = connection.post(signature, resource_url, query_params, body)
    message = QueueResponseBuilder.new()
    messageObj = message.buildResponse(response)
  rescue  App42Exception =>e
    raise e
  rescue  Exception => e
    raise App42Exception.new(e)
  end
  return messageObj
end