logstash-mixin-http_client 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3be85aa47707c0efff5108ef847692de49ff1c2b
-  data.tar.gz: 84c250cb85d7af53eff7c3e98c68ed0583b4e4be
+  metadata.gz: 866041325df6f6f569b40e8a0c44464f5d543c04
+  data.tar.gz: c911cdde46a537e2a87061b1439f357b01767fef
 SHA512:
-  metadata.gz: ad251e9bd636dda5e6f6914967a2f965d183cb5aca111428d0cc6c5e3319e3a7d1fcbb4558ec687034a44fe7aa132dab2f8442babf740252a742a83b835727a9
-  data.tar.gz: bb7c09d980bdf6dca16a3527184f679784aa6481099d9ff5ccce4f2d2a66de620636765e2222d3d8ae6a5cc3ce8b0d2358a4a12ff99876d5ae1da46ebacfed84
+  metadata.gz: d0f2a27414856acd2f5235ff7b9765baa5b2a8641f23f133c15fde9dc5b89d216e70bf3d0b65b043caccaefafffd25c452cf877688621cc9e252933f8f359754
+  data.tar.gz: 8f9e2b21bd8545a5723c4a0c57b3d13716dfec47457dfb81bb81581a520a3f309a5afa6083ed1d7148a48d88752a91dd4a4b96aa7fecbb230ab2266543ae023b

data/README.md

@@ -1,4 +1,6 @@
-# Usage
+# Easily Add an HTTP Client to your Logstash Plugin!
+
+HTTP clients have a lot of configurable options (proxies, certificates, headers, etc.), and specifying all of these with proper validation for a logstash plugin can be irritating. We built this plugin while building our [HTTP Poller Input](https://github.com/logstash-plugins/logstash-input-http_poller). If you need to build a plugin that works primarily based around HTTP this mixin makes it easy and consistent! It is based on [Manticore](https://github.com/cheald/manticore) a lightning quick, fully featured JRuby HTTP client based on Apache Commons HTTP Client.`
 
 This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
 
@@ -8,7 +10,7 @@ This plugin exposes the following options:
 
 ```ruby
 # Timeout (in seconds) for the entire request
-request_timeout, :validate => :number, :default => 60
+config :request_timeout, :validate => :number, :default => 60
 
 # Timeout (in seconds) to wait for data on the socket. Default is 10s
 config :socket_timeout, :validate => :number, :default => 10
@@ -25,6 +27,9 @@ config :pool_max, :validate => :number, :default => 50
 # Max number of concurrent connections to a single host. Defaults to 25
 config :pool_max_per_route, :validate => :number, :default => 25
 
+# Enable HTTP keepalive support, enabled by default
+config :keepalive, :validate => :boolean, :default => true
+
 # How many times should the client retry a failing URL? Default is 3
 config :automatic_retries, :validate => :number, :default => 3
 
@@ -36,7 +41,10 @@ config :truststore_path, :validate => :path
 
 # Specify the keystore password here.
 # Note, most .jks files created with keytool require a password!
-config :truststore_password, :validate => :string
+config :truststore_password, :validate => :password
+
+# Specify the keystore type here. One of "JKS" or "PKCS12". Default is "JKS"
+config :truststore_type, :validate => :string, :default => "JKS"
 
 # Enable cookie support. With this enabled the client will persist cookies
 # across requests as a normal web browser would. Enabled by default
@@ -47,6 +55,11 @@ config :cookies, :validate => :boolean, :default => true
 # 2. Proxy host in form: {host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
 # 3. Proxy host in form: {url =>  'http://proxy.org:1234', user => 'username@host', password => 'password'}
 config :proxy
+
+# If you'd like to use a client certificate (note, most people don't want this) set the path to the x509 cert here
+config :client_cert, :validate => :path
+# If you'd like to use a client certificate (note, most people don't want this) set the path to the x509 key here
+config :client_key, :validate => :path
 ```
 
 ## Documentation

data/lib/logstash/plugin_mixins/http_client.rb

@@ -1,10 +1,12 @@
 # encoding: utf-8
 require "logstash/config/mixin"
 
-# This module provides helper for the `AWS-SDK` v1,
-# and it will be deprecated in the near future, please use the V2 module
-# for any new development.
+# This module makes it easy to add a very fully configured HTTP client to logstash
+# based on [Manticore](https://github.com/cheald/manticore).
+# For an example of its usage see https://github.com/logstash-plugins/logstash-input-http_poller
 module LogStash::PluginMixins::HttpClient
+  class InvalidHTTPConfigError < StandardError; end
+
   def self.included(base)
     require 'manticore'
     base.extend(self)
@@ -31,6 +33,9 @@ module LogStash::PluginMixins::HttpClient
     # Max number of concurrent connections to a single host. Defaults to 25
     config :pool_max_per_route, :validate => :number, :default => 25
 
+    # Turn this on to enable HTTP keepalive support
+    config :keepalive, :validate => :boolean, :default => true
+
     # How many times should the client retry a failing URL? Default is 3
     config :automatic_retries, :validate => :number, :default => 3
 
@@ -42,7 +47,10 @@ module LogStash::PluginMixins::HttpClient
 
     # Specify the keystore password here.
     # Note, most .jks files created with keytool require a password!
-    config :truststore_password, :validate => :string
+    config :truststore_password, :validate => :password
+
+    # Specify the keystore type here. One of "JKS" or "PKCS12". Default is "JKS"
+    config :truststore_type, :validate => :string, :default => "JKS"
 
     # Enable cookie support. With this enabled the client will persist cookies
     # across requests as a normal web browser would. Enabled by default
@@ -53,6 +61,11 @@ module LogStash::PluginMixins::HttpClient
     # 2. Proxy host in form: {host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
     # 3. Proxy host in form: {url =>  'http://proxy.org:1234', user => 'username@host', password => 'password'}
     config :proxy
+
+    # If you'd like to use a client certificate (note, most people don't want this) set the path to the x509 cert here
+    config :client_cert, :validate => :path
+    # If you're using a client certificate specify the path to the encryption key here
+    config :client_key, :validate => :path
   end
 
   public
@@ -66,6 +79,7 @@ module LogStash::PluginMixins::HttpClient
       pool_max: @pool_max,
       pool_max_per_route: @pool_max_per_route,
       cookies: @cookies,
+      keepalive: @keepalive
     }
 
     if @proxy
