wavefront-sdk 6.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 839f24e0a1a324b6965cb8aec1c0516bcb7c193215bc3cb6c1351f888bd49863
-  data.tar.gz: 97ba3cce211abdef8d1b08265279a2998f968a6f85a58290efe26d8109314940
+  metadata.gz: 81df2a4acef6e05c259a4c835aa9591dce558c15eb42771c1cfd722736745e1a
+  data.tar.gz: 3315abd4368904f2debce8df47ce4a0654c58b2e8112c1c241c15d23ec5717fb
 SHA512:
-  metadata.gz: 2d72451c46077024d79451aaea09efec073db0dcfb6dfb7601382973f80b14c99cd3b732bf57ec09a1ec962938b2219470676ba84c47b27051b5d2970cdeb8ef
-  data.tar.gz: fdf2b294468db11835722f3ffbcbac2e77a42a12d8083c4e7536f637659bf8e063de0b75f023e71a46d2a25e942ad197e16e70a4229db5142b741542dbaaf2f7
+  metadata.gz: 107545fb991c8dac3165ba90dc676b79d416bb16fff9a4a1551be4cdb4cea72910e3fdb6ab1731c858561064be5423b4d5605913a7d5fcb4e4e19d11a217976e
+  data.tar.gz: 006de9abcb517ef2feaef266c0578ac6ac36c60870cc510abf13cb4eee8ee69983a7eab41f3ca289e426f9cce11a9c9c9adf3b24c81e5b5e763fb793e9d0f3d6

data/.github/workflows/release.yml

@@ -11,14 +11,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set env
       run: echo "RELEASE_VERSION=$(echo ${GITHUB_REF:10})" >> $GITHUB_ENV
 
-    - name: Set up Ruby 2.7
+    - name: Set up Ruby 3.2
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.2
     - run: bundle install
 
     - name: Run tests
@@ -34,4 +34,4 @@ jobs:
         chmod 0600 ${HOME}/.gem/credentials
         gem push pkg/*.gem
       env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_PUSH_KEY}}"

data/.github/workflows/test.yml

@@ -9,9 +9,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.5.9, 2.6.7, 2.7.3, 3.0.1]
+        ruby-version: [3.0, 3.1, 3.2]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.rubocop.yml

@@ -1,7 +1,7 @@
 ---
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
   NewCops: enable
 
 require:
@@ -14,7 +14,5 @@ Layout/LineLength:
   Max: 80
 Metrics/ClassLength:
   Max: 150
-Style/StringConcatenation:
-  Enabled: false
 Style/OptionalBooleanParameter:
   Enabled: false

data/Gemfile

@@ -2,3 +2,14 @@
 
 source 'https://rubygems.org'
 gemspec
+
+gem 'minitest', '~> 5.17', group: :development
+gem 'rake', '~> 13.0', group: :development
+gem 'rubocop', '~> 1.51', group: :development
+gem 'rubocop-minitest', '~> 0.31', group: :development
+gem 'rubocop-performance', '~> 1.19', group: :development
+gem 'rubocop-rake', '~> 0.6', group: :development
+gem 'simplecov', '~> 0.22', group: :development
+gem 'spy', '~> 1.0', group: :development
+gem 'webmock', '~> 3.19', group: :development
+gem 'yard', '~> 0.9', group: :development

data/HISTORY.md

@@ -1,14 +1,42 @@
 # Changelog
 
+## 8.0.0 (2023-09-06)
+* Drop support for Ruby 2.7 (Breaking change.)
+* Correctly report errors when sending points to API.
+* Bump dependencies.
+* Add `Wavefront::AccessPolicy` class.
+* Add `Wavefront::Cluster` class to cover "wavefront" endpoint.
+* Add `Wavefront::Alert#check_query`.
+* Add `Wavefront::Alert#preview`.
+* Add `Wavefront::Internal` class to show API coverage.
+* Add `Wavefront::Account#admins`.
+* Add `Wavefront::Account#update_perms`.
+* Add `Wavefront::Integration#manifest_min`.
+* Add `Wavefront::Proxy#config`.
+* Add `Wavefront::Proxy#preprocessor_rules`.
+* Add `version` parameter to `Wavefront::IngestionPolicy#describe`.
+* Add `Wavefront::IngestionPolicy#history`.
+* Add `Wavefront::IngestionPolicy#revert`.
+* Add `Wavefront::ApiToken#list_customer_tokens`.
+* Add `Wavefront::ApiToken#describe_customer_token`.
+* Add `Wavefront::ApiToken#revoke_customer_token`, though it does nothing.
+* Add `Wavefront::MonitoredApplication` class.
+* Add `Wavefront::SpanSamplingPolicy` class.
+
+## 7.0.0 (2023-01-19)
+* Drop support for Ruby 2.5. (Breaking change.)
+* Drop support for Ruby 2.6. (Breaking change.)
+* Bugfix for `metricspolicy` API.
+
 ## 6.0.0 (2021-07-16)
 * Drop support for Ruby 2.4. (Breaking change.)
 * Change the name of the proxy writer from `socket` to `proxy`. (Breaking
   change.)
 * Change the name of the Unix datagram socket writer from `unix` to `socket`.
-* added `Wavefront::Event#alert_firing_details`.
-* added `Wavefront::Event#alert_queries_slug`.
-* added `Wavefront::Event#events`.
-* added `Wavefront::Event#alert_firings`.
+* Add `Wavefront::Event#alert_firing_details`.
+* Add `Wavefront::Event#alert_queries_slug`.
+* Add `Wavefront::Event#events`.
+* Add `Wavefront::Event#alert_firings`.
 * Add `Wavefront::MetricsPolicy`.
 * Add `Wavefront::Spy#deltas`.
 

data/README.md

@@ -1,6 +1,6 @@
 # wavefront-sdk
-[![Test](https://github.com/snltd/wavefront-sdk/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/snltd/wavefront-sdk/actions/workflows/test.yml) [![Release](https://github.com/snltd/wavefront-sdk/actions/workflows/release.yml/badge.svg?branch=master)](https://github.com/snltd/wavefront-sdk/actions/workflows/release.yml) [![Code Climate](https://codeclimate.com/github/snltd/wavefront-sdk/badges/gpa.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Issue Count](https://codeclimate.com/github/snltd/wavefront-sdk/badges/issue_count.svg)](https://codeclimate.com/github/snltd/wavefront-sdk) [![Gem Version](https://badge.fury.io/rb/wavefront-sdk.svg)](https://badge.fury.io/rb/wavefront-sdk) ![](http://ruby-gem-downloads-badge.herokuapp.com/wavefront-sdk?type=total)
-
+[![Test](https://github.com/snltd/wavefront-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/snltd/wavefront-sdk/actions/workflows/test.yml) [![Release](https://github.com/snltd/wavefront-sdk/actions/workflows/release.yml/badge.svg)](https://github.com/snltd/wavefront-sdk/actions/workflows/release.yml) [![Gem Version](https://badge.fury.io/rb/wavefront-sdk.png)](https://badge.fury.io/rb/wavefront-sdk)
+ 
 This is a Ruby SDK for v2 of
 [Wavefront](https://www.wavefront.com/)'s public API. It aims to be
 more lightweight, consistent, simple, and convenient than an
@@ -24,7 +24,7 @@ or to build locally,
 $ gem build wavefront-sdk.gemspec
 ```
 
-`wavefront-sdk` requires Ruby >= 2.5. All its dependencies are pure
+`wavefront-sdk` requires Ruby >= 3.0. All its dependencies are pure
 Ruby, right the way down, so a compiler should never be required to
 install it.
 

data/lib/wavefront-sdk/accesspolicy.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Manage and query the Wavefront access policy
+  #
+  class AccessPolicy < CoreApi
+    # GET /api/v2/accesspolicy
+    # Get the access policy
+    # @return [Wavefront::Response]
+    #
+    def describe
+      api.get('')
+    end
+
+    # PUT /api/v2/accesspolicy
+    # Update the access policy
+    # @param body [Hash] hash describing access policy
+    # @return [Wavefront::Response]
+    #
+    def update(body)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      api.put('', body, 'application/json')
+    end
+
+    # GET /api/v2/accesspolicy/validate
+    # Validate a given url and ip address
+    # @return [Wavefront::Response]
+    #
+    def validate(ip)
+      api.get('validate', ip: ip)
+    end
+  end
+end

data/lib/wavefront-sdk/account.rb

@@ -44,6 +44,34 @@ module Wavefront
       api.get(id)
     end
 
+    # GET /api/v2/account/user/admin
+    # Get all users with Accounts permission
+    #
+    def admins
+      api.get('user/admin')
+    end
+
+    # PUT /api/v2/account/user/{id}
+    # Update user with given user groups and permissions.
+    #
+    # @param id [String] a Wavefront 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_perms(id, body, modify = true)
+      wf_account_id?(id)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      return api.put(['user', id], body, 'application/json') unless modify
+
+      api.put(['user', id], hash_for_update(describe(id).response, body),
+              'application/json')
+    end
+
     # POST /api/v2/account/{id}/addRoles
     # Add specific roles to the account (user or service account)
     # @param id [String] ID of the account

data/lib/wavefront-sdk/alert.rb

@@ -44,7 +44,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/alert/id
+    # DELETE /api/v2/alert/{id}
     # Delete a specific alert.
     #
     # Deleting an active alert moves it to 'trash', from where it can
@@ -59,8 +59,8 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/alert/id
-    # GET /api/v2/alert/id/history/version
+    # GET /api/v2/alert/{id}
+    # GET /api/v2/alert/{id}/history/{version}
     # Get a specific alert / Get a specific historical version of a
     # specific alert.
     #
@@ -76,9 +76,10 @@ module Wavefront
       api.get(fragments.uri_concat)
     end
 
-    # Gets all the versions of the given alert
+    # GET /api/v2/alert/{id}/history
+    # Get the version history of a specific alert
     # @param id [String] ID of the alert
-    # @reutrn [Wavefront::Resonse] where items is an array of integers
+    # @return [Wavefront::Response]
     #
     def versions(id)
       wf_alert_id?(id)
@@ -91,7 +92,7 @@ module Wavefront
       resp
     end
 
-    # PUT /api/v2/alert/id
+    # PUT /api/v2/alert/{id}
     # Update a specific alert.
     #
     # @param id [String] a Wavefront alert ID
@@ -128,7 +129,7 @@ module Wavefront
                  v: version }, 'application/json')
     end
 
-    # GET /api/v2/alert/id/history
+    # GET /api/v2/alert/{id}/history
     # Get the version history of a specific alert.
     #
     # @param id [String] ID of the alert
@@ -151,7 +152,7 @@ module Wavefront
       api.post([id, 'install'].uri_concat, nil)
     end
 
-    # POST /api/v2/alert/id/snooze
+    # POST /api/v2/alert/{id}/snooze
     # Snooze a specific alert for some number of seconds.
     #
     # @param id [String] ID of the alert
@@ -169,7 +170,7 @@ module Wavefront
       wf_alert_id?(id)
     end
 
-    # POST /api/v2/alert/id/undelete
+    # POST /api/v2/alert/{id}/undelete
     # Undelete a specific alert.
     #
     # @param id [String] ID of the alert
@@ -188,7 +189,7 @@ module Wavefront
       api.post([id, 'uninstall'].uri_concat, nil)
     end
 
-    # POST /api/v2/alert/id/unsnooze
+    # POST /api/v2/alert/{id}/unsnooze
     # Unsnooze a specific alert.
     #
     # @param id [String] ID of the alert
@@ -199,6 +200,24 @@ module Wavefront
       api.post([id, 'unsnooze'].uri_concat)
     end
 
+    # POST /api/v2/alert/checkQuery
+    # Return the type of provided query.
+    # @param query [Hash] description of query
+    # @return [Wavefront::Response]
+    #
+    def check_query(query)
+      api.post('checkQuery', query, 'application/json')
+    end
+
+    # POST /api/v2/alert/preview
+    # Get all the notification preview for a specific alert
+    # @param alert [Hash] description of alert
+    # @return [Wavefront::Response]
+    #
+    def preview(alert)
+      api.post('preview', alert, 'application/json')
+    end
+
     # GET /api/v2/alert/summary
     # Count alerts of various statuses for a customer
     #

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

@@ -9,10 +9,10 @@ module Wavefront
     # valid_id? method to perform ID validation.
     #
     module Tag
-      # GET /api/v2/{object}/id/tag
-      # Get all tags associated with a specific object.
+      # GET /api/v2/{entity}/{id}/tag
+      # Get all tags associated with a specific entity.
       #
-      # @param id [String] ID of the object
+      # @param id [String] ID of the entity
       # @return [Wavefront::Response]
       #
       def tags(id)
@@ -20,10 +20,10 @@ module Wavefront
         api.get([id, 'tag'].uri_concat)
       end
 
-      # POST /api/v2/{object}/id/tag
-      # Set all tags associated with a specific object.
+      # POST /api/v2/{entity}/{id}/tag
+      # Set all tags associated with a specific entity.
       #
-      # @param id [String] ID of the object
+      # @param id [String] ID of the entity
       # @param tags [Array] list of tags to set.
       # @return [Wavefront::Response]
       #
@@ -34,10 +34,10 @@ module Wavefront
         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.
+      # DELETE /api/v2/{entity}/{id}/tag/{tagValue}
+      # Remove a tag from a specific entity.
       #
-      # @param id [String] ID of the object
+      # @param id [String] ID of the entity
       # @param tag [String] tag to delete
       # @return [Wavefront::Response]
       #
@@ -47,10 +47,10 @@ module Wavefront
         api.delete([id, 'tag', tag].uri_concat)
       end
 
-      # PUT /api/v2/{object}/id/tag/tagValue
-      # Add a tag to a specific object.
+      # PUT /api/v2/{entity}/{id}/tag/{tagValue}
+      # Add a tag to a specific entity.
       #
-      # @param id [String] ID of the object
+      # @param id [String] ID of the entity
       # @param tag [String] tag to set.
       # @return [Wavefront::Response]
       #

data/lib/wavefront-sdk/apitoken.rb

@@ -25,7 +25,25 @@ module Wavefront
       api.post('', nil, 'application/json')
     end
 
-    # DELETE /api/v2/apitoken/id
+    # GET /api/v2/apitoken/customertokens
+    # Get all api tokens for a customer
+    #
+    def list_customer_tokens
+      api.get('customertokens')
+    end
+
+    # GET /api/v2/apitoken/customertokens/{id}
+    # Get the specified api token for a customer
+    #
+    # @param id [String] ID of the api token
+    # @return [Wavefront::Response]
+    #
+    def describe_customer_token(id)
+      wf_apitoken_id?(id)
+      api.get(['customertokens', id].uri_concat)
+    end
+
+    # DELETE /api/v2/apitoken/{id}
     # Delete the specified api token
     #
     # @param id [String] ID of the api token
@@ -36,7 +54,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # PUT /api/v2/apitoken/id
+    # PUT /api/v2/apitoken/{id}
     # Update the name of the specified api token
     #
     # @param id [String] ID of the API token
@@ -99,5 +117,14 @@ module Wavefront
       api.put(['serviceaccount', id, token_id].uri_concat,
               { tokenID: token_id, tokenName: name }, 'application/json')
     end
+
+    # PUT /api/v2/apitoken/customertokens/revoke
+    # Delete the specified api token for a customer
+    #
+    # This appears to be only for use by the web API.
+    #
+    def revoke_customer_token
+      raise 'Unsupported API path'
+    end
   end
 end

data/lib/wavefront-sdk/cloudintegration.rb

@@ -32,7 +32,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/cloudintegration/id
+    # DELETE /api/v2/cloudintegration/{id}
     # Delete a specific cloud integration
     #
     # Deleting an active integration moves it to 'trash', from where
@@ -47,7 +47,7 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/cloudintegration/id
+    # GET /api/v2/cloudintegration/{id}
     # Get a specific cloud integration
     #
     # @param id [String] ID of the integration
@@ -58,7 +58,7 @@ module Wavefront
       api.get(id)
     end
 
-    # PUT /api/v2/cloudintegration/id
+    # PUT /api/v2/cloudintegration/{id}
     # Update a specific cloud integration
     #
     # @param id [String] ID of the integration
@@ -91,7 +91,7 @@ module Wavefront
       api.post([id, 'enable'].uri_concat)
     end
 
-    # POST /api/v2/cloudintegration/id/undelete
+    # POST /api/v2/cloudintegration/{id}/undelete
     # Undelete a specific cloud integration
     #
     # @param id [String] ID of the integration
@@ -102,14 +102,16 @@ module Wavefront
       api.post([id, 'undelete'].uri_concat)
     end
 
-    # POST /api/v2/cloudintegration/awsExternalIdCreate an external id
+    # POST /api/v2/cloudintegration/awsExternalId
+    # Create an external id
     # @return [Wavefront::Response]
     #
     def create_aws_external_id
       api.post('awsExternalId', nil, 'application/json')
     end
 
-    # DELETE /api/v2/cloudintegration/awsExternalId/{id}DELETEs an external id
+    # DELETE /api/v2/cloudintegration/awsExternalId/{id}
+    # Deletes an external id
     # that was created by Wavefront
     # @param id [String] AWS external ID
     # @return [Wavefront::Response]
@@ -119,8 +121,8 @@ module Wavefront
       api.delete(['awsExternalId', external_id].uri_concat)
     end
 
-    # GET /api/v2/cloudintegration/awsExternalId/{id}GETs (confirms) a valid
-    # external id that was created by Wavefront
+    # GET /api/v2/cloudintegration/awsExternalId/{id}
+    # GETs (confirms) a valid external id that was created by Wavefront
     # @param id [String] AWS external ID
     # @return [Wavefront::Response]
     #

data/lib/wavefront-sdk/cluster.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Query Wavefront cluster info. The API docs call this "wavefront", but that
+  # confuses everything.
+  #
+  class Cluster < CoreApi
+    # GET /api/v2/cluster/info
+    # get cluster info
+    #
+    def describe
+      api.get('info')
+    end
+  end
+end

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

@@ -133,8 +133,8 @@ module Wavefront
     #
     def post(path, body = nil, ctype = 'text/plain')
       body = body.to_json unless body.is_a?(String)
-      make_call(mk_conn(path,  'Content-Type': ctype,
-                               Accept: 'application/json'),
+      make_call(mk_conn(path, 'Content-Type': ctype,
+                              Accept: 'application/json'),
                 :post, nil, body)
     end
 
@@ -229,14 +229,8 @@ module Wavefront
       return if noop
 
       pp args if debug
-
       resp = conn.public_send(method, *args)
-
-      if debug
-        require 'pp'
-        pp resp
-      end
-
+      pp resp if debug
       respond(resp)
     end
 

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

@@ -53,6 +53,8 @@ module Wavefront
 
     class InvalidMaintenanceWindowId < RuntimeError; end
 
+    class InvalidMonitoredApplicationId < RuntimeError; end
+
     class InvalidMonitoredClusterId < RuntimeError; end
 
     class InvalidMessageId < RuntimeError; end
@@ -89,6 +91,8 @@ module Wavefront
 
     class InvalidSourceId < RuntimeError; end
 
+    class InvalidSpanSamplingPolicyId < RuntimeError; end
+
     class InvalidString < RuntimeError; end
 
     class InvalidTag < RuntimeError; end

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

@@ -51,7 +51,7 @@ module Wavefront
     # Were there items in the response?
     #
     def empty?
-      response.items.size.zero?
+      response.items.empty?
     rescue StandardError
       false
     end

data/lib/wavefront-sdk/credentials.rb

@@ -82,8 +82,8 @@ module Wavefront
         Array(Pathname.new(opts[:file]))
       else
         [Pathname.new('/etc/wavefront/credentials'),
-         Pathname.new(ENV['HOME']) + '.wavefront.conf',
-         Pathname.new(ENV['HOME']) + '.wavefront']
+         Pathname.new(Dir.home).join('.wavefront.conf'),
+         Pathname.new(Dir.home).join('.wavefront')]
       end
     end
 

data/lib/wavefront-sdk/dashboard.rb

@@ -40,7 +40,7 @@ module Wavefront
       api.post('', body, 'application/json')
     end
 
-    # DELETE /api/v2/dashboard/id
+    # DELETE /api/v2/dashboard/{id}
     # Delete a specific dashboard.
     # Deleting an active dashboard moves it to 'trash', from where
     # it can be restored with an #undelete operation. Deleting a
@@ -54,7 +54,8 @@ module Wavefront
       api.delete(id)
     end
 
-    # GET /api/v2/dashboard/id
+    # GET /api/v2/dashboard/{id}
+    # GET /api/v2/dashboard/{id}/history/{version}
     # Get a specific dashboard / Get a specific historical version
     # of a specific dashboard.
     #
@@ -70,10 +71,10 @@ module Wavefront
       api.get(fragments.uri_concat)
     end
 
-    # PUT /api/v2/dashboard/id
+    # PUT /api/v2/dashboard/{id}
     # Update a specific dashboard.
     #
-    # @param id [String] a Wavefront alert ID
+    # @param id [String] a Wavefront dashboard ID
     # @param body [Hash] key-value hash of the parameters you wish
     #   to change
     # @param modify [true, false] if true, use {#describe()} to get
@@ -103,7 +104,7 @@ module Wavefront
     end
     alias favourite favorite
 
-    # GET /api/v2/dashboard/id/history
+    # GET /api/v2/dashboard/{id}/history
     # Get the version history of a dashboard.
     #
     # @param id [String] ID of the dashboard
@@ -114,7 +115,7 @@ module Wavefront
       api.get([id, 'history'].uri_concat)
     end
 
-    # POST /api/v2/dashboard/id/undelete
+    # POST /api/v2/dashboard/{id}/undelete
     # Move a dashboard from 'trash' back into active service.
     #
     # @param id [String] ID of the dashboard

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

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