wavefront-sdk 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f37a97bd03c5522bb5dbbfcb25e13645ae724d60
-  data.tar.gz: 1649e2709f06702ef3dc459157dfbe67c920eb01
+  metadata.gz: d40567787f9b9712aec60c01fc49a6efb30d31ae
+  data.tar.gz: db8147e94b8589d1bd06aed17b6624b19729c3a9
 SHA512:
-  metadata.gz: 9af27034b0984bbb7f3eb02d5ef254c8a57a497bddc6dc8d6585795b8c49e8009dfce6839cb9b6c45baf6d9ba113bed2b895d047aef3bca45065ae62375464ab
-  data.tar.gz: 6189ac5bc2267c07050940ce83ca5f77c89a0c6ce20f6476d0dbe2817f84223c17b8a8e4d89fae35dc0106bef39025417dd3700953b8637c7265d8f93ddbf7bf
+  metadata.gz: cdb83339828a884226d9df89c3376245aebf8d68c2f2cdc3cafb07a73d2cf12ecba6c5faf2bbdc793f11dd7f99423a8e86c941f9ba26b0d54b21f27f2a1a52ac
+  data.tar.gz: c901b39875e0828471bce2c59be8db34ca97d05d459dcb6f7405d58f748241e2e13fc0104f6d5090fcfc74d44ec6a378bf16425a6ddc172c73495989b4aade7c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wavefront-sdk (0.1.3)
+    wavefront-sdk (0.1.5)
       addressable (~> 2.4)
       faraday (>= 0.12.1, < 0.13)
       inifile (>= 3.0.0)

data/lib/wavefront-sdk/cloudintegration.rb

@@ -12,7 +12,7 @@ module Wavefront
     #
     # @param offset [Int] integration at which the list begins
     # @param limit [Int] the number of integration to return
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
       api_get('', { offset: offset, limit: limit })
@@ -23,7 +23,7 @@ module Wavefront
     # valid keys.
     #
     # @param body [Hash] description of integration
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -38,7 +38,7 @@ module Wavefront
     # integration in 'trash' removes it for ever.
     #
     # @param id [String] ID of the integration
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_cloudintegration_id?(id)
@@ -49,7 +49,7 @@ module Wavefront
     # Get a specific cloud integration
     #
     # @param id [String] ID of the integration
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id)
       wf_cloudintegration_id?(id)
@@ -60,7 +60,7 @@ module Wavefront
     # Update a specific cloud integration
     #
     # @param id [String] ID of the integration
-    # @param body [Hash] description of integration
+    # @param body [Wavefront::Response]
     #
     def update(id, body)
       wf_cloudintegration_id?(id)
@@ -72,7 +72,7 @@ module Wavefront
     # Undelete a specific cloud integration
     #
     # @param id [String] ID of the integration
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def undelete(id)
       wf_cloudintegration_id?(id)

data/lib/wavefront-sdk/dashboard.rb

@@ -5,13 +5,16 @@ module Wavefront
   # View and manage dashboards.
   #
   class Dashboard < Base
+    def update_keys
+      %i(id name url description sections)
+    end
 
     # GET /api/v2/dashboard
     # Get all dashboards for a customer.
     #
     # @param offset [Int] dashboard at which the list begins
     # @param limit [Int] the number of dashboard to return
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
       api_get('', { offset: offset, limit: limit })
@@ -22,7 +25,7 @@ module Wavefront
     # Refer to the Swagger API docs for valid keys.
     #
     # @param body [Hash] description of dashboard
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -36,7 +39,7 @@ module Wavefront
     # 'trash' removes it for ever.
     #
     # @param id [String] ID of the dashboard
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_dashboard_id?(id)
@@ -49,7 +52,7 @@ module Wavefront
     #
     # @param id [String] ID of the dashboard
     # @param version [Integer] version of dashboard
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id, version = nil)
       wf_dashboard_id?(id)
@@ -62,22 +65,30 @@ module Wavefront
     # PUT /api/v2/dashboard/id
     # Update a specific dashboard.
     #
-    # Refer to the Swagger API docs for valid keys.
-    #
-    # @param body [Hash] description of dashboard
-    # @return [Hash]
-    #
-    def update(id, body)
+    # @param id [String] a Wavefront alert 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_dashboard_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
-      api_put(id, body)
+
+      return api_put(id, body, 'application/json') unless modify
+
+      api_put(id, hash_for_update(describe(id).response, body),
+              'application/json')
     end
 
