Class: RightAws::SqsGen2::Queue

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sqs, url_or_name) ⇒ Queue

Creates new Queue instance. Does not create a queue at Amazon.

queue = RightAws::SqsGen2::Queue.new(sqs, 'my_awesome_queue')



113
114
115
116
117
 
# File 'lib/sqs/right_sqs_gen2.rb', line 113

def initialize(sqs, url_or_name)
  @sqs  = sqs
  @url  = @sqs.interface.queue_url_by_name(url_or_name)
  @name = @sqs.interface.queue_name_by_url(@url)
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



97
98
99
 
# File 'lib/sqs/right_sqs_gen2.rb', line 97

def name
  @name
end

#sqs ⇒ Object (readonly)

Returns the value of attribute sqs.



97
98
99
 
# File 'lib/sqs/right_sqs_gen2.rb', line 97

def sqs
  @sqs
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



97
98
99
 
# File 'lib/sqs/right_sqs_gen2.rb', line 97

def url
  @url
end

Class Method Details

.create(sqs, url_or_name, create = true, visibility = nil) ⇒ Object

Returns Queue instance by queue name. If the queue does not exist at Amazon SQS and create is true, the method creates it.

RightAws::SqsGen2::Queue.create(sqs, 'my_awesome_queue') #=> #<RightAws::SqsGen2::Queue:0xb7b626e4 ... >



104
105
106
 
# File 'lib/sqs/right_sqs_gen2.rb', line 104

def self.create(sqs, url_or_name, create=true, visibility=nil)
  sqs.queue(url_or_name, create, visibility)
end

Instance Method Details

#add_permissions(label, grantees, actions) ⇒ Object

Add permission to the queue.

queue.add_permissions('testLabel',['125074342641', '125074342642'],
                      ['SendMessage','SendMessage','ReceiveMessage']) #=> true



278
279
280
 
# File 'lib/sqs/right_sqs_gen2.rb', line 278

def add_permissions(label, grantees, actions)
  @sqs.interface.add_permissions(@url, label, grantees, actions)
end

#clear ⇒ Object

Clears queue, deleting only the visible messages. Any message within its visibility timeout will not be deleted, and will re-appear in the queue in the future when the timeout expires.

To delete all messages in a queue and eliminate the chance of any messages re-appearing in the future, it’s best to delete the queue and re-create it as a new queue. Note that doing this will take at least 60 s since SQS does not allow re-creation of a queue within this interval.

queue.clear() #=> true



138
139
140
 
# File 'lib/sqs/right_sqs_gen2.rb', line 138

def clear()
  @sqs.interface.clear_queue(@url)
end

#delete(force = false) ⇒ Object

Deletes queue. Any messages in the queue will be permanently lost. Returns true.

NB: Use with caution; severe data loss is possible!

queue.delete(true) #=> true



149
150
151
 
# File 'lib/sqs/right_sqs_gen2.rb', line 149

def delete(force=false)
  @sqs.interface.delete_queue(@url)
end

#get_attribute(attribute = 'All') ⇒ Object

Retrieves queue attributes. If the name of attribute is set, returns its value. Otherwise, returns a hash of attributes.

queue.get_attribute(‘VisibilityTimeout’) #=> “VisibilityTimeout”=>“45”

P.S. This guy is deprecated. Use get_attributes instead.



251
252
253
254
 
# File 'lib/sqs/right_sqs_gen2.rb', line 251

def get_attribute(attribute='All')
  attributes = get_attributes(attribute)
  attribute=='All' ? attributes : attributes[attribute]
end

#get_attributes(*attributes) ⇒ Object

Retrieves queue attributes.

queue.get_attributes #=>
  {"ApproximateNumberOfMessages" => "0",
   "LastModifiedTimestamp"       => "1240946032",
   "CreatedTimestamp"            => "1240816887",
   "VisibilityTimeout"           => "30",
   "Policy"                      => "{"Version":"2008-10-17","Id":...}"}

queue.get_attributes("LastModifiedTimestamp", "VisibilityTimeout") #=>
  {"LastModifiedTimestamp" => "1240946032",
   "VisibilityTimeout"     => "30"}



269
270
271
 
# File 'lib/sqs/right_sqs_gen2.rb', line 269

def get_attributes(*attributes)
  @sqs.interface.get_queue_attributes(@url, attributes)
end

#get_permissions ⇒ Object

Get current permissions set. The set is JSON packed.

sqs.get_permissions #=>
  '{"Version":"2008-10-17","Id":"/826693181925/kd-test-gen-2_5/SQSDefaultPolicy",
    "Statement":[{"Sid":"kd-perm-04","Effect":"Allow","Principal":{"AWS":"100000000001",
    "AWS":"100000000001","AWS":"100000000002"},"Action":["SQS:SendMessage","SQS:DeleteMessage",
    "SQS:ReceiveMessage"],"Resource":"/826693181925/kd-test-gen-2_5"},{"Sid":"kd-perm-03",
    "Effect":"Allow","Principal":{"AWS":"648772224137"},"Action":"SQS:SendMessage",
    "Resource":"/826693181925/kd-test-gen-2_5"}]}'



