wavefront-sdk 3.3.4 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e5b7ef712204907db606287f0d84d3c89a2784e9d8edbc53415b2277311081
-  data.tar.gz: e1f7e4c28c8c1d42194cff7c5ce6a5ec55b25dd838883159fba2b8e2a0faa6ee
+  metadata.gz: bf113855e97fd18cd468edb2eb47cc94ff7551ffdfd4eae01d151f3dd83f843d
+  data.tar.gz: 2af7243524750797cb4da86732a0e39a0b7d050052a8b540ce732aa22a2ce516
 SHA512:
-  metadata.gz: 9c55603c0db5ad279802221f3f7eb945e04f861743fb9599c4bbd97e03d51ca6902956ac9aa35202ef1271a6a0d13ee9d96d8cd26b0f89eb81192d2b65772b33
-  data.tar.gz: 2e922eb985d685075076ad3da8100296ae891fb645f00211b8ddb4a03b05f16708ed3f8a5a45761277cebec2394a3bc00cbf63b76b70291e94e456f10cb442cb
+  metadata.gz: 8690b71bfe78192af6360fcebea3c95e19901d4f8f673d8fb557533d91982c2f394b9f4462e3e2827eb2d7171e25b9a11885d080e44c85ea6aeb0d66dceb01ea
+  data.tar.gz: 6ef9ab034e8f48df21a54aa122b1f6b6a3dbc03e716dcd91e4e1b752b918f71bb693912041aeadad0837692cb0fffd955d71e70ba9dca5f84390ce0c9e264ff2

data/.travis.yml

@@ -2,9 +2,9 @@ language: ruby
 cache: bundler
 rvm:
   - 2.3.8
-  - 2.4.5
-  - 2.5.5
-  - 2.6.2
+  - 2.4.7
+  - 2.5.6
+  - 2.6.4
 before_install: gem install bundler --no-document
 deploy:
   provider: rubygems
@@ -14,7 +14,7 @@ deploy:
   on:
     tags: true
     repo: snltd/wavefront-sdk
-    ruby: 2.6.2
+    ruby: 2.6.4
 notifications:
   email: false
   slack:

data/HISTORY.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.4.0 (2019-09-28)
+* Add `serviceaccount` class.
+* Validator exceptions now return the value which failed validation.
+
 ## 3.3.4 (2019-09-18)
 * Upgrade Rubocop dev dependency to 0.74.0, and make codebase compliant with
   those standards. No interfaces are changed.

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

@@ -31,12 +31,14 @@ module Wavefront
     class InvalidMetricValue < RuntimeError; end
     class InvalidName < RuntimeError; end
     class InvalidNotificantId < RuntimeError; end
+    class InvalidPermission < RuntimeError; end
     class InvalidPoint < RuntimeError; end
     class InvalidPrefixLength < RuntimeError; end
     class InvalidProxyId < RuntimeError; end
     class InvalidRelativeTime < RuntimeError; end
     class InvalidSavedSearchEntity < RuntimeError; end
     class InvalidSavedSearchId < RuntimeError; end
+    class InvalidServiceAccountId < RuntimeError; end
     class InvalidSourceId < RuntimeError; end
     class InvalidString < RuntimeError; end
     class InvalidTag < RuntimeError; end

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

@@ -2,5 +2,5 @@
 
 require 'pathname'
 
-WF_SDK_VERSION = '3.3.4'
+WF_SDK_VERSION = '3.4.0'
 WF_SDK_LOCATION = Pathname.new(__dir__).parent.parent.parent

data/lib/wavefront-sdk/derivedmetric.rb

@@ -74,7 +74,7 @@ module Wavefront
     #   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_derivedmetric_id?(id)
       raise ArgumentError unless body.is_a?(Hash)

data/lib/wavefront-sdk/serviceaccount.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Manage and query Wavefront service accounts
+  #
+  class ServiceAccount < CoreApi
+    def api_base
+      '/account/serviceaccount'
+    end
+
+    # GET /api/v2/account/serviceaccount
+    # Get all service accounts
+    #
+    # @param offset [Integer] webhook at which the list begins
+    # @param limit [Integer] the number of webhooks to return
+    #
+    def list
+      api.get('')
+    end
+
+    # POST /api/v2/account/serviceaccount
+    # Creates a service account
+    # Refer to the Swagger API docs for valid keys.
+    #
+    # @param body [Hash] description of service account
+    # @return [Wavefront::Response]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      api.post('', body, 'application/json')
+    end
+
+    # GET /api/v2/account/serviceaccount/{id}
+    # Retrieves a service account by identifier
+    #
+    # @param id [String, Integer] ID of the account
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_serviceaccount_id?(id)
+      api.get(id)
+    end
+
+    # PUT /api/v2/account/serviceaccount/{id}
+    # Updates the service account
+    #
+    # @param id [String] a Wavefront service account 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_serviceaccount_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/account/serviceaccount/{id}/activate
+    # Activates the given service account
+    #
+    # @param id [String, Integer] ID of the account
+    # @return [Wavefront::Response]
+    #
+    def activate(id)
+      wf_serviceaccount_id?(id)
+      api.post([id, 'activate'].uri_concat, nil, 'application/json')
+    end
+
+    # POST /api/v2/account/serviceaccount/{id}/deactivate
+    # Deactivates the given service account
+    #
+    # @param id [String, Integer] ID of the account
+    # @return [Wavefront::Response]
+    #
+    def deactivate(id)
+      wf_serviceaccount_id?(id)
+      api.post([id, 'deactivate'].uri_concat, nil, 'application/json')
+    end
+
+    def update_keys
+      %i[description tokens groups userGroups active identifier]
+    end
+  end
+end

data/lib/wavefront-sdk/validators.rb

@@ -35,7 +35,7 @@ module Wavefront
         return true
       end
 
-      raise Wavefront::Exception::InvalidLinkTemplate
+      raise Wavefront::Exception::InvalidLinkTemplate, template
     end
 
     # Ensure the given argument is a valid Wavefront metric name, or
@@ -53,7 +53,7 @@ module Wavefront
         return true
       end
 
-      raise Wavefront::Exception::InvalidMetricName
+      raise Wavefront::Exception::InvalidMetricName, metric
     end
 
     # Ensure the given argument is a valid name, for instance for an
@@ -66,7 +66,7 @@ module Wavefront
     def wf_name?(name)
       return true if name.is_a?(String) && name.size < 1024 && name =~ /^\w+$/
 
-      raise Wavefront::Exception::InvalidName
+      raise Wavefront::Exception::InvalidName, name
     end
 
     # Ensure the given argument is a valid string, for a tag name.
@@ -85,7 +85,7 @@ module Wavefront
         return true
       end
 
-      raise Wavefront::Exception::InvalidString
+      raise Wavefront::Exception::InvalidString, str
     end
 
     # Ensure the given argument is a valid timestamp
@@ -97,7 +97,7 @@ module Wavefront
     def wf_ts?(timestamp)
       return true if timestamp.is_a?(Time) || timestamp.is_a?(Date)
 
-      raise Wavefront::Exception::InvalidTimestamp
+      raise Wavefront::Exception::InvalidTimestamp, timestamp
     end
 
     # Ensure the given argument is a valid millisecond epoch
@@ -112,7 +112,7 @@ module Wavefront
     def wf_ms_ts?(timestamp)
       return true if timestamp.is_a?(Numeric)
 
-      raise Wavefront::Exception::InvalidTimestamp
+      raise Wavefront::Exception::InvalidTimestamp, timestamp
     end
 
     # Ensure the given argument is a valid epoch timestamp. Again,
@@ -125,7 +125,7 @@ module Wavefront
     def wf_epoch?(timestamp)
       return true if timestamp.is_a?(Numeric)
 
-      raise Wavefront::Exception::InvalidTimestamp
+      raise Wavefront::Exception::InvalidTimestamp, timestamp
     end
 
     # Ensure one, or an array, of tags are valid. These tags are
@@ -140,7 +140,7 @@ module Wavefront
     def wf_tag?(*tags)
       Array(*tags).each do |tag|
         unless tag.is_a?(String) && tag.size < 255 && tag =~ /^[\w:\-\.]+$/
-          raise Wavefront::Exception::InvalidTag
+          raise Wavefront::Exception::InvalidTag, tag
         end
       end
 
@@ -157,7 +157,7 @@ module Wavefront
     def wf_value?(value)
       return true if value.is_a?(Numeric)
 
-      raise Wavefront::Exception::InvalidMetricValue
+      raise Wavefront::Exception::InvalidMetricValue, value
     end
 
     # Ensure the given argument is a valid version number
@@ -171,7 +171,7 @@ module Wavefront
       version = version.to_i if version.is_a?(String) && version =~ /^\d+$/
       return true if version.is_a?(Integer) && version.positive?
 
-      raise Wavefront::Exception::InvalidVersion
+      raise Wavefront::Exception::InvalidVersion, version
     end
 
     # Ensure a hash of key:value point tags are value. Not to be
@@ -200,7 +200,7 @@ module Wavefront
         return
       end
 
-      raise Wavefront::Exception::InvalidTag
+      raise Wavefront::Exception::InvalidTag, "#{key}=#{val}"
     end
 
     # Ensure the given argument is a valid Wavefront proxy ID
@@ -213,7 +213,7 @@ module Wavefront
     def wf_proxy_id?(id)
       return true if uuid?(id)
 
-      raise Wavefront::Exception::InvalidProxyId
+      raise Wavefront::Exception::InvalidProxyId, id
     end
 
     # Ensure the given argument is a valid Wavefront alert ID.
@@ -229,7 +229,7 @@ module Wavefront
       id = id.to_s if id.is_a?(Numeric)
       return true if id.is_a?(String) && id.match(/^\d{13}$/)
 
-      raise Wavefront::Exception::InvalidAlertId
+      raise Wavefront::Exception::InvalidAlertId, id
     end
 
     # Ensure the given argument is a valid Wavefront cloud
@@ -243,7 +243,7 @@ module Wavefront
     def wf_cloudintegration_id?(id)
       return true if uuid?(id)
 
-      raise Wavefront::Exception::InvalidCloudIntegrationId
+      raise Wavefront::Exception::InvalidCloudIntegrationId, id
     end
 
     # There doesn't seem to be a public statement on what's allowed
@@ -258,7 +258,7 @@ module Wavefront
     def wf_dashboard_id?(id)
       return true if id.is_a?(String) && id.size < 256 && id.match(/^[\w\-]+$/)
 
-      raise Wavefront::Exception::InvalidDashboardId
+      raise Wavefront::Exception::InvalidDashboardId, id
     end
 
     # Ensure the given argument is a valid derived metric ID.  IDs
@@ -273,7 +273,7 @@ module Wavefront
       id = id.to_s if id.is_a?(Numeric)
       return true if id.is_a?(String) && id =~ /^\d{13}$/
 
-      raise Wavefront::Exception::InvalidDerivedMetricId
+      raise Wavefront::Exception::InvalidDerivedMetricId, id
     end
 
     # Ensure the given argument is a valid event ID. Event IDs are
@@ -288,7 +288,7 @@ module Wavefront
     def wf_event_id?(id)
       return true if id.is_a?(String) && id =~ /^\d{13}:.+/
 
-      raise Wavefront::Exception::InvalidEventId
+      raise Wavefront::Exception::InvalidEventId, id
     end
 
     # Ensure the given argument is a valid external Link ID
@@ -301,7 +301,7 @@ module Wavefront
     def wf_link_id?(id)
       return true if id.is_a?(String) && id =~ /^\w{16}$/
 
-      raise Wavefront::Exception::InvalidExternalLinkId
+      raise Wavefront::Exception::InvalidExternalLinkId, id
     end
 
     # Ensure the given argument is a valid maintenance window ID.
@@ -316,7 +316,7 @@ module Wavefront
       id = id.to_s if id.is_a?(Numeric)
       return true if id.is_a?(String) && id =~ /^\d{13}$/
 
-      raise Wavefront::Exception::InvalidMaintenanceWindowId
+      raise Wavefront::Exception::InvalidMaintenanceWindowId, id
     end
 
     # Ensure the given argument is a valid alert severity
@@ -328,7 +328,7 @@ module Wavefront
     def wf_alert_severity?(severity)
       return true if %w[INFO SMOKE WARN SEVERE].include?(severity)
 
-      raise Wavefront::Exception::InvalidAlertSeverity
+      raise Wavefront::Exception::InvalidAlertSeverity, severity
     end
 
     # Ensure the given argument is a valid message ID
@@ -340,7 +340,7 @@ module Wavefront
     def wf_message_id?(id)
       return true if id.is_a?(String) && id =~ /^\w+::\w+$/
 
-      raise Wavefront::Exception::InvalidMessageId
+      raise Wavefront::Exception::InvalidMessageId, id
     end
 
     # Ensure the given argument is a valid query granularity
