logstash-filter-xml 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7fd25d440b0df516cae7ba96eb400efdaa142eb
-  data.tar.gz: 02f3550e09fc68ecc383b59f0dbf4ead4c9a999a
+  metadata.gz: 807ad58486117006372804beae20e62e831748d2
+  data.tar.gz: fd042894e9d34c478b6b664f521e11c5948d256d
 SHA512:
-  metadata.gz: 32b9892df7bd97edc06cc5165433ff7818894fb97dc8379797fc5c6ad2ef8fd030303e69eae940214cf64372712768a049d7a0f7186c0bc1d35c653c5c29f0b5
-  data.tar.gz: 4b9fffa4ac1b0839c0ec4f6c2bc1c81635624fc68595f6aa1d1df82a0379b6de9ff2266e556afcb097285c96a423e2b2d85392316c085e98eedde4b049fbfb63
+  metadata.gz: 248162f14ab8d50153f8090299280c7a27c924c5f4cfeae8e7e1f65656a0f78551e163b4a18dd35d12cc53fc16d4cbf9f3090cbff54976470bc98ce373e2eb2d
+  data.tar.gz: ee51dbef72a086a83deb3edb578a8f0fd329a1f7ad53a41da04bd170df5b52a3978928e98ad4dec6687e15ee7c6ee1a3e8c3c3850e0b027a8eb4c29c381a0988

data/CONTRIBUTORS

@@ -0,0 +1,17 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Bryan Germann (bgerm)
+* Harlan Barnes (harlanbarnes)
+* Jordan Sissel (jordansissel)
+* Pete Fritchman (fetep)
+* Philippe Weber (wiibaa)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+
+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
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
 
 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

@@ -0,0 +1,95 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/xml.rb

@@ -7,7 +7,6 @@ require "logstash/namespace"
 class LogStash::Filters::Xml < LogStash::Filters::Base
 
   config_name "xml"
-  milestone 1
 
   # Config for xml to hash is:
   # [source,ruby]
@@ -62,6 +61,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
 
+  # Remove all namespaces from all nodes in the document.
+  # Of course, if the document had nodes with the same names but different namespaces, they will now be ambiguous.
+  config :remove_namespaces, :validate => :boolean, :default => false
+
   public
   def register
     require "nokogiri"
@@ -98,7 +101,7 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
                      :exception => e, :backtrace => e.backtrace)
         return
       end
-
+      doc.remove_namespaces! if @remove_namespaces
       @xpath.each do |xpath_src, xpath_dest|
         nodeset = doc.xpath(xpath_src)
 

data/logstash-filter-xml.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-xml'
-  s.version         = '0.1.2'
+  s.version         = '0.1.3'
   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"

data/spec/filters/xml_spec.rb

@@ -172,4 +172,38 @@ describe LogStash::Filters::Xml do
     end
   end
 
+  describe "parse including namespaces" do
+    config <<-CONFIG
+    filter {
+      xml {
+        source => "xmldata"
+        xpath => [ "/foo/h:div", "xpath_field" ]
+        remove_namespaces => false
+      }
+    }
+    CONFIG
+
+    # Single value
+    sample("xmldata" => '<foo xmlns:h="http://www.w3.org/TR/html4/"><h:div>Content</h:div></foo>') do
+      insist { subject["xpath_field"] } == ["<h:div>Content</h:div>"]
+    end
+  end
+
+  describe "parse removing namespaces" do
+    config <<-CONFIG
+    filter {
+      xml {
+        source => "xmldata"
+        xpath => [ "/foo/div", "xpath_field" ]
+        remove_namespaces => true
+      }
+    }
+    CONFIG
+
+    # Single value
+    sample("xmldata" => '<foo xmlns:h="http://www.w3.org/TR/html4/"><h:div>Content</h:div></foo>') do
+      insist { subject["xpath_field"] } == ["<div>Content</div>"]
+    end
+  end
+
 end

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-xml
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -20,7 +19,10 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -28,50 +30,48 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
-  name: nokogiri
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        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
 email: info@elasticsearch.com
 executables: []
@@ -79,8 +79,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTORS
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - lib/logstash/filters/xml.rb
 - logstash-filter-xml.gemspec
@@ -107,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.4
+rubygems_version: 2.1.9
 signing_key:
 specification_version: 4
 summary: Takes a field that contains XML and expands it into an actual datastructure.