logstash-filter-wkt_repair 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be14b161e3a0c66926ad60399614e447133368e26bb6818406007f8734823f0e
-  data.tar.gz: 0ab82484912b7b1a4bb498108931a93408c3fd81b9c2b599a2affe3a1360297c
+  metadata.gz: 1630bff071ee79eb0873f68c5133d716f4ac7e0cf8bfcc3e21dabd2229d6e694
+  data.tar.gz: 10786660fbf15502655b667594e5ac8a88f53c2f3a47295562edee2a991c6973
 SHA512:
-  metadata.gz: 449d144e38bbaa76120450c7d4243aa77541d4545d4269adb8db8aecdbafaf4bfa73fe0f3714268d7a2af3449aace7dfab13ac31744a89b18de0bbc6b4be755b
-  data.tar.gz: f6752e5bf97463f3757e90d582e779913f3452d9276e03d81852e0334b1c673b97c3114c051dbd88d49522e8519a47cfa667059e48ee7961e172e05b0887cf7d
+  metadata.gz: 931060715411a7ff254aed275865d505eb3973fe48f8e06f48726f3e242edc1749bd5a5ba9c56815286fbcc21cfd6b10eb7cab178535ccdd5cf9810afc66eb92
+  data.tar.gz: 4767a4bb5de36a06b76f4383a1f177b6fea737c8d126fe42aa0e0358367e1d525ea5b1b1d1d7811c03b22a82f59a6d9e0793d1ae8b15c3c8ea779c504a45ac33

data/README.md

@@ -1,8 +1,8 @@
-# WKT Repair Logstash Filter
+# WKT or GeoJson Repair Logstash Filter
 
 [![Gem Version](https://badge.fury.io/rb/logstash-filter-wkt_repair.svg)](https://badge.fury.io/rb/logstash-filter-wkt_repair)
 
-Repairs WKT Polygons/Multipolygons on a Logstash event that are ambiguous or ill-defined and returns a coherent and clearly defined output.
+Repairs WKT or GeoJson Polygons/Multipolygons on a Logstash event that are ambiguous or ill-defined and returns a coherent and clearly defined output.
 
 Examples of ambigous or ill-defined polygons include, but not limited to:
 
@@ -18,6 +18,7 @@ Examples of ambigous or ill-defined polygons include, but not limited to:
         wkt_repair {
             source => "wkt"
             target => "wkt_repaired"
+            type => "WKT|GeoJson"
             tag_on_failure => [ "_wkt_repair_failure" ]
         }
     }
@@ -74,8 +75,9 @@ Add `/opt/prepair` to your $PATH
 ### 1. Plugin Developement and Testing
 
 #### Code
-- To get started, you'll need JRuby with the Bundler gem installed.
+- To get started, you'll need rvm, JRuby and the Bundler gem installed.
 ```sh
+\curl -sSL https://get.rvm.io | bash -s stable
 rvm install jruby
 jruby -S gem install bundler
 ```

data/lib/logstash/filters/wkt_repair.rb

@@ -10,15 +10,17 @@ class LogStash::Filters::WktRepair < LogStash::Filters::Base
   # [source,ruby]
   # ----------------------------------
   # wkt_repair => {
-  #  "source" => "name of field containing WKT shape data"
+  #  "source" => "name of field containing WKT or GeoJson data"
   #  "target" => "name of field to put the repaired WKT"
+  #  "type" => "the type of data. WKT or GeoJson"
   # }
   # ----------------------------------
   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' ]
+  config :target, :validate => :string, :default => 'data_repaired'
+  config :type, :validate => :string, :default => 'WKT'
+  config :tag_on_failure, :validate => :array, :default => [ '_data_repair_failure' ]
 
   public
   def register
@@ -28,27 +30,31 @@ class LogStash::Filters::WktRepair < LogStash::Filters::Base
   public
   def filter(event)
 
-    wkt = event.get(@source)
+    data = event.get(@source)
+    type = @type
     event_uuid = SecureRandom.uuid
     random_hex = SecureRandom.hex(10)
-    temp_file = "temp-wkt_#{event_uuid}_#{random_hex}.txt"
+    temp_file = "temp-data_#{event_uuid}_#{random_hex}.txt"
 
-    unless wkt.nil?
+    unless data.nil?
       begin
-        IO.write(temp_file, wkt)
+        IO.write(temp_file, data)
 
         wkt_repair_cmd = "prepair -f #{temp_file}"
+        if type.eql?("GeoJson")
+          wkt_repair_cmd = "prepair --ogr #{temp_file}"
+        end
         stdout, stderr, status = Open3.capture3("#{wkt_repair_cmd}")
         
         if (status.success? && !stdout.nil?)
           event.set(@target, stdout.strip)
         else
-          @logger.error("WKT Repair Error: #{stderr}")
-          @logger.error("WKT Repair Output Message: #{stdout}")
+          @logger.error("#{type} Repair Error: #{stderr}")
+          @logger.error("#{type} Repair Output Message: #{stdout}")
           @tag_on_failure.each { |tag| event.tag(tag) }
         end
       rescue Exception => e
-        @logger.error("WKT Repair Exception", :exception => e, :stacktrace => e.backtrace.join("\n"))
+        @logger.error("#{type} Repair Exception", :exception => e, :stacktrace => e.backtrace.join("\n"))
         @tag_on_failure.each { |tag| event.tag(tag) }
       ensure
         begin
@@ -56,7 +62,7 @@ class LogStash::Filters::WktRepair < LogStash::Filters::Base
             File.delete(temp_file)
           end
         rescue Exception => e
-          @logger.error("WKT Repair Exception in ensure block", :exception => e, :stacktrace => e.backtrace.join("\n"))
+          @logger.error("#{type} Repair Exception in ensure block", :exception => e, :stacktrace => e.backtrace.join("\n"))
         end
       end
     end

data/logstash-filter-wkt_repair.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-wkt_repair'
-  s.version       = '0.1.11'
+  s.version       = '0.2.0'
   s.licenses      = ['Apache-2.0']
-  s.summary       = 'Logstash filter to repair a WKT shape data.'
+  s.summary       = 'Logstash filter to repair a WKT/GeoJson 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']

data/spec/filters/wkt_repair_spec.rb

@@ -21,6 +21,26 @@ describe LogStash::Filters::WktRepair do
   end
 end
 
+describe LogStash::Filters::WktRepair do
+  describe "Successfully repair a GeoJson" do
+    let(:config) do <<-CONFIG
+      filter {
+        wkt_repair {
+          source => "geojson"
+          target => "geojson"
+          type => "GeoJson"
+        }
+      }
+    CONFIG
+    end
+
+    sample("geojson" => "{\"type\":\"Polygon\",\"coordinates\":[[[0,0],[0,10],[10,0],[10,10],[0,0]]]}") do
+      expect(subject).to include("geojson")
+      expect(subject.get('geojson')).to eq('MULTIPOLYGON (((0 10,0 0,5 5,0 10)),((5 5,10 0,10 10,5 5)))')
+    end
+  end
+end
+
 describe LogStash::Filters::WktRepair do
   describe "Unsuccessfully repair a WKT" do
     let(:config) do <<-CONFIG
@@ -36,7 +56,7 @@ describe LogStash::Filters::WktRepair do
     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")
+      expect(subject.get('tags')).to include("_data_repair_failure")
       
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-wkt_repair
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Silver Ibenye
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,7 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
-summary: Logstash filter to repair a WKT shape data.
+summary: Logstash filter to repair a WKT/GeoJson shape data.
 test_files:
 - spec/filters/wkt_repair_spec.rb
 - spec/spec_helper.rb