twiglet 2.2.3 → 2.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd959654140f88727254fcf4d660dd017e8a00e12f3a68eabf6359246f7aeb97
-  data.tar.gz: ab14bddf0d5b9138634000a0fad1e7d4fd5d13d56e2e604aef87a74e2c0c7d78
+  metadata.gz: bc5514d2c3e51632a86e09ee38aab95d2b32c3d9337b8ce5d0677d9de8b41899
+  data.tar.gz: bd223470da816efcea468f339042986bc62ad76f348607ee76bd12829d9a8b5f
 SHA512:
-  metadata.gz: 1effc27ff4f08c25d1b92789e7b7937da24d652c922bf0bc404a4ca106d5c670897b0e24bbee17ee0fd1d1e584457bba06034e5fb0432edf6d517cd6dc3f801b
-  data.tar.gz: 5e6a270d224fb73e077670036b2540a23787ac4d9cde08c8aa0912c2c94e2ec392e49b8d39e134d13c4a76b3e6294729b5241ac651504e9099e69509b8ddf044
+  metadata.gz: 346e3c5209e5a6b785eac0535920b5f09ad18ac02f8db7b2027fe3d13e6f89e9f300bfe02be1eebbf97bb39e723e6fd21f2ec053d91690aa31a1d3f059c96c40
+  data.tar.gz: 2f516abc83aaa75ff8389eb9560380cf88cdad547773b63429716f985e120433fcf55c188bd023ef0413829ccd14c498cc150ca748632ee5b1ddcad6a3d7b36b

data/.github/CODEOWNERS

@@ -1,3 +1,4 @@
 # Add your project owners info here
 # More information: https://help.github.com/articles/about-codeowners/
-* @simplybusiness/application-tooling
+* @simplybusiness/silversmiths 
+

data/.github/workflows/gem-publish.yml

@@ -0,0 +1,26 @@
+name: Publish Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          version: 2.6.x
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.github/workflows/ruby.yml

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

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   simplycop: .simplycop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.5
   Rails:
     Enabled: false
   Documentation:

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

@@ -50,6 +50,9 @@ module Twiglet
 
     def log_message(level, message:)
       base_message = {
+        ecs: {
+          version: '1.5.0'
+        },
         "@timestamp": @now.call.iso8601(3),
         service: {
           name: @service_name

data/lib/twiglet/version.rb

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

data/test/formatter_test.rb

@@ -17,6 +17,9 @@ describe Twiglet::Formatter do
   it 'returns a formatted log from a string message' do
     msg = @formatter.call('warn', nil, nil, 'shop is running low on dog food')
     expected_log = {
+      "ecs" => {
+        "version" => '1.5.0'
+      },
       "@timestamp" => '2020-05-11T15:01:01.000Z',
       "service" => {
         "name" => 'petshop'

data/test/logger_test.rb

@@ -49,6 +49,9 @@ describe Twiglet::Logger do
 
       expected_log = {
         message: 'Out of pets exception',
+        ecs: {
+          version: '1.5.0'
+        },
         "@timestamp": '2020-05-11T15:01:01.000Z',
         service: {
           name: 'petshop'
@@ -136,10 +139,10 @@ describe Twiglet::Logger do
       @logger.info({message: 'there'})
 
       expected_output =
-        '{"@timestamp":"2020-05-11T15:01:01.000Z",'\
+        '{"ecs":{"version":"1.5.0"},"@timestamp":"2020-05-11T15:01:01.000Z",'\
         '"service":{"name":"petshop"},"log":{"level":"debug"},"message":"hi"}'\
         "\n"\
-        '{"@timestamp":"2020-05-11T15:01:01.000Z",'\
+        '{"ecs":{"version":"1.5.0"},"@timestamp":"2020-05-11T15:01:01.000Z",'\
         '"service":{"name":"petshop"},"log":{"level":"info"},"message":"there"}'\
         "\n"\
 
@@ -251,6 +254,9 @@ describe Twiglet::Logger do
 
       expected_log = {
         message: 'Out of pets exception',
+        ecs: {
+          version: '1.5.0'
+        },
         "@timestamp": '2020-05-11T15:01:01.000Z',
         service: {
           name: 'petshop'

data/twiglet.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files            = `git ls-files -- {test}/*`.split("\n")
 
   gem.require_paths         = ['lib']
-  gem.required_ruby_version = '>= 2.6'
+  gem.required_ruby_version = '>= 2.5'
 
   gem.license               = 'Copyright SimplyBusiness'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.7
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/workflows/gem-publish.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -29,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
@@ -49,14 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Twiglet