wavefront-sdk 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c09b458b9e9921e9a33d3478fffd60c9428239f
-  data.tar.gz: 7b2d2bceb5c45fec4c221b62569d7bd089737fe2
+  metadata.gz: 2002dacfb813974ef1b2450b4843142bc399d472
+  data.tar.gz: 6b6f2ec545568e1ae155b98c9ecf0b6d8b7e6737
 SHA512:
-  metadata.gz: 5a616119c5be2f0c074410156240a8647e37dac522193d52e84a3496d38360cb040649cfac4b028732e2b24f835fbaa03be7aadf074b45c61adcf602ca4048fc
-  data.tar.gz: 5a80bc97dbdbb236208462bb337914f2fe0e899ec5046d8e44ec440b13ff7e657707a5c08cfcb5adaff759448863aa8daff07dd86ec5ac4f40b55e3fcadcf7ad
+  metadata.gz: 7f36ed4ec001d74f134c5e9b893cc11e9f71872b885960ceb5da87d7d8915c5b63dbc362604d599f768efa826ea6efa63a17802a8f1bea4ce254fd41184620ae
+  data.tar.gz: 1641bf8dadb681d1401c332136fc7dd139379fb65c890e40f5deeee129de973c7f97a19587cdf31285d78c7a76e8d0ae89d4296de180fdf1b91dd70e1be713a3

data/README.md