+
     # GET /api/v2/dashboard/id/history
     # Get the version history of an dashboard.
     #
     # @param id [String] ID of the dashboard
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def history(id)
       wf_dashboard_id?(id)
@@ -88,7 +99,7 @@ module Wavefront
     # Get all tags associated with a specific dashboard.
     #
     # @param id [String] ID of the dashboard
-    # @return [Hash] object describing the dashboard with status and
+    # @return [Wavefront::Response]
     #   response keys
     #
     def tags(id)
@@ -101,7 +112,7 @@ module Wavefront
     #
     # @param id [String] ID of the dashboard
     # @param tags [Array] list of tags to set.
-    # @return [Hash] object describing the dashboard with status and
+    # @return [Wavefront::Response]
     #   response keys
     #
     def tag_set(id, tags)
@@ -116,7 +127,7 @@ module Wavefront
     #
     # @param id [String] ID of the dashboard
     # @param tag [String] tag to delete
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_delete(id, tag)
       wf_dashboard_id?(id)
@@ -129,7 +140,7 @@ module Wavefront
     #
     # @param id [String] ID of the dashboard
     # @param tag [String] tag to set.
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_add(id, tag)
       wf_dashboard_id?(id)
@@ -141,7 +152,7 @@ module Wavefront
     # Move an dashboard from 'trash' back into active service.
     #
     # @param id [String] ID of the dashboard
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def undelete(id)
       wf_dashboard_id?(id)

data/lib/wavefront-sdk/event.rb

@@ -21,7 +21,7 @@ module Wavefront
     #   current time.
     # @param cursor [String] I think this must start with a timestamp.
     # @param limit [Integer] the number of events to return
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def list(from = nil, to = nil, limit = 100, cursor = nil)
       raise ArgumentError unless from && to
@@ -46,7 +46,7 @@ module Wavefront
     # Refer to the Swagger docs for more information.
     #
     # @param body [Hash] description of event
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -57,7 +57,7 @@ module Wavefront
     # Delete a specific event.
     #
     # @param id [String] ID of the alert
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_event_id?(id)
@@ -70,7 +70,7 @@ module Wavefront
     #
     # @param id [String] ID of the event
     # @param version [Integer] version of event
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id, version = nil)
       wf_event_id?(id)
@@ -91,7 +91,7 @@ module Wavefront
     #   object will be fetched and merged with the user-supplied body.
     #   The resulting object will be passed to the API. If this is
     #   false, the body will be passed through unmodified.
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def update(id, body, modify = true)
       wf_event_id?(id)
@@ -116,7 +116,7 @@ module Wavefront
     # Get all tags associated with a specific event
     #
     # @param id [String] ID of the event
-    # @return [Hash] object describing the event with status and
+    # @return [Wavefront::Response]
     #   response keys
     #
     def tags(id)
@@ -129,7 +129,7 @@ module Wavefront
     #
     # @param id [String] ID of the event
     # @param tags [Array] list of tags to set.
-    # @return [Hash] object describing the event with status and
+    # @return [Wavefront::Response]
     #   response keys
     #
     def tag_set(id, tags)
@@ -144,7 +144,7 @@ module Wavefront
     #
     # @param id [String] ID of the event
     # @param tag [String] tag to delete
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_delete(id, tag)
       wf_event_id?(id)
@@ -157,7 +157,7 @@ module Wavefront
     #
     # @param id [String] ID of the event
     # @param tag [String] tag to set.
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_add(id, tag)
       wf_event_id?(id)

data/lib/wavefront-sdk/externallink.rb

@@ -9,6 +9,10 @@ module Wavefront
       '/extlink'
     end
 
+    def update_keys
+      %i(name template description)
+    end
+
     # GET /api/v2/extlink
     # Get all external links for a customer
     #
@@ -23,7 +27,7 @@ module Wavefront
     # Create a specific external link.
     #
     # @param body [Hash] a description of the external link.
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -34,7 +38,7 @@ module Wavefront
     # Delete a specific external link.
     #
     # @param id [String] ID of the link
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_link_id?(id)
@@ -45,7 +49,7 @@ module Wavefront
     # Get a specific external link.
     #
     # @param id [String] ID of the limnk
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id)
       wf_link_id?(id)
