nsq-ruby-maglev- 1.2.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 404388ace1303e56c07f6b18284a81abe2cd03e8
-  data.tar.gz: 77946db3d3f9d10a2d515ff75ac3ca48888fbc55
+  metadata.gz: 55fe876d7c1dbd2c80142f832d20bc8ecde1d0ae
+  data.tar.gz: 8dbd9c540ff8998c42b160def4f549bb2e72b8a3
 SHA512:
-  metadata.gz: 106aa12520e1d473c57ff760eff08267c5bd1294a0586dc06ee607d513722a0e9651435eea6a2ef4403d72f70bfd50e412909e4bfc93740e58e756d89c490132
-  data.tar.gz: 24d46489acd7a824001d0a6720e0b9bedc1b259e27a974fbe7e5c8b33b83259fc3555aea1ae1749785e31ac6def0d7eb543b3a9cd8e018055c73cbc9d816a98e
+  metadata.gz: 8cad697caa38a0688ff28c091520e5e2bef9b41eeba667a1007031e55f9c7a15f631048f674eb4f13c75a6265b2da0ec547b3a234fb884fec2000dfbd5e4b0b8
+  data.tar.gz: 599313c8a267777d9d55368dbf744387023be73dbf7583f72015265ba02289f9771ed0642f65103088a62f22fd383080bd10543310ab8aa4e03ed1a29533bf8a

data/README.md

@@ -85,7 +85,7 @@ producer = Nsq::Producer.new(
 
 ### `#write`
 
-Publishes one or more message to nsqd. If you give it a single argument, it will
+Publishes one or more messages to nsqd. If you give it a single argument, it will
 send it to nsqd via `PUB`. If you give it multiple arguments, it will send all
 those messages to nsqd via `MPUB`. It will automatically call `to_s` on any
 arguments you give it.
@@ -98,7 +98,7 @@ producer.write(123)
 producer.write(456, 'another-message', { key: 'value' }.to_json)
 ```
 
-If it's connection to nsqd fails, it will automatically try to reconnect with
+If its connection to nsqd fails, it will automatically try to reconnect with
 exponential backoff. Any messages that were sent to `#write` will be queued
 and transmitted after reconnecting.
 
@@ -107,6 +107,22 @@ connection to nsqd fails, you can lose messages. This is acceptable for our use
 cases, mostly because we are sending messages to a local nsqd instance and
 failure is very rare.
 
+
+### `#write_to_topic`
+
+Publishes one or more messages to nsqd. Like `#write`, but allows you to specify
+the topic. Use this method if you want a single producer instance to write to
+multiple topics.
+
+```Ruby
+# Send a single message via PUB to the topic 'rutabega'
+producer.write_to_topic('rutabega', 123)
+
+# Send multiple messages via MPUB to the topic 'kohlrabi'
+producer.write_to_topic('kohlrabi', 'a', 'b', 'c')
+```
+
+
 ### `#connected?`
 
 Returns true if it's currently connected to nsqd and false if not.
@@ -144,7 +160,7 @@ consumer = Nsq::Consumer.new(
   nsqlookupd: ['127.0.0.1:4161', '4.5.6.7:4161'],
   max_in_flight: 100,
   discovery_interval: 30,
-  msq_timeout: 120_000
+  msg_timeout: 120_000
 )
 ```
 
@@ -171,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`
 
@@ -285,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/nsq/producer.rb

@@ -6,7 +6,7 @@ module Nsq
 
     def initialize(opts = {})
       @connections = {}
-      @topic = opts[:topic] || raise(ArgumentError, 'topic is required')
+      @topic = opts[:topic]
       @discovery_interval = opts[:discovery_interval] || 60
 
       nsqlookupds = []
@@ -30,6 +30,18 @@ module Nsq
 
 
     def write(*raw_messages)
+      if !@topic
+        raise 'No topic specified. Either specify a topic when instantiating the Producer or use write_to_topic.'
+      end
+
+      write_to_topic(@topic, *raw_messages)
+    end
+
+
+    def write_to_topic(topic, *raw_messages)
+      # return error if message(s) not provided
+      raise ArgumentError, 'message not provided' if raw_messages.empty?
+
       # stringify the messages
       messages = raw_messages.map(&:to_s)
 
@@ -37,9 +49,9 @@ module Nsq
       connection = connection_for_write
 
       if messages.length > 1
-        connection.mpub(@topic, messages)
+        connection.mpub(topic, messages)
       else
-        connection.pub(@topic, messages.first)
+        connection.pub(topic, messages.first)
       end
     end
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nsq-ruby-maglev-
 version: !ruby/object:Gem::Version
-  version: 1.2.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Wistia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,5 +112,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Ruby client library for NSQ
+summary: MagLev Ruby client library for NSQ
 test_files: []