wavefront-sdk 1.6.2 → 2.0.0

data/lib/wavefront-sdk/integration.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Manage and query Wavefront integrations.
   #
-  class Integration < Base
+  class Integration < CoreApi
     # GET /api/v2/integration
     # Gets a flat list of all Wavefront integrations available,
     # along with their status
@@ -13,7 +13,7 @@ module Wavefront
     # @param limit [Int] the number of proxies to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # GET /api/v2/integration/id
@@ -25,7 +25,7 @@ module Wavefront
     #
     def describe(id)
       wf_integration_id?(id)
-      api_get(id)
+      api.get(id)
     end
 
     # POST /api/v2/integration/id/install
@@ -36,7 +36,7 @@ module Wavefront
     #
     def install(id)
       wf_integration_id?(id)
-      api_post([id, 'install'].uri_concat, nil)
+      api.post([id, 'install'].uri_concat, nil)
     end
 
     # POST /api/v2/integration/id/uninstall
@@ -47,7 +47,7 @@ module Wavefront
     #
     def uninstall(id)
       wf_integration_id?(id)
-      api_post([id, 'uninstall'].uri_concat, nil)
+      api.post([id, 'uninstall'].uri_concat, nil)
     end
 
     # GET /api/v2/integration/id/status
@@ -58,7 +58,7 @@ module Wavefront
     #
     def status(id)
       wf_integration_id?(id)
-      api_get([id, 'status'].uri_concat)
+      api.get([id, 'status'].uri_concat)
     end
 
     # GET /api/v2/integration/status
@@ -67,7 +67,7 @@ module Wavefront
     # @return [Wavefront::Response]
     #
     def statuses
-      api_get('status')
+      api.get('status')
     end
 
     # GET /api/v2/integration/manifests
@@ -75,7 +75,7 @@ module Wavefront
     # integration manifests, along with their status
     #
     def manifests
-      api_get('manifests')
+      api.get('manifests')
     end
   end
 end

data/lib/wavefront-sdk/maintenancewindow.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Manage and query Wavefront maintenance windows
   #
-  class MaintenanceWindow < Base
+  class MaintenanceWindow < CoreApi
     def update_keys
       %i[reason title startTimeInSeconds endTimeInSeconds
          relevantCustomerTags relevantHostTags relevantHostNames]
@@ -17,7 +17,7 @@ module Wavefront
     # @param limit [Integer] the number of window to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/maintenancewindow
@@ -32,7 +32,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/maintenancewindow/id
@@ -43,7 +43,7 @@ module Wavefront
     #
     def delete(id)
       wf_maintenance_window_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/maintenancewindow/id
@@ -54,7 +54,7 @@ module Wavefront
     #
     def describe(id)
       wf_maintenance_window_id?(id)
-      api_get(id)
+      api.get(id)
     end
 
     # PUT /api/v2/maintenancewindow/id
@@ -72,10 +72,56 @@ module Wavefront
       wf_maintenance_window_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
-      return api_put(id, body, 'application/json') unless modify
+      return api.put(id, body, 'application/json') unless modify
 
