wavefront-sdk 3.0.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc630d37510f6a1606b0680c2ea50245f569ac12d2091f8551766d9f9d6021a0
-  data.tar.gz: 8c458655085f9f1fd0ff7b1e2d4a01e4b277f29e500b8ec445705cbefa91b0c8
+  metadata.gz: c0d0b70537f8a1965c33603e7fa7a25493b9d9ff84d72badf3f5d587c7e51c70
+  data.tar.gz: add8ce51bf47032fbb1436db738f2985d2448db2c9b56767f654f816bacb30a2
 SHA512:
-  metadata.gz: 1450041d4c7877bee9de16e4c8942a80b6bd190f876a69bcdeb2f99afb70171eaa10ebff1db13a6d3519f021e4d0127ba8f8b47942a7626ee80e92fe3185d10e
-  data.tar.gz: 8ae22c21bd7338badc525648d8dac78b18255e1a32fa483ac188d3d4aa39e60b20d01ae93ac05ffe39ffc992c9e5c03c3e26929afd0ab669e02e980cb7d15700
+  metadata.gz: db92c24817827d785eb1e036be8f1398d94b1e16e2da59d1f3c7eaa65dcbc42309166c10e83d9d62468f38a6ca16ddc58d834650b66cb37034d4a09e43219894
+  data.tar.gz: 466acb6db568c0c1ac93b30fabe7b677b97df42657aa5414ae83c0ce2fa9b3dcfd52701c55a263dcb0bde232717bce6e324f59b17bc1a6dd7cbf9afd1188d126

data/HISTORY.md

@@ -1,9 +1,20 @@
 # Changelog
 
+## 3.2.0 (01/05/2019)
+* Add support for new `apitoken` path.
+* Add support for alert ACLs
+* Tag and ACL methods have been broken out into mixins which are
+  automatically included by classes which support them
+
+## 3.1.0 (23/04/2019)
+* When using `Wavefront::Write`, large numbers of points are written
+  in chunks, rather than all at once. The chunk size can be set by
+  the user when instantiating the class.
+
 ## 3.0.2 (06/04/2019)
 * Better handling of non-existent or malformed config files.
 * Look for `~/.wavefront.conf` as well as `~/.wavefront`. Both these
-  fixes are related to findind out that other Wavefront tooling
+  fixes are related to finding out that other Wavefront tooling
   creates `~/.wavefront` as a directory.
 
 ## 3.0.1 (05/04/2019)

data/README.md

@@ -254,6 +254,10 @@ symbol, or by using the `Write#write_delta()` method. This is called in
 exactly the same way as `Write#write`, and supports all the same
 options.
 
+If you try to send huge amounts of metrics in a single go,
+`Wavefront::Write` will break them up into smaller API-friendly
+chunks.
+
 #### Sending Distributions
 
 Use the `Wavefront::Distribution` class to send distributions via a

data/Rakefile

@@ -1,5 +1,6 @@
 require 'yard'
 require 'rake/testtask'
+require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
 
 task default: %i[rubocop test]

data/lib/wavefront-sdk/alert.rb

@@ -1,5 +1,7 @@
 require_relative 'defs/constants'
 require_relative 'core/api'
+require_relative 'api_mixins/acl'
+require_relative 'api_mixins/tag'
 
 module Wavefront
   #
@@ -7,8 +9,11 @@ module Wavefront
   # epoch timestamp. Returns a Wavefront::Response::Alert object.
   #
   class Alert < CoreApi
+    include Wavefront::Mixin::Acl
+    include Wavefront::Mixin::Tag
+
     def update_keys
-      %i[id name target condition displayExpression minutes
+      %i[id name target condition displayExpression minutes tag
          resolveAfterMinutes severity additionalInformation]
     end
 
@@ -68,6 +73,19 @@ module Wavefront
       api.get(fragments.uri_concat)
     end
 
+    # Gets all the versions of the given alert
+    # @param id [String] ID of the alert
+    # @reutrn [Wavefront::Resonse] where items is an array of integers
+    #
+    def versions(id)
+      wf_alert_id?(id)
+      resp = api.get([id, 'history'].uri_concat)
+
+      versions = resp.response.items.map(&:version)
+      resp.response[:items] = versions
+      resp
+    end
+
     # PUT /api/v2/alert/id
     # Update a specific alert.
     #
@@ -89,6 +107,22 @@ module Wavefront
               'application/json')
     end
 
