wavefront-sdk 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e691fa7a8a4399a0bec4938c1804927089df29e
-  data.tar.gz: 5712e629146f8463aea82acf768ea9cc3a6ba6b2
+  metadata.gz: f37a97bd03c5522bb5dbbfcb25e13645ae724d60
+  data.tar.gz: 1649e2709f06702ef3dc459157dfbe67c920eb01
 SHA512:
-  metadata.gz: 72cd570ae62c6bd38e745f089a4abfad246869344fadd736dcf8cbafda61c3315747245c894bdf5b66af68087561be5eeb5f48323b228943c0fc7595d8350077
-  data.tar.gz: 063d3295757ccbff34a9dc1591e87f7bba2c0640344734810a1b76794121180e5c00e5e523495376255b3e9d805678bd80c3169cf950ded706b0088f9b78b3c5
+  metadata.gz: 9af27034b0984bbb7f3eb02d5ef254c8a57a497bddc6dc8d6585795b8c49e8009dfce6839cb9b6c45baf6d9ba113bed2b895d047aef3bca45065ae62375464ab
+  data.tar.gz: 6189ac5bc2267c07050940ce83ca5f77c89a0c6ce20f6476d0dbe2817f84223c17b8a8e4d89fae35dc0106bef39025417dd3700953b8637c7265d8f93ddbf7bf

data/Gemfile.lock

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

data/README.md

@@ -15,7 +15,7 @@ $ gem install wavefront-sdk
 
 or to build locally,
 
-
+```
 $ gem build wavefront-sdk.gemspec
 ```
 
