twiglet 3.1.3 → 3.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cace8decdc47857c5ce0bec8ae85b92fe93f866521bc6872371db38999b25c3
-  data.tar.gz: dc9bf4d673968a4c718af21c117584f7770a3f2d50cc704ff5d39da1bec26626
+  metadata.gz: 98f1c6b47cc30e450a1318ea8040d210cb1af5103124fbeee26bb4b5c5ccbb36
+  data.tar.gz: 4a1affb0ad177358ac4b66e33326b39e089fdf8bb63cee4e78593db3a2fd4109
 SHA512:
-  metadata.gz: 12c4455ae13471d0ebf0899966c9dbd32bf17841c468beaddb0a912a234033921a1694c2007d6a9d1732bdb69dbabc21f88cf98a195b9eea9a9be52d51cc07db
-  data.tar.gz: 91fab7466ae13a05de15fe66c2b8e4b78b28e2ee31220cd0f427d3928bfd59b15dbec2facc444f5c3a10a29bade3ee568e369fb921360fd6ddbb4c76f80bafd0
+  metadata.gz: bf39d61c9cdf97257a040ee3246facd81c3376a656e024817c7abc96153fce7404138b022923aafc4ba84b54c85a74553cdc59ca19dc88af0d5ea5b71e3ef171
+  data.tar.gz: 6d17f9991a7535f4083138cf1c65861e4890c0d4ef3a19cf0c14931d5766afb09136a7d56fbb7a782b166270eeb8fbeb74a6671b1301fc10cfe83f7ddb23085e

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,7 +65,7 @@ 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'

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

@@ -13,28 +13,29 @@ module Twiglet
 
     def initialize(
       service_name,
-      default_properties: {},
-      now: -> { Time.now.utc },
-      output: $stdout,
-      level: Logger::DEBUG
+      **args
     )
       @service_name = service_name
-      @now = now
-      @output = output
-      @level = level
+      default_properties = args.delete(:default_properties) || {}
+      @args = args
+
+      now = args.fetch(:now, -> { Time.now.utc })
+      output = args.fetch(:output, $stdout)
+      level = args.fetch(:level, DEBUG)
+      validation_schema = args.fetch(:validation_schema, File.read("#{__dir__}/validation_schema.json"))
 
       raise 'Service name is mandatory' \
         unless service_name.is_a?(String) && !service_name.strip.empty?
 
-      @validator = Validator.from_file("#{__dir__}/validation_schema.json")
+      @validator = Validator.new(validation_schema)
 
-      @formatter = Twiglet::Formatter.new(
+      formatter = Twiglet::Formatter.new(
         service_name,
         default_properties: default_properties,
         now: now,
         validator: @validator
       )
-      super(output, formatter: @formatter, level: level)
+      super(output, formatter: formatter, level: level)
     end
 
     def configure_validation_error_response(&block)
@@ -59,10 +60,7 @@ module Twiglet
     def with(default_properties)
       Logger.new(
         @service_name,
-        default_properties: default_properties,
-        now: @now,
-        output: @output,
-        level: @level
+        **@args.merge(default_properties: default_properties)
       )
     end
 

data/lib/twiglet/validator.rb

@@ -8,14 +8,10 @@ module Twiglet
     attr_accessor :custom_error_handler
 
     def initialize(schema)
-      @schema = schema
+      @schema = JSON.parse(schema)
       @custom_error_handler = ->(e) { raise e }
     end
 
-    def self.from_file(file_path)
-      new(JSON.parse(File.read(file_path)))
-    end
-
     def validate(message)
       JSON::Validator.validate!(@schema, message)
     rescue JSON::Schema::ValidationError => e

data/lib/twiglet/version.rb

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

data/test/formatter_test.rb

@@ -8,7 +8,7 @@ require_relative '../lib/twiglet/validator'
 describe Twiglet::Formatter do
   before do
     @now = -> { Time.utc(2020, 5, 11, 15, 1, 1) }
-    @formatter = Twiglet::Formatter.new('petshop', now: @now, validator: Twiglet::Validator.new({}))
+    @formatter = Twiglet::Formatter.new('petshop', now: @now, validator: Twiglet::Validator.new({}.to_json))
   end
 
   it 'initializes an instance of a Ruby Logger Formatter' do

data/test/logger_test.rb

@@ -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
@@ -380,6 +391,61 @@ describe Twiglet::Logger do
     end
   end
 
+  describe 'validation schema' do
+    before do
+      validation_schema = <<-JSON
+        {
+          "type": "object",
+          "required": ["pet"],
+          "properties": {
+            "pet": {
+              "type": "object",
+              "required": ["name", "best_boy_or_girl?"],
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "best_boy_or_girl?": {
+                  "type": "boolean"
+                }
+              }
+            }
+          }
+        }
+      JSON
+
+      @logger = Twiglet::Logger.new(
+        'petshop',
+        now: @now,
+        output: @buffer,
+        validation_schema: validation_schema
+      )
+    end
+
+    it 'allows for the configuration of custom validation rules' do
+      @logger.debug(
+        {
+          pet: { name: 'Davis', best_boy_or_girl?: true, species: 'dog' }
+        }
+      )
+      log = read_json(@buffer)
+
+      assert_equal true, log[:pet][:best_boy_or_girl?]
+    end
+
+    it 'raises when custom validation rules are broken' do
+      nonconformant = {
+        pet: { name: 'Davis' }
+      }
+
+      assert_raises JSON::Schema::ValidationError,
+                    "The property '#/pet' did not contain a required property of 'best_boy_or_girl?'" do
+        @logger.debug(nonconformant)
+      end
+    end
+  end
+
   private
 
   def read_json(buffer)

data/test/validator_test.rb

@@ -17,7 +17,7 @@ describe Twiglet::Validator do
       }
     }
 
-    @validator = Twiglet::Validator.new(schema)
+    @validator = Twiglet::Validator.new(schema.to_json)
   end
 
   it 'does not raise when validation passes' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.5
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-05-21 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