wavefront-sdk 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf113855e97fd18cd468edb2eb47cc94ff7551ffdfd4eae01d151f3dd83f843d
-  data.tar.gz: 2af7243524750797cb4da86732a0e39a0b7d050052a8b540ce732aa22a2ce516
+  metadata.gz: 4a1343ef6a630b783c158b7ff3373247ea541a22e1b3428a9bacc30c4bf6c4f0
+  data.tar.gz: bd9366f76e693b5ccafe6956ec841fde8816481bff27c24ce2f7167a150942d4
 SHA512:
-  metadata.gz: 8690b71bfe78192af6360fcebea3c95e19901d4f8f673d8fb557533d91982c2f394b9f4462e3e2827eb2d7171e25b9a11885d080e44c85ea6aeb0d66dceb01ea
-  data.tar.gz: 6ef9ab034e8f48df21a54aa122b1f6b6a3dbc03e716dcd91e4e1b752b918f71bb693912041aeadad0837692cb0fffd955d71e70ba9dca5f84390ce0c9e264ff2
+  metadata.gz: 4647a15bce3d481808699c017c21df2f08046e50a7931fc58b7b4c1249ad67315f779038aa619ec57f80ba714dff56d9cb46fed7c85feff70d1b66375e7aaea5
+  data.tar.gz: 8578a761628a6ce77a234d12ff59c084498bc2615448aaf905c8057f2230e2fd74df2638f4bbb7e9ebf6df74a963715f1c8bff2154e5894dff1fb51b67f8ff4c

data/HISTORY.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 3.5.0 (2019-09-30)
+* Extend `apitoken` class to cover new service account paths.
+
 ## 3.4.0 (2019-09-28)
 * Add `serviceaccount` class.
 * Validator exceptions now return the value which failed validation.

data/lib/wavefront-sdk/apitoken.rb

@@ -4,7 +4,7 @@ require_relative 'core/api'
 
 module Wavefront
   #
-  # View and manage API tokens
+  # View and manage API tokens for one's own user, and for service accounts.
   #
   class ApiToken < CoreApi
     # GET /api/v2/apitoken
@@ -47,5 +47,57 @@ module Wavefront
       wf_apitoken_id?(id)
       api.put(id, { tokenID: id, tokenName: name }, 'application/json')
     end
+
+    # GET /api/v2/apitoken/serviceaccount/{id}
+    # Get all api tokens for the given service account
+    #
+    # @param id [String] service account ID
+    # @return [Wavefront::Response]
+    #
+    def sa_list(id)
+      wf_serviceaccount_id?(id)
+      api.get(['serviceaccount', id].uri_concat)
+    end
+
+    # POST /api/v2/apitoken/serviceaccount/{id}
+    # Create a new api token for the service account
+    #
+    # @param id [String] service account ID
+    # @param name [String] optional name for token
+    # @return [Wavefront::Response]
+    #
+    def sa_create(id, name = nil)
+      wf_serviceaccount_id?(id)
+      body = {}.tap { |b| b[:tokenName] = name if name }
+      api.post(['serviceaccount', id].uri_concat, body, 'application/json')
+    end
+
+    # DELETE /api/v2/apitoken/serviceaccount/{id}/{token}
+    # Delete the specified api token of the given service account
+    #
+    # @param id [String] service account ID
+    # @param token_id [String] ID of the api token
+    # @return [Wavefront::Response]
+    #
+    def sa_delete(id, token_id)
+      wf_serviceaccount_id?(id)
+      wf_apitoken_id?(token_id)
+      api.delete(['serviceaccount', id, token_id].uri_concat)
+    end
+
+    # PUT /api/v2/apitoken/serviceaccount/{id}/{token}
+    # Update the name of the specified api token for the given service
+    # account
+    #
+    # @param id [String] service account ID
+    # @param token_id [String] ID of the api token
+    # @return [Wavefront::Response]
+    #
+    def sa_rename(id, token_id, name)
+      wf_serviceaccount_id?(id)
+      wf_apitoken_id?(token_id)
+      api.put(['serviceaccount', id, token_id].uri_concat,
+              { tokenID: token_id, tokenName: name }, 'application/json')
+    end
   end
 end

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

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

data/lib/wavefront-sdk/serviceaccount.rb

@@ -37,7 +37,7 @@ module Wavefront
     # GET /api/v2/account/serviceaccount/{id}
     # Retrieves a service account by identifier
     #
-    # @param id [String, Integer] ID of the account
+    # @param id [String] ID of the account
     # @return [Wavefront::Response]
     #
     def describe(id)
@@ -69,7 +69,7 @@ module Wavefront
     # POST /api/v2/account/serviceaccount/{id}/activate
     # Activates the given service account
     #
-    # @param id [String, Integer] ID of the account
+    # @param id [String] ID of the account
     # @return [Wavefront::Response]
     #
     def activate(id)
@@ -80,7 +80,7 @@ module Wavefront
     # POST /api/v2/account/serviceaccount/{id}/deactivate
     # Deactivates the given service account
     #
-    # @param id [String, Integer] ID of the account
+    # @param id [String] ID of the account
     # @return [Wavefront::Response]
     #
     def deactivate(id)

data/spec/spec_helper.rb

@@ -14,11 +14,15 @@ class WavefrontTestBase < MiniTest::Test
   attr_reader :wf, :wf_noop, :headers, :invalid_id, :valid_id
 
   def initialize(args)
-    require_relative "../lib/wavefront-sdk/#{class_basename.downcase}"
+    require_relative libfile_to_test
     setup_fixtures if respond_to?(:setup_fixtures)
     super(args)
   end
 
+  def libfile_to_test
+    "../lib/wavefront-sdk/#{class_basename.downcase}"
+  end
+
   private
 
   def setup

data/spec/wavefront-sdk/apitoken_spec.rb

@@ -2,13 +2,10 @@
 # frozen_string_literal: true
 
 require_relative '../spec_helper'
-require_relative '../test_mixins/general'
 
 # Unit tests for API token class
 #
 class WavefrontApiTokenTest < WavefrontTestBase
-  include WavefrontTest::Delete
-
   def test_list
     assert_gets('/api/v2/apitoken') { wf.list }
   end
@@ -19,22 +16,79 @@ class WavefrontApiTokenTest < WavefrontTestBase
   end
 
   def test_rename
-    assert_puts("/api/v2/apitoken/#{id}",
-                tokenID: id, tokenName: 'token name') do
-      wf.rename(id, 'token name')
+    assert_puts("/api/v2/apitoken/#{token_id}",
+                tokenID: token_id, tokenName: 'token name') do
+      wf.rename(token_id, 'token name')
     end
 
     assert_invalid_id { wf.rename(invalid_id, 'token name') }
     assert_raises(ArgumentError) { wf.rename }
+    assert_raises(ArgumentError) { wf.rename(token_id) }
+  end
+
+  def test_sa_list
+    assert_gets("/api/v2/apitoken/serviceaccount/#{id}") { wf.sa_list(id) }
+
+    assert_raises(Wavefront::Exception::InvalidServiceAccountId) do
+      wf.sa_list(invalid_id)
+    end
+  end
+
+  def test_sa_create
+    assert_posts("/api/v2/apitoken/serviceaccount/#{id}",
+                 tokenName: 'token name') do
+      wf.sa_create(id, 'token name')
+    end
+
+    assert_raises(Wavefront::Exception::InvalidServiceAccountId) do
+      wf.sa_create(invalid_id, 'token name')
+    end
+  end
+
+  def test_sa_rename
+    assert_puts("/api/v2/apitoken/serviceaccount/#{id}/#{token_id}",
+                tokenID: token_id, tokenName: 'new token name') do
+      wf.sa_rename(id, token_id, 'new token name')
+    end
+
+    assert_invalid_id { wf.sa_rename(id, invalid_token_id, 'token name') }
+    assert_raises(ArgumentError) { wf.sa_rename }
     assert_raises(ArgumentError) { wf.rename(id) }
+
+    assert_raises(Wavefront::Exception::InvalidServiceAccountId) do
+      wf.sa_rename(invalid_id, token_id, 'token name')
+    end
+  end
+
+  def test_delete
+    assert_deletes("/api/v2/apitoken/serviceaccount/#{id}/#{token_id}") do
+      wf.sa_delete(id, token_id)
+    end
+
+    assert_invalid_id { wf.sa_delete(id, invalid_token_id) }
+
+    assert_raises(Wavefront::Exception::InvalidServiceAccountId) do
+      wf.sa_delete(invalid_id, token_id)
+    end
+
+    assert_raises(ArgumentError) { wf.sa_delete(id) }
+    assert_raises(ArgumentError) { wf.sa_delete }
   end
 
   private
 
   def id
+    'sa::tester'
+  end
+
+  def token_id
     '17db4cc1-65f6-40a8-a1fa-6fcae460c4bd'
   end
 
+  def invalid_token_id
+    '__bad__'
+  end
+
   def invalid_id
     '__rubbish__'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-28 00:00:00.000000000 Z
+date: 2019-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable