rack-logstasher 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d5dadb9e4dfe9709a500d0d95c547473c085fde
-  data.tar.gz: 3bfee07e71c02dc05878c8824a258d86193302b9
+SHA256:
+  metadata.gz: d5094e6e9fe586e95d7dd08699e18c62d0019dee66ad0da6e2da1d6ac6b2d024
+  data.tar.gz: 6bebaffb4cb498b604a78fc3a3505144578c169fd158f464fb321a16201e1668
 SHA512:
-  metadata.gz: 0bdce96aa0baed8c87f6866d2587160830b6431809141d3f184560a3fd6ba8966fbe5309ae1606f9a3bf23a8b31118d9cfd6d33d3017b192839eebc664c3377f
-  data.tar.gz: 71dfb7ba5e1e77a33f2f379feef745d74c693736e292530ab1e5c477e4e5fb591b159cce7560e7d5c6ae75b4d6a42b80576ae971864cba22b5421db8b4d9a03f
+  metadata.gz: 252b77f49678629284adf356cdf662241ec7fcad6f4f773c8c974b51fab8d8c81d814ae32a252deffeb6eb5c48f8ebfcb3a74f8faa976cf45b4f296b48ad9852
+  data.tar.gz: 19451f78071d21aeb47807d6a11c9aaa7a82c8a61f3872db8fc31e30eb26469af1abcfbe332bc46cb433e69076bc184b01c9df67f43d9bdb7cb2a1a409212571

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.6.1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.1
+
+- *Changes logging format* to drop the "@fields" prefix and rename "@tags" to "tags".
+- Updates development dependencies
+
 # 1.0.0
 
 - Add support for Rack 2 (thanks @anicholson https://github.com/alphagov/rack-logstasher/issues/5)

data/Jenkinsfile

@@ -0,0 +1,7 @@
+#!/usr/bin/env groovy
+
+library("govuk")
+
+node {
+  govuk.buildProject()
+}

data/Rakefile

@@ -4,9 +4,3 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-
-require "gem_publisher"
-task :publish_gem do |t|
-  gem = GemPublisher.publish_if_updated("rack-logstasher.gemspec", :rubygems)
-  puts "Published #{gem}" if gem
-end

data/lib/rack/logstasher/logger.rb

@@ -39,7 +39,7 @@ module Rack
           end
         end
 
-        event = LogStash::Event.new('@fields' => data, '@tags' => ['request'])
+        event = LogStash::Event.new(data.merge('tags' => ['request']))
         msg = event.to_json + "\n"
         if @logger.respond_to?(:write)
           @logger.write(msg)

data/lib/rack/logstasher/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module Logstasher
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/rack-logstasher.gemspec

@@ -6,8 +6,8 @@ require 'rack/logstasher/version'
 Gem::Specification.new do |spec|
   spec.name          = "rack-logstasher"
   spec.version       = Rack::Logstasher::VERSION
-  spec.authors       = ["Alex Tomlins"]
-  spec.email         = ["alex.tomlins@digital.cabinet-office.gov.uk"]
+  spec.authors       = ["GOV.UK Dev"]
+  spec.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
   spec.description   = %q{Rack middleware to log requests in logstash json event format.  Like the logstasher gem, but for rack apps.}
   spec.summary       = %q{Rack middleware to log requests in logstash json event format}
   spec.homepage      = "https://github.com/alphagov/rack-logstasher"
@@ -21,9 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack", "~> 2.0"
   spec.add_dependency "logstash-event"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rack-test", "0.6.2"
-  spec.add_development_dependency "rspec", "2.14.1"
-  spec.add_development_dependency "gem_publisher", "1.2.0"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec"
 end

data/spec/logger_spec.rb

@@ -22,12 +22,11 @@ describe "Logger" do
       get "/foo?bar=baz"
 
       log_details = JSON.parse(last_log_line)
-      fields = log_details['@fields']
 
-      expect(fields['method']).to eq('GET')
-      expect(fields['path']).to eq('/foo')
-      expect(fields['query_string']).to eq('bar=baz')
-      expect(fields['request']).to eq('GET /foo?bar=baz ') # env['SERVER_PROTOCOL'] is not set under rack-test
+      expect(log_details['method']).to eq('GET')
+      expect(log_details['path']).to eq('/foo')
+      expect(log_details['query_string']).to eq('bar=baz')
+      expect(log_details['request']).to eq('GET /foo?bar=baz ') # env['SERVER_PROTOCOL'] is not set under rack-test
     end
 
     it "should add request duration" do
@@ -35,16 +34,15 @@ describe "Logger" do
       get "/foo"
 
       log_details = JSON.parse(last_log_line)
-      fields = log_details['@fields']
 
-      expect(fields['duration']).to be_within(5).of(100)
+      expect(log_details['duration']).to be_within(5).of(100)
     end
 
     it "should add a tag of 'request'" do
       get "/foo?bar=baz"
 
       log_details = JSON.parse(last_log_line)
-      expect(log_details['@tags']).to eq(['request'])
+      expect(log_details['tags']).to eq(['request'])
     end
 
     describe "adding extra headers to the log" do
@@ -70,9 +68,8 @@ describe "Logger" do
           get "/something", {}, {"HTTP_FOO" => "bar"}
 
           log_details = JSON.parse(last_log_line)
-          fields = log_details['@fields']
 
-          expect(fields['header_foo']).to eq('bar')
+          expect(log_details['header_foo']).to eq('bar')
         end
 
         it "should not add the key if the header is missing" do
@@ -80,9 +77,8 @@ describe "Logger" do
           get "/something"
 
           log_details = JSON.parse(last_log_line)
-          fields = log_details['@fields']
 
-          expect(fields).not_to have_key('header_foo')
+          expect(log_details).not_to have_key('header_foo')
         end
 
         it "should handle dashes in header name" do
@@ -90,9 +86,8 @@ describe "Logger" do
           get "/something", {}, {"HTTP_VARNISH_ID" => "1234"}
 
           log_details = JSON.parse(last_log_line)
-          fields = log_details['@fields']
 
-          expect(fields['varnish_id']).to eq('1234')
+          expect(log_details['varnish_id']).to eq('1234')
         end
       end
 
@@ -103,9 +98,8 @@ describe "Logger" do
           get "/something"
 
           log_details = JSON.parse(last_log_line)
-          fields = log_details['@fields']
 
-          expect(fields['header_foo']).to eq('bar')
+          expect(log_details['header_foo']).to eq('bar')
         end
 
         it "should not add the key if the header is missing" do
@@ -113,9 +107,8 @@ describe "Logger" do
           get "/something"
 
           log_details = JSON.parse(last_log_line)
-          fields = log_details['@fields']
 
-          expect(fields).not_to have_key('header_foo')
+          expect(log_details).not_to have_key('header_foo')
         end
 
         it "should handle dashes in header name" do
@@ -124,9 +117,8 @@ describe "Logger" do
           get "/something"
 
           log_details = JSON.parse(last_log_line)
-          fields = log_details['@fields']
 
-          expect(fields['cache_status']).to eq('MISS')
+          expect(log_details['cache_status']).to eq('MISS')
         end
 
         it "should match header in a case-insensitive fashion" do
@@ -135,9 +127,8 @@ describe "Logger" do
           get "/something"
 
           log_details = JSON.parse(last_log_line)
-          fields = log_details['@fields']
 
-          expect(fields['cache_status']).to eq('MISS')
+          expect(log_details['cache_status']).to eq('MISS')
         end
       end
     end

data/spec/spec_helper.rb

@@ -10,7 +10,6 @@ Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
-- Alex Tomlins
+- GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2019-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,48 +70,34 @@ dependencies:
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-- !ruby/object:Gem::Dependency
-  name: gem_publisher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
 description: Rack middleware to log requests in logstash json event format.  Like
   the logstasher gem, but for rack apps.
 email:
-- alex.tomlins@digital.cabinet-office.gov.uk
+- govuk-dev@digital.cabinet-office.gov.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -121,10 +107,10 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- jenkins.sh
 - lib/rack/logstasher.rb
 - lib/rack/logstasher/logger.rb
 - lib/rack/logstasher/version.rb
@@ -151,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Rack middleware to log requests in logstash json event format

data/jenkins.sh

@@ -1,58 +0,0 @@
-#!/bin/bash
-
-REPO_NAME=${REPO_NAME:-"alphagov/rack-logstasher"}
-CONTEXT_MESSAGE=${CONTEXT_MESSAGE:-"default"}
-GH_STATUS_GIT_COMMIT=${SCHEMA_GIT_COMMIT:-${GIT_COMMIT}}
-
-function github_status {
-  REPO_NAME="$1"
-  STATUS="$2"
-  MESSAGE="$3"
-  gh-status "$REPO_NAME" "$GH_STATUS_GIT_COMMIT" "$STATUS" -d "Build #${BUILD_NUMBER} ${MESSAGE}" -u "$BUILD_URL" -c "$CONTEXT_MESSAGE" >/dev/null
-}
-
-function error_handler {
-  trap - ERR # disable error trap to avoid recursion
-  local parent_lineno="$1"
-  local message="$2"
-  local code="${3:-1}"
-  if [[ -n "$message" ]] ; then
-    echo "Error on or near line ${parent_lineno}: ${message}; exiting with status ${code}"
-  else
-    echo "Error on or near line ${parent_lineno}; exiting with status ${code}"
-  fi
-  github_status "$REPO_NAME" error "errored on Jenkins"
-  exit "${code}"
-}
-
-trap 'error_handler ${LINENO}' ERR
-github_status "$REPO_NAME" pending "is running on Jenkins"
-
-# Cleanup anything left from previous test runs
-git clean -fdx
-
-# Try to merge master into the current branch, and abort if it doesn't exit
-# cleanly (ie there are conflicts). This will be a noop if the current branch
-# is master.
-git merge --no-commit origin/master || git merge --abort
-
-# Bundle and run tests against multiple ruby versions
-for version in 2.3 2.2; do
-  rm -f Gemfile.lock
-  export RBENV_VERSION=$version
-  echo "Running tests under ruby $version"
-  bundle install --path "${HOME}/bundles/${JOB_NAME}"
-
-  if ! bundle exec rake ${TEST_TASK:-"default"}; then
-    github_status "$REPO_NAME" failure "failed on Jenkins"
-    exit 1
-  fi
-done
-unset RBENV_VERSION
-
-if [[ -n "$PUBLISH_GEM" ]]; then
-  bundle install --path "${HOME}/bundles/${JOB_NAME}"
-  bundle exec rake publish_gem --trace
-fi
-
-github_status "$REPO_NAME" success "succeeded on Jenkins"