wavefront-sdk 5.2.1 → 5.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e623522f872c4204c1e723ee5a399c513251933e64445f6f5b65ff66d2fbffc
-  data.tar.gz: 6f55f44177169c24d4c0aa89490464097a6fe2278e24a1e3b83e5f7520757dfd
+  metadata.gz: 47c3ed865038dcefae2e115015cfd5cda6d2eec720278010ab16b285261ae7d3
+  data.tar.gz: 31816281995c53c3b6a12cdf103edbfbf0274a14f8353dc4085a1356bb770a0f
 SHA512:
-  metadata.gz: 58bb998cc92b36c369497631f766af8844a692fbd10508962ee7bd30f4fbe65d222bc512d06b63feb19ca94cdcc4e8429b8c61f6227e4ff1041cd6ffff141758
-  data.tar.gz: 198dfadd7561b5c3772211716d23f9653ace3bbf472e41d12fa8b64d744ed16567bb11796ef3aff252054bc0945200ea71e454b5989824656c178e74503b4675
+  metadata.gz: c9801eec9641016634808e2ad4e40139222fbf3e3c7ef3d0bde7ca85e5b9fe273d5d91700f290531775b4ef1ae463d3eb75e219b47936ca7ab69fa8211a27a5d
+  data.tar.gz: d07c63a3aa77ba33ae7c5b6c43bbc8a5af1f3c5b981f7a8543f3e2bd86a431ba6e1730a746a04b5cc5c0d149e4ec080657160c4876c51d09b1f9648f39ff3041

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.4.10, 2.5.8, 2.6.6, 2.7.2]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with: 
+        ruby-version: ${{ matrix.ruby-version }}     
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.travis.yml

@@ -2,9 +2,9 @@ language: ruby
 cache: bundler
 rvm:
   - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
 before_install: gem install bundler --no-document
 deploy:
   provider: rubygems
@@ -14,7 +14,7 @@ deploy:
   on:
     tags: true
     repo: snltd/wavefront-sdk
-    ruby: 2.6.5
+    ruby: 2.6.6
 notifications:
   email: false
   slack:

data/HISTORY.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 5.4.2 (2021-01-11)
+* Fix bug which blocked event updates.
+
+## 5.4.1 (2020-12-17)
+* Fix error on derived metric modification.
+
+## 5.4.0 (2020-12-16)
+* Add `raw_response` option, which makes the SDK return the raw API response
+  as plain JSON text, rather than as a `Wavefront::Response` object.
+
+## 5.3.1 (2020-12-11)
+* Fix error when renaming ingestion policies, and improve testing which should
+  have caught the problem in the first place.
+
+## 5.3.0 (2020-10-10)
+* Add `Wavefront::Proxy#shutdown` which can shut down a proxy via the API.
+
 ## 5.2.1 (2020-09-18)
 * Remove necessity for user to `require 'pathname'`
 

data/lib/wavefront-sdk/cloudintegration.rb

@@ -128,5 +128,9 @@ module Wavefront
       wf_aws_external_id?(external_id)
       api.get(['awsExternalId', external_id].uri_concat)
     end
+
+    def update_keys
+      %i[name]
+    end
   end
 end

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

@@ -81,9 +81,9 @@ module Wavefront
       (time.to_f * 1000).round
     end
 
-    # doing a PUT to update an object requires only a certain subset of
+    # 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
+    # existing description of an object and turns it into a new hash
     # which can be PUT.
     #
     # @param old [Hash] a hash of the existing object

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

@@ -15,8 +15,7 @@ module Wavefront
   class ApiCaller
     include Wavefront::Mixins
 
-    attr_reader :opts, :noop, :debug, :verbose, :net, :logger,
-                :calling_class
+    attr_reader :opts, :noop, :debug, :verbose, :net, :logger, :calling_class
 
     # @param calling_class [
     # @param creds [Hash] Wavefront credentials
@@ -178,7 +177,9 @@ module Wavefront
                resp.body
              end
 
-      Wavefront::Response.new(body, resp.status, @opts)
+      return body if opts[:raw_response]
+
+      Wavefront::Response.new(body, resp.status, opts)
     end
 
     # Try to describe the actual HTTP calls we make. There's a bit

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

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

data/lib/wavefront-sdk/derivedmetric.rb

@@ -112,11 +112,9 @@ module Wavefront
       wf_derivedmetric_id?(id)
     end
 
-    private
-
     def update_keys
-      %i[id name query tags additionalInformation
-         includeObsoleteMetrics processRateMinutes minutes]
+      %i[id name query tags additionalInformation includeObsoleteMetrics
+         processRateMinutes minutes]
     end
   end
 end

data/lib/wavefront-sdk/event.rb

@@ -12,7 +12,7 @@ module Wavefront
     include Wavefront::Mixin::Tag
 
     def update_keys
-      %i[startTime endTime name annotations]
+      %i[id name]
     end
 
     # GET /api/v2/event
@@ -100,7 +100,9 @@ module Wavefront
 
       return api.put(id, body, 'application/json') unless modify
 
-      api.put(id, hash_for_update(describe(id), body), 'application/json')
+      api.put(id,
+              hash_for_update(describe(id).response, body),
+              'application/json')
     end
 
     # POST /api/v2/event/id/close

data/lib/wavefront-sdk/ingestionpolicy.rb

@@ -81,5 +81,9 @@ module Wavefront
       api.put(id, hash_for_update(describe(id).response, body),
               'application/json')
     end
+
+    def update_keys
+      %i[name]
+    end
   end
 end

data/lib/wavefront-sdk/notificant.rb

@@ -83,8 +83,6 @@ module Wavefront
       api.post(['test', id].uri_concat, nil)
     end
 
-    private
-
     def update_keys
       %i[id contentType method description title template triggers
          recipient customHttpHeaders emailSubject isHtmlContent]

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

@@ -50,7 +50,7 @@ module Wavefront
       def body_as(desired, args, index = 1)
         body = args[index]
 
-        return args if body.class == desired
+        return args if body.instance_of?(desired)
 
         args[index] = body_as_json(body)
         args

data/lib/wavefront-sdk/proxy.rb

@@ -86,5 +86,15 @@ module Wavefront
       wf_proxy_id?(id)
       api.put(id, payload)
     end
+
+    # Shutdown a proxy. Requires proxy >=5.x. Might not be effective if you
+    # have something like systemd or SMF restarting a failed proxy.
+    # @param id [String] ID of the proxy
+    # @return [Wavefront::Response]
+    #
+    def shutdown(id)
+      wf_proxy_id?(id)
+      api.put(id, { shutdown: true }, 'application/json')
+    end
   end
 end

data/lib/wavefront-sdk/savedsearch.rb

@@ -80,5 +80,9 @@ module Wavefront
       api.get(['type', entitytype].uri_concat, offset: offset,
                                                limit: limit)
     end
+
+    def update_keys
+      %i[query entityType]
+    end
   end
 end

data/lib/wavefront-sdk/support/mixins.rb

@@ -23,7 +23,7 @@ module Wavefront
     # @raise Wavefront::InvalidTimestamp
     #
     def parse_time(time, in_ms = false)
-      return relative_time(time, in_ms) if time.to_s =~ /^[\-+]/
+      return relative_time(time, in_ms) if time.to_s.match?(/^[\-+]/)
 
       ParseTime.new(time, in_ms).parse!
     end

data/lib/wavefront-sdk/support/parse_time.rb

@@ -34,7 +34,7 @@ module Wavefront
     # @return [Fixnum] timestamp
     #
     def parse_time_string
-      return t.to_i if t =~ /^\d+$/
+      return t.to_i if t.match?(/^\d+$/)
 
       @t = Time.parse("#{t} #{Time.now.getlocal.zone}")
       parse_time_time

data/lib/wavefront-sdk/user.rb

@@ -297,6 +297,10 @@ module Wavefront
       raise NoMethodError
     end
 
+    def update_keys
+      %i[identifier groups userGroups]
+    end
+
     private
 
     def response_looks_right?(body_obj)
@@ -311,9 +315,5 @@ module Wavefront
 
       items.fetch(:message, 'no message from API')
     end
-
-    def update_keys
-      %i[identifier groups userGroups]
-    end
   end
 end

data/spec/test_mixins/general.rb

@@ -65,6 +65,7 @@ module WavefrontTest
   module Update
     def test_update
       [payload].flatten.each do |p|