300
301
302
 
# File 'lib/sqs/right_sqs_gen2.rb', line 300

def get_permissions
  get_attributes('Policy')['Policy']
end

#pop(attributes = nil) ⇒ Object

Pops (and deletes) first accessible message from queue. Returns Message instance or nil if the queue is empty.

queue.pop #=> #<RightAws::SqsGen2::Message:0xb7bf0884 ... >

# pop a message with custom attributes
m = queue.pop(['SenderId', 'SentTimestamp']) #=> #<RightAws::SqsGen2::Message:0xb7bf1884 ... >
m.attributes #=> {"SentTimestamp"=>"1240991906937", "SenderId"=>"800000000005"}



199
200
201
202
203
204
205
206
207
 
# File 'lib/sqs/right_sqs_gen2.rb', line 199

def pop(attributes=nil)
  list = @sqs.interface.pop_messages(@url, 1, attributes)
  return nil if list.empty?
  entry = list[0]
  msg = Message.new(self, entry['MessageId'], entry['ReceiptHandle'], entry['Body'], visibility, entry['Attributes'])
  msg.received_at = Time.now 
  msg.receive_checksum = entry['MD5OfBody']
  msg
end

#receive(visibility = nil, attributes = nil) ⇒ Object

Retrieves first accessible message from queue. Returns Message instance or nil it the queue is empty.

queue.receive #=> #<RightAws::SqsGen2::Message:0xb7bf0884 ... >



185
186
187
188
 
# File 'lib/sqs/right_sqs_gen2.rb', line 185

def receive(visibility=nil, attributes=nil)
  list = receive_messages(1, visibility, attributes)
  list.empty? ? nil : list[0]
end

#receive_messages(number_of_messages = 1, visibility = nil, attributes = nil) ⇒ Object

Retrieves several messages from queue. Returns an array of Message instances. 

queue.receive_messages(2,10) #=> array of messages



170
171
172
173
174
175
176
177
178
 
# File 'lib/sqs/right_sqs_gen2.rb', line 170

def receive_messages(number_of_messages=1, visibility=nil, attributes=nil)
  list = @sqs.interface.receive_message(@url, number_of_messages, visibility, attributes)
  list.map! do |entry|
    msg = Message.new(self, entry['MessageId'], entry['ReceiptHandle'], entry['Body'], visibility, entry['Attributes'])
    msg.received_at = Time.now 
    msg.receive_checksum = entry['MD5OfBody']
    msg
  end
end

#remove_permissions(label) ⇒ Object

Revoke any permissions in the queue policy that matches the label parameter.

sqs.remove_permissions('testLabel') # => true



286
287
288
 
# File 'lib/sqs/right_sqs_gen2.rb', line 286

def remove_permissions(label)
  @sqs.interface.remove_permissions(@url, label)
end

#send_message(message) ⇒ Object Also known as: push

Sends new message to queue. Returns new Message instance that has been sent to queue.



155
156
157
158
159
160
161
162
 
# File 'lib/sqs/right_sqs_gen2.rb', line 155

def send_message(message)
  message = message.to_s
  res = @sqs.interface.send_message(@url, message)
  msg = Message.new(self, res['MessageId'], nil, message)
  msg.send_checksum = res['MD5OfMessageBody']
  msg.sent_at = Time.now
  msg
end

#set_attribute(attribute, value) ⇒ Object

Sets new queue attribute value. Not all attributes may be changed: ApproximateNumberOfMessages (for example) is a read only attribute. Returns a value to be assigned to attribute. Currently, ‘VisibilityTimeout’ is the only settable queue attribute. Attempting to set non-existent attributes generates an indignant exception.

queue.set_attribute(‘VisibilityTimeout’, ‘100’) #=> ‘100’ queue.get_attribute(‘VisibilityTimeout’) #=> ‘100’



240
241
242
243
 
# File 'lib/sqs/right_sqs_gen2.rb', line 240

def set_attribute(attribute, value)
  @sqs.interface.set_queue_attributes(@url, attribute, value)
  value
end

#size ⇒ Object

Retrieves queue size.

queue.size #=> 1



123
124
125
 
# File 'lib/sqs/right_sqs_gen2.rb', line 123

def size
  @sqs.interface.get_queue_length(@url)
end

#visibility ⇒ Object

Retrieves VisibilityTimeout value for the queue. Returns new timeout value.

queue.visibility #=> 30



214
215
216
 
# File 'lib/sqs/right_sqs_gen2.rb', line 214

def visibility
  @sqs.interface.get_queue_attributes(@url, 'VisibilityTimeout')['VisibilityTimeout']
end

#visibility=(visibility_timeout) ⇒ Object

Sets new VisibilityTimeout for the queue. Returns new timeout value. 

queue.visibility #=> 30
queue.visibility = 33
queue.visibility #=> 33



225
226
227
228
 
# File 'lib/sqs/right_sqs_gen2.rb', line 225

def visibility=(visibility_timeout)
  @sqs.interface.set_queue_attributes(@url, 'VisibilityTimeout', visibility_timeout)
  visibility_timeout
end