nsq-ruby 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7330baaeb160c2c5d5771c6694c67fd431b635b9
-  data.tar.gz: 69ab28adb8065ba95d8a6936fc6f437c8b28d1d7
+  metadata.gz: 6cbb0662845f5a7d8080d9531d9238fe12b8f87e
+  data.tar.gz: 105520f8192afccdba5097cae209ac36d1ec09e9
 SHA512:
-  metadata.gz: ebb0f048f870b45ff0123406639b2cb824bd69e4db938efeaa1751fb60de78e2477864f55eab890ad919efc8cbe1da10a290d8d152f3c989b7697116c40cf04d
-  data.tar.gz: 5fd65ab036ffdef8d0460b839a358e93b19849668f007fe22f8d1ded73a781408faf32e4147f7c354c11cc113357e9e716e39d14070cc55c3ee7cb446e0f98bd
+  metadata.gz: 7b4038559f24a0923af28a5e9c0281f32f09850b3970b07c52abd587d66dd119d912686408f91e92c77d376c5565d73a8bfcf3c9f391bacde6e22ce550f10d0b
+  data.tar.gz: d0425623eb3cf5733e5b10bc2ab40bb377c9fa4e5ecf9509e5ea88d4006f64211cda36821165b696ab7b58fb139c6aa39ceb12001229f92fd1e5d8e0f5296895

data/README.md

@@ -68,8 +68,9 @@ The Nsq::Producer constructor takes the following options:
 |---------------|----------------------------------------|--------------------|
 | `topic`       | Topic to which to publish messages     |                    |
 | `nsqd`        | Host and port of the nsqd instance     | '127.0.0.1:4150'   |
-| `nsqlookupd`  | Use lookupd to automatically discover nsqds |               |
-| `ssl_context` | Optional keys and certificates for TLS connections |        |
+| `nsqlookupd`  | Use lookupd to auto discover nsqds     |                    |
+| `tls_v1`      | Flag for tls v1 connections            | false              |
+| `tls_options` | Optional keys+certs for TLS connections|                    |
 
 For example, if you'd like to publish messages to a single nsqd.
 