@@ -55,15 +59,22 @@ module Wavefront
     # PUT /api/v2/extlink/id
     # Update a specific external link.
     #
-    # @param id [String] ID of the link
-    # @param body [Hash] a key:value hash where the key is the
-    #   property to change and the value is its desired value
-    # @return [Hash]
-    #
-    def update(id, body)
+    # @param id [String] a Wavefront external link 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_link_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
-      api_put(id, body)
+
+      return api_put(id, body, 'application/json') unless modify
+
+      api_put(id, hash_for_update(describe(id).response, body),
+              'application/json')
     end
   end
 end

data/lib/wavefront-sdk/maintenancewindow.rb

@@ -5,6 +5,10 @@ module Wavefront
   # Manage and query Wavefront maintenance windows
   #
   class MaintenanceWindow < Base
+    def update_keys
+      %i(reason title startTimeInSeconds endTimeInSeconds
+         relevantCustomerTags relevantHostTags)
+    end
 
     # GET /api/v2/maintenancewindow
     # Get all maintenance windows for a customer.
@@ -24,7 +28,7 @@ module Wavefront
     # @param body [Hash] a hash of parameters describing the window.
     #   Please refer to the Wavefront Swagger docs for key:value
     #   information
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -35,7 +39,7 @@ module Wavefront
     # Delete a specific maintenance window.
     #
     # @param id [String, Integer] ID of the maintenance window
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_maintenance_window_id?(id)
@@ -46,7 +50,7 @@ module Wavefront
     # Get a specific maintenance window.
     #
     # @param id [String, Integer] ID of the maintenance window
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id)
       wf_maintenance_window_id?(id)
@@ -56,14 +60,22 @@ module Wavefront
     # PUT /api/v2/maintenancewindow/id
     # Update a specific maintenance window.
     #
-    # @param body [Hash] a hash of parameters describing the window.
-    # @return [Hash]
-    # @raise any validation errors from body
-    #
-    def update(id, body)
+    # @param id [String] a Wavefront maintenance window 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_maintenance_window_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
-      api_put(id, body)
+
+      return api_put(id, body, 'application/json') unless modify
+
+      api_put(id, hash_for_update(describe(id).response, body),
+              'application/json')
     end
   end
 end

data/lib/wavefront-sdk/proxy.rb

@@ -24,7 +24,7 @@ module Wavefront
     # in 'trash' removes it for ever.
     #
     # @param id [String] ID of the proxy
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_proxy_id?(id)
@@ -35,7 +35,7 @@ module Wavefront
     # Get a specific proxy
     #
     # @param id [String] ID of the proxy
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id)
       wf_proxy_id?(id)
@@ -48,7 +48,7 @@ module Wavefront
     # Move an proxy from 'trash' back into active service.
     #
     # @param id [String] ID of the proxy
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def undelete(id)
       wf_proxy_id?(id)
@@ -63,7 +63,7 @@ module Wavefront
     #
     # @param id [String] ID of the proxy
     # @param name [String] new name
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def rename(id, name)
       wf_proxy_id?(id)
@@ -79,7 +79,7 @@ module Wavefront
     # @param payload [Hash] a key: value hash, where the key is the
     #   property to change and the value is its desired value. No
     #   validation is performed on any part of the payload.
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def update(id, payload)
       wf_proxy_id?(id)

data/lib/wavefront-sdk/query.rb

@@ -26,7 +26,7 @@ module Wavefront
     #   May be a Ruby Time object, or epoch milliseconds.
     # @param options [Hash] any other options defined in the API
     # @raise [ArgumentError] if query is not a string
-    # @return [Wavefront::Response::Query]
+    # @return [Wavefront::Response]
     #
     def query(query, granularity = nil, t_start = nil, t_end = nil,
                options = {})
@@ -75,5 +75,16 @@ module Wavefront
 
       api_get('raw', options)
     end
+
+    # Fake a response which looks like we get from all the other
+    # paths. The default response is a single array.
+    #
+    def response_shim(body, status)
+      { response: JSON.parse(body),
+        status:   { result:  status == 200 ? 'OK' : 'ERROR',
+                    message: '',
+                    code:    status },
+      }.to_json
+    end
   end
 end

data/lib/wavefront-sdk/response.rb

@@ -31,7 +31,11 @@ module Wavefront
     #   has changed underneath us.
     #
     def initialize(json, status, debug = false)
