Class: Aws::SqsInterface
- Includes:
- AwsBaseInterface
- Defined in:
- lib/sqs/right_sqs_interface.rb
Overview
Right::Aws::SqsInterface - RightScale’s low-level Amazon SQS interface for API version 2008-01-01 and later. For explanations of the semantics of each call, please refer to Amazon’s documentation at developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=31
This class provides a procedural interface to SQS. Conceptually it is mostly a pass-through interface to SQS and its API is very similar to the bare SQS API. For a somewhat higher-level and object-oriented interface, see Aws::Sqs.
Defined Under Namespace
Classes: SqsCreateQueueParser, SqsGetQueueAttributesParser, SqsListQueuesParser, SqsReceiveMessageParser, SqsSendMessagesParser, SqsStatusParser
Constant Summary collapse
- API_VERSION =
"2009-02-01"
- DEFAULT_HOST =
"queue.amazonaws.com"
- DEFAULT_PORT =
443
- DEFAULT_PROTOCOL =
'https'
- REQUEST_TTL =
30
- DEFAULT_VISIBILITY_TIMEOUT =
30
- @@bench =
AwsBenchmarkingBlock.new
- @@api =
API_VERSION
Constants included from AwsBaseInterface
AwsBaseInterface::DEFAULT_SIGNATURE_VERSION
Constants inherited from AwsBase
Instance Attribute Summary
Attributes included from AwsBaseInterface
#aws_access_key_id, #cache, #connection, #last_errors, #last_request, #last_request_id, #last_response, #logger, #params, #signature_version
Class Method Summary collapse
- .api ⇒ Object
- .bench_sqs ⇒ Object
- .bench_xml ⇒ Object
-
.queue_name_by_url(queue_url) ⇒ Object
Returns short queue name by url.
Instance Method Summary collapse
-
#clear_queue(queue_url) ⇒ Object
Removes all visible messages from queue.
-
#create_queue(queue_name, default_visibility_timeout = nil) ⇒ Object
Creates a new queue, returning its URI.
-
#delete_message(queue_url, receipt_handle) ⇒ Object
Deletes message from queue.
-
#delete_queue(queue_url) ⇒ Object
Deletes queue.
-
#generate_post_request(action, param = {}) ⇒ Object
:nodoc:.
-
#generate_request(action, param = {}) ⇒ Object
Generates a request hash for the query API.
-
#get_queue_attributes(queue_url, attribute = 'All') ⇒ Object
Retrieves the queue attribute(s).
-
#get_queue_length(queue_url) ⇒ Object
Returns approximate number of messages in queue.
-
#initialize(aws_access_key_id = nil, aws_secret_access_key = nil, params = {}) ⇒ SqsInterface
constructor
Creates a new SqsInterface instance.
-
#list_queues(queue_name_prefix = nil) ⇒ Object
Lists all queues owned by this user that have names beginning with
queue_name_prefix
. -
#pop_message(queue_url) ⇒ Object
Pops (retrieves and deletes) first accessible message from queue.
-
#pop_messages(queue_url, number_of_messages = 1) ⇒ Object
Pops (retrieves and deletes) up to ‘number_of_messages’ from queue.
-
#queue_name_by_url(queue_url) ⇒ Object
Returns short queue name by url.
-
#queue_url_by_name(queue_name) ⇒ Object
Given the queue’s short name, this call returns the queue URL or
nil
if queue is not found sqs.queue_url_by_name(‘my_awesome_queue’) #=> ‘queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue’. -
#receive_message(queue_url, max_number_of_messages = 1, visibility_timeout = nil) ⇒ Object
Retrieves a list of messages from queue.
-
#request_info(request, parser) ⇒ Object
Sends request to Amazon and parses the response Raises AwsError if any banana happened.
-
#send_message(queue_url, message) ⇒ Object
(also: #push_message)
Sends a new message to a queue.
-
#set_queue_attributes(queue_url, attribute, value) ⇒ Object
Sets queue attribute.
Methods included from AwsBaseInterface
#cache_hits?, caching, caching=, #caching?, #generate_request2, #get_conn, #hash_params, #init, #multi_thread, #on_exception, #request_cache_or_info, #request_info2, #request_info_impl, #request_info_xml_simple, #signed_service_params, #update_cache
Methods inherited from AwsBase
amazon_problems, amazon_problems=
Constructor Details
#initialize(aws_access_key_id = nil, aws_secret_access_key = nil, params = {}) ⇒ SqsInterface
Creates a new SqsInterface instance. This instance is limited to operations on SQS objects created with Amazon’s 2008-01-01 API version. This interface will not work on objects created with prior API versions. See Amazon’s article “Migrating to Amazon SQS API version 2008-01-01” at: developer.amazonwebservices.com/connect/entry.jspa?externalID=1148
sqs = Aws::SqsInterface.new('1E3GDYEOGFJPIT75KDT40','hgTHt68JY07JKUY08ftHYtERkjgtfERn57DFE379', {:multi_thread => true, :logger => Logger.new('/tmp/x.log')})
Params is a hash:
{:server => 'queue.amazonaws.com' # Amazon service host: 'queue.amazonaws.com' (default)
:port => 443 # Amazon service port: 80 or 443 (default)
:multi_thread => true|false # Multi-threaded (connection per each thread): true or false (default)
:signature_version => '0' # The signature version : '0' or '1'(default)
:logger => Logger Object} # Logger instance: logs to STDOUT if omitted }
78 79 80 81 82 83 84 85 86 |
# File 'lib/sqs/right_sqs_interface.rb', line 78 def initialize(aws_access_key_id=nil, aws_secret_access_key=nil, params={}) init({ :name => 'SQS', :default_host => ENV['SQS_URL'] ? URI.parse(ENV['SQS_URL']).host : DEFAULT_HOST, :default_port => ENV['SQS_URL'] ? URI.parse(ENV['SQS_URL']).port : DEFAULT_PORT, :default_protocol => ENV['SQS_URL'] ? URI.parse(ENV['SQS_URL']).scheme : DEFAULT_PROTOCOL }, aws_access_key_id || ENV['AWS_ACCESS_KEY_ID'], aws_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY'], params) end |
Class Method Details
.api ⇒ Object
58 59 60 |
# File 'lib/sqs/right_sqs_interface.rb', line 58 def self.api @@api end |
.bench_sqs ⇒ Object
53 54 55 |
# File 'lib/sqs/right_sqs_interface.rb', line 53 def self.bench_sqs @@bench.service end |
.bench_xml ⇒ Object
50 51 52 |
# File 'lib/sqs/right_sqs_interface.rb', line 50 def self.bench_xml @@bench.xml end |
.queue_name_by_url(queue_url) ⇒ Object
Returns short queue name by url.
RightSqs.queue_name_by_url('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> 'my_awesome_queue'
301 302 303 304 305 |
# File 'lib/sqs/right_sqs_interface.rb', line 301 def self.queue_name_by_url(queue_url) queue_url[/[^\/]*$/] rescue on_exception end |
Instance Method Details
#clear_queue(queue_url) ⇒ Object
Removes all visible messages from queue. Return true
or an exception.
sqs.clear_queue('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> true
331 332 333 334 335 336 |
# File 'lib/sqs/right_sqs_interface.rb', line 331 def clear_queue(queue_url) while ((queue_url, 10).length > 0) ; end # delete all messages in queue true rescue on_exception end |
#create_queue(queue_name, default_visibility_timeout = nil) ⇒ Object
Creates a new queue, returning its URI.
sqs.create_queue('my_awesome_queue') #=> 'http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue'
153 154 155 156 157 158 159 |
# File 'lib/sqs/right_sqs_interface.rb', line 153 def create_queue(queue_name, default_visibility_timeout=nil) req_hash = generate_request('CreateQueue', 'QueueName' => queue_name, 'DefaultVisibilityTimeout' => default_visibility_timeout || DEFAULT_VISIBILITY_TIMEOUT ) request_info(req_hash, SqsCreateQueueParser.new(:logger => @logger)) rescue on_exception end |
#delete_message(queue_url, receipt_handle) ⇒ Object
Deletes message from queue. Returns true
or an exception. Amazon returns true
on deletion of non-existent messages. You must use the receipt handle for a message to delete it, not the message ID.
From the SQS Developer Guide: “It is possible you will receive a message even after you have deleted it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you request to delete the message. The copy remains on the server and might be returned to you again on a subsequent receive request. You should create your system to be idempotent so that receiving a particular message more than once is not a problem. ”
sqs.('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 'Euvo62/1nlIet...ao03hd9Sa0w==') #=> true
276 277 278 279 280 281 |
# File 'lib/sqs/right_sqs_interface.rb', line 276 def (queue_url, receipt_handle) req_hash = generate_request('DeleteMessage', 'ReceiptHandle' => receipt_handle, :queue_url => queue_url) request_info(req_hash, SqsStatusParser.new(:logger => @logger)) rescue on_exception end |
#delete_queue(queue_url) ⇒ Object
Deletes queue. Any messages in the queue are permanently lost. Returns true
or an exception. Queue deletion can take up to 60 s to propagate through SQS. Thus, after a deletion, subsequent list_queues calls may still show the deleted queue. It is not unusual within the 60 s window to see the deleted queue absent from one list_queues call but present in the subsequent one. Deletion is eventual.
sqs.delete_queue('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue_2') #=> true
185 186 187 188 189 190 |
# File 'lib/sqs/right_sqs_interface.rb', line 185 def delete_queue(queue_url) req_hash = generate_request('DeleteQueue', :queue_url => queue_url) request_info(req_hash, SqsStatusParser.new(:logger => @logger)) rescue on_exception end |
#generate_post_request(action, param = {}) ⇒ Object
:nodoc:
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/sqs/right_sqs_interface.rb', line 117 def generate_post_request(action, param={}) # :nodoc: service = param[:queue_url] ? URI(param[:queue_url]).path : '/' = param[:message] # extract message body if nesessary param.each{ |key, value| param.delete(key) if (value.nil? || key.is_a?(Symbol)) } service_hash = { "Action" => action, "Expires" => (Time.now + REQUEST_TTL).utc.strftime("%Y-%m-%dT%H:%M:%SZ"), "AWSAccessKeyId" => @aws_access_key_id, "MessageBody" => , "Version" => API_VERSION } service_hash.update(param) # service_params = signed_service_params(@aws_secret_access_key, service_hash, :post, @params[:server], service) request = Net::HTTP::Post.new(AwsUtils::URLencode(service)) request['Content-Type'] = 'application/x-www-form-urlencoded' request.body = service_params # prepare output hash { :request => request, :server => @params[:server], :port => @params[:port], :protocol => @params[:protocol] } end |
#generate_request(action, param = {}) ⇒ Object
Generates a request hash for the query API
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/sqs/right_sqs_interface.rb', line 94 def generate_request(action, param={}) # :nodoc: # For operation requests on a queue, the queue URI will be a parameter, # so we first extract it from the call parameters. Next we remove any # parameters with no value or with symbolic keys. We add the header # fields required in all requests, and then the headers passed in as # params. We sort the header fields alphabetically and then generate the # signature before URL escaping the resulting query and sending it. service = param[:queue_url] ? URI(param[:queue_url]).path : '/' param.each{ |key, value| param.delete(key) if (value.nil? || key.is_a?(Symbol)) } service_hash = { "Action" => action, "Expires" => (Time.now + REQUEST_TTL).utc.strftime("%Y-%m-%dT%H:%M:%SZ"), "AWSAccessKeyId" => @aws_access_key_id, "Version" => API_VERSION } service_hash.update(param) service_params = signed_service_params(@aws_secret_access_key, service_hash, :get, @params[:server], service) request = Net::HTTP::Get.new("#{AwsUtils.URLencode(service)}?#{service_params}") # prepare output hash { :request => request, :server => @params[:server], :port => @params[:port], :protocol => @params[:protocol] } end |
#get_queue_attributes(queue_url, attribute = 'All') ⇒ Object
Retrieves the queue attribute(s). Returns a hash of attribute(s) or an exception.
sqs.get_queue_attributes('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue')
#=> {"ApproximateNumberOfMessages"=>"0", "VisibilityTimeout"=>"30"}
197 198 199 200 201 202 |
# File 'lib/sqs/right_sqs_interface.rb', line 197 def get_queue_attributes(queue_url, attribute='All') req_hash = generate_request('GetQueueAttributes', 'AttributeName' => attribute, :queue_url => queue_url) request_info(req_hash, SqsGetQueueAttributesParser.new(:logger => @logger)) rescue on_exception end |
#get_queue_length(queue_url) ⇒ Object
Returns approximate number of messages in queue.
sqs.get_queue_length('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> 3
321 322 323 324 325 |
# File 'lib/sqs/right_sqs_interface.rb', line 321 def get_queue_length(queue_url) get_queue_attributes(queue_url)['ApproximateNumberOfMessages'].to_i rescue on_exception end |
#list_queues(queue_name_prefix = nil) ⇒ Object
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. Queue creation is an eventual operation and created queues may not show up in immediately subsequent list_queues calls.
sqs.create_queue('my_awesome_queue')
sqs.create_queue('my_awesome_queue_2')
sqs.list_queues('my_awesome') #=> ['http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue','http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue_2']
169 170 171 172 173 174 |
# File 'lib/sqs/right_sqs_interface.rb', line 169 def list_queues(queue_name_prefix=nil) req_hash = generate_request('ListQueues', 'QueueNamePrefix' => queue_name_prefix) request_info(req_hash, SqsListQueuesParser.new(:logger => @logger)) rescue on_exception end |
#pop_message(queue_url) ⇒ Object
Pops (retrieves and deletes) first accessible message from queue. Returns the message in format {:id=>'message_id', :body=>'message_body'}
or nil
.
sqs.('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=>
{:id=>"12345678904GEZX9746N|0N9ED344VK5Z3SV1DTM0|1RVYH4X3TJ0987654321", :body=>"message_1"}
359 360 361 362 363 364 |
# File 'lib/sqs/right_sqs_interface.rb', line 359 def (queue_url) = (queue_url) .blank? ? nil : [0] rescue on_exception end |
#pop_messages(queue_url, number_of_messages = 1) ⇒ Object
Pops (retrieves and deletes) up to ‘number_of_messages’ from queue. Returns an array of retrieved messages in format: [{:id=>'message_id', :body=>'message_body'}]
.
sqs.pop_messages('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 3) #=>
[{"ReceiptHandle"=>"Euvo62/...+Zw==", "MD5OfBody"=>"16af2...81e3", "Body"=>"Goodbyte World!",
"MessageId"=>"MEZI...JSWDE="}, {...}, ... , {...} ]
344 345 346 347 348 349 350 351 352 |
# File 'lib/sqs/right_sqs_interface.rb', line 344 def (queue_url, =1) = (queue_url, ) .each do || (queue_url, ['ReceiptHandle']) end rescue on_exception end |
#queue_name_by_url(queue_url) ⇒ Object
Returns short queue name by url.
sqs.queue_name_by_url('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue') #=> 'my_awesome_queue'
311 312 313 314 315 |
# File 'lib/sqs/right_sqs_interface.rb', line 311 def queue_name_by_url(queue_url) self.class.queue_name_by_url(queue_url) rescue on_exception end |
#queue_url_by_name(queue_name) ⇒ Object
Given the queue’s short name, this call returns the queue URL or nil
if queue is not found
sqs.queue_url_by_name('my_awesome_queue') #=> 'http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue'
286 287 288 289 290 291 292 293 294 295 |
# File 'lib/sqs/right_sqs_interface.rb', line 286 def queue_url_by_name(queue_name) return queue_name if queue_name.include?('/') queue_urls = list_queues(queue_name) queue_urls.each do |queue_url| return queue_url if queue_name_by_url(queue_url) == queue_name end nil rescue on_exception end |
#receive_message(queue_url, max_number_of_messages = 1, visibility_timeout = nil) ⇒ Object
Retrieves a list of messages from queue. Returns an array of hashes in format: {:id=>'message_id', body=>'message_body'}
sqs.receive_message('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue',10, 5) #=>
[{"ReceiptHandle"=>"Euvo62...kw==", "MD5OfBody"=>"16af2171b5b83cfa35ce254966ba81e3",
"Body"=>"Goodbyte World!", "MessageId"=>"MUM4WlAyR...pYOTA="}, ..., {}]
Normally this call returns fewer messages than the maximum specified, even if they are available.
233 234 235 236 237 238 239 240 |
# File 'lib/sqs/right_sqs_interface.rb', line 233 def (queue_url, =1, visibility_timeout=nil) return [] if == 0 req_hash = generate_post_request('ReceiveMessage', 'MaxNumberOfMessages' => , 'VisibilityTimeout' => visibility_timeout, :queue_url => queue_url ) request_info(req_hash, SqsReceiveMessageParser.new(:logger => @logger)) rescue on_exception end |
#request_info(request, parser) ⇒ Object
Sends request to Amazon and parses the response Raises AwsError if any banana happened
142 143 144 145 146 |
# File 'lib/sqs/right_sqs_interface.rb', line 142 def request_info(request, parser) # :nodoc: thread = @params[:multi_thread] ? Thread.current : Thread.main thread[:sqs_connection] ||= Rightscale::HttpConnection.new(:exception => AwsError, :logger => @logger) request_info_impl(thread[:sqs_connection], @@bench, request, parser) end |
#send_message(queue_url, message) ⇒ Object Also known as: push_message
Sends a new message to a queue. Message size is limited to 8 KB. If successful, this call returns a hash containing key/value pairs for “MessageId” and “MD5OfMessageBody”:
sqs.send_message('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', 'message_1') #=> "1234567890...0987654321"
=> {"MessageId"=>"MEs4M0JKNlRCRTBBSENaMjROTk58QVFRNzNEREhDVFlFOVJDQ1JKNjF8UTdBRllCUlJUMjhKMUI1WDJSWDE=", "MD5OfMessageBody"=>"16af2171b5b83cfa35ce254966ba81e3"}
On failure, send_message raises an exception.
252 253 254 255 256 257 |
# File 'lib/sqs/right_sqs_interface.rb', line 252 def (queue_url, ) req_hash = generate_post_request('SendMessage', :message => , :queue_url => queue_url) request_info(req_hash, SqsSendMessagesParser.new(:logger => @logger)) rescue on_exception end |
#set_queue_attributes(queue_url, attribute, value) ⇒ Object
Sets queue attribute. Returns true
or an exception.
sqs.set_queue_attributes('http://queue.amazonaws.com/ZZ7XXXYYYBINS/my_awesome_queue', "VisibilityTimeout", 10) #=> true
From the SQS Dev Guide: “Currently, you can set only the VisibilityTimeout attribute for a queue… When you change a queue’s attributes, the change can take up to 60 seconds to propagate throughout the SQS system.”
NB: Attribute values may not be immediately available to other queries for some time after an update. See the SQS documentation for semantics, but in general propagation can take up to 60 s.
217 218 219 220 221 222 |
# File 'lib/sqs/right_sqs_interface.rb', line 217 def set_queue_attributes(queue_url, attribute, value) req_hash = generate_request('SetQueueAttributes', 'Attribute.Name' => attribute, 'Attribute.Value' => value, :queue_url => queue_url) request_info(req_hash, SqsStatusParser.new(:logger => @logger)) rescue on_exception end |