mwilliams-right_aws 1.10.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,596 @@
1
+ #
2
+ # Copyright (c) 2007-2008 RightScale Inc
3
+ #
4
+ # Permission is hereby granted, free of charge, to any person obtaining
5
+ # a copy of this software and associated documentation files (the
6
+ # "Software"), to deal in the Software without restriction, including
7
+ # without limitation the rights to use, copy, modify, merge, publish,
8
+ # distribute, sublicense, and/or sell copies of the Software, and to
9
+ # permit persons to whom the Software is furnished to do so, subject to
10
+ # the following conditions:
11
+ #
12
+ # The above copyright notice and this permission notice shall be
13
+ # included in all copies or substantial portions of the Software.
14
+ #
15
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19
+ # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20
+ # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21
+ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22
+ #
23
+
24
+ module RightAws
25
+
26
+ class SqsInterface < RightAwsBase
27
+ include RightAwsBaseInterface
28
+
29
+ API_VERSION = "2007-05-01"
30
+ DEFAULT_HOST = "queue.amazonaws.com"
31
+ DEFAULT_PORT = 443
32
+ DEFAULT_PROTOCOL = 'https'
33
+ REQUEST_TTL = 30
34
+ DEFAULT_VISIBILITY_TIMEOUT = 30
35
+
36
+
37
+ @@bench = AwsBenchmarkingBlock.new
38
+ def self.bench_xml
39
+ @@bench.xml
40
+ end
41
+ def self.bench_sqs
42
+ @@bench.service
43
+ end
44
+
45
+ @@api = API_VERSION
46
+ def self.api
47
+ @@api
48
+ end
49
+
50
+ # Creates a new SqsInterface instance.
51
+ #
52
+ # sqs = RightAws::SqsInterface.new('1E3GDYEOGFJPIT75KDT40','hgTHt68JY07JKUY08ftHYtERkjgtfERn57DFE379', {:multi_thread => true, :logger => Logger.new('/tmp/x.log')})
53
+ #
54
+ # Params is a hash:
55
+ #
56
+ # {:server => 'queue.amazonaws.com' # Amazon service host: 'queue.amazonaws.com'(default)
57
+ # :port => 443 # Amazon service port: 80 or 443(default)
58
+ # :multi_thread => true|false # Multi-threaded (connection per each thread): true or false(default)
59
+ # :signature_version => '0' # The signature version : '0' or '1'(default)
60
+ # :logger => Logger Object} # Logger instance: logs to STDOUT if omitted }
61
+ #
62
+ def initialize(aws_access_key_id=nil, aws_secret_access_key=nil, params={})
63
+ init({ :name => 'SQS',
64
+ :default_host => ENV['SQS_URL'] ? URI.parse(ENV['SQS_URL']).host : DEFAULT_HOST,
65
+ :default_port => ENV['SQS_URL'] ? URI.parse(ENV['SQS_URL']).port : DEFAULT_PORT,
66
+ :default_protocol => ENV['SQS_URL'] ? URI.parse(ENV['SQS_URL']).scheme : DEFAULT_PROTOCOL },
67
+ aws_access_key_id || ENV['AWS_ACCESS_KEY_ID'],
68
+ aws_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY'],
69
+ params)
70
+ end
71
+
72
+
73
+ #-----------------------------------------------------------------
74
+ # Requests
75
+ #-----------------------------------------------------------------
76
+
77
+ # Generates a request hash for the query API
78
+ def generate_request(action, params={}) # :nodoc:
79
+ # Sometimes we need to use queue uri (delete queue etc)
80
+ # In that case we will use Symbol key: 'param[:queue_url]'
81
+ service = params[:queue_url] ? URI(params[:queue_url]).path : '/'
82
+ # remove unset(=optional) and symbolyc keys
83
+ params.each{ |key, value| params.delete(key) if (value.nil? || key.is_a?(Symbol)) }
84
+ # prepare output hash
85
+ service_hash = { "Action" => action,
86
+ "Expires" => (Time.now + REQUEST_TTL).utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
87
+ "AWSAccessKeyId" => @aws_access_key_id,
88
+ "Version" => API_VERSION }
89
+ service_hash.update(params)
90
+ service_params = signed_service_params(@aws_secret_access_key, service_hash, :get, @params[:server], service)
91
+ request = Net::HTTP::Get.new("#{AwsUtils::URLencode(service)}?#{service_params}")
92
+ # prepare output hash
93
+ { :request => request,
94
+ :server => @params[:server],
95
+ :port => @params[:port],
96
+ :protocol => @params[:protocol] }
97
+ end
98
+
99
+ # Generates a request hash for the REST API
100
+ def generate_rest_request(method, param) # :nodoc:
101
+ queue_uri = param[:queue_url] ? URI(param[:queue_url]).path : '/'
102
+ message = param[:message] # extract message body if nesessary
103
+ # remove unset(=optional) and symbolyc keys
104
+ param.each{ |key, value| param.delete(key) if (value.nil? || key.is_a?(Symbol)) }
105
+ # created request
106
+ param_to_str = param.to_a.collect{|key,val| key.to_s + "=" + CGI::escape(val.to_s) }.join("&")
107
+ param_to_str = "?#{param_to_str}" unless param_to_str.blank?
108
+ request = "Net::HTTP::#{method.capitalize}".constantize.new("#{queue_uri}#{param_to_str}")
109
+ request.body = message if message
110
+ # set main headers
111
+ request['content-md5'] = ''
112
+ request['Content-Type'] = 'text/plain'
113
+ request['Date'] = Time.now.httpdate
114
+ # generate authorization string
115
+ auth_string = "#{method.upcase}\n#{request['content-md5']}\n#{request['Content-Type']}\n#{request['Date']}\n#{CGI::unescape(queue_uri)}"
116
+ signature = AwsUtils::sign(@aws_secret_access_key, auth_string)
117
+ # set other headers
118
+ request['Authorization'] = "AWS #{@aws_access_key_id}:#{signature}"
119
+ request['AWS-Version'] = API_VERSION
120
+ # prepare output hash
121
+ { :request => request,
122
+ :server => @params[:server],
123
+ :port => @params[:port],
124
+ :protocol => @params[:protocol] }
125
+ end
126
+
127
+
128
+ # Sends request to Amazon and parses the response
129
+ # Raises AwsError if any banana happened
130
+ def request_info(request, parser) # :nodoc:
131
+ thread = @params[:multi_thread] ? Thread.current : Thread.main
132
+ thread[:sqs_connection] ||= Rightscale::HttpConnection.new(:exception => AwsError, :logger => @logger)
133
+ request_info_impl(thread[:sqs_connection], @@bench, request, parser)
134
+ end
135
+
136
+
137
+ # Creates new queue. Returns new queue link.
138
+ #
139
+ # sqs.create_queue('my_awesome_queue') #=> 'http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue'
140
+ #
141
+ # PS Some queue based requests may not become available until a couple of minutes after queue creation
142
+ # (permission grant and removal for example)
143
+ #
144
+ def create_queue(queue_name, default_visibility_timeout=nil)
145
+ req_hash = generate_request('CreateQueue',
146
+ 'QueueName' => queue_name,
147
+ 'DefaultVisibilityTimeout' => default_visibility_timeout || DEFAULT_VISIBILITY_TIMEOUT )
148
+ request_info(req_hash, SqsCreateQueueParser.new(:logger => @logger))
149
+ end
150
+
151
+ # Lists all queues owned by this user that have names beginning with +queue_name_prefix+. If +queue_name_prefix+ is omitted then retrieves a list of all queues.
152
+ #
153
+ # sqs.create_queue('my_awesome_queue')
154
+ # sqs.create_queue('my_awesome_queue_2')
155
+ # sqs.list_queues('my_awesome') #=> ['http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue','http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue_2']
156
+ #
157
+ def list_queues(queue_name_prefix=nil)
158
+ req_hash = generate_request('ListQueues', 'QueueNamePrefix' => queue_name_prefix)
159
+ request_info(req_hash, SqsListQueuesParser.new(:logger => @logger))
160
+ rescue
161
+ on_exception
162
+ end
163
+
164
+ # Deletes queue (queue must be empty or +force_deletion+ must be set to true). Queue is identified by url. Returns +true+ or an exception.
165
+ #
166
+ # sqs.delete_queue('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue_2') #=> true
167
+ #
168
+ def delete_queue(queue_url, force_deletion = false)
169
+ req_hash = generate_request('DeleteQueue',
170
+ 'ForceDeletion' => force_deletion.to_s,
171
+ :queue_url => queue_url)
172
+ request_info(req_hash, SqsStatusParser.new(:logger => @logger))
173
+ rescue
174
+ on_exception
175
+ end
176
+
177
+ # Retrieves the queue attribute(s). Returns a hash of attribute(s) or an exception.
178
+ #
179
+ # sqs.get_queue_attributes('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> {"ApproximateNumberOfMessages"=>"0", "VisibilityTimeout"=>"30"}
180
+ #
181
+ def get_queue_attributes(queue_url, attribute='All')
182
+ req_hash = generate_request('GetQueueAttributes',
183
+ 'Attribute' => attribute,
184
+ :queue_url => queue_url)
185
+ request_info(req_hash, SqsGetQueueAttributesParser.new(:logger => @logger))
186
+ rescue
187
+ on_exception
188
+ end
189
+
190
+ # Sets queue attribute. Returns +true+ or an exception.
191
+ #
192
+ # sqs.set_queue_attributes('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', "VisibilityTimeout", 10) #=> true
193
+ #
194
+ # P.S. Amazon returns success even if the attribute does not exist. Also, attribute values may not be immediately available to other queries
195
+ # for some time after an update (see the SQS documentation for
196
+ # semantics).
197
+ def set_queue_attributes(queue_url, attribute, value)
198
+ req_hash = generate_request('SetQueueAttributes',
199
+ 'Attribute' => attribute,
200
+ 'Value' => value,
201
+ :queue_url => queue_url)
202
+ request_info(req_hash, SqsStatusParser.new(:logger => @logger))
203
+ rescue
204
+ on_exception
205
+ end
206
+
207
+ # Sets visibility timeout. Returns +true+ or an exception.
208
+ #
209
+ # sqs.set_visibility_timeout('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 15) #=> true
210
+ #
211
+ # See also: +set_queue_attributes+
212
+ #
213
+ def set_visibility_timeout(queue_url, visibility_timeout=nil)
214
+ req_hash = generate_request('SetVisibilityTimeout',
215
+ 'VisibilityTimeout' => visibility_timeout || DEFAULT_VISIBILITY_TIMEOUT,
216
+ :queue_url => queue_url )
217
+ request_info(req_hash, SqsStatusParser.new(:logger => @logger))
218
+ rescue
219
+ on_exception
220
+ end
221
+
222
+ # Retrieves visibility timeout.
223
+ #
224
+ # sqs.get_visibility_timeout('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> 15
225
+ #
226
+ # See also: +get_queue_attributes+
227
+ #
228
+ def get_visibility_timeout(queue_url)
229
+ req_hash = generate_request('GetVisibilityTimeout', :queue_url => queue_url )
230
+ request_info(req_hash, SqsGetVisibilityTimeoutParser.new(:logger => @logger))
231
+ rescue
232
+ on_exception
233
+ end
234
+
235
+ # Adds grants for user (identified by email he registered at Amazon). Returns +true+ or an exception. Permission = 'FULLCONTROL' | 'RECEIVEMESSAGE' | 'SENDMESSAGE'.
236
+ #
237
+ # sqs.add_grant('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 'my_awesome_friend@gmail.com', 'FULLCONTROL') #=> true
238
+ #
239
+ def add_grant(queue_url, grantee_email_address, permission = nil)
240
+ req_hash = generate_request('AddGrant',
241
+ 'Grantee.EmailAddress' => grantee_email_address,
242
+ 'Permission' => permission,
243
+ :queue_url => queue_url)
244
+ request_info(req_hash, SqsStatusParser.new(:logger => @logger))
245
+ rescue
246
+ on_exception
247
+ end
248
+
249
+ # Retrieves hash of +grantee_id+ => +perms+ for this queue:
250
+ #
251
+ # sqs.list_grants('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=>
252
+ # {"000000000000000000000001111111111117476c7fea6efb2c3347ac3ab2792a"=>{:name=>"root", :perms=>["FULLCONTROL"]},
253
+ # "00000000000000000000000111111111111e5828344600fc9e4a784a09e97041"=>{:name=>"myawesomefriend", :perms=>["FULLCONTROL"]}
254
+ #
255
+ def list_grants(queue_url, grantee_email_address=nil, permission = nil)
256
+ req_hash = generate_request('ListGrants',
257
+ 'Grantee.EmailAddress' => grantee_email_address,
258
+ 'Permission' => permission,
259
+ :queue_url => queue_url)
260
+ response = request_info(req_hash, SqsListGrantsParser.new(:logger => @logger))
261
+ # One user may have up to 3 permission records for every queue.
262
+ # We will join these records to one.
263
+ result = {}
264
+ response.each do |perm|
265
+ id = perm[:id]
266
+ # create hash for new user if unexisit
267
+ result[id] = {:perms=>[]} unless result[id]
268
+ # fill current grantee params
269
+ result[id][:perms] << perm[:permission]
270
+ result[id][:name] = perm[:name]
271
+ end
272
+ result
273
+ end
274
+
275
+ # Revokes permission from user. Returns +true+ or an exception.
276
+ #
277
+ # sqs.remove_grant('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 'my_awesome_friend@gmail.com', 'FULLCONTROL') #=> true
278
+ #
279
+ def remove_grant(queue_url, grantee_email_address_or_id, permission = nil)
280
+ grantee_key = grantee_email_address_or_id.include?('@') ? 'Grantee.EmailAddress' : 'Grantee.ID'
281
+ req_hash = generate_request('RemoveGrant',
282
+ grantee_key => grantee_email_address_or_id,
283
+ 'Permission' => permission,
284
+ :queue_url => queue_url)
285
+ request_info(req_hash, SqsStatusParser.new(:logger => @logger))
286
+ rescue
287
+ on_exception
288
+ end
289
+
290
+ # Retrieves a list of messages from queue. Returns an array of hashes in format: <tt>{:id=>'message_id', body=>'message_body'}</tt>
291
+ #
292
+ # sqs.receive_messages('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue',10, 5) #=>
293
+ # [{:id=>"12345678904GEZX9746N|0N9ED344VK5Z3SV1DTM0|1RVYH4X3TJ0987654321", :body=>"message_1"}, ..., {}]
294
+ #
295
+ # P.S. Usually returns fewer messages than requested even if they are available.
296
+ #
297
+ def receive_messages(queue_url, number_of_messages=1, visibility_timeout=nil)
298
+ return [] if number_of_messages == 0
299
+ req_hash = generate_rest_request('GET',
300
+ 'NumberOfMessages' => number_of_messages,
301
+ 'VisibilityTimeout' => visibility_timeout,
302
+ :queue_url => "#{queue_url}/front" )
303
+ request_info(req_hash, SqsReceiveMessagesParser.new(:logger => @logger))
304
+ rescue
305
+ on_exception
306
+ end
307
+
308
+ # Peeks message from queue by message id. Returns message in format of <tt>{:id=>'message_id', :body=>'message_body'}</tt> or +nil+.
309
+ #
310
+ # sqs.peek_message('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', '1234567890...0987654321') #=>
311
+ # {:id=>"12345678904GEZX9746N|0N9ED344VK5Z3SV1DTM0|1RVYH4X3TJ0987654321", :body=>"message_1"}
312
+ #
313
+ def peek_message(queue_url, message_id)
314
+ req_hash = generate_rest_request('GET', :queue_url => "#{queue_url}/#{CGI::escape message_id}" )
315
+ messages = request_info(req_hash, SqsReceiveMessagesParser.new(:logger => @logger))
316
+ messages.blank? ? nil : messages[0]
317
+ rescue
318
+ on_exception
319
+ end
320
+
321
+ # Sends new message to queue.Returns 'message_id' or raises an exception.
322
+ #
323
+ # sqs.send_message('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 'message_1') #=> "1234567890...0987654321"
324
+ #
325
+ def send_message(queue_url, message)
326
+ req_hash = generate_rest_request('PUT',
327
+ :message => message,
328
+ :queue_url => "#{queue_url}/back")
329
+ request_info(req_hash, SqsSendMessagesParser.new(:logger => @logger))
330
+ rescue
331
+ on_exception
332
+ end
333
+
334
+ # Deletes message from queue. Returns +true+ or an exception. Amazon
335
+ # returns +true+ on deletion of non-existent messages.
336
+ #
337
+ # sqs.delete_message('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', '12345678904...0987654321') #=> true
338
+ #
339
+ def delete_message(queue_url, message_id)
340
+ req_hash = generate_request('DeleteMessage',
341
+ 'MessageId' => message_id,
342
+ :queue_url => queue_url)
343
+ request_info(req_hash, SqsStatusParser.new(:logger => @logger))
344
+ rescue
345
+ on_exception
346
+ end
347
+
348
+ # Changes message visibility timeout. Returns +true+ or an exception.
349
+ #
350
+ # sqs.change_message_visibility('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', '1234567890...0987654321', 10) #=> true
351
+ #
352
+ def change_message_visibility(queue_url, message_id, visibility_timeout=0)
353
+ req_hash = generate_request('ChangeMessageVisibility',
354
+ 'MessageId' => message_id,
355
+ 'VisibilityTimeout' => visibility_timeout.to_s,
356
+ :queue_url => queue_url)
357
+ request_info(req_hash, SqsStatusParser.new(:logger => @logger))
358
+ rescue
359
+ on_exception
360
+ end
361
+
362
+ # Returns queue url by queue short name or +nil+ if queue is not found
363
+ #
364
+ # sqs.queue_url_by_name('my_awesome_queue') #=> 'http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue'
365
+ #
366
+ def queue_url_by_name(queue_name)
367
+ return queue_name if queue_name.include?('/')
368
+ queue_urls = list_queues(queue_name)
369
+ queue_urls.each do |queue_url|
370
+ return queue_url if queue_name_by_url(queue_url) == queue_name
371
+ end
372
+ nil
373
+ rescue
374
+ on_exception
375
+ end
376
+
377
+ # Returns short queue name by url.
378
+ #
379
+ # RightSqs.queue_name_by_url('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> 'my_awesome_queue'
380
+ #
381
+ def self.queue_name_by_url(queue_url)
382
+ queue_url[/[^\/]*$/]
383
+ rescue
384
+ on_exception
385
+ end
386
+
387
+ # Returns short queue name by url.
388
+ #
389
+ # sqs.queue_name_by_url('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> 'my_awesome_queue'
390
+ #
391
+ def queue_name_by_url(queue_url)
392
+ self.class.queue_name_by_url(queue_url)
393
+ rescue
394
+ on_exception
395
+ end
396
+
397
+ # Returns approximate number of messages in queue.
398
+ #
399
+ # sqs.get_queue_length('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> 3
400
+ #
401
+ def get_queue_length(queue_url)
402
+ get_queue_attributes(queue_url)['ApproximateNumberOfMessages'].to_i
403
+ rescue
404
+ on_exception
405
+ end
406
+
407
+ # Removes all visible messages from queue. Return +true+ or an exception.
408
+ #
409
+ # sqs.clear_queue('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> true
410
+ #
411
+ def clear_queue(queue_url)
412
+ while (m = pop_message(queue_url)) ; end # delete all messages in queue
413
+ true
414
+ rescue
415
+ on_exception
416
+ end
417
+
418
+ # Deletes queue then re-creates it (restores attributes also). The fastest method to clear big queue or queue with invisible messages. Return +true+ or an exception.
419
+ #
420
+ # sqs.force_clear_queue('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> true
421
+ #
422
+ # PS This function is no longer supported. Amazon has changed the SQS semantics to require at least 60 seconds between
423
+ # queue deletion and creation. Hence this method will fail with an exception.
424
+ #
425
+ def force_clear_queue(queue_url)
426
+ queue_name = queue_name_by_url(queue_url)
427
+ queue_attributes = get_queue_attributes(queue_url)
428
+ force_delete_queue(queue_url)
429
+ create_queue(queue_name)
430
+ # hmmm... The next line is a trick. Amazon do not want change attributes immediately after queue creation
431
+ # So we do 'empty' get_queue_attributes. Probably they need some time to allow attributes change.
432
+ get_queue_attributes(queue_url)
433
+ queue_attributes.each{ |attribute, value| set_queue_attributes(queue_url, attribute, value) }
434
+ true
435
+ rescue
436
+ on_exception
437
+ end
438
+
439
+ # Deletes queue even if it has messages. Return +true+ or an exception.
440
+ #
441
+ # force_delete_queue('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> true
442
+ #
443
+ # P.S. same as <tt>delete_queue('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', true)</tt>
444
+ def force_delete_queue(queue_url)
445
+ delete_queue(queue_url, true)
446
+ rescue
447
+ on_exception
448
+ end
449
+
450
+ # Reads first accessible message from queue. Returns message as a hash: <tt>{:id=>'message_id', :body=>'message_body'}</tt> or +nil+.
451
+ #
452
+ # sqs.receive_message('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 10) #=>
453
+ # {:id=>"12345678904GEZX9746N|0N9ED344VK5Z3SV1DTM0|1RVYH4X3TJ0987654321", :body=>"message_1"}
454
+ #
455
+ def receive_message(queue_url, visibility_timeout=nil)
456
+ result = receive_messages(queue_url, 1, visibility_timeout)
457
+ result.blank? ? nil : result[0]
458
+ rescue
459
+ on_exception
460
+ end
461
+
462
+ # Same as send_message
463
+ alias_method :push_message, :send_message
464
+
465
+ # Pops (retrieves and deletes) up to 'number_of_messages' from queue. Returns an array of retrieved messages in format: <tt>[{:id=>'message_id', :body=>'message_body'}]</tt>.
466
+ #
467
+ # sqs.pop_messages('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 3) #=>
468
+ # [{:id=>"12345678904GEZX9746N|0N9ED344VK5Z3SV1DTM0|1RVYH4X3TJ0987654321", :body=>"message_1"}, ..., {}]
469
+ #
470
+ def pop_messages(queue_url, number_of_messages=1)
471
+ messages = receive_messages(queue_url, number_of_messages)
472
+ messages.each do |message|
473
+ delete_message(queue_url, message[:id])
474
+ end
475
+ messages
476
+ rescue
477
+ on_exception
478
+ end
479
+
480
+ # Pops (retrieves and deletes) first accessible message from queue. Returns the message in format <tt>{:id=>'message_id', :body=>'message_body'}</tt> or +nil+.
481
+ #
482
+ # sqs.pop_message('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=>
483
+ # {:id=>"12345678904GEZX9746N|0N9ED344VK5Z3SV1DTM0|1RVYH4X3TJ0987654321", :body=>"message_1"}
484
+ #
485
+ def pop_message(queue_url)
486
+ messages = pop_messages(queue_url)
487
+ messages.blank? ? nil : messages[0]
488
+ rescue
489
+ on_exception
490
+ end
491
+
492
+ #-----------------------------------------------------------------
493
+ # PARSERS: Status Response Parser
494
+ #-----------------------------------------------------------------
495
+
496
+ class SqsStatusParser < RightAWSParser # :nodoc:
497
+ def tagend(name)
498
+ if name == 'StatusCode'
499
+ @result = @text=='Success' ? true : false
500
+ end
501
+ end
502
+ end
503
+
504
+ #-----------------------------------------------------------------
505
+ # PARSERS: Queue
506
+ #-----------------------------------------------------------------
507
+
508
+ class SqsCreateQueueParser < RightAWSParser # :nodoc:
509
+ def tagend(name)
510
+ @result = @text if name == 'QueueUrl'
511
+ end
512
+ end
513
+
514
+ class SqsListQueuesParser < RightAWSParser # :nodoc:
515
+ def reset
516
+ @result = []
517
+ end
518
+ def tagend(name)
519
+ @result << @text if name == 'QueueUrl'
520
+ end
521
+ end
522
+
523
+ class SqsGetQueueAttributesParser < RightAWSParser # :nodoc:
524
+ def reset
525
+ @result = {}
526
+ end
527
+ def tagend(name)
528
+ case name
529
+ when 'Attribute' ; @current_attribute = @text
530
+ when 'Value' ; @result[@current_attribute] = @text
531
+ # when 'StatusCode'; @result['status_code'] = @text
532
+ # when 'RequestId' ; @result['request_id'] = @text
533
+ end
534
+ end
535
+ end
536
+
537
+ #-----------------------------------------------------------------
538
+ # PARSERS: Timeouts
539
+ #-----------------------------------------------------------------
540
+
541
+ class SqsGetVisibilityTimeoutParser < RightAWSParser # :nodoc:
542
+ def tagend(name)
543
+ @result = @text.to_i if name == 'VisibilityTimeout'
544
+ end
545
+ end
546
+
547
+ #-----------------------------------------------------------------
548
+ # PARSERS: Permissions
549
+ #-----------------------------------------------------------------
550
+
551
+ class SqsListGrantsParser < RightAWSParser # :nodoc:
552
+ def reset
553
+ @result = []
554
+ end
555
+ def tagstart(name, attributes)
556
+ @current_perms = {} if name == 'GrantList'
557
+ end
558
+ def tagend(name)
559
+ case name
560
+ when 'ID' ; @current_perms[:id] = @text
561
+ when 'DisplayName'; @current_perms[:name] = @text
562
+ when 'Permission' ; @current_perms[:permission] = @text
563
+ when 'GrantList' ; @result << @current_perms
564
+ end
565
+ end
566
+ end
567
+
568
+ #-----------------------------------------------------------------
569
+ # PARSERS: Messages
570
+ #-----------------------------------------------------------------
571
+
572
+ class SqsReceiveMessagesParser < RightAWSParser # :nodoc:
573
+ def reset
574
+ @result = []
575
+ end
576
+ def tagstart(name, attributes)
577
+ @current_message = {} if name == 'Message'
578
+ end
579
+ def tagend(name)
580
+ case name
581
+ when 'MessageId' ; @current_message[:id] = @text
582
+ when 'MessageBody'; @current_message[:body] = @text
583
+ when 'Message' ; @result << @current_message
584
+ end
585
+ end
586
+ end
587
+
588
+ class SqsSendMessagesParser < RightAWSParser # :nodoc:
589
+ def tagend(name)
590
+ @result = @text if name == 'MessageId'
591
+ end
592
+ end
593
+
594
+ end
595
+
596
+ end
@@ -0,0 +1,2 @@
1
+ require 'test/unit'
2
+ require File.dirname(__FILE__) + '/../../lib/right_aws'