-      raw = json.empty? {} || JSON.parse(json, symbolize_names: true)
+      begin
+        raw = json.empty? ? {} : JSON.parse(json, symbolize_names: true)
+      rescue
+        raw = { message: json, code: status }
+      end
 
       @status = build_status(raw, status)
       @response = build_response(raw)
@@ -47,7 +51,15 @@ module Wavefront
     end
 
     def build_response(raw)
-      Map(raw.is_a?(Hash) && raw.key?(:response) ? raw[:response] : {})
+      if raw.is_a?(Hash)
+        if raw.key?(:response)
+          Map(raw[:response])
+        else
+          Map.new
+        end
+      else
+        Map.new
+      end
     end
   end
 
@@ -75,9 +87,16 @@ module Wavefront
       def initialize(raw, status)
         obj = raw.key?(:status) ? raw[:status] : raw
 
-        @result = obj[:result] || nil
         @message = obj[:message] || nil
         @code = obj[:code] || status
+
+        @result = if obj[:result]
+                    obj[:result]
+                  elsif status == 200
+                    'OK'
+                  else
+                    'ERROR'
+                  end
       end
     end
   end

data/lib/wavefront-sdk/savedsearch.rb

@@ -12,7 +12,7 @@ module Wavefront
     #
     # @param offset [Int] saved search at which the list begins
     # @param limit [Int] the number of saved searches to return
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
       api_get('', { offset: offset, limit: limit })
@@ -23,7 +23,7 @@ module Wavefront
     # valid keys.
     #
     # @param body [Hash] description of saved search
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -34,7 +34,7 @@ module Wavefront
     # Delete a specific saved search.
     #
     # @param id [String] ID of the saved search
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_savedsearch_id?(id)
@@ -45,7 +45,7 @@ module Wavefront
     # Get a specific saved search.
     #
     # @param id [String] ID of the saved search
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id)
       wf_savedsearch_id?(id)
@@ -56,7 +56,7 @@ module Wavefront
     # Update a specific saved search.
     #
     # @param id [String] ID of the saved search
-    # @param body [Hash] description of saved search
+    # @param body [Wavefront::Response]
     #
     def update(id, body)
       wf_savedsearch_id?(id)
@@ -70,7 +70,7 @@ module Wavefront
     # @param entitytype [String] type of entity to retrieve
     # @param offset [Int] saved search at which the list begins
     # @param limit [Int] the number of saved searches to return
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def entity(entitytype, offset = 0, limit = 100)
       wf_savedsearch_entity?(entitytype)

data/lib/wavefront-sdk/source.rb

@@ -5,13 +5,16 @@ module Wavefront
   # View and manage source metadata.
   #
   class Source < Base
+    def update_keys
+      %i(sourceName tags description)
+    end
 
     # GET /api/v2/source
     # Get all sources for a customer
     #
     # @param offset [Int] source at which the list begins
     # @param limit [Int] the number of sources to return
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def list(offset = 0, limit = 100)
       api_get('', { offset: offset, limit: limit })
@@ -23,7 +26,7 @@ module Wavefront
     # Refer to the Swagger API docs for valid keys.
     #
     # @param body [Hash] description of source
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -34,7 +37,7 @@ module Wavefront
     # Delete metadata (description and tags) for a specific source.
     #
     # @param id [String] ID of the source
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_source_id?(id)
@@ -45,7 +48,7 @@ module Wavefront
     # Get a specific source for a customer.
     #
     # @param id [String] ID of the source
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id, version = nil)
       wf_source_id?(id)
@@ -58,23 +61,29 @@ module Wavefront
     # PUT /api/v2/source/id
     # Update metadata (description or tags) for a specific source.
     #
-    # Refer to the Swagger API docs for valid keys.
-    #
-    # @param body [Hash] description of source
-    # @return [Hash]
-    #
-    def update(id, body)
+    # @param id [String] a Wavefront alert 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_source_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
-      api_put(id, body)
+
+      return api_put(id, body, 'application/json') unless modify
+
+      api_put(id, hash_for_update(describe(id).response, body),
+              'application/json')
     end
 
     # GET /api/v2/source/id/tag
     # Get all tags associated with a specific source.
     #
     # @param id [String] ID of the source
-    # @return [Hash] object describing the source with status and
-    #   response keys
+    # @return [Wavefront::Response]
     #
     def tags(id)
       wf_source_id?(id)
