wavefront-sdk 3.7.1 → 5.2.0

data/lib/wavefront-sdk/user.rb

@@ -4,16 +4,33 @@ require_relative 'core/api'
 require_relative 'api_mixins/user'
 
 module Wavefront
+  #
+  # In line with the API changes in the 2020-06 release of Wavefront, this
+  # class has been deprecated.
+  #
+  # Please use Wavefront::Account to manage users.
+  #
+  # https://docs.wavefront.com/2020.06.x_release_notes.html
   #
   # Manage and query Wavefront users
   #
   class User < CoreApi
     include Wavefront::Mixin::User
 
+    def deprecation_warning
+      logger.log('Wavefront::User is deprecated and will be removed from the ' \
+               'next major release. Please use Wavefront::Account.', :warn)
+    end
+
+    def post_initialize(_creds, _opts)
+      deprecation_warning
+    end
+
     # GET /api/v2/user
     # Get all users.
     #
     def list
+      deprecation_warning
       api.get('')
     end
 
@@ -26,6 +43,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def create(body, send_email = false)
+      deprecation_warning
       raise ArgumentError unless body.is_a?(Hash)
 
       api.post("?sendEmail=#{send_email}", body, 'application/json')
@@ -38,6 +56,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def delete(id)
+      deprecation_warning
       wf_user_id?(id)
       api.delete(id)
     end
@@ -49,6 +68,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def describe(id)
+      deprecation_warning
       wf_user_id?(id)
       api.get(id)
     end
@@ -65,6 +85,7 @@ module Wavefront
     # @return [Wavefront::Response]
 
     def update(id, body, modify = true)
+      deprecation_warning
       wf_user_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
@@ -82,6 +103,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def add_groups_to_user(id, group_list = [])
+      deprecation_warning
       wf_user_id?(id)
       validate_usergroup_list(group_list)
       api.post([id, 'addUserGroups'].uri_concat, group_list,
@@ -95,6 +117,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def remove_groups_from_user(id, group_list = [])
+      deprecation_warning
       wf_user_id?(id)
       validate_usergroup_list(group_list)
       api.post([id, 'removeUserGroups'].uri_concat, group_list,
@@ -116,6 +139,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def grant(id, pgroup)
+      deprecation_warning
       wf_user_id?(id)
       raise ArgumentError unless pgroup.is_a?(String)
 
@@ -133,6 +157,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def revoke(id, pgroup)
+      deprecation_warning
       wf_user_id?(id)
       raise ArgumentError unless pgroup.is_a?(String)
 
@@ -149,6 +174,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def delete_users(user_list)
+      deprecation_warning
       raise ArgumentError unless user_list.is_a?(Array)
 
       validate_user_list(user_list)
@@ -165,6 +191,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def grant_permission(permission, user_list)
+      deprecation_warning
       raise ArgumentError unless user_list.is_a?(Array)
 
       validate_user_list(user_list)
@@ -182,6 +209,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def revoke_permission(permission, user_list)
+      deprecation_warning
       raise ArgumentError unless user_list.is_a?(Array)
 
       validate_user_list(user_list)
@@ -196,6 +224,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def invite(body)
+      deprecation_warning
       raise ArgumentError unless body.is_a?(Array)
       raise ArgumentError unless body.first.is_a?(Hash)
 
@@ -208,6 +237,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def business_functions(id)
+      deprecation_warning
       wf_user_id?(id)
       api.get([id, 'businessFunctions'].uri_concat)
     end
@@ -219,6 +249,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def validate_users(id_list)
+      deprecation_warning
       api.post('validateUsers', id_list, 'application/json')
     end
 

data/lib/wavefront-sdk/usergroup.rb

@@ -108,30 +108,31 @@ module Wavefront
                'application/json')
     end
 
-    # POST /api/v2/usergroup/grant/{permission}
-    # Grants a single permission to user group(s)
+    # POST /api/v2/usergroup/{id}/addRoles
+    # Add multiple roles to a specific user group
     #
-    # @param perm [String] permission to grant
-    # @param group_list [Array[String]] list of groups who should
-    #   receive permission
+    # @param id [String] ID of the user group
+    # @param role_list [Array[String]] list of roles to add
     # @return [Wavefront::Response]
     #
-    def grant(perm, group_list = [])
-      validate_usergroup_list(group_list)
-      api.post(['grant', perm].uri_concat, group_list, 'application/json')
+    def add_roles_to_group(id, role_list = [])
+      wf_usergroup_id?(id)
+      validate_role_list(role_list)
+      api.post([id, 'addRoles'].uri_concat, role_list, 'application/json')
     end
 
-    # POST /api/v2/usergroup/revoke/{permission}
-    # Revokes a single permission from user group(s)
+    # POST /api/v2/usergroup/{id}/removeRoles
+    # Remove multiple roles from a specific user group
     #
-    # @param perm [String] permission to revoke
-    # @param group_list [Array[String]] list of groups who should
-    #   lose permission
+    # @param id [String] ID of the user group
+    # @param user_list [Array[String]] list of roles to remove
     # @return [Wavefront::Response]
     #
-    def revoke(perm, group_list = [])
-      validate_usergroup_list(group_list)
-      api.post(['revoke', perm].uri_concat, group_list, 'application/json')
+    def remove_roles_from_group(id, role_list = [])
+      wf_usergroup_id?(id)
+      validate_role_list(role_list)
+      api.post([id, 'removeRoles'].uri_concat, role_list,
+               'application/json')
     end
   end
 end

data/lib/wavefront-sdk/validators.rb

@@ -48,8 +48,8 @@ module Wavefront
     #
     def wf_metric_name?(metric)
       if metric.is_a?(String) && metric.size < 1024 &&
-         (metric.match(/^#{DELTA}?[\w\-\.]+$/) ||
-          metric.match(%r{^\"#{DELTA}?[\w\-\.\/,]+\"$}))
+         (metric.match(/^#{DELTA}?[\w\-.]+$/) ||
+          metric.match(%r{^"#{DELTA}?[\w\-./,]+"$}))
         return true
       end
 
@@ -81,7 +81,7 @@ module Wavefront
       # commas in tags and descriptions. This might be too restrictive,
       # but if it is, this is the only place we need to change it.
       #
-      if str.is_a?(String) && str.size < 1024 && str =~ /^[\-\w \.,]*$/
+      if str.is_a?(String) && str.size < 1024 && str =~ /^[\-\w .,]*$/
         return true
       end
 
@@ -139,7 +139,7 @@ module Wavefront
     #
     def wf_tag?(*tags)
       Array(*tags).each do |tag|
-        unless tag.is_a?(String) && tag.size < 255 && tag =~ /^[\w:\-\.]+$/
+        unless tag.is_a?(String) && tag.size < 255 && tag =~ /^[\w:\-.]+$/
           raise Wavefront::Exception::InvalidTag, tag
         end
       end
@@ -196,7 +196,7 @@ module Wavefront
     #
     def wf_point_tag?(key, val)
       if key && val && (key.size + val.size < 254) &&
-         key =~ /^[\w\-\.:]+$/ && val !~ /\\$/
+         key =~ /^[\w\-.:]+$/ && val !~ /\\$/
         return
       end
 
@@ -391,7 +391,7 @@ module Wavefront
     #   is not valid
     #
     def wf_source_id?(source)
-      if source.is_a?(String) && source.match(/^[\w\.\-]+$/) &&
+      if source.is_a?(String) && source.match(/^[\w.\-]+$/) &&
          source.size < 1024
         return true
       end
@@ -566,7 +566,7 @@ module Wavefront
         return true
       end
 
-      raise Wavefront::Exception::InvalidPermission, id, id
+      raise Wavefront::Exception::InvalidPermission, id
     end
 
     # Ensure the given argument is a valid ingestion policy ID
@@ -594,6 +594,51 @@ module Wavefront
         raise Wavefront::Exception::InvalidAccountId, id
       end
     end
+
+    # Ensure the given argument is a valid monitored cluster ID
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidMonitoredClusterId if the ID is not
+    #   valid
+    #
+    def wf_monitoredcluster_id?(id)
+      return true if id.is_a?(String) && id.size < 256 && id =~ /^[a-z0-9\-_]+$/
+
+      raise Wavefront::Exception::InvalidMonitoredClusterId, id
+    end
+
+    # Ensure the given value is a valid sampling rate.
+    # @param rate [Float]
+    # @raise Wavefront::Exception::InvalidSamplingValue
+    #
+    def wf_sampling_value?(value)
+      return true if value.is_a?(Numeric) && value.between?(0, 0.05)
+
+      raise Wavefront::Exception::InvalidSamplingValue, value
+    end
+
+    # Ensure the given argument is a valid Wavefront role ID
+    # @param id [String] the role ID to validate
+    # @return true if the role ID is valid
+    # @raise Wavefront::Exception::InvalidRoleId if the role ID is not valid
+    #
+    def wf_role_id?(id)
+      return true if uuid?(id)
+
+      raise Wavefront::Exception::InvalidRoleId, id
+    end
+
+    # Ensure the given argument is a valid AWS external ID, used in the AWS
+    # cloud integration.
+    # @param id [String] the external ID to validate
+    # @return true if the external ID is valid
+    # @raise Wavefront::Exception::InvalidAwsExternalId if the external ID is
+    # not valid
+    #
+    def wf_aws_external_id?(id)
+      return true if id.is_a?(String) && id =~ /^[a-z0-9A-Z]{16}$/
+
+      raise Wavefront::Exception::InvalidAwsExternalId, id
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/wavefront-sdk/write.rb

@@ -113,7 +113,7 @@ module Wavefront
     # @return Wavefront::Response
     #
     def composite_response(responses)
-      result, code = response_codes(responses)
+      result, code = response_results(responses)
 
       summary = { sent: 0, rejected: 0, unsent: 0 }
 
@@ -127,6 +127,14 @@ module Wavefront
       )
     end
 
+    def response_results(responses)
+      if responses.all?(&:ok?)
+        ['OK', 200]
+      else
+        ['ERROR', 400]
+      end
+    end
+
     def manage_conn
       opts[:noauto] ? false : true
     end
@@ -248,13 +256,5 @@ module Wavefront
     rescue LoadError
       raise(Wavefront::Exception::UnsupportedWriter, writer)
     end
-
-    def response_codes(responses)
-      if responses.all?(&:ok?)
-        ['OK', 200]
-      else
-        ['ERROR', 400]
-      end
-    end
   end
 end

data/spec/.rubocop.yml

@@ -11,3 +11,44 @@ Metrics/ClassLength:
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 39
+
+# New cops
+#
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+
+# Is nothing sacred?
+Layout/LineLength:
+  Max: 80

data/spec/spec_helper.rb

@@ -23,6 +23,10 @@ class WavefrontTestBase < MiniTest::Test
     "../lib/wavefront-sdk/#{class_basename.downcase}"
   end
 
+  def dummy_response
+    DUMMY_RESPONSE
+  end
+
   private
 
   def setup

data/spec/support/minitest_assertions.rb

@@ -20,7 +20,7 @@ module Minitest
       headers = DEFAULT_HEADERS
       stub_request(:get, uri(api_path))
         .with(headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:get, uri(api_path), headers: headers)
       WebMock.reset!
@@ -39,7 +39,7 @@ module Minitest
       payload = 'null' if payload.nil?
       stub_request(:post, uri(api_path))
         .with(body: payload, headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:post, uri(api_path), headers: headers)
       WebMock.reset!
@@ -58,7 +58,7 @@ module Minitest
       payload = 'null' if payload.nil?
       stub_request(:put, uri(api_path))
         .with(body: payload, headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:put, uri(api_path), headers: headers)
       WebMock.reset!
@@ -72,7 +72,7 @@ module Minitest
       headers = DEFAULT_HEADERS
       stub_request(:delete, uri(api_path))
         .with(headers: headers)
-        .to_return(body: DUMMY_RESPONSE, status: 200)
+        .to_return(body: dummy_response, status: 200)
       yield block
       assert_requested(:delete, uri(api_path), headers: headers)
       WebMock.reset!

data/spec/wavefront-sdk/account_spec.rb

@@ -11,6 +11,18 @@ class WavefrontAccountTest < WavefrontTestBase
   include WavefrontTest::Delete
   include WavefrontTest::Describe
 
+  def test_add_roles
+    assert_posts("/api/v2/account/#{id}/addRoles", roles.to_json) do
+      wf.add_roles(id, roles)
+    end
+
+    assert_invalid_id { wf.add_roles(invalid_id, roles) }
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.add_roles(id, invalid_role)
+    end
+  end
+
   def test_add_user_groups
     assert_posts("/api/v2/account/#{id}/addUserGroups", groups.to_json) do
       wf.add_user_groups(id, groups)
@@ -37,6 +49,22 @@ class WavefrontAccountTest < WavefrontTestBase
     assert_posts("/api/v2/account/grant/#{permission}", id_list.to_json) do
       wf.grant(id_list, permission)
     end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.remove_roles(id, invalid_role)
+    end
+  end
+
+  def test_remove_roles
+    assert_posts("/api/v2/account/#{id}/removeRoles", roles.to_json) do
+      wf.remove_roles(id, roles)
+    end
+
+    assert_invalid_id { wf.remove_roles(invalid_id, roles) }
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.remove_roles(id, invalid_role)
+    end
   end
 
   def test_remove_user_groups
@@ -45,12 +73,22 @@ class WavefrontAccountTest < WavefrontTestBase
     end
 
     assert_invalid_id { wf.remove_user_groups(invalid_id, groups) }
+
+    assert_raises(Wavefront::Exception::InvalidUserGroupId) do
+      wf.remove_user_groups(id, invalid_group)
+    end
   end
 
   def test_revoke_from_single_user
     assert_posts("/api/v2/account/#{id}/revoke/#{permission}") do
       wf.revoke(id, permission)
     end
+
+    assert_invalid_id { wf.revoke(invalid_id, permission) }
+
+    assert_raises(Wavefront::Exception::InvalidPermission) do
+      wf.revoke(id, invalid_permission)
+    end
   end
 
   def test_revoke_from_multiple_users
@@ -82,7 +120,7 @@ class WavefrontAccountTest < WavefrontTestBase
   end
 
   def test_remove_ingestion_policy
-    assert_posts('/api/v2/account/removeingestionpolicy',
+    assert_posts('/api/v2/account/removeingestionpolicies',
                  { ingestionPolicyId: policy_id,
                    accounts: id_list }.to_json) do
       wf.remove_ingestion_policy(policy_id, id_list)
@@ -95,6 +133,52 @@ class WavefrontAccountTest < WavefrontTestBase
     assert_invalid_id { wf.add_ingestion_policy(policy_id, [invalid_id]) }
   end
 
+  def test_user_list
+    assert_gets('/api/v2/account/user?offset=0&limit=100') do
+      wf.user_list
+    end
+
+    assert_gets('/api/v2/account/user?offset=10&limit=50') do
+      wf.user_list(10, 50)
+    end
+  end
+
+  def test_user_describe
+    assert_gets("/api/v2/account/user/#{id}") { wf.user_describe(id) }
+
+    assert_raises(Wavefront::Exception::InvalidUserId) do
+      wf.user_describe(invalid_id)
+    end
+
+    assert_raises(ArgumentError) { wf.user_describe }
+  end
+
+  def test_user_create
+    assert_posts('/api/v2/account/user', payload.to_json) do
+      wf.user_create(payload)
+    end
+
+    assert_raises(ArgumentError) { wf.user_create }
+    assert_raises(ArgumentError) { wf.user_create('test') }
+  end
+
+  def test_user_invite
+    assert_posts('/api/v2/account/user/invite', [payload].to_json) do
+      wf.user_invite([payload])
+    end
+
+    assert_raises(ArgumentError) { wf.user_invite }
+    assert_raises(ArgumentError) { wf.user_invite('test') }
+  end
+
+  def test_validate_accounts
+    assert_posts('/api/v2/account/validateAccounts', id_list.to_json) do
+      wf.validate_accounts(id_list)
+    end
+
+    assert_raises(ArgumentError) { wf.validate_accounts }
+  end
+
   private
 
   def api_class
@@ -114,10 +198,27 @@ class WavefrontAccountTest < WavefrontTestBase
        2659191e-aad4-4302-a94e-9667e1517127]
   end
 
+  def roles
+    %w[f8dc0c14-91a0-4ca9-8a2a-7d47f4db1234
+       2659191e-aad4-4302-a94e-9667e1515678]
+  end
+
+  def invalid_role
+    %w[bad_role]
+  end
+
+  def invalid_group
+    %w[bad_group]
+  end
+
   def id_list
     %w[sa:test user@example.com]
   end
 
+  def invalid_permission
+    'some_nonsense_permission_i_made_up'
+  end
+
   def permission
     'agent_management'
   end
@@ -129,4 +230,9 @@ class WavefrontAccountTest < WavefrontTestBase
   def invalid_policy_id
     'badpolicy'
   end
+
+  def payload
+    { emailAddress: id,
+      groups: %w[browse] }
+  end
 end