wavefront-sdk 3.6.1 → 5.0.1

data/lib/wavefront-sdk/stdlib/array.rb

@@ -11,6 +11,6 @@ class Array
   # @return [String] a URI path
   #
   def uri_concat
-    join('/').squeeze('/').sub(%r{\/$}, '').sub(%r{\/\?}, '?')
+    join('/').squeeze('/').sub(%r{/$}, '').sub(%r{/\?}, '?')
   end
 end

data/lib/wavefront-sdk/stdlib/time.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Extensions to the stdlib Time class
+#
+class Time
+  #
+  # The real hi-res time. See
+  # https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/
+  #
+  def self.right_now
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+end

data/lib/wavefront-sdk/unstable/README.md

@@ -0,0 +1,4 @@
+The classes in here use undocumented APIs. They are thus subject to
+change or revocation at any time.
+
+Use them at your own risk.

data/lib/wavefront-sdk/unstable/chart.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative '../defs/constants'
+require_relative '../core/api'
+
+module Wavefront
+  module Unstable
+    #
+    # This is an unstable class. Please refer to README.md.
+    #
+    class Chart < CoreApi
+      def all_metrics
+        metrics_under('')
+      end
+
+      # Gets a list of metrics under the given path. This must be done via
+      # recursive calls to the API, so calls can take a while. If you ask for
+      # all your metrics, expect to be waiting some time.
+      #
+      # @return [Wavefront::Response]
+      #
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def metrics_under(path, cursor = nil, limit = 100)
+        resp = api.get('metrics/all',
+                       { trie: true, q: path, p: cursor, l: limit }.compact)
+
+        return resp unless resp.ok?
+
+        metrics = resp.response.items
+
+        metrics.each do |m|
+          if m.end_with?('.')
+            metrics += metrics_under(m).response.items
+            metrics.delete(m)
+          end
+        end
+
+        # resp.more_items? doesn't work: we don't get that from this API
+
+        if metrics.size == limit
+          metrics += metrics_under(path, metrics.last, limit).response.items
+        end
+
+        resp.response.items = metrics.sort
+        resp
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def api_path
+        '/chart'
+      end
+
+      # We have to try to make the response we get from the API look
+      # like the one we get from the public API. To begin with, it's
+      # nothing like it.
+      #
+      # This method must be public because a #respond_to? looks for
+      # it.
+      #
+      def response_shim(resp, status)
+        { response: parse_response(resp),
+          status: { result: status == 200 ? 'OK' : 'ERROR',
+                    message: extract_api_message(status, resp),
+                    code: status } }.to_json
+      end
+
+      private
+
+      def parse_response(resp)
+        metrics = JSON.parse(resp, symbolize_names: true)[:metrics]
+
+        { items: metrics,
+          offset: 0,
+          limit: metrics.size,
+          totalItems: metrics.size,
+          moreItems: false }
+      rescue JSON::ParserError
+        nil
+      end
+
+      def extract_api_message(_status, resp)
+        resp.match(/^message='(.*)'/)[1]
+      rescue NoMethodError
+        ''
+      end
+    end
+  end
+end

data/lib/wavefront-sdk/unstable/unstable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wavefront
+  #
+  # Placeholder for unstable API classes
+  #
+  module Unstable
+  end
+end

data/lib/wavefront-sdk/usage.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # View and manage Wavefront usage.
+  #
+  # Ingestion policy shares this API path, but has its own SDK class.
+  #
+  class Usage < CoreApi
+    # GET /api/v2/usage/exportcsv
+    # Export a CSV report
+    #
+    # @param t_start [Integer] start time in epoch seconds
+    # @param t_end [Integer] end time in epoch seconds, nil being "now".
+    # @return [Wavefront::Response]
+    #
+    def export_csv(t_start, t_end = nil)
+      wf_epoch?(t_start)
+      args = { startTime: t_start }
+
+      if t_end
+        wf_epoch?(t_end)
+        args[:endTime] = t_end
+      end
+
+      api.get('exportcsv', args)
+    end
+  end
+end

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,10 +237,22 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def business_functions(id)
+      deprecation_warning
       wf_user_id?(id)
       api.get([id, 'businessFunctions'].uri_concat)
     end
 
+    # POST /api/v2/user/validateUsers
+    # Returns valid users and service accounts, also invalid identifiers from
+    # the given list
+    # @param id_list [Array[String]] list of user IDs
+    # @return [Wavefront::Response]
+    #
+    def validate_users(id_list)
+      deprecation_warning
+      api.post('validateUsers', id_list, 'application/json')
+    end
+
     # Fake a response which looks like we get from all the other
     # paths. I'm expecting the user response model to be made
     # consistent with others in the future.

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,65 @@ 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
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidIngestionPolicyId if the
+    #   ID is not valid
+    #
+    def wf_ingestionpolicy_id?(id)
+      return true if id.is_a?(String) && id =~ /^[a-z0-9\-_]+-\d{13}$/
+
+      raise Wavefront::Exception::InvalidIngestionPolicyId, id
+    end
+
+    # Ensure the given argument is a valid User or SystemAccount ID.
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidAccountId if the
+    #   ID is not valid
+    #
+    def wf_account_id?(id)
+      return true if wf_user_id?(id)
+    rescue Wavefront::Exception::InvalidUserId
+      begin
+        return true if wf_serviceaccount_id?(id)
+      rescue Wavefront::Exception::InvalidServiceAccountId
+        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
   end
   # rubocop:enable Metrics/ModuleLength