logstash-filter-wkt_repair 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6032339c0a0e856124aa743eaf47cbebef6479bd440e0722c2138d7d507e44d
+  data.tar.gz: 5f8c5a64d3707992043be6dd4604c3f80991b1f1b68669534aad6e1a5840b2b2
+SHA512:
+  metadata.gz: f1d4580914c5d0d808c33decdb8eb6f24f51be6b75f4bd453482720415dcf161e133a2f64f2324730d9494fe957e7b4c7345953ab224879cd1cd6d9f96ecd198
+  data.tar.gz: 11ae0b9153abf6f84c0bfc04ff82dbcea42bef4d48953a10851d9ffb016e443e0e19519e700edcca48a751637f0eb27387e26f974d4363c7b725bbcdf2db8978

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Silver Ibenye - silver.ibenye@forrent.com
+
+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/DEVELOPER.md

@@ -0,0 +1,49 @@
+# logstash-filter-wkt_repair
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+```sh
+rvm install jruby
+jruby -S gem install bundler
+```
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Installing and Running your plugin locally
+
+You can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-wkt_repair.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-wkt_repair.gem
+```
+- Start Logstash and proceed to using/testing the plugin
+
+For walk through of developing Logstash filter plugin see https://www.elastic.co/guide/en/logstash/current/_how_to_write_a_logstash_filter_plugin.html

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,99 @@
+# WKT Repair Logstash Filter
+
+Repairs WKTs on a Logstash event that are ambigous or ill-defined polygons and returns a coherent and clearly defined output.
+
+Examples of ambigous or ill-defined polygons include, but not limited to:
+
+* A polygon with dangling edge
+* A polygon that is not closed
+* A polygon that  self intersects
+
+## Config example
+```javascript
+{
+    ...
+    filter {
+        wkt_repair {
+            source => "wkt"
+            target => "wkt_repaired"
+            tag_on_failure => [ "_wkt_repair_failure" ]
+        }
+    }
+    ...
+}
+```
+
+## Dependencies
+
+Yeah, unfortunately, this plugin depends on your server/container having these installed;
+- [cmake](https://cmake.org/download/)
+- [prepair](https://github.com/ForRentCom/prepair)
+
+### Dependency installation
+Run the following commands to install the dependencies;
+
+Installing cmake:
+```sh
+wget https://cmake.org/files/v3.9/cmake-3.9.3.tar.gz
+tar xzf cmake-3.9.3.tar.gz
+cd cmake-2.8.3
+./configure --prefix=/opt/cmake
+make
+make install
+```
+Add `/opt/cmake/bin` to your $PATH
+
+Installing prepair:
+```sh
+wget https://github.com/ForRentCom/prepair/archive/master.zip
+unzip prepair-master.zip -d /opt
+mv /opt/prepair-master /opt/prepair
+cd /opt/prepair
+cmake .
+make
+```
+Add `/opt/prepair` to your $PATH
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+```sh
+rvm install jruby
+jruby -S gem install bundler
+```
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Installing and Running the plugin locally
+
+- Build the plugin gem
+```sh
+gem build logstash-filter-wkt_repair.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-wkt_repair.gem
+```
+- Start Logstash and proceed to using/testing the plugin
+
+For walk through of developing Logstash filter plugin see https://www.elastic.co/guide/en/logstash/current/_how_to_write_a_logstash_filter_plugin.html

data/lib/logstash/filters/wkt_repair.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "open3"
+
+class LogStash::Filters::WktRepair < LogStash::Filters::Base
+
+  # Usage:
+  # [source,ruby]
+  # ----------------------------------
+  # wkt_repair => {
+  #  "source" => "name of field containing WKT shape data"
+  #  "target" => "name of field to put the repaired WKT"
+  # }
+  # ----------------------------------
+  config_name "wkt_repair"
+  
+  config :source, :validate => :string, :required => true
+  config :target, :validate => :string, :default => 'wkt_repaired'
+  config :tag_on_failure, :validate => :array, :default => [ '_wkt_repair_failure' ]
+
+  public
+  def register
+    # Add instance variables 
+  end # def register
+
+  public
+  def filter(event)
+
+    wkt = event.get(@source)
+
+    begin
+      cmd = "prepair --wkt '#{wkt}'"
+      stdout, stderr, status = Open3.capture3("#{cmd}")
+
+      if status.success?
+        event.set(@target, stdout.strip)
+      else
+        @logger.error("WKT Repair Error: #{stderr}", :wkt => wkt)
+        @tag_on_failure.each { |tag| event.tag(tag) }
+      end
+    rescue Exception => e
+      @logger.error("WKT Repair Exception", :exception => e)
+      @tag_on_failure.each { |tag| event.tag(tag) }
+    end
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::WktRepair

data/logstash-filter-wkt_repair.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-wkt_repair'
+  s.version       = '0.1.6'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Logstash filter to repair a WKT shape data.'
+  s.description   = 'It takes ambigous or ill-defined polygons and returns a coherent and clearly defined output.'
+  s.homepage      = 'https://github.com/sibenye/logstash-filter-wkt_repair'
+  s.authors       = ['Silver Ibenye']
+  s.email         = 'sibenye@gmail.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_development_dependency 'logstash-devutils', '1.3.3'
+end

data/spec/filters/wkt_repair_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/wkt_repair"
+
+describe LogStash::Filters::WktRepair do
+  describe "Successfully repair a WKT" do
+    let(:config) do <<-CONFIG
+      filter {
+        wkt_repair {
+          source => "geometry"
+          target => "geometry"
+        }
+      }
+    CONFIG
+    end
+
+    sample("geometry" => "POLYGON((0 0, 10 0, 10 11, 11 10, 0 10))") do
+      expect(subject).to include("geometry")
+      expect(subject.get('geometry')).to eq('MULTIPOLYGON (((10 0,10 10,0 10,0 0,10 0)),((11 10,10 11,10 10,11 10)))')
+    end
+  end
+end
+
+describe LogStash::Filters::WktRepair do
+  describe "Unsuccessfully repair a WKT" do
+    let(:config) do <<-CONFIG
+      filter {
+        wkt_repair {
+          source => "geometry"
+          target => "geometry"
+        }
+      }
+    CONFIG
+    end
+
+    sample("geometry" => "POLYGON((0 0, 10 0, 10 11, 11 10, 0 10") do
+      expect(subject).to include("geometry")
+      expect(subject.get('geometry')).to eq('POLYGON((0 0, 10 0, 10 11, 11 10, 0 10')
+      expect(subject.get('tags')).to include("_wkt_repair_failure")
+      
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-wkt_repair
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Silver Ibenye
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: It takes ambigous or ill-defined polygons and returns a coherent and
+  clearly defined output.
+email: sibenye@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/filters/wkt_repair.rb
+- logstash-filter-wkt_repair.gemspec
+- spec/filters/wkt_repair_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sibenye/logstash-filter-wkt_repair
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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.6.13
+signing_key:
+specification_version: 4
+summary: Logstash filter to repair a WKT shape data.
+test_files:
+- spec/filters/wkt_repair_spec.rb
+- spec/spec_helper.rb