fastly_nsq 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1980f54ed1aa7fe8ef369d7dfb3f9bf969a7c662
-  data.tar.gz: c8c5e7ffa1cb2131f206842f54b6e8c6f5f7e076
+  metadata.gz: b2f03d7a90d220d61bbbab80806d305f49017361
+  data.tar.gz: fa5f44e2035bd6a9bf655040498bbdeb9b378b37
 SHA512:
-  metadata.gz: c92d2a3dd4f552c2a9bdd27aa78732d35078baab9a2d391836d3c599371b594ff8751b547dd709aa38b45388eba25770a42fe305a6f4d690279ad64274b72e0e
-  data.tar.gz: 33f3cc6eafb6eaec16e48205813cdc60ee99c0149773f2a5637fdadd1001e45c75d76ebb4ab58e4db1380c89638ac33d5a086e0caeb852a98ed37a380ae2a21d
+  metadata.gz: f34fd7c48a23702fb39115295110d3b1a1aab08f882a514cb83ad9eddcfe7a75e2d67f64a5b6414c543bd557e44c113479d64d45b47e7d010747a8559988169f
+  data.tar.gz: 4a68b4cab8892638444669e2ce3c3780b9df7596a0ebd9753df6f4dd1909a33f7b4ba96c90fc0027de3066da937d9b49486bcc12f43956b476d7c18c7ff3d31c

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.8.0 / 2016-11-23
+
+* Upgrade nsq-ruby to version 2.0.3
+* Support passing `verify_mode` in parameters and through ENV
+* Change SSLContext class to be TlsOptions class to match gem needs
+
 ### 0.1.0 / 2016-01-25
 
 * Initial release:

data/fastly_nsq.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rubocop', '~> 0.39.0'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
 
-  gem.add_dependency 'nsq-ruby', '~> 1.6.0', '>= 1.6.0'
+  gem.add_dependency 'nsq-ruby', '~> 2.0', '>= 2.0.3'
 end

data/lib/fastly_nsq.rb

@@ -5,7 +5,7 @@ require 'fastly_nsq/listener'
 require 'fastly_nsq/message'
 require 'fastly_nsq/producer'
 require 'fastly_nsq/strategy'
-require 'fastly_nsq/ssl_context'
+require 'fastly_nsq/tls_options'
 require 'fastly_nsq/version'
 
 module FastlyNsq

data/lib/fastly_nsq/consumer.rb

@@ -8,16 +8,16 @@ module FastlyNsq
     def_delegator :connection, :size
     def_delegator :connection, :terminate
 
-    def initialize(topic:, channel:, ssl_context: nil, connector: nil)
+    def initialize(topic:, channel:, tls_options: nil, connector: nil)
       @topic       = topic
       @channel     = channel
-      @ssl_context = SSLContext.new(ssl_context)
+      @tls_options = TlsOptions.as_hash(tls_options)
       @connector   = connector
     end
 
     private
 
-    attr_reader :channel, :topic, :ssl_context
+    attr_reader :channel, :topic, :tls_options
 
     def connection
       @connection ||= connector.new(params)
@@ -32,8 +32,7 @@ module FastlyNsq
         nsqlookupd: ENV.fetch('NSQLOOKUPD_HTTP_ADDRESS').split(',').map(&:strip),
         topic: topic,
         channel: channel,
-        ssl_context: ssl_context.to_h,
-      }
+      }.merge(tls_options)
     end
   end
 end

data/lib/fastly_nsq/fake_backend.rb

@@ -33,7 +33,7 @@ module FastlyNsq
     end
 
     class Producer
-      def initialize(topic:, nsqd: nil, ssl_context: nil)
+      def initialize(topic:, nsqd: nil, tls_v1: nil, tls_options: nil)
       end
 
       def write(string)
@@ -53,7 +53,7 @@ module FastlyNsq
     end
 
     class Consumer
-      def initialize(nsqlookupd: nil, topic:, channel:, ssl_context: nil)
+      def initialize(nsqlookupd: nil, topic:, channel:, tls_v1: nil, tls_options: nil)
       end
 
       def pop(delay = FakeBackend.delay)

data/lib/fastly_nsq/producer.rb

@@ -6,15 +6,15 @@ module FastlyNsq
     def_delegator :connection, :terminate
     def_delegator :connection, :write
 
-    def initialize(topic:, ssl_context: nil, connector: nil)
+    def initialize(topic:, tls_options: nil, connector: nil)
       @topic       = topic
-      @ssl_context = SSLContext.new(ssl_context)
+      @tls_options = TlsOptions.as_hash(tls_options)
       @connector   = connector
     end
 
     private
 
-    attr_reader :topic, :ssl_context
+    attr_reader :topic, :tls_options
 
     def connection
       @connection ||= connector.new(params)
@@ -28,8 +28,7 @@ module FastlyNsq
       {
         nsqd:        ENV.fetch('NSQD_TCP_ADDRESS'),
         topic:       topic,
-        ssl_context: ssl_context.to_h,
-      }
+      }.merge(tls_options)
     end
   end
 end

data/lib/fastly_nsq/{ssl_context.rb → tls_options.rb}

@@ -1,15 +1,22 @@
 module FastlyNsq
-  class SSLContext
+  class TlsOptions
+    def self.as_hash(context = nil)
+      new(context).to_h
+    end
+
     def initialize(context = nil)
       @context = context || {}
     end
 
     def to_h
       merge_contexts
-      if empty_context?
-        nil
+      if @context.empty?
+        {}
       else
-        @context
+        {
+          tls_v1: true,
+          tls_options: @context,
+        }
       end
     end
 
@@ -27,20 +34,21 @@ module FastlyNsq
       ENV.fetch('NSQ_SSL_CA_CERTIFICATE', nil)
     end
 
+    def verify_mode
+      ENV.fetch('NSQ_SSL_VERIFY_MODE', nil)
+    end
+
     def env_default_hash
       {
         key: env_key,
         certificate: env_certificate,
         ca_certificate: env_ca_certificate,
+        verify_mode: verify_mode,
       }
     end
 
     def merge_contexts
-      @context = env_default_hash.merge(@context)
-    end
-
-    def empty_context?
-      @context.all? { |_key, value| value.nil? }
+      @context = env_default_hash.merge(@context).delete_if { |_, v| v.nil? }
     end
   end
 end

data/lib/fastly_nsq/version.rb

@@ -1,3 +1,3 @@
 module FastlyNsq
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.8.0'.freeze
 end

data/spec/lib/fastly_nsq/tls_options_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+RSpec.describe FastlyNsq::TlsOptions do
+  describe 'when SSL ENV variables are not set' do
+    describe '.to_h' do
+      it 'returns nil when initialized without parameters' do
+        context = FastlyNsq::TlsOptions.new
+
+        expect(context.to_h).to eq({})
+      end
+
+      it 'returns an equivalent hash when all variables are defined' do
+        tls_options_hash = {
+          key: 'key',
+          certificate: 'certificate',
+          ca_certificate: 'ca_certificate',
+        }
+        context = FastlyNsq::TlsOptions.new(tls_options_hash)
+
+        expected_output = {
+          tls_v1: true,
+          tls_options: {
+            key: 'key',
+            certificate: 'certificate',
+            ca_certificate: 'ca_certificate',
+          },
+        }
+        expect(context.to_h).to eq(expected_output)
+      end
+
+      it 'does not add keys with nil values' do
+        tls_options_hash = {
+          key: 'key',
+          certificate: 'certificate',
+        }
+        context = FastlyNsq::TlsOptions.new(tls_options_hash)
+        ca_certificate = context.to_h[:ca_certificate]
+
+        expect(ca_certificate).to be_nil
+      end
+    end
+  end
+
+  describe 'when SSL ENV variables are set' do
+    before do
+      ENV['NSQ_SSL_KEY'] = '/some/key'
+      ENV['NSQ_SSL_CERTIFICATE'] = '/some/certificate'
+      ENV['NSQ_SSL_CA_CERTIFICATE'] = '/some/ca_certificate'
+      ENV['NSQ_SSL_VERIFY_MODE'] = 'value'
+    end
+
+    after do
+      ENV['NSQ_SSL_KEY'] = nil
+      ENV['NSQ_SSL_CERTIFICATE'] = nil
+      ENV['NSQ_SSL_CA_CERTIFICATE'] = nil
+      ENV['NSQ_SSL_VERIFY_MODE'] = nil
+    end
+
+    describe '.to_h' do
+      it 'returns a hash of the env variables when no parameters are passed' do
+        expected_hash = {
+          tls_v1: true,
+          tls_options: {
+            key: ENV['NSQ_SSL_KEY'],
+            certificate: ENV['NSQ_SSL_CERTIFICATE'],
+            ca_certificate: ENV['NSQ_SSL_CA_CERTIFICATE'],
+            verify_mode: ENV['NSQ_SSL_VERIFY_MODE'],
+          },
+        }
+        context = FastlyNsq::TlsOptions.new
+
+        expect(context.to_h).to eq(expected_hash)
+      end
+
+      it 'merges passed parameters and env variables' do
+        passed_certificate = '/passed/certificate'
+        expected_hash = {
+          tls_v1: true,
+          tls_options: {
+            key: ENV['NSQ_SSL_KEY'],
+            certificate: passed_certificate,
+            ca_certificate: ENV['NSQ_SSL_CA_CERTIFICATE'],
+            verify_mode: ENV['NSQ_SSL_VERIFY_MODE'],
+          },
+        }
+        context = FastlyNsq::TlsOptions.new(certificate: passed_certificate)
+
+        expect(context.to_h).to eq(expected_hash)
+      end
+
+      it 'removes keys that are nil' do
+        expected_hash = {
+          tls_v1: true,
+          tls_options: {
+            ca_certificate: ENV['NSQ_SSL_CA_CERTIFICATE'],
+            verify_mode: ENV['NSQ_SSL_VERIFY_MODE'],
+          },
+        }
+        context = FastlyNsq::TlsOptions.new(key: nil, certificate: nil)
+
+        expect(context.to_h).to eq(expected_hash)
+      end
+    end
+  end
+
+  describe 'as_hash' do
+    it 'returns an tls_options hash' do
+      expected_hash = {
+        tls_v1: true,
+        tls_options: {
+          key: 'joe',
+          certificate: 'biden',
+        },
+      }
+      output_hash = FastlyNsq::TlsOptions.as_hash(key: 'joe', certificate: 'biden')
+      expect(output_hash).to eq(expected_hash)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastly_nsq
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Tommy O'Neil
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-26 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -157,20 +157,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.0.3
 description: Helper classes for Fastly's NSQ Services
 email: tommy@fastly.com
 executables: []
@@ -201,8 +201,8 @@ files:
 - lib/fastly_nsq/message.rb
 - lib/fastly_nsq/producer.rb
 - lib/fastly_nsq/rake_task.rb
-- lib/fastly_nsq/ssl_context.rb
 - lib/fastly_nsq/strategy.rb
+- lib/fastly_nsq/tls_options.rb
 - lib/fastly_nsq/version.rb
 - spec/lib/fastly_nsq/consumer_spec.rb
 - spec/lib/fastly_nsq/fake_backend_spec.rb
@@ -211,8 +211,8 @@ files:
 - spec/lib/fastly_nsq/message_spec.rb
 - spec/lib/fastly_nsq/producer_spec.rb
 - spec/lib/fastly_nsq/rake_task_spec.rb
-- spec/lib/fastly_nsq/ssl_context_spec.rb
 - spec/lib/fastly_nsq/strategy_spec.rb
+- spec/lib/fastly_nsq/tls_options_spec.rb
 - spec/lib/fastly_nsq_spec.rb
 - spec/spec_helper.rb
 - spec/support/env_helpers.rb

data/spec/lib/fastly_nsq/ssl_context_spec.rb

@@ -1,74 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe FastlyNsq::SSLContext do
-  describe 'when SSL ENV variables are not set' do
-    describe '.to_h' do
-      it 'returns nil when initialized without parameters' do
-        context = FastlyNsq::SSLContext.new
-
-        expect(context.to_h).to be_nil
-      end
-
-      it 'returns an equivalent hash when all variables are defined' do
-        ssl_context_hash = {
-          key: 'key',
-          certificate: 'certificate',
-          ca_certificate: 'ca_certificate',
-        }
-        context = FastlyNsq::SSLContext.new(ssl_context_hash)
-
-        expect(context.to_h).to eq(ssl_context_hash)
-      end
-
-      it 'does not add keys with nil values' do
-        ssl_context_hash = {
-          key: 'key',
-          certificate: 'certificate',
-        }
-        context = FastlyNsq::SSLContext.new(ssl_context_hash)
-        ca_certificate = context.to_h[:ca_certificate]
-
-        expect(ca_certificate).to be_nil
-      end
-    end
-  end
-
-  describe 'when SSL ENV variables are set' do
-    before do
-      ENV['NSQ_SSL_KEY'] = '/some/key'
-      ENV['NSQ_SSL_CERTIFICATE'] = '/some/certificate'
-      ENV['NSQ_SSL_CA_CERTIFICATE'] = '/some/ca_certificate'
-    end
-
-    after do
-      ENV['NSQ_SSL_KEY'] = nil
-      ENV['NSQ_SSL_CERTIFICATE'] = nil
-      ENV['NSQ_SSL_CA_CERTIFICATE'] = nil
-    end
-
-    describe '.to_h' do
-      it 'returns a hash of the env variables when no parameters are passed' do
-        expected_hash = {
-          key: ENV['NSQ_SSL_KEY'],
-          certificate: ENV['NSQ_SSL_CERTIFICATE'],
-          ca_certificate: ENV['NSQ_SSL_CA_CERTIFICATE'],
-        }
-        context = FastlyNsq::SSLContext.new
-
-        expect(context.to_h).to eq(expected_hash)
-      end
-
-      it 'merges passed parameters and env variables' do
-        passed_certificate = '/passed/certificate'
-        expected_hash = {
-          key: ENV['NSQ_SSL_KEY'],
-          certificate: passed_certificate,
-          ca_certificate: ENV['NSQ_SSL_CA_CERTIFICATE'],
-        }
-        context = FastlyNsq::SSLContext.new(certificate: passed_certificate)
-
-        expect(context.to_h).to eq(expected_hash)
-      end
-    end
-  end
-end