@@ -2,8 +2,8 @@
 [![Build Status](https://travis-ci.org/snltd/wavefront-sdk.svg?branch=master)](https://travis-ci.org/snltd/wavefront-sdk) [![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) [![Dependency Status](https://gemnasium.com/badges/github.com/snltd/wavefront-sdk.svg)](https://gemnasium.com/github.com/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 supports Ruby
->= 2.2. It aims to be more lightweight, consistent, simple, and
+[Wavefront](https://www.wavefront.com/)'s public API. It supports
+Ruby >= 2.2. It aims to be more lightweight, consistent, simple, and
 convenient than an auto-generated SDK.
 
 ## Installation

data/lib/wavefront-sdk/exception.rb

@@ -13,10 +13,12 @@ module Wavefront
     class InvalidExternalLinkId < ::Exception; end
     class InvalidGranularity < ::Exception; end
     class InvalidHostname < ::Exception; end
+    class InvalidIntegrationId < ::Exception; end
     class InvalidMaintenanceWindowId < ::Exception; end
     class InvalidMessageId < ::Exception; end
     class InvalidMetricName < ::Exception; end
     class InvalidMetricValue < ::Exception; end
+    class InvalidNotificantId < ::Exception; end
     class InvalidName < ::Exception; end
     class InvalidPoint < ::Exception; end
     class InvalidPrefixLength < ::Exception; end

data/lib/wavefront-sdk/integration.rb

@@ -0,0 +1,82 @@
+require_relative './base'
+
+module Wavefront
+  #
+  # Manage and query Wavefront integrations.
+  #
+  class Integration < Base
+
+    # GET /api/v2/integration
+    # Gets a flat list of all Wavefront integrations available,
+    # along with their status
+    #
+    # @param offset [Int] proxy at which the list begins
+    # @param limit [Int] the number of proxies to return
+    #
+    def list(offset = 0, limit = 100)
+      api_get('', { offset: offset, limit: limit })
+    end
+
+    # GET /api/v2/integration/id
+    # Gets a single Wavefront integration by its id, along with its
+    # status
+    #
+    # @param id [String] ID of the proxy
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_integration_id?(id)
+      api_get(id)
+    end
+
+    # POST /api/v2/integration/id/install
+    # Installs a Wavefront integration
+    #
+    # @param id [String] ID of the integration
+    # @return [Wavefront::Response]
+    #
+    def install(id)
+      wf_integration_id?(id)
+      api_post([id, 'install'].uri_concat, nil)
+    end
+
+    # POST /api/v2/integration/id/uninstall
+    # Uninstalls a Wavefront integration
+    #
+    # @param id [String] ID of the integration
+    # @return [Wavefront::Response]
+    #
+    def uninstall(id)
+      wf_integration_id?(id)
+      api_post([id, 'uninstall'].uri_concat, nil)
+    end
+
+    # GET /api/v2/integration/id/status
+    # Gets the status of a single Wavefront integration
+    #
+    # @param id [String] ID of the integration
+    # @return [Wavefront::Response]
+    #
+    def status(id)
+      wf_integration_id?(id)
+      api_get([id, 'status'].uri_concat)
+    end
+
+    # GET /api/v2/integration/status
+    # Gets the status of all Wavefront integrations
+    #
+    # @return [Wavefront::Response]
+    #
+    def statuses
+      api_get('status')
+    end
+
+    # GET /api/v2/integration/manifests
+    # Gets all Wavefront integrations as structured in their
+    # integration manifests, along with their status
+    #
+    def manifests
+      api_get('manifests')
+    end
+  end
+end

data/lib/wavefront-sdk/notificant.rb

@@ -0,0 +1,84 @@
+require_relative './base'
+
+module Wavefront
+  #
+  # Manage and query Wavefront notification targets.
+  #
+  class Notificant < Base
+
+    # GET /api/v2/notificant
+    # Get all notification targets for a customer
+    #
+    # @param offset [Int] notificant at which the list begins
+    # @param limit [Int] the number of notification targets to return
+    #
+    def list(offset = 0, limit = 100)
+      api_get('', { offset: offset, limit: limit })
+    end
+
+    # POST /api/v2/notificant
+    # Create a notification target.
+    #
+    # @param body [Hash] description of notification target
+    # @return [Wavefront::Response]
+    #
+    def create(body)
+      raise ArgumentError unless body.is_a?(Hash)
+      api_post('', body, 'application/json')
+    end
+
+    # DELETE /api/v2/notificant/id
+    # Delete a specific notificant
+    #
+    # @param id [String] ID of the notification target
+    # @return [Wavefront::Response]
+    #
+    def delete(id)
+      wf_notificant_id?(id)
+      api_delete(id)
+    end
+
+    # GET /api/v2/notificant/id
+    # Get a specific notification target
+    #
+    # @param id [String] ID of the notification target
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_notificant_id?(id)
+      api_get(id)
+    end
+
+    # PUT /api/v2/notificant/id
+    # Update a specific notification target
+    #
+    # @param id [String] a Wavefront notification target 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(id, body, modify = true)
+      wf_notificant_id?(id)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      return api_put(id, body, 'application/json') unless modify
+
+      api_put(id, hash_for_update(describe(id).response, body),
+              'application/json')
+    end
+
+    # POST /api/v2/notificant/test/id
+    # Create a notification target.
+    #
+    # @param body [Hash] description of notification target
+    # @return [Wavefront::Response]
+    #
+    def test(id)
+      wf_notificant_id?(id)
+      api_post(['test', id].uri_concat, nil)
+    end
+   end
+end

data/lib/wavefront-sdk/source.rb

@@ -48,6 +48,23 @@ module Wavefront
       api_delete(id)
     end
 
+    # POST /api/v2/source/id/description
+    # Set description associated with a specific source
+
+    def description_set(id, description)
+      wf_source_id?(id)
+      api_post([id, 'description'].uri_concat, description,
+               'application/json')
+    end
+
+    # DELETE /api/v2/source/id/description
+    # Remove description from a specific source
+
+    def description_delete(id)
+      wf_source_id?(id)
+      api_delete([id, 'description'].uri_concat)
+    end
+
     # GET /api/v2/source/id
     # Get a specific source for a customer.
     #

data/lib/wavefront-sdk/validators.rb

@@ -391,5 +391,31 @@ module Wavefront
       wf_point_tags?(v[:tags]) if v[:tags]
       true
     end
+
+    # Ensure the given argument is a valid Wavefront
+    # notificant ID.
+    #
+    # @param v [String] the notificant name to validate
+    # @return True if the notificant name is valid
+    # @raise Wavefront::Exception::InvalidNotificantId if the
+    #   notificant ID is not valid
+    #
+    def wf_notificant_id?(v)
+      return true if v.is_a?(String) && v =~ /^\w{16}$/
+      raise Wavefront::Exception::InvalidNotificantId
+    end
+
+    # Ensure the given argument is a valid Wavefront
+    # integration ID. These appear to be lower-case strings.
+    #
+    # @param v [String] the integration name to validate
+    # @return True if the integration name is valid
+    # @raise Wavefront::Exception::InvalidIntegrationId if the
+    #   integration ID is not valid
+    #
+    def wf_integration_id?(v)
+      return true if v.is_a?(String) && v =~ /^[a-z0-9]+$/
+      raise Wavefront::Exception::InvalidIntegrationId
+    end
   end
 end

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '1.0.3'.freeze
+WF_SDK_VERSION = '1.1.0'.freeze

data/spec/wavefront-sdk/integration_spec.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require_relative '../spec_helper'
+
+INTEGRATION = 'tester'.freeze
+
+# Unit tests for Integration class
+#
+class WavefrontIntegrationTest < WavefrontTestBase
+  def test_list
+    should_work(:list, 10, '?offset=10&limit=100')
+  end
+
+  def test_install
+    should_work(:install, INTEGRATION, ["#{INTEGRATION}/install", nil],
+                :post, POST_HEADERS)
+    should_be_invalid(:install)
+    assert_raises(ArgumentError) { wf.install }
+  end
+
+  def test_uninstall
+    should_work(:uninstall, INTEGRATION, ["#{INTEGRATION}/uninstall", nil],
+                :post, POST_HEADERS)
+    should_be_invalid(:uninstall)
+    assert_raises(ArgumentError) { wf.uninstall }
+  end
+
+  def test_describe
+    should_work(:describe, INTEGRATION, INTEGRATION)
+    should_be_invalid(:describe)
+    assert_raises(ArgumentError) { wf.describe }
+  end
+
+  def test_status
+    should_work(:status, INTEGRATION, "#{INTEGRATION}/status")
+    should_be_invalid(:status)
+    assert_raises(ArgumentError) { wf.status }
+  end
+
+  def test_manifests
+    should_work(:manifests, nil, 'manifests')
+  end
+
+  def test_statuses
+    should_work(:statuses, nil, 'status')
+  end
+end

data/spec/wavefront-sdk/notificant_spec.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require_relative '../spec_helper'
+
+NOTIFICANT = '8Bl5l7wxtdGindxk'.freeze
+
+# Unit tests for notificant class
+#
+class WavefrontNotificantTest < WavefrontTestBase
+  def test_list
+    should_work(:list, 10, '?offset=10&limit=100')
+  end
+
+  def test_describe
+    should_work(:describe, NOTIFICANT, NOTIFICANT)
+    should_be_invalid(:describe)
+    assert_raises(ArgumentError) { wf.describe }
+  end
+
+  def test_delete
+    should_work(:delete, NOTIFICANT, NOTIFICANT, :delete)
+    should_be_invalid('delete')
+  end
+
+  def test_test
+    should_work(:test, NOTIFICANT, ["test/#{NOTIFICANT}", nil],
+                :post, POST_HEADERS)
+    should_be_invalid('test')
+  end
+end

data/spec/wavefront-sdk/validators_spec.rb

@@ -243,4 +243,14 @@ class WavefrontValidatorsTest < MiniTest::Test
       wf_point?(bad)
     end
   end
+
+  def test_notificant_id
+    good = %w(CHTo47HvsPzSaGhh)
+    bad = ['CTo47HvsPzSaGhh',  [], {}, nil, 'bad id']
+  end
+
+  def test_integration_id
+    good = %w(aws tutorial elasticsearch cassandra go)
+    bad = ['CTo47HvsPzSaGhh',  [], {}, nil, 'bad id']
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,10 +192,12 @@ files:
 - lib/wavefront-sdk/event.rb
 - lib/wavefront-sdk/exception.rb
 - lib/wavefront-sdk/externallink.rb
+- lib/wavefront-sdk/integration.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/proxy.rb
 - lib/wavefront-sdk/query.rb
 - lib/wavefront-sdk/response.rb
@@ -217,10 +219,12 @@ files:
 - spec/wavefront-sdk/dashboard_spec.rb
 - spec/wavefront-sdk/event_spec.rb
 - spec/wavefront-sdk/externallink_spec.rb
+- spec/wavefront-sdk/integration_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/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
 - spec/wavefront-sdk/resources/test.conf
@@ -267,10 +271,12 @@ test_files:
 - spec/wavefront-sdk/dashboard_spec.rb
 - spec/wavefront-sdk/event_spec.rb
 - spec/wavefront-sdk/externallink_spec.rb
+- spec/wavefront-sdk/integration_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/proxy_spec.rb
 - spec/wavefront-sdk/query_spec.rb
 - spec/wavefront-sdk/resources/test.conf