@@ -27,16 +27,16 @@ rubydoc.info](http://www.rubydoc.info/gems/wavefront-sdk/).
 
 ## Examples
 
-First, let's list the IDs of the users in our account. The `list()` method
-will return a `Wavefront::Response` object. This object has
-`status` and `response` methods. `status` always yields a
-structure containing `result`, `message` and `code` fields which can
-be inspected to ensure an API call was processed successfully.
+First, let's list the IDs of the users in our account. The `list()`
+method will return a `Wavefront::Response` object. This object has
+`status` and `response` methods. `status` always yields a structure
+containing `result`, `message` and `code` fields which can be
+inspected to ensure an API call was processed successfully.
 `response` gives you a the JSON response from the API, conveniently
-processed and turned into a
-[`Map`](https://github.com/ahoward/map) object. Map objects can be
-interrogated in various ways. For instance `map['items']`,
-`map[:items]` and `map.items` will all get you to the same place.
+processed and turned into a [`Map`](https://github.com/ahoward/map)
+object. Map objects can be interrogated in various ways. For
+instance `map['items']`, `map[:items]` and `map.items` will all get
+you to the same place.
 
 
 ```ruby

data/lib/wavefront-sdk/alert.rb

@@ -6,6 +6,10 @@ module Wavefront
   # epoch timestamp. Returns a Wavefront::Response::Alert object.
   #
   class Alert < Base
+    def update_keys
+      %i(id name target condition displayExpression minutes
+         resolveAfterMinutes severity additionalInformation)
+    end
 
     # GET /api/v2/alert
     # Get all alerts for a customer
@@ -24,7 +28,7 @@ module Wavefront
     # generic POST of a hash.
     #
     # @param body [Hash] description of alert
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def create(body)
       raise ArgumentError unless body.is_a?(Hash)
@@ -39,7 +43,7 @@ module Wavefront
     # 'trash' removes it for ever.
     #
     # @param id [String] ID of the alert
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def delete(id)
       wf_alert_id?(id)
@@ -53,7 +57,7 @@ module Wavefront
     #
     # @param id [String] ID of the alert
     # @param version [Integer] version of alert
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def describe(id, version = nil)
       wf_alert_id?(id)
@@ -67,24 +71,36 @@ module Wavefront
     # Update a specific alert.
     #
     # @param id [String] a Wavefront alert ID
-    # @param body [Hash] description of event. See body_desc()
-    # @return [Hash]
-    #
-    def update(id, body)
+    # @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_alert_id?(id)
       raise ArgumentError unless body.is_a?(Hash)
-      api_put(id, body, 'application/json')
+
+      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/alert/id/history
     # Get the version history of a specific alert.
     #
     # @param id [String] ID of the alert
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
-    def history(id)
+    def history(id, offset = nil, limit = nil)
       wf_alert_id?(id)
-      api_get([id, 'history'].uri_concat)
+      qs = {}
+      qs[:offset] = offset if offset
+      qs[:limit] = limit if limit
+
+      api_get([id, 'history'].uri_concat, qs)
     end
 
     # POST /api/v2/alert/id/snooze
@@ -92,9 +108,8 @@ module Wavefront
     #
     # @param id [String] ID of the alert
     # @param seconds [Integer] how many seconds to snooze for.
-    #   Nil is indefinite
-    # @return [Hash] object describing the alert with status and
-    #   response keys
+    #   Nil is indefinite.
+    # @return [Wavefront::Response]
     #
     def snooze(id, seconds = nil)
       wf_alert_id?(id)
@@ -106,8 +121,7 @@ module Wavefront
     # Get all tags associated with a specific alert.
     #
     # @param id [String] ID of the alert
-    # @return [Hash] object describing the alert with status and
-    #   response keys
+    # @return [Wavefront::Response]
     #
     def tags(id)
       wf_alert_id?(id)
@@ -119,8 +133,7 @@ module Wavefront
     #
     # @param id [String] ID of the alert
     # @param tags [Array] list of tags to set.
-    # @return [Hash] object describing the alert with status and
-    #   response keys
+    # @return [Wavefront::Response]
     #
     def tag_set(id, tags)
       wf_alert_id?(id)
@@ -134,7 +147,7 @@ module Wavefront
     #
     # @param id [String] ID of the alert
     # @param tag [String] tag to delete
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_delete(id, tag)
       wf_alert_id?(id)
@@ -147,7 +160,7 @@ module Wavefront
     #
     # @param id [String] ID of the alert
     # @param tag [String] tag to set.
-    # @return [Hash] object with 'status' key and empty 'repsonse'
+    # @return [Wavefront::Response]
     #
     def tag_add(id, tag)
       wf_alert_id?(id)
@@ -159,7 +172,7 @@ module Wavefront
     # Undelete a specific alert.
     #
     # @param id [String] ID of the alert
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def undelete(id)
       wf_alert_id?(id)
@@ -170,8 +183,7 @@ module Wavefront
     # Unsnooze a specific alert.
     #
     # @param id [String] ID of the alert
-    # @return [Hash] object describing the alert with status and
-    #   response keys
+    # @return [Wavefront::Response]
     #
     def unsnooze(id)
       wf_alert_id?(id)
@@ -181,7 +193,7 @@ module Wavefront
     # GET /api/v2/alert/summary
     # Count alerts of various statuses for a customer
     #
-    # @return [Hash]
+    # @return [Wavefront::Response]
     #
     def summary
       api_get('summary')

data/lib/wavefront-sdk/event.rb

@@ -6,7 +6,9 @@ module Wavefront
   # epoch timestamp.
   #
   class Event < Base
-    @update_keys = [:startTime, :endTime, :name, :annotations]
+    def update_keys
+      %i(startTime endTime name annotations)
+    end
 
     # GET /api/v2/event
     # List all the events for a customer within a time range.

data/lib/wavefront-sdk/response.rb

@@ -47,7 +47,7 @@ module Wavefront
     end
 
     def build_response(raw)
-      Map(raw.is_a?(Hash) && raw.key?(:response) ? raw[:response] : raw)
+      Map(raw.is_a?(Hash) && raw.key?(:response) ? raw[:response] : {})
     end
   end
 

data/lib/wavefront-sdk/version.rb

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

data/spec/wavefront-sdk/alert_spec.rb

@@ -55,8 +55,8 @@ class WavefrontAlertTest < WavefrontTestBase
   end
 
   def test_update
-    should_work(:update, [ALERT, ALERT_BODY], ALERT, :put,
-                JSON_POST_HEADERS, ALERT_BODY.to_json)
+    should_work(:update, [ALERT, ALERT_BODY, false], ALERT, :put,
+                JSON_POST_HEADERS, ALERT_BODY)
     should_be_invalid(:update, ['abcde', ALERT_BODY])
     assert_raises(ArgumentError) { wf.update }
   end

data/spec/wavefront-sdk/event_spec.rb

@@ -67,8 +67,8 @@ class WavefrontEventTest < WavefrontTestBase
   def test_update
     should_work(:update, [EVENT, EVENT_BODY, false], EVENT, :put,
                 JSON_POST_HEADERS, EVENT_BODY.to_json)
-    #should_be_invalid(:update, ['abcde', EVENT_BODY])
-    #assert_raises(ArgumentError) { wf.update }
+    should_be_invalid(:update, ['abcde', EVENT_BODY])
+    assert_raises(ArgumentError) { wf.update }
   end
 
   def test_delete

metadata

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