logstash-output-csv 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c90c7648823c390c1db7b69296f90b71b18a631f
-  data.tar.gz: 94848d4486fce5fab419fe6f9228b756bb5cebce
+  metadata.gz: 05d5e4ca59e34c3669b05517154b5b5869d483c7
+  data.tar.gz: b27171ebca8cef47f85fa94dbe89aa5facb23c8e
 SHA512:
-  metadata.gz: 8c5dd47ad581fdde9859f1fc0072374ca0f7138eca3ad936c71cbb71fe0be6511e5f1576f7045cc849007842061244c586920bbec55eaf376c5f9a203a933246
-  data.tar.gz: 29b433bf08d08d639c9af348503b415a8ff5b233c75329d573914ab50cf74b342d1babff09f10d7be1953d08203ac4e604b42f9ea04eb89c2b98d81e5c3d436e
+  metadata.gz: b41a43e2c69186d9a4ccb1ec5557dc029ee5cad34b480cdf4fbe674823f4500336662ea47715a5e7de6e895f6982e75828c03377f6a23891c5f26e8dd69567f4
+  data.tar.gz: b88038d2a6a36646809d5ecf5a553755a92c6e2a4f06b5f9a6b9a6806995f25f6f719bd4f046419d2f6b2bfb4c79b9e878b75a57f6d231c0d3b241b1238311b3

data/CHANGELOG.md

@@ -1,5 +1,7 @@
+## 2.0.3
+ - Escape rogue values by default, which can be interpreted by spreadsheet apps. Add option to turn it off 
+
 ## 2.0.0
- - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
  - Dependency on logstash-core update to 2.0
-

data/README.md

@@ -1,5 +1,8 @@
 # Logstash Plugin
 
+[![Build
+Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-csv-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-csv-unit/)
+
 This is a plugin for [Logstash](https://github.com/elastic/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.

data/lib/logstash/outputs/csv.rb

@@ -22,6 +22,9 @@ class LogStash::Outputs::CSV < LogStash::Outputs::File
   # Full documentation is available on the http://ruby-doc.org/stdlib-2.0.0/libdoc/csv/rdoc/index.html[Ruby CSV documentation page].
   # A typical use case would be to use alternative column or row seperators eg: `csv_options => {"col_sep" => "\t" "row_sep" => "\r\n"}` gives tab seperated data with windows line endings
   config :csv_options, :validate => :hash, :required => false, :default => Hash.new
+  # Option to not escape/munge string values. Please note turning off this option
+  # may not make the values safe in your spreadsheet application
+  config :spreadsheet_safe, :validate => :boolean, :default => true
 
   public
   def register
@@ -31,7 +34,7 @@ class LogStash::Outputs::CSV < LogStash::Outputs::File
 
   public
   def receive(event)
-    
+
     path = event.sprintf(@path)
     fd = open(path)
     csv_values = @fields.map {|name| get_value(name, event)}
@@ -44,7 +47,11 @@ class LogStash::Outputs::CSV < LogStash::Outputs::File
   private
   def get_value(name, event)
     val = event[name]
-    val.is_a?(Hash) ? LogStash::Json.dump(val) : val
+    val.is_a?(Hash) ? LogStash::Json.dump(val) : escape_csv(val)
   end
-end # class LogStash::Outputs::CSV
 
+  private
+  def escape_csv(val)
+    (spreadsheet_safe && val.is_a?(String) && val.start_with?("=")) ? "'#{val}" : val
+  end
+end # class LogStash::Outputs::CSV

data/logstash-output-csv.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-csv'
-  s.version         = '2.0.2'
+  s.version         = '2.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Write events to disk in CSV or other delimited format"
   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"
@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core", ">= 2.0.0.beta2", "< 3.0.0"
 
+  s.add_runtime_dependency 'logstash-input-generator'
   s.add_runtime_dependency 'logstash-output-file'
   s.add_runtime_dependency 'logstash-filter-json'
   s.add_development_dependency 'logstash-devutils'
 end
-

data/spec/outputs/csv_spec.rb

@@ -4,7 +4,7 @@ require "logstash/devutils/rspec/spec_helper"
 require "logstash/outputs/csv"
 
 describe LogStash::Outputs::CSV do
-  
+
 
   describe "Write a single field to a csv file" do
     tmpfile = Tempfile.new('logstash-spec-output-csv')
@@ -263,4 +263,56 @@ describe LogStash::Outputs::CSV do
       insist {lines[0]} == "one|two\tone|two\t"
     end
   end
+
+  describe "can escape rogue values" do
+    tmpfile = Tempfile.new('logstash-spec-output-csv')
+    config <<-CONFIG
+      input {
+        generator {
+          add_field => ["foo","1+1", "baz", "=1+1"]
+          count => 1
+        }
+      }
+      output {
+        csv {
+          path => "#{tmpfile.path}"
+          fields => ["foo", "baz"]
+        }
+      }
+    CONFIG
+
+    agent do
+      lines = CSV.read(tmpfile.path)
+      insist {lines.count} == 1
+      insist {lines[0][0]} == "1+1"
+      insist {lines[0][1]} == "'=1+1"
+    end
+  end
+
+  describe "can turn off escaping rogue values" do
+    tmpfile = Tempfile.new('logstash-spec-output-csv')
+    config <<-CONFIG
+      input {
+        generator {
+          add_field => ["foo","1+1", "baz", "=1+1"]
+          count => 1
+        }
+      }
+      output {
+        csv {
+          path => "#{tmpfile.path}"
+          spreadsheet_safe => false
+          fields => ["foo", "baz"]
+        }
+      }
+    CONFIG
+
+    agent do
+      lines = CSV.read(tmpfile.path)
+      insist {lines.count} == 1
+      insist {lines[0][0]} == "1+1"
+      insist {lines[0][1]} == "=1+1"
+    end
+  end
+
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-csv
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -19,10 +20,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,48 +28,64 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 3.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: logstash-input-generator
+  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: logstash-output-file
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-output-file
   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-filter-json
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-filter-json
   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
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   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'
+  prerelease: false
+  type: :development
 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@elastic.co
 executables: []