wavefront-sdk 4.0.0 → 5.0.0

data/spec/wavefront-sdk/metric_helper_spec.rb

@@ -118,7 +118,7 @@ class WavefrontMetricHelperTest < MiniTest::Test
     assert_equal(1, out.select do |o|
                       o[:value] == [[2, 10.0], [1, 11.0],
                                     [1, 12.0]]
-                    end .size)
+                    end.size)
     assert_equal(1, out.select { |o| o[:tags] == WH_TAGS }.size)
     assert_equal(3, out.select { |o| o[:path] == 'test.dist1' }.size)
   end

data/spec/wavefront-sdk/role_spec.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../test_mixins/general'
+
+# Unit tests for Wavefront::Role
+#
+class WavefrontRoleTest < WavefrontTestBase
+  include WavefrontTest::Create
+  include WavefrontTest::Delete
+  include WavefrontTest::Describe
+  include WavefrontTest::List
+  include WavefrontTest::Update
+
+  def test_add_assignees
+    assert_posts("/api/v2/role/#{id}/addAssignees", assignees.to_json) do
+      wf.add_assignees(id, assignees)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.add_assignees(invalid_id, assignees)
+    end
+  end
+
+  def test_remove_assignees
+    assert_posts("/api/v2/role/#{id}/removeAssignees", assignees.to_json) do
+      wf.remove_assignees(id, assignees)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.remove_assignees(invalid_id, assignees)
+    end
+  end
+
+  private
+
+  def api_class
+    :role
+  end
+
+  def id
+    'f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672'
+  end
+
+  def roles
+    %w[f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672
+       2659191e-aad4-4302-a94e-9667e1517127]
+  end
+
+  def assignees
+    roles.push('sa::test')
+  end
+
+  def invalid_id
+    '__BAD_ID__'
+  end
+
+  def payload
+    { name: 'test role',
+      permissions: %w[alerts_management events_management],
+      description: 'dummy role for unit tests' }
+  end
+
+  def permission
+    'alerts_management'
+  end
+end

data/spec/wavefront-sdk/{unstable/spy_spec.rb → spy_spec.rb}

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../../spec_helper'
-require_relative '../../../lib/wavefront-sdk/unstable/spy'
+require_relative '../spec_helper'
+require_relative '../../lib/wavefront-sdk/spy'
 
 # Unit tests for Spy class
 #
@@ -10,7 +10,7 @@ class WavefrontSpyTest < MiniTest::Test
   attr_reader :wf
 
   def setup
-    @wf = Wavefront::Unstable::Spy.new(CREDS)
+    @wf = Wavefront::Spy.new(CREDS)
   end
 
   def test_points

data/spec/wavefront-sdk/user_spec.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'logger'
 require_relative '../spec_helper'
 require_relative '../test_mixins/general'
 
@@ -13,6 +14,13 @@ class WavefrontUserTest < WavefrontTestBase
   include WavefrontTest::Describe
   include WavefrontTest::Update
 
+  # Override the parent constructor so we can suppress all the 'deprecated'
+  # log messages
+  #
+  def setup
+    @wf = Wavefront::User.new(CREDS, logger: Logger.new('/dev/null'))
+  end
+
   def test_list
     assert_gets('/api/v2/user') { wf.list }
   end

data/spec/wavefront-sdk/usergroup_spec.rb

@@ -7,7 +7,8 @@ require_relative '../test_mixins/general'
 # Unit tests for WavefrontUserGroup
 #
 class WavefrontUserGroupTest < WavefrontTestBase
-  attr_reader :users, :groups, :permission, :invalid_groups, :invalid_users
+  attr_reader :users, :groups, :permission, :invalid_groups, :invalid_users,
+              :roles, :invalid_roles
 
   include WavefrontTest::Create
   include WavefrontTest::Delete
@@ -39,22 +40,28 @@ class WavefrontUserGroupTest < WavefrontTestBase
     assert_invalid_id { wf.remove_users_from_group(invalid_id, users) }
   end
 
-  def test_grant
-    assert_posts("/api/v2/usergroup/grant/#{permission}",
-                 groups.to_json) do
-      wf.grant(permission, groups)
+  def test_add_roles_to_group
+    assert_posts("/api/v2/usergroup/#{id}/addRoles", roles.to_json) do
+      wf.add_roles_to_group(id, roles)
     end
 
-    assert_invalid_id { wf.grant(permission, invalid_groups) }
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.add_roles_to_group(id, invalid_roles)
+    end
+
+    assert_invalid_id { wf.add_roles_to_group(invalid_id, roles) }
   end
 
-  def test_revoke
-    assert_posts("/api/v2/usergroup/revoke/#{permission}",
-                 groups.to_json) do
-      wf.revoke(permission, groups)
+  def test_remove_roles_from_group
+    assert_posts("/api/v2/usergroup/#{id}/removeRoles", roles.to_json) do
+      wf.remove_roles_from_group(id, roles)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidRoleId) do
+      wf.remove_roles_from_group(id, invalid_roles)
     end
 
-    assert_invalid_id { wf.revoke(permission, invalid_groups) }
+    assert_invalid_id { wf.remove_roles_from_group(invalid_id, roles) }
   end
 
   def setup_fixtures
@@ -63,7 +70,10 @@ class WavefrontUserGroupTest < WavefrontTestBase
     @groups = %w[f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672
                  2659191e-aad4-4302-a94e-9667e1517127]
     @users = %w[someone@somewhere.com other@elsewhere.net]
+    @roles = %w[abcdef14-91a0-4ca9-8a2a-7d47f4db4672
+                fedcba1e-aad4-4302-a94e-9667e1517127]
     @invalid_users = ['bad' * 500, '']
+    @invalid_roles = ['some nonsense']
   end
 
   private

data/spec/wavefront-sdk/validators_spec.rb

@@ -401,4 +401,14 @@ class WavefrontValidatorsTest < MiniTest::Test
     bad = ['a', 0.1, 0.99, 1, -1, 1.1]
     good_and_bad('wf_sampling_value?', 'InvalidSamplingValue', good, bad)
   end
+
+  def test_wf_role_id
+    good = %w[2bfdcac7-1c9c-4c4b-9b56-c41c22c586dc
+              17db4cc1-65f6-40a8-a1fa-6fcae460c4bd
+              fca312fb-5ff4-420d-862d-5d6d99ed6bcf
+              3a1957e0-459e-49e5-9209-3888a4e8ac5b]
+
+    bad = %w[fa312fb-5ff4-420d-862d-5d6d99ed6bcf thing 123]
+    good_and_bad('wf_role_id?', 'InvalidRoleId', good, bad)
+  end
 end

data/wavefront-sdk.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'map', '~> 6.6'
 
   gem.add_development_dependency 'minitest', '~> 5.11'
-  gem.add_development_dependency 'rake', '~> 12.3'
-  gem.add_development_dependency 'rubocop', '~> 0.79'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rubocop', '~> 0.87'
   gem.add_development_dependency 'simplecov', '~> 0.16'
   gem.add_development_dependency 'spy', '~> 1.0.0'
   gem.add_development_dependency 'webmock', '~> 3.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.87'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.87'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +205,6 @@ files:
 - lib/wavefront-sdk/message.rb
 - lib/wavefront-sdk/metric.rb
 - lib/wavefront-sdk/metric_helper.rb
-- lib/wavefront-sdk/monitoredcluster.rb
 - lib/wavefront-sdk/notificant.rb
 - lib/wavefront-sdk/paginator/base.rb
 - lib/wavefront-sdk/paginator/delete.rb
@@ -215,11 +214,13 @@ files:
 - lib/wavefront-sdk/proxy.rb
 - lib/wavefront-sdk/query.rb
 - lib/wavefront-sdk/report.rb
+- lib/wavefront-sdk/role.rb
 - lib/wavefront-sdk/savedsearch.rb
 - lib/wavefront-sdk/search.rb
 - lib/wavefront-sdk/serviceaccount.rb
 - lib/wavefront-sdk/settings.rb
 - lib/wavefront-sdk/source.rb
+- lib/wavefront-sdk/spy.rb
 - lib/wavefront-sdk/stdlib/array.rb
 - lib/wavefront-sdk/stdlib/hash.rb
 - lib/wavefront-sdk/stdlib/string.rb
@@ -229,7 +230,6 @@ files:
 - lib/wavefront-sdk/types/status.rb
 - lib/wavefront-sdk/unstable/README.md
 - lib/wavefront-sdk/unstable/chart.rb
-- lib/wavefront-sdk/unstable/spy.rb
 - lib/wavefront-sdk/unstable/unstable.rb
 - lib/wavefront-sdk/usage.rb
 - lib/wavefront-sdk/user.rb
@@ -276,7 +276,6 @@ files:
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_helper_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
-- spec/wavefront-sdk/monitoredcluster_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
 - spec/wavefront-sdk/paginator/post_spec.rb
@@ -293,18 +292,19 @@ files:
 - spec/wavefront-sdk/resources/user_responses/describe.json
 - spec/wavefront-sdk/resources/user_responses/grant.json
 - spec/wavefront-sdk/resources/user_responses/list.json
+- spec/wavefront-sdk/role_spec.rb
 - spec/wavefront-sdk/savedsearch_spec.rb
 - spec/wavefront-sdk/search_spec.rb
 - spec/wavefront-sdk/serviceaccount_spec.rb
 - spec/wavefront-sdk/settings_spec.rb
 - spec/wavefront-sdk/source_spec.rb
+- spec/wavefront-sdk/spy_spec.rb
 - spec/wavefront-sdk/stdlib/array_spec.rb
 - spec/wavefront-sdk/stdlib/hash_spec.rb
 - spec/wavefront-sdk/stdlib/string_spec.rb
 - spec/wavefront-sdk/support/mixins_spec.rb
 - spec/wavefront-sdk/support/parse_time_spec.rb
 - spec/wavefront-sdk/unstable/chart_spec.rb
-- spec/wavefront-sdk/unstable/spy_spec.rb
 - spec/wavefront-sdk/usage_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/usergroup_spec.rb
@@ -374,7 +374,6 @@ test_files:
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_helper_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
-- spec/wavefront-sdk/monitoredcluster_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
 - spec/wavefront-sdk/paginator/post_spec.rb
@@ -391,18 +390,19 @@ test_files:
 - spec/wavefront-sdk/resources/user_responses/describe.json
 - spec/wavefront-sdk/resources/user_responses/grant.json
 - spec/wavefront-sdk/resources/user_responses/list.json
+- spec/wavefront-sdk/role_spec.rb
 - spec/wavefront-sdk/savedsearch_spec.rb
 - spec/wavefront-sdk/search_spec.rb
 - spec/wavefront-sdk/serviceaccount_spec.rb
 - spec/wavefront-sdk/settings_spec.rb
 - spec/wavefront-sdk/source_spec.rb
+- spec/wavefront-sdk/spy_spec.rb
 - spec/wavefront-sdk/stdlib/array_spec.rb
 - spec/wavefront-sdk/stdlib/hash_spec.rb
 - spec/wavefront-sdk/stdlib/string_spec.rb
 - spec/wavefront-sdk/support/mixins_spec.rb
 - spec/wavefront-sdk/support/parse_time_spec.rb
 - spec/wavefront-sdk/unstable/chart_spec.rb
-- spec/wavefront-sdk/unstable/spy_spec.rb
 - spec/wavefront-sdk/usage_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/usergroup_spec.rb

data/lib/wavefront-sdk/monitoredcluster.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'core/api'
-require_relative 'api_mixins/tag'
-
-module Wavefront
-  #
-  # Manage and query Wavefront monitored clusters
-  #
-  class MonitoredCluster < CoreApi
-    include Wavefront::Mixin::Tag
-
-    def update_keys
-      %i[id]
-    end
-
-    # GET /api/v2/monitoredcluster
-    # Get all monitored clusters
-    # @param offset [Integer] cluster at which the list begins
-    # @param limit [Integer] the number of clusters to return
-    # @return [Wavefront::Response]
-    #
-    def list(offset = 0, limit = 100)
-      api.get('', offset: offset, limit: limit)
-    end
-
-    # POST /api/v2/monitoredcluster
-    # Create a specific cluster
-    # @param body [Hash] a hash of parameters describing the cluster.
-    #   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/monitoredcluster/{id}
-    # Delete a specific cluster
-    # @param id [String, Integer] ID of the maintenance cluster
-    # @return [Wavefront::Response]
-    #
-    def delete(id)
-      wf_monitoredcluster_id?(id)
-      api.delete(id)
-    end
-
-    # GET /api/v2/monitoredcluster/{id}
-    # Get a specific cluster
-    # @param id [String, Integer] ID of the cluster
-    # @return [Wavefront::Response]
-    #
-    def describe(id)
-      wf_monitoredcluster_id?(id)
-      api.get(id)
-    end
-
-    # PUT /api/v2/monitoredcluster/{id}
-    # Update a specific cluster
-    # @return [Wavefront::Response]
-    #
-    def update(id, body, modify = true)
-      wf_monitoredcluster_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
-
-    # PUT /api/v2/monitoredcluster/merge/{id1}/{id2}
-    # Merge two monitored clusters. The first cluster will remain and the
-    # second cluster will be deleted, with its id added as an alias to the
-    # first cluster.
-    # @param id1 [String, Integer] ID of the target cluster
-    # @param id2 [String, Integer] ID of the other cluster
-    # @return [Wavefront::Response]
-    #
-    def merge(id1, id2)
-      wf_monitoredcluster_id?(id1)
-      wf_monitoredcluster_id?(id2)
-
-      api.put(['merge', id1, id2].uri_concat, nil, 'application/json')
-    end
-
-    def valid_id?(id)
-      wf_monitoredcluster_id?(id)
-    end
-  end
-end

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

@@ -1,134 +0,0 @@
-# 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.
-    #
-    # Everything about this API is different from the public one. To make it
-    # appear similar we must change various things we normally take for
-    # granted.
-    #
-    # This class is built according to the documentation at
-    # https://docs.wavefront.com/wavefront_monitoring_spy.html
-    #
-    class Spy < CoreApi
-      # https://<cluster>.wavefront.com/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
-
-      # 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
-
-      # https://<cluster>.wavefront.com/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
-
-      # https://<cluster>.wavefront.com/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
-end