vault-tools 1.0.1 → 2.1.0

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Chris Continanza
 - Jamu Kakar
-autorequire: 
+- Kenny Parnell
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
@@ -67,50 +68,36 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: heroku-api
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: fernet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.rc2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.rc2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rollbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: 2.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: 2.18.2
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -165,20 +152,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: zipkin-tracer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.27'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.27'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -237,16 +210,18 @@ dependencies:
         version: '0'
 description: Basic tools for Heroku Vault's Ruby projects
 email:
-- christopher.continanza@gmail.com
 - csquared@heroku.com
+- christopher.continanza@gmail.com
 - jkakar@heroku.com
 - jkakar@kakar.ca
+- kennyp@heroku.com
+- k.parnell@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - Gemfile.lock
@@ -272,9 +247,6 @@ files:
 - lib/vault-tools/tasks.rb
 - lib/vault-tools/text_processor.rb
 - lib/vault-tools/time.rb
-- lib/vault-tools/tracing.rb
-- lib/vault-tools/tracing/sidekiq_client.rb
-- lib/vault-tools/tracing/sidekiq_server.rb
 - lib/vault-tools/usage_db_tasks.rb
 - lib/vault-tools/user.rb
 - lib/vault-tools/vault_db_tasks.rb
@@ -292,14 +264,13 @@ files:
 - test/statement_store_test.rb
 - test/text_processor_test.rb
 - test/time_test.rb
-- test/tracing_test.rb
 - test/user_test.rb
 - test/web_test.rb
 - vault-tools.gemspec
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -307,16 +278,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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,6 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.0
-  - 2.4.0
-  - 2.3.0

data/lib/vault-tools/tracing/sidekiq_client.rb

@@ -1,37 +0,0 @@
-module Vault
-  module Tracing
-    # Tracing info for sidekiq, adding them as params
-    # This was lifted straight out of heroku/coal_car
-    class SidekiqClient
-      def trace_information(trace_id)
-        {
-          "trace_id"  => trace_id.trace_id,
-          "parent_id" => trace_id.parent_id,
-          "span_id"   => trace_id.span_id,
-          "sampled"   => trace_id.sampled,
-          "flags"     => trace_id.flags
-        }
-      end
-
-      def call(worker_class, job, _queue, _redis_pool)
-        trace_id = ::ZipkinTracer::TraceGenerator.new.next_trace_id
-        ::ZipkinTracer::TraceContainer.with_trace_id(trace_id) do
-          job["zipkin_trace_information"] = trace_information(trace_id)
-          if trace_id.sampled?
-            ::Trace.tracer.with_new_span(trace_id, "sidekiq") do |span|
-              local_endpoint = Trace.default_endpoint
-              klass = job["wrapped".freeze] || worker_class
-              span.record_tag("job_class",
-                              klass,
-                              ::Trace::BinaryAnnotation::Type::STRING,
-                              local_endpoint)
-              yield
-            end
-          else
-            yield
-          end
-        end
-      end
-    end
-  end
-end

data/lib/vault-tools/tracing/sidekiq_server.rb

@@ -1,54 +0,0 @@
-module Vault
-  module Tracing
-    # Tracing info for sidekiq
-    # This was lifted straight out of heroku/coal_car
-    class SidekiqServer
-      def initialize(config = nil)
-        @config = ZipkinTracer::Config.new(nil, config).freeze
-        @tracer = ZipkinTracer::TracerFactory.new.tracer(@config)
-      end
-
-      def call(worker, job, _queue)
-        result = nil
-        id = trace_id(job)
-        klass = job["wrapped".freeze] || worker.class.to_s
-        ::ZipkinTracer::TraceContainer.with_trace_id(id) do
-          if id.sampled?
-            @tracer.with_new_span(id, klass) do |span|
-              span.record("sidekiq.start")
-              result = yield
-              span.record("sidekiq.end")
-            end
-          else
-            yield
-          end
-        end
-        ::Trace.tracer.flush! if ::Trace.tracer.respond_to?(:flush!)
-        result
-      end
-
-      private
-
-      def trace_id(job)
-        info = job["zipkin_trace_information"]
-        if info
-          trace_id = info["trace_id"]
-          span_id  = info["span_id"]
-          parent_span_id = info["parent_id"]
-          sampled = info["sampled"]
-          flags = info["flags"].to_i
-        else
-          trace_id = span_id = ::Trace.generate_id
-          parent_span_id = nil
-          sampled = sample?
-          flags = ::Trace::Flags::EMPTY
-        end
-        ::Trace::TraceId.new(trace_id, parent_span_id, span_id, sampled, flags)
-      end
-
-      def sample?
-        rand < @config.sample_rate
-      end
-    end
-  end
-end

data/lib/vault-tools/tracing.rb

@@ -1,92 +0,0 @@
-require 'zipkin-tracer'
-
-module Vault
-  module Tracing
-    ZIPKIN_API_HOST_STAGING = 'https://zipkin-staging.heroku.tools'.freeze
-
-    # Injects the zipkin middleware into the Web class, add Zipkin middleware to
-    # Excon.
-    #
-    # @example
-    #   Vault::Tracing.configure
-    #
-    # @return nil
-    def self.configure
-      return unless Vault::Tracing.enabled?
-
-      Vault::Web.instance_eval { require 'zipkin-tracer' }
-      Vault::Web.use ZipkinTracer::RackHandler, config
-      setup_excon
-    end
-
-    # Traces a local component. Useful to track down long running implementation
-    # methods within an app, instead of only tracing external calls.
-    #
-    # @param name [String] the name of the span to record in Zipkin.
-    # @param tracer [Constant] the const that should respond to :local_component_span
-    # @param options [Hash] the options to create a message with.
-    #
-    # @example
-    #   Vault::Tracing.trace_local 'cashier_middleware_x', internal: true do
-    #     # some expensive task
-    #   end
-    #
-    # @yield [the_block_passed_in]
-    def self.trace_local(name, tracer = ZipkinTracer::TraceClient, **options)
-      return yield unless Vault::Tracing.enabled?
-
-      tracer.local_component_span(name) do |span|
-        span.name = name
-        span.record_tag('options', options.to_s) unless options.empty?
-        yield
-      end
-    end
-
-    # Configuration options for the Zipkin RackHandler.
-    #
-    # @return [Hash] config options for Zipkin tracer
-    def self.config
-      {
-        service_name: "#{Config.app_name}.herokuapp.com",
-        service_port: 443,
-        json_api_host: Config[:zipkin_api_host],
-        sample_rate: (Config[:zipkin_sample_rate] || 0.1).to_f,
-        sampled_as_boolean: false
-      }
-    end
-
-    # A helper to guard against injecting Zipkin when not desired.
-    #
-    # @return [true] if so
-    def self.enabled?
-      Config.app_name &&
-        Config[:zipkin_enabled] == 'true' &&
-        Config[:zipkin_api_host]
-    end
-
-    # Adds ZipkinTracer::ExconHandler to Excon's default middlewares if Excon is
-    # defined
-    #
-    # @private
-    #
-    # @return nil
-    def self.setup_excon
-      if add_to_excon_middlewares?
-        Excon.defaults[:middlewares].push(ZipkinTracer::ExconHandler)
-      end
-    end
-    private_class_method :setup_excon
-
-    # Checks to see if Excon is defined and if the Zipkin middleware has already
-    # been inserted.
-    #
-    # @private
-    #
-    # @return [true] if Excon is defined and the middleware is not already
-    # inserted
-    def self.add_to_excon_middlewares?
-      defined?(Excon) && !Excon.defaults[:middlewares].include?(ZipkinTracer::ExconHandler)
-    end
-    private_class_method :add_to_excon_middlewares?
-  end
-end

data/test/tracing_test.rb

@@ -1,86 +0,0 @@
-require 'helper'
-
-class TracingTest < Vault::TestCase
-  # Anonymous Web Frontend
-  def app
-    @app ||= Class.new(Vault::Web)
-  end
-
-  # Middleware is attached at load time, so we have to delete the Vault::Web
-  # class and reload it to simulate being loaded with different environment
-  # variables.
-  def reload_web!
-    # remove the constant to force a clean reload
-    Vault.send(:remove_const, 'Web')
-    load 'lib/vault-tools/web.rb'
-  end
-
-  # Always reload the web class to eliminate test leakage
-  def setup
-    super
-    reload_web!
-    enable
-  end
-
-  def teardown
-    super
-    @app = nil
-  end
-
-  def enable
-    set_env('APP_NAME', 'test_app')
-    set_env('ZIPKIN_ENABLED', 'true')
-    set_env('ZIPKIN_API_HOST', 'http://localhost')
-  end
-
-  def disable
-    set_env('ZIPKIN_ENABLED', nil)
-  end
-
-  def test_service_name_gets_herokuapp
-    assert_equal 'test_app.herokuapp.com', Vault::Tracing.config[:service_name]
-  end
-
-  def test_configure_enabled
-    Vault::Tracing.configure
-    middleware_constants = app.middleware.map(&:first)
-    assert middleware_constants.include?(ZipkinTracer::RackHandler),
-      "expected ZipkinTracer::RackHandler to be in the middleware stack, got #{middleware_constants}"
-  end
-
-  def test_configure_not_enabled
-    disable
-    refute Vault::Tracing.configure,
-      'Vault::Tracing.configure should return nil when not enabled'
-  end
-
-  def test_excon
-    Vault::Tracing.configure
-    assert Excon.defaults[:middlewares].include?(ZipkinTracer::ExconHandler),
-      "Vault::Tracing.setup_excon should add ZipkinTracer::ExconHandler to excon's middleware"
-  end
-
-  def test_enabled_true
-    assert Vault::Tracing.enabled?,
-      'Vault::Tracing.enabled? should return true when enabled'
-  end
-
-  def test_enabled_false
-    disable
-    refute Vault::Tracing.enabled?,
-      'Vault::Tracing.enabled? should return false when not enabled'
-  end
-
-  def test_trace_local_yield
-    result = Vault::Tracing.trace_local('testing', opt: 'foo') { 1 + 1 }
-    assert_equal 2, result, 'trace_local should yield the result of the block given'
-  end
-
-  def test_trace_local_calls_tracer
-    tracer_mock = Minitest::Mock.new
-    tracer_mock.expect :local_component_span, true, ['testing']
-    Vault::Tracing.trace_local('testing', tracer_mock, opt: 'foo') { 1 + 1 }
-    assert tracer_mock.verify,
-      'trace_local should call :local_component_span on the tracer'
-  end
-end