vault-tools 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9265591e92a631fd1b996644985ee742c622ac3259412dc5b7ca2e6ff3c7aebe
-  data.tar.gz: b01e51fe465c1a001685bd909fcbfec83757005cad808b34918328af0fca4906
+  metadata.gz: 760a137b1c3e642183950c4e765d3ec9b60c327178b2faac45ff7048d94f9d82
+  data.tar.gz: 6743dd1b28722d7995215b8d9d6a9fc615572a97447fc64df5666d3f452bbe89
 SHA512:
-  metadata.gz: 3910495873e72ce2299d303118e790fa42f22ec6acd0fe440d2d1ca595a394e50afc30e58751a352db9b5ed87f6448aa88db042ab8059bee6b9b58da53376df7
-  data.tar.gz: 4dd78be8dec844bb89a2729309ffe80f8084736c9535e0d74ecf8a352cffde2fa9f548cc303443732aa0e750ae5c0074257adeae54e28f38c72548c804dab6d8
+  metadata.gz: f0b647bf7ab47175b9337434f2c9064f4ee89318f2df3aebb3e2354a47fde6edcab89a713a864e6b94d32651d755a267ea5ea502b197481d6ba8fb7f3b05183b
+  data.tar.gz: c2a4280ee1a422e1a80016afaa62b22ee3c7489bcc4a5b510b2aa485267bbf9564fb34aa1f6c9ce82593ceef698a11e44e5dc95a19221a1068f6306fd02033a7

data/.circleci/config.yml

@@ -0,0 +1,15 @@
+version: 2.1
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7.1
+    
+    steps:
+      - checkout
+      - run: export BUNDLE_GEMFILE=$PWD/Gemfile
+      - run: ruby --version
+      - run: gem update --system
+      - run: gem install bundler -v '< 2'
+      - run: bundle install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
+      - run: bundle exec rake

data/CODEOWNERS

@@ -0,0 +1,2 @@
+# Comment line immediately above ownership line is reserved for related gus information. Please be careful while editing.
+#ECCN:Open Source

data/Gemfile

@@ -4,13 +4,12 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rake', '~> 12.3'
+  gem 'rake', '~> 13.0'
   gem 'shotgun', '~> 0.9.2'
   gem 'yard-sinatra'
 end
 
 group :test do
-  gem 'guard-minitest'
   gem 'minitest-around'
-  gem 'vault-test-tools', '~> 1.0.0'
+  gem 'vault-test-tools', '~> 1.1.0'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vault-tools (2.0.0)
+    vault-tools (2.1.1)
       aws-sdk-s3 (~> 1.0)
       coderay
       excon
@@ -16,74 +16,75 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-eventstream (1.0.1)
-    aws-partitions (1.127.0)
-    aws-sdk-core (3.44.1)
-      aws-eventstream (~> 1.0)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.0)
+    aws-eventstream (1.1.1)
+    aws-partitions (1.491.0)
+    aws-sdk-core (3.119.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.13.0)
-      aws-sdk-core (~> 3, >= 3.39.0)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-s3 (1.30.0)
-      aws-sdk-core (~> 3, >= 3.39.0)
+    aws-sdk-kms (1.46.0)
+      aws-sdk-core (~> 3, >= 3.119.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.99.0)
+      aws-sdk-core (~> 3, >= 3.119.0)
       aws-sdk-kms (~> 1)
-      aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.0.3)
-    coderay (1.1.2)
-    dotenv (2.5.0)
-    excon (0.62.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.4)
+      aws-eventstream (~> 1, >= 1.0.2)
+    coderay (1.1.3)
+    dotenv (2.7.6)
+    excon (0.85.0)
     fernet (2.0)
       valcro (= 0.1)
-    guard-compat (1.2.1)
-    guard-minitest (2.4.6)
-      guard-compat (~> 1.2)
-      minitest (>= 3.0)
     jmespath (1.4.0)
-    logfmt (0.0.8)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
+    logfmt (0.0.9)
+    method_source (1.0.0)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
     minitest-around (0.5.0)
       minitest (~> 5.0)
-    multi_json (1.13.1)
-    mustermann (1.0.3)
-    nokogiri (1.10.1)
-      mini_portile2 (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.6)
-    rack-protection (2.0.5)
+    multi_json (1.15.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nokogiri (1.12.3)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-protection (2.0.8.1)
       rack
     rack-ssl-enforcer (0.2.9)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rake (12.3.2)
-    rdoc (6.1.1)
+    rake (13.0.6)
+    rdoc (6.3.2)
     rollbar (2.18.2)
       multi_json
     rr (1.2.1)
-    scrolls (0.9.0)
+    ruby2_keywords (0.0.5)
+    scrolls (0.9.1)
     shotgun (0.9.2)
       rack (>= 1.0)
-    sinatra (2.0.5)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.5)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
-    tilt (2.0.9)
-    uuidtools (2.1.5)
+    tilt (2.0.10)
+    uuidtools (2.2.0)
     valcro (0.1)
-    vault-test-tools (1.0.0)
+    vault-test-tools (1.1.0)
       logfmt
       minitest (~> 5.11)
       nokogiri
       rack-test (~> 1.1)
-      rr
-      scrolls (= 0.9)
-    yard (0.9.16)
+      rr (~> 1.2)
+      scrolls
+    yard (0.9.26)
     yard-sinatra (1.0.0)
       yard (~> 0.7)
 
@@ -92,16 +93,15 @@ PLATFORMS
 
 DEPENDENCIES
   dotenv
-  guard-minitest
   minitest-around
   pry
-  rake (~> 12.3)
+  rake (~> 13.0)
   rdoc
   shotgun (~> 0.9.2)
-  vault-test-tools (~> 1.0.0)
+  vault-test-tools (~> 1.1.0)
   vault-tools!
   yard
   yard-sinatra
 
 BUNDLED WITH
-   1.17.1
+   2.2.26

data/README.md

@@ -3,7 +3,7 @@
 Tools is the English word for ツール.  Tooling for the Heroku Vault
 team to enable faster bootstrapping for Ruby projects.
 
-[![Build Status](https://travis-ci.org/heroku/vault-tools.png?branch=master)](https://travis-ci.org/heroku/vault-tools)
+[![CircleCI](https://circleci.com/gh/heroku/vault-tools/tree/master.svg?style=shield&circle-token=39ec638ab252a4440ca919f9b09dc258b4459c58)](_https://circleci.com/gh/heroku/vault-tools/tree/master_)
 
 ## Installation
 
@@ -93,3 +93,10 @@ Generate the API documentation:
 ## Releasing
 
     > bundle exec rake release
+
+## Release Notes
+  Version 2.1.1 (2022-01-06):
+    - Added tooling to support metadata tags on request status metrics.
+    - Reverted change to minimum supported ruby version.
+  Version 2.1.0 (2021-08-26):
+    guard-minitest was removed due to it causing problems with the ruby version upgrade. Was not actively used anymore. Hasn't been updated in a long time.

data/lib/vault-tools/log.rb

@@ -20,8 +20,8 @@ module Vault
     # well as classes of HTTP status codes.
     #
     # @param status [Integer] The HTTP status code to record.
-    def self.count_status(status)
-      count("http.#{status}")
+    def self.count_status(status, data)
+      count("http.#{status}", 1, data)
       if status_prefix = status.to_s.match(/\d/)[0]
         count("http.#{status_prefix}xx")
       end

data/lib/vault-tools/pipeline.rb

@@ -16,7 +16,7 @@ module Vault
   class Pipeline
     def self.use(*args)
       @filters ||= []
-      @filters.push *args
+      @filters.push(*args)
     end
 
     def self.filters

data/lib/vault-tools/version.rb

@@ -2,6 +2,6 @@
 
 module Vault
   module Tools
-    VERSION = '2.0.0'
+    VERSION = '2.1.1'
   end
 end

data/lib/vault-tools/web.rb

@@ -53,7 +53,7 @@ module Vault
       # protect! is used
       %w{get put post delete head options path link unlink}.each do |meth|
         define_method "#{meth}_unprotected".to_sym do |path, opts = {}, &block|
-          pattern = compile!(meth.upcase, path, block, opts).first
+          pattern = compile!(meth.upcase, path, block, **opts).first
           set :unprotected_paths, settings.unprotected_paths + [pattern]
           if meth.downcase == 'get'
             conditions = @conditions.dup
@@ -100,12 +100,20 @@ module Vault
     # Start timing the request.
     before do
       @start_request = Time.now
+      # if client sends content_type: application/json which no longer works
+      # https://github.com/puma/puma/compare/4.3.1...4.3.5#commitcomment-39478516
+      #
+      # fixing this here so that we do not break all client users at once
+      if request.env["CONTENT_TYPE"].nil? && request.env["HTTP_CONTENT_TYPE"]
+        request.env["CONTENT_TYPE"] = request.env["HTTP_CONTENT_TYPE"]
+      end
     end
 
     # Log details about the request including how long it took.
     after do
       @action ||= 'unknown'
-      Log.count_status(response.status)
+      @metadata ||= {}
+      Log.count_status(response.status, @metadata.merge(request_path: request.path_info))
       Log.time("http.#{@action}", (Time.now - @start_request) * 1000)
     end
 

data/test/log_test.rb

@@ -31,10 +31,11 @@ class LogTest < Vault::TestCase
 
   # Vault::Log.count_status emits metrics to measure HTTP responses.
   def test_count_status
-    Vault::Log.count_status(201)
-    assert_equal '1', logged_data['count#test-app.http.201']
-    assert_equal '1', logged_data['count#test-app.http.2xx']
-    assert_equal 'test-deploy', logged_data['source']
+    Vault::Log.count_status(201, request_path: '/some/request/path')
+    assert_equal 1, logdata['count#test-app.http.201']
+    assert_equal 1, logdata['count#test-app.http.2xx']
+    assert_equal '/some/request/path', logdata['request_path']
+    assert_equal 'test-deploy', logdata['source']
   end
 
   def test_measure
@@ -115,6 +116,6 @@ class LogTest < Vault::TestCase
     assert_equal 'true', logged_data['A']
     assert_equal 'true', logged_data['B']
     assert_equal 'test-deploy', logged_data['source']
-    assert_match /\d/, logged_data['elapsed']
+    assert_match(/\d/, logged_data['elapsed'])
   end
 end

data/test/web_test.rb

@@ -155,6 +155,7 @@ class WebTest < Vault::TestCase
     head '/'
     assert_equal '1', logged_data['count#test-app.http.200']
     assert_equal '1', logged_data['count#test-app.http.2xx']
+    assert_equal '/', logged_data['request_path']
     assert_equal(200, last_response.status)
   end
 
@@ -246,6 +247,18 @@ class WebTest < Vault::TestCase
     assert_equal request_id, last_response.headers['Request-ID']
   end
 
+  def test_that_metadata_gets_logged
+    mock(Vault::Log).count_status(200, {
+      'user' => 'amanda',
+      'some_flag' => 'true',
+      request_path:  '/logging-test'
+    })
+    app.get '/logging-test' do
+      @metadata = {'user' => 'amanda', 'some_flag' => 'true'}
+    end
+    get '/logging-test'
+  end
+
   def test_that_excon_proxies_request_id
     request_id = 'JKJK-123'
     Excon.stub(

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Chris Continanza
 - Jamu Kakar
 - Kenny Parnell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
@@ -220,9 +220,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".travis.yml"
 - ".yardopts"
+- CODEOWNERS
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -270,7 +271,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -285,9 +286,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Test classes, base web classes, and helpers - oh my!
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.0
-  - 2.5.3
-before_install:
-  - gem install bundler -v '< 2'