nsq-ruby 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35d1cfb3f84900faa925a11816c604c2d36d6cc
-  data.tar.gz: 0158497d7aaaa82cd5488589fb97b4361831eccd
+  metadata.gz: 1cc303464874107233049891324ba89f7fdabeb9
+  data.tar.gz: f8f0d0d615f723893babdca18401221c0f86bbf8
 SHA512:
-  metadata.gz: 7ee7047f73fd426b3825f814cace21c87cc04997975cf20c67a9e7f1b4680dd1d2b41632ca0d40c6d9086e4accb4b4a83acf43d7277166f904118be54e9d2dba
-  data.tar.gz: 4067ac682d665fb700b8e6918ce7c4a8656b1376dfd12bb3ecb1f1845f2731f4a0de8776b6421fded2ca65c9f567410074baacbc3670daae74c490d0d6fc2e12
+  metadata.gz: f797afecb530034108857cfee09ff0fb17d41d715d80cb1f10dfc527801de8ebc1cd707348908e743108a61ebddd942f1f964cadf4abb452d7a9f749572bb75d
+  data.tar.gz: b34ed2daeed5f863b6f81cf53d787fb4d11bbda45eaeabc01e5a75c33f9a7373ff72aadb4731ac7ca2b9df272ac15486dd97e59248acb7f8d0471937ba67ed89

data/README.md

@@ -187,6 +187,32 @@ message = consumer.pop
 If there are messages on the queue, `pop` will return one immediately. If there
 are no messages on the queue, `pop` will block execution until one arrives.
 
+Be aware, while `#pop` is blocking, your process will be unresponsive.  This
+can be a problem in certain cases, like if you're trying to gracefully restart
+a worker process by sending it a `TERM` signal. See `#pop_without_blocking` for
+information on how to mitigate this issue.
+
+
+### `#pop_without_blocking`
+
+This is just like `#pop` except it doesn't block. It always returns immediately.
+If there are no messages in the queue, it will return `nil`.
+
+If you're consuming from a low-volume topic and don't want to get stuck in a
+blocking state, you can use this method to consume messages like so:
+
+```Ruby
+loop do
+  if msg = @messages.pop_without_blocking
+    # do something
+    msg.finish
+  else
+    # wait for a bit before checking for new messages
+    sleep 0.01
+  end
+end
+```
+
 
 ### `#size`
 
@@ -301,11 +327,12 @@ millions of messages a day.
 - Robby Grossman (@freerobby)
 - Brendan Schwartz (@bschwartz)
 - Marshall Moutenot (@mmoutenot)
+- Danielle Sucher (@DanielleSucher)
 
 
 ## MIT License
 
-Copyright (C) 2014 Wistia, Inc.
+Copyright (C) 2016 Wistia, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/nsq/consumer.rb

@@ -48,6 +48,19 @@ module Nsq
     end
 
 
+    # By default, if the internal queue is empty, pop will block until
+    # a new message comes in.
+    #
+    # Calling this method won't block. If there are no messages, it just
+    # returns nil.
+    def pop_without_blocking
+      @messages.pop(true)
+    rescue ThreadError
+      # When the Queue is empty calling `Queue#pop(true)` will raise a ThreadError
+      nil
+    end
+
+
     # returns the number of messages we have locally in the queue
     def size
       @messages.size

data/lib/version.rb

@@ -1,7 +1,7 @@
 module Nsq
   module Version
     MAJOR = 1
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
     BUILD = nil
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nsq-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Wistia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler