twiglet 2.3.6 → 2.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6b403959c8c42d8942d17af72a53419a68b8a90c0a805fbdec6703aa4e86d95
-  data.tar.gz: 7c99b71016b8f41ab0d82cfedcb376dd5704c77e1bdb7a00a99f48a89d1b2666
+  metadata.gz: bc5514d2c3e51632a86e09ee38aab95d2b32c3d9337b8ce5d0677d9de8b41899
+  data.tar.gz: bd223470da816efcea468f339042986bc62ad76f348607ee76bd12829d9a8b5f
 SHA512:
-  metadata.gz: e22959d3b8796813b6f4b789ae00cf8629b83b14b31a4f525babc3718d7462c93e961391f3322c39a15bd26d08a38194cd1dd6d025d5c4871ada864be4e52c5b
-  data.tar.gz: bcf49062251a7b68b20ef559c124e04928593fc5a004ad21cbfd3262a716f382bcc3b462ca338bfd628796e5c40d14bf4c543d430f4e9d7c542a6201a7639f2b
+  metadata.gz: 346e3c5209e5a6b785eac0535920b5f09ad18ac02f8db7b2027fe3d13e6f89e9f300bfe02be1eebbf97bb39e723e6fd21f2ec053d91690aa31a1d3f059c96c40
+  data.tar.gz: 2f516abc83aaa75ff8389eb9560380cf88cdad547773b63429716f985e120433fcf55c188bd023ef0413829ccd14c498cc150ca748632ee5b1ddcad6a3d7b36b

data/Rakefile

@@ -2,6 +2,6 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/*_test.rb', 'examples/rack/request_logger_test.rb']
   t.verbose = true
 end

data/examples/rack/example_rack_app.rb

@@ -0,0 +1,17 @@
+require 'twiglet/logger'
+require 'request_logger'
+
+# basic rack application
+class Application
+  def call(_env)
+    status  = 200
+    headers = { "Content-Type" => "text/json" }
+    body    = ["Example rack app"]
+
+    [status, headers, body]
+  end
+end
+
+use RequestLogger, Twiglet::Logger.new('example_app')
+
+run Application.new

data/examples/rack/request_logger.rb

@@ -0,0 +1,49 @@
+# Middleware for logging request logs
+class RequestLogger
+  def initialize(app, logger)
+    @app = app
+    @logger = logger
+  end
+
+  def call(env)
+    status, headers, body = @app.call(env)
+    log(env, status)
+    [status, headers, body]
+  rescue StandardError => e
+    log_error(env, 500, e)
+    [500, {}, body]
+  end
+
+  private
+
+  def log(env, status)
+    fields = get_fields(env, status)
+    @logger.info(fields)
+  end
+
+  def log_error(env, status, error)
+    fields = get_fields(env, status)
+    @logger.error(fields, error)
+  end
+
+  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'] }
+        }
+      },
+      message: message
+    }
+  end
+end

data/examples/rack/request_logger_test.rb

@@ -0,0 +1,66 @@
+require 'minitest/autorun'
+require_relative './request_logger'
+require 'rack'
+
+describe RequestLogger do
+  let(:output) { StringIO.new }
+
+  before { output.rewind }
+
+  it 'log should not be empty' do
+    request.get("/some/path")
+    log = output.string
+    refute_empty log
+  end
+
+  it 'logs the request data' do
+    request.get("/some/path?some_var=1")
+    log = JSON.parse(output.string)
+    http_body = {
+      "request" => {
+        "https_enabled" => "off",
+        "method" => "GET",
+        "path" => "/some/path",
+        "query" => "some_var=1",
+        "server" => "example.org"
+      },
+      "response" => {
+        "status" => 200,
+        "body" => { "bytes" => "0" }
+      }
+    }
+    assert_equal http_body, log["http"]
+    assert_equal "GET: /some/path", log["message"]
+  end
+
+  it 'does not log PII' do
+    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'
+    refute_includes log, '1234'
+  end
+
+  it 'logs an error message when a request is bad' do
+    bad_request.get("/some/path")
+    log = JSON.parse(output.string)
+    assert_equal 'error', log['log']['level']
+    assert_equal 'some exception', log['error']['message']
+  end
+end
+
+def request
+  app = ->(env) { [200, env, "app"] }
+  base_request(app)
+end
+
+def bad_request
+  app = Rack::Lint.new ->(_env) { raise StandardError, 'some exception' }
+  base_request(app)
+end
+
+def base_request(app)
+  logger = Twiglet::Logger.new('example', output: output)
+  req_logger = RequestLogger.new(app, logger)
+  Rack::MockRequest.new(req_logger)
+end

data/lib/twiglet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.3.6
+  version: 2.3.7
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -30,6 +30,9 @@ files:
 - README.md
 - Rakefile
 - example_app.rb
+- examples/rack/example_rack_app.rb
+- examples/rack/request_logger.rb
+- examples/rack/request_logger_test.rb
 - lib/hash_extensions.rb
 - lib/twiglet/formatter.rb
 - lib/twiglet/logger.rb