@@ -86,8 +95,7 @@ module Wavefront
     #
     # @param id [String] ID of the source
     # @param tags [Array] list of tags to set.
-    # @return [Hash] object describing the source with status and
-    #   response keys
+    # @return [Wavefront::Response]
     #
     def tag_set(id, tags)
       wf_source_id?(id)
@@ -101,7 +109,7 @@ module Wavefront
     #
     # @param id [String] ID of the source
     # @param tag [String] tag to delete
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_delete(id, tag)
       wf_source_id?(id)
@@ -114,7 +122,7 @@ module Wavefront
     #
     # @param id [String] ID of the source
     # @param tag [String] tag to set.
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_add(id, tag)
       wf_source_id?(id)

data/lib/wavefront-sdk/user.rb

@@ -19,7 +19,7 @@ module Wavefront
     # @param body [Hash] a hash of parameters describing the user.
     #   Please refer to the Wavefront Swagger docs for key:value
     #   information
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body, send_email = false)
       raise ArgumentError unless body.is_a?(Hash)
@@ -30,7 +30,7 @@ module Wavefront
     # Delete a specific user.
     #
     # @param id [String] ID of the user
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_user_id?(id)
@@ -41,7 +41,7 @@ module Wavefront
     # Retrieves a user by identifier (email addr).
     #
     # @param id [String] ID of the user
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id)
       wf_user_id?(id)
@@ -59,7 +59,7 @@ module Wavefront
     #   embedded_charts, events_management,
     #   external_links_management, host_tag_management,
     #   metrics_management, user_management,
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def grant(id, group)
       wf_user_id?(id)
@@ -75,7 +75,7 @@ module Wavefront
     # @param group [String] group to add user to. We do not validate
     #   this so that changes to the API do not mandate changes to
     #   the SDK. See #update for valid values.
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def revoke(id, group)
       wf_user_id?(id)

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '0.1.3'.freeze
+WF_SDK_VERSION = '0.1.5'.freeze

data/lib/wavefront-sdk/webhook.rb

@@ -5,6 +5,9 @@ module Wavefront
   # Manage and query Wavefront webhooks
   #
   class Webhook < Base
+    def update_keys
+      %i(title description template title triggers recipient)
+    end
 
     # GET /api/v2/webhook
     # Get all webhooks for a customer.
@@ -22,7 +25,7 @@ module Wavefront
     # @param body [Hash] a hash of parameters describing the webhook.
     #   Please refer to the Wavefront Swagger docs for key:value
     #   information
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -33,7 +36,7 @@ module Wavefront
     # Delete a specific webhook.
     #
     # @param id [String, Integer] ID of the webhook
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_webhook_id?(id)
@@ -44,7 +47,7 @@ module Wavefront
     # Get a specific webhook.
     #
     # @param id [String, Integer] ID of the webhook
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id)
       wf_webhook_id?(id)
@@ -54,14 +57,22 @@ module Wavefront
     # PUT /api/v2/webhook/id
     # Update a specific webhook.
     #
-    # @param body [Hash] a hash of parameters describing the webhook.
-    # @return [Hash]
-    # @raise any validation errors from body
-    #
-    def update(id, body)
+    # @param id [String] a Wavefront webhook 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_webhook_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
-      api_put(id, body)
+
+      return api_put(id, body, 'application/json') unless modify
+
+      api_put(id, hash_for_update(describe(id).response, body),
+              'application/json')
     end
   end
 end

data/lib/wavefront-sdk/write.rb

@@ -211,25 +211,4 @@ module Wavefront
       @net = creds
     end
   end
-
-  #class Response
-    # The Write response forges status and response methods to look
-    # like other classes and create a more consistent interface. As
-    # the request does not happen over HTTP, there's not much to put
-    # in the status object. The response object is the contents of
-    # the summary variable.
-    #
-    # @response=#<struct  sent=1, rejected=0, unsent=0>,
-    # @status=#<struct  result="OK", message=nil, code=nil>>
-    #
-    #class Write < Base
-      #def populate(raw, status)
-        #@response = Struct.new(*raw.keys).new(*raw.values).freeze
-#
-        #ok = raw[:rejected] == 0 && raw[:unsent] == 0 ? 'OK' : 'ERROR'
-#
-        #@status = Struct.new(:result, :message, :code).new(ok, nil, nil)
-      #end
-    #end
-  #end
 end

data/spec/wavefront-sdk/dashboard_spec.rb

@@ -56,8 +56,9 @@ class WavefrontDashboardTest < WavefrontTestBase
   end
 
   def test_update
-    should_work(:update, [DASHBOARD, DASHBOARD_BODY], DASHBOARD, :put,
-                JSON_POST_HEADERS, DASHBOARD_BODY.to_json)
+    should_work(:update, [DASHBOARD, DASHBOARD_BODY, false],
+                DASHBOARD, :put, JSON_POST_HEADERS,
+                DASHBOARD_BODY.to_json)
     should_be_invalid(:update, ['!invalid dash!', DASHBOARD_BODY])
     assert_raises(ArgumentError) { wf.update }
   end

data/spec/wavefront-sdk/externallink_spec.rb

@@ -50,11 +50,11 @@ class WavefrontExternalLinkTest < WavefrontTestBase
   end
 
   def test_update
-    should_work(:update, [EXTERNAL_LINK, EXTERNAL_LINK_BODY],
+    should_work(:update, [EXTERNAL_LINK, EXTERNAL_LINK_BODY, false],
                 EXTERNAL_LINK, :put, JSON_POST_HEADERS,
                 EXTERNAL_LINK_BODY.to_json)
 
-    should_work(:update, [EXTERNAL_LINK, EXTERNAL_LINK_BODY_2],
+    should_work(:update, [EXTERNAL_LINK, EXTERNAL_LINK_BODY_2, false],
                 EXTERNAL_LINK, :put, JSON_POST_HEADERS,
                 EXTERNAL_LINK_BODY_2.to_json)
 

data/spec/wavefront-sdk/maintenancewindow_spec.rb

@@ -40,7 +40,7 @@ class WavefrontMaintenanceWindowTest < WavefrontTestBase
   end
 
   def test_update
-    should_work(:update, [WINDOW, WINDOW_BODY], WINDOW, :put,
+    should_work(:update, [WINDOW, WINDOW_BODY, false], WINDOW, :put,
                 JSON_POST_HEADERS, WINDOW_BODY.to_json)
     should_be_invalid(:update, ['abcde', WINDOW_BODY])
     assert_raises(ArgumentError) { wf.update }

data/spec/wavefront-sdk/response_spec.rb

@@ -25,23 +25,5 @@ class WavefrontResponseTest < MiniTest::Test
   end
 
   def test_initialize_bad_data
-    assert_raises(Wavefront::Exception::UnparseableResponse) do
-      Wavefront::Response.new('merp', 200)
-    end
-
-    assert_raises(Wavefront::Exception::UnparseableResponse) do
-      Wavefront::Response.new(
-        '{"status":{"result":"OK","message":"","code":200}', 200)
-    end
-
-    assert_raises(Wavefront::Exception::UnparseableResponse) do
-      Wavefront::Response.new(
-        '{"status":{"result":"OK","message":"","code":200}', 200)
-    end
-
-    assert_raises(Wavefront::Exception::UnparseableResponse) do
-      Wavefront::Response.new(
-        '{"response":{"items":[{"name":"test agent"}],"offset":0 }', 200)
-    end
   end
 end

data/spec/wavefront-sdk/source_spec.rb

@@ -36,7 +36,7 @@ class WavefrontSourceTest < WavefrontTestBase
   end
 
   def test_update
-    should_work(:update, [SOURCE, SOURCE_BODY], SOURCE, :put,
+    should_work(:update, [SOURCE, SOURCE_BODY, false], SOURCE, :put,
                 JSON_POST_HEADERS, SOURCE_BODY.to_json)
     should_be_invalid(:update, ['!invalid source!', SOURCE_BODY])
     assert_raises(ArgumentError) { wf.update }

data/spec/wavefront-sdk/webhook_spec.rb

@@ -42,7 +42,7 @@ class WavefrontWebhookTest < WavefrontTestBase
   end
 
   def test_update
-    should_work(:update, [WEBHOOK, WEBHOOK_BODY], WEBHOOK, :put,
+    should_work(:update, [WEBHOOK, WEBHOOK_BODY, false], WEBHOOK, :put,
                 JSON_POST_HEADERS, WEBHOOK_BODY.to_json)
     should_be_invalid(:update, ['abcde', WEBHOOK_BODY])
     assert_raises(ArgumentError) { wf.update }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday