vault-tools 0.5.22 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30a308b70cb2b0dd36a4adbfa44579504e0e3eda
-  data.tar.gz: 25851c62a3c1cdede8a40045c7ad413227be03d7
+  metadata.gz: 3659a73e16232326982244fac1ce9ed09b5ad45f
+  data.tar.gz: 5ce1c3c552061e26ff1e945d8f82dbfa626fb2b3
 SHA512:
-  metadata.gz: df817efcb1d0e58585de50f92d3db33e378d5955b2cd2e5c07911cee2524395dd3b48db8c289ab91e809625daa12a8753b7f8fa43fc6ef78314a4ea06cab20ab
-  data.tar.gz: bb7171a789a86faec92e237759342855921220f651f309e9208bedc2a2092b84a8d3b5006e5aff64df5128e4d110e8affdd5f324d8a02452778883908630482b
+  metadata.gz: 89d887c7303d0246b93ac07a591f9db3deb4f47101702b8c528fb16891e6ea40b776dfc48e23d5008b1272b980403858c2fac0be00ce494879188a03ae196993
+  data.tar.gz: 5b1fd861313db8223070531f7290da7e2e2474ca0426000135ff15578f271e96e2587a8caa2e9182035257017f8942792ee00f20e656e31040450189917e9d40

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 test.profile*
 test/.test.profile*
 vendor
+.tool-versions

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.2.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
+  - 2.5.0
+  - 2.4.0
+  - 2.3.0

data/Gemfile.lock

@@ -1,76 +1,80 @@
 PATH
   remote: .
   specs:
-    vault-tools (0.5.22)
+    vault-tools (0.6.0)
       aws-sdk (~> 1.0)
       coderay
       excon
       fernet (= 2.0.rc2)
       heroku-api
-      pry
       rack (~> 1.6.4)
       rack-ssl-enforcer
-      rdoc
       rollbar (~> 2.7.1)
       scrolls
       sinatra (~> 1.4.4)
       uuidtools
-      yard
+      zipkin-tracer (~> 0.27)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    aws-sdk (1.66.0)
-      aws-sdk-v1 (= 1.66.0)
-    aws-sdk-v1 (1.66.0)
+    aws-sdk (1.67.0)
+      aws-sdk-v1 (= 1.67.0)
+    aws-sdk-v1 (1.67.0)
       json (~> 1.4)
-      nokogiri (>= 1.4.4)
-    coderay (1.1.1)
+      nokogiri (~> 1)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
     dotenv (2.0.0)
-    excon (0.54.0)
+    excon (0.60.0)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
     fernet (2.0.rc2)
       valcro (= 0.1)
+    finagle-thrift (1.4.2)
+      thrift (~> 0.9.3)
     guard-compat (1.2.1)
     guard-minitest (2.4.4)
       guard-compat (~> 1.2)
       minitest (>= 3.0)
-    heroku-api (0.4.1)
+    heroku-api (0.4.3)
       excon (~> 0.45)
       multi_json (~> 1.8)
-    json (1.8.3)
+    json (1.8.6)
     logfmt (0.0.7)
-    method_source (0.8.2)
+    method_source (0.9.0)
     mini_portile (0.6.2)
     minitest (4.7.5)
-    multi_json (1.12.1)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
-    pry (0.10.4)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
     rack (1.6.4)
-    rack-protection (1.5.3)
+    rack-protection (1.5.4)
       rack
     rack-ssl-enforcer (0.2.9)
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.4.2)
-    rdoc (4.2.2)
-      json (~> 1.4)
+    rdoc (6.0.1)
     rollbar (2.7.1)
       multi_json
     rr (1.1.2)
     scrolls (0.3.8)
     shotgun (0.9.1)
       rack (>= 1.0)
-    sinatra (1.4.7)
+    sinatra (1.4.8)
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    slop (3.6.0)
-    tilt (2.0.5)
+    sucker_punch (2.0.4)
+      concurrent-ruby (~> 1.0.0)
+    thrift (0.9.3.0)
+    tilt (2.0.8)
     turn (0.9.7)
       ansi
       minitest (~> 4)
@@ -88,6 +92,11 @@ GEM
     yard (0.8.7.6)
     yard-sinatra (1.0.0)
       yard (~> 0.7)
+    zipkin-tracer (0.27.2.1)
+      faraday (~> 0.8)
+      finagle-thrift (~> 1.4.2)
+      rack (>= 1.0)
+      sucker_punch (~> 2.0)
 
 PLATFORMS
   ruby
@@ -95,11 +104,14 @@ PLATFORMS
 DEPENDENCIES
   dotenv
   guard-minitest
+  pry
   rake
+  rdoc
   shotgun
   vault-test-tools
   vault-tools!
+  yard
   yard-sinatra
 
 BUNDLED WITH
-   1.13.6
+   1.16.1

data/README.md

@@ -26,6 +26,8 @@ calling `Vault.setup` will:
 - if the `CONFIG_APP` environment variable is defined and this is
   the production environment, it will attempt to use the Heroku API
   to load the config vars from another app into `Vault::Config`
+- enable distributed tracing via Zipkin, if the [required config
+  vars](#configs-for-tracing) are set
 
 
 ### `Vault::Config`
@@ -91,15 +93,15 @@ Generate the API documentation:
 
     vendor/bin/d
 
+## Configs for tracing
 
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+The following are config vars to be set in the consumer app for tracing with
+Zipkin:
+* `APP_NAME` (required) what the trace will show up as in the Zipkin interface.
+* `ZIPKIN_ENABLED` (required) must be set to `true` to start tracing.
+* `ZIPKIN_API_HOST` (required) where to post traces to. URL must contain the
+  basic auth creds from the Tools team.
+* `ZIPKIN_SAMPLE_RATE` defaults to `0.1`.
 
 ## Releasing
 

data/lib/vault-tools.rb

@@ -74,6 +74,7 @@ module Vault
     self.hack_time_class
     self.override_global_config
     self.load_shared_config
+    Tracing.configure
   end
 end
 
@@ -91,3 +92,4 @@ require 'vault-tools/time'
 require 'vault-tools/s3'
 require 'vault-tools/statement_store'
 require 'vault-tools/rollbar_helper'
+require 'vault-tools/tracing'

data/lib/vault-tools/app.rb

@@ -2,7 +2,7 @@ require 'uuidtools'
 
 module Vault
   module App
-    ID_CAPTURE = /^app(\d+)\@[\w\.]+com$/
+    ID_CAPTURE = /\Aapp(\d+)\@[\w\.]+com\z/
     # Convert a core app ID into a Heroku app ID.
     #
     # @param app_id [Fixnum] A core app ID.

data/lib/vault-tools/tracing.rb

@@ -0,0 +1,40 @@
+module Vault
+  module Tracing
+    ZIPKIN_API_HOST_STAGING = 'https://zipkin-staging.heroku.tools'.freeze
+
+    # Injects the zipkin middleware into the Web class.
+    #
+    # @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
+    end
+
+    # Configuration options for the Zipkin RackHandler.
+    #
+    # @return [Hash] config options for Zipkin tracer
+    def self.config
+      {
+        service_name: Config.app_name,
+        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
+  end
+end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.5.22'
+    VERSION = '0.6.0'
   end
 end

data/test/tracing_test.rb

@@ -0,0 +1,63 @@
+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_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_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
+end

data/vault-tools.gemspec

@@ -24,13 +24,14 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'heroku-api'
   gem.add_dependency 'fernet', '2.0.rc2'
   gem.add_dependency 'rollbar', '~> 2.7.1'
-  gem.add_dependency 'rdoc'
-  gem.add_dependency 'yard'
   gem.add_dependency 'aws-sdk', '~> 1.0'
   gem.add_dependency 'excon'
   gem.add_dependency 'rack', '~> 1.6.4'
   gem.add_dependency 'coderay'
-  gem.add_dependency 'pry'
+  gem.add_dependency 'zipkin-tracer', '~> 0.27'
 
   gem.add_development_dependency 'dotenv'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.5.22
+  version: 0.6.0
 platform: ruby
 authors:
 - Chris Continanza
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
@@ -110,21 +110,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.7.1
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,21 +138,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.6.4
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,27 +166,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: zipkin-tracer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '0.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '0.27'
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -200,7 +200,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -208,7 +208,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -258,6 +272,7 @@ 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/usage_db_tasks.rb
 - lib/vault-tools/user.rb
 - lib/vault-tools/vault_db_tasks.rb
@@ -275,6 +290,7 @@ 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
@@ -297,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Test classes, base web classes, and helpers - oh my!