lenjador 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d2c05e9a5e41ddcfb2274063ae0b5d75387a5657e9effb6440e1d0ac9aa10e2
-  data.tar.gz: f5e80262d179b4320f7db1e2f1998b9a6160c57868a14dbf3d74d73420289e2a
+  metadata.gz: 8fe741ce777af0426bec161a4c4bdddc3a6272c058289ba3d915dcb751fefeea
+  data.tar.gz: b68b01d171d613e15d789275e1f6b8666e6a480b2fecd5d23488f53d4f5e4c3a
 SHA512:
-  metadata.gz: a051c066866a827ca68e7b207a5f37f73ce7eb73bc1a33afca8523f2b51d2c44f47bd3d7d87d07ac2e7498f03298ac5120d314718c906043cf17b5ed913c6711
-  data.tar.gz: 212cc99147c9d533b82fb92594259ebf65eb49e9cf61e006d8460b874dec01e2cba6b4f15e898e3b199186c569fbcb488923e26ba05dc76a925292a9d1501f0f
+  metadata.gz: 73e65b430535a9f751746029beb9a7007b93694808543f079ff9732ff2a473824283ad31c6b86310bbd6dc1756de887b4a0575118813c1247afa04f6da950a48
+  data.tar.gz: a4c2975ac2a4445fcf763eb76eaaa1b7bef46ed8d3e22606d63c2b2d9fb49de74de7c8e5d53607df35667632b1e3446a74ef46934785bfc8dc66e058f49fd1ac

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/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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lenjador (2.2.1)
+    lenjador (2.3.0)
       lru_redux
       oj (~> 3.6)
 

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,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = 'lenjador'
-  gem.version       = '2.2.1'
+  gem.version       = '2.3.0'
   gem.authors       = ['Salemove']
   gem.email         = ['support@salemove.com']
   gem.description   = "It's lenjadoric"

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.rb

@@ -28,6 +28,11 @@ class Lenjador
     @preprocessors = preprocessors
   end
 
+  def add(severity, *args, &block)
+    level = SEV_LABEL.index(severity.to_s)
+    log(level, *args, &block)
+  end
+
   def debug(*args, &block)
     log(Severity::DEBUG, *args, &block)
   end

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

data/spec/lenjador_spec.rb

@@ -37,6 +37,20 @@ describe Lenjador do
     end
   end
 
+  describe '#add' do
+    let(:adapter) { double }
+    let(:lenjador) { described_class.new(adapter, Lenjador::Severity::INFO, []) }
+
+    it 'logs with severity' do
+      expect(adapter).to receive(:log).with(described_class::Severity::INFO, message: 'info-msg').ordered
+      expect(adapter).to receive(:log).with(described_class::Severity::WARN, message: 'warn-msg').ordered
+
+      lenjador.add('debug', 'debug-msg')
+      lenjador.add('info', 'info-msg')
+      lenjador.add('warn', 'warn-msg')
+    end
+  end
+
   context 'when preprocessor defined' do
     let(:lenjador) { described_class.new(adapter, level, [preprocessor]) }
     let(:adapter) { double }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lenjador
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lru_redux
@@ -158,11 +158,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -210,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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