logstash-filter-sentimentalizer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d01ae62913663f01498106240233691ba9554a7b
-  data.tar.gz: cd400d8bd6e832f8161f0a8365575cca9acfb467
+  metadata.gz: 985434fa92185812a9723b193bbf35993c35cd39
+  data.tar.gz: 2d9778a8dc3854c1d8eee28a95a846b02f23579b
 SHA512:
-  metadata.gz: 831e9ca15c91a307d0a13c220b7d102e96c6f46f606af045cbcd004553ee20b262006e0918e8280d9894ad6bd7c9913b69be05c18c62b296127fe095aa2361c0
-  data.tar.gz: 44f9e8b5842088167d85bf895aead64e660759bbbf6a58f8a1d3a2752e5cf11af0152243827a44a4b64605eec672ffe5a64e5cb098f44eae754d41968f4b7bd5
+  metadata.gz: 2d5d64917cdcc72cf81c95c09a6a1271a2fe20eda29bb137c3b6382f71d70c9a797696dcc6a45bf688fda48856b8fdd285fedfb73654033787f31fd8fb5a9ce4
+  data.tar.gz: 4b6efdc4e66ffae2c9267d5f92514c368a62a8980211fd44c96873f7756216a27fa8b27694baa9eb1af51385b6a8b93f73ae97bc2854f8dfe5c662f125d409bc

data/.travis.yml

@@ -1,6 +1,13 @@
+---
+sudo: false
 language: ruby
-
-rvm:
-    - jruby
-
+cache: bundler
+matrix:
+  include:
+  - rvm: jruby-9.1.13.0
+  - rvm: jruby-9.1.13.0
+  - rvm: jruby-9.1.13.0
+  - rvm: jruby-1.7.27
+  fast_finish: true
+jdk: oraclejdk8
 script: 'bundle exec rspec'

data/README.md

@@ -1,6 +1,25 @@
-# Logstash Plugin
+# logstash-filter-sentimentalizer [![Build Status](https://travis-ci.org/tylerjl/logstash-filter-sentimentalizer.svg?branch=master)](https://travis-ci.org/tylerjl/logstash-filter-sentimentalizer)
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash). [![Build Status](https://travis-ci.org/tylerjl/logstash-filter-sentimentalizer.svg?branch=master)](https://travis-ci.org/tylerjl/logstash-filter-sentimentalizer)
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+This plugin enables you to perform effective sentiment analysis on arbitrary event fields with pretty simple configuration.
+Consider the following:
+
+```
+filter {
+  sentimentalizer {
+    source => "message"
+  }
+}
+```
+
+Is enough to perform sentiment analysis on the `message` field.
+
+Results are stored in the `sentiment.probability` (a float between 0 and 1, 0 being wholly negative and 1 being maximum positive) and `sentiment.polarity` (an enum with the members "positive", "negative", and "neutral") fields of the processed event (these names come from the underlying sentiment analysis library).
+
+Here's a short demo of it in action.
+
+![logstash demo gif](./demo.gif)
 
 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/filters/sentimentalizer.rb

@@ -34,12 +34,13 @@ class LogStash::Filters::Sentimentalizer < LogStash::Filters::Base
   def filter(event)
     return unless filter?(event)
 
-    source = event.get(@source)
-    source.gsub!(/\B#(\S+)\b/, '\1') if @scrub
+    source = event.get(@source).dup
 
     unless source.nil?
       begin
-        sentiment = Sentimentalizer.analyze(source)
+        sentiment = Sentimentalizer.analyze(
+          @scrub ? source.gsub(/\B#(\S+)\b/, '\1') : source
+        )
       rescue NoMethodError => e
         @logger.error(
           'Error parsing sentiment for field',

data/logstash-filter-sentimentalizer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-sentimentalizer'
-  s.version       = '0.2.0'
+  s.version       = '0.2.1'
   s.licenses      = ['Apache-2.0']
   s.summary       = 'This plugin will analyze sentiment of a specified field.'
   s.description   = 'A logstash plugin to derive sentiment from fields.'
@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'sentimentalizer', '~> 0.3.0'
 
   s.add_development_dependency 'logstash-devutils', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
 end

data/spec/filters/sentimentalizer_spec.rb

@@ -1,75 +1,78 @@
 require 'spec_helper'
-require "logstash/filters/sentimentalizer"
+require 'logstash/filters/sentimentalizer'
 
 describe LogStash::Filters::Sentimentalizer do
   describe 'default sentiment configuration' do
-    let(:config) do <<-CONFIG
-      filter {
-        sentimentalizer { }
-      }
-    CONFIG
+    let(:config) do
+      <<-CONFIG
+        filter {
+          sentimentalizer { }
+        }
+      CONFIG
     end
 
     sample 'Horrible' do
-      expect(subject).to include("message")
-      expect(subject['sentiment']['polarity']).to eq('negative')
-      expect(subject['sentiment']['probability']).to be_a(Float)
-      expect(subject['sentiment']['probability']).to be < 0.5
+      expect(subject).to include('message')
+      expect(subject.get('sentiment')['polarity']).to eq('negative')
+      expect(subject.get('sentiment')['probability']).to be_a(Float)
+      expect(subject.get('sentiment')['probability']).to be < 0.5
     end
 
     sample 'Fantastic' do
-      expect(subject).to include("message")
-      expect(subject['sentiment']['polarity']).to eq('positive')
-      expect(subject['sentiment']['probability']).to be_a(Float)
-      expect(subject['sentiment']['probability']).to be > 0.5
+      expect(subject).to include('message')
+      expect(subject.get('sentiment')['polarity']).to eq('positive')
+      expect(subject.get('sentiment')['probability']).to be_a(Float)
+      expect(subject.get('sentiment')['probability']).to be > 0.5
     end
   end
 
   describe 'twitter hashtag scoring without scrubbing' do
-    let(:config) do <<-CONFIG
-      filter {
-        sentimentalizer {
-            scrub => false
+    let(:config) do
+      <<-CONFIG
+        filter {
+          sentimentalizer {
+              scrub => false
+          }
         }
-      }
-    CONFIG
+      CONFIG
     end
 
     sample 'What a #horrible idea' do
-      expect(subject).to include("message")
-      expect(subject['sentiment']['probability']).to be_a(Float)
-      expect(subject['sentiment']['probability']).to be_within(0.1).of(0.5)
+      expect(subject).to include('message')
+      expect(subject.get('sentiment')['probability']).to be_a(Float)
+      expect(subject.get('sentiment')['probability']).to be_within(0.1).of(0.5)
     end
 
     sample 'What a #fantastic idea' do
-      expect(subject).to include("message")
-      expect(subject['sentiment']['probability']).to be_a(Float)
-      expect(subject['sentiment']['probability']).to be_within(0.1).of(0.5)
+      expect(subject).to include('message')
+      expect(subject.get('sentiment')['probability']).to be_a(Float)
+      expect(subject.get('sentiment')['probability']).to be_within(0.1).of(0.5)
     end
   end
 
   describe 'twitter hashtag scoring with scrubbing' do
-    let(:config) do <<-CONFIG
-      filter {
-        sentimentalizer {
-            scrub => true
+    let(:config) do
+      <<-CONFIG
+        filter {
+          sentimentalizer {
+              scrub => true
+          }
         }
-      }
-    CONFIG
+      CONFIG
     end
 
     sample 'What a #horrible idea' do
-      expect(subject).to include("message")
-      expect(subject['sentiment']['polarity']).to eq('negative')
-      expect(subject['sentiment']['probability']).to be_a(Float)
-      expect(subject['sentiment']['probability']).to be < 0.1
+      expect(subject).to include('message')
+      expect(subject.get('sentiment')['polarity']).to eq('negative')
+      expect(subject.get('sentiment')['probability']).to be_a(Float)
+      expect(subject.get('sentiment')['probability']).to be < 0.1
     end
 
     sample 'What a #fantastic idea' do
-      expect(subject).to include("message")
-      expect(subject['sentiment']['polarity']).to eq('positive')
-      expect(subject['sentiment']['probability']).to be_a(Float)
-      expect(subject['sentiment']['probability']).to be > 0.9
+      expect(subject).to include('message')
+      expect(subject.get('sentiment')['polarity']).to eq('positive')
+      expect(subject.get('sentiment')['probability']).to be_a(Float)
+      expect(subject.get('sentiment')['probability']).to be > 0.9
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-sentimentalizer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tyler Langlois
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A logstash plugin to derive sentiment from fields.
 email: tyler@elastic.co
 executables: []
@@ -80,6 +94,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- demo.gif
 - lib/logstash/filters/sentimentalizer.rb
 - logstash-filter-sentimentalizer.gemspec
 - spec/filters/sentimentalizer_spec.rb