+        # passes payload through as-is
         assert_puts("/api/v2/#{api_class}/#{id}", p) do
           wf.update(id, p, false)
         end
@@ -73,6 +74,11 @@ module WavefrontTest
         assert_raises(ArgumentError) { wf.update }
       end
     end
+
+    def test_update_keys
+      assert_instance_of Array, wf.update_keys
+      assert(wf.update_keys.all? { |k| k.is_a?(Symbol) })
+    end
   end
 
   module Clone

data/spec/wavefront-sdk/alert_spec.rb

@@ -4,7 +4,6 @@
 require_relative '../spec_helper'
 require_relative '../test_mixins/acl'
 require_relative '../test_mixins/tag'
-require_relative '../test_mixins/update_keys'
 require_relative '../test_mixins/general'
 
 # Unit tests for Alert class
@@ -20,7 +19,6 @@ class WavefrontAlertTest < WavefrontTestBase
   include WavefrontTest::List
   include WavefrontTest::Tag
   include WavefrontTest::Update
-  include WavefrontTest::UpdateKeys
 
   def test_snooze
     assert_posts("/api/v2/alert/#{id}/snooze") { wf.snooze(id) }

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

@@ -23,7 +23,15 @@ class WavefrontCoreApiTest < MiniTest::Test
 
   def test_hash_for_update
     wf.instance_variable_set('@update_keys', %i[k1 k2])
-    body = { k1: 'ov1', k2: 'ov2', k3: 'ov3' }
+    body = { k1: 'ov1',
+             k2: 'ov2',
+             k3: 'ov3',
+             customerId: 'test',
+             creatorId: 'someone@example.com',
+             createUserId: 'someone@example.com',
+             updateUserId: 'someone@example.com',
+             createdEpochMillis: 1_607_691_387_023,
+             updatedEpochMillis: 1_607_691_387_023 }
     upd = { k2: 'nv1' }
     assert_equal({ k1: 'ov1', k2: 'nv1' }, wf.hash_for_update(body, upd))
   end

data/spec/wavefront-sdk/dashboard_spec.rb

@@ -4,7 +4,6 @@
 require_relative '../spec_helper'
 require_relative '../test_mixins/acl'
 require_relative '../test_mixins/tag'
-require_relative '../test_mixins/update_keys'
 require_relative '../test_mixins/general'
 
 # Unit tests for dashboard class
@@ -18,7 +17,6 @@ class WavefrontDashboardTest < WavefrontTestBase
   include WavefrontTest::List
   include WavefrontTest::Tag
   include WavefrontTest::Update
-  include WavefrontTest::UpdateKeys
 
   def test_favorite
     assert_posts("/api/v2/dashboard/#{id}/favorite") { wf.favorite(id) }

data/spec/wavefront-sdk/derivedmetric_spec.rb

@@ -29,6 +29,7 @@ class WavefrontDerivedMetricTest < WavefrontTestBase
   def payload
     { minutes: 5,
       name: 'test_1',
+      id: id,
       query: 'aliasMetric(ts("test.metric"), "derived.test_1")',
       tags: { customerTags: ['test'] },
       includeObsoleteMetrics: false,

data/spec/wavefront-sdk/misc_spec.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative '../../lib/wavefront-sdk/defs/version'
+
+# Tests for things that aren't in the SDK itself.
+#
+class WavefrontMiscTest < MiniTest::Test
+  # Check the latest version mentioned in the changelog is the version the SDK
+  # defines itself as.
+  #
+  def test_version_vs_history
+    history_file = WF_SDK_LOCATION + 'HISTORY.md'
+    history_vers = IO.read(history_file).match(/^## (\d+\.\d+\.\d+) \(/)
+    assert_equal(WF_SDK_VERSION, history_vers.captures.first)
+  end
+end

data/spec/wavefront-sdk/notificant_spec.rb

@@ -10,6 +10,7 @@ class WavefrontNotificantTest < WavefrontTestBase
   include WavefrontTest::List
   include WavefrontTest::Delete
   include WavefrontTest::Describe
+  include WavefrontTest::Update
 
   def test_test
     assert_posts("/api/v2/notificant/test/#{id}") { wf.test(id) }
@@ -29,4 +30,30 @@ class WavefrontNotificantTest < WavefrontTestBase
   def invalid_id
     '---rubbish---'
   end
+
+  def payload
+    JSON.parse(%(
+{
+  "method": "PAGERDUTY",
+  "id": "PE0BEkf4r123yooO",
+  "contentType": "",
+  "description": "Test target",
+  "customerId": "sysdef",
+  "title": "Terraform Test Target",
+  "recipient": "12345678910111213141516171819202",
+  "creatorId": "someone@example.com",
+  "updaterId": "someone@example.com",
+  "createdEpochMillis": 1604513812010,
+  "updatedEpochMillis": 1604513812010,
+  "template": "{}",
+  "triggers": [
+    "ALERT_OPENED",
+    "ALERT_RESOLVED"
+  ],
+  "customHttpHeaders": {},
+  "emailSubject": "",
+  "isHtmlContent": false
+}
+    ), symbolize_names: true)
+  end
 end

data/spec/wavefront-sdk/proxy_spec.rb

@@ -21,6 +21,12 @@ class WavefrontProxyTest < WavefrontTestBase
     assert_raises(ArgumentError) { wf.rename }
   end
 
+  def test_shutdown
+    assert_puts("/api/v2/proxy/#{id}", { shutdown: true }.to_json, :json) do
+      wf.shutdown(id)
+    end
+  end
+
   private
 
   def api_class

data/wavefront-sdk.gemspec

@@ -23,16 +23,16 @@ Gem::Specification.new do |gem|
   gem.bindir        = 'bin'
 
   gem.add_dependency 'addressable', '~> 2.7'
-  gem.add_dependency 'faraday', '~> 1.0'
+  gem.add_dependency 'faraday', '~> 1.1'
   gem.add_dependency 'inifile', '~> 3.0'
   gem.add_dependency 'map', '~> 6.6'
 
   gem.add_development_dependency 'minitest', '~> 5.14'
   gem.add_development_dependency 'rake', '~> 13.0'
-  gem.add_development_dependency 'rubocop', '0.91.0'
+  gem.add_development_dependency 'rubocop', '1.0'
   gem.add_development_dependency 'simplecov', '~> 0.18'
   gem.add_development_dependency 'spy', '1.0.0'
-  gem.add_development_dependency 'webmock', '~> 3.8'
+  gem.add_development_dependency 'webmock', '~> 3.9'
   gem.add_development_dependency 'yard', '~> 0.9'
 
   gem.required_ruby_version = Gem::Requirement.new('>= 2.4.0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.4.2
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +171,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -254,7 +255,6 @@ files:
 - spec/test_mixins/acl.rb
 - spec/test_mixins/general.rb
 - spec/test_mixins/tag.rb
-- spec/test_mixins/update_keys.rb
 - spec/wavefront-sdk/account_spec.rb
 - spec/wavefront-sdk/alert_spec.rb
 - spec/wavefront-sdk/api_mixins/user_mixins_spec.rb
@@ -276,6 +276,7 @@ files:
 - spec/wavefront-sdk/message_spec.rb
 - spec/wavefront-sdk/metric_helper_spec.rb
 - spec/wavefront-sdk/metric_spec.rb
+- spec/wavefront-sdk/misc_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
 - spec/wavefront-sdk/paginator/post_spec.rb
@@ -351,7 +352,6 @@ test_files:
 - spec/test_mixins/acl.rb
 - spec/test_mixins/general.rb
 - spec/test_mixins/tag.rb
-- spec/test_mixins/update_keys.rb
 - spec/wavefront-sdk/account_spec.rb
 - spec/wavefront-sdk/alert_spec.rb
 - spec/wavefront-sdk/api_mixins/user_mixins_spec.rb
@@ -373,6 +373,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/misc_spec.rb
 - spec/wavefront-sdk/notificant_spec.rb
 - spec/wavefront-sdk/paginator/base_spec.rb
 - spec/wavefront-sdk/paginator/post_spec.rb

data/spec/test_mixins/update_keys.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module WavefrontTest
-  #
-  # include this into any class which has update keys
-  #
-  module UpdateKeys
-    def test_update_keys
-      assert_instance_of Array, wf.update_keys
-      assert(wf.update_keys.all? { |k| k.is_a?(Symbol) })
-    end
-  end
-end