wavefront-sdk 1.6.2 → 2.0.0

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

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+require 'webmock/minitest'
+require 'spy'
+require 'spy/integration'
+require 'socket'
+require 'logger'
+require_relative '../../spec_helper'
+require_relative '../../../lib/wavefront-sdk/write'
+require_relative '../resources/dummy_points'
+
+# rubocop:disable Style/MutableConstant
+WS_CREDS = { proxy: 'wavefront-proxy' }
+# rubocop:enable Style/MutableConstant
+
+# It's not straightforward to test the Writer::Socket class on its
+# own. It makes far more sense to test the Write interface which
+# calls it.
+#
+class WavefrontWriterSocketTest < 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)
+  end
+
+  def test_writer_class
+    assert_instance_of(Wavefront::Writer::Socket, wf.writer)
+  end
+
+  def test_write_openclose
+    mocket = Mocket.new
+    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(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?
+  end
+
+  def test_write_noop_openclose
+    mocket = Mocket.new
+    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(TCPSocket, :new).and_return(mocket)
+    mocket_spy = Spy.on(mocket, :puts)
+    wf.open
+    wf.write(POINT, false)
+    assert mocket_spy.has_been_called?
+  end
+
+  def test_write_array
+    mocket = Mocket.new
+    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?
+  end
+
+  def test_noop_send_point
+    mocket = Mocket.new
+    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(TCPSocket, :new)
+    wf.open
+    assert tcp_spy.has_been_called?
+    assert_equal(tcp_spy.calls.first.args, ['wavefront-proxy', 2878])
+  end
+
+  def test_noop_open
+    tcp_spy = Spy.on(TCPSocket, :new)
+    wf_noop.open
+    refute tcp_spy.has_been_called?
+  end
+end
+
+# A mock socket
+#
+class Mocket
+  def puts(socket); end
+
+  def close; end
+end

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

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require_relative '../../../lib/wavefront-sdk/writers/summary'
+require_relative '../../spec_helper'
+
+class WavefronWriterSummaryTest < MiniTest::Test
+  attr_reader :wf
+
+  def setup
+    @wf = Wavefront::Writer::Summary.new
+  end
+
+  def test_initial
+    assert_equal(0, wf.sent)
+    assert_equal(0, wf.unsent)
+    assert_equal(0, wf.rejected)
+    assert_raises(NoMethodError) { wf.missing }
+  end
+
+  def test_increments_result_and_ok?
+    wf_ok = wf.dup
+    wf_ok.sent += 1
+    assert_equal('OK', wf_ok.result)
+    assert wf_ok.ok?
+    wf_ok.rejected += 1
+    refute wf_ok.ok?
+    assert_equal('ERROR', wf_ok.result)
+
+    wf_not_ok = wf.dup
+    wf_not_ok.unsent += 1
+    refute wf_not_ok.ok?
+    assert_equal('ERROR', wf_not_ok.result)
+  end
+
+  def test_to_h
+    assert_equal({ sent: 0, unsent: 0, rejected: 0 }, wf.to_h)
+  end
+end

data/wavefront-sdk.gemspec

@@ -1,6 +1,6 @@
 require 'pathname'
 require 'date'
-require_relative 'lib/wavefront-sdk/version'
+require_relative 'lib/wavefront-sdk/defs/version'
 
 # rubocop:disable Metrics/BlockLength:
 Gem::Specification.new do |gem|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-22 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -194,77 +194,97 @@ files:
 - README.md
 - Rakefile
 - lib/wavefront-sdk/alert.rb
-- lib/wavefront-sdk/base.rb
-- lib/wavefront-sdk/base_write.rb
 - lib/wavefront-sdk/cloudintegration.rb
-- lib/wavefront-sdk/constants.rb
+- lib/wavefront-sdk/core/api.rb
+- lib/wavefront-sdk/core/api_caller.rb
+- lib/wavefront-sdk/core/exception.rb
+- lib/wavefront-sdk/core/logger.rb
+- lib/wavefront-sdk/core/response.rb
 - lib/wavefront-sdk/credentials.rb
 - lib/wavefront-sdk/dashboard.rb
+- lib/wavefront-sdk/defs/constants.rb
+- lib/wavefront-sdk/defs/version.rb
 - lib/wavefront-sdk/derivedmetric.rb
+- lib/wavefront-sdk/distribution.rb
 - lib/wavefront-sdk/event.rb
-- lib/wavefront-sdk/exception.rb
 - lib/wavefront-sdk/externallink.rb
 - lib/wavefront-sdk/integration.rb
-- lib/wavefront-sdk/logger.rb
 - lib/wavefront-sdk/maintenancewindow.rb
 - lib/wavefront-sdk/message.rb
 - lib/wavefront-sdk/metric.rb
-- lib/wavefront-sdk/mixins.rb
 - lib/wavefront-sdk/notificant.rb
-- lib/wavefront-sdk/parse_time.rb
+- lib/wavefront-sdk/paginator/base.rb
+- lib/wavefront-sdk/paginator/delete.rb
+- lib/wavefront-sdk/paginator/get.rb
+- lib/wavefront-sdk/paginator/post.rb
+- lib/wavefront-sdk/paginator/put.rb
 - lib/wavefront-sdk/proxy.rb
 - lib/wavefront-sdk/query.rb
 - lib/wavefront-sdk/report.rb
-- lib/wavefront-sdk/response.rb
 - lib/wavefront-sdk/savedsearch.rb
 - lib/wavefront-sdk/search.rb
 - lib/wavefront-sdk/source.rb
-- lib/wavefront-sdk/stdlib.rb
 - lib/wavefront-sdk/stdlib/array.rb
 - lib/wavefront-sdk/stdlib/hash.rb
 - lib/wavefront-sdk/stdlib/string.rb
+- lib/wavefront-sdk/support/mixins.rb
+- lib/wavefront-sdk/support/parse_time.rb
+- lib/wavefront-sdk/types/status.rb
 - lib/wavefront-sdk/user.rb
 - lib/wavefront-sdk/validators.rb
-- lib/wavefront-sdk/version.rb
 - lib/wavefront-sdk/webhook.rb
 - lib/wavefront-sdk/write.rb
+- lib/wavefront-sdk/writers/api.rb
+- lib/wavefront-sdk/writers/core.rb
+- lib/wavefront-sdk/writers/http.rb
+- lib/wavefront-sdk/writers/socket.rb
+- lib/wavefront-sdk/writers/summary.rb
+- lib/wavefront_sdk.rb
 - pkg/wavefront-client-3.5.0.gem
 - spec/.rubocop.yml
 - spec/spec_helper.rb
 - spec/wavefront-sdk/alert_spec.rb
-- spec/wavefront-sdk/base_spec.rb
-- spec/wavefront-sdk/base_write_spec.rb
 - spec/wavefront-sdk/cloudintegration_spec.rb
+- spec/wavefront-sdk/core/api_caller_spec.rb
+- spec/wavefront-sdk/core/api_spec.rb
+- spec/wavefront-sdk/core/logger_spec.rb
+- spec/wavefront-sdk/core/response_spec.rb
 - spec/wavefront-sdk/credentials_spec.rb
 - spec/wavefront-sdk/dashboard_spec.rb
 - spec/wavefront-sdk/derivedmetric_spec.rb
+- spec/wavefront-sdk/distribution_spec.rb
 - spec/wavefront-sdk/event_spec.rb
 - spec/wavefront-sdk/externallink_spec.rb
 - spec/wavefront-sdk/integration_spec.rb
-- spec/wavefront-sdk/logger_spec.rb
 - spec/wavefront-sdk/maintenancewindow_spec.rb
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
-- spec/wavefront-sdk/mixins_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
-- spec/wavefront-sdk/parse_time_spec.rb
+- spec/wavefront-sdk/paginator/base_spec.rb
+- spec/wavefront-sdk/paginator/post_spec.rb
 - spec/wavefront-sdk/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
 - spec/wavefront-sdk/report_spec.rb
 - spec/wavefront-sdk/resources/dummy_points.rb
 - spec/wavefront-sdk/resources/test.conf
 - spec/wavefront-sdk/resources/test2.conf
-- spec/wavefront-sdk/response_spec.rb
 - spec/wavefront-sdk/savedsearch_spec.rb
 - spec/wavefront-sdk/search_spec.rb
 - spec/wavefront-sdk/source_spec.rb
 - spec/wavefront-sdk/stdlib/array_spec.rb
 - spec/wavefront-sdk/stdlib/hash_spec.rb
 - spec/wavefront-sdk/stdlib/string_spec.rb
+- spec/wavefront-sdk/support/mixins_spec.rb
+- spec/wavefront-sdk/support/parse_time_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/validators_spec.rb
 - spec/wavefront-sdk/webhook_spec.rb
 - spec/wavefront-sdk/write_spec.rb
+- 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/socket_spec.rb
+- spec/wavefront-sdk/writers/summary_spec.rb
 - wavefront-sdk.gemspec
 homepage: https://github.com/snltd/wavefront-sdk
 licenses:
@@ -294,36 +314,44 @@ test_files:
 - spec/.rubocop.yml
 - spec/spec_helper.rb
 - spec/wavefront-sdk/alert_spec.rb
-- spec/wavefront-sdk/base_spec.rb
-- spec/wavefront-sdk/base_write_spec.rb
 - spec/wavefront-sdk/cloudintegration_spec.rb
+- spec/wavefront-sdk/core/api_caller_spec.rb
+- spec/wavefront-sdk/core/api_spec.rb
+- spec/wavefront-sdk/core/logger_spec.rb
+- spec/wavefront-sdk/core/response_spec.rb
 - spec/wavefront-sdk/credentials_spec.rb
 - spec/wavefront-sdk/dashboard_spec.rb
 - spec/wavefront-sdk/derivedmetric_spec.rb
+- spec/wavefront-sdk/distribution_spec.rb
 - spec/wavefront-sdk/event_spec.rb
 - spec/wavefront-sdk/externallink_spec.rb
 - spec/wavefront-sdk/integration_spec.rb
-- spec/wavefront-sdk/logger_spec.rb
 - spec/wavefront-sdk/maintenancewindow_spec.rb
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
-- spec/wavefront-sdk/mixins_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
-- spec/wavefront-sdk/parse_time_spec.rb
+- spec/wavefront-sdk/paginator/base_spec.rb
+- spec/wavefront-sdk/paginator/post_spec.rb
 - spec/wavefront-sdk/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
 - spec/wavefront-sdk/report_spec.rb
 - spec/wavefront-sdk/resources/dummy_points.rb
 - spec/wavefront-sdk/resources/test.conf
 - spec/wavefront-sdk/resources/test2.conf
-- spec/wavefront-sdk/response_spec.rb
 - spec/wavefront-sdk/savedsearch_spec.rb
 - spec/wavefront-sdk/search_spec.rb
 - spec/wavefront-sdk/source_spec.rb
 - spec/wavefront-sdk/stdlib/array_spec.rb
 - spec/wavefront-sdk/stdlib/hash_spec.rb
 - spec/wavefront-sdk/stdlib/string_spec.rb
+- spec/wavefront-sdk/support/mixins_spec.rb
+- spec/wavefront-sdk/support/parse_time_spec.rb
 - spec/wavefront-sdk/user_spec.rb
 - spec/wavefront-sdk/validators_spec.rb
 - spec/wavefront-sdk/webhook_spec.rb
 - spec/wavefront-sdk/write_spec.rb
+- 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/socket_spec.rb
+- spec/wavefront-sdk/writers/summary_spec.rb

data/lib/wavefront-sdk/base.rb

@@ -1,264 +0,0 @@
-require 'json'
-require 'time'
-require 'faraday'
-require 'pp'
-require 'ostruct'
-require 'addressable'
-require_relative 'logger'
-require_relative 'exception'
-require_relative 'mixins'
-require_relative 'response'
-require_relative 'validators'
-require_relative 'version'
-
-module Wavefront
-  #
-  # Abstract class from which all API classes inherit. When you make
-  # any call to the Wavefront API from this SDK, you are returned an
-  # OpenStruct object.
-  #
-  # @return a Wavefront::Response object
-  #
-  class Base
-    include Wavefront::Validators
-    include Wavefront::Mixins
-    attr_reader :opts, :debug, :noop, :verbose, :net, :conn,
-                :update_keys, :logger
-
-    # Create a new API object. This will always be called from a
-    # class which inherits this one. If the inheriting class defines
-    # #post_initialize, that method will be called afterwards, with
-    # the same arguments.
-    #
-    # @param creds [Hash] must contain the keys `endpoint` (the
-    #   Wavefront API server) and `token`, the user token with which
-    #   you wish to access the endpoint. Can optionally contain
-    #   `agent`, which will become the `user-agent` string sent with
-    #   all requests.
-    # @param opts [Hash] options governing class behaviour. Expected
-    #   keys are `debug`, `noop` and `verbose`, all boolean; and
-    #   `logger`, which must be a standard Ruby logger object. You
-    #   can also pass :response_only. If this is true, you will only
-    #   be returned a hash of the 'response' object returned by
-    #   Wavefront.
-    # @return [Nil]
-    #
-    def initialize(creds = {}, opts = {})
-      @opts    = opts
-      @debug   = opts[:debug] || false
-      @noop    = opts[:noop] || false
-      @verbose = opts[:verbose] || false
-      @logger  = Wavefront::Logger.new(opts)
-      setup_endpoint(creds)
-      post_initialize(creds, opts) if respond_to?(:post_initialize)
-    end
-
-    def log(message, severity = :info)
-      logger.log(message, severity)
-    end
-
-    # Convert an epoch timestamp into epoch milliseconds. If the
-    # timestamp looks like it's already epoch milliseconds, return
-    # it as-is.
-    #
-    # @param t [Integer] epoch timestamp
-    # @return [Ingeter] epoch millisecond timestamp
-    #
-    def time_to_ms(time)
-      return false unless time.is_a?(Integer)
-      return time if time.to_s.size == 13
-      (time.to_f * 1000).round
-    end
-
-    # Derive the first part of the API path from the class name. You
-    # can override this in your class if you wish
-    #
-    # @return [String] portion of API URI
-    #
-    def api_base
-      self.class.name.split('::').last.downcase
-    end
-
-    # Create a Faraday connection object. The server comes from the
-    # endpoint passed to the initializer in the 'creds' hash; the
-    # root of the URI is dynamically derived by the #setup_endpoint
-    # method.
-    #
-    # @param headers [Hash] additional headers
-    # @return [URI::HTTPS]
-    #
-    def mk_conn(path, headers = {})
-      url = format('https://%s%s', net[:endpoint], [net[:api_base],
-                                                    path].uri_concat)
-      Faraday.new(url:     Addressable::URI.encode(url),
-                  headers: net[:headers].merge(headers))
-    end
-
-    # Make a GET call to the Wavefront API and return the result as
-    # a Ruby hash. Can optionally perform a verbose noop, if the
-    # @noop class variable is set. If @verbose is set, then prints
-    # the information used to build the URI.
-    #
-    # @param path [String] path to be appended to the
-    #   #net[:api_base] path.
-    # @param query [Hash] optional key-value pairs with will be made
-    #   into aquery string
-    # @return [Hash] API response
-    #
-    def api_get(path, query = {})
-      make_call(mk_conn(path), :get, nil, query)
-    end
-
-    # Make a POST call to the Wavefront API and return the result as
-    # a Ruby hash. Can optionally perform a verbose noop, if the
-    # @noop class variable is set. If @verbose is set, then prints
-    # the information used to build the URI.
-    #
-    # @param path [String] path to be appended to the
-    #   #net[:api_base] path.
-    # @param body [String] optional body text to post
-    # @param ctype [String] the content type to use when posting
-    # @return [Hash] API response
-    #
-    def api_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'),
-                :post, nil, body)
-    end
-
-    # Make a PUT call to the Wavefront API and return the result as
-    # a Ruby hash. Can optionally perform a verbose noop, if the
-    # @noop class variable is set. If @verbose is set, then prints
-    # the information used to build the URI.
-    #
-    # @param path [String] path to be appended to the
-    #   #net[:api_base] path.
-    # @param body [String] optional body text to post
-    # @param ctype [String] the content type to use when putting
-    # @return [Hash] API response
-    #
-    def api_put(path, body = nil, ctype = 'application/json')
-      make_call(mk_conn(path,  'Content-Type': ctype,
-                               'Accept': 'application/json'),
-                :put, nil, body.to_json)
-    end
-
-    # Make a DELETE call to the Wavefront API and return the result
-    # as a Ruby hash. Can optionally perform a verbose noop, if the
-    # @noop class variable is set. If @verbose is set, then prints
-    # the information used to build the URI.
-    #
-    # @param path [String] path to be appended to the
-    #   #net[:api_base] path.
-    # @return [Hash] API response
-    #
-    def api_delete(path)
-      make_call(mk_conn(path), :delete)
-    end
-
-    # doing a PUT to update an object requires only a certain subset of
-    # the keys returned by #describe(). This method takes the
-    # existing description of an object and turns it into a new has
-    # which can be PUT.
-    #
-    # @param old [Hash] a hash of the existing object
-    # @param new [Hash] the keys you wish to update
-    # @return [Hash] a hash containing only the keys which need to be
-    #   sent to the API. Keys will be symbolized.
-    #
-    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|
-        update_keys.include?(k)
-      end
-    end
-
-    # If we need to massage a raw response to fit what the
-    # Wavefront::Response class expects (I'm looking at you,
-    # 'User'), a class can provide a {#response_shim} method.
-    #
-    def respond(resp)
-      body = if respond_to?(:response_shim)
-               response_shim(resp.body, resp.status)
-             else
-               resp.body
-             end
-
-      Wavefront::Response.new(body, resp.status, opts)
-    end
-
-    # Return all objects using a lazy enumerator
-    # @return Enumerable
-    #
-    def everything
-      Enumerator.new do |y|
-        offset = 0
-        limit = 100
-
-        loop do
-          resp = api_get('', offset: offset, limit: limit).response
-          resp.items.map { |i| y.<< i }
-          offset += limit
-          raise StopIteration unless resp.moreItems == true
-        end
-      end.lazy
-    end
-
-    def api_path
-      ['', 'api', 'v2', api_base].uri_concat
-    end
-
-    private
-
-    # Try to describe the actual HTTP calls we make. There's a bit
-    # of clumsy guesswork here
-    #
-    def verbosity(conn, method, *args)
-      log format('uri: %s %s', method.upcase, conn.url_prefix)
-
-      return unless args.last && !args.last.empty?
-
-      log method == :get ? "params: #{args.last}" : "body: #{args.last}"
-    end
-
-    # Make the API call, or not, if noop is set.
-    #
-    def make_call(conn, method, *args)
-      verbosity(conn, method, *args) if noop || verbose
-      return if noop
-
-      resp = conn.public_send(method, *args)
-
-      if debug
-        require 'pp'
-        pp resp
-      end
-
-      respond(resp)
-    end
-
-    def validate_credentials(creds)
-      %w[endpoint token].each do |k|
-        unless creds.key?(k.to_sym)
-          raise(Wavefront::Exception::CredentialError,
-                format('credentials must contain %s', k))
-        end
-      end
-    end
-
-    def setup_endpoint(creds)
-      validate_credentials(creds)
-
-      unless creds.key?(:agent) && creds[:agent]
-        creds[:agent] = "wavefront-sdk #{WF_SDK_VERSION}"
-      end
-
-      @net = { headers:  { 'Authorization': "Bearer #{creds[:token]}",
-                           'user-agent':    creds[:agent] },
-               endpoint: creds[:endpoint],
-               api_base: api_path }
-    end
-  end
-end