logstash-filter-xml 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6219dbfef9c7bd16f8407575325b90a2348c8003a3b1b131e9ef659fdf559cf8
-  data.tar.gz: d24834789afc1f58c9f12c4e37f7c792308ec8bf781ac8bf30f5abfb85f97e91
+  metadata.gz: 41486355fca6576c993aabd98476dd39888ba6467b8f91f3a4e76d3d45da06b0
+  data.tar.gz: 13ea42b6f0b45fcf03051b468965b342e6d02b72c5ee41a8bb5ae08423dfe714
 SHA512:
-  metadata.gz: f91a615ab60c1910cab4752ef8f2dc37a1dfa7f3fb364f837c39bd271d5131541d608cbfe9cdf2d32a8369efa2dc6bfc76a1720dc5426cee3b42bc2d3c09fa34
-  data.tar.gz: 50372739d44fffeef3df70ce87eb973b40cc0b903c658b067aea48adc61b5937345b73cf21c4f241c17ae5cc7d901b455fcb053ee65f2eb242cfdaca24cad4e1
+  metadata.gz: 938a1e47c3739672583e4cad10c6083a092335bb3191a6479b4da757d14d9dca02542446f1bb2db3d87cbf77860f2cb7e9b1759a4fad5b82baaaf73cd6c83902
+  data.tar.gz: 67e01e1ce39cd128bad8f1450d542f8c5ecf79ad3268675fb01f415d26c196f0b3ff7b71ac880ba248474b6be8a82310fe24aa76d1f3dbcdcf404767be20c839

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 4.2.0
+  - Update Nokogiri dependency version [#78](https://github.com/logstash-plugins/logstash-filter-xml/pull/78)
+
+## 4.1.3
+  - [DOC] Updated URL for current xsl reference docs [#70](https://github.com/logstash-plugins/logstash-filter-xml/pull/70)
+  - [DOC] Added info about non valid characters [#72](https://github.com/logstash-plugins/logstash-filter-xml/pull/72)  
+
+## 4.1.2
+  - [DOC] Updated docs to correct name of parse_options config option [#75](https://github.com/logstash-plugins/logstash-filter-xml/pull/75)
+
 ## 4.1.1
   - Fix: exceptions thrown while handling events no longer crash the pipeline [#73](https://github.com/logstash-plugins/logstash-filter-xml/pull/73)
 

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-xml.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-xml)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-xml.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-xml)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -34,7 +34,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-force_array>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-force_content>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-namespaces>> |<<hash,hash>>|No
-| <<plugins-{type}s-{plugin}-parser_options>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-parse_options>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-remove_namespaces>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-source>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-store_xml>> |<<boolean,boolean>>|No
@@ -88,17 +88,29 @@ filter {
   }
 }
 
-[id="plugins-{type}s-{plugin}-parser_options"]
-===== `parser_options`
+[id="plugins-{type}s-{plugin}-parse_options"]
+===== `parse_options`
 
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-Setting XML parser options allows for more control of the parsing process.
+Setting XML parse options allows for more control of the parsing process.
 By default the parser is not strict and thus accepts some invalid content.
 Currently supported options are:
 
  - `strict` - forces the parser to fail early instead of accumulating errors when content is not valid xml.
+ 
+Control characters such as ASCII 0x0 are not allowed and _always_ result in non-valid XML.
+
+When XML content is not valid, it will be tagged as `_xmlparsefailure`.
+
+XML specs:
+
+* XML 1.0 Spec: https://www.w3.org/TR/2008/REC-xml-20081126/#charsets
+* XML 1.1 Spec: https://www.w3.org/TR/xml11/#charsets
+
+
+ 
 
 [id="plugins-{type}s-{plugin}-remove_namespaces"]
 ===== `remove_namespaces` 
@@ -187,10 +199,12 @@ destination field. Multiple values returned will be pushed onto the
 destination field as an array. As such, multiple matches across
 multiple source fields will produce duplicate entries in the field.
 
-More on XPath: http://www.w3schools.com/xml/xml_xpath.asp
+[id="plugins-{type}s-{plugin}-xpath_resources"]
+====== Additional XPath resources
+
+For more information on XPath, see https://www.w3schools.com/xml/xml_xpath.asp.
 
-The XPath functions are particularly powerful:
-http://www.w3schools.com/xsl/xsl_functions.asp
+The https://www.w3schools.com/xml/xsl_functions.asp[XPath functions] are particularly powerful. 
 
 
 

data/lib/logstash/filters/xml.rb

@@ -51,10 +51,10 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
   # destination field as an array. As such, multiple matches across
   # multiple source fields will produce duplicate entries in the field.
   #
-  # More on XPath: http://www.w3schools.com/xml/xml_xpath.asp
+  # More on XPath: https://www.w3schools.com/xml/xml_xpath.asp
   #
   # The XPath functions are particularly powerful:
-  # http://www.w3schools.com/xsl/xsl_functions.asp
+  # https://www.w3schools.com/xml/xsl_functions.asp
   #
   config :xpath, :validate => :hash, :default => {}
 

data/logstash-filter-xml.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-xml'
-  s.version         = '4.1.1'
+  s.version         = '4.2.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parses XML into fields"
   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"
@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
+  s.add_runtime_dependency 'logstash-core', '>= 8.4.0' # this provides Ruby 2.6.0
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
-  s.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'nokogiri', '>= 1.13.8' # >= 1.13.0 requires Ruby 2.6+
   s.add_runtime_dependency 'xml-simple'
 
   s.add_development_dependency 'logstash-devutils'

data/spec/filters/xml_spec.rb

@@ -436,7 +436,7 @@ describe LogStash::Filters::Xml do
     end
 
     context 'strict option' do
-      let(:options) { super.merge({ 'parse_options' => 'strict' }) }
+      let(:options) { super().merge({ 'parse_options' => 'strict' }) }
 
       it 'does fail parsing' do
         subject.filter(event)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-xml
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.4.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.4.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -35,7 +49,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.8
   name: nokogiri
   prerelease: false
   type: :runtime
@@ -43,7 +57,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.8
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -125,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.2.29
 signing_key:
 specification_version: 4
 summary: Parses XML into fields