logstash-mixin-zeromq 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 581a303492a25d46f0bd462e8cddf2464d2cea18
+  data.tar.gz: 460addf350a60201f1230e14c9450fcca928fb2f
+SHA512:
+  metadata.gz: 01251b1a3cf3e13d59939e2f3bbe79b8139177c92777664845dd18e73747d588cece9c2402492864f7c16e4f9ad6c2a1674c9e8e83c166122e3d6528ee47953a
+  data.tar.gz: 4cfd55e56dc3623912e5ddb5502159553e7b79347f1ecab4b86e57beefad84d14c1a342263299b0606996e9d0648e6f841d11fd5ab041e04c00d2d463f045e74

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 2.0.0
+ - Initial release, mixin functions moved from logstash-output-zeromq, logstash-input-zeromq and logstash-filter-zeromq

data/CONTRIBUTORS

@@ -0,0 +1,16 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Jordan Sissel (jordansissel)
+* Richard Pijnenburg (electrical)
+* Lucas Bremgartner (breml)
+* Pere Urbón (purbon)
+* Colin Surprenant (colinsurprenant)
+* Brice Figureau (masterzen)
+* John E. Vincent (lusis)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,7 @@
+# logstash-mixin-zeromq
+
+[![Build Status](https://travis-ci.org/logstash-plugins/logstash-mixin-zeromq.svg?branch=master)](https://travis-ci.org/logstash-plugins/logstash-mixin-zeromq)
+
+This is a mixin library to share code for zeromq input, output and filter Logstash plugins.
+
+This code is designed internal use by Logstash plugins.

data/lib/logstash/plugin_mixins/zeromq.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'ffi-rzmq'
+require "logstash/namespace"
+
+module LogStash::PluginMixins::ZeroMQ
+  # LOGSTASH-400
+  # see https://github.com/chuckremes/ffi-rzmq/blob/master/lib/ffi-rzmq/socket.rb#L93-117
+  STRING_OPTS = %w{IDENTITY SUBSCRIBE UNSUBSCRIBE}
+
+  def context
+    @context ||= ZMQ::Context.new
+  end
+
+  def setup(socket, address)
+    if server?
+      error_check(socket.bind(address), "binding to #{address}")
+    else
+      error_check(socket.connect(address), "connecting to #{address}")
+    end
+    @logger.info("0mq: #{server? ? 'connected' : 'bound'}", :address => address)
+  end
+
+  def error_check(rc, doing)
+    unless ZMQ::Util.resultcode_ok?(rc)
+      @logger.error("ZeroMQ error while #{doing}", { :error_code => rc })
+      raise "ZeroMQ Error while #{doing}"
+    end
+  end # def error_check
+
+  def setopts(socket, options)
+    options.each do |opt,value|
+      sockopt = opt.split('::')[1]
+      option = ZMQ.const_defined?(sockopt) ? ZMQ.const_get(sockopt) : ZMQ.const_missing(sockopt)
+      unless STRING_OPTS.include?(sockopt)
+        begin
+          Float(value)
+          value = value.to_i
+        rescue ArgumentError
+          raise "#{sockopt} requires a numeric value. #{value} is not numeric"
+        end
+      end # end unless
+      error_check(socket.setsockopt(option, value),
+              "while setting #{opt} == #{value}")
+    end # end each
+  end # end setopts
+end # module LogStash::PluginMixins::ZeroMQ

data/logstash-util-zeromq.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-mixin-zeromq'
+  s.version         = '2.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Mixin to share code for zeromq input, output and filter"
+  s.description     = "This gem contains mixin functions, used by 0MQ logstash plugins. This gem is not a stand-alone program"
+  s.authors         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths   = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
+
+  s.add_runtime_dependency 'ffi-rzmq', '~> 2.0.4'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-codec-plain'
+end

data/spec/plugin_mixins/zeromq_spec.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require 'logstash/plugin_mixins/zeromq'
+
+class Dummy < LogStash::Inputs::Base
+  attr_accessor :mode
+
+  include LogStash::PluginMixins::ZeroMQ
+  def server?
+    @mode == "server"
+  end
+end
+
+describe LogStash::PluginMixins::ZeroMQ do
+  let(:basic_config) { {} }
+  let(:impl) {
+    d = Dummy.new(basic_config)
+    d.mode = "server"
+    d
+  }
+
+  it "should initialize with no extra settings" do
+    expect {
+      impl
+    }.not_to raise_error
+  end
+
+  it "should return a ZMQ context" do
+    expect(impl.context).to be_a ZMQ::Context
+  end
+
+  context "when setup" do
+    let(:socket) { context = ZMQ::Context.new; context.socket(ZMQ::REQ) }
+    let(:port) { rand(1000)+1025 }
+    after do
+      socket.close
+    end
+
+    context "a server" do
+      it "should setup a server, bind to address without error" do
+        expect { impl.setup(socket, "tcp://127.0.0.1:#{port}") }.to_not raise_error
+      end
+    end
+
+    context "a client" do
+      let(:impl_client) { 
+        d = Dummy.new(basic_config)
+        d.mode = "client"
+        d 
+      }
+
+      it "should setup a client, connecting to address without error" do
+        expect { impl_client.setup(socket, "tcp://127.0.0.1:#{port}") }.to_not raise_error
+      end
+    end
+  end
+
+  context "when error_check" do
+    it "should not raise an error for return code 0 or greater" do
+      expect { impl.error_check(0, "test return values" ) }.to_not raise_error
+      expect { impl.error_check(1, "test return values" ) }.to_not raise_error
+    end
+    it "should raise an error for return code below 0" do
+      expect { impl.error_check(-1, "test return values" ) }.to raise_error
+      expect { impl.error_check(-999, "test return values" ) }.to raise_error
+    end
+  end
+
+  context "when socketopts" do
+    let(:socket) { context = ZMQ::Context.new; context.socket(ZMQ::REQ) }
+    after do
+      socket.close
+    end
+
+    it "should set SNDHWM to numeric value without error" do
+      expect { impl.setopts(socket, { "ZMQ::SNDHWM" => "50" } ) }.to_not raise_error
+    end
+    it "should raise an error if set SNDHWM to a non numeric value" do
+      expect { impl.setopts(socket, { "ZMQ::SNDHWM" => "foo" } ) }.to raise_error
+    end
+    it "should raise an error for unknown ZMQ option" do
+      expect { impl.setopts(socket, { "ZMQ::UNKNOWNOPT" => "foo" } ) }.to raise_error
+    end
+    it "should set IDENTITY to string value without error" do
+      expect { impl.setopts(socket, { "ZMQ::IDENTITY" => "my_named_queue" } ) }.to_not raise_error
+    end
+    it "should raise an error for a wrong formated ZMQ option" do
+      expect { impl.setopts(socket, { "ZMQ..SNDHWM" => "50" } ) }.to raise_error
+    end
+    it "should set multiple options" do
+      expect { impl.setopts(socket, { "ZMQ::SNDHWM" => "50", "ZMQ::SNDBUF" => "50" } ) }.to_not raise_error
+    end
+
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: logstash-mixin-zeromq
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  name: ffi-rzmq
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem contains mixin functions, used by 0MQ logstash plugins. This gem is not a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/plugin_mixins/zeromq.rb
+- logstash-util-zeromq.gemspec
+- spec/plugin_mixins/zeromq_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Mixin to share code for zeromq input, output and filter
+test_files:
+- spec/plugin_mixins/zeromq_spec.rb