lenjador 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6196d724a25318d7d37585d8240aeadf4539730a3d2456852e99f00a703ad60
-  data.tar.gz: aefd0d89ad20ed8f1decdd5e084adee315fdc6dbc14702fc26747f83b81274ec
+  metadata.gz: 26f40334235faaeecd2b8f1e960641c98d7926be963cb485d57b5db7476abd9d
+  data.tar.gz: 9417049506b81464afd16c050a72c0c9af8e4078c5b361aededb74c2fca2c117
 SHA512:
-  metadata.gz: 74e4d77b7bbe1867605dac6cd7edfa7e5b7ff5fdf7d2699422c49a0bd6168d531174d7f4c2f594b104afb4e90eaf5d0926c595d5543f3c56bea16d156465a283
-  data.tar.gz: 1bb069818e94912e408cd7cd95fa09db743336dd3242ebccd1b0029cb887b3dcf223cc4aa207ee2f543dac9044b38e6549ace8efe24453a4aae8f1380c898ccc
+  metadata.gz: 1005262582ae1ec5bc03445af4346f6011a5e32c553cdd86469dbcf9d380d8114a995f53649bd398d09674e145e023821e6717b70914f04bf5f96b5ec5429b00
+  data.tar.gz: ed3a7f3f6afc47cc7e431217c1c103bd290d3a9bd51f2e8bc0a94e5fd8fa6cf8d6de538a89a4eb1834d5c938987aa0fbe2be23530b7e48761936a6e6e60c5a85

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run lint & tests
+      run: bundle exec rake

data/.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Publish Gem
+
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+      - name: Release Gem
+        uses: discourse/publish-rubygems-action@ec5415e2cc3509a5cc8c4eef9499cf3fb05f8391
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          RELEASE_COMMAND: rake release

data/.gitignore

@@ -1,4 +1,2 @@
 node_modules/
 npm-debug.log
-Gemfile.lock
-

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   rubocop-salemove: config/default.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 
 Style/FrozenStringLiteralComment:
   Enabled: yes

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing to lenjador
+
+We currently do not accept any contributions from external sources.
+
+The code is still open source and if you wish to add any changes, feel free to fork it and add changes to your fork.
+
+Issues for any security-related bugs found are still welcome, but we offer no guarantees on whether or when they will be acted upon.
+
+For any exceptional cases, please contact us at open-source@glia.com.

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    lenjador (2.2.2)
+      lru_redux
+      oj (~> 3.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    benchmark-ips (2.8.4)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    lru_redux (1.1.0)
+    method_source (1.0.0)
+    oj (3.11.5)
+    opentelemetry-api (0.17.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    rubocop-salemove (0.0.5)
+      rubocop (~> 0.82)
+      rubocop-rspec (~> 1.15)
+    ruby-prof (1.4.3)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler
+  lenjador!
+  opentelemetry-api
+  pry
+  rake
+  rspec
+  rubocop-salemove
+  ruby-prof
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -119,3 +119,7 @@ Logger output:
 ```
 Received request {password: "********", "info": {"phone": "+12055555555"}, "addresses": [{"host": "example.com","path": "****"}]}
 ```
+
+## Releasing a new version
+
+A new version is created when a change is merged into the master branch that changes the version number in `lenjador.gemspec`. A Github Action will create a tag for the version and push the `.gem` file to [rubygems.org](https://rubygems.org)

data/lenjador.gemspec

@@ -5,13 +5,13 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = 'lenjador'
-  gem.version       = '2.2.0'
+  gem.version       = '2.2.2'
   gem.authors       = ['Salemove']
   gem.email         = ['support@salemove.com']
   gem.description   = "It's lenjadoric"
   gem.summary       = 'What description said'
   gem.license       = 'MIT'
-  gem.required_ruby_version = '>= 2.4'
+  gem.required_ruby_version = '>= 2.6'
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/lenjador/preprocessors/strategies/mask.rb

@@ -21,8 +21,11 @@ class Lenjador
           when Array
             process_array(data, pointer)
 
-          else
+          when String, Numeric, Symbol, Date, Time, TrueClass, FalseClass, NilClass
             data
+
+          else
+            MASKED_VALUE
           end
         end
 

data/lib/lenjador/preprocessors/strategies/prune.rb

@@ -18,8 +18,11 @@ class Lenjador
           when Array
             process_array(data, pointer)
 
-          else
+          when String, Numeric, Symbol, Date, Time, TrueClass, FalseClass, NilClass
             data
+
+          else
+            nil
           end
         end
 

data/lib/lenjador/preprocessors/whitelist.rb

@@ -7,7 +7,7 @@ require 'lenjador/preprocessors/strategies/prune'
 class Lenjador
   module Preprocessors
     class Whitelist
-      DEFAULT_WHITELIST = %w[/id /message /correlation_id /queue].freeze
+      DEFAULT_WHITELIST = %w[/id /message /correlation_id /queue /trace_id /span_id].freeze
       MASK_SYMBOL = '*'
       MASKED_VALUE = MASK_SYMBOL * 5
 

data/spec/lenjador/preprocessors/whitelist_spec.rb

@@ -147,10 +147,105 @@ RSpec.describe Lenjador::Preprocessors::Whitelist do
     end
 
     context 'when boolean present' do
-      let(:data) { {bool: true} }
+      let(:pointers) { ['/bool'] }
+      let(:data) do
+        {
+          bool: true,
+          bool2: true
+        }
+      end
+
+      it 'masks only if not in whitelist' do
+        expect(processed_data).to eq({
+          bool: true,
+          bool2: '*****'
+        })
+      end
+    end
+
+    context 'when nil present' do
+      let(:pointers) { ['/nil'] }
+      let(:data) do
+        {
+          nil: nil,
+          nil2: nil
+        }
+      end
 
-      it 'masks it with asteriks' do
-        expect(processed_data).to eq(bool: '*****')
+      it 'masks only if not in whitelist' do
+        expect(processed_data).to eq({
+          nil: nil,
+          nil2: '*****'
+        })
+      end
+    end
+
+    context 'when numbers present' do
+      let(:data) do
+        {
+          integer: 1,
+          float: 2.03,
+          integer2: 3,
+          float2: 3.34324
+        }
+      end
+      let(:pointers) { ['/integer', '/float'] }
+
+      it 'masks only if not in whitelist' do
+        expect(processed_data).to eq({
+          integer: 1,
+          float: 2.03,
+          integer2: '*****',
+          float2: '*****'
+        })
+      end
+    end
+
+    context 'when symbol present' do
+      let(:data) do
+        {
+          symbol1: :symbol1,
+          symbol2: :symbol2
+        }
+      end
+      let(:pointers) { ['/symbol1'] }
+
+      it 'masks only if not in whitelist' do
+        expect(processed_data).to eq({
+          symbol1: :symbol1,
+          symbol2: '*****'
+        })
+      end
+    end
+
+    context 'when date time present' do
+      let(:data) do
+        {
+          date: Date.new(2023, 12, 12),
+          time: Time.new(2023, 12, 13),
+          datetime: DateTime.new(2023, 12, 14)
+        }
+      end
+      let(:pointers) { ['/date', '/time', '/datetime'] }
+
+      it 'shows dates' do
+        expect(processed_data).to eq({
+          date: Date.new(2023, 12, 12),
+          time: Time.new(2023, 12, 13),
+          datetime: DateTime.new(2023, 12, 14)
+        })
+      end
+    end
+
+    context 'when unsupported object present' do
+      let(:pointers) { ['/field'] }
+      let(:some_class) { OpenStruct.new(name: 'Rowdy', pin_code: '1234') }
+      let(:data) { {field: some_class} }
+
+      it 'masks the object' do
+        expect(processed_data).to eq(
+          field: '*****'
+        )
       end
     end
 
@@ -312,6 +407,103 @@ RSpec.describe Lenjador::Preprocessors::Whitelist do
       end
     end
 
+    context 'when boolean present' do
+      let(:pointers) { ['/bool'] }
+      let(:data) do
+        {
+          bool: true,
+          bool2: true
+        }
+      end
+
+      it 'prunes only if not in whitelist' do
+        expect(processed_data).to eq({
+          bool: true
+        })
+      end
+    end
+
+    context 'when nil present' do
+      let(:pointers) { ['/nil'] }
+      let(:data) do
+        {
+          nil: nil,
+          nil2: nil
+        }
+      end
+
+      it 'prunes only if not in whitelist' do
+        expect(processed_data).to eq({
+          nil: nil
+        })
+      end
+    end
+
+    context 'when numbers present' do
+      let(:data) do
+        {
+          integer: 1,
+          float: 2.03,
+          integer2: 3,
+          float2: 3.34324
+        }
+      end
+      let(:pointers) { ['/integer', '/float'] }
+
+      it 'prunes only if not in whitelist' do
+        expect(processed_data).to eq({
+          integer: 1,
+          float: 2.03
+        })
+      end
+    end
+
+    context 'when symbol present' do
+      let(:data) do
+        {
+          symbol1: :symbol1,
+          symbol2: :symbol2
+        }
+      end
+      let(:pointers) { ['/symbol1'] }
+
+      it 'prunes only if not in whitelist' do
+        expect(processed_data).to eq({
+          symbol1: :symbol1
+        })
+      end
+    end
+
+    context 'when date time present' do
+      let(:data) do
+        {
+          date: Date.new(2023, 12, 12),
+          time: Time.new(2023, 12, 13),
+          datetime: DateTime.new(2023, 12, 14)
+        }
+      end
+      let(:pointers) { ['/date', '/time', '/datetime'] }
+
+      it 'shows dates' do
+        expect(processed_data).to eq({
+          date: Date.new(2023, 12, 12),
+          time: Time.new(2023, 12, 13),
+          datetime: DateTime.new(2023, 12, 14)
+        })
+      end
+    end
+
+    context 'when unsupported object present' do
+      let(:pointers) { ['/class'] }
+      let(:some_class) { OpenStruct.new(name: 'Rowdy', pin_code: '1234') }
+
+      let(:data) { {class: some_class} }
+
+      it 'does not return the object' do
+        expect(processed_data).to eq({class: nil})
+      end
+    end
+
     def process(pointers, data)
       described_class.new(pointers: pointers, action: :prune).process(data)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lenjador
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lru_redux
@@ -157,13 +157,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - benchmark/whitelisting.rb
@@ -202,14 +205,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: What description said

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.7