@@ -92,19 +93,29 @@ producer = Nsq::Producer.new(
 )
 ```
 
-If you need to connect using SSL/TLS
+If you need to connect using SSL/TLS Authentication via `tls_options`
 
 ```Ruby
 producer = Nsq::Producer.new(
   nsqlookupd: ['1.2.3.4:4161', '6.7.8.9:4161'],
   topic: 'topic-of-great-esteem',
-  ssl_context: {
+  tls_v1: true,
+  tls_options: {
     key: '/path/to/ssl/key.pem',
     certificate: '/path/to/ssl/certificate.pem'
   }
 )
 ```
 
+If you need to connect using simple `tls_v1`
+
+```Ruby
+producer = Nsq::Producer.new(
+  nsqlookupd: ['1.2.3.4:4161', '6.7.8.9:4161'],
+  topic: 'topic-of-great-esteem',
+  tls_v1: true
+)
+```
 
 ### `#write`
 
@@ -170,9 +181,10 @@ producers when you're done with them.
 | `nsqlookupd`         | Use lookupd to automatically discover nsqds   |                    |
 | `nsqd`               | Connect directly to a single nsqd instance    | '127.0.0.1:4150'   |
 | `max_in_flight`      | Max number of messages for this consumer to have in flight at a time   | 1 |
-| `discovery_interval` | Seconds between queue discovery via nsqlookupd    | 60.0   |
-| `msg_timeout`        | Milliseconds before nsqd will timeout a message   | 60000  |
-| `ssl_context`        | Optional keys and certificates for TLS connections |       |
+| `discovery_interval` | Seconds between queue discovery via nsqlookupd    | 60.0           |
+| `msg_timeout`        | Milliseconds before nsqd will timeout a message   | 60000          |
+| `tls_v1`             | Flag for tls v1 connections                   | false              |
+| `tls_options`        | Optional keys and certificates for TLS connections |               |
 
 
 For example:
@@ -185,7 +197,8 @@ consumer = Nsq::Consumer.new(
   max_in_flight: 100,
   discovery_interval: 30,
   msg_timeout: 120_000,
-  ssl_context: {
+  tls_v1: true,
+  tls_options: {
     key: '/path/to/ssl/key.pem',
     certificate: '/path/to/ssl/certificate.pem'
   }

data/lib/nsq/client_base.rb

@@ -90,7 +90,9 @@ module Nsq
       connection = Connection.new({
         host: host,
         port: port,
-        ssl_context: @ssl_context
+        ssl_context: @ssl_context,
+        tls_options: @tls_options,
+        tls_v1: @tls_v1
       }.merge(options))
       @connections[nsqd] = connection
     end

data/lib/nsq/connection.rb

@@ -31,8 +31,24 @@ module Nsq
       @channel = opts[:channel]
       @msg_timeout = opts[:msg_timeout] || 60_000 # 60s
       @max_in_flight = opts[:max_in_flight] || 1
-      @ssl_context = opts[:ssl_context]
-      validate_ssl_context! if @ssl_context
+      @tls_options = opts[:tls_options]
+      if opts[:ssl_context]
+        if @tls_options
+          warn 'ssl_context and tls_options both set. Using tls_options. Ignoring ssl_context.'
+        else
+          @tls_options = opts[:ssl_context]
+          warn 'ssl_context will be deprecated nsq-ruby version 3. Please use tls_options instead.'
+        end
+      end
+      @tls_v1 = !!opts[:tls_v1]
+
+      if @tls_options
+        if @tls_v1
+          validate_tls_options!
+        else
+          warn 'tls_options was provided, but tls_v1 is false. Skipping validation of tls_options.'
+        end
+      end
 
       if @msg_timeout < 1000
         raise ArgumentError, 'msg_timeout cannot be less than 1000. it\'s in milliseconds.'
@@ -152,7 +168,7 @@ module Nsq
         heartbeat_interval: 30_000, # 30 seconds
         output_buffer: 16_000, # 16kb
         output_buffer_timeout: 250, # 250ms
-        tls_v1: !!@ssl_context,
+        tls_v1: @tls_v1,
         snappy: false,
         deflate: false,
         sample_rate: 0, # disable sampling
@@ -320,7 +336,7 @@ module Nsq
       # it gets to nsqd ahead of anything in the `@write_queue`
       write_to_socket '  V2'
       identify
-      upgrade_to_ssl_socket if @ssl_context
+      upgrade_to_ssl_socket if @tls_v1
 
       start_read_loop
       start_write_loop
@@ -354,17 +370,20 @@ module Nsq
 
 
     def upgrade_to_ssl_socket
-      @socket = OpenSSL::SSL::SSLSocket.new(@socket, openssl_context)
+      ssl_opts = [@socket, openssl_context].compact
+      @socket = OpenSSL::SSL::SSLSocket.new(*ssl_opts)
       @socket.connect
     end
 
 
     def openssl_context
+      return unless @tls_options
+
       context = OpenSSL::SSL::SSLContext.new
-      context.cert = OpenSSL::X509::Certificate.new(File.open(@ssl_context[:certificate]))
-      context.key = OpenSSL::PKey::RSA.new(File.open(@ssl_context[:key]))
-      if @ssl_context[:ca_certificate]
-        context.ca_file = OpenSSL::X509::Certificate.new(File.open(@ssl_context[:ca_certificate])).to_pem
+      context.cert = OpenSSL::X509::Certificate.new(File.open(@tls_options[:certificate]))
+      context.key = OpenSSL::PKey::RSA.new(File.open(@tls_options[:key]))
+      if @tls_options[:ca_certificate]
+        context.ca_file = OpenSSL::X509::Certificate.new(File.open(@tls_options[:ca_certificate])).to_pem
       end
       context
     end
@@ -422,16 +441,16 @@ module Nsq
     end
 
 
-    def validate_ssl_context!
+    def validate_tls_options!
       [:key, :certificate].each do |key|
-        unless @ssl_context.has_key?(key)
-          raise ArgumentError.new "ssl_context requires a :#{key}"
+        unless @tls_options.has_key?(key)
+          raise ArgumentError.new "@tls_options requires a :#{key}"
         end
       end
 
       [:key, :certificate, :ca_certificate].each do |key|
-        if @ssl_context[key] && !File.readable?(@ssl_context[key])
-          raise LoadError.new "ssl_context :#{key} is unreadable"
+        if @tls_options[key] && !File.readable?(@tls_options[key])
+          raise LoadError.new "@tls_options :#{key} is unreadable"
         end
       end
     end

data/lib/nsq/consumer.rb

@@ -18,6 +18,8 @@ module Nsq
       @discovery_interval = opts[:discovery_interval] || 60
       @msg_timeout = opts[:msg_timeout]
       @ssl_context = opts[:ssl_context]
+      @tls_options = opts[:tls_options]
+      @tls_v1 = opts[:tls_v1]
 
       # This is where we queue up the messages we receive from each connection
       @messages = opts[:queue] || Queue.new

data/lib/nsq/producer.rb

@@ -9,6 +9,8 @@ module Nsq
       @topic = opts[:topic]
       @discovery_interval = opts[:discovery_interval] || 60
       @ssl_context = opts[:ssl_context]
+      @tls_options = opts[:tls_options]
+      @tls_v1 = opts[:tls_v1]
 
       nsqlookupds = []
       if opts[:nsqlookupd]

data/lib/version.rb

@@ -1,7 +1,7 @@
 module Nsq
   module Version
-    MAJOR = 1
-    MINOR = 7
+    MAJOR = 2
+    MINOR = 0
     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.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Wistia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client library for NSQ