wavefront-sdk 5.3.0 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9589c220f3c1cb86c7e3c4e3f051315508358580656e61e61d716a756568e9a4
-  data.tar.gz: 03b24e65b9617170af9b03eadae0d7cbd9d78cea99f1be60f8452ef79989d81d
+  metadata.gz: 0fc4311b2322403ef715d9a62c5f84712accb5ed1ee9e5350e0bbcb6237fe631
+  data.tar.gz: f2fb99d1f35d601a619f0e7135f8b22ea0b22d0697752af5a265132d867216bb
 SHA512:
-  metadata.gz: 9ea8ef64251bb430053390d991a16024f1d1545524fe36479a5369c94dcf87669bb77a1cfab92395e2cdd6e23d10fa6c38738fe7227a6e572e0630f35830afca
-  data.tar.gz: b85aa3b9a03e338b4db8fc702bb0b03532d1eaa7618e044f10a7dbc9a973ffebdeaa4891f4a02c717e7c59db280cee551b8765d6cf8dee2f8fe630f6d5bb4201
+  metadata.gz: a2e79e3ce013f9fcdc3e28d7e111c586746e65ae341b0187b44b3908d29d81ae9aa8f0723d8eeea239c27f9976b232aa2acf2ecda92b797b0c45f25dc9e9c612
+  data.tar.gz: 20f3124667013b4f1212df12c6e04c235e7dfda24e3f0ac9a87ba4c4a4884d96d11f1a855d460f8026d65d8a35754d7a2f5d0bf705f13456dea066d0faee7822

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/HISTORY.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 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.
 

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/defs/version.rb

@@ -2,5 +2,5 @@
 
 require 'pathname'
 
-WF_SDK_VERSION = '5.3.0'
+WF_SDK_VERSION = '5.3.1'
 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[name query tags additionalInformation includeObsoleteMetrics
+         processRateMinutes minutes]
     end
   end
 end

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/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/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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.3.1
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-31 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -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
@@ -352,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

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