wavefront-sdk 5.4.4 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0aafb012ded5a99a13ee3553d686e0552f5c4cae8da39e70139f6882aadcc9
-  data.tar.gz: b033a54d99e7a8402d04fd3555d56c53c765b655f89c59c6b1b27e2880ec5945
+  metadata.gz: 839f24e0a1a324b6965cb8aec1c0516bcb7c193215bc3cb6c1351f888bd49863
+  data.tar.gz: 97ba3cce211abdef8d1b08265279a2998f968a6f85a58290efe26d8109314940
 SHA512:
-  metadata.gz: e647c51a97b626d080d7d666e17b81c6ead709b8780f0bb3f2897fc34d326df65d6c524359f4ea461520ef75cf7d29883f1f822feb774b06a3d822ce7717e882
-  data.tar.gz: c6602237acfdf5c18820e086071e1f06cc73199fc45ef02e689f091fec36208936b3618c5ec0d1464fff2773f4424bb49d0be3c9ba394da5d31143a14e2aed71
+  metadata.gz: 2d72451c46077024d79451aaea09efec073db0dcfb6dfb7601382973f80b14c99cd3b732bf57ec09a1ec962938b2219470676ba84c47b27051b5d2970cdeb8ef
+  data.tar.gz: fdf2b294468db11835722f3ffbcbac2e77a42a12d8083c4e7536f637659bf8e063de0b75f023e71a46d2a25e942ad197e16e70a4229db5142b741542dbaaf2f7

data/.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.4.10, 2.5.8, 2.6.6, 2.7.2, 3.0.0]
+        ruby-version: [2.5.9, 2.6.7, 2.7.3, 3.0.1]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/.rubocop.yml

@@ -1,7 +1,7 @@
 ---
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   NewCops: enable
 
 require:

data/HISTORY.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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::MetricsPolicy`.
+* Add `Wavefront::Spy#deltas`.
+
 ## 5.4.4 (2021-02-01)
 * Fix credential validation on writer classes.
 * Improve tests for writer classes

data/README.md

@@ -1,5 +1,5 @@
 # wavefront-sdk
-![Test](https://github.com/snltd/wavefront-sdk/workflows/Test/badge.svg) ![Release](https://github.com/snltd/wavefront-sdk/workflows/Release/badge.svg) [![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?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)
 
 This is a Ruby SDK for v2 of
 [Wavefront](https://www.wavefront.com/)'s public API. It aims to be
@@ -24,7 +24,7 @@ or to build locally,
 $ gem build wavefront-sdk.gemspec
 ```
 
-`wavefront-sdk` requires Ruby >= 2.4. All its dependencies are pure
+`wavefront-sdk` requires Ruby >= 2.5. All its dependencies are pure
 Ruby, right the way down, so a compiler should never be required to
 install it.
 
@@ -41,7 +41,7 @@ method will return a `Wavefront::Response` object. This object has
 `status` and `response` methods. `status` always yields a structure
 containing `result`, `message` and `code` fields which can be
 inspected to ensure an API call was processed successfully.
-`response` gives you a the JSON response from the API, conveniently
+`response` gives you the JSON response from the API, conveniently
 processed and turned into a [`Map`](https://github.com/ahoward/map)
 object. Map objects can be interrogated in various ways. For
 instance `map['items']`, `map[:items]` and `map.items` will all get
@@ -203,7 +203,7 @@ wf.close
 ```
 
 Alternatively, pass `false` as the second argument to `Write#write`.
-(This is the legacy method, kept in for backward compatability.)
+(This is the legacy method, kept in for backward compatibility.)
 
 ```ruby
 wf = Wavefront::Write.new(Wavefront::Credentials.new.proxy)
@@ -220,7 +220,7 @@ but other methods are supported via the `writer` option.
 wf = Wavefront::Write.new(Wavefront::Credentials.new.creds, writer: :api)
 
 # To send points via a local Unix socket
-wf = Wavefront::Write.new(socket: '/tmp/wf_sock', { writer: :unix })
+wf = Wavefront::Write.new({ socket: '/tmp/wf_sock'}, { writer: :socket })
 
 # To send points over HTTP
 wf = Wavefront::Write.new(Wavefront::Credentials.new.creds, writer: :http)

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

@@ -80,7 +80,7 @@ module Wavefront
       end
 
       def valid_acl_body?(list)
-        return true if list.is_a?(Array) && list.all? { |h| h.is_a?(String) }
+        return true if list.is_a?(Array) && list.all?(String)
 
         raise ArgumentError
       end

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

@@ -94,7 +94,7 @@ module Wavefront
     def hash_for_update(old, new)
       raise ArgumentError unless old.is_a?(Hash) && new.is_a?(Hash)
 
-      Hash[old.merge(new).map { |k, v| [k.to_sym, v] }].select do |k, _v|
+      old.merge(new).transform_keys(&:to_sym).select do |k, _v|
         update_keys.include?(k)
       end
     end

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

@@ -59,6 +59,8 @@ module Wavefront
 
     class InvalidMetricName < RuntimeError; end
 
+    class InvalidMetricsPolicyId < RuntimeError; end
+
     class InvalidMetricValue < RuntimeError; end
 
     class InvalidName < RuntimeError; end

data/lib/wavefront-sdk/credentials.rb

@@ -128,9 +128,7 @@ module Wavefront
     # @return [Hash] options loaded from file. Each key becomes a symbol
     #
     def load_profile(file, profile = 'default')
-      IniFile.load(file)[profile].each_with_object({}) do |(k, v), memo|
-        memo[k.to_sym] = v
-      end
+      IniFile.load(file)[profile].transform_keys(&:to_sym)
     rescue StandardError
       raise Wavefront::Exception::InvalidConfigFile, file
     end

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

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

data/lib/wavefront-sdk/event.rb

@@ -117,12 +117,75 @@ module Wavefront
       api.post([id, 'close'].uri_concat)
     end
 
-    def valid_id?(id)
+    # GET /api/v2/event/{id}/alertFiringDetails
+    # Return details of a particular alert firing, including all the series
+    # that fired during the referred alert firing
+    #
+    # @param id [String] ID of the event
+    # @return [Wavefront::Response]
+    #
+    def alert_firing_details(id)
+      wf_event_id?(id)
+      api.get([id, 'alertFiringDetails'].uri_concat)
+    end
+
+    # GET /api/v2/event/{id}/alertQueriesSlug
+    # If the specified event is associated with an alert, returns a slug
+    # encoding the queries having to do with that alert firing or resolution
+    # @param id [String] ID of the event
+    # @return [Wavefront::Response]
+    #
+    def alert_queries_slug(id)
+      wf_event_id?(id)
+      api.get([id, 'alertQueriesSlug'].uri_concat)
+    end
+
+    # GET /api/v2/event/{id}/events
+    # List all related events for a specific firing event with a time span of
+    # one hour
+    # @param id [String] ID of the event
+    # @param opts [Hash] containing one or more of
+    #   is_overlapped [Bool]
+    #   rendering_method [Symbol,String] one of :HOST, :METRIC, :SIMILARITY
+    #   limit [Integer]
+    # @return [Wavefront::Response]
+    #
+    def events(id, opts = {})
       wf_event_id?(id)
+
+      api.get([id, 'events'].uri_concat,
+              { isOverlapped: opts[:is_overlapped] || false,
+                renderingMethod: (opts[:rendering_method] || :HOST).to_s,
+                limit: opts[:limit] || nil }.compact)
+    end
+
+    # GET /api/v2/event/alertFirings
+    # Get firings events of an alert within a time range
+    # @param alert_id [String] ID of the alert
+    # @param opts [Hash] containing one or more of
+    #   earliest_start [Integer] epoch ms timestamp
+    #   latest_start [Integer] epoch ms timestamp
+    #   ascending [Bool]
+    #   limit [Integer]
+    # @return [Wavefront::Response]
+    #
+    def alert_firings(alert_id, opts = {})
+      wf_alert_id?(alert_id)
+
+      api.get('alertFirings',
+              { alertId: alert_id,
+                earliestStartTimeEpochMillis: opts[:earliest_start] || nil,
+                latestStartTimeEpochMillis: opts[:latest_start] || nil,
+                limit: opts[:limit] || nil,
+                asc: opts[:asc] || true }.compact)
     end
 
     private
 
+    def valid_id?(id)
+      wf_event_id?(id)
+    end
+
     def list_body(t_start, t_end, limit, cursor)
       { earliestStartTimeEpochMillis: parse_time(t_start, true),
         latestStartTimeEpochMillis: parse_time(t_end, true),

data/lib/wavefront-sdk/metricspolicy.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+
+module Wavefront
+  #
+  # Manage and query Wavefront metrics policies
+  #
+  class MetricsPolicy < CoreApi
+    # GET /api/v2/metricspolicy
+    # Get the metrics policy
+    # GET /api/v2/metricspolicy/history/{version}
+    # Get a specific historical version of a metrics policy
+    # @param version [Integer] specify version to describe
+    # @return [Wavefront::Response]
+    #
+    def describe(version = nil)
+      if version
+        wf_version?(version)
+        api.get(['history', version].uri_concat)
+      else
+        api.get('')
+      end
+    end
+
+    # GET /api/v2/metricspolicy/history
+    # Get the version history of metrics policy
+    #
+    # @param offset [Integer] version at which the list begins
+    # @param limit [Integer] the number of versions to return
+    #
+    def history(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # POST /api/v2/metricspolicy/revert/{version}
+    # Revert to a specific historical version of a metrics policy
+    # @param version [Integer] specify version to describe
+    # @return [Wavefront::Response]
+    #
+    def revert(version)
+      wf_version?(version)
+      api.post(['revert', version].uri_concat)
+    end
+
+    # PUT /api/v2/metricspolicy
+    # Update the metrics policy
+    # @param body [Hash] hash describing metrics policy
+    # @return [Wavefront::Response]
+    #
+    def update(body)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      api.put('', body, 'application/json')
+    end
+  end
+end

data/lib/wavefront-sdk/spy.rb

@@ -32,6 +32,21 @@ module Wavefront
       api.get_stream('points', points_filter(sampling, filters), options)
     end
 
+    # GET /api/spy/deltas
+    # Gets new deltas 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 deltas(sampling = 0.01, filters = {}, options = {})
+      wf_sampling_value?(sampling)
+      api.get_stream('deltas',
+                     deltas_filter(sampling, filters),
+                     options)
+    end
+
     # GET /api/spy/histograms
     # Gets new histograms that are added to existing time series.
     # @param sampling [Float] see #points
@@ -103,6 +118,13 @@ module Wavefront
         pointTagKey: filters.fetch(:tag_key, nil) }.compact
     end
 
+    def deltas_filter(sampling, filters)
+      { counter: filters.fetch(:prefix, nil),
+        host: filters.fetch(:host, nil),
+        sampling: sampling,
+        counterTagKey: filters.fetch(:tag_key, nil) }.compact
+    end
+
     def histograms_filter(sampling, filters)
       { histogram: filters.fetch(:prefix, nil),
         host: filters.fetch(:host, nil),

data/lib/wavefront-sdk/user.rb

@@ -19,7 +19,7 @@ module Wavefront
 
     def deprecation_warning
       logger.log('Wavefront::User is deprecated and will be removed from the ' \
-               'next major release. Please use Wavefront::Account.', :warn)
+                 'next major release. Please use Wavefront::Account.', :warn)
     end
 
     def post_initialize(_creds, _opts)

data/lib/wavefront-sdk/validators.rb

@@ -467,6 +467,9 @@ module Wavefront
       true
     end
 
+    # @
+    def wf_trace?(trace); end
+
     # Validate an array of distribution values
     # @param vals [Array[Array]] [count, value]
     # @return true if valid
@@ -639,6 +642,18 @@ module Wavefront
 
       raise Wavefront::Exception::InvalidAwsExternalId, id
     end
+
+    # Ensure the given argument is a valid Wavefront metrics policy ID
+    # @param id [String] the metrics policy ID to validate
+    # @return true if the role ID is valid
+    # @raise Wavefront::Exception::InvalidMetricsPolicyId if the ID is
+    #   not valid
+    #
+    def wf_metricspolicy_id?(id)
+      return true if uuid?(id)
+
+      raise Wavefront::Exception::InvalidMetricsPolicyId, id
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/wavefront-sdk/write.rb

@@ -39,7 +39,7 @@ module Wavefront
     #   verbose [Bool]
     #   debug [Bool]
     #   writer [Symbol, String] the name of the writer class to use.
-    #     Defaults to :socket
+    #     Defaults to :proxy
     #   noauto [Bool] if this is false, #write will automatically
     #     open a connection to Wavefront on each invocation. Set
     #     this to true to manually manage the connection.
@@ -62,7 +62,7 @@ module Wavefront
     #
     def defaults
       { tags: nil,
-        writer: :socket,
+        writer: :proxy,
         noop: false,
         novalidate: false,
         noauto: false,

data/lib/wavefront-sdk/writers/api.rb

@@ -24,7 +24,7 @@ module Wavefront
                 'credentials must contain API endpoint')
         end
 
-        return if creds.key?(:token) && creds[:token]
+        return true if creds.key?(:token) && creds[:token]
 
         raise(Wavefront::Exception::CredentialError,
               'credentials must contain API token')

data/lib/wavefront-sdk/writers/proxy.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'core'
+
+module Wavefront
+  module Writer
+    #
+    # Everything specific to writing points to a Wavefront proxy, in
+    # native Wavefront format, to a socket. (The original and,
+    # once, only way to send points.)
+    #
+    class Proxy < Core
+      # Open a connection to a socket to a Wavefront proxy, putting the
+      # descriptor in instance variable @conn.
+      # @return [TCPSocket]
+      #
+      def open
+        if opts[:noop]
+          logger.log('No-op requested. Not opening connection to proxy.')
+          return true
+        end
+
+        port = creds[:port] || default_port
+        logger.log("Connecting to #{creds[:proxy]}:#{port}.", :debug)
+        open_socket(creds[:proxy], port)
+      end
+
+      # Close the connection described by the @conn instance variable.
+      #
+      def close
+        return if opts[:noop]
+
+        logger.log('Closing connection to proxy.', :debug)
+        conn.close
+      end
+
+      def validate_credentials(creds)
+        return true if creds.key?(:proxy) && creds[:proxy]
+
+        raise(Wavefront::Exception::CredentialError,
+              'credentials must contain proxy address')
+      end
+
+      private
+
+      def open_socket(proxy, port)
+        @conn = TCPSocket.new(proxy, port)
+      rescue StandardError => e
+        logger.log(e, :error)
+        raise Wavefront::Exception::InvalidEndpoint
+      end
+
+      # @param point [String] point or points in native Wavefront format.
+      # @raise [SocketError] if point cannot be written
+      #
+      def _send_point(point)
+        return if opts[:noop]
+
+        conn.puts(point)
+      rescue StandardError
+        raise Wavefront::Exception::SocketError
+      end
+
+      # return [Integer] the port to connect to, if none is supplied
+      #
+      def default_port
+        2878
+      end
+    end
+  end
+end

data/lib/wavefront-sdk/writers/socket.rb

@@ -1,70 +1,58 @@
 # frozen_string_literal: true
 
+require 'socket'
 require_relative 'core'
 
 module Wavefront
   module Writer
     #
-    # Everything specific to writing points to a Wavefront proxy, in
-    # native Wavefront format, to a socket. (The original and,
-    # once, only way to send points.)
+    # Everything specific to writing points to a Unix datagram socket.
     #
     class Socket < Core
-      # Open a socket to a Wavefront proxy, putting the descriptor
-      # in instance variable @conn.
-      # @return [TCPSocket]
+      # Make a connection to a Unix datagram socket, putting the
+      # descriptor in instance variable @conn.
+      # This requires the name of the socket file in creds[:socket]
+      # @return [UnixSocket]
       #
       def open
         if opts[:noop]
-          logger.log('No-op requested. Not opening connection to proxy.')
+          logger.log('No-op requested. Not opening socket connection.')
           return true
         end
 
-        port = creds[:port] || default_port
-        logger.log("Connecting to #{creds[:proxy]}:#{port}.", :debug)
-        open_socket(creds[:proxy], port)
+        logger.log("Connecting to #{creds[:socket]}.", :debug)
+        open_socket(creds[:socket])
       end
 
-      # Close the connection described by the @conn instance variable.
-      #
       def close
         return if opts[:noop]
 
-        logger.log('Closing connection to proxy.', :debug)
+        logger.log('Closing socket connection.', :debug)
         conn.close
       end
 
       def validate_credentials(creds)
-        return if creds.key?(:proxy) && creds[:proxy]
+        return true if creds.key?(:socket) && creds[:socket]
 
         raise(Wavefront::Exception::CredentialError,
-              'credentials must contain proxy address')
+              'credentials must contain socket file path')
       end
 
       private
 
-      def open_socket(proxy, port)
-        @conn = TCPSocket.new(proxy, port)
+      def open_socket(socket)
+        @conn = UNIXSocket.new(socket)
       rescue StandardError => e
         logger.log(e, :error)
         raise Wavefront::Exception::InvalidEndpoint
       end
 
       # @param point [String] point or points in native Wavefront format.
-      # @raise [SocketError] if point cannot be written
       #
       def _send_point(point)
         return if opts[:noop]
 
-        conn.puts(point)
-      rescue StandardError
-        raise Wavefront::Exception::SocketError
-      end
-
-      # return [Integer] the port to connect to, if none is supplied
-      #
-      def default_port
-        2878
+        conn.write(point)
       end
     end
   end

data/spec/test_mixins/general.rb

@@ -77,7 +77,7 @@ module WavefrontTest
 
     def test_update_keys
       assert_instance_of Array, wf.update_keys
-      assert(wf.update_keys.all? { |k| k.is_a?(Symbol) })
+      assert(wf.update_keys.all?(Symbol))
     end
   end
 

data/spec/wavefront-sdk/core/response_spec.rb

@@ -7,8 +7,8 @@ require_relative '../../../lib/wavefront-sdk/core/exception'
 require_relative '../../../lib/wavefront-sdk/core/response'
 
 GOOD_RESP = '{"status":{"result":"OK","message":"","code":200},' \
-             '"response":{"items":[{"name":"test agent"}],"offset":0,' \
-             '"limit":100,"totalItems":3,"moreItems":false}}'
+            '"response":{"items":[{"name":"test agent"}],"offset":0,' \
+            '"limit":100,"totalItems":3,"moreItems":false}}'
 
 BAD_RESP = "error='not_found'
 message='resource cannot be found'

data/spec/wavefront-sdk/event_spec.rb

@@ -43,12 +43,58 @@ class WavefrontEventTest < WavefrontTestBase
     assert_raises(ArgumentError) { wf.close }
   end
 
+  def test_alert_firing_details
+    assert_gets("/api/v2/event/#{id}/alertFiringDetails") do
+      wf.alert_firing_details(id)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidEventId) do
+      wf.alert_firing_details(invalid_id)
+    end
+  end
+
+  def test_alert_queries_slug
+    assert_gets("/api/v2/event/#{id}/alertQueriesSlug") do
+      wf.alert_queries_slug(id)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidEventId) do
+      wf.alert_queries_slug(invalid_id)
+    end
+  end
+
+  def test_events
+    assert_gets(
+      "/api/v2/event/#{id}/events?isOverlapped=false&renderingMethod=HOST"
+    ) do
+      wf.events(id)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidEventId) do
+      wf.events(invalid_id)
+    end
+  end
+
+  def test_alert_firings
+    assert_gets("/api/v2/event/alertFirings?alertId=#{alert_id}&asc=true") do
+      wf.alert_firings(alert_id, asc: true)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidAlertId) do
+      wf.alert_firings(invalid_id)
+    end
+  end
+
   private
 
   def id
     '1481553823153:testev'
   end
 
+  def alert_id
+    '1481553823153'
+  end
+
   def invalid_id
     'nonsense'
   end

data/spec/wavefront-sdk/metric_helper_spec.rb

@@ -4,6 +4,8 @@
 require 'minitest/autorun'
 require_relative '../spec_helper'
 require_relative '../../lib/wavefront-sdk/metric_helper'
+require_relative '../support/mocket'
+require_relative '../support/bad_mocket'
 
 ND_CREDS = { proxy: 'wavefront' }.freeze
 WH_TAGS  = { t1: 'v1', t2: 'v2' }.freeze

data/spec/wavefront-sdk/metricspolicy_spec.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../test_mixins/general'
+
+# Unit tests for MetricsPolicy class
+#
+class WavefrontMetricsPolicyTest < WavefrontTestBase
+  def test_describe
+    assert_gets('/api/v2/metricspolicy') { wf.describe }
+
+    assert_gets('/api/v2/metricspolicy/history/5') { wf.describe(5) }
+
+    assert_raises(Wavefront::Exception::InvalidVersion) do
+      wf.describe('v5')
+    end
+  end
+
+  def test_history
+    assert_gets('/api/v2/metricspolicy?offset=10&limit=100') do
+      wf.history(10)
+    end
+
+    assert_gets('/api/v2/metricspolicy?offset=12&limit=34') do
+      wf.history(12, 34)
+    end
+  end
+
+  def test_revert
+    assert_posts('/api/v2/metricspolicy/revert/5') do
+      wf.revert(5)
+    end
+
+    assert_raises(Wavefront::Exception::InvalidVersion) do
+      wf.revert('v5')
+    end
+  end
+
+  def test_update
+    assert_puts('/api/v2/metricspolicy', payload.to_json) do
+      wf.update(payload)
+    end
+  end
+
+  private
+
+  def api_class
+    'metricspolicy'
+  end
+
+  def id
+    'a7d2e651-cec1-4154-a5e8-1946f57ef5b3'
+  end
+
+  def invalid_id
+    '+-+-+-+'
+  end
+
+  def payload
+    {
+      policyRules: [
+        {
+          name: 'Policy rule1 name',
+          description: 'Policy rule1 description',
+          prefixes: ['revenue.*'],
+          tags: [
+            {
+              key: 'sensitive',
+              value: 'false'
+            },
+            {
+              key: 'source',
+              value: 'app1'
+            }
+          ],
+          tagsAnded: 'true',
+          accessType: 'ALLOW',
+          accounts: %w[accountId1 accountId2],
+          userGroups: ['userGroupId1'],
+          roles: ['roleId']
+        },
+        {
+          name: 'Policy rule2 name',
+          description: 'Policy rule2 description',
+          prefixes: ['revenue.*'],
+          accessType: 'BLOCK',
+          accounts: ['accountId3'],
+          userGroups: ['userGroupId1']
+        }
+      ]
+    }
+  end
+end

data/spec/wavefront-sdk/spy_spec.rb

@@ -38,6 +38,33 @@ class WavefrontSpyTest < MiniTest::Test
     end
   end
 
+  def test_deltas
+    capture_io do
+      assert_gets('/api/spy/deltas?sampling=0.01') { wf.deltas }
+      assert_gets('/api/spy/deltas?sampling=0.05') { wf.deltas(0.05) }
+
+      assert_gets('/api/spy/deltas?sampling=0.05&counter=my_prefix') do
+        wf.deltas(0.05, prefix: 'my_prefix')
+      end
+
+      assert_gets(
+        '/api/spy/deltas?sampling=0.05&counter=my_prefix&host=h1'
+      ) do
+        wf.deltas(0.05, prefix: 'my_prefix', host: 'h1')
+      end
+
+      assert_gets('/api/spy/deltas?sampling=0.02&counter=my_prefix&' \
+                  'counterTagKey=the_tag') do
+        wf.deltas(0.02, prefix: 'my_prefix', tag_key: 'the_tag')
+      end
+
+      assert_gets('/api/spy/deltas?sampling=0.02&counter=my_prefix&' \
+                  'counterTagKey=tag1&counterTagKey=tag2') do
+        wf.deltas(0.02, prefix: 'my_prefix', tag_key: %w[tag1 tag2])
+      end
+    end
+  end
+
   def test_histograms
     capture_io do
       assert_gets('/api/spy/histograms?sampling=0.01') { wf.histograms }

data/spec/wavefront-sdk/validators_spec.rb

@@ -417,4 +417,14 @@ class WavefrontValidatorsTest < MiniTest::Test
     bad = %w[h5Z9dkr46jbvLtJ HqOM4mru5svd3uFp3 c!lBx!LC*NxLKdx*]
     good_and_bad('wf_aws_external_id?', 'InvalidAwsExternalId', good, bad)
   end
+
+  def test_wf_metricspolicy_id
+    good = %w[2bfdcac7-1c9c-4c4b-9b56-c41c22c586dc
+              a7d2e651-cec1-4154-a5e8-1946f57ef5b3
+              fca312fb-5ff4-420d-862d-5d6d99ed6bcf
+              3a1957e0-459e-49e5-9209-3888a4e8ac5b]
+
+    bad = %w[fa312fb-5ff4-420d-862d-5d6d99ed6bcf thing 123]
+    good_and_bad('wf_metricspolicy_id?', 'InvalidMetricsPolicyId', good, bad)
+  end
 end

data/spec/wavefront-sdk/write_spec.rb

@@ -27,7 +27,7 @@ class WavefrontWriteTest < MiniTest::Test
     refute(wf.opts[:noop])
     assert(wf_noop.opts[:noop])
     assert_equal(wf_tags.opts[:tags], TAGS)
-    assert_instance_of(Wavefront::Writer::Socket, wf.writer)
+    assert_instance_of(Wavefront::Writer::Proxy, wf.writer)
   end
 
   def test_composite_response

data/spec/wavefront-sdk/writers/{unix_spec.rb → proxy_spec.rb}

@@ -11,36 +11,34 @@ require_relative '../../spec_helper'
 require_relative '../../../lib/wavefront-sdk/write'
 require_relative '../../../spec/support/mocket'
 
-UNIX_SOCK = '/tmp/testsock'
+WS_CREDS = { proxy: 'wavefront-proxy' }.freeze
 
-WU_CREDS = { socket: UNIX_SOCK }.freeze
-
-# Test UNIX Datagram socket writing
+# The Proxy class writes to a proxy TCP socket
 #
-class WavefrontWriterUnixTest < MiniTest::Test
+class WavefrontWriterSocketTest < MiniTest::Test
   attr_reader :wf, :wf_noop
 
   def setup
-    @wf = Wavefront::Write.new(WU_CREDS, writer: :unix)
-    @wf_noop = Wavefront::Write.new(WU_CREDS, writer: :unix, noop: true)
+    @wf = Wavefront::Write.new(WS_CREDS, writer: :proxy)
+    @wf_noop = Wavefront::Write.new(WS_CREDS, writer: :proxy, noop: true)
   end
 
   def test_writer_class
-    assert_instance_of(Wavefront::Writer::Unix, wf.writer)
+    assert_instance_of(Wavefront::Writer::Proxy, wf.writer)
   end
 
   def test_write_openclose
     mocket = Mocket.new
-    Spy.on(UNIXSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :write)
+    Spy.on(TCPSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :puts)
     wf.write(POINT)
     assert mocket_spy.has_been_called?
   end
 
   def test_write_noop
     mocket = Mocket.new
-    Spy.on(UNIXSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :write)
+    Spy.on(TCPSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :puts)
     wf_noop.open
     wf_noop.write(POINT, false)
     refute mocket_spy.has_been_called?
@@ -48,16 +46,16 @@ class WavefrontWriterUnixTest < MiniTest::Test
 
   def test_write_noop_openclose
     mocket = Mocket.new
-    Spy.on(UNIXSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :write)
+    Spy.on(TCPSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :puts)
     wf_noop.write(POINT)
     refute mocket_spy.has_been_called?
   end
 
   def test_write
     mocket = Mocket.new
-    Spy.on(UNIXSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :write)
+    Spy.on(TCPSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :puts)
     wf.open
     wf.write(POINT, false)
     assert mocket_spy.has_been_called?
@@ -65,8 +63,8 @@ class WavefrontWriterUnixTest < MiniTest::Test
 
   def test_write_array
     mocket = Mocket.new
-    Spy.on(UNIXSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :write)
+    Spy.on(TCPSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :puts)
     wf.open
     wf.write(POINT_A, false)
     assert mocket_spy.has_been_called?
@@ -74,32 +72,32 @@ class WavefrontWriterUnixTest < MiniTest::Test
 
   def test_noop_send_point
     mocket = Mocket.new
-    Spy.on(UNIXSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :write)
+    Spy.on(TCPSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :puts)
     wf_noop.open
     wf_noop.send_point(POINT_L)
     refute mocket_spy.has_been_called?
   end
 
   def test_open
-    tcp_spy = Spy.on(UNIXSocket, :new)
+    tcp_spy = Spy.on(TCPSocket, :new)
     wf.open
     assert tcp_spy.has_been_called?
-    assert_equal([UNIX_SOCK], tcp_spy.calls.first.args)
+    assert_equal(['wavefront-proxy', 2878], tcp_spy.calls.first.args)
   end
 
   def test_noop_open
-    tcp_spy = Spy.on(UNIXSocket, :new)
+    tcp_spy = Spy.on(TCPSocket, :new)
     log_spy = Spy.on(wf_noop.logger, :log)
     wf_noop.open
     refute tcp_spy.has_been_called?
-    assert_equal(['No-op requested. Not opening socket connection.'],
+    assert_equal(['No-op requested. Not opening connection to proxy.'],
                  log_spy.calls.last.args)
     assert_equal(1, log_spy.calls.size)
   end
 
   def test_noop_close
-    tcp_spy = Spy.on(UNIXSocket, :new)
+    tcp_spy = Spy.on(TCPSocket, :new)
     log_spy = Spy.on(wf_noop.logger, :log)
     wf_noop.close
     refute tcp_spy.has_been_called?
@@ -107,25 +105,25 @@ class WavefrontWriterUnixTest < MiniTest::Test
   end
 
   def test_validate_credentials
-    assert(Wavefront::Write.new(WU_CREDS, writer: :unix))
+    assert(Wavefront::Write.new(WS_CREDS, writer: :proxy))
 
     assert_instance_of(Wavefront::Write,
-                       Wavefront::Write.new(WU_CREDS, writer: :unix))
+                       Wavefront::Write.new(WS_CREDS, writer: :proxy))
 
     assert_raises(Wavefront::Exception::CredentialError) do
-      Wavefront::Write.new({}, writer: :unix)
+      Wavefront::Write.new({}, writer: :proxy)
     end
 
     assert_raises(Wavefront::Exception::CredentialError) do
-      Wavefront::Write.new({ endpoint: 'wavefront.com' }, writer: :unix)
+      Wavefront::Write.new({ endpoint: 'wavefront.com' }, writer: :proxy)
     end
 
     assert_raises(Wavefront::Exception::CredentialError) do
-      Wavefront::Write.new({ token: 'abcdef' }, writer: :unix)
+      Wavefront::Write.new({ token: 'abcdef' }, writer: :proxy)
     end
 
     assert_raises(Wavefront::Exception::CredentialError) do
-      Wavefront::Write.new({ proxy: nil }, writer: :unix)
+      Wavefront::Write.new({ proxy: nil }, writer: :proxy)
     end
   end
 end

data/spec/wavefront-sdk/writers/socket_spec.rb

@@ -11,16 +11,18 @@ require_relative '../../spec_helper'
 require_relative '../../../lib/wavefront-sdk/write'
 require_relative '../../../spec/support/mocket'
 
-WS_CREDS = { proxy: 'wavefront-proxy' }.freeze
+UNIX_SOCK = '/tmp/testsock'
 
-# The Socket class writes to a proxy
+WU_CREDS = { socket: UNIX_SOCK }.freeze
+
+# Test UNIX Datagram socket writing
 #
-class WavefrontWriterSocketTest < MiniTest::Test
+class WavefrontWriterUnixTest < MiniTest::Test
   attr_reader :wf, :wf_noop
 
   def setup
-    @wf = Wavefront::Write.new(WS_CREDS, writer: :socket)
-    @wf_noop = Wavefront::Write.new(WS_CREDS, writer: :socket, noop: true)
+    @wf = Wavefront::Write.new(WU_CREDS, writer: :socket)
+    @wf_noop = Wavefront::Write.new(WU_CREDS, writer: :socket, noop: true)
   end
 
   def test_writer_class
@@ -29,16 +31,16 @@ class WavefrontWriterSocketTest < MiniTest::Test
 
   def test_write_openclose
     mocket = Mocket.new
-    Spy.on(TCPSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :puts)
+    Spy.on(UNIXSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :write)
     wf.write(POINT)
     assert mocket_spy.has_been_called?
   end
 
   def test_write_noop
     mocket = Mocket.new
-    Spy.on(TCPSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :puts)
+    Spy.on(UNIXSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :write)
     wf_noop.open
     wf_noop.write(POINT, false)
     refute mocket_spy.has_been_called?
@@ -46,16 +48,16 @@ class WavefrontWriterSocketTest < MiniTest::Test
 
   def test_write_noop_openclose
     mocket = Mocket.new
-    Spy.on(TCPSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :puts)
+    Spy.on(UNIXSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :write)
     wf_noop.write(POINT)
     refute mocket_spy.has_been_called?
   end
 
   def test_write
     mocket = Mocket.new
-    Spy.on(TCPSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :puts)
+    Spy.on(UNIXSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :write)
     wf.open
     wf.write(POINT, false)
     assert mocket_spy.has_been_called?
@@ -63,8 +65,8 @@ class WavefrontWriterSocketTest < MiniTest::Test
 
   def test_write_array
     mocket = Mocket.new
-    Spy.on(TCPSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :puts)
+    Spy.on(UNIXSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :write)
     wf.open
     wf.write(POINT_A, false)
     assert mocket_spy.has_been_called?
@@ -72,32 +74,32 @@ class WavefrontWriterSocketTest < MiniTest::Test
 
   def test_noop_send_point
     mocket = Mocket.new
-    Spy.on(TCPSocket, :new).and_return(mocket)
-    mocket_spy = Spy.on(mocket, :puts)
+    Spy.on(UNIXSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :write)
     wf_noop.open
     wf_noop.send_point(POINT_L)
     refute mocket_spy.has_been_called?
   end
 
   def test_open
-    tcp_spy = Spy.on(TCPSocket, :new)
+    tcp_spy = Spy.on(UNIXSocket, :new)
     wf.open
     assert tcp_spy.has_been_called?
-    assert_equal(['wavefront-proxy', 2878], tcp_spy.calls.first.args)
+    assert_equal([UNIX_SOCK], tcp_spy.calls.first.args)
   end
 
   def test_noop_open
-    tcp_spy = Spy.on(TCPSocket, :new)
+    tcp_spy = Spy.on(UNIXSocket, :new)
     log_spy = Spy.on(wf_noop.logger, :log)
     wf_noop.open
     refute tcp_spy.has_been_called?
-    assert_equal(['No-op requested. Not opening connection to proxy.'],
+    assert_equal(['No-op requested. Not opening socket connection.'],
                  log_spy.calls.last.args)
     assert_equal(1, log_spy.calls.size)
   end
 
   def test_noop_close
-    tcp_spy = Spy.on(TCPSocket, :new)
+    tcp_spy = Spy.on(UNIXSocket, :new)
     log_spy = Spy.on(wf_noop.logger, :log)
     wf_noop.close
     refute tcp_spy.has_been_called?
@@ -105,10 +107,10 @@ class WavefrontWriterSocketTest < MiniTest::Test
   end
 
   def test_validate_credentials
-    assert(Wavefront::Write.new(WS_CREDS, writer: :socket))
+    assert(Wavefront::Write.new(WU_CREDS, writer: :socket))
 
     assert_instance_of(Wavefront::Write,
-                       Wavefront::Write.new(WS_CREDS, writer: :socket))
+                       Wavefront::Write.new(WU_CREDS, writer: :socket))
 
     assert_raises(Wavefront::Exception::CredentialError) do
       Wavefront::Write.new({}, writer: :socket)

data/wavefront-sdk.gemspec

@@ -7,7 +7,6 @@ require_relative 'lib/wavefront-sdk/defs/version'
 Gem::Specification.new do |gem|
   gem.name          = 'wavefront-sdk'
   gem.version       = WF_SDK_VERSION
-  gem.date          = Date.today.to_s
 
   gem.summary       = 'SDK for Wavefront API v2'
   gem.description   = 'SDK for Wavefront (wavefront.com) API v2 '
@@ -29,7 +28,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'minitest', '~> 5.14'
   gem.add_development_dependency 'rake', '~> 13.0'
-  gem.add_development_dependency 'rubocop', '~> 1.9'
+  gem.add_development_dependency 'rubocop', '~> 1.17'
   gem.add_development_dependency 'rubocop-minitest', '~> 0.10'
   gem.add_development_dependency 'rubocop-performance', '~> 1.3'
   gem.add_development_dependency 'rubocop-rake', '~> 0.5'
@@ -38,5 +37,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'webmock', '~> 3.9'
   gem.add_development_dependency 'yard', '~> 0.9'
 
-  gem.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+  gem.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 5.4.4
+  version: 6.0.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +248,7 @@ files:
 - lib/wavefront-sdk/message.rb
 - lib/wavefront-sdk/metric.rb
 - lib/wavefront-sdk/metric_helper.rb
+- lib/wavefront-sdk/metricspolicy.rb
 - lib/wavefront-sdk/notificant.rb
 - lib/wavefront-sdk/paginator/base.rb
 - lib/wavefront-sdk/paginator/delete.rb
@@ -283,9 +284,9 @@ files:
 - lib/wavefront-sdk/writers/api.rb
 - lib/wavefront-sdk/writers/core.rb
 - lib/wavefront-sdk/writers/http.rb
+- lib/wavefront-sdk/writers/proxy.rb
 - lib/wavefront-sdk/writers/socket.rb
 - lib/wavefront-sdk/writers/summary.rb
-- lib/wavefront-sdk/writers/unix.rb
 - lib/wavefront_sdk.rb
 - spec/.rubocop.yml
 - spec/constants.rb
@@ -318,6 +319,7 @@ files:
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_helper_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
+- spec/wavefront-sdk/metricspolicy_spec.rb
 - spec/wavefront-sdk/misc_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
@@ -357,9 +359,9 @@ files:
 - spec/wavefront-sdk/writers/api_spec.rb
 - spec/wavefront-sdk/writers/core_spec.rb
 - spec/wavefront-sdk/writers/http_spec.rb
+- spec/wavefront-sdk/writers/proxy_spec.rb
 - spec/wavefront-sdk/writers/socket_spec.rb
 - spec/wavefront-sdk/writers/summary_spec.rb
-- spec/wavefront-sdk/writers/unix_spec.rb
 - wavefront-sdk.gemspec
 homepage: https://github.com/snltd/wavefront-sdk
 licenses:
@@ -373,14 +375,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: SDK for Wavefront API v2
@@ -416,6 +418,7 @@ test_files:
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_helper_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
+- spec/wavefront-sdk/metricspolicy_spec.rb
 - spec/wavefront-sdk/misc_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
@@ -455,6 +458,6 @@ test_files:
 - spec/wavefront-sdk/writers/api_spec.rb
 - spec/wavefront-sdk/writers/core_spec.rb
 - spec/wavefront-sdk/writers/http_spec.rb
+- spec/wavefront-sdk/writers/proxy_spec.rb
 - spec/wavefront-sdk/writers/socket_spec.rb
 - spec/wavefront-sdk/writers/summary_spec.rb
-- spec/wavefront-sdk/writers/unix_spec.rb

data/lib/wavefront-sdk/writers/unix.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-require_relative 'core'
-
-module Wavefront
-  module Writer
-    #
-    # Everything specific to writing points to a Unix datagram socket.
-    #
-    class Unix < Core
-      # Make a connection to a Unix datagram socket, putting the
-      # descriptor in instance variable @conn.
-      # This requires the name of the socket file in creds[:socket]
-      # @return [UnixSocket]
-      #
-      def open
-        if opts[:noop]
-          logger.log('No-op requested. Not opening socket connection.')
-          return true
-        end
-
-        logger.log("Connecting to #{creds[:socket]}.", :debug)
-        open_socket(creds[:socket])
-      end
-
-      def close
-        return if opts[:noop]
-
-        logger.log('Closing socket connection.', :debug)
-        conn.close
-      end
-
-      def validate_credentials(creds)
-        return if creds.key?(:socket) && creds[:socket]
-
-        raise(Wavefront::Exception::CredentialError,
-              'credentials must contain socket file path')
-      end
-
-      private
-
-      def open_socket(socket)
-        @conn = UNIXSocket.new(socket)
-      rescue StandardError => e
-        logger.log(e, :error)
-        raise Wavefront::Exception::InvalidEndpoint
-      end
-
-      # @param point [String] point or points in native Wavefront format.
-      #
-      def _send_point(point)
-        return if opts[:noop]
-
-        conn.write(point)
-      end
-    end
-  end
-end