wavefront-sdk 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fa47f9b8dc9c71f547e50131d53cfcdf5ae0142cd75f14558afd5303576a4cc
-  data.tar.gz: '08bea64a048f8e22e02c4b8b12fa6e413a9e26bbb1e5c55e26201ac873424812'
+  metadata.gz: fc04400fbf51a67e94d228b3145a9fdd5fdb484c24035f1c83ff583e755d705e
+  data.tar.gz: 3acd358086967628300c65bff916b541e28004a1a5ca55b44b764a7ddb277d1e
 SHA512:
-  metadata.gz: ea55156acfeaadce57ff846aa723c936c77f061730ef7f1e91b2b2919c51dfa2cc1b0652d1485905772397da24452332e34b15ea4bae713dd4abc8aa83477dc7
-  data.tar.gz: 953bbc44ca84d32194a231d9037ce8e47917a1895c148e1e0661c7125f24c6bba53e29d9a625b8b6d2744669b49cab99837429c0f22129fad4e6697fafb17988
+  metadata.gz: 665e0f09c85149b0879b868ec51336b88ac9c9c1af542df52ce0e00b932249a06236268e6398e6b828b7a7deb4421669611cdcaaf838965dd2eb560a720f0181
+  data.tar.gz: 519dc5ca20b01d81454bf8255815bd85ba3e016a4639eda688f1e2544b6d6c6e26ce6ff097e125fdf1eb40ab3ac10530307e0df3a31e590fac24279c89965b64

data/HISTORY.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 5.2.0 (2020-09-03)
+* Add `:raise_on_no_profile` option to `Wavefront::Credentials` constructor
+  options. If this is true and a specific config stanza is requested but not
+  found, `Wavefront::Exception::MissingConfigProfile` is thrown.
+
 ## 5.1.0 (2020-08-15)
 * Add `create_aws_external_id`, `delete_aws_external_id`, and
   `confirm_aws_external_id` methods to `Wavefront::CloudIntegration`.

data/lib/wavefront-sdk/core/exception.rb

@@ -55,6 +55,7 @@ module Wavefront
     class InvalidUserGroupId < RuntimeError; end
     class InvalidVersion < RuntimeError; end
     class InvalidWebhookId < RuntimeError; end
+    class MissingConfigProfile < RuntimeError; end
     class NetworkTimeout < RuntimeError; end
     class NotImplemented < RuntimeError; end
     class SocketError < RuntimeError; end

data/lib/wavefront-sdk/credentials.rb

@@ -31,11 +31,16 @@ module Wavefront
     # @param options [Hash] keys may be 'file', which
     #   specifies a config file which will be loaded and parsed. If
     #   no file is supplied, those listed above will be used.;
-    #   and/or 'profile' which select a profile section from 'file'
+    #   and/or 'profile' which select a profile section from 'file'.
+    #   Specify the key :raise_noprofile to have an exception thrown
+    #   if a given profile cannot be found. Otherwise that is ignored and
+    #   options are built from other sources.
     #
     def initialize(options = {})
-      raw = load_from_file(cred_files(options), options[:profile] ||
-                           'default')
+      @raise_noprofile = options[:raise_on_no_profile] || false
+      raw = load_from_file(real_files(cred_files(options)),
+                           options[:profile] || 'default')
+
       populate(env_override(raw))
     end
 
@@ -80,31 +85,45 @@ module Wavefront
       end
     end
 
+    def real_files(files)
+      files.select { |f| f.exist? && f.file? }
+    end
+
     # @param files [Array][Pathname] a list of ini-style config files
     # @param profile [String] a profile name
+    # @param disallow_missing [Bool] whether or not to raise an exception if
+    #   we are given a profile but can't find it.
     # @return [Hash] the given profile from the given list of files.
     #   If multiple files match, the last one will be used
     #
     def load_from_file(files, profile = 'default')
       ret = {}
+      profiles_found = conf_files_found = 0
 
       files.each do |f|
-        next unless f.exist? && f.file?
-
         ret = load_profile(f, profile)
+        conf_files_found += 1
+        profiles_found += 1 unless ret.empty?
         ret[:file] = f
       end
 
+      raise_on_missing_profile(profile, profiles_found, conf_files_found)
       ret
     end
 
-    # Load in an (optionally) given section of an ini-style
-    # configuration file not there, we don't consider that an error.
+    def raise_on_missing_profile(profile, profiles_found, conf_files_found)
+      return true unless @raise_noprofile
+      return true unless profiles_found.zero? && conf_files_found.positive?
+
+      raise Wavefront::Exception::MissingConfigProfile, profile
+    end
+
+    # Load in an (optionally) given section of an ini-style configuration
+    # file. If the section is not there, we don't consider that an error.
     #
     # @param file [Pathname] the file to read
     # @param profile [String] the section in the config to read
-    # @return [Hash] options loaded from file. Each key becomes a
-    #   symbol
+    # @return [Hash] options loaded from file. Each key becomes a symbol
     #
     def load_profile(file, profile = 'default')
       IniFile.load(file)[profile].each_with_object({}) do |(k, v), memo|

data/lib/wavefront-sdk/defs/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-WF_SDK_VERSION = '5.1.0'
+WF_SDK_VERSION = '5.2.0'
 WF_SDK_LOCATION = Pathname.new(__dir__).parent.parent.parent

data/spec/wavefront-sdk/credentials_spec.rb

@@ -153,10 +153,9 @@ class GibletsTest < MiniTest::Test
   end
 
   def test_load_from_file
-    assert_equal({},
-                 wf.load_from_file(
-                   [Pathname.new('/no/file/1'), Pathname.new('/no/file/2')]
-                 ))
+    assert_raises(Wavefront::Exception::InvalidConfigFile) do
+      wf.load_from_file([Pathname.new('/nofile/1'), Pathname.new('/nofile/2')])
+    end
 
     assert_equal({ file: CONF1 }, wf.load_from_file([CONF1], 'noprofile'))
 

data/wavefront-sdk.gemspec

@@ -27,12 +27,12 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'inifile', '~> 3.0'
   gem.add_dependency 'map', '~> 6.6'
 
-  gem.add_development_dependency 'minitest', '~> 5.11'
+  gem.add_development_dependency 'minitest', '~> 5.14'
   gem.add_development_dependency 'rake', '~> 13.0'
-  gem.add_development_dependency 'rubocop', '= 0.87.1'
-  gem.add_development_dependency 'simplecov', '~> 0.16'
-  gem.add_development_dependency 'spy', '~> 1.0.0'
-  gem.add_development_dependency 'webmock', '~> 3.7'
+  gem.add_development_dependency 'rubocop', '0.87.1'
+  gem.add_development_dependency 'simplecov', '~> 0.18'
+  gem.add_development_dependency 'spy', '1.0.0'
+  gem.add_development_dependency 'webmock', '~> 3.8'
   gem.add_development_dependency 'yard', '~> 0.9'
 
   gem.required_ruby_version = Gem::Requirement.new('>= 2.4.0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,26 +114,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: spy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement