logstash-filter-xml 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa0cd358f103b421ffb2039b0b1bb72ba3c79caf
-  data.tar.gz: 8735d06b2b5da663cf0f011b0b9eef52bb19a480
+  metadata.gz: 0bbe7a26079ee72f9c7ff4a22f793757f798d664
+  data.tar.gz: 463335a351bae555a468961e02f8bd2e06757552
 SHA512:
-  metadata.gz: b7adefb6e41f38b3f16d142c4e26ec4f4edcddc68793f82e6e897975449068c5c148865a036ec780256740a9c3452be9016ed7ac05d49d1509b80e41d4a7b4e5
-  data.tar.gz: b36c4eca3db78a7d033e9985bba70476c67fc27b84febe6b4e253891fd8534ae7cc1cadaf1ec46883e08dd66383148ced093d13caf5bc4631a6faa8347dcf10e
+  metadata.gz: 895e1fabb1950929973a761d0c3899e5cfe6854b2c0a1b71184b75260fe10167c52a0e8d4b1a1b176a39d3b3b695b58ea8dfaf42dc68cc1ffc45d4e49b0ffd82
+  data.tar.gz: ef8a46d212ede4351ffcbf62f562dff080557279530e7cfa432f827a3d8afb7dd4c0fe47f6b314c5392e08c40f3e70728b53a391398c37e5efd41752cd27f5ef

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+# 2.1.4
+  - Added setting to disable forcing single values to be added in arrays. Ref: https://github.com/logstash-plugins/logstash-filter-xml/pull/28.
 # 2.1.3
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
 # 2.1.2

data/CONTRIBUTORS

@@ -10,6 +10,7 @@ Contributors:
 * Pier-Hugues Pellerin (ph)
 * Richard Pijnenburg (electrical)
 * Suyog Rao (suyograo)
+* Gabriel Moskovicz (gmoskovicz)
 
 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

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012–2016 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.

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-xml-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-xml-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-xml.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-xml)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,7 +55,12 @@ gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
 - Install plugin
 ```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
 bin/plugin install --no-verify
+
 ```
 - Run Logstash with your plugin
 ```sh
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
 ```
 - Start Logstash and proceed to test the plugin
 

data/lib/logstash/filters/xml.rb

@@ -62,6 +62,10 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
   # field as described above. Setting this to false will prevent that.
   config :store_xml, :validate => :boolean, :default => true
 
+  # By default the filter will force single elements to be arrays. Setting this to 
+  # false will prevent storing single elements in arrays.
+  config :force_array, :validate => :boolean, :default => true
+
   # By default only namespaces declarations on the root element are considered.
   # This allows to configure all namespace declarations to parse the XML document.
   #
@@ -159,7 +163,7 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
 
     if @store_xml
       begin
-        event[@target] = XmlSimple.xml_in(value)
+        event[@target] = XmlSimple.xml_in(value, "ForceArray" => @force_array)
         matched = true
       rescue => e
         event.tag(XMLPARSEFAILURE_TAG)

data/logstash-filter-xml.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-xml'
-  s.version         = '2.1.3'
+  s.version         = '2.1.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Takes a field that contains XML and expands it into an actual datastructure."
-  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"
+  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"
   s.authors         = ["Elastic"]
   s.email           = 'info@elastic.co'
   s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"

data/spec/filters/xml_spec.rb

@@ -272,4 +272,38 @@ describe LogStash::Filters::Xml do
     end
   end
 
+
+  describe "parse with forcing array (Default)" do
+    config <<-CONFIG
+    filter {
+      xml {
+        source => "xmldata"
+        target => "parseddata"
+      }
+    }
+    CONFIG
+
+    # Single value
+    sample("xmldata" => '<foo><bar>Content</bar></foo>') do
+      insist { subject["parseddata"] } == { "bar" => ["Content"] }
+    end
+  end
+
+  describe "parse disabling forcing array" do
+    config <<-CONFIG
+    filter {
+      xml {
+        source => "xmldata"
+        target => "parseddata"
+        force_array => false
+      }
+    }
+    CONFIG
+
+    # Single value
+    sample("xmldata" => '<foo><bar>Content</bar></foo>') do
+      insist { subject["parseddata"] } == { "bar" => "Content" }
+    end
+  end
+
 end

metadata

@@ -1,72 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-xml
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-  name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: nokogiri
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: xml-simple
   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: xml-simple
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   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-devutils
   prerelease: false
   type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-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
+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
 email: info@elastic.co
 executables: []
 extensions: []
@@ -93,12 +93,12 @@ 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: []