twiglet 3.0.1 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65c3f0028e0ac918736f63a2475fb45231586d51256a8778d4730ebd7792675c
-  data.tar.gz: 98d3607d5e1aad68f00d0ced7ccce24f0dba0c8b3eede84620a4a37a102a9849
+  metadata.gz: f5cdde3c0d71c1d9749653946057baea5d50178d32c3345aaec2969da0a08b81
+  data.tar.gz: cbf3b20dadb27002fbfe6f9448d515f086b59c9b6d9321e01090860edf6aad3e
 SHA512:
-  metadata.gz: '0418346dbb4f5d486062caa13b7d1859a96309d00061b3e818563c9c399601f73035e2c89c64888e168d2a040fbb96c18a47e150c505859a58c067cfe46fe76f'
-  data.tar.gz: 9437cae3f2662746cd059a660f9e0884c5c0edd7e56de77771d81678c01f6e55006e048b50bd44f7a99d240b9a5d3527b70a15528d0f4e8711ca2e0954c73235
+  metadata.gz: 47fbf4941a54d8fc6acf5b52f6b0cc3bbf68a0ecc6cb0f7739c595c47b78dd23d1a1bf3cfb692c79d915248b1bc9de6b9c45f8f43c902f5bc22675a43256af85
+  data.tar.gz: f65764ec68e251d38ba49eafe44f1b04a62695bc94411f5c1ebb524c3fab498916b65f6905768fbb1c7bdad5dce7124f8e38fa219266cd0a300aadfae84c1162

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

@@ -11,7 +11,7 @@ class RequestLogger
     [status, headers, body]
   rescue StandardError => e
     log_error(env, 500, e)
-    [500, {}, body]
+    raise e
   end
 
   private
@@ -26,24 +26,41 @@ class RequestLogger
     @logger.error(fields, error)
   end
 
+  # https://www.elastic.co/guide/en/ecs/1.5/ecs-field-reference.html
   def get_fields(env, status)
     message = "#{env['REQUEST_METHOD']}: #{env['PATH_INFO']}"
 
     {
-      http: {
-        request: {
-          method: env['REQUEST_METHOD'],
-          server: env['SERVER_NAME'],
-          https_enabled: env['HTTPS'],
-          path: env['PATH_INFO'],
-          query: env['QUERY_STRING']  # Don't log PII query params
-        },
-        response: {
-          status: status,
-          body: { bytes: env['CONTENT_LENGTH'] }
-        }
+      http: http_fields(env, status),
+      url: url_fields(env),
+      client: {
+        ip: env['HTTP_TRUE_CLIENT_IP'] || env['REMOTE_ADDR']
+      },
+      user_agent: {
+        original: env['HTTP_USER_AGENT']
       },
       message: message
     }
   end
+
+  def http_fields(env, status)
+    {
+      request: {
+        method: env['REQUEST_METHOD'],
+        mime_type: env['HTTP_ACCEPT']
+      },
+      response: {
+        status: status
+      },
+      version: env['HTTP_VERSION']
+    }
+  end
+
+  def url_fields(env)
+    {
+      path: env['PATH_INFO'],
+      query: env['QUERY_STRING'],
+      domain: env['SERVER_NAME']
+    }
+  end
 end

data/examples/rack/request_logger_test.rb

@@ -1,4 +1,5 @@
 require 'minitest/autorun'
+require_relative '../../lib/twiglet/logger'
 require_relative './request_logger'
 require 'rack'
 
@@ -14,27 +15,49 @@ describe RequestLogger do
   end
 
   it 'logs the request data' do
-    request.get("/some/path?some_var=1")
+    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)
-    http_body = {
-      "request" => {
-        "https_enabled" => "off",
-        "method" => "GET",
+
+    expected_log = {
+      "log" => { "level" => "info" },
+      "http" => {
+        "request" => {
+          "method" => "GET",
+          "mime_type" => 'application/json'
+        },
+        "response" => {
+          "status" => 200
+        },
+        "version" => 'HTTP/1.1'
+      },
+      "url" => {
         "path" => "/some/path",
         "query" => "some_var=1",
-        "server" => "example.org"
+        "domain" => "example.org"
+      },
+      "client" => {
+        'ip' => '0.0.0.0'
       },
-      "response" => {
-        "status" => 200,
-        "body" => { "bytes" => "0" }
-      }
+      "user_agent" => {
+        "original" => 'Mozilla/5.0 (Macintosh)'
+      },
+      "message" => "GET: /some/path"
     }
-    assert_equal http_body, log["http"]
-    assert_equal "GET: /some/path", log["message"]
+
+    assert_equal(log['log'], expected_log['log'])
+    assert_equal(log['http'], expected_log['http'])
+    assert_equal(log['url'], expected_log['url'])
+    assert_equal(log['user_agent'], expected_log['user_agent'])
+    assert_equal(log['message'], expected_log['message'])
   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'
@@ -42,10 +65,12 @@ describe RequestLogger do
   end
 
   it 'logs an error message when a request is bad' do
-    bad_request.get("/some/path")
+    -> { bad_request.get("/some/path") }.must_raise StandardError
     log = JSON.parse(output.string)
-    assert_equal 'error', log['log']['level']
-    assert_equal 'some exception', log['error']['message']
+    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'
   end
 end
 

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

@@ -6,6 +6,8 @@ module Twiglet
         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.1'
+  VERSION = '3.0.6'
 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.1
+  version: 3.0.6
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2021-02-10 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"
@@ -66,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Twiglet