wavefront-sdk 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 578159c0ff0dac09b94caa4dac4e37f03436cb3e2b4cdda54886ce91b9ce4c9b
-  data.tar.gz: 93eac0630e97d53e3b26d222fd09df61f8cd7966c62e39520dbf27525982cb1b
+  metadata.gz: 97f7ce778de07ac5c70631f69d24c84bf9aad453dcf68ee28518f85b6bca7e03
+  data.tar.gz: d8b9d202a25cb88c501ac0e4101245c9c582990401b400ef759e057986b67864
 SHA512:
-  metadata.gz: e3f09ae6d818b0acc7e81e2e4da585c10a59efba18a4ab373679783d62b5a5ccc300e14435b7cbe8a0f2d64adec361e080c55f089732ffbb6c171f619524440e
-  data.tar.gz: d558a6d0eafe0d09120317113758ee70807cae035a7e9677a22cf643e537103ff66d671e7e6a031151cd03572f6b62a78e9aa92a86a2fb052f0cb31ba92c4f17
+  metadata.gz: 182e6262ddc79f9f88d94505c9b1488dd5f69e19d7e3edfb854ab74378519c83bf60056b709572c21a994c3420802a022eb4a9679395cc7f195e592ca9725c9e
+  data.tar.gz: 8a0fb76bc633bff58dbb8957fef6bf18a41f2bcc11baf27465a2a8b267625511bb0817207975f58c32daf9c51d78b4016fd1f155f121e509dc3b30ef016f87f0

data/.rubocop.yml

@@ -1,7 +1,48 @@
 ---
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Metrics/ClassLength:
   Max: 150
+
+# 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/HISTORY.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 5.0.0 (2020-07-08)
+* Remove `Wavefront::UserGroup#grant` and `Wavefront::UserGroup#revoke` as [the
+ API paths they used have been
+ removed](https://docs.wavefront.com/2020.06.x_release_notes.html#obsolete-and-deprecated-apis).
+ (Breaking change.)
+* Remove `Wavefront::MonitoredCluster` class, as it has been removed from the
+  public API.
+* Deprecate `Wavefront::User` class, as [the user API is now
+  deprecated](https://docs.wavefront.com/2020.06.x_release_notes.html#obsolete-and-deprecated-apis)
+* Add `Wavefront::Role` class, for managing roles.
+* Promote `Wavefront::Spy` class from unstable. It is now an official API.
+
 ## 4.0.0 (2020-02-17)
 * Drop support for Ruby 2.3. (Breaking change.)
 * Add `Wavefront::MonitoredCluster` class.

data/README.md

@@ -100,10 +100,11 @@ when you ask for a list of objects.
 
 You can set an offset and a limit when you list, but setting the
 limit to the magic value `:all` will return all items, without you
-having to deal with pagination.
+having to deal with pagination. When you do that, `offset` is repurposed as
+the number of results fetched with each call to the API.
 
 Calling a method with the limit set to `:lazy` returns a lazy
-enumerable.
+enumerable. Again, `offset` is the chunk size.
 
 ```ruby
 wf = Wavefront::Alert.new(creds.all)

data/lib/wavefront-sdk/account.rb

@@ -44,6 +44,18 @@ module Wavefront
       api.get(id)
     end
 
+    # POST /api/v2/account/{id}/addRoles
+    # Add specific roles to the account (user or service account)
+    # @param id [String] ID of the account
+    # @param role_list [Array[String]] list of roles to add
+    # @return [Wavefront::Response]
+    #
+    def add_roles(id, role_list)
+      wf_account_id?(id)
+      validate_role_list(role_list)
+      api.post([id, 'addRoles'].uri_concat, role_list, 'application/json')
+    end
+
     # POST /api/v2/account/{id}/addUserGroups
     # Adds specific user groups to the account (user or service account)
     # @param id [String] ID of the account
@@ -68,10 +80,22 @@ module Wavefront
       api.get([id, 'businessFunctions'].uri_concat)
     end
 
+    # POST /api/v2/account/{id}/removeRoles
+    # Removes specific roles from the account (user or service account)
+    # @param id [String] ID of the account
+    # @param role_list [Array[String]] list of roles to remove
+    # @return [Wavefront::Response]
+    #
+    def remove_roles(id, role_list)
+      wf_account_id?(id)
+      validate_role_list(role_list)
+      api.post([id, 'removeRoles'].uri_concat, role_list, 'application/json')
+    end
+
     # POST /api/v2/account/{id}/removeUserGroups
     # Removes specific user groups from the account (user or service account)
     # @param id [String] ID of the account
-    # @param group_list [Array[String]] list of groups to add
+    # @param group_list [Array[String]] list of groups to remove
     # @return [Wavefront::Response]
     #
     def remove_user_groups(id, group_list)
@@ -132,7 +156,8 @@ module Wavefront
     end
 
     # POST /api/v2/account/removeingestionpolicies
-    # Removes ingestion policies from multiple accounts
+    # Removes ingestion policies from multiple accounts. The API path says
+    # "policies" but I've made the method name "policy" for consistency.
     # @param policy_id [String] ID of the ingestion policy
     # @param id_list [Array[String]] list of accounts to be put in policy
     # @return [Wavefront::Response]
@@ -140,7 +165,7 @@ module Wavefront
     def remove_ingestion_policy(policy_id, id_list)
       wf_ingestionpolicy_id?(policy_id)
       validate_account_list(id_list)
-      api.post('removeingestionpolicy',
+      api.post('removeingestionpolicies',
                { ingestionPolicyId: policy_id,
                  accounts: id_list },
                'application/json')
@@ -157,6 +182,78 @@ module Wavefront
       api.post('deleteAccounts', id_list, 'application/json')
     end
 
+    # GET /api/v2/account/user
+    # Get all user accounts
+    # @param offset [Int] user account at which the list begins
+    # @param limit [Int] the number of user accounts to return
+    # @return [Wavefront::Response]
+    #
+    def user_list(offset = 0, limit = 100)
+      api.get('user', offset: offset, limit: limit)
+    end
+
+    def user_create(body, send_email = false)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      uri = send_email ? "?sendEmail=#{send_email}" : 'user'
+
+      api.post(uri, body, 'application/json')
+    end
+
+    # POST /api/v2/account/user
+    # Creates or updates a user account
+    # @param id [String] a Wavefront user ID
+    # @param body [Hash] key-value hash of the parameters you wish to change
+    # @param modify [true, false] if true, use {#describe()} to get a hash
+    #   describing the existing object, and modify that with the new body. If
+    #   false, pass the new body straight through.
+    # @return [Wavefront::Response]
+    def user_update(body, modify = true)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      return api.post('user', body, 'application/json') unless modify
+
+      api.post('user',
+               hash_for_update(describe(id).response, body),
+               'application/json')
+    end
+
+    # GET /api/v2/account/user/{id}
+    # Retrieves a user by identifier (email address)
+    # @param id [String] ID of the proxy
+    # @return [Wavefront::Response]
+    #
+    def user_describe(id)
+      wf_user_id?(id)
+      api.get(['user', id].uri_concat)
+    end
+
+    # POST /api/v2/account/user/invite
+    # Invite user accounts with given user groups and permissions.
+    # @param body [Array[Hash]] array of hashes, each hash describing a user.
+    #   See API docs for more details. It is your responsibility to validate
+    #   the data which describes each user.
+    # @return [Wavefront::Response]
+    #
+    def user_invite(body)
+      raise ArgumentError unless body.is_a?(Array)
+      raise ArgumentError unless body.first.is_a?(Hash)
+
+      api.post('user/invite', body, 'application/json')
+    end
+
+    # POST /api/v2/account/validateAccounts
+    # Returns valid accounts (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_accounts(id_list)
+      raise ArgumentError unless id_list.is_a?(Array)
+
+      api.post('validateAccounts', id_list, 'application/json')
+    end
+
     private
 
     # @param id [String] ID of the user
@@ -198,5 +295,9 @@ module Wavefront
       wf_permission?(permission)
       api.post(['revoke', permission].uri_concat, id_list, 'application/json')
     end
+
+    def update_keys
+      %i[identifier groups userGroups roles ingestionPolicyId]
+    end
   end
 end

data/lib/wavefront-sdk/api_mixins/user.rb

@@ -35,6 +35,16 @@ module Wavefront
 
         list.each { |id| wf_account_id?(id) }
       end
+
+      # Validate a list of roles
+      # @param list [Array[String]] list of role IDs
+      # @raise Wavefront::Exception::InvalidRole
+      #
+      def validate_role_list(list)
+        raise ArgumentError unless list.is_a?(Array)
+
+        list.each { |id| wf_role_id?(id) }
+      end
     end
   end
 end

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

@@ -38,6 +38,7 @@ module Wavefront
     class InvalidPoint < RuntimeError; end
     class InvalidPrefixLength < RuntimeError; end
     class InvalidProxyId < RuntimeError; end
+    class InvalidRoleId < RuntimeError; end
     class InvalidRelativeTime < RuntimeError; end
     class InvalidSamplingValue < RuntimeError; end
     class InvalidSavedSearchEntity < RuntimeError; end

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

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

data/lib/wavefront-sdk/paginator/base.rb

@@ -5,23 +5,29 @@ require_relative '../defs/constants'
 module Wavefront
   module Paginator
     #
-    # Automatically handle pagination. This is an abstract class
-    # made concrete by an extension for each HTTP request type.
+    # Automatically handle pagination. This is an abstract class made concrete
+    # by an extension for each HTTP request type.
     #
-    # This class and its children do slightly unpleasant things with
-    # the HTTP request passed to us by the user, extracting and
-    # changing values in the URI, query string, or POST/PUT body.
-    # The POST class is particularly onerous.
+    # This class and its children do slightly unpleasant things with the HTTP
+    # request passed to us by the user, extracting and changing values in the
+    # URI, query string, or POST/PUT body.  The POST class is particularly
+    # onerous.
     #
-    # Automatic pagination works by letting the user override the
-    # limit and offset values in API calls. Setting the limit to
-    # :all iteratively calls the Wavefront API, returning all
-    # requested objects an a standard Wavefront::Response wrapper;
-    # setting limit to :lazy returns a lazy Enumerable. The number
-    # of objects fetched in each API call, whether eager or lazy
-    # defaults to PAGE_SIZE, but the user can override that value by
-    # using the offset argument in conjunction with limit = :lazy |
-    # :all.
+    # Automatic pagination works by letting the user override the limit and
+    # offset values in API calls.
+    #
+    # * Calling with limit = :all iteratively calls the Wavefront API,
+    # returning all requested objects in a standard Wavefront::Response
+    # wrapper.
+    #
+    # * Calling with limit = :lazy returns a lazy Enumerable.
+    #
+    # The number of objects fetched in each API call, eager or lazy, defaults
+    # to PAGE_SIZE, but the user can override that value by using the offset
+    # argument in conjunction with limit = :lazy | :all.
+    #
+    # So, for example, to fetch all objects in blocks of ten (which could
+    # require a lot of API calls) you would use { limit: :all, offset: 10 }
     #
     class Base
       attr_reader :api_caller, :conn, :method, :args, :page_size,

data/lib/wavefront-sdk/query.rb

@@ -43,7 +43,6 @@ module Wavefront
       options[:s] = parse_time(t_start, true)
       options[:e] = parse_time(t_end, true) if t_end
 
-      options.delete_if { |k, v| v == false && k != :i }
       api.get('api', options)
     end
 

data/lib/wavefront-sdk/role.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+require_relative 'api_mixins/user'
+
+module Wavefront
+  #
+  # Manage and query Wavefront roles
+  #
+  class Role < CoreApi
+    include Wavefront::Mixin::User
+
+    def update_keys
+      %i[id name description]
+    end
+
+    # GET /api/v2/role
+    # Get all roles for a customer
+    # @param offset [Int] alert at which the list begins
+    # @param limit [Int] the number of alerts to return
+    # @return [Wavefront::Response]
+    #
+    def list(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # POST /api/v2/role
+    # Create a specific role
+    # @param body [Hash] a hash of parameters describing the role.  Please
+    #   refer to the Wavefront Swagger docs for key:value information
+    # @return [Wavefront::Response]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      api.post('', body, 'application/json')
+    end
+
+    # DELETE /api/v2/role/{id}
+    # Delete a specific role
+    # @param id [String] ID of the role
+    # @return [Wavefront::Response]
+    #
+    def delete(id)
+      wf_role_id?(id)
+      api.delete(id)
+    end
+
+    # GET /api/v2/role/{id}
+    # Get a specific role
+    # @param id [String] ID of the role
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_role_id?(id)
+      api.get(id)
+    end
+
+    # PUT /api/v2/role/{id}
+    # Update a specific role
+    # @param id [String] role ID
+    # @param body [Hash] key-value hash of the parameters you wish to change
+    # @param modify [true, false] if true, use {#describe()} to get a hash
+    #   describing the existing object, and modify that with the new body. If
+    #   false, pass the new body straight through.
+    # @return [Wavefront::Response]
+    #
+    def update(id, body, modify = true)
+      wf_role_id?(id)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      return api.put(id, body, 'application/json') unless modify
+
+      api.put(id, hash_for_update(describe(id).response, body),
+              'application/json')
+    end
+
+    # POST /api/v2/role/{id}/addAssignees
+    # Add multiple users and user groups to a specific role
+    # @param id [String] role ID
+    # @param assignees [Array[String]] list of roles or accounts to be added
+    # @return [Wavefront::Response]
+    #
+    def add_assignees(id, assignees)
+      wf_role_id?(id)
+      validate_user_list(assignees)
+      api.post([id, 'addAssignees'].uri_concat, assignees, 'application/json')
+    end
+
+    # POST /api/v2/role/{id}/removeAssignees
+    # Remove multiple users and user groups from a specific role
+    # @param id [String] role ID
+    # @param assignees [Array[String]] list of roles or accounts to be removed
+    # @return [Wavefront::Response]
+    #
+    def remove_assignees(id, assignees)
+      wf_role_id?(id)
+      validate_user_list(assignees)
+      api.post([id, 'removeAssignees'].uri_concat,
+               assignees,
+               'application/json')
+    end
+  end
+end

data/lib/wavefront-sdk/spy.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative 'defs/constants'
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Spy on data going into Wavefront
+  #
+  class Spy < CoreApi
+    # GET /api/spy/points
+    # Gets new metric data points that are added to existing time series.
+    # @param sampling [Float] the amount of points to sample, from 0
+    #   (none) to 1 (all)
+    # @param filter [Hash] with the following keys:
+    #   :prefix [String] only list points whose metric name begins with this
+    #     case-sensitive string
+    #   :host [Array] only list points if source name begins with this
+    #     case-sensitive string
+    #   :tag_key [String,Array[String]] only list points with one or more of
+    #     the given points tags
+    # @param options [Hash] with the following keys
+    #   :timestamp [Boolean] prefix each block of streamed data with a
+    #     timestamp
+    #   :timeout [Integer] how many seconds to run the spy. After this time
+    #     the method returns
+    # @raise Wavefront::Exception::InvalidSamplingValue
+    # @return [Nil]
+    #
+    def points(sampling = 0.01, filters = {}, options = {})
+      wf_sampling_value?(sampling)
+      api.get_stream('points', points_filter(sampling, filters), options)
+    end
+
+    # GET /api/spy/histograms
+    # Gets new histograms that are added to existing time series.
+    # @param sampling [Float] see #points
+    # @param filter [Hash] see #points
+    # @param options [Hash] see #points
+    # @raise Wavefront::Exception::InvalidSamplingValue
+    # @return [Nil]
+    #
+    def histograms(sampling = 0.01, filters = {}, options = {})
+      wf_sampling_value?(sampling)
+      api.get_stream('histograms',
+                     histograms_filter(sampling, filters),
+                     options)
+    end
+
+    # GET /api/spy/spans
+    # Gets new spans with existing source names and span tags.
+    # @param sampling [Float] see #points
+    # @param filter [Hash] see #points
+    # @param options [Hash] see #points
+    # @raise Wavefront::Exception::InvalidSamplingValue
+    # @return [Nil]
+    #
+    def spans(sampling = 0.01, filters = {}, options = {})
+      wf_sampling_value?(sampling)
+      api.get_stream('spans', spans_filter(sampling, filters), options)
+    end
+
+    # GET /api/spy/ids
+    # Gets newly allocated IDs that correspond to new metric names, source
+    # names, point tags, or span tags. A new ID generally indicates that a
+    # new time series has been introduced.
+    # @param sampling [Float] see #points
+    # @param filter [Hash] with keys:
+    #   :prefix [String] only list assignments whose metric name begins with
+    #     this case-sensitive string
+    #   :type [String] one of METRIC, SPAN, HOST or STRING
+    # @param options [Hash] see #points
+    #
+    def ids(sampling = 0.01, filters = {}, options = {})
+      wf_sampling_value?(sampling)
+      api.get_stream('ids', ids_filter(sampling, filters), options)
+    end
+
+    def api_path
+      '/api/spy'
+    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 points_filter(sampling, filters)
+      { metric: filters.fetch(:prefix, nil),
+        host: filters.fetch(:host, nil),
+        sampling: sampling,
+        pointTagKey: filters.fetch(:tag_key, nil) }.compact
+    end
+
+    def histograms_filter(sampling, filters)
+      { histogram: filters.fetch(:prefix, nil),
+        host: filters.fetch(:host, nil),
+        sampling: sampling,
+        histogramTagKey: filters.fetch(:tag_key, nil) }.compact
+    end
+
+    def spans_filter(sampling, filters)
+      { name: filters.fetch(:prefix, nil),
+        host: filters.fetch(:host, nil),
+        sampling: sampling,
+        spanTagKey: filters.fetch(:tag_key, nil) }.compact
+    end
+
+    def ids_filter(sampling, filters)
+      { name: filters.fetch(:prefix, nil),
+        type: filters.fetch(:type, nil),
+        sampling: sampling }.compact
+    end
+  end
+end