+    # POST /api/v2/alert/{id}/clone
+    # Clones the specified alert
+    # @param id [String] ID of the alert
+    # @param version [Integer] version of alert
+    # @return [Wavefront::Response]
+    #
+    def clone(id, version = nil)
+      wf_alert_id?(id)
+      wf_version?(version) if version
+
+      api.post([id, 'clone'].uri_concat,
+               { id:   id,
+                 name: nil,
+                 v:    version }, 'application/json')
+    end
+
     # GET /api/v2/alert/id/history
     # Get the version history of a specific alert.
     #
@@ -126,55 +160,8 @@ module Wavefront
       api.post([id, "snooze#{qs}"].uri_concat, nil)
     end
 
-    # GET /api/v2/alert/id/tag
-    # Get all tags associated with a specific alert.
-    #
-    # @param id [String] ID of the alert
-    # @return [Wavefront::Response]
-    #
-    def tags(id)
-      wf_alert_id?(id)
-      api.get([id, 'tag'].uri_concat)
-    end
-
-    # POST /api/v2/alert/id/tag
-    # Set all tags associated with a specific alert.
-    #
-    # @param id [String] ID of the alert
-    # @param tags [Array] list of tags to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_set(id, tags)
-      wf_alert_id?(id)
-      tags = Array(tags)
-      tags.each { |t| wf_string?(t) }
-      api.post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
-    end
-
-    # DELETE /api/v2/alert/id/tag/tagValue
-    # Remove a tag from a specific alert.
-    #
-    # @param id [String] ID of the alert
-    # @param tag [String] tag to delete
-    # @return [Wavefront::Response]
-    #
-    def tag_delete(id, tag)
-      wf_alert_id?(id)
-      wf_string?(tag)
-      api.delete([id, 'tag', tag].uri_concat)
-    end
-
-    # PUT /api/v2/alert/id/tag/tagValue
-    # Add a tag to a specific alert.
-    #
-    # @param id [String] ID of the alert
-    # @param tag [String] tag to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_add(id, tag)
+    def valid_id?(id)
       wf_alert_id?(id)
-      wf_string?(tag)
-      api.put([id, 'tag', tag].uri_concat)
     end
 
     # POST /api/v2/alert/id/undelete

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

@@ -0,0 +1,76 @@
+module Wavefront
+  module Mixin
+    #
+    # ACL mixins
+    #
+    # Mix this module into class which supports ACLs, ensuring there is a
+    # valid_id? method to perform ID validation.
+    #
+    module Acl
+      # GET /api/v2/{entity}/acl
+      # Get list of Access Control Lists for the specified object
+      # @param id_list [Array[String]] array of object IDs
+      # @return [Wavefront::Response]
+      #
+      def acls(id_list)
+        id_list.each { |id| valid_id?(id) }
+        api.get_flat_params('acl', id: id_list)
+      end
+
+      # POST /api/v2/{entity}/acl/add
+      # Adds the specified ids to the given object's ACL
+      # @param id [String] ID of object
+      # @param view [Array[Hash]] array of entities allowed to view
+      #   the object. Entities may be users or groups, and are
+      #   defined as a Hash with keys :id and :name. For users the two
+      #   will be the same, for groups, not.
+      # @param modify [Array[Hash]] array of entities allowed to
+      #   view and modify the object. Same rules as @view.
+      # @return [Wavefront::Response]
+      #
+      def acl_add(id, view = [], modify = [])
+        valid_id?(id)
+
+        api.post(%w[acl add].uri_concat,
+                 acl_body(id, view, modify),
+                 'application/json')
+      end
+
+      # POST /api/v2/{entity}/acl/remove
+      # Removes the specified ids from the given object's ACL
+      #
+      # Though the API method is 'remove', the acl method names have
+      # been chosen to correspond with the tag methods.
+      #
+      def acl_delete(id, view = [], modify = [])
+        valid_id?(id)
+
+        api.post(%w[acl remove].uri_concat,
+                 acl_body(id, view, modify),
+                 'application/json')
+      end
+
+      # PUT /api/v2/{entity}/acl/set
+      # Set ACL for the specified object
+      #
+      def acl_set(id, view = [], modify = [])
+        api.put(%w[acl set].uri_concat, acl_body(id, view, modify))
+      end
+
+      private
+
+      def acl_body(id, view, modify)
+        valid_id?(id)
+        valid_acl_body?(view)
+        valid_acl_body?(modify)
+
+        [{ entityId: id, viewAcl: view, modifyAcl: modify }]
+      end
+
+      def valid_acl_body?(list)
+        return true if list.is_a?(Array) && list.all? { |h| h.is_a?(Hash) }
+        raise ArgumentError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module Wavefront
+  module Mixin
+    #
+    # Tagging support.
+    #
+    # Mix this module into class which supports tags, ensuring there is a
+    # valid_id? method to perform ID validation.
+    #
+    module Tag
+      # GET /api/v2/{object}/id/tag
+      # Get all tags associated with a specific object.
+      #
+      # @param id [String] ID of the object
+      # @return [Wavefront::Response]
+      #
+      def tags(id)
+        valid_id?(id)
+        api.get([id, 'tag'].uri_concat)
+      end
+
+      # POST /api/v2/{object}/id/tag
+      # Set all tags associated with a specific object.
+      #
+      # @param id [String] ID of the object
+      # @param tags [Array] list of tags to set.
+      # @return [Wavefront::Response]
+      #
+      def tag_set(id, tags)
+        valid_id?(id)
+        tags = Array(tags)
+        tags.each { |t| wf_string?(t) }
+        api.post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
+      end
+
+      # DELETE /api/v2/{object}/id/tag/tagValue
+      # Remove a tag from a specific object.
+      #
+      # @param id [String] ID of the object
+      # @param tag [String] tag to delete
+      # @return [Wavefront::Response]
+      #
+      def tag_delete(id, tag)
+        valid_id?(id)
+        wf_string?(tag)
+        api.delete([id, 'tag', tag].uri_concat)
+      end
+
+      # PUT /api/v2/{object}/id/tag/tagValue
+      # Add a tag to a specific object.
+      #
+      # @param id [String] ID of the object
+      # @param tag [String] tag to set.
+      # @return [Wavefront::Response]
+      #
+      def tag_add(id, tag)
+        valid_id?(id)
+        wf_string?(tag)
+        api.put([id, 'tag', tag].uri_concat)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Wavefront
+  module Mixin
+    #
+    # Things needed by User and UserGroup classes
+    #
+    module User
+      # Validate a list of users.
+      # @param list [Array[String]] list of user IDs
+      # @raise Wavefront::Exception::InvalidUser
+      #
+      def validate_user_list(list)
+        raise ArgumentError unless list.is_a?(Array)
+        list.each { |id| wf_user_id?(id) }
+      end
+
+      # Validate a list of user groups
+      # @param list [Array[String]] list of user group IDs
+      # @raise Wavefront::Exception::InvalidUserGroup
+      #
+      def validate_usergroup_list(list)
+        raise ArgumentError unless list.is_a?(Array)
+        list.each { |id| wf_usergroup_id?(id) }
+      end
+    end
+  end
+end

data/lib/wavefront-sdk/apitoken.rb

@@ -0,0 +1,49 @@
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # View and manage API tokens
+  #
+  class ApiToken < CoreApi
+    # GET /api/v2/apitoken
+    # Get all api tokens for a user
+    #
+    # @return [Wavefront::Response]
+    #
+    def list
+      api.get('')
+    end
+
+    # POST /api/v2/apitoken
+    # Create a new api token
+    #
+    # @return [Wavefront::Response]
+    #
+    def create
+      api.post('', nil, 'application/json')
+    end
+
+    # DELETE /api/v2/apitoken/id
+    # Delete the specified api token
+    #
+    # @param id [String] ID of the api token
+    # @return [Wavefront::Response]
+    #
+    def delete(id)
+      wf_apitoken_id?(id)
+      api.delete(id)
+    end
+
+    # PUT /api/v2/apitoken/id
+    # Update the name of the specified api token
+    #
+    # @param id [String] ID of the API token
+    # @param name [String] name of the API token
+    # @return [Wavefront::Response]
+
+    def rename(id, name)
+      wf_apitoken_id?(id)
+      api.put(id, { tokenID: id, tokenName: name }, 'application/json')
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module Wavefront
     class EnumerableError < RuntimeError; end
     class InvalidAlertId < RuntimeError; end
     class InvalidAlertSeverity < RuntimeError; end
+    class InvalidApiTokenId < RuntimeError; end
     class InvalidConfigFile < RuntimeError; end
     class InvalidCloudIntegrationId < RuntimeError; end
     class InvalidDashboardId < RuntimeError; end

data/lib/wavefront-sdk/dashboard.rb

@@ -1,10 +1,15 @@
 require_relative 'core/api'
+require_relative 'api_mixins/acl'
+require_relative 'api_mixins/tag'
 
 module Wavefront
   #
   # View and manage dashboards.
   #
   class Dashboard < CoreApi
+    include Wavefront::Mixin::Acl
+    include Wavefront::Mixin::Tag
+
     def update_keys
       %i[id name url description sections]
     end
@@ -106,57 +111,6 @@ module Wavefront
       api.get([id, 'history'].uri_concat)
     end
 
-    # GET /api/v2/dashboard/id/tag
-    # Get all tags associated with a specific dashboard.
-    #
-    # @param id [String] ID of the dashboard
-    # @return [Wavefront::Response]
-    #
-    def tags(id)
-      wf_dashboard_id?(id)
-      api.get([id, 'tag'].uri_concat)
-    end
-
-    # POST /api/v2/dashboard/id/tag
-    # Set all tags associated with a specific dashboard.
-    #
-    # @param id [String] ID of the dashboard
-    # @param tags [Array] list of tags to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_set(id, tags)
-      wf_dashboard_id?(id)
-      tags = Array(tags)
-      tags.each { |t| wf_string?(t) }
-      api.post([id, 'tag'].uri_concat, tags.to_json, 'application/json')
-    end
-
-    # DELETE /api/v2/dashboard/id/tag/tagValue
-    # Remove a tag from a specific dashboard.
-    #
-    # @param id [String] ID of the dashboard
-    # @param tag [String] tag to delete
-    # @return [Wavefront::Response]
-    #
-    def tag_delete(id, tag)
-      wf_dashboard_id?(id)
-      wf_string?(tag)
-      api.delete([id, 'tag', tag].uri_concat)
-    end
-
-    # PUT /api/v2/dashboard/id/tag/tagValue
-    # Add a tag to a specific dashboard.
-    #
-    # @param id [String] ID of the dashboard
-    # @param tag [String] tag to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_add(id, tag)
-      wf_dashboard_id?(id)
-      wf_string?(tag)
-      api.put([id, 'tag', tag].uri_concat)
-    end
-
     # POST /api/v2/dashboard/id/undelete
     # Move a dashboard from 'trash' back into active service.
     #
@@ -180,62 +134,8 @@ module Wavefront
     end
     alias unfavourite unfavorite
 
-    # GET /api/v2/dashboard/acl
-    # Get list of Access Control Lists for the specified dashboards
-    # @param id_list [Array[String]] array of dashboard IDs
-    # @return [Wavefront::Response]
-    #
-    def acls(id_list)
-      id_list.each { |id| wf_dashboard_id?(id) }
-      api.get_flat_params('acl', id: id_list)
-    end
-
-    # POST /api/v2/dashboard/acl/add
-    # Adds the specified ids to the given dashboards' ACL
-    # @param id [String] ID of dashboard
-    # @param view [Array[Hash]] array of entities allowed to view
-    #   the dashboard. Entities may be users or groups, and are
-    #   defined as a Hash with keys :id and :name. For users the two
-    #   will be the same, for groups, not.
-    # @param modify [Array[Hash]] array of entities allowed to
-    #   view and modify the dashboard. Same rules as @view.
-    # @return [Wavefront::Response]
-    #
-    def acl_add(id, view = [], modify = [])
-      api.post(%w[acl add].uri_concat,
-               acl_body(id, view, modify),
-               'application/json')
-    end
-
-    # POST /api/v2/dashboard/acl/remove
-    # Removes the specified ids from the given dashboards' ACL
-    #
-    # Though the API method is 'remove', the acl method names have
-    # been chosen to correspond with the tag methods.
-    #
-    def acl_delete(id, view = [], modify = [])
-      api.post(%w[acl remove].uri_concat,
-               acl_body(id, view, modify),
-               'application/json')
-    end
-
-    # PUT /api/v2/dashboard/acl/set
-    # Set ACL for the specified dashboards
-    #
-    def acl_set(id, view = [], modify = [])
-      api.put(%w[acl set].uri_concat, acl_body(id, view, modify))
-    end
-
-    private
-
-    def acl_body(id, view, modify)
+    def valid_id?(id)
       wf_dashboard_id?(id)
-
-      raise ArgumentError unless view.is_a?(Array) && modify.is_a?(Array)
-      raise ArgumentError unless view.all? { |h| h.is_a?(Hash) }
-      raise ArgumentError unless modify.all? { |h| h.is_a?(Hash) }
-
-      [{ entityId: id, viewAcl: view, modifyAcl: modify }]
     end
   end
 end