logstash-filter-rest 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af5930ffb298925b7a340afd929ac9c85559f4f
-  data.tar.gz: 57e160ff830adbc6b63d22968e4f20047b1779a3
+  metadata.gz: 4fac99e78c6f1c75edbbf92e74fede3862dca591
+  data.tar.gz: d7ccae6caf784862a5f998ff48116cf96b44030a
 SHA512:
-  metadata.gz: bedafb7870ae6c5d0fc22c81f4fcedd5b1384d6524afd8394da949502f6af8ce9d551615fa73751e112db6e44acfb51b90854874ac4199f0cc3cf53e55a7951a
-  data.tar.gz: cb947ea8b5cbd4f666afcb297f2e45cc2f8bf5655db1f16b66de7a7a649eefc01332fb6e3156076b92ada1986d9e469027c5a8552f1880ab0a69be55f86efc1e
+  metadata.gz: b49a566196685abb817a20f4438f9fedcf14a33bb8c82a9a766ed0bdb91e7cbeeb9f18746e4eba277fbce034ad798c32361bf6e54e7bfd1c4ccfebb2eb891ad7
+  data.tar.gz: 15d9d11fb62f6bda9b4d67e70e753eb5b0e2a447f054213bcc8e9831a06b5358ffc635ea57e5988cc05fd8760bebcecace6bba7a5c9412d773a83aaed666d20f

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.5.0
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+  - Require devutils >= 0 to make `bundler` update the package
+  - Use Event API for LS-5
+  - Implicit `sprintf`, deprecating the setting
+  - `target` is now required, dropping support to write into top-level in favor of only using new Event API
+    - this follows other logstash-plugins like `logstash-filter-json`
+  - if the response is empty, add the restfailure tags
+  - Some logging moved before code
+  - Testcases adapted to new behavior with error check

data/README.md

