twiglet 3.0.6 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5cdde3c0d71c1d9749653946057baea5d50178d32c3345aaec2969da0a08b81
-  data.tar.gz: cbf3b20dadb27002fbfe6f9448d515f086b59c9b6d9321e01090860edf6aad3e
+  metadata.gz: 9cace8decdc47857c5ce0bec8ae85b92fe93f866521bc6872371db38999b25c3
+  data.tar.gz: dc9bf4d673968a4c718af21c117584f7770a3f2d50cc704ff5d39da1bec26626
 SHA512:
-  metadata.gz: 47fbf4941a54d8fc6acf5b52f6b0cc3bbf68a0ecc6cb0f7739c595c47b78dd23d1a1bf3cfb692c79d915248b1bc9de6b9c45f8f43c902f5bc22675a43256af85
-  data.tar.gz: f65764ec68e251d38ba49eafe44f1b04a62695bc94411f5c1ebb524c3fab498916b65f6905768fbb1c7bdad5dce7124f8e38fa219266cd0a300aadfae84c1162
+  metadata.gz: 12c4455ae13471d0ebf0899966c9dbd32bf17841c468beaddb0a912a234033921a1694c2007d6a9d1732bdb69dbabc21f88cf98a195b9eea9a9be52d51cc07db
+  data.tar.gz: 91fab7466ae13a05de15fe66c2b8e4b78b28e2ee31220cd0f427d3928bfd59b15dbec2facc444f5c3a10a29bade3ee568e369fb921360fd6ddbb4c76f80bafd0

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

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-group :development, :test do
-  gem 'minitest'
-  gem 'rake'
-  gem 'simplecov', '0.17.1'
-  gem 'simplycop'
-end
+
+gemspec

data/README.md

@@ -110,7 +110,7 @@ This writes:
 It may be that when making a series of logs that write information about a single event, you may want to avoid duplication by creating an event specific logger that includes the context:
 
 ```ruby
-request_log = logger.with({ event: { action: 'HTTP request'}, trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' }})
+request_logger = logger.with({ event: { action: 'HTTP request'}, trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' }})
 ```
 
 This can be used like any other Logger instance:
@@ -140,6 +140,10 @@ To access the formatter:
 logger.formatter
 ```
 
+### HTTP Request Logging
+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)
 
 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

@@ -7,18 +7,21 @@ module Twiglet
     Hash.include HashExtensions
 
     def initialize(service_name,
-                   default_properties: {},
+                   validator:, default_properties: {},
                    now: -> { Time.now.utc })
       @service_name = service_name
       @now = now
       @default_properties = default_properties
+      @validator = validator
 
       super()
     end
 
     def call(severity, _time, _progname, msg)
       level = severity.downcase
-      log(level: level, message: Message.new(msg))
+      message = Message.new(msg)
+      @validator.validate(message)
+      log(level: level, message: message)
     end
 
     private

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
@@ -26,8 +26,19 @@ module Twiglet
       raise 'Service name is mandatory' \
         unless service_name.is_a?(String) && !service_name.strip.empty?
 
-      formatter = Twiglet::Formatter.new(service_name, default_properties: default_properties, now: now)
-      super(output, formatter: formatter, level: level)
+      @validator = Validator.from_file("#{__dir__}/validation_schema.json")
+
+      @formatter = Twiglet::Formatter.new(
+        service_name,
+        default_properties: default_properties,
+        now: now,
+        validator: @validator
+      )
+      super(output, formatter: @formatter, level: level)
+    end
+
+    def configure_validation_error_response(&block)
+      @validator.custom_error_handler = block
     end
 
     def error(message = nil, error = nil, &block)

data/lib/twiglet/message.rb

@@ -1,6 +1,7 @@
 module Twiglet
   class Message < Hash
     def initialize(msg)
+      super
       case msg
       when String
         self[:message] = msg
@@ -9,18 +10,6 @@ module Twiglet
       else
         super(msg)
       end
-
-      validate!
-    end
-
-    private
-
-    def validate!
-      raise 'Message must be initialized with a String or a non-empty Hash' if empty?
-
-      raise 'Log object must have a \'message\' property' unless self[:message]
-
-      raise 'The \'message\' property of the log object must not be empty' if self[:message].strip.empty?
     end
   end
 end

data/lib/twiglet/validation_schema.json

@@ -0,0 +1,10 @@
+{
+  "type": "object",
+  "required": ["message"],
+  "properties": {
+    "message": {
+      "type": "string",
+      "minLength": 1
+    }
+  }
+}

data/lib/twiglet/validator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'json-schema'
+require 'json'
+
+module Twiglet
+  class Validator
+    attr_accessor :custom_error_handler
+
+    def initialize(schema)
+      @schema = 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
+      custom_error_handler.call(e)
+    end
+  end
+end

data/lib/twiglet/version.rb

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

data/test/formatter_test.rb

@@ -3,11 +3,12 @@
 require 'minitest/autorun'
 require 'json'
 require_relative '../lib/twiglet/formatter'
+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)
+    @formatter = Twiglet::Formatter.new('petshop', now: @now, validator: Twiglet::Validator.new({}))
   end
 
   it 'initializes an instance of a Ruby Logger Formatter' do

data/test/logger_test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'minitest/autorun'
+require 'minitest/mock'
 require_relative '../lib/twiglet/logger'
 
 LEVELS = [
@@ -42,11 +43,17 @@ describe Twiglet::Logger do
 
   describe 'JSON logging' do
     it 'should throw an error with an empty message' do
-      assert_raises RuntimeError do
+      assert_raises JSON::Schema::ValidationError, "The property '#/message' was not of a minimum string length of 1" do
         @logger.info({ message: '' })
       end
     end
 
+    it 'should throw an error if message is missing' do
+      assert_raises JSON::Schema::ValidationError, "The property '#/message' was not of a minimum string length of 1" do
+        @logger.info({ foo: 'bar' })
+      end
+    end
+
     it 'should log mandatory attributes' do
       @logger.error({ message: 'Out of pets exception' })
       actual_log = read_json(@buffer)
@@ -239,7 +246,7 @@ describe Twiglet::Logger do
 
   describe 'text logging' do
     it 'should throw an error with an empty message' do
-      assert_raises RuntimeError do
+      assert_raises JSON::Schema::ValidationError, "The property '#/message' was not of a minimum string length of 1" do
         @logger.info('')
       end
     end
@@ -352,6 +359,27 @@ describe Twiglet::Logger do
     end
   end
 
+  describe 'configuring error response' do
+    it 'blows up by default' do
+      assert_raises JSON::Schema::ValidationError,
+                    "The property '#/message' of type boolean did not match the following type: string" do
+        @logger.debug(message: true)
+      end
+    end
+
+    it 'silently swallows errors when configured to do so' do
+      mock = Minitest::Mock.new
+
+      @logger.configure_validation_error_response do |_e|
+        mock.notify_error("Logging schema validation error")
+      end
+
+      mock.expect(:notify_error, nil, ["Logging schema validation error"])
+      nonconformant_log = { message: true }
+      @logger.debug(nonconformant_log)
+    end
+  end
+
   private
 
   def read_json(buffer)

data/test/message_test.rb

@@ -2,24 +2,6 @@ require 'minitest/autorun'
 require_relative '../lib/twiglet/message'
 
 describe Twiglet::Message do
-  it 'raises if message is empty' do
-    assert_raises RuntimeError do
-      Twiglet::Message.new('   ')
-    end
-  end
-
-  it 'raises if message is not provided' do
-    assert_raises RuntimeError do
-      Twiglet::Message.new(foo: 'bar')
-    end
-  end
-
-  it 'raises on unrecognized inputs' do
-    assert_raises RuntimeError do
-      Twiglet::Message.new(OpenStruct.new(message: 'hello'))
-    end
-  end
-
   it 'returns a message hash from a string' do
     assert_equal Twiglet::Message.new('hello, world'), { message: 'hello, world' }
   end

data/test/validator_test.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require_relative '../lib/twiglet/validator'
+
+describe Twiglet::Validator do
+  let(:valid)
+
+  before do
+    schema = {
+      "type" => "object",
+      "required" => ["message"],
+      "properties" => {
+        "message" => {
+          "type" => "string"
+        }
+      }
+    }
+
+    @validator = Twiglet::Validator.new(schema)
+  end
+
+  it 'does not raise when validation passes' do
+    assert_equal(@validator.validate({ message: 'this is my message', foo: 'bar' }), true)
+  end
+
+  it 'raises when validation fails' do
+    assert_raises JSON::Schema::ValidationError do
+      @validator.validate({ message: true })
+    end
+  end
+
+  it 'is a no-op when validator is configured to swallow errors' do
+    @validator.custom_error_handler = ->(e) { puts e }
+
+    assert_nil(@validator.validate({ message: true }))
+  end
+end

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.0.6
+  version: 3.1.3
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
-dependencies: []
+date: 2021-02-16 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"
@@ -42,12 +112,15 @@ files:
 - lib/twiglet/formatter.rb
 - lib/twiglet/logger.rb
 - lib/twiglet/message.rb
+- lib/twiglet/validation_schema.json
+- lib/twiglet/validator.rb
 - lib/twiglet/version.rb
 - test/formatter_test.rb
 - test/hash_extensions_test.rb
 - test/logger_test.rb
 - test/message_test.rb
 - test/test_coverage.rb
+- test/validator_test.rb
 - twiglet.gemspec
 homepage: https://github.com/simplybusiness/twiglet-ruby
 licenses: