logstash-filter-http 1.4.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf9e6e5719322e393443523446a54d9940048cd2dc540d4f71afedf7dd58b1dd
-  data.tar.gz: 72869368a417ccc28e522ab0ef47a3910d3bdb8565a9c215108a3cc3d8f088ca
+  metadata.gz: 115c2c25afb8de24c53df0f55cd72b9a4e02d1fd6536a2eb8e5450c0ba4830df
+  data.tar.gz: 6c2dcab69cdae94dc7c98aeca7ff023451ba681d674b813e575b6f5c68ee8edd
 SHA512:
-  metadata.gz: 2c76225e97cc973becbace99e5f2af1cbbebcdc73d264e735dc6064b5d7d1ecd88a51f0665bed3df2c6571d209c61ffa044be69f009762454713d367f96e653b
-  data.tar.gz: 2cffbf09fc61fd9a0fc7594e7f828497e9c8e098e056053c8791a2d9bb16533cedf2b31f3cf934f1bd5cc40e9d2574f007895a90ff469d962fb4a6d6f19eec52
+  metadata.gz: b4b38e4785d4a4674511d62b62f02caf7f161cb0523d2991aa375066c9c16b0c1323726a691b543dd614d9bcf6eccf291072548bd61617d63b031a59752a138a
+  data.tar.gz: 62b3b7e17e567cb4aefd648bb25629f2c1c1b5c87ba008d4259fdf70078f8e5c2ede799f0c6339f7acb89a9692fff7e7c3c869d87514947ab0ce8ec00c818a1b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+## 1.4.3
+  - DOC: add clarification on sending data as json [#48](https://github.com/logstash-plugins/logstash-filter-http/pull/48)
+
+## 1.4.2
+  - Fix: resolve content type when a content-type header contains an array [#46](https://github.com/logstash-plugins/logstash-filter-http/pull/46)
+
 ## 1.4.1
-  - Fix: don't process response body for HEAD requests [#40](https://github.com/logstash-plugins/logstash-filter-http/pull/40)
+  - Fix: don't process response body for HEAD requests [#41](https://github.com/logstash-plugins/logstash-filter-http/pull/41)
 
 ## 1.4.0
   - Feat: added ssl_supported_protocols option [#38](https://github.com/logstash-plugins/logstash-filter-http/pull/38)

data/lib/logstash/filters/http.rb

@@ -88,11 +88,12 @@ class LogStash::Filters::Http < LogStash::Filters::Base
     elsif !code.between?(200, 299)
       @logger.error('error during HTTP request',
                     :url => url_for_event, :code => code,
+                    :headers => response_headers,
                     :response => response_body)
       @tag_on_request_failure.each { |tag| event.tag(tag) }
     else
       @logger.debug? && @logger.debug('success received',
-                                      :code => code, :body => response_body)
+                                      :code => code, :headers => response_headers, :body => response_body)
       process_response(response_body, response_headers, event)
       filter_matched(event)
     end
@@ -132,10 +133,10 @@ EOF
   end
 
   def process_response(body, headers, event)
-    content_type, _ = headers.fetch("content-type", "").split(";")
     event.set(@target_headers, headers)
     return if @verb == 'head' # Since HEAD requests will not contain body, we need to set only header
-    if content_type == "application/json"
+
+    if headers_has_json_content_type?(headers)
       begin
         parsed = LogStash::Json.load(body)
         event.set(@target_body, parsed)
@@ -152,4 +153,14 @@ EOF
     end
   end
 
+  ##
+  # @param headers [String] or [Array]
+  # @return resolved content-type
+  def headers_has_json_content_type?(headers)
+    # content-type might be an array or string with ; separated
+    headers = headers.fetch("content-type", "")
+    headers = headers.kind_of?(Array) ? headers : headers.split(';')
+    headers.map(&:strip).include?("application/json")
+  end
+
 end # class LogStash::Filters::Rest

data/logstash-filter-http.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-http'
-  s.version = '1.4.1'
+  s.version = '1.4.3'
   s.licenses = ['Apache License (2.0)']
   s.summary = 'This filter requests data from a RESTful Web Service.'
   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 logstash-filter-http. This gem is not a stand-alone program'

data/spec/filters/http_spec.rb

@@ -118,6 +118,7 @@ describe LogStash::Filters::Http do
           'Server' => 'Apache',
           'Last-Modified' => 'Mon, 18 Jul 2016 02:36:04 GMT',
           'X-Backend-Server' => 'logstash.elastic.co',
+          'Content-Type' => %w[application/json application/xml]
       }
       [200, response_headers, "Bom dia"]
     end
@@ -136,10 +137,12 @@ describe LogStash::Filters::Http do
         if ecs_select.active_mode == :disabled
           expect(event.get('headers')).to include "Server" => "Apache"
           expect(event.get('headers')).to include "X-Backend-Server" => "logstash.elastic.co"
+          expect(event.get('headers')).to include "Content-Type" => %w[application/json application/xml]
         else
           expect(event.include?('headers')).to be false
           expect(event.get('[@metadata][filter][http][response][headers]')).to include "Server" => "Apache"
           expect(event.get('[@metadata][filter][http][response][headers]')).to include "X-Backend-Server" => "logstash.elastic.co"
+          expect(event.get('[@metadata][filter][http][response][headers]')).to include "Content-Type" => %w[application/json application/xml]
         end
       end
 
@@ -172,6 +175,46 @@ describe LogStash::Filters::Http do
         subject.filter(event)
       end
     end
+
+    context "content-type header" do
+      let(:config) { super().merge "headers" => headers }
+
+      describe 'when content-type header is an array' do
+        let(:headers) {{ "Content-type" => %w[application/json logstash/custom-media-type] }}
+
+        it "resolves the content-type" do
+          expect(subject).to receive(:request_http) do |verb, url, options|
+            expect( options.fetch(:headers, {}) ).to include(headers)
+          end.and_return(response)
+
+          expect{ subject.filter(event) }.not_to raise_error
+        end
+      end
+
+      describe 'when content-type header is a string' do
+        let(:headers) {{ "Content-type" => "application/json; logstash/custom-media-type" }}
+
+        it "resolves the content-type" do
+          expect(subject).to receive(:request_http) do |verb, url, options|
+            expect( options.fetch(:headers, {}) ).to include(headers)
+          end.and_return(response)
+
+          expect{ subject.filter(event) }.not_to raise_error
+        end
+      end
+
+      describe 'when content-type header is an empty string' do
+        let(:headers) {{ "Content-type" => "" }}
+
+        it "resolves the content-type" do
+          expect(subject).to receive(:request_http) do |verb, url, options|
+            expect( options.fetch(:headers, {}) ).to include(headers)
+          end.and_return(response)
+
+          expect{ subject.filter(event) }.not_to raise_error
+        end
+      end
+    end
   end
 
   describe "query string parameters" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-http
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-04 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement