vault-tools 1.0.1 → 2.1.0

data/lib/vault-tools/time.rb

@@ -16,7 +16,7 @@ class Time
   end
 end
 
-class Fixnum
+class Integer
   def weeks
     self.days * 7
   end

data/lib/vault-tools/user.rb

@@ -5,7 +5,7 @@ module Vault
     ID_CAPTURE = /^user(\d+)\@[\w\.]+com$/
     # Convert a user ID into a Heroku user ID.
     #
-    # @param user_id [Fixnum] A user ID.
+    # @param user_id [Integer] A user ID.
     # @return [String] A Heroku ID that uniquely represents the user.
     def self.id_to_hid(user_id)
       "user#{user_id}@heroku.com"
@@ -13,7 +13,7 @@ module Vault
 
     # Convert a user ID into a v5 UUID.
     #
-    # @param user_id [Fixnum] A user ID.
+    # @param user_id [Integer] A user ID.
     # @return [String] A v5 UUID that uniquely represents the user.
     def self.id_to_uuid(user_id)
       url = "https://vault.heroku.com/users/#{user_id}"
@@ -25,7 +25,7 @@ module Vault
     # @param heroku_id [String] A Heroku user ID, such as
     #   `user1234@heroku.com`.
     # @raise [ArgumentError] Raised if a malformed Heroku ID is provided.
-    # @return [Fixnum] The core user ID that uniquely represents the user.
+    # @return [Integer] The core user ID that uniquely represents the user.
     def self.hid_to_id(heroku_id)
       if user_id = heroku_id.slice(ID_CAPTURE, 1)
         user_id.to_i

data/lib/vault-tools/version.rb

@@ -2,6 +2,6 @@
 
 module Vault
   module Tools
-    VERSION = '1.0.1'
+    VERSION = '2.1.0'
   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,11 +100,19 @@ 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
-      Log.count_status(response.status)
+      @action ||= 'unknown'
+      Log.count_status(response.status, request_path: request.path_info)
       Log.time("http.#{@action}", (Time.now - @start_request) * 1000)
     end
 

data/lib/vault-tools.rb

@@ -3,8 +3,8 @@ require "vault-tools/version"
 require 'sinatra/base'
 require 'scrolls'
 require 'rack/ssl-enforcer'
-require 'heroku-api'
 require 'rollbar'
+require 'excon'
 
 # Yes, there's a lot of stuff on STDERR.  But its on
 # stderr and not stdout so you can pipe to /dev/null if
@@ -72,7 +72,6 @@ module Vault
     self.override_global_config
     self.load_shared_config
     self.init_scrolls
-    Tracing.configure
   end
 end
 
@@ -90,9 +89,6 @@ require 'vault-tools/time'
 require 'vault-tools/s3'
 require 'vault-tools/statement_store'
 require 'vault-tools/rollbar_helper'
-require 'vault-tools/tracing/sidekiq_client'
-require 'vault-tools/tracing/sidekiq_server'
-require 'vault-tools/tracing'
 
 Rollbar.configure do |config|
   config.environment = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['APP_ENV'] || ENV['ROLLBAR_ENV'] || 'unassigned'

data/test/config_test.rb

@@ -9,35 +9,6 @@ class ConfigTest < Vault::TestCase
     Config.reset!
   end
 
-  # Config.remote_env uses the Heroku API to read config vars from
-  # other apps.
-  def test_remote_env
-    api_mock = MiniTest::Mock.new
-    api_response = OpenStruct.new(body: {'DATABASE_URL' => 'postgres:///foo'})
-    Heroku::API.stub(:new, api_mock) do
-      api_mock.expect(:get_config_vars, api_response, ['app'])
-      assert_equal('postgres:///foo',
-                   Config.remote_env('app', 'DATABASE_URL'))
-    end
-  end
-
-  # Config.remote_env uses the Heroku API to read config vars from
-  # other apps.
-  def test_shared_config_loads_shared_with_correct_precedence
-    set_env('CONFIG_APP', 'vault-config')
-    api_mock = MiniTest::Mock.new
-    api_response = OpenStruct.new(body: {'HELLO' => 'world'})
-    Heroku::API.stub(:new, api_mock) do
-      api_mock.expect(:get_config_vars, api_response, ['vault-config'])
-      assert_equal(nil, Config[:hello])
-      Config.default(:hello, 'foo')
-      assert_equal('foo', Config[:hello])
-      # this is how we'll call it in the code
-      Config.load_shared!(Config[:config_app])
-      assert_equal('world', Config[:hello])
-    end
-  end
-
   # Config.env returns the value matching the specified environment
   # variable name.
   def test_env
@@ -55,7 +26,7 @@ class ConfigTest < Vault::TestCase
   # Config.env return nil if an unknown environment variable is
   # requested.
   def test_env_with_unknown_name
-    assert_equal(Config.env('UNKNOWN'), nil)
+    assert_nil(Config.env('UNKNOWN'))
   end
 
   # Config.env! returns the value matching the specified environment
@@ -132,7 +103,7 @@ class ConfigTest < Vault::TestCase
     end
   end
 
-  # Config.port converts the value from the environment to a Fixnum
+  # Config.port converts the value from the environment to a Integer
   def test_port_convert_to_int
     set_env 'PORT', "3000"
     assert_equal(3000, Config.port)
@@ -150,14 +121,14 @@ class ConfigTest < Vault::TestCase
 
   # Config.int(VAR) returns nil or VAR as integer.
   def test_int
-    assert_equal(nil, Config.int('FOO'))
+    assert_nil Config.int('FOO')
     set_env 'FOO', "3000"
     assert_equal(3000, Config.int('FOO'))
   end
 
   # Config.time returns nil or VAR as time
   def test_time
-    assert_equal(nil, Config.time('T'))
+    assert_nil(Config.time('T'))
     set_env 'T', '2000'
     assert_equal(Time.utc(2000), Config.time(:t))
     set_env 'T', '2000-2'
@@ -170,7 +141,7 @@ class ConfigTest < Vault::TestCase
 
   # Config.time returns nil or VAR as URI
   def test_uri
-    assert_equal(nil, Config.uri('URL'))
+    assert_nil(Config.uri('URL'))
     set_env 'URL', 'http://user:password@the-web.com/path/to/greatness?foo=bar'
     uri = Config.uri('URL')
     assert_equal('http', uri.scheme)

data/test/defaults_test.rb

@@ -8,13 +8,13 @@ class DefaultsTest < Vault::TestCase
   end
 
   def test_default_when_no_value
-    assert_equal(Config[:max_connections], nil)
+    assert_nil(Config[:max_connections])
     Config.default(:max_connections, 10)
     assert_equal(Config[:max_connections], 10)
   end
 
   def test_default_with_int
-    assert_equal(Config[:max_connections], nil)
+    assert_nil(Config[:max_connections])
     Config.default(:max_connections, '10')
     assert_equal('10', Config[:max_connections])
     assert_equal(10, Config.int(:max_connections))
@@ -23,7 +23,7 @@ class DefaultsTest < Vault::TestCase
   end
 
   def test_default_with_time
-    assert_equal(Config[:date], nil)
+    assert_nil(Config[:date])
     Config.default(:date, '2013-01-01')
     assert_equal('2013-01-01', Config[:date])
     assert_equal(Time.utc(2013), Config.time(:date))
@@ -33,7 +33,7 @@ class DefaultsTest < Vault::TestCase
   end
 
   def test_default_with_array
-    assert_equal(Config[:array], nil)
+    assert_nil(Config[:array])
     Config.default(:array, '10')
     assert_equal('10', Config[:array])
     assert_equal(['10'], Config.array(:array))

data/test/helper.rb

@@ -1,8 +1,11 @@
 require 'vault-test-tools'
 require 'vault-tools'
 require 'rr'
+require 'minitest/around/unit'
+require 'pry'
 
 ENV['RACK_ENV'] = 'test'
+ENV['AWS_REGION'] = 'us-east-1'
 
 module LoggedDataHelper
   def logged_data
@@ -39,69 +42,32 @@ class Vault::TestCase
 end
 
 module StubbedS3
-  class FakeFile
-    def initialize(contents=nil)
-      @contents = contents
-    end
-
-    def write(contents)
-      @contents = contents
-    end
-
-    def read
-      @contents
-    end
-  end
-
-  class FakeBucket
-    def initialize
-      @files = {}
-    end
-
-    def [](file_name)
-      @files[file_name] ||= FakeFile.new
-    end
-
-    def write(file_name, contents)
-      @files[file_name].write(contents)
-    end
-
-    def objects
-      self
-    end
-  end
-
   class FakeClient
     def initialize
-      @buckets = {}
+      @files = {}
     end
 
-    def [](bucket_name)
-      @buckets[bucket_name] ||= FakeBucket.new
+    def put_object(opts)
+      @files["#{opts[:bucket]}::#{opts[:key]}"] = opts[:body]
     end
 
-    def buckets
-      self
+    def get_object(opts)
+      val = @files["#{opts[:bucket]}::#{opts[:key]}"]
+      OpenStruct.new(body: OpenStruct.new(read: val))
     end
   end
 
   class << self
     def seed(bucket, file, contents)
-      fake_client.buckets[bucket].objects[file].write(contents)
+      fake_client.put_object({bucket: bucket, key: file, body: contents})
     end
 
     def fake_client
       @client ||= FakeClient.new
     end
 
-    def enable!(env, opts={})
-      AWS.stub!
-      expected_aws_args = {
-        access_key_id: opts.fetch(:access_key_id, 'FAKE_ID'),
-        secret_access_key: opts.fetch(:secret_access_key, 'FAKE_KEY'),
-        use_ssl: opts.fetch(:use_ssl, true)
-      }
-      env.stub(AWS::S3).new(expected_aws_args) { fake_client }
+    def enable!(opts={}, &block)
+      Aws::S3::Client.stub(:new, fake_client) { yield }
     end
   end
 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/s3_test.rb

@@ -7,13 +7,14 @@ end
 class S3Test < Vault::TestCase
   include LoggedDataHelper
 
-  def setup
-    super
+  def around
     set_env 'APP_DEPLOY', 'test'
     set_env 'AWS_ACCESS_KEY_ID', 'fake access key id'
     set_env 'AWS_SECRET_ACCESS_KEY', 'fake secret access key'
-    AWS.stub!
-    @consumer = SomeS3Consumer.new
+    StubbedS3.enable! do
+      @consumer = SomeS3Consumer.new
+      yield
+    end
   end
 
   def log_output
@@ -23,33 +24,32 @@ class S3Test < Vault::TestCase
   # S3 writes should be logged.
   def test_write_logs
     @consumer.write('fake bucket', 'fake key', 'fake value')
-    assert_match /fake key/, log_output
+    assert_match(/fake key/, log_output)
   end
 
   # S3 reads should be logged.
   def test_read_logs
     @consumer.read('fake bucket', 'fake key')
-    assert_match /fake key/, log_output
+    assert_match(/fake key/, log_output)
   end
 
   # Should use S3 to write to bucket
   def test_writes_to_s3_bucket
-    mock(@consumer).s3.mock!.buckets.
-      mock!.[]('fake bucket').
-      mock!.objects.
-      mock!.[]('fake key').
-      mock!.write('fake value')
+    mock(@consumer).s3.mock!.put_object({
+      bucket: 'fake bucket',
+      key: 'fake key',
+      body: 'fake value'
+    })
     @consumer.write('fake bucket', 'fake key', 'fake value')
   end
 
   # Should use S3 to read from bucket
   def test_reads_from_s3_bucket
       #s3.buckets[bucket].objects[key].read
-    mock(@consumer).s3.mock!.buckets.
-      mock!.[]('fake bucket').
-      mock!.objects.
-      mock!.[]('fake key').
-      mock!.read
+    mock(@consumer).s3.mock!.get_object({
+      bucket: 'fake bucket',
+      key: 'fake key'
+    }).mock!.body.mock!.read
     @consumer.read('fake bucket', 'fake key')
   end
 end

data/test/statement_store_test.rb

@@ -1,12 +1,12 @@
 require 'helper'
 
 class StatementStoreTest < Vault::TestCase
-  def setup
-    super
-    StubbedS3.enable!(self)
-    StubbedS3.seed('vault-v2-json-invoice-test',
-                   '2014-10-01/2014-11-01/user8@heroku.com_v2', '{"foo": 1}')
-
+  def around(&block)
+    StubbedS3.enable! do
+      StubbedS3.seed('vault-v2-json-invoice-test',
+                     '2014-10-01/2014-11-01/user8@heroku.com_v2', '{"foo": 1}')
+      yield
+    end
   end
 
   def test_invoice_path_with_user_id
@@ -36,15 +36,12 @@ class StatementStoreTest < Vault::TestCase
     # Nothing Before Write
     doc = inv.get_json(start_time: '2014-10-01', stop_time: '2014-11-01',
                        user_hid: 'user9@heroku.com', version: 2)
-    expected = nil
-    assert_equal expected, doc
+    assert_nil doc
 
     # Write to S3 updating expectation
     expected = {"bar" => 3}
-    obj = inv.write_json(start_time: '2014-10-01', stop_time: '2014-11-01',
-                         user_hid: 'user9@heroku.com', version: 2,
-                         contents: expected)
-    assert obj.is_a? StubbedS3::FakeFile
+    inv.write_json(start_time: '2014-10-01', stop_time: '2014-11-01',
+                   user_hid: 'user9@heroku.com', version: 2, contents: expected)
 
     # There after write
     doc = inv.get_json(start_time: '2014-10-01', stop_time: '2014-11-01',

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
 

data/vault-tools.gemspec

@@ -7,11 +7,14 @@ require 'vault-tools/version'
 Gem::Specification.new do |gem|
   gem.name          = "vault-tools"
   gem.version       = Vault::Tools::VERSION
-  gem.authors       = ["Chris Continanza", "Jamu Kakar"]
-  gem.email         = ["christopher.continanza@gmail.com", "csquared@heroku.com","jkakar@heroku.com","jkakar@kakar.ca"]
+  gem.authors       = ["Chris Continanza", "Jamu Kakar", "Kenny Parnell"]
+  gem.email         = ["csquared@heroku.com", "christopher.continanza@gmail.com",
+                       "jkakar@heroku.com","jkakar@kakar.ca",
+                       "kennyp@heroku.com", "k.parnell@gmail.com"]
   gem.description   = "Basic tools for Heroku Vault's Ruby projects"
   gem.summary       = "Test classes, base web classes, and helpers - oh my!"
   gem.homepage      = ""
+  gem.required_ruby_version = '>= 2.7.1'
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep('^(test|spec|features)/')
@@ -21,14 +24,12 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'sinatra', '~> 2.0.4'
   gem.add_dependency 'uuidtools'
   gem.add_dependency 'rack-ssl-enforcer'
-  gem.add_dependency 'heroku-api'
-  gem.add_dependency 'fernet', '2.0.rc2'
-  gem.add_dependency 'rollbar', '~> 2.7.1'
-  gem.add_dependency 'aws-sdk', '~> 1.0'
+  gem.add_dependency 'fernet', '2.0'
+  gem.add_dependency 'rollbar', '~> 2.18.2'
+  gem.add_dependency 'aws-sdk-s3', '~> 1.0'
   gem.add_dependency 'excon'
   gem.add_dependency 'rack', '~> 2.0'
   gem.add_dependency 'coderay'
-  gem.add_dependency 'zipkin-tracer', '~> 0.27'
 
   gem.add_development_dependency 'dotenv'
   gem.add_development_dependency 'pry'