fluent-plugin-xml-parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b080b8bbb4fef60f53d153d3a0c7f72a71465906
+  data.tar.gz: 0ade2363ce81d3d3639b7fa7977382b3dfdb4f8c
+SHA512:
+  metadata.gz: ba3f247d30b10a7e21bfebaaff9b1ce569e7f7366c2a22e69dbc1486937b05396529ed4ae3eed15609f3b46efd88abbd68bf5cca8f51af14506002f2747de0fb
+  data.tar.gz: 8535026f8b26aac6d7ec9d5005419f94a65a2f3c1257de02caea45f2ee7648709a160a82b463e12b0d685adbe65f805a0b6cf650eb716b1722aadef8c53baf64

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'test-unit'
+
+# Specify your gem's dependencies in fluent-plugin-mqtt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Toyokazu Akiyama
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,66 @@
+# Fluent::Plugin::XmlParser
+
+Fluent plugin for Parsing XML Input
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-xml-parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-xml-parser
+
+## Usage
+
+fluent-plugin-xml-parser provides input data conversion from XML to JSON for
+simple case, like sensor data. It can be specified at source directive as
+'format' option.
+
+The followings are an example description for Libelium SmartCity sensor data.
+
+```
+
+<source>
+  type mqtt
+  bind 127.0.0.1
+  port 1883
+  format xml
+  attr_xpaths '[[null, "@timestamp"], ["cap:alert/cap:info/cap:parameter/cap:valueName", "text"], [null, "location"]]'
+  value_xpaths '[["cap:alert/cap:info/cap:onset", "text"], ["cap:alert/cap:info/cap:parameter/cap:value", "text"], [null, "Kyoto"]]'
+</source>
+
+```
+
+attr_xpaths indicates attribute name of the target value. Each array with two strings
+means xpath of the attribute name and the attribute of the XML element (name, text etc).
+XPath can be omitted as 'null' and specify your own attribute name as the second
+parameter.
+
+value_xpaths indicates the target value to be extracted. Each array with two strings
+means xpath of the target value and the attribute of the XML element (name, text etc).
+XPath can be omitted as 'null' and specify your own value as the second parameter.
+
+You can check your own XML data structure by using irb or pry
+
+```
+
+require 'rexml/document'
+doc = REXML::Document.new(open("test.xml"))
+doc.elements['cap:alert/cap:info'].children
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/toyokazu/fluent-plugin-xml-parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-xml-parser.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-xml-parser"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Toyokazu Akiyama"]
+  spec.email         = ["toyokazu@gmail.com"]
+  spec.summary       = %q{fluentd xml parser plugin}
+  spec.description   = %q{fluentd xml parser plugin}
+  spec.homepage      = "http://github.com/toyokazu/fluent-plugin-xml-parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "fluentd"
+
+end

data/lib/fluent/plugin/parser_xml.rb

@@ -0,0 +1,95 @@
+require 'rexml/document'
+module Fluent
+  class TextParser
+    class XmlParser < Parser
+      # Register this parser as "xml"
+      Plugin.register_parser("xml", self)
+
+      # How to specify the target attributes and values
+      # The followings are an example description for Libelium SmartCity sensor data.
+      #
+      # attr_xpaths '[[null, "@timestamp"], ["cap:alert/cap:info/cap:parameter/cap:valueName", "text"], [null, "location"]]'
+      # value_xpaths '[["cap:alert/cap:info/cap:onset", "text"], ["cap:alert/cap:info/cap:parameter/cap:value", "text"], [null, "Kyoto"]]'
+      #
+      # attr_xpaths indicates attribute name of the target value. Each array with two strings
+      # means xpath of the attribute name and the attribute of the XML element (name, text etc).
+      # XPath can be omitted as 'null' and specify your own attribute name as the second
+      # parameter.
+      # 
+      # value_xpaths indicates the target value to be extracted. Each array with two strings
+      # means xpath of the target value and the attribute of the XML element (name, text etc).
+      # XPath can be omitted as 'null' and specify your own value as the second parameter.
+      #
+      # You can check your own XML data structure by using irb or pry
+      #
+      # require 'rexml/document'
+      # doc = REXML::Document.new(open("test.xml"))
+      # doc.elements['cap:alert/cap:info'].children
+      #
+      config_param :attr_xpaths, :string, :default => '[]'
+      config_param :value_xpaths, :string, :default => '[]'
+      config_param :time_format, :string, :default => nil # time_format is configurable
+      # This method is called after config_params have read configuration parameters
+      def configure(conf)
+        super
+
+        @attr_xpaths = json_parse(conf['attr_xpaths'])
+        @value_xpaths = json_parse(conf['value_xpaths'])
+        @time_format = conf['time_format']
+        # TimeParser class is already given. It takes a single argument as the time format
+        # to parse the time string with.
+        @time_parser = TimeParser.new(@time_format)
+      end
+
+      # This is the main method. The input "text" is the unit of data to be parsed.
+      # If this is the in_tail plugin, it would be a line. If this is for in_syslog,
+      # it is a single syslog message.
+      def parse(text)
+        begin
+          doc = REXML::Document.new(text)
+          $log.debug doc
+          record = {}
+          attrs = @attr_xpaths.map do |attr_xpath|
+            if attr_xpath[0].nil? # when null is specified
+              attr_xpath[1] # second parameter is used as the attribute name
+            else # otherwise, the target attribute name is extracted from XML
+              doc.elements[attr_xpath[0]].method(attr_xpath[1]).call
+            end
+          end
+          values = @value_xpaths.map do |value_xpath|
+            if value_xpath[0].nil? # when null is specified
+              value_xpath[1] # second parameter is used as the target value
+            else # otherwise, the target value is extracted from XML
+              doc.elements[value_xpath[0]].method(value_xpath[1]).call
+            end
+          end
+          attrs.size.times do |i|
+            if i == 0 # time value
+              @time = @time_parser.parse(values[i])
+              record[attrs[i]] = @time
+            else
+              record[attrs[i]] = values[i]
+            end
+          end
+          yield @time, record
+        rescue REXML::ParseException => e
+          $log.warn "Parse error", :error => e.to_s
+          $log.debug_backtrace(e.backtrace)
+        rescue Exception => e
+          $log.warn "error", :error => e.to_s
+          $log.debug_backtrace(e.backtrace)
+        end
+      end
+
+      def json_parse message
+        begin
+          y = Yajl::Parser.new
+          y.parse(message)
+        rescue
+          $log.error "JSON parse error", :error => $!.to_s, :error_class => $!.class.to_s
+          $log.warn_backtrace $!.backtrace         
+        end
+      end
+    end
+  end
+end

data/test/data/test.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<cap:alert xmlns:cap="urn:oasis:names:tc:emergency:cap:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:oasis:names:tc:emergency:cap:1.2 CAP-v1.2-os.xsd">
+  <cap:identifier>Libelium_2015-09-21T18:54:24+:00:00495</cap:identifier>
+  <cap:sender>Libelium_SmartCity_387243170</cap:sender>
+  <cap:sent>2015-09-21T18:54:24+:00:00</cap:sent>
+  <cap:status>Actual</cap:status>
+  <cap:msgType>Alert</cap:msgType>
+  <cap:scope>Public</cap:scope>
+  <cap:code>KPI</cap:code>
+  <cap:info>
+    <cap:category>Other</cap:category>
+    <cap:event>Libelium</cap:event>
+    <cap:urgency>Inmediate</cap:urgency>
+    <cap:severity>Unknown</cap:severity>
+    <cap:certainty>Observed</cap:certainty>
+    <cap:onset>2015-09-21T18:54:24+:00:00</cap:onset>
+    <cap:senderName>Libelium</cap:senderName>
+    <cap:headline>Waspmote sensors</cap:headline>
+    <cap:description>Sensor data from Waspmote devices: MCP</cap:description>
+    <cap:parameter>
+      <cap:valueName>MCP</cap:valueName>
+      <cap:value>50</cap:value>
+    </cap:parameter>
+  </cap:info>
+</cap:alert>

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-xml-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Toyokazu Akiyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fluentd xml parser plugin
+email:
+- toyokazu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-xml-parser.gemspec
+- lib/fluent/plugin/parser_xml.rb
+- test/data/test.xml
+- test/plugin/test_parser_xml.rb
+homepage: http://github.com/toyokazu/fluent-plugin-xml-parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: fluentd xml parser plugin
+test_files:
+- test/data/test.xml
+- test/plugin/test_parser_xml.rb