lenjador 1.2.1

data/spec/preprocessors/whitelist_spec.rb

@@ -0,0 +1,335 @@
+require 'spec_helper'
+require_relative '../../lib/lenjador/preprocessors/whitelist'
+
+RSpec.describe Lenjador::Preprocessors::Whitelist, 'when :action is :mask or omitted' do
+  subject(:processed_data) { described_class.new(config).process(data) }
+
+  let(:config) { { pointers: pointers } }
+  let(:pointers) { [] }
+  let(:data) do
+    {
+      field: 'secret',
+      data: {
+        field: 'secret'
+      },
+      array: [{ field: 'secret' }]
+    }
+  end
+
+  it 'masks all non-whitelisted fields' do
+    expect(processed_data).to eq(
+      field: '*****',
+      data: '*****',
+      array: '*****'
+    )
+  end
+
+  context 'when pointer has trailing slash' do
+    let(:pointers) { ['/field/'] }
+
+    it 'throws exception' do
+      expect { processed_data }.to raise_exception(Lenjador::Preprocessors::Whitelist::InvalidPointerFormatException)
+    end
+  end
+
+  context 'with whitelisted field' do
+    let(:pointers) { ['/field'] }
+
+    it 'includes the field' do
+      expect(processed_data).to eq(
+        field: 'secret',
+        data: '*****',
+        array: '*****'
+      )
+    end
+  end
+
+  context 'with whitelisted nested field' do
+    let(:pointers) { ['/data/field'] }
+
+    it 'includes nested field' do
+      expect(processed_data).to eq(
+        field: '*****',
+        data: {
+          field: 'secret'
+        },
+        array: '*****'
+      )
+    end
+  end
+
+  context 'with whitelisted array element field' do
+    let(:pointers) { ['/array/0/field'] }
+
+    it 'includes array element' do
+      expect(processed_data).to eq(
+        field: '*****',
+        data: '*****',
+        array: [{ field: 'secret' }]
+      )
+    end
+  end
+
+  context 'with whitelisted hash' do
+    it 'includes all whitelisted hash elements' do
+      source = { foo: { bar: 'baz' } }
+      target = { foo: { bar: 'baz' } }
+      expect(process(['/foo/~'], source)).to eq(target)
+    end
+
+    it 'does not include nested elements' do
+      source = { foo: { bar: { baz: 'asd' } } }
+      target = { foo: { bar: { baz: '*****' } } }
+      expect(process(['/foo/~'], source)).to eq(target)
+    end
+  end
+
+  context 'with whitelisted array elements field with wildcard' do
+    let(:data) do
+      {
+        array: [
+          { field: 'data1', secret: 'secret1' },
+          { field: 'data2', secret: 'secret2' }
+        ]
+      }
+    end
+    let(:pointers) { ['/array/~/field'] }
+
+    it 'includes array elements field' do
+      expect(processed_data).to include(
+        array: [
+          { field: 'data1', secret: '*****' },
+          { field: 'data2', secret: '*****' }
+        ]
+      )
+    end
+  end
+
+  context 'with whitelisted string array elements with wildcard' do
+    let(:data) do
+      { array: %w[secret secret] }
+    end
+    let(:pointers) { ['/array/~'] }
+
+    it 'includes array elements' do
+      expect(processed_data).to include(array: %w[secret secret])
+    end
+  end
+
+  context 'with whitelisted string array elements in an array with wildcard' do
+    let(:data) do
+      {
+        nested: [{ array: %w[secret secret] }]
+      }
+    end
+    let(:pointers) { ['/nested/~/array/~'] }
+
+    it 'includes array elements' do
+      expect(processed_data).to include(nested: [{ array: %w[secret secret] }])
+    end
+  end
+
+
+  context 'with whitelisted array element' do
+    let(:pointers) { ['/array/0'] }
+
+    it 'masks array element' do
+      expect(processed_data).to include(array: [{ field: '*****' }])
+    end
+  end
+
+  context 'with whitelisted array' do
+    let(:pointers) { ['/array'] }
+
+    it 'masks array' do
+      expect(processed_data).to include(array: ['*****'])
+    end
+  end
+
+  context 'with whitelisted hash' do
+    let(:pointers) { ['/data'] }
+
+    it 'masks hash' do
+      expect(processed_data).to include(data: { field: '*****' })
+    end
+  end
+
+  context 'when boolean present' do
+    let(:data) { { bool: true } }
+
+    it 'masks it with asteriks' do
+      expect(processed_data).to eq(bool: '*****')
+    end
+  end
+
+  context 'when field has slash in the name' do
+    let(:data) do
+      { 'field_with_/' => 'secret' }
+    end
+    let(:pointers) { ['/field_with_~1'] }
+
+    it 'includes field' do
+      expect(processed_data).to include('field_with_/'=> 'secret')
+    end
+  end
+
+  context 'when field has tilde in the name' do
+    let(:data) do
+      { 'field_with_~' => 'secret' }
+    end
+    let(:pointers) { ['/field_with_~0'] }
+
+    it 'includes field' do
+      expect(processed_data).to include('field_with_~'=> 'secret')
+    end
+  end
+
+  context 'when field has tilde and 1' do
+    let(:data) do
+      { 'field_with_~1' => 'secret' }
+    end
+    let(:pointers) { ['/field_with_~01'] }
+
+    it 'includes field' do
+      expect(processed_data).to include('field_with_~1'=> 'secret')
+    end
+  end
+
+  def process(pointers, data)
+    described_class.new(pointers: pointers).process(data)
+  end
+end
+
+RSpec.describe Lenjador::Preprocessors::Whitelist, 'when :action is :exclude or :prune' do
+  subject(:processed_data) { described_class.new(config).process(data) }
+
+  let(:config) { { pointers: pointers, action: :prune } }
+  let(:pointers) { [] }
+  let(:data) do
+    {
+      field: 'secret',
+      data: {
+        field: 'secret'
+      },
+      array: [{ field: 'secret' }, { field2: 'secret' }]
+    }
+  end
+
+  context 'when pointers is empty' do
+    it 'prunes all fields from the input' do
+      expect(processed_data).to eq({})
+    end
+  end
+
+  context 'with whitelisted field' do
+    let(:pointers) { ['/field'] }
+
+    it 'includes the field' do
+      expect(processed_data).to eq(field: 'secret')
+    end
+  end
+
+  context 'with whitelisted nested field' do
+    let(:pointers) { ['/data/field'] }
+
+    it 'includes nested field' do
+      expect(processed_data).to eq(data: { field: 'secret' })
+    end
+  end
+
+  context 'with whitelisted array element field' do
+    let(:pointers) { ['/array/0/field'] }
+
+    it 'includes array element' do
+      expect(processed_data).to eq(array: [{ field: 'secret' }])
+    end
+  end
+
+  context 'with whitelisted hash' do
+    it 'includes all whitelisted hash elements' do
+      source = { foo: { bar: 'baz' } }
+      target = { foo: { bar: 'baz' } }
+      expect(process(['/foo/~'], source)).to eq(target)
+    end
+
+    it 'does not include nested elements' do
+      source = { foo: { bar: { baz: 'asd' } } }
+      target = { foo: { bar: {} } }
+      expect(process(['/foo/~'], source)).to eq(target)
+    end
+  end
+
+  context 'with whitelisted array elements field with wildcard' do
+    let(:data) do
+      {
+        array: [
+          { field: 'data1', secret: 'secret1' },
+          { field: 'data2', secret: 'secret2' }
+        ]
+      }
+    end
+    let(:pointers) { ['/array/~/field'] }
+
+    it 'includes array elements field' do
+      expect(processed_data).to include(
+                                  array: [
+                                    { field: 'data1' },
+                                    { field: 'data2' }
+                                  ]
+                                )
+    end
+  end
+
+  context 'with whitelisted string array elements with wildcard' do
+    let(:data) do
+      { array: %w[secret1 secret2] }
+    end
+    let(:pointers) { ['/array/~'] }
+
+    it 'includes array elements' do
+      expect(processed_data).to include(array: %w[secret1 secret2])
+    end
+  end
+
+  context 'with whitelisted string array elements in an array with wildcard' do
+    let(:data) do
+      {
+        nested: [{ array: %w[secret1 secret2] }]
+      }
+    end
+    let(:pointers) { ['/nested/~/array/~'] }
+
+    it 'includes array elements' do
+      expect(processed_data).to include(nested: [{ array: %w[secret1 secret2] }])
+    end
+  end
+
+
+  context 'with whitelisted array element' do
+    let(:pointers) { ['/array/0'] }
+
+    it 'masks array element' do
+      expect(processed_data).to eq(array: [{}])
+    end
+  end
+
+  context 'with whitelisted array' do
+    let(:pointers) { ['/array'] }
+
+    it 'masks array' do
+      expect(processed_data).to include(array: [])
+    end
+  end
+
+  context 'with whitelisted hash' do
+    let(:pointers) { ['/data'] }
+
+    it 'masks hash' do
+      expect(processed_data).to include(data: {})
+    end
+  end
+
+  def process(pointers, data)
+    described_class.new(pointers: pointers, action: :prune).process(data)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+require 'pry'
+Bundler.setup
+
+require 'lenjador'
+
+Dir[File.dirname(__FILE__) + '/support/*.rb'].each {|f| require f}
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/support/implement_interface.rb

@@ -0,0 +1,11 @@
+RSpec::Matchers.define :implement_interface do |expected|
+  required_methods = expected.instance_methods(false)
+  match do |actual|
+    required_methods - actual.methods == []
+  end
+
+  failure_message do |actual|
+    missing_methods = required_methods - actual.methods
+    "Expected instance methods #{missing_methods.inspect} to be implemented"
+  end
+end

data/spec/utils_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Lenjador::Utils do
+  let(:now) { Time.utc(2015, 10, 11, 23, 10, 21, 123456) }
+
+  before do
+    allow(Time).to receive(:now) { now }
+  end
+
+  describe '.build_event' do
+    subject(:event) { described_class.build_event(metadata, level, application_name) }
+
+    let(:application_name) { 'test_service' }
+    let(:level)  { :info }
+    let(:metadata) { {x: 'y'} }
+
+    it 'includes it in the event as application' do
+      expect(event[:application]).to eq(application_name)
+    end
+
+    it 'includes log level' do
+      expect(event[:level]).to eq(:info)
+    end
+
+    it 'includes timestamp' do
+      expect(event[:@timestamp]).to eq('2015-10-11T23:10:21.123Z')
+    end
+
+    context 'when @timestamp provided' do
+      let(:metadata) { {message: 'test', :@timestamp => 'a timestamp'} }
+
+      it 'overwrites @timestamp' do
+        expect(subject[:message]).to eq('test')
+        expect(subject[:@timestamp]).to eq('a timestamp')
+      end
+    end
+
+    context 'when host provided' do
+      let(:metadata) { {message: 'test', host: 'xyz'} }
+
+      it 'overwrites host' do
+        expect(subject[:message]).to eq('test')
+        expect(subject[:host]).to eq('xyz')
+      end
+    end
+  end
+
+  describe '.serialize_time_objects!' do
+    let(:object) do
+      {
+        time: Time.now,
+        hash: {
+          time: Time.now
+        },
+        array: [
+          Time.now,
+          {
+            time: Time.now
+          }
+        ]
+      }
+    end
+
+    let(:serialized_time) { now.iso8601 }
+
+    it 'recursively serializes time objects to iso8601' do
+      o = object.dup
+      described_class.serialize_time_objects!(o)
+
+      expect(o).to eq(
+        time: serialized_time,
+        hash: {
+          time: serialized_time
+        },
+        array: [
+          serialized_time,
+          {
+            time: serialized_time
+          }
+        ]
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: lenjador
+version: !ruby/object:Gem::Version
+  version: 1.2.1
+platform: ruby
+authors:
+- Salemove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It's lenjadoric
+email:
+- support@salemove.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- benchmark/whitelisting.rb
+- lenjador.gemspec
+- lib/lenjador.rb
+- lib/lenjador/adapters.rb
+- lib/lenjador/adapters/stdout_adapter.rb
+- lib/lenjador/adapters/stdout_json_adapter.rb
+- lib/lenjador/null_logger.rb
+- lib/lenjador/preprocessors.rb
+- lib/lenjador/preprocessors/blacklist.rb
+- lib/lenjador/preprocessors/json_pointer_trie.rb
+- lib/lenjador/preprocessors/strategies/mask.rb
+- lib/lenjador/preprocessors/strategies/prune.rb
+- lib/lenjador/preprocessors/whitelist.rb
+- lib/lenjador/utils.rb
+- spec/adapters/stdout_adapter_spec.rb
+- spec/adapters/stdout_json_adapter_spec.rb
+- spec/lenjador_spec.rb
+- spec/preprocessors/blacklist_spec.rb
+- spec/preprocessors/json_pointer_trie.rb
+- spec/preprocessors/whitelist_spec.rb
+- spec/spec_helper.rb
+- spec/support/implement_interface.rb
+- spec/utils_spec.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: What description said
+test_files:
+- spec/adapters/stdout_adapter_spec.rb
+- spec/adapters/stdout_json_adapter_spec.rb
+- spec/lenjador_spec.rb
+- spec/preprocessors/blacklist_spec.rb
+- spec/preprocessors/json_pointer_trie.rb
+- spec/preprocessors/whitelist_spec.rb
+- spec/spec_helper.rb
+- spec/support/implement_interface.rb
+- spec/utils_spec.rb