logstash-filter-translate 0.1.4 → 0.1.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    N2IzZDgwNzM5YWY5OTI5OGZjN2Y1NGM5ZmRlNGE0YmMzZjM2NDRhNA==
-  data.tar.gz: !binary |-
-    OTcyY2FkZjFiMTg4MDUwNDliOWU0NTUxZDE0YTVmYzcyMGEwMTdkMg==
+SHA1:
+  metadata.gz: 46646b5c42903aa3b53c057a52f3cdb01574667d
+  data.tar.gz: 2d6b62873e4236da2b884f6df1f5fa2eef5de556
 SHA512:
-  metadata.gz: !binary |-
-    ZWU0ZGU5NmFlYTJlYmZhZWUwYjllM2M1YTVjYzA0OGY5NTE3NzE4ZGJiNTk5
-    OWQyMzJhYjU3YTU1ZjEzZWVlNDlmOTQ3OGY5ODZjMThkYjJhZjM5NjM4NTQw
-    Y2ViZjAzMjA3OTBhNjUyYmJmMTgzZmU0YjhjZWE4Yzc1ZGViODU=
-  data.tar.gz: !binary |-
-    Y2QzZTQ0ZGRjMTEwYTI4NzIzM2VjMTA1NTAyZjY5MTkwMGE5NGMwZGUxMzA1
-    ZTlkNGEzODEzZWU5MDhkYTM3ZmIxNGFkOWE2MTJkYmE1MmYyMDRjMWMyMjA3
-    OTUzOWRkNjQ5YTI3MzcyZjdkYjI3NmVmNTQ2Njk3NjJjMDBkZDQ=
+  metadata.gz: 895c3b7e311506ab84dc8c4cf5cbde9c8927cc83c40ad0e92cad2976e5e74ffae46a8ccce355272a8f2ab85648332a71052d0c033fe63c52e724621f61f0f95c
+  data.tar.gz: ba6356635422fb9e2e06747d0b66e3b3181c475bcb2414c63010143e93424a944e3a9429a45aaac5bbb1007acfdac99e05e04798777972e190835d2298145cfe

data/.gitignore

@@ -1,3 +1,4 @@
 *.gem
 Gemfile.lock
 .bundle
+vendor

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
-gem 'rake'
-gem 'gem_publisher'
+gemspec
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+
+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/Rakefile

@@ -1,12 +1,7 @@
-require "gem_publisher"
-
-desc "Publish gem to RubyGems.org"
-task :publish_gem do |t|
-  gem = GemPublisher.publish_if_updated("logstash-filter-translate.gemspec", :rubygems)
-  puts "Published #{gem}" if gem
-end
+@files=[]
 
 task :default do
   system("rake -T")
 end
 
+require "logstash/devutils/rake"

data/lib/logstash/filters/translate.rb

@@ -6,18 +6,18 @@ require "logstash/namespace"
 # and/or a YAML file to determine replacement values.
 #
 # The dictionary entries can be specified in one of two ways: First,
-# the "dictionary" configuration item may contain a hash representing
+# the `dictionary` configuration item may contain a hash representing
 # the mapping. Second, an external YAML file (readable by logstash) may be specified
-# in the "dictionary_path" configuration item. These two methods may not be used
+# in the `dictionary_path` configuration item. These two methods may not be used
 # in conjunction; it will produce an error.
 #
-# Operationally, if the event field specified in the "field" configuration
+# Operationally, if the event field specified in the `field` configuration
 # matches the EXACT contents of a dictionary entry key (or matches a regex if
-# "regex" configuration item has been enabled), the field's value will be substituted
+# `regex` configuration item has been enabled), the field's value will be substituted
 # with the matched key's value from the dictionary.
 #
 # By default, the translate filter will replace the contents of the 
-# maching event field (in-place). However, by using the "destination"
+# maching event field (in-place). However, by using the `destination`
 # configuration item, you may also specify a target event field to
 # populate with the new translated value.
 # 
@@ -29,7 +29,7 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   milestone 1
 
   # The name of the logstash event field containing the value to be compared for a
-  # match by the translate filter (e.g. "message", "host", "response_code"). 
+  # match by the translate filter (e.g. `message`, `host`, `response_code`). 
   # 
   # If this field is an array, only the first value will be used.
   config :field, :validate => :string, :required => true
@@ -40,9 +40,9 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   config :override, :validate => :boolean, :default => false
 
   # The dictionary to use for translation, when specified in the logstash filter
-  # configuration item (i.e. do not use the @dictionary_path YAML file)
+  # configuration item (i.e. do not use the `@dictionary_path` YAML file)
   # Example:
-  #
+  # [source,ruby]
   #     filter {
   #       %PLUGIN% {
   #         dictionary => [ "100", "Continue",
@@ -51,19 +51,19 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   #                         "old version", "new version" ]
   #       }
   #     }
-  # NOTE: it is an error to specify both dictionary and dictionary_path
+  # NOTE: it is an error to specify both `dictionary` and `dictionary_path`
   config :dictionary, :validate => :hash,  :default => {}
 
   # The full path of the external YAML dictionary file. The format of the table
   # should be a standard YAML file. Make sure you specify any integer-based keys
   # in quotes. The YAML file should look something like this:
-  #
+  # [source,ruby]
   #     "100": Continue
   #     "101": Switching Protocols
   #     merci: gracias
   #     old version: new version
   #     
-  # NOTE: it is an error to specify both dictionary and dictionary_path
+  # NOTE: it is an error to specify both `dictionary` and `dictionary_path`
   config :dictionary_path, :validate => :path
 
   # When using a dictionary file, this setting will indicate how frequently
@@ -71,7 +71,7 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   config :refresh_interval, :validate => :number, :default => 300
   
   # The destination field you wish to populate with the translated code. The default
-  # is a field named "translation". Set this to the same value as source if you want
+  # is a field named `translation`. Set this to the same value as source if you want
   # to do a substitution, in this case filter will allways succeed. This will clobber
   # the old value of the source field! 
   config :destination, :validate => :string, :default => "translation"
@@ -82,14 +82,15 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   # destination field's data, with the translated value substituted in-place.
   #
   # For example, consider this simple translation.yml, configured to check the `data` field:
+  # [source,ruby]
   #     foo: bar
   #
-  # If logstash receives an event with the `data` field set to "foo", and `exact => true`,
-  # the destination field will be populated with the string "bar".
+  # If logstash receives an event with the `data` field set to `foo`, and `exact => true`,
+  # the destination field will be populated with the string `bar`.
   
   # If `exact => false`, and logstash receives the same event, the destination field
-  # will be also set to "bar". However, if logstash receives an event with the `data` field
-  # set to "foofing", the destination field will be set to "barfing".
+  # will be also set to `bar`. However, if logstash receives an event with the `data` field
+  # set to `foofing`, the destination field will be set to `barfing`.
   #
   # Set both `exact => true` AND `regex => `true` if you would like to match using dictionary
   # keys as regular expressions. A large dictionary could be expensive to match in this case. 
@@ -100,15 +101,15 @@ class LogStash::Filters::Translate < LogStash::Filters::Base
   config :regex, :validate => :boolean, :default => false
 
   # In case no translation occurs in the event (no matches), this will add a default
-  # translation string, which will always populate "field", if the match failed.
+  # translation string, which will always populate `field`, if the match failed.
   #
   # For example, if we have configured `fallback => "no match"`, using this dictionary:
-  #
+  # [source,ruby]
   #     foo: bar
   #
-  # Then, if logstash received an event with the field `foo` set to "bar", the destination
-  # field would be set to "bar". However, if logstash received an event with `foo` set to "nope",
-  # then the destination field would still be populated, but with the value of "no match".
+  # Then, if logstash received an event with the field `foo` set to `bar`, the destination
+  # field would be set to `bar`. However, if logstash received an event with `foo` set to `nope`,
+  # then the destination field would still be populated, but with the value of `no match`.
   config :fallback, :validate => :string
 
   public

data/logstash-filter-translate.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-translate'
-  s.version         = '0.1.4'
+  s.version         = '0.1.6'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "A general search and replace tool which uses a configured hash and/or a YAML file to determine replacement values."
-  s.description     = "A general search and replace tool which uses a configured hash and/or a YAML file to determine replacement values."
+  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"
   s.authors         = ["Elasticsearch"]
-  s.email           = 'richard.pijnenburg@elasticsearch.com'
-  s.homepage        = "http://logstash.net/"
+  s.email           = 'info@elasticsearch.com'
+  s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
   s.require_paths = ["lib"]
 
   # Files
@@ -17,10 +17,11 @@ Gem::Specification.new do |s|
   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", "group" => "filter" }
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
   s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
 
+  s.add_development_dependency 'logstash-devutils'
 end
 

data/spec/filters/{translate.rb → translate_spec.rb}

@@ -1,8 +1,8 @@
-require "test_utils"
+require "logstash/devutils/rspec/spec_helper"
 require "logstash/filters/translate"
 
 describe LogStash::Filters::Translate do
-  extend LogStash::RSpec
+  
 
   describe "exact translation" do
     config <<-CONFIG

metadata

@@ -1,76 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-translate
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Elasticsearch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS40LjA=
+        version: 1.4.0
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS40LjA=
-    - - <
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description: A general search and replace tool which uses a configured hash and/or
-  a YAML file to determine replacement values.
-email: richard.pijnenburg@elasticsearch.com
+        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@elasticsearch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - Rakefile
 - lib/logstash/filters/translate.rb
 - logstash-filter-translate.gemspec
-- spec/filters/translate.rb
-homepage: http://logstash.net/
+- spec/filters/translate_spec.rb
+homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
 metadata:
   logstash_plugin: 'true'
-  group: filter
-post_install_message: 
+  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.4.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.4.4
+signing_key:
 specification_version: 4
-summary: A general search and replace tool which uses a configured hash and/or a YAML
-  file to determine replacement values.
+summary: A general search and replace tool which uses a configured hash and/or a YAML file to determine replacement values.
 test_files:
-- spec/filters/translate.rb
+- spec/filters/translate_spec.rb