@@ -81,14 +95,21 @@ module LogStash::PluginMixins::HttpClient
     end
     if (@truststore_path)
       c[:ssl].merge!(
-        truststore: @truststore_path
+        :truststore => @truststore_path,
+        :truststore_type => @truststore_type
       )
 
       # JKS files have optional passwords if programatically created
       if (@truststore_password)
-        c[:ssl].merge!(truststore_password: @truststore_password)
+        c[:ssl].merge!(truststore_password: @truststore_password.value)
       end
     end
+    if @client_cert && @client_key
+      c[:ssl][:client_cert] = @client_cert
+      c[:ssl][:client_key] = @client_key
+    elsif !!@client_cert ^ !!@client_key
+      raise InvalidHTTPConfigError, "You must specify both client_cert and client_key for an HTTP client, or neither!"
+    end
 
     c
   end

data/logstash-mixin-http_client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-mixin-http_client'
-  s.version         = '0.0.1'
+  s.version         = '1.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "AWS mixins to provide a unified interface for Amazon Webservice"
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"

data/spec/plugin_mixin/http_client_spec.rb

@@ -9,7 +9,7 @@ end
 
 describe LogStash::PluginMixins::HttpClient do
   let(:basic_config) { {} }
-  let(:impl) { Dummy.new(basic_config)  }
+  let(:impl) { Dummy.new(basic_config) }
 
   it "should initialize with no extra settings" do
     expect {
@@ -22,15 +22,15 @@ describe LogStash::PluginMixins::HttpClient do
   end
 
   it "#client should return the client" do
-    expect(impl.client).to be_a(Manticore::Client)
+    expect(impl.send(:client)).to be_a(Manticore::Client)
   end
 
   it "#client should return the same client" do
-    expect(impl.client).to eql(impl.client)
+    expect(impl.send(:client)).to eql(impl.client)
   end
 
   shared_examples "setting ca bundles" do |key|
-    subject { Dummy.new(conf).client_config }
+    subject { Dummy.new(conf).send(:client_config) }
 
     it "should correctly set the path" do
       expect(subject[:ssl][key]).to eql(path)
@@ -54,4 +54,41 @@ describe LogStash::PluginMixins::HttpClient do
       include_examples("setting ca bundles", :truststore)
     end
   end
+
+  describe "with a client cert" do
+    let(:file) { Stud::Temporary.file }
+    let(:path) { file.path }
+    after { File.unlink(path)}
+
+    context "with correct client certs" do
+      let(:conf) { basic_config.merge("client_cert" => path, "client_key" => path) }
+
+      it "should create without error" do
+        expect {
+          Dummy.new(conf).client_config
+        }.not_to raise_error
+      end
+    end
+
+    shared_examples("raising a configuration error") do
+      it "should raise an error error" do
+        expect {
+          Dummy.new(conf).client_config
+        }.to raise_error(LogStash::PluginMixins::HttpClient::InvalidHTTPConfigError)
+      end
+    end
+
+    context "without a key" do
+      let(:conf) { basic_config.merge("client_cert" => path) }
+
+      include_examples("raising a configuration error")
+    end
+
+    context "without a cert" do
+      let(:conf) { basic_config.merge("client_key" => path) }
+
+      include_examples("raising a configuration error")
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-mixin-http_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core