-      api_put(id, hash_for_update(describe(id).response, body),
+      api.put(id, hash_for_update(describe(id).response, body),
               'application/json')
     end
+
+    # Windows currently open.
+    # @return [Wavefront::Response]
+    #
+    def ongoing
+      windows_in_state(:ongoing)
+    end
+
+    # Get the windows which will be open in the next so-many hours
+    # @param hours [Numeric] how many hours to look ahead
+    # @return [Wavefront::Response]
+    #
+    def pending(hours = 24)
+      cutoff = Time.now.to_i + hours * 3600
+
+      windows_in_state(:pending).tap do |r|
+        r.response.items.delete_if { |w| w.startTimeInSeconds > cutoff }
+      end
+    end
+
+    # This method mimics the similarly named method from the v1 SDK,
+    # which called the 'GET /api/alert/maintenancewindow/summary'
+    # path.
+    # @return [Wavefront::Response]
+    #
+    def summary
+      ret = pending
+
+      items = { UPCOMING: ret.response.items,
+                CURRENT:  ongoing.response.items }
+
+      ret.response.items = items
+      ret
+    end
+
+    # Return all maintenance windows in the given state. At the time
+    # of writing valid states are ONGOING, PENDING, and ENDED.
+    # @param state [Symbol]
+    # @return [Wavefront::Response]
+    #
+    def windows_in_state(state)
+      require_relative 'search'
+      wfs = Wavefront::Search.new(creds, opts)
+      query = { key: 'runningState', value: state, matchingMethod: 'EXACT' }
+      wfs.search(:maintenancewindow, query, limit: :all, offset: PAGE_SIZE)
+    end
   end
 end

data/lib/wavefront-sdk/message.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Manage and query Wavefront messages.
   #
-  class Message < Base
+  class Message < CoreApi
     # GET /api/v2/message
     # Gets messages applicable to the current user, i.e. within time
     # range and distribution scope
@@ -13,7 +13,7 @@ module Wavefront
     # @param limit [Int] the number of agents to return
     #
     def list(offset = 0, limit = 100, unread_only = true)
-      api_get('', offset: offset, limit: limit, unreadOnly: unread_only)
+      api.get('', offset: offset, limit: limit, unreadOnly: unread_only)
     end
 
     # POST /api/v2/message/id/read
@@ -23,7 +23,7 @@ module Wavefront
     #
     def read(id)
       wf_message_id?(id)
-      api_post([id, 'read'].uri_concat)
+      api.post([id, 'read'].uri_concat)
     end
   end
 end

data/lib/wavefront-sdk/metric.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Query Wavefront metrics.
   #
-  class Metric < Base
+  class Metric < CoreApi
     def api_base
       'chart/metric'
     end
@@ -29,7 +29,7 @@ module Wavefront
 
       sources.each { |source| query.<< [:h, source] }
 
-      api_get('detail', query)
+      api.get('detail', query)
     end
   end
 end

data/lib/wavefront-sdk/notificant.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
+require_relative 'core/api'
 
 module Wavefront
   #
   # Manage and query Wavefront notification targets.
   #
-  class Notificant < Base
+  class Notificant < CoreApi
     # GET /api/v2/notificant
     # Get all notification targets for a customer
     #
@@ -12,7 +12,7 @@ module Wavefront
     # @param limit [Int] the number of notification targets to return
     #
     def list(offset = 0, limit = 100)
-      api_get('', offset: offset, limit: limit)
+      api.get('', offset: offset, limit: limit)
     end
 
     # POST /api/v2/notificant
@@ -23,7 +23,7 @@ module Wavefront
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
-      api_post('', body, 'application/json')
+      api.post('', body, 'application/json')
     end
 
     # DELETE /api/v2/notificant/id
@@ -34,7 +34,7 @@ module Wavefront
     #
     def delete(id)
       wf_notificant_id?(id)
-      api_delete(id)
+      api.delete(id)
     end
 
     # GET /api/v2/notificant/id
@@ -45,7 +45,7 @@ module Wavefront
     #
     def describe(id)
       wf_notificant_id?(id)
-      api_get(id)
+      api.get(id)
     end
 
     # PUT /api/v2/notificant/id
@@ -63,9 +63,9 @@ module Wavefront
       wf_notificant_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
 
-      return api_put(id, body, 'application/json') unless modify
+      return api.put(id, body, 'application/json') unless modify
 
-      api_put(id, hash_for_update(describe(id).response, body),
+      api.put(id, hash_for_update(describe(id).response, body),
               'application/json')
     end
 
@@ -77,7 +77,7 @@ module Wavefront
     #
     def test(id)
       wf_notificant_id?(id)
-      api_post(['test', id].uri_concat, nil)
+      api.post(['test', id].uri_concat, nil)
     end
   end
 end

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

@@ -0,0 +1,148 @@
+require_relative '../defs/constants'
+
+module Wavefront
+  module Paginator
+    #
+    # Automatically handle pagination. This is an abstract class
+    # made concrete by an extension for each HTTP request type.
+    #
+    # This class and its children do slightly unpleasant things with
+    # the HTTP request passed to us by the user, extracting and
+    # changing values in the URI, query string, or POST/PUT body.
+    # The POST class is particularly onerous.
+    #
+    # Automatic pagination works by letting the user override the
+    # limit and offset values in API calls. Setting the limit to
+    # :all iteratively calls the Wavefront API, returning all
+    # requested objects an a standard Wavefront::Response wrapper;
+    # setting limit to :lazy returns a lazy Enumerable. The number
+    # of objects fetched in each API call, whether eager or lazy
+    # defaults to PAGE_SIZE, but the user can override that value by
+    # using the offset argument in conjunction with limit = :lazy |
+    # :all.
+    #
+    class Base
+      attr_reader :api_caller, :conn, :method, :args, :page_size,
+                  :initial_limit
+
+      # @param api_caller [Wavefront::ApiCaller] the class which
+      #   creates an instance of this one. We need to access its
+      #   #response method.
+      # @param conn [Faraday::Connection]
+      # @param method [Symbol] HTTP request method
+      # @param *args arguments to pass to Faraday's #get method
+      #
+      def initialize(api_caller, conn, method, *args)
+        @api_caller  = api_caller
+        @conn        = conn
+        @method      = method
+        @args        = args
+        setup_vars
+      end
+
+      def setup_vars
+        @initial_limit = limit_and_offset(args)[:limit]
+        @page_size = user_page_size(args) unless initial_limit.is_a?(Integer)
+      end
+
+      # An API call may or may not have a limit and/or offset value.
+      # They could (I think) be anywhere. Safely find and return
+      # them. If multiple elements of @args have :limit or :offset
+      # keys, the last value wins.
+      #
+      # @param args [Array] arguments to be passed to a Faraday
+      #   connection object
+      # @return [Hash] with keys :offset and :limit. Either's value
+      #   can be nil
+      #
+      def limit_and_offset(args)
+        ret = { offset: nil, limit: nil }
+
+        args.select { |a| a.is_a?(Hash) }.each_with_object(ret) do |arg|
+          ret[:limit] = arg[:limit] if arg.key?(:limit)
+          ret[:offset] = arg[:offset] if arg.key?(:offset)
+        end
+      end
+
+      # How many objects to get on each iteration? The user can pass
+      # it in as an alternative to the offset argument, If it's not a
+      # positive integer, default to 999
+      #
+      def user_page_size(args)
+        arg_val = limit_and_offset(args)[:offset].to_i
+        return arg_val if arg_val && arg_val > 0
+        PAGE_SIZE
+      end
+
+      # @param offset [Integer] where to start fetching from
+      # @param page_size [Integer] how many objects to fetch
+      # @param args [Array] arguments to pass to Faraday.get
+      #
+      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
+        end
+      end
+
+      # 'get' eagerly. Re-run the get operation, merging together
+      # returned items until we have them all.
+      # @return [Wavefront::Response]
+      #
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def make_recursive_call
+        offset = 0
+        p_args = set_pagination(offset, page_size, args)
+        ret = api_caller.respond(conn.public_send(method, *p_args))
+
+        return ret unless ret.more_items?
+
+        loop do
+          offset += page_size
+          p_args = set_pagination(offset, page_size, p_args)
+          api_caller.verbosity(conn, method, *p_args)
+          resp = api_caller.respond(conn.public_send(method, *p_args))
+          raise StopIteration unless resp.ok?
+          ret.response.items += resp.response.items
+          raise StopIteration unless resp.more_items?
+        end
+
+        ret
+      end
+
+      # Return all objects using a lazy enumerator.
+      # @return [Enumerable] with each item being
+      # @raise [Wavefront::Exception::EnumerableError] if an API error
+      #   is encountered at any point. The exception message is a
+      #   Wavefront::Type::Status object, which will include the HTTP
+      #   status code and any error string passed back by the API.
+      #
+      def make_lazy_call
+        offset = 0
+        p_args = set_pagination(offset, page_size, args)
+
+        Enumerator.new do |y|
+          loop do
+            offset += page_size
+            api_caller.verbosity(conn, method, *p_args)
+            resp = api_caller.respond(conn.public_send(method, *p_args))
+            unless resp.ok?
+              raise(Wavefront::Exception::EnumerableError, resp.status)
+            end
+            p_args = set_pagination(offset, page_size, p_args)
+            resp.response.items.map { |i| y.<< i }
+            raise StopIteration unless resp.more_items?
+          end
+        end.lazy
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end