wavefront-sdk 3.0.2 → 3.2.0

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

@@ -1,4 +1,4 @@
 require 'pathname'
 
-WF_SDK_VERSION = '3.0.2'.freeze
+WF_SDK_VERSION = '3.2.0'.freeze
 WF_SDK_LOCATION = Pathname.new(__FILE__).dirname.parent.parent.parent

data/lib/wavefront-sdk/derivedmetric.rb

@@ -1,13 +1,12 @@
 require_relative 'core/api'
+require_relative 'api_mixins/tag'
 
 module Wavefront
   #
   # View and manage derived metrics
   #
   class DerivedMetric < CoreApi
-    def update_keys
-      # %i[id name url description sections]
-    end
+    include Wavefront::Mixin::Tag
 
     # GET /api/v2/derivedmetric
     # Get all derived metric definitions for a customer.
@@ -94,59 +93,6 @@ module Wavefront
       api.get([id, 'history'].uri_concat)
     end
 
-    # GET /api/v2/derivedmetric/id/tag
-    # Get all tags associated with a specific derived metric
-    # definition.
-    #
-    # @param id [String] ID of the derived metric
-    # @return [Wavefront::Response]
-    #
-    def tags(id)
-      wf_derivedmetric_id?(id)
-      api.get([id, 'tag'].uri_concat)
-    end
-
-    # POST /api/v2/derivedmetric/id/tag
-    # Set all tags associated with a specific derived metric
-    # definition.
-    #
-    # @param id [String] ID of the derived metric
-    # @param tags [Array] list of tags to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_set(id, tags)
-      wf_derivedmetric_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/derivedmetric/id/tag/tagValue
-    # Remove a tag from a specific derived metric definition.
-    #
-    # @param id [String] ID of the derived metric
-    # @param tag [String] tag to delete
-    # @return [Wavefront::Response]
-    #
-    def tag_delete(id, tag)
-      wf_derivedmetric_id?(id)
-      wf_string?(tag)
-      api.delete([id, 'tag', tag].uri_concat)
-    end
-
-    # PUT /api/v2/derivedmetric/id/tag/tagValue
-    # Add a tag to a specific derived metric definition.
-    #
-    # @param id [String] ID of the derived metric
-    # @param tag [String] tag to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_add(id, tag)
-      wf_derivedmetric_id?(id)
-      wf_string?(tag)
-      api.put([id, 'tag', tag].uri_concat)
-    end
-
     # POST /api/v2/derivedmetric/id/undelete
     # Move a derived metric definition from 'trash' back into active
     # service.
@@ -158,5 +104,9 @@ module Wavefront
       wf_derivedmetric_id?(id)
       api.post([id, 'undelete'].uri_concat)
     end
+
+    def valid_id?(id)
+      wf_derivedmetric_id?(id)
+    end
   end
 end

data/lib/wavefront-sdk/event.rb

@@ -1,4 +1,5 @@
 require_relative 'core/api'
+require_relative 'api_mixins/tag'
 
 module Wavefront
   #
@@ -6,6 +7,8 @@ module Wavefront
   # epoch timestamp.
   #
   class Event < CoreApi
+    include Wavefront::Mixin::Tag
+
     def update_keys
       %i[startTime endTime name annotations]
     end
@@ -115,57 +118,8 @@ module Wavefront
       api.post([id, 'close'].uri_concat)
     end
 
-    # GET /api/v2/event/id/tag
-    # Get all tags associated with a specific event
-    #
-    # @param id [String] ID of the event
-    # @return [Wavefront::Response]
-    #   response keys
-    #
-    def tags(id)
-      wf_event_id?(id)
-      api.get([id, 'tag'].uri_concat)
-    end
-
-    # POST /api/v2/event/id/tag
-    # Set all tags associated with a specific event.
-    #
-    # @param id [String] ID of the event
-    # @param tags [Array] list of tags to set.
-    # @return [Wavefront::Response]
-    #   response keys
-    #
-    def tag_set(id, tags)
-      wf_event_id?(id)
-      tags = Array(tags)
-      tags.each { |t| wf_string?(t) }
-      api.post([id, 'tag'].uri_concat, tags, 'application/json')
-    end
-
-    # DELETE /api/v2/event/id/tag/tagValue
-    # Remove a tag from a specific event.
-    #
-    # @param id [String] ID of the event
-    # @param tag [String] tag to delete
-    # @return [Wavefront::Response]
-    #
-    def tag_delete(id, tag)
-      wf_event_id?(id)
-      wf_string?(tag)
-      api.delete([id, 'tag', tag].uri_concat)
-    end
-
-    # PUT /api/v2/event/id/tag/tagValue
-    # Add a tag to a specific event.
-    #
-    # @param id [String] ID of the event
-    # @param tag [String] tag to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_add(id, tag)
+    def valid_id?(id)
       wf_event_id?(id)
-      wf_string?(tag)
-      api.put([id, 'tag', tag].uri_concat)
     end
   end
 end

data/lib/wavefront-sdk/paginator/base.rb

@@ -80,13 +80,14 @@ module Wavefront
       #
       def set_pagination(offset, page_size, args)
         args.map do |arg|
-          if arg.is_a?(Hash)
-            arg.tap do |a|
-              a[:limit] = page_size if a.key?(:limit)
-              a[:offset] = offset if a.key?(:offset)
-            end
-          end
-          arg
+          arg.is_a?(Hash) ? set_limit_and_offset(arg, page_size, offset) : arg
+        end
+      end
+
+      def set_limit_and_offset(arg, page_size, offset)
+        arg.tap do |a|
+          a[:limit] = page_size if a.key?(:limit)
+          a[:offset] = offset if a.key?(:offset)
         end
       end
 

data/lib/wavefront-sdk/paginator/post.rb

@@ -50,15 +50,17 @@ module Wavefront
 
         return args if body.class == desired
 
-        args[index] = if body.is_a?(String)
-                        JSON.parse(body, symbolize_names: true)
-                      else
-                        body.to_json
-                      end
+        args[index] = body_as_json(body)
         args
       rescue JSON::ParserError
         []
       end
+
+      def body_as_json(body)
+        return body.to_json unless body.is_a?(String)
+
+        JSON.parse(body, symbolize_names: true)
+      end
     end
   end
 end

data/lib/wavefront-sdk/source.rb

@@ -1,10 +1,13 @@
 require_relative 'core/api'
+require_relative 'api_mixins/tag'
 
 module Wavefront
   #
   # View and manage source metadata.
   #
   class Source < CoreApi
+    include Wavefront::Mixin::Tag
+
     def update_keys
       %i[sourceName tags description]
     end
@@ -100,55 +103,8 @@ module Wavefront
               'application/json')
     end
 
-    # GET /api/v2/source/id/tag
-    # Get all tags associated with a specific source.
-    #
-    # @param id [String] ID of the source
-    # @return [Wavefront::Response]
-    #
-    def tags(id)
-      wf_source_id?(id)
-      api.get([id, 'tag'].uri_concat)
-    end
-
-    # POST /api/v2/source/id/tag
-    # Set all tags associated with a specific source.
-    #
-    # @param id [String] ID of the source
-    # @param tags [Array] list of tags to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_set(id, tags)
-      wf_source_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/source/id/tag/tagValue
-    # Remove a tag from a specific source.
-    #
-    # @param id [String] ID of the source
-    # @param tag [String] tag to delete
-    # @return [Wavefront::Response]
-    #
-    def tag_delete(id, tag)
-      wf_source_id?(id)
-      wf_string?(tag)
-      api.delete([id, 'tag', tag].uri_concat)
-    end
-
-    # PUT /api/v2/source/id/tag/tagValue
-    # Add a tag to a specific source
-    #
-    # @param id [String] ID of the source
-    # @param tag [String] tag to set.
-    # @return [Wavefront::Response]
-    #
-    def tag_add(id, tag)
+    def valid_id?(id)
       wf_source_id?(id)
-      wf_string?(tag)
-      api.put([id, 'tag', tag].uri_concat)
     end
   end
 end

data/lib/wavefront-sdk/user.rb

@@ -1,12 +1,12 @@
 require_relative 'core/api'
-require_relative 'support/user_mixins'
+require_relative 'api_mixins/user'
 
 module Wavefront
   #
   # Manage and query Wavefront users
   #
   class User < CoreApi
-    include Wavefront::UserMixins
+    include Wavefront::Mixin::User
 
     # GET /api/v2/user
     # Get all users.

data/lib/wavefront-sdk/usergroup.rb

@@ -1,12 +1,12 @@
 require_relative 'core/api'
-require_relative 'support/user_mixins'
+require_relative 'api_mixins/user'
 
 module Wavefront
   #
   # Manage and query Wavefront user groups
   #
   class UserGroup < CoreApi
-    include Wavefront::UserMixins
+    include Wavefront::Mixin::User
 
     def update_keys
       %i[id name]

data/lib/wavefront-sdk/validators.rb

@@ -502,6 +502,16 @@ module Wavefront
       return true if count.is_a?(Integer) && count.positive?
       raise Wavefront::Exception::InvalidDistributionCount
     end
+
+    # Ensure the given argument is a valid API token ID
+    # @param id [String]
+    # @raise Wavefront::Exception::InvalidApiTokenId if the
+    #   count is not valid
+    #
+    def wf_apitoken_id?(id)
+      return true if uuid?(id)
+      raise Wavefront::Exception::InvalidApiTokenId
+    end
   end
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/wavefront-sdk/write.rb

@@ -1,6 +1,7 @@
 require 'socket'
 require_relative 'core/exception'
 require_relative 'core/logger'
+require_relative 'core/response'
 require_relative 'defs/constants'
 require_relative 'validators'
 
@@ -40,16 +41,14 @@ module Wavefront
     #   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.
+    #   chunk_size [Integer] So as not to create unusable metric
+    #     payloads, large batches of points will be broken into
+    #     chunks. This property controls the number of metrics in a
+    #     chunk. Defaults to 1,000.
+    #   chunk_pause [Integer] pause this many seconds between
+    #     writing chunks. Defaults to zero.
     #
     def initialize(creds = {}, opts = {})
-      defaults = { tags:       nil,
-                   writer:     :socket,
-                   noop:       false,
-                   novalidate: false,
-                   noauto:     false,
-                   verbose:    false,
-                   debug:      false }
-
       @opts = setup_options(opts, defaults)
       @creds = creds
       wf_point_tags?(opts[:tags]) if opts[:tags]
@@ -57,6 +56,18 @@ module Wavefront
       @writer = setup_writer
     end
 
+    def defaults
+      { tags:        nil,
+        writer:      :socket,
+        noop:        false,
+        novalidate:  false,
+        noauto:      false,
+        verbose:     false,
+        debug:       false,
+        chunk_size:  1000,
+        chunk_pause: 0 }
+    end
+
     def setup_options(user, defaults)
       defaults.merge(user)
     end
@@ -78,15 +89,35 @@ module Wavefront
     # Writers implement this method differently, Check the
     # appropriate class documentation for @return information etc.
     # The signature is always the same.
+    # @return [Boolean] false should any chunk fail
+    # @raise any exceptions raised by the writer classes are passed
+    #   through
     #
     def write(points = [], openclose = manage_conn, prefix = nil)
-      writer.write(points, openclose, prefix)
+      resps = [points].flatten.each_slice(opts[:chunk_size]).map do |chunk|
+        resp = writer.write(chunk, openclose, prefix)
+        sleep(opts[:chunk_pause])
+        resp
+      end
+
+      composite_response(resps)
     end
 
-    # Wrapper around writer class's #flush method
+    # Compound the responses of all chunked writes into one. It will
+    # be 'ok' only if *everything* passed.
     #
-    def flush
-      writer.flush
+    def composite_response(responses)
+      result = responses.all?(&:ok?) ? 'OK' : 'ERROR'
+      summary = { sent: 0, rejected: 0, unsent: 0 }
+
+      %i[sent rejected unsent].each do |k|
+        summary[k] = responses.map { |r| r.response[k] }.inject(:+)
+      end
+
+      Wavefront::Response.new(
+        { status:   { result: result, message: nil, code: nil },
+          response: summary.to_h }.to_json, nil
+      )
     end
 
     def manage_conn

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

@@ -49,11 +49,11 @@ module Wavefront
 
       private
 
-      # @param point [String] point or points in native Wavefront
-      # format.
+      # @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

data/spec/.rubocop.yml

@@ -11,7 +11,7 @@ Metrics/MethodLength:
   Max: 80
 
 Metrics/AbcSize:
-  Max: 45
+  Max: 80
 
 Metrics/ClassLength:
   Max: 300