twiglet 3.1.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 120d52bf23086d2db6f65f068aa087835914bcfe52c3ef1f8b6b886f946e9dcd
-  data.tar.gz: 8355c113e09882c4b1346111bba954b82f81d69c0290d1055dca4bb61174fc09
+  metadata.gz: 64fa676db51b4a53f17a7f1ff578ba00b670c2df9100b6972f2cf4b6fb51c1fc
+  data.tar.gz: 014044c6cccb28d13d019a26715ad83a5532e38b5f4df7ecf9a9a211eaec6751
 SHA512:
-  metadata.gz: 65ca30c0dcf26b8190b7840b70bd5a183b481333bc98af0abfed2835a5a25ec664e2b3c24f10d90f40a6a1d5a18fb90d9f97c2c2aae0ab49b123558049cc11da
-  data.tar.gz: 5936e07ac730cd18b39b5777a3fd1a7b8d805852726ad2732d46d6acdb1c7ef820f7dacf87ba68a85352dd3653c0e49b132a90ad71a40dd7ebdc3744ff9e68b8
+  metadata.gz: 3d771c2182011b62d5d5af36a55fb04069a2f19805733df475b2f8d0e93e9ccdffdbac81c24eda8ba2081950812b94f87673c931776b65a125fb973106ce1210
+  data.tar.gz: 01c66f316cabc1b1169d35ca224d2c35f5e79efab580df3c530deaddcf30f8b23a46549ffc46140540408fc8c60c916ea72cb1c67122d32233b633786c8289c8

data/.github/workflows/{version-update.yml → dobby-actions.yml}

@@ -1,4 +1,4 @@
-name: "version update action"
+name: "dobby action"
 on:
   issue_comment:
     types: [created]
@@ -8,8 +8,9 @@ jobs:
     if: startsWith(github.event.comment.body, '/dobby')
 
     steps:
-      - name: 'bump version'
-        uses: simplybusiness/dobby@v1.0.0
+      - name: bump version
+        uses: simplybusiness/dobby@v2.0.0
         env:
-          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
+          DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}
           VERSION_FILE_PATH: lib/twiglet/version.rb

data/Gemfile

@@ -2,11 +2,4 @@
 
 source 'https://rubygems.org'
 
-gem 'json-schema'
-
-group :development, :test do
-  gem 'minitest'
-  gem 'rake'
-  gem 'simplecov', '0.17.1'
-  gem 'simplycop'
-end
+gemspec

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/lib/twiglet/formatter.rb

@@ -1,7 +1,6 @@
 require 'logger'
 require_relative '../hash_extensions'
 require_relative 'message'
-require_relative 'validator'
 
 module Twiglet
   class Formatter < ::Logger::Formatter

data/lib/twiglet/logger.rb

@@ -2,10 +2,10 @@
 
 require 'logger'
 require 'time'
-require 'json'
 require_relative 'formatter'
 require_relative '../hash_extensions'
 require_relative 'message'
+require_relative 'validator'
 
 module Twiglet
   class Logger < ::Logger
@@ -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, Logger::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('lib/twiglet/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.0'
+  VERSION = '3.2.1'
 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

@@ -380,6 +380,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

data/twiglet.gemspec

@@ -21,4 +21,10 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.6'
 
   gem.license               = 'Copyright SimplyBusiness'
+
+  gem.add_runtime_dependency     'json-schema'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'simplecov', '0.17.1'
+  gem.add_development_dependency 'simplycop'
 end

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
-dependencies: []
+date: 2021-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rake
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: simplycop
+  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'
 description: Like a log, only smaller.
 email:
 - tech@simplybusiness.co.uk
@@ -19,10 +89,10 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/dependabot.yml"
+- ".github/workflows/dobby-actions.yml"
 - ".github/workflows/gem-publish.yml"
 - ".github/workflows/ruby.yml"
 - ".github/workflows/version-forget-me-not.yml"
-- ".github/workflows/version-update.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"