lenjador 1.2.1 → 2.1.0

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ Bundler.setup
 
 require 'lenjador'
 
-Dir[File.dirname(__FILE__) + '/support/*.rb'].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lenjador
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lru_redux
@@ -26,12 +26,26 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -42,16 +56,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bunny
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: rubocop-salemove
+  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: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -103,6 +145,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -123,15 +166,16 @@ files:
 - 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
+- profiler/logs.rb
+- spec/lenjador/adapters/stdout_adapter_spec.rb
+- spec/lenjador/adapters/stdout_json_adapter_spec.rb
+- spec/lenjador/preprocessors/blacklist_spec.rb
+- spec/lenjador/preprocessors/json_pointer_trie_spec.rb
+- spec/lenjador/preprocessors/whitelist_spec.rb
+- spec/lenjador/utils_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
@@ -144,25 +188,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 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/adapters/stdout_adapter_spec.rb
+- spec/lenjador/adapters/stdout_json_adapter_spec.rb
+- spec/lenjador/preprocessors/blacklist_spec.rb
+- spec/lenjador/preprocessors/json_pointer_trie_spec.rb
+- spec/lenjador/preprocessors/whitelist_spec.rb
+- spec/lenjador/utils_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

data/spec/adapters/stdout_adapter_spec.rb

@@ -1,48 +0,0 @@
-require 'spec_helper'
-require_relative '../../lib/lenjador/adapters/stdout_adapter'
-
-describe Lenjador::Adapters::StdoutAdapter do
-  it 'creates a stdout logger' do
-    io_logger = described_class.new(0)
-
-    logger = io_logger.instance_variable_get(:@logger)
-    expect(logger).to be_a Logger
-  end
-
-  describe '#log' do
-    let(:adapter) { described_class.new(0) }
-    let(:logger) { adapter.logger }
-
-    context 'with only a message' do
-      it 'stringifies it correctly' do
-        expect(logger).to receive(:info).with('test')
-
-        adapter.log :info, message: 'test'
-      end
-    end
-
-    context 'with an empty message' do
-      it 'stringifies it correctly' do
-        expect(logger).to receive(:info).with(' {"a":"b"}')
-
-        adapter.log :info, message: '', a: 'b'
-      end
-    end
-
-    context 'with no message' do
-      it 'stringifies it correctly' do
-        expect(logger).to receive(:info).with('{"a":"b"}')
-
-        adapter.log :info, a: 'b'
-      end
-    end
-
-    context 'with a message and metadata' do
-      it 'stringifies it correctly' do
-        expect(logger).to receive(:info).with('test {"a":"b"}')
-
-        adapter.log :info, message: 'test', a: 'b'
-      end
-    end
-  end
-end

data/spec/adapters/stdout_json_adapter_spec.rb

@@ -1,62 +0,0 @@
-require 'spec_helper'
-require 'json'
-require_relative '../../lib/lenjador/adapters/stdout_json_adapter'
-
-describe Lenjador::Adapters::StdoutJsonAdapter do
-  let(:debug_level_code) { 0 }
-  let(:debug_level) { Lenjador::Adapters::LOG_LEVELS[debug_level_code] }
-  let(:info_level_code) { 1 }
-  let(:info_level) { Lenjador::Adapters::LOG_LEVELS[info_level_code] }
-
-  let(:stdout) { StringIO.new }
-
-  around do |example|
-    old_stdout = $stdout
-    $stdout = stdout
-
-    begin
-      example.call
-    ensure
-      $stdout = old_stdout
-    end
-  end
-
-  describe '#log' do
-    context 'when below threshold' do
-      let(:adapter) { described_class.new(debug_level_code, service_name) }
-      let(:metadata) { {x: 'y'} }
-      let(:event) { {a: 'b', x: 'y'} }
-      let(:serialized_event) { JSON.dump(event) }
-      let(:service_name) { 'my-service' }
-      let(:application_name) { 'my_service' }
-
-      before do
-        allow(Lenjador::Utils).to receive(:build_event)
-          .with(metadata, info_level, application_name)
-          .and_return(event)
-      end
-
-      it 'sends serialized event to $stdout' do
-        adapter.log(info_level, metadata)
-        expect(output).to eq serialized_event + "\n"
-      end
-    end
-
-    context 'when above threshold' do
-      let(:adapter) { described_class.new(info_level_code, service_name) }
-      let(:metadata) { {x: 'y'} }
-      let(:service_name) { 'my-service' }
-
-      it 'does not log the event' do
-        adapter.log(debug_level, metadata)
-        expect(output).to be_empty
-      end
-    end
-  end
-
-  private
-
-  def output
-    stdout.string
-  end
-end

data/spec/preprocessors/whitelist_spec.rb

@@ -1,335 +0,0 @@
-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