propono 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d76586c96adfed4a7b43d249f6a4eb9c61a5920f
-  data.tar.gz: ff43e4ea9407a6ae61c51e3a51df7dc6160ac9fe
+  metadata.gz: 53dbc7f715b2bb37de7874a88c8b3f968ea1fc4f
+  data.tar.gz: 11bce43d6c3753af3af92c9c91b293a376fae392
 SHA512:
-  metadata.gz: 9803c63181e9190eb4dd2f6248ef675d47a743956a56b53c6a21d23ad2e77d1ec500fe7280ff7876c5f5cce2ad52d472837071494a31b1c51c5588971c250b2d
-  data.tar.gz: e6fbf0073a8f596074ebee276e74455a77d4cf9ac6e27499d178d379bed444453a97f4e0195018697ce19150d78e98f86335514aea5602fffd96448a75c3d538
+  metadata.gz: 235e0650f5f1be3b1240b57b87c48fd66609cb2e7d915b8e6a409ed67e8475c680540cf0fc021aaa408915e3643c307a32afd1b5f1150c945b4ce7e361b0cffd
+  data.tar.gz: 221535790828808e5451dc8ba3ff32aa882c719d840c9d25cf5f4619839d22b1c2fa0e3dde48aa71a75bb6723f607516f4a56c75c3c8899a8354425b1bdf66ec

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2.0.0 / 2017-03-14
+* [FEATURE] Added visibility_timeout to listen
+
 # 2.0.0 / 2017-03-14
 * [FEATURE] Remove UDP and TCP support
 * [FEATURE] Change default publish behaviour from async to sync

data/README.md

@@ -102,6 +102,18 @@ Propono::Client.new do |config|
 end
 ```
 
+### Options
+
+#### Visiblity Timeout
+
+For certain tasks (e.g. video processing), being able to hold messages for longer is important. To achieve this, the [visibility timeout of a message](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) can be changed on the call to listen. e.g.
+
+```
+client.listen('long-running-tasks', visiblity_timeout: 3600) do |message|
+  puts "I just received: #{message}"
+end
+```
+
 These can all also be set using the `client.config.access_key = "..."` syntax.
 
 ### Is it any good?

data/lib/propono/components/aws_client.rb

@@ -47,12 +47,14 @@ module Propono
       )
     end
 
-    def read_from_sqs(queue, num_messages, long_poll: true)
+    def read_from_sqs(queue, num_messages, long_poll: true, visibility_timeout: nil)
       wait_time_seconds = long_poll ? 20 : 0
+      visibility_timeout ||= 30
       sqs_client.receive_message(
         queue_url: queue.url,
         wait_time_seconds: wait_time_seconds,
-        max_number_of_messages: num_messages
+        max_number_of_messages: num_messages,
+        visibility_timeout: visibility_timeout
       ).messages
     end
 

data/lib/propono/components/client.rb

@@ -69,8 +69,8 @@ module Propono
     #
     # @param [String] topic The topic to subscribe to.
     # @param &message_processor The block to yield for each message.
-    def listen(topic_name, &message_processor)
-      QueueListener.listen(aws_client, config, topic_name, &message_processor)
+    def listen(topic_name, options = {}, &message_processor)
+      QueueListener.listen(aws_client, config, topic_name, options, &message_processor)
     end
 
     # Listens on a queue and yields for each message

data/lib/propono/services/queue_listener.rb

@@ -9,12 +9,13 @@ module Propono
       new(*args, &message_processor).drain
     end
 
-    attr_reader :aws_client, :propono_config, :topic_name, :message_processor
-    def initialize(aws_client, propono_config, topic_name, &message_processor)
+    attr_reader :aws_client, :propono_config, :topic_name, :visibility_timeout, :message_processor
+    def initialize(aws_client, propono_config, topic_name, options = {}, &message_processor)
       @aws_client = aws_client
       @propono_config = propono_config
       @topic_name = topic_name
       @message_processor = message_processor
+      @visibility_timeout = options[:visibility_timeout] || nil
     end
 
     def listen
@@ -38,7 +39,7 @@ module Propono
     end
 
     def read_messages_from_queue(queue, num_messages, long_poll: true)
-      messages = aws_client.read_from_sqs(queue, num_messages, long_poll: long_poll)
+      messages = aws_client.read_from_sqs(queue, num_messages, long_poll: long_poll, visibility_timeout: visibility_timeout)
       if messages.empty?
         false
       else

data/lib/propono/version.rb

@@ -1,3 +1,3 @@
 module Propono
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/test/components/client_test.rb

@@ -40,11 +40,28 @@ module Propono
       QueueListener.expects(:listen).with(
         client.aws_client,
         client.config,
-        topic
+        topic,
+        {}
       )
       client.listen(topic)
     end
 
+    def test_listen_calls_queue_listener_with_options
+      topic = 'foobar'
+      options = {foo: 'bar'}
+
+      client = Propono::Client.new
+      QueueListener.expects(:listen).with(
+        client.aws_client,
+        client.config,
+        topic,
+        options
+      )
+      client.listen(topic, options)
+    end
+
+
+
     def test_drain_queue_calls_queue_listener
       topic = 'foobar'
 

data/test/services/queue_listener_test.rb

@@ -81,7 +81,7 @@ module Propono
 
     def test_read_message_from_sqs
       max_number_of_messages = 5
-      aws_client.expects(:read_from_sqs).with(@queue, max_number_of_messages, long_poll: true)
+      aws_client.expects(:read_from_sqs).with(@queue, max_number_of_messages, long_poll: true, visibility_timeout: nil)
       @listener.send(:read_messages_from_queue, @queue, max_number_of_messages)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: propono
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - MalcyL
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns