twiglet 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6970a1b98fbd77737c3742429691e3c03c7966e894e2f6a523824df785941858
-  data.tar.gz: 3a878416f432a4c9e38b0299afb6204fd2202168646d028298d40ab2c6cc7746
+  metadata.gz: 7a491b04b5c5a74e3addcdf2c8fb7712fddaf8f9966162f87f899166e05d08a0
+  data.tar.gz: eb4fe8a112d256d709a11792fd72d90b96f6bad05e2b814b99b8e7347b803f6f
 SHA512:
-  metadata.gz: 8a2e0c5bd321f495f4cf2c5d69a8caaff889e352305c5a900c1c7415e8637d0127729c91bd030353c1dd3b56e9c5623880f46849d3ff3eac1d502c3df8752c54
-  data.tar.gz: 0076c02f4070de277e488278f9f858d529b0ab39d8f8c07bc59a9d583c40421f0231b769a7ffb6a6ad1b422ed17f22ee4cd2a7eb68e436dc3b2b6c70c0246c8e
+  metadata.gz: 2fd77d2dd0403cbb6437d321eda9d0fb405a8efb7faec3cbfdc6d348c80de00064628d36ae50ded029cfe99d7b317f21a9a044af09174ead2350f71ccdc195c8
+  data.tar.gz: 6bf9879a1cf6d439f830394ca8cfb566e5b7145b6fc255e8b89be9fe57d6b89e33e7eaa2cf79d78a29a99ab8f8a8ebacf2f1219de3ed2ba12430b1c0f064480a

data/.github/workflows/dobby-actions.yml

@@ -9,7 +9,7 @@ jobs:
 
     steps:
       - name: bump version
-        uses: simplybusiness/dobby@v2.0.0
+        uses: simplybusiness/dobby@v2.1.0
         env:
           DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
           DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}

data/.github/workflows/version-forget-me-not.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-18.04
 
     steps:
-      - uses: simplybusiness/version-forget-me-not@v2
+      - uses: simplybusiness/version-forget-me-not@v2.1.0
         env:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION_FILE_PATH: "lib/twiglet/version.rb"

data/README.md

@@ -144,7 +144,72 @@ logger.formatter
 Take a look at this sample [Rack application](examples/rack/example_rack_app.rb#L15) with an ECS compliant
 [request logger](/examples/rack/request_logger.rb) as a template when configuring your own request logging middleware with Twiglet.
 
-## Use of dotted keys (DEPRECATED)
+### Log format validation
+Twiglet allows for the configuration of a custom validation schema. The validation schema must be [JSON Schema](https://json-schema.org/) compliant. Any fields not explicitly included in the provided schema are permitted by default.
+
+For example, given the following JSON Schema:
+```ruby
+validation_schema = <<-JSON
+    {
+      "type": "object",
+      "required": ["pet"],
+      "properties": {
+        "pet": {
+          "type": "object",
+          "required": ["name", "best_boy_or_girl?"],
+          "properties": {
+            "name": {
+              "type": "string",
+              "minLength": 1
+            },
+            "good_boy?": {
+              "type": "boolean"
+            }
+          }
+        }
+      }
+    }
+JSON
+```
+
+The logger can be instantiated with the custom schema
+```ruby
+custom_logger = Twiglet::Logger.new('service name', validation_schema: validation_schema)
+```
+
+Compliant log messages will log as normal.
+```ruby
+# this is compliant
+custom_logger.debug(pet: { name: 'Davis', good_boy?: true })
+
+# the result
+{:ecs=>{:version=>"1.5.0"}, :@timestamp=>"2020-05-11T15:01:01.000Z", :service=>{:name=>"petshop"}, :log=>{:level=>"debug"}, :pet=>{:name=>"Davis", :good_boy?=>true}}
+```
+
+Non compliant messages will raise an error.
+```ruby
+begin
+  custom_logger.debug(pet: { name: 'Davis' })
+rescue JSON::Schema::ValidationError
+  # we forgot to specify that he's a good boy!
+  puts 'uh-oh'
+end
+```
+
+#### Customizing error responses
+Depending on the application, it may not be desirable for the logger to raise Runtime errors. Twiglet allows you to configure a custom response for handling validation errors.
+
+Configure error handling by writing a block
+```ruby
+logger.configure_validation_error_response do |error|
+  # validation error handling goes here
+  # for example:
+  {YOUR APPLICATION BUG TRACKING SERVICE}.notify_error(error)
+end
+
+```
+
+### Use of dotted keys (DEPRECATED)
 
 Writing nested json objects could be confusing. This library has a built-in feature to convert dotted keys into nested objects, so if you log like this:
 

data/examples/rack/request_logger_test.rb

@@ -65,12 +65,12 @@ describe RequestLogger do
   end
 
   it 'logs an error message when a request is bad' do
-    -> { bad_request.get("/some/path") }.must_raise StandardError
+    expect { bad_request.get("/some/path") }.must_raise StandardError
     log = JSON.parse(output.string)
     assert_equal log['log']['level'], 'error'
     assert_equal log['error']['message'], 'some exception'
     assert_equal log['error']['type'], 'StandardError'
-    assert_includes log['error']['stack_trace'], 'request_logger_test.rb'
+    assert_includes log['error']['stack_trace'].first, 'examples/rack/request_logger_test.rb'
   end
 end
 

data/lib/hash_extensions.rb

@@ -24,6 +24,6 @@ module HashExtensions
     key.to_s
        .split('.')
        .reverse
-       .reduce(val) { |nested, key_part| Hash[key_part.to_sym, nested] }
+       .reduce(val) { |nested, key_part| { key_part.to_sym => nested } }
   end
 end

data/lib/twiglet/logger.rb

@@ -21,7 +21,7 @@ module Twiglet
 
       now = args.fetch(:now, -> { Time.now.utc })
       output = args.fetch(:output, $stdout)
-      level = args.fetch(:level, Logger::DEBUG)
+      level = args.fetch(:level, DEBUG)
       validation_schema = args.fetch(:validation_schema, File.read("#{__dir__}/validation_schema.json"))
 
       raise 'Service name is mandatory' \
@@ -70,7 +70,7 @@ module Twiglet
     private
 
     def add_stack_trace(hash_to_add_to, error)
-      hash_to_add_to[:error][:stack_trace] = error.backtrace.join("\n") if error.backtrace
+      hash_to_add_to[:error][:stack_trace] = error.backtrace if error.backtrace
     end
   end
 end

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/test/logger_test.rb

@@ -217,7 +217,7 @@ describe Twiglet::Logger do
       assert_equal 'Artificially raised exception', actual_log[:message]
       assert_equal 'divided by 0', actual_log[:error][:message]
       assert_equal 'ZeroDivisionError', actual_log[:error][:type]
-      assert_match 'logger_test.rb', actual_log[:error][:stack_trace].lines.first
+      assert_match 'test/logger_test.rb', actual_log[:error][:stack_trace].first
     end
 
     it 'should log an error without backtrace' do
@@ -357,6 +357,17 @@ describe Twiglet::Logger do
     it 'initializes the logger with the provided level' do
       assert_equal Logger::WARN, Twiglet::Logger.new('petshop', level: :warn).level
     end
+
+    it 'does not log lower level' do
+      logger = Twiglet::Logger.new(
+        'petshop',
+        now: @now,
+        output: @buffer,
+        level: Logger::INFO
+      )
+      logger.debug({ name: 'Davis', best_boy_or_girl?: true, species: 'dog' })
+      assert_empty @buffer.read
+    end
   end
 
   describe 'configuring error response' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Twiglet