logstash-mixin-http_client 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3407598b8fe0c863cdf83991df712acadb5156d2
-  data.tar.gz: 597f3f3b3dfd3da2db551b4071c429c44fc1b4a0
+  metadata.gz: accbc8d73a9e83d972f9e0a8fb4e559af7190943
+  data.tar.gz: 81084e1fa78f82fcd72572bdb0c94f03a3ee3e36
 SHA512:
-  metadata.gz: c6d5cafaeb158d80ec39b621127676eeee1dfbb2494835ec59e7e98f4c7f3735023d7b8ba0086fc9376279b996195f5452fac13c03eb9c33d94c1450e917df0a
-  data.tar.gz: 1d511a3e32b178592bb27772f4de3edae4638911f2a61cf0e9da995f5bec5ded738ad728c599062ce6201d7dcf7155a3fd1c0799ad88d42843aa1ff96077ae24
+  metadata.gz: e1be836f270f3e1023645a22f5f6bbcd7c3c854c440492315a0ae5501087e41dc6b4b0a37c37f040fff1b7beddbad353b0931da81e1d23530e2654c577aaac6d
+  data.tar.gz: d64fb9c5ab678cb1411584ad0382a2277b94a28883114f251f20752f0ad37500b79444670b663b99eb5975795145ce2962c8f4c11b65c4e159868e7928b6770d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 5.1.0
+  - Add user / password options for HTTP auth
+
 ## 5.0.0
   - Obsolete ssl_certificate_verify option that didn't actually work
 

data/README.md

@@ -64,6 +64,13 @@ config :proxy
 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
+
+# If you'd like to use authentication. Options available include:
+#
+# user     - username to be used
+# password - password to be used
+# eager    - eagerly offer the Authorization header before the server challenges for it
+config :auth
 ```
 
 ## Documentation

data/lib/logstash/plugin_mixins/http_client.rb

@@ -92,6 +92,12 @@ 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
+
+    # Username to use for HTTP auth.
+    config :user, :validate => :string
+
+    # Password to use for HTTP auth
+    config :password, :validate => :password
   end
 
   public
@@ -117,6 +123,19 @@ module LogStash::PluginMixins::HttpClient
         @proxy
     end
 
+    if @user
+      if !@password || !@password.value
+        raise ::LogStash::ConfigurationError, "User '#{@user}' specified without password!"
+      end
+
+      # Symbolize keys if necessary
+      c[:auth] = {
+        :user => @user,
+        :password => @password.value,
+        :eager => true
+      }
+    end
+
     c[:ssl] = {}
     if @cacert
       c[:ssl][:ca_file] = @cacert

data/logstash-mixin-http_client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-mixin-http_client'
-  s.version         = '5.0.0'
+  s.version         = '5.1.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/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/plugin_mixin/http_client_spec.rb

@@ -85,6 +85,42 @@ describe LogStash::PluginMixins::HttpClient do
     end
   end
 
+describe "http auth" do
+    subject { Dummy.new(client_config).send(:client_config)[:auth] }
+
+    let(:user) { "myuser" }
+    let(:password) { "mypassword" }
+    let(:client_config) { basic_config.merge("user" => user, "password" => password )}
+
+    it "should set the user correctly in the auth settings" do
+      expect(subject[:user]).to eq(user)
+    end
+
+    it "should set the password correctly in the auth settings" do
+      expect(subject[:password]).to eq(password)
+    end
+
+    it "should always enable eager auth" do
+      expect(subject[:eager]).to eq(true)
+    end
+
+    context "with no user or password" do
+      let(:client_config) { basic_config }
+
+      it "should not set the auth parameter" do
+        expect(subject).to be_nil
+      end
+    end
+
+    context "with a user but no password specified" do
+      let(:client_config) { c = super; c.delete("password"); c }
+
+      it "should raise a configuration error" do
+        expect { subject }.to raise_error(::LogStash::ConfigurationError)
+      end
+    end
+  end
+
   ["keystore", "truststore"].each do |store|
     describe "with a custom #{store}" do
       let(:file) { Stud::Temporary.file }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-mixin-http_client
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement