twiglet 2.2.2 → 2.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bd7e1ea9d6464abb4dcb96e8d2679ce6c82ebc289c55cb5989d8f8f657f065f
-  data.tar.gz: 2b2d8e963cf250c0b746dd9d56c40368e31f67b1deaf6cd63c9dee9a731ce804
+  metadata.gz: b6b403959c8c42d8942d17af72a53419a68b8a90c0a805fbdec6703aa4e86d95
+  data.tar.gz: 7c99b71016b8f41ab0d82cfedcb376dd5704c77e1bdb7a00a99f48a89d1b2666
 SHA512:
-  metadata.gz: 8277fd64f609bb4edbf6c95e0f97dc56784a1ea63415c1b261dd9649a69fd6cfee54abbb0c91dfb2232f78f0a14b9c539592d4ca58d57d566350f2a0dbceb648
-  data.tar.gz: e9daae207235db6582162e7d2682cf69ea59e5dc09796b7d804bed6f31775ff07ceaff4b38518dd7c6d6a1ec40759c20dadcbebd388417187bcccb66c09fe793
+  metadata.gz: e22959d3b8796813b6f4b789ae00cf8629b83b14b31a4f525babc3718d7462c93e961391f3322c39a15bd26d08a38194cd1dd6d025d5c4871ada864be4e52c5b
+  data.tar.gz: bcf49062251a7b68b20ef559c124e04928593fc5a004ad21cbfd3262a716f382bcc3b462ca338bfd628796e5c40d14bf4c543d430f4e9d7c542a6201a7639f2b

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/README.md

@@ -22,7 +22,9 @@ A hash can optionally be passed in as a keyword argument for `default_properties
 
 You may also provide an optional `output` keyword argument which should be an object with a `puts` method - like `$stdout`.
 
-Lastly, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
+In addition, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
+
+Lastly, you may provide the optional keyword argument `level` to initialize the logger with a severity threshold. Alternatively, the threshold can be updated at runtime by calling the `level` instance method.
 
 The defaults for both `output` and `now` should serve for most uses, though you may want to override them for testing as we have done [here](test/logger_test.rb).
 

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

@@ -14,17 +14,19 @@ module Twiglet
       service_name,
       default_properties: {},
       now: -> { Time.now.utc },
-      output: $stdout
+      output: $stdout,
+      level: Logger::DEBUG
     )
       @service_name = service_name
       @now = now
       @output = output
+      @level = level
 
       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)
+      super(output, formatter: formatter, level: level)
     end
 
     def error(message = {}, error = nil, &block)
@@ -45,7 +47,8 @@ module Twiglet
       Logger.new(@service_name,
                  default_properties: default_properties,
                  now: @now,
-                 output: @output)
+                 output: @output,
+                 level: @level)
     end
 
     alias_method :warning, :warn

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '2.2.2'
+  VERSION = '2.3.6'
 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'
@@ -305,6 +311,10 @@ describe Twiglet::Logger do
         assert_equal args[:level], @logger.level
       end
     end
+
+    it 'initializes the logger with the provided level' do
+      assert_equal Logger::WARN, Twiglet::Logger.new('petshop', level: :warn).level
+    end
   end
 
   private

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.2
+  version: 2.3.6
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-10 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"
@@ -49,14 +50,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.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Twiglet