twiglet 3.0.2 → 3.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caa9b2047bc7a8ca268f0ba1b84a983b110234769db49c549f1d61fb21bbc730
-  data.tar.gz: c3eaa4009b34d4d01b4b0b7a90fc5ba1b2e760abb7b137fd92f4679c22de57ae
+  metadata.gz: aadbe159aee695cfd454e0f006ab5eab2b3c06d01ecaa80d3f6b1b69c0d21d5e
+  data.tar.gz: 53907b03fb29af1fe41d8262619a6d5c84dab554b4e309d7336d969c11600a44
 SHA512:
-  metadata.gz: d3ab7e57c1e99ac93349dcc2e75787e08d5f5c5fc6e242a03f286f17ae892ff38f759eacff900bbec46508fe559c5172958e1b94452e6af807e239ae195e29f2
-  data.tar.gz: 4c57202266f609af726de4cc9a60b38f9bcc414dbcdfb5ce26e7f39bb18ebb07f8292310a9fa6a853a49ab9a2f18d53837d77f2321c5046224884aa0b72c5f99
+  metadata.gz: d5e68a4b343c861c7236e4a301365d738221bbe5eb0b23426e3cba84fad2358046d1b868bef5248c1c3398f4c2cfd132445259b7db976937024f73663699c2d4
+  data.tar.gz: 28b619fd981103d5baea53d07e032e52e21cf88e84b5229d1ca1ff61cedc284d6825ebf26fb977f060d3af4c34f276b8a69c733e66321952a726d452dc82164b

data/.github/dependabot.yml

@@ -0,0 +1,22 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "07:00"
+    open-pull-requests-limit: 99
+    labels:
+      - dependencies
+    ignore:
+      - dependency-name: simplecov
+        versions:
+          - ">= 0.18"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "07:00"
+    open-pull-requests-limit: 99
+    labels:
+      - dependencies

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.6, 2.7]
+        ruby-version: [2.6, 2.7, 3.0]
 
     steps:
     - uses: actions/checkout@v2

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@v1
+      - uses: simplybusiness/version-forget-me-not@v2
         env:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION_FILE_PATH: "lib/twiglet/version.rb"

data/.github/workflows/version-update.yml

@@ -0,0 +1,15 @@
+name: "version update action"
+on:
+  issue_comment:
+    types: [created]
+jobs:
+  pr_commented:
+    runs-on: ubuntu-20.04
+    if: startsWith(github.event.comment.body, '/dobby')
+
+    steps:
+      - name: 'bump version'
+        uses: simplybusiness/dobby@v1.0.0
+        env:
+          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION_FILE_PATH: lib/twiglet/version.rb

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

@@ -7,28 +7,32 @@ PORT = 8080
 logger = Twiglet::Logger.new('petshop')
 
 # Start our petshop
-logger.info({
-  event: {
-    action: 'startup'
-  },
-  message: "Ready to go, listening on port #{PORT}",
-  server: {
-    port: PORT
+logger.info(
+  {
+    event: {
+      action: 'startup'
+    },
+    message: "Ready to go, listening on port #{PORT}",
+    server: {
+      port: PORT
+    }
   }
-})
+)
 
 # Use text logging
 logger.info("Ready to go, listening on port #{PORT}")
 #
 # We get a request
-request_logger = logger.with({
-  event: {
-    action: 'HTTP request'
-  },
-  trace: {
-    id: '126bb6fa-28a2-470f-b013-eefbf9182b2d'
+request_logger = logger.with(
+  {
+    event: {
+      action: 'HTTP request'
+    },
+    trace: {
+      id: '126bb6fa-28a2-470f-b013-eefbf9182b2d'
+    }
   }
-})
+)
 
 # Oh noes!
 db_err = StandardError.new('Connection timed-out')
@@ -36,17 +40,19 @@ db_err = StandardError.new('Connection timed-out')
 request_logger.error({ message: 'DB connection failed.' }, db_err) if db_err
 
 # We return an error to the requester
-request_logger.info({
-  message: 'Internal Server Error',
-  http: {
-    request: {
-      method: 'get'
-    },
-    response: {
-      status_code: 500
+request_logger.info(
+  {
+    message: 'Internal Server Error',
+    http: {
+      request: {
+        method: 'get'
+      },
+      response: {
+        status_code: 500
+      }
     }
   }
-})
+)
 
 # Logging with an empty message is an anti-pattern and is therefore forbidden
 # Both of the following lines would throw an error

data/examples/rack/request_logger_test.rb

@@ -15,10 +15,12 @@ describe RequestLogger do
   end
 
   it 'logs the request data' do
-    request.get("/some/path?some_var=1", 'HTTP_ACCEPT' => 'application/json',
-                                         'REMOTE_ADDR' => '0.0.0.0',
-                                         'HTTP_VERSION' => 'HTTP/1.1',
-                                         'HTTP_USER_AGENT' => 'Mozilla/5.0 (Macintosh)')
+    request.get(
+      "/some/path?some_var=1", 'HTTP_ACCEPT' => 'application/json',
+                               'REMOTE_ADDR' => '0.0.0.0',
+                               'HTTP_VERSION' => 'HTTP/1.1',
+                               'HTTP_USER_AGENT' => 'Mozilla/5.0 (Macintosh)'
+    )
     log = JSON.parse(output.string)
 
     expected_log = {
@@ -55,7 +57,7 @@ describe RequestLogger do
   end
 
   it 'does not log PII' do
-    request.post("/user/info", input_data: {credit_card_no: '1234'})
+    request.post("/user/info", input_data: { credit_card_no: '1234' })
     log = output.string
     assert_includes log, "POST: /user/info"
     refute_includes log, 'credit_card_no'

data/lib/twiglet/logger.rb

@@ -33,9 +33,9 @@ module Twiglet
     def error(message = nil, error = nil, &block)
       if error
         error_fields = {
-          'error': {
-            'type': error.class,
-            'message': error.message
+          error: {
+            type: error.class,
+            message: error.message
           }
         }
         add_stack_trace(error_fields, error)
@@ -46,11 +46,13 @@ module Twiglet
     end
 
     def with(default_properties)
-      Logger.new(@service_name,
-                 default_properties: default_properties,
-                 now: @now,
-                 output: @output,
-                 level: @level)
+      Logger.new(
+        @service_name,
+        default_properties: default_properties,
+        now: @now,
+        output: @output,
+        level: @level
+      )
     end
 
     alias_method :warning, :warn

data/lib/twiglet/message.rb

@@ -1,11 +1,14 @@
 module Twiglet
   class Message < Hash
     def initialize(msg)
+      super
       case msg
       when String
         self[:message] = msg
       when Hash
         replace(msg.transform_keys!(&:to_sym))
+      else
+        super(msg)
       end
 
       validate!

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -18,9 +18,11 @@ describe Twiglet::Logger do
   before do
     @now = -> { Time.utc(2020, 5, 11, 15, 1, 1) }
     @buffer = StringIO.new
-    @logger = Twiglet::Logger.new('petshop',
-                                  now: @now,
-                                  output: @buffer)
+    @logger = Twiglet::Logger.new(
+      'petshop',
+      now: @now,
+      output: @buffer
+    )
   end
 
   it 'should throw an error with an empty service name' do
@@ -30,8 +32,10 @@ describe Twiglet::Logger do
   end
 
   it 'conforms to the standard Ruby Logger API' do
-    [:debug, :debug?, :info, :info?, :warn, :warn?, :fatal, :fatal?, :error, :error?,
-     :level, :level=, :sev_threshold=].each do |call|
+    [
+      :debug, :debug?, :info, :info?, :warn, :warn?, :fatal, :fatal?, :error, :error?,
+      :level, :level=, :sev_threshold=
+    ].each do |call|
       assert @logger.respond_to?(call), "Logger does not respond to #{call}"
     end
   end
@@ -39,12 +43,12 @@ describe Twiglet::Logger do
   describe 'JSON logging' do
     it 'should throw an error with an empty message' do
       assert_raises RuntimeError do
-        @logger.info({message: ''})
+        @logger.info({ message: '' })
       end
     end
 
     it 'should log mandatory attributes' do
-      @logger.error({message: 'Out of pets exception'})
+      @logger.error({ message: 'Out of pets exception' })
       actual_log = read_json(@buffer)
 
       expected_log = {
@@ -65,9 +69,13 @@ describe Twiglet::Logger do
     end
 
     it 'should log the provided message' do
-      @logger.error({event:
-                       {action: 'exception'},
-                     message: 'Emergency! Emergency!'})
+      @logger.error(
+        {
+          event:
+                                 { action: 'exception' },
+          message: 'Emergency! Emergency!'
+        }
+      )
       log = read_json(@buffer)
 
       assert_equal 'exception', log[:event][:action]
@@ -82,17 +90,19 @@ describe Twiglet::Logger do
         service: {
           type: 'shop'
         },
-        request: {method: 'get'},
-        response: {status_code: 200}
+        request: { method: 'get' },
+        response: { status_code: 200 }
       }
 
       output = StringIO.new
-      logger = Twiglet::Logger.new('petshop',
-                                   now: @now,
-                                   output: output,
-                                   default_properties: extra_properties)
-
-      logger.error({message: 'GET /cats'})
+      logger = Twiglet::Logger.new(
+        'petshop',
+        now: @now,
+        output: output,
+        default_properties: extra_properties
+      )
+
+      logger.error({ message: 'GET /cats' })
       log = read_json output
 
       assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
@@ -104,17 +114,21 @@ describe Twiglet::Logger do
 
     it "should be able to add properties with '.with'" do
       # Let's add some context to this customer journey
-      purchase_logger = @logger.with({
-        trace: {id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'},
-        customer: {full_name: 'Freda Bloggs'},
-        event: {action: 'pet purchase'}
-      })
+      purchase_logger = @logger.with(
+        {
+          trace: { id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb' },
+          customer: { full_name: 'Freda Bloggs' },
+          event: { action: 'pet purchase' }
+        }
+      )
 
       # do stuff
-      purchase_logger.info({
-        message: 'customer bought a dog',
-        pet: {name: 'Barker', species: 'dog', breed: 'Bitsa'}
-      })
+      purchase_logger.info(
+        {
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', species: 'dog', breed: 'Bitsa' }
+        }
+      )
 
       log = read_json @buffer
 
@@ -135,8 +149,8 @@ describe Twiglet::Logger do
     end
 
     it "should log multiple messages properly" do
-      @logger.debug({message: 'hi'})
-      @logger.info({message: 'there'})
+      @logger.debug({ message: 'hi' })
+      @logger.info({ message: 'there' })
 
       expected_output =
         '{"ecs":{"version":"1.5.0"},"@timestamp":"2020-05-11T15:01:01.000Z",'\
@@ -174,7 +188,7 @@ describe Twiglet::Logger do
 
     LEVELS.each do |attrs|
       it "should correctly log level when calling #{attrs[:method]}" do
-        @logger.public_send(attrs[:method], {message: 'a log message'})
+        @logger.public_send(attrs[:method], { message: 'a log message' })
         actual_log = read_json(@buffer)
 
         assert_equal attrs[:level], actual_log[:log][:level]
@@ -188,7 +202,7 @@ describe Twiglet::Logger do
       begin
         1 / 0
       rescue StandardError => e
-        @logger.error({message: 'Artificially raised exception'}, e)
+        @logger.error({ message: 'Artificially raised exception' }, e)
       end
 
       actual_log = read_json(@buffer)
@@ -201,7 +215,7 @@ describe Twiglet::Logger do
 
     it 'should log an error without backtrace' do
       e = StandardError.new('Connection timed-out')
-      @logger.error({message: 'Artificially raised exception'}, e)
+      @logger.error({ message: 'Artificially raised exception' }, e)
 
       actual_log = read_json(@buffer)
 
@@ -284,13 +298,15 @@ describe Twiglet::Logger do
 
   describe 'dotted keys' do
     it 'should be able to convert dotted keys to nested objects' do
-      @logger.debug({
-        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-        message: 'customer bought a dog',
-        "pet.name": 'Barker',
-        "pet.species": 'dog',
-        "pet.breed": 'Bitsa'
-      })
+      @logger.debug(
+        {
+          "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+          message: 'customer bought a dog',
+          "pet.name": 'Barker',
+          "pet.species": 'dog',
+          "pet.breed": 'Bitsa'
+        }
+      )
       log = read_json(@buffer)
 
       assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
@@ -301,12 +317,14 @@ describe Twiglet::Logger do
     end
 
     it 'should be able to mix dotted keys and nested objects' do
-      @logger.debug({
-        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-        message: 'customer bought a dog',
-        pet: {name: 'Barker', breed: 'Bitsa'},
-        "pet.species": 'dog'
-      })
+      @logger.debug(
+        {
+          "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+          message: 'customer bought a dog',
+          pet: { name: 'Barker', breed: 'Bitsa' },
+          "pet.species": 'dog'
+        }
+      )
       log = read_json(@buffer)
 
       assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]

data/test/test_coverage.rb

@@ -7,7 +7,11 @@ SimpleCov.start do
   if ENV['CI']
     formatter SimpleCov::Formatter::SimpleFormatter
   else
-    formatter SimpleCov::Formatter::MultiFormatter.new([SimpleCov::Formatter::SimpleFormatter,
-                                                        SimpleCov::Formatter::HTMLFormatter])
+    formatter SimpleCov::Formatter::MultiFormatter.new(
+      [
+        SimpleCov::Formatter::SimpleFormatter,
+        SimpleCov::Formatter::HTMLFormatter
+      ]
+    )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.8
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -18,9 +18,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/dependabot.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"