@@ -353,7 +353,7 @@ module Wavefront
     def wf_granularity?(granularity)
       return true if %w[d h m s].include?(granularity.to_s)
 
-      raise Wavefront::Exception::InvalidGranularity
+      raise Wavefront::Exception::InvalidGranularity, granularity
     end
 
     # Ensure the given argument is a valid saved search ID.
@@ -365,7 +365,7 @@ module Wavefront
     def wf_savedsearch_id?(id)
       return true if id.is_a?(String) && id =~ /^\w{8}$/
 
-      raise Wavefront::Exception::InvalidSavedSearchId
+      raise Wavefront::Exception::InvalidSavedSearchId, id
     end
 
     # Ensure the given argument is a valid saved search entity type.
@@ -380,7 +380,7 @@ module Wavefront
                         NOTIFICANT EVENT SOURCE EXTERNAL_LINK AGENT
                         CLOUD_INTEGRATION].include?(id)
 
-      raise Wavefront::Exception::InvalidSavedSearchEntity
+      raise Wavefront::Exception::InvalidSavedSearchEntity, id
     end
 
     # Ensure the given argument is a valid Wavefront source name
@@ -396,7 +396,7 @@ module Wavefront
         return true
       end
 
-      raise Wavefront::Exception::InvalidSourceId
+      raise Wavefront::Exception::InvalidSourceId, source
     end
 
     # Ensure the given argument is a valid user.
@@ -408,7 +408,7 @@ module Wavefront
     def wf_user_id?(user)
       return true if user.is_a?(String) && user.length < 256 && !user.empty?
 
-      raise Wavefront::Exception::InvalidUserId
+      raise Wavefront::Exception::InvalidUserId, user
     end
 
     # Ensure the given argument is a valid user group.
@@ -420,7 +420,7 @@ module Wavefront
     def wf_usergroup_id?(gid)
       return true if uuid?(gid)
 
-      raise Wavefront::Exception::InvalidUserGroupId
+      raise Wavefront::Exception::InvalidUserGroupId, gid
     end
 
     # Ensure the given argument is a valid webhook ID.
@@ -432,7 +432,7 @@ module Wavefront
     def wf_webhook_id?(id)
       return true if id.is_a?(String) && id =~ /^[a-zA-Z0-9]{16}$/
 
-      raise Wavefront::Exception::InvalidWebhookId
+      raise Wavefront::Exception::InvalidWebhookId, id
     end
 
     # Validate a point so it conforms to the standard described in
@@ -491,7 +491,7 @@ module Wavefront
     def wf_notificant_id?(id)
       return true if id.is_a?(String) && id =~ /^\w{16}$/
 
-      raise Wavefront::Exception::InvalidNotificantId
+      raise Wavefront::Exception::InvalidNotificantId, id
     end
 
     # Ensure the given argument is a valid Wavefront
@@ -505,7 +505,7 @@ module Wavefront
     def wf_integration_id?(id)
       return true if id.is_a?(String) && id =~ /^[a-z0-9]+$/
 
-      raise Wavefront::Exception::InvalidIntegrationId
+      raise Wavefront::Exception::InvalidIntegrationId, id
     end
 
     # Ensure the given argument is a valid distribution interval.
@@ -516,7 +516,7 @@ module Wavefront
     def wf_distribution_interval?(interval)
       return true if %i[m h d].include?(interval)
 
-      raise Wavefront::Exception::InvalidDistributionInterval
+      raise Wavefront::Exception::InvalidDistributionInterval, interval
     end
 
     # Ensure the given argument is a valid distribution count.
@@ -527,18 +527,46 @@ module Wavefront
     def wf_distribution_count?(count)
       return true if count.is_a?(Integer) && count.positive?
 
-      raise Wavefront::Exception::InvalidDistributionCount
+      raise Wavefront::Exception::InvalidDistributionCount, count
     end
 
     # Ensure the given argument is a valid API token ID
     # @param id [String]
     # @raise Wavefront::Exception::InvalidApiTokenId if the
-    #   count is not valid
+    #   token ID is not valid
     #
     def wf_apitoken_id?(id)
       return true if uuid?(id)
 
-      raise Wavefront::Exception::InvalidApiTokenId
+      raise Wavefront::Exception::InvalidApiTokenId, id
+    end
+
+    # Ensure the given argument is a valid service account ID
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidApiTokenId if the
+    #   ID is not valid
+    #
+    def wf_serviceaccount_id?(id)
+      return true if id.is_a?(String) && id.start_with?('sa::')
+
+      raise Wavefront::Exception::InvalidServiceAccountId, id
+    end
+
+    # Ensure the given argument is a Wavefront permission
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidApiTokenId if the
+    #   ID is not valid
+    #
+    def wf_permission?(id)
+      if %w[alerts_management batch_query_priority embedded_charts
+            dashboard_management derived_metrics_management ingestion
+            events_management external_links_management
+            application_management metrics_management agent_management
+            host_tag_management user_management].include?(id)
+        return true
+      end
+
+      raise Wavefront::Exception::InvalidPermission, id, id
     end
   end
   # rubocop:enable Metrics/ModuleLength

data/spec/.rubocop.yml

@@ -5,7 +5,7 @@ Metrics/AbcSize:
 # Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 279
+  Max: 300
 
 # Offense count: 46
 # Configuration parameters: CountComments, ExcludedMethods.

data/spec/support/minitest_assertions.rb

@@ -85,12 +85,12 @@ module Minitest
     end
 
     def extra_headers(payload, type)
-      if payload.nil?
+      if type
+        header_lookup(type)
+      elsif payload.nil?
         header_lookup(:plain)
       elsif type.nil?
         header_lookup(:json)
-      else
-        header_lookup(type)
       end
     end
 

data/spec/wavefront-sdk/serviceaccount_spec.rb

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../test_mixins/general'
+
+# Unit tests for ServiceAccount class
+#
+class WavefrontServiceAccountTest < WavefrontTestBase
+  # include WavefrontTest::Create
+  # include WavefrontTest::Describe
+  # include WavefrontTest::Update
+
+  # def test_list
+  # assert_gets('/api/v2/account/serviceaccount') { wf.list }
+  # end
+
+  def test_activate
+    assert_posts("/api/v2/account/serviceaccount/#{id}/activate", nil,
+                 :json) do
+      wf.activate(id)
+    end
+
+    assert_invalid_id { wf.activate(invalid_id) }
+    assert_raises(ArgumentError) { wf.activate }
+  end
+
+  def test_deactivate
+    assert_posts("/api/v2/account/serviceaccount/#{id}/deactivate", nil,
+                 :json) do
+      wf.deactivate(id)
+    end
+
+    assert_invalid_id { wf.deactivate(invalid_id) }
+    assert_raises(ArgumentError) { wf.deactivate }
+  end
+
+  private
+
+  def api_class
+    'account/serviceaccount'
+  end
+
+  def id
+    'sa::tester'
+  end
+
+  def invalid_id
+    'bad_id'
+  end
+
+  def payload
+    { identifier: id,
+      description: 'some info',
+      tokens: [
+        'f8dc0c14-91a0-4ca9-8a2a-7d47f4db4672'
+      ],
+      userGroups: [
+        '2659191e-aad4-4302-a94e-9667e1517127'
+      ],
+      groups: [
+        'agent_management'
+      ] }
+  end
+end

data/spec/wavefront-sdk/validators_spec.rb

@@ -351,4 +351,18 @@ class WavefrontValidatorsTest < MiniTest::Test
     good_and_bad('wf_distribution_interval?',
                  'InvalidDistributionInterval', good, bad)
   end
+
+  def test_serviceaccount_id
+    good = %w[sa::my-id sa::ID]
+    bad = %w[sc:id fca312fb-5ff4-420d-862d-5d6d99ed6bcf]
+    good_and_bad('wf_serviceaccount_id?',
+                 'InvalidServiceAccountId', good, bad)
+  end
+
+  def test_permission
+    good = %w[events_management external_links_management]
+    bad = ['events management', 'event_management', 'EVENT_MANAGEMENT']
+    good_and_bad('wf_permission?',
+                 'InvalidPermission', good, bad)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 3.3.4
+  version: 3.4.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-18 00:00:00.000000000 Z
+date: 2019-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -214,6 +214,7 @@ files:
 - lib/wavefront-sdk/report.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/stdlib/array.rb
@@ -282,6 +283,7 @@ files:
 - spec/wavefront-sdk/resources/user_responses/list.json
 - 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/stdlib/array_spec.rb
@@ -373,6 +375,7 @@ test_files:
 - spec/wavefront-sdk/resources/user_responses/list.json
 - 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/stdlib/array_spec.rb