@@ -1,4 +1,4 @@
-# Logstash REST Filter [![Build Status](https://travis-ci.org/gandalfb/logstash-filter-rest.svg?branch=http-keep-alive)](https://travis-ci.org/gandalfb/logstash-filter-rest)
+# Logstash REST Filter [![Build Status](https://travis-ci.org/gandalfb/logstash-filter-rest.svg?branch=version%2Flogstash-5)](https://travis-ci.org/gandalfb/logstash-filter-rest)
 
 This is a filter plugin for [Logstash](https://github.com/elasticsearch/logstash).
 
@@ -30,8 +30,8 @@ Add the following inside the filter section of your logstash configuration:
 filter {
   rest {
     request => {
-      url => "http://example.com"       # string (required, with field reference: "http://example.com?id=%{id}" or params, if defined)
-      method => "post"                  # string (optional, default = "get")
+      url => "http://example.com"        # string (required, with field reference: "http://example.com?id=%{id}" or params, if defined)
+      method => "post"                   # string (optional, default = "get")
       headers => {                       # hash (optional)
         "key1" => "value1"
         "key2" => "value2"
@@ -40,16 +40,15 @@ filter {
         user => "AzureDiamond"
         password => "hunter2"
       }
-      params => {                       # hash (optional, available for method => "get" and "post"; if post it will be transformed into body hash and posted as json)
+      params => {                        # hash (optional, available for method => "get" and "post"; if post it will be transformed into body hash and posted as json)
         "key1" => "value1"
         "key2" => "value2"
-        "key3" => "%{somefield}"        # Please set sprintf to true if you want to use field references
+        "key3" => "%{somefield}"         # sprintf is used implicitly
       }
     }
-    json => true                      # boolean (optional, default = false)
-    sprintf => true                   # boolean (optional, default = false, set this to true if you want to use field references in url, header or params)
-    target => "my_key"          # string (optional, default = "rest_response")
-    fallback => {                     # hash describing a default in case of error
+    json => true                         # boolean (optional, default = true)
+    target => "my_key"                   # string (mandatory, no default)
+    fallback => {                        # hash describing a default in case of error
       "key1" => "value1"
       "key2" => "value2"
     }
@@ -57,6 +56,31 @@ filter {
 }
 ```
 
+Print plugin version:
+
+``` bash
+bin/logstash-plugin list --verbose | grep rest
+```
+
+Examples for running logstash from `cli`:
+
+``` bash
+bin/logstash --debug -e 'input { stdin{} } filter { rest { request => { url => "https://jsonplaceholder.typicode.com/posts" method => "post" params => { "userId" => "%{message}" } headers => { "Content-Type" => "application/json" } } target => 'rest' } } output {stdout { codec => rubydebug }}'
+```
+
+``` bash
+bin/logstash --debug -e 'input { stdin{} } filter { rest { request => { url => "https://jsonplaceholder.typicode.com/posts" method => "post" body => { "userId" => "%{message}" } headers => { "Content-Type" => "application/json" } } target => 'rest' } } output {stdout { codec => rubydebug }}'
+```
+
+``` bash
+bin/logstash --debug -e 'input { stdin{} } filter { rest { request => { url => "http://jsonplaceholder.typicode.com/users/%{message}" } target => 'rest' } } output {stdout { codec => rubydebug }}'
+```
+
+``` bash
+bin/logstash --debug -e 'input { stdin{} } filter { rest { request => { url => "https://jsonplaceholder.typicode.com/posts" method => "get" params => { "userId" => "%{message}" } headers => { "Content-Type" => "application/json" } } target => 'rest' } } output {stdout { codec => rubydebug }}'
+```
+
+
 ## Contributing
 
 All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.

data/lib/logstash/filters/rest.rb

@@ -4,6 +4,36 @@ require 'logstash/namespace'
 require 'logstash/plugin_mixins/http_client'
 require 'logstash/json'
 
+# Monkey Patch hsh with a recursive compact and deep freeze
+class Hash
+  def compact
+    delete_if { |_k, v| v.respond_to?(:each) ? v.compact.empty? : v.nil? }
+  end
+
+  def deep_freeze
+    each { |_k, v| v.deep_freeze if v.respond_to? :deep_freeze }
+    freeze
+  end
+end
+
+# Monkey Patch string to parse to hsh
+class String
+  def to_object(symbolize = true)
+    LogStash::Json.load(
+      gsub(/:([a-zA-z]+)/, '"\\1"').gsub('=>', ': '),
+      :symbolize_keys => symbolize
+    )
+  end
+end
+
+#  Monkey Patch Array with deep freeze
+class Array
+  def deep_freeze
+    each { |j| j.deep_freeze if j.respond_to? :deep_freeze }
+    freeze
+  end
+end
+
 # Logstash REST Filter
 # This filter calls a defined URL and saves the answer into a specified field.
 #
@@ -22,7 +52,7 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   #        request => {
   #          url => "http://example.com"       # string (required, with field reference: "http://example.com?id=%{id}" or params, if defined)
   #          method => "post"                  # string (optional, default = "get")
-  #          headers => {                       # hash (optional)
+  #          headers => {                      # hash (optional)
   #            "key1" => "value1"
   #            "key2" => "value2"
   #          }
@@ -33,9 +63,10 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   #          params => {                       # hash (optional, available for method => "get" and "post"; if post it will be transformed into body hash and posted as json)
   #            "key1" => "value1"
   #            "key2" => "value2"
-  #            "key3" => "%{somefield}"        # Please set sprintf to true if you want to use field references
+  #            "key3" => "%{somefield}"        # Field references are found implicitly on startup
   #          }
   #        }
+  #        target => "doc"
   #      }
   #    }
   #
@@ -48,7 +79,6 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   # [source,ruby]
   #     filter {
   #       rest {
-  #         request => { .. }
   #         json => true
   #       }
   #     }
@@ -64,22 +94,24 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   #         sprintf => true
   #       }
   #     }
-  config :sprintf, :validate => :boolean, :default => false
+  config :sprintf, :validate => :boolean, :default => false, :deprecated => true
 
-  # Defines the field, where the parsed response is written to
-  # if set to '' it will be written to event root
+  # Define the target field for placing the response data. This setting is
+  # required and may not be omitted. It is not possible to place the response
+  # into the event top-level.
   #
   # For example, if you want the data to be put in the `doc` field:
   # [source,ruby]
   #     filter {
   #       rest {
-  #         request => { .. }
   #         target => "doc"
   #       }
   #     }
   #
+  # Rest response will be expanded into a data structure in the `target` field.
+  #
   # NOTE: if the `target` field already exists, it will be overwritten!
-  config :target, :validate => :string, :default => 'rest'
+  config :target, :validate => :string, :required => true
 
   # If set, any error like json parsing or invalid http response
   # will result in this hash to be added to target instead of error tags
@@ -88,7 +120,6 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   # [source,ruby]
   #     filter {
   #       rest {
-  #         request => { .. }
   #         fallback => {
   #           'key1' => 'value1'
   #           'key2' => 'value2'
@@ -106,11 +137,25 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
   public
 
   def register
-    @request = normalize_request(@request).freeze
+    @request = normalize_request(@request)
+    @sprintf_fields = find_sprintf(
+      Marshal.load(Marshal.dump(@request))
+    ).deep_freeze
+    @target = normalize_target(@target)
   end # def register
 
   private
 
+  def normalize_target(target)
+    # make sure @target is in the format [field name] if defined,
+    # i.e. not empty and surrounded by brakets
+    raise LogStash::ConfigurationError, 'target config string is empty, please set a valid field name' if target.empty?
+    target = "[#{target}]" if target && target !~ /^\[[^\[\]]+\]$/
+    target
+  end
+
+  private
+
   def normalize_request(url_or_spec)
     if url_or_spec.is_a?(String)
       res = [:get, url_or_spec]
@@ -123,12 +168,12 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
       url = spec.delete(:url)
 
       # if it is a post and json, it is used as body string, not params
-      spec[:body] = spec.delete(:params) if method == :post
+      spec[:body] = spec.delete(:params) if method == :post && spec[:params]
 
       # We need these strings to be keywords!
       spec[:auth] = { user: spec[:auth]['user'], pass: spec[:auth]['password'] } if spec[:auth]
 
-      res = [method, url, spec]
+      res = [method.freeze, url, spec]
     else
       raise LogStash::ConfigurationError, "Invalid URL or request spec: '#{url_or_spec}', expected a String or Hash!"
     end
@@ -155,10 +200,27 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
 
   private
 
-  def request_http(request)
-    @logger.debug? && @logger.debug('Fetching URL', :request => request)
+  def find_sprintf(config)
+    field_matcher = /%\{[^}]+\}/
+    if config.is_a?(Hash)
+      config.keep_if do |_k, v|
+        find_sprintf(v)
+      end.compact
+    elsif config.is_a?(Array)
+      config.keep_if do |v|
+        find_sprintf(v)
+      end.compact
+    elsif config.is_a?(String) && config =~ field_matcher
+      config
+    end
+  end
 
+  private
+
+  def request_http(request)
     request[2][:body] = LogStash::Json.dump(request[2][:body]) if request[2].key?(:body)
+    @logger.debug? && @logger.debug('Fetching request',
+                                    :request => request)
 
     method, url, *request_opts = request
     response = client.http(method, url, *request_opts)
@@ -171,65 +233,64 @@ class LogStash::Filters::Rest < LogStash::Filters::Base
     if @json
       begin
         parsed = LogStash::Json.load(response)
-        event = add_to_event(parsed, event)
+        if parsed.empty?
+          @logger.warn('rest response empty',
+                       :response => response, :event => event)
+          @tag_on_rest_failure.each { |tag| event.tag(tag) }
+        else
+          event.set(@target, parsed)
+        end
       rescue
         if @fallback.empty?
+          @logger.warn('JSON parsing error',
+                       :response => response, :event => event)
           @tag_on_json_failure.each { |tag| event.tag(tag) }
-          @logger.warn('JSON parsing error', :response => response, :event => event)
         else
-          event = add_to_event(@fallback, event)
+          event.set(@target, @fallback)
         end
       end
     else
       event.set(@target, response.strip)
     end
-    event
   end
 
   public
 
   def filter(event)
     return unless filter?(event)
-    request = @request.dup
-    request[2][:params] = sprint(@sprintf, @request[2][:params], event) if request[2].key?(:params)
-    request[2][:body] = sprint(@sprintf, @request[2][:body], event) if request[2].key?(:body)
-    request[1] = sprint(@sprintf, @request[1], event)
+    @logger.debug? && @logger.debug('Parsing event fields',
+                                    :sprintf_fields => @sprintf_fields)
+    parsed_request_fields = event.sprintf(@sprintf_fields).to_object
+    parsed_request_fields.each do |v|
+      case v
+      when Hash
+        @request[2].merge!(v)
+      when String
+        @request[1] = v
+      end
+    end
+    @logger.debug? && @logger.debug('Parsed request',
+                                    :request => @request)
 
-    code, body = request_http(request)
+    code, body = request_http(@request)
     if code.between?(200, 299)
-      event = process_response(body, event)
-      @logger.debug? && @logger.debug('Sucess received', :code => code, :body => body)
+      @logger.debug? && @logger.debug('Sucess received',
+                                      :code => code, :body => body)
+      process_response(body, event)
     else
-      @logger.debug? && @logger.debug('Http error received', :code => code, :body => body)
+      @logger.debug? && @logger.debug('Http error received',
+                                      :code => code, :body => body)
       if @fallback.empty?
+        @logger.error('Error in Rest filter',
+                      :request => @request, :json => @json,
+                      :code => code, :body => body)
         @tag_on_rest_failure.each { |tag| event.tag(tag) }
-        @logger.error('Error in Rest filter', :request => request, :json => @json, :code => code, :body => body)
       else
-        event = add_to_event(@fallback, event)
-        @logger.debug? && @logger.debug('Setting fallback', :fallback => @fallback)
+        @logger.debug? && @logger.debug('Setting fallback',
+                                        :fallback => @fallback)
+        event.set(@target, @fallback)
       end
     end
     filter_matched(event)
   end # def filter
-
-  private
-
-  def sprint(sprintf, hash, event)
-    return hash unless sprintf
-    return event.sprintf(hash) unless hash.is_a?(Hash)
-    result = {}
-    hash.each { |k, v| result[k] = event.sprintf(v) }
-    result
-  end
-
-  private
-
-  def add_to_event(to_add, event)
-    if @target.empty?
-      to_add.each { |k, v| event[k] = v }
-    else
-      event[@target] = to_add
-    end
-    event
-  end
 end # class LogStash::Filters::Rest

data/logstash-filter-rest.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-rest'
-  s.version = '0.2.1'
+  s.version = '0.5.0'
   s.licenses = ['Apache License (2.0)']
   s.summary = 'This filter requests data from a RESTful Web Service.'
   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'
@@ -10,7 +10,15 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir['lib/**/*',
+                'spec/**/*',
+                'vendor/**/*',
+                '*.gemspec',
+                '*.md',
+                'CONTRIBUTORS',
+                'Gemfile',
+                'LICENSE',
+                'NOTICE.TXT']
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
@@ -18,10 +26,8 @@ Gem::Specification.new do |s|
   s.metadata = { 'logstash_plugin' => 'true', 'logstash_group' => 'filter' }
 
   # Gem dependencies
-  s.add_runtime_dependency 'logstash-core', '>= 1.6.0', '< 3.0.0'
-  s.add_runtime_dependency 'logstash-codec-json', '>= 1.6.0', '< 3.0.0'
+  s.add_runtime_dependency 'logstash-core-plugin-api', '>= 1.60', '<= 2.99'
   s.add_runtime_dependency 'logstash-mixin-http_client', '>= 2.2.4', '< 5.0.0'
 
-  s.add_development_dependency 'logstash-devutils', '~> 0'
-  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'logstash-devutils', '>= 0', '< 2.0.0'
 end

data/spec/filters/rest_spec.rb

@@ -1,33 +1,34 @@
-require 'spec_helper'
+require 'logstash/devutils/rspec/spec_helper'
 require 'logstash/filters/rest'
 
 describe LogStash::Filters::Rest do
-  describe "Set to Rest Filter Get without params" do
+  describe 'Set to Rest Filter Get without params' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "http://jsonplaceholder.typicode.com/users/10"
+            url => 'http://jsonplaceholder.typicode.com/users/10'
           }
           json => true
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
+    sample('message' => 'some text') do
       expect(subject).to include('rest')
-      expect(subject['rest']).to include("id")
-      expect(subject['rest']['id']).to eq(10)
-      expect(subject['rest']).to_not include("fallback")
+      expect(subject.get('rest')).to include('id')
+      expect(subject.get('[rest][id]')).to eq(10)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe "Set to Rest Filter Get without params custom target" do
+  describe 'Set to Rest Filter Get without params custom target' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "http://jsonplaceholder.typicode.com/users/10"
+            url => 'http://jsonplaceholder.typicode.com/users/10'
           }
           json => true
           target => 'testing'
@@ -36,14 +37,14 @@ describe LogStash::Filters::Rest do
     CONFIG
     end
 
-    sample("message" => "some text") do
+    sample('message' => 'some text') do
       expect(subject).to include('testing')
-      expect(subject['testing']).to include("id")
-      expect(subject['testing']['id']).to eq(10)
-      expect(subject['testing']).to_not include("fallback")
+      expect(subject.get('testing')).to include('id')
+      expect(subject.get('[testing][id]')).to eq(10)
+      expect(subject.get('testing')).to_not include('fallback')
     end
   end
-  describe "Set to Rest Filter Get without params and sprintf" do
+  describe 'Set to Rest Filter Get without params and sprintf' do
     let(:config) do <<-CONFIG
       filter {
         rest {
@@ -52,226 +53,279 @@ describe LogStash::Filters::Rest do
           }
           json => true
           sprintf => true
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "10") do
+    sample('message' => '10') do
       expect(subject).to include('rest')
-      expect(subject['rest']).to include("id")
-      expect(subject['rest']['id']).to eq(10)
-      expect(subject['rest']).to_not include("fallback")
+      expect(subject.get('rest')).to include('id')
+      expect(subject.get('[rest][id]')).to eq(10)
+      expect(subject.get('rest')).to_not include('fallback')
     end
-    sample("message" => "9") do
+    sample('message' => '9') do
       expect(subject).to include('rest')
-      expect(subject['rest']).to include("id")
-      expect(subject['rest']['id']).to eq(9)
-      expect(subject['rest']).to_not include("fallback")
+      expect(subject.get('rest')).to include('id')
+      expect(subject.get('[rest][id]')).to eq(9)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe "Set to Rest Filter Get without params http error" do
+  describe 'Set to Rest Filter Get without params http error' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "http://httpstat.us/404"
+            url => 'http://httpstat.us/404'
           }
           json => true
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
+    sample('message' => 'some text') do
       expect(subject).to_not include('rest')
-      expect(subject['tags']).to include('_restfailure')
+      expect(subject.get('tags')).to include('_restfailure')
     end
   end
-  describe "Set to Rest Filter Get with params" do
+  describe 'Set to Rest Filter Get with params' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "https://jsonplaceholder.typicode.com/posts"
+            url => 'https://jsonplaceholder.typicode.com/posts'
             params => {
               userId => 10
             }
             headers => {
-              "Content-Type" => "application/json"
+              'Content-Type' => 'application/json'
             }
           }
           json => true
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
+    sample('message' => 'some text') do
       expect(subject).to include('rest')
-      expect(subject['rest'][0]).to include("userId")
-      expect(subject['rest'][0]['userId']).to eq(10)
-      expect(subject['rest']).to_not include("fallback")
+      expect(subject.get('[rest][0]')).to include('userId')
+      expect(subject.get('[rest][0][userId]')).to eq(10)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe "Set to Rest Filter Get with params sprintf" do
+  describe 'empty response' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "https://jsonplaceholder.typicode.com/posts"
+            url => 'https://jsonplaceholder.typicode.com/posts'
+            params => {
+              userId => 0
+            }
+            headers => {
+              'Content-Type' => 'application/json'
+            }
+          }
+          target => 'rest'
+        }
+      }
+    CONFIG
+    end
+
+    sample('message' => 'some text') do
+      expect(subject).to_not include('rest')
+      expect(subject.get('tags')).to include('_restfailure')
+    end
+  end
+  describe 'Set to Rest Filter Get with params sprintf' do
+    let(:config) do <<-CONFIG
+      filter {
+        rest {
+          request => {
+            url => 'https://jsonplaceholder.typicode.com/posts'
             params => {
               userId => "%{message}"
+              id => "%{message}"
             }
             headers => {
-              "Content-Type" => "application/json"
+              'Content-Type' => 'application/json'
             }
           }
           json => true
-          sprintf => true
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "10") do
-      expect(subject).to include('rest')
-      expect(subject['rest'][0]).to include("userId")
-      expect(subject['rest'][0]['userId']).to eq(10)
-      expect(subject['rest']).to_not include("fallback")
-    end
-    sample("message" => "9") do
+    sample('message' => '1') do
       expect(subject).to include('rest')
-      expect(subject['rest'][0]).to include("userId")
-      expect(subject['rest'][0]['userId']).to eq(9)
-      expect(subject['rest']).to_not include("fallback")
+      expect(subject.get('[rest][0]')).to include('userId')
+      expect(subject.get('[rest][0][userId]')).to eq(1)
+      expect(subject.get('[rest][0][id]')).to eq(1)
+      expect(subject.get('rest').length).to eq(1)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe "Set to Rest Filter Post with params" do
+  describe 'Set to Rest Filter Post with params' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "https://jsonplaceholder.typicode.com/posts"
-            method => "post"
+            url => 'https://jsonplaceholder.typicode.com/posts'
+            method => 'post'
             params => {
               title => 'foo'
               body => 'bar'
               userId => 42
             }
             headers => {
-              "Content-Type" => "application/json"
+              'Content-Type' => 'application/json'
             }
           }
           json => true
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
+    sample('message' => 'some text') do
       expect(subject).to include('rest')
-      expect(subject['rest']).to include("id")
-      expect(subject['rest']['userId']).to eq(42)
-      expect(subject['rest']).to_not include("fallback")
+      expect(subject.get('rest')).to include('id')
+      expect(subject.get('[rest][userId]')).to eq(42)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe "Set to Rest Filter Post with params sprintf" do
+  describe 'Set to Rest Filter Post with params sprintf' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "https://jsonplaceholder.typicode.com/posts"
-            method => "post"
+            url => 'https://jsonplaceholder.typicode.com/posts'
+            method => 'post'
             params => {
               title => 'foo'
               body => 'bar'
               userId => "%{message}"
             }
             headers => {
-              "Content-Type" => "application/json"
+              'Content-Type' => 'application/json'
             }
           }
           json => true
-          sprintf => true
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "42") do
+    sample('message' => '42') do
       expect(subject).to include('rest')
-      expect(subject['rest']).to include("id")
-      expect(subject['rest']['userId']).to eq(42)
-      expect(subject['rest']).to_not include("fallback")
+      expect(subject.get('rest')).to include('id')
+      expect(subject.get('[rest][userId]')).to eq(42)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe "Fallback" do
+  describe 'Set to Rest Filter Post with body sprintf' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "http://jsonplaceholder.typicode.com/users/0"
+            url => 'https://jsonplaceholder.typicode.com/posts'
+            method => 'post'
+            body => {
+              title => 'foo'
+              body => 'bar'
+              userId => "%{message}"
+            }
+            headers => {
+              'Content-Type' => 'application/json'
+            }
           }
           json => true
-          fallback => {
-            "fallback1" => true
-            "fallback2" => true
-          }
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
+    sample('message' => '42') do
       expect(subject).to include('rest')
-      expect(subject['rest']).to include("fallback1")
-      expect(subject['rest']).to include("fallback2")
-      expect(subject['rest']).to_not include("id")
+      expect(subject.get('rest')).to include('id')
+      expect(subject.get('[rest][userId]')).to eq(42)
+      expect(subject.get('rest')).to_not include('fallback')
     end
   end
-  describe "Fallback empty target" do
+  describe 'fallback' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "http://jsonplaceholder.typicode.com/users/0"
+            url => 'http://jsonplaceholder.typicode.com/users/0'
           }
           json => true
-          target => ''
           fallback => {
-            "fallback1" => true
-            "fallback2" => true
+            'fallback1' => true
+            'fallback2' => true
           }
+          target => 'rest'
         }
       }
     CONFIG
     end
 
-    sample("message" => "some text") do
-      expect(subject).to_not include('rest')
-      expect(subject).to include("fallback1")
-      expect(subject).to include("fallback2")
-      expect(subject).to_not include("id")
+    sample('message' => 'some text') do
+      expect(subject).to include('rest')
+      expect(subject.get('rest')).to include('fallback1')
+      expect(subject.get('rest')).to include('fallback2')
+      expect(subject.get('rest')).to_not include('id')
     end
   end
-  describe "Empty target" do
+  describe 'empty target exception' do
     let(:config) do <<-CONFIG
       filter {
         rest {
           request => {
-            url => "http://jsonplaceholder.typicode.com/users/1"
+            url => 'http://jsonplaceholder.typicode.com/users/0'
           }
           json => true
+          fallback => {
+            'fallback1' => true
+            'fallback2' => true
+          }
           target => ''
         }
       }
     CONFIG
     end
-
-    sample("message" => "some text") do
-      expect(subject).to include("id")
-      expect(subject).to_not include("fallback")
+    sample('message' => 'some text') do
+      expect { subject }.to raise_error(LogStash::ConfigurationError)
+    end
+  end
+  describe 'missing target exception' do
+    let(:config) do <<-CONFIG
+      filter {
+        rest {
+          request => {
+            url => 'http://jsonplaceholder.typicode.com/users/0'
+          }
+          json => true
+          fallback => {
+            'fallback1' => true
+            'fallback2' => true
+          }
+        }
+      }
+    CONFIG
+    end
+    sample('message' => 'some text') do
+      expect { subject }.to raise_error(LogStash::ConfigurationError)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-rest
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Lucas Henning
@@ -9,48 +9,28 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-21 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.0
-    - - "<"
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  name: logstash-codec-json
+        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.6.0
-    - - "<"
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -74,37 +54,30 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   name: logstash-devutils
   prerelease: false
   type: :development
   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: pry
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 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: mail@hurb.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
@@ -112,7 +85,6 @@ files:
 - lib/logstash/filters/rest.rb
 - logstash-filter-rest.gemspec
 - spec/filters/rest_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/lucashenning/logstash-filter-rest/
 licenses:
 - Apache License (2.0)
@@ -141,4 +113,3 @@ specification_version: 4
 summary: This filter requests data from a RESTful Web Service.
 test_files:
 - spec/filters/rest_spec.rb
-- spec/spec_helper.rb

data/spec/spec_helper.rb

@@ -1,2 +0,0 @@
-require 'logstash/devutils/rspec/spec_helper'
-require 'pry'