dogtrainer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d400dbf30520efe26fd2c8e35423766df31d70
-  data.tar.gz: c49711ca30824470040e34c5010be7a2afee19d9
+  metadata.gz: 61ad47a205486a220109a1e79127f4c7e5d13724
+  data.tar.gz: 054eb39e28f43c41599d64840813da35d78210b3
 SHA512:
-  metadata.gz: c0bb25a6a3c4119e67338aacdcdeb700b9ad2f4cce57152290f6f1b877af203c2b8e20fbcec1751deb84011df2dad4ebecea88d66b85a57479c4d70a604e4287
-  data.tar.gz: ccd27b826a7ed42ee86c30882101c5e5515327196842b5c2b1a7aa98f00063870888c89236eb3f90275258c1c13a122567174b2c24bb61dafa0ba45d5702e808
+  metadata.gz: 81048ff88866c2439e90d0ff18d46ece9480a73c8b8358a4b975f4b59c38bf6415c9018502b82092ad240c8dc2dbd7a12f38afdda251098287b81a68f12fb84a
+  data.tar.gz: 0cd934673286968e9657102fc9f11c156e4ad8817e3d86ec4c2881601a43e0cbdebb135ebee3c7aeed6ec790abd4442e9795805a277583bdd04e5f6a205e0fd4

data/.rubocop.yml

@@ -25,3 +25,6 @@ Style/AccessorMethodName:
 Style/PreferredHashMethods:
   Exclude:
     - 'lib/dogtrainer/api.rb'
+
+Metrics/BlockLength:
+  Max: 2000

data/ChangeLog.md

@@ -1,3 +1,12 @@
+Version 0.3.0
+
+  - Added ``DogTrainer::DogApiException`` custom exception class, subclass of ``StandardError``.
+  - ``DogTrainer::API`` methods ``mute_monitor_by_id``, ``mute_monitor_by_name``,
+    ``mute_monitors_by_regex``, ``unmute_monitor_by_id``, ``unmute_monitor_by_name``,
+    ``unmute_monitors_by_regex``, ``upsert_timeboard`` and ``upsert_screenboard``
+    now raise an ``DogTrainer::DogApiException`` if the Datadog API response status
+    code indicates an error.
+
 Version 0.2.0
 
   - add support to mute and unmute monitors by id, name or regex

data/README.md

@@ -4,9 +4,9 @@ Build of master branch: [![CircleCI](https://circleci.com/gh/manheim/dogtrainer.
 
 Documentation: [http://www.rubydoc.info/gems/dogtrainer/](http://www.rubydoc.info/gems/dogtrainer/)
 
-Wrapper around DataDog dogapi gem to simplify creation and management of Monitors and Boards.
+Wrapper around Datadog dogapi gem to simplify creation and management of Monitors and Boards.
 
-This class provides methods to manage (upsert / ensure the existence and configuration of) DataDog
+This class provides methods to manage (upsert / ensure the existence and configuration of) Datadog
 Monitors and TimeBoards/ScreenBoards.
 
 ## Installation
@@ -30,7 +30,7 @@ gem.add_runtime_dependency 'dogtrainer'
 
 ## Usage
 
-To use the DataDog helper, require the module and create an instance of the class,
+To use the Datadog helper, require the module and create an instance of the class,
 passing it the required configuration information.
 
 ```ruby
@@ -47,13 +47,13 @@ require 'dogtrainer'
 dog = DogTrainer::API.new(api_key, app_key, notify_to, 'string describing where to update monitors or boards')
 ```
 
-* __api_key__ is your DataDog API Key, which you can find at https://app.datadoghq.com/account/settings#api
+* __api_key__ is your Datadog API Key, which you can find at https://app.datadoghq.com/account/settings#api
 * __app_key__ is an application-specific key, which should be generated separately for every app or
   service that uses this class. These can be generated and seen at https://app.datadoghq.com/account/settings#api
-* __notify_to__ is the string specifying DataDog monitor recipients in "@" form. If you are only managing Timeboards or
+* __notify_to__ is the string specifying Datadog monitor recipients in "@" form. If you are only managing Timeboards or
   Screenboards (not Monitors), this can be ``nil``.
 * __repo_path__ is a string that will be included in all Monitor notification messages and TimeBoard/ScreenBoard descriptions,
-  telling users where to find the code that created the DataDog resource. This is intended to alert users to code-managed
+  telling users where to find the code that created the Datadog resource. This is intended to alert users to code-managed
   items that shouldn't be manually changed. If this parameter is not specified, it will be obtained from the first usable
   and present value of: the ``GIT_URL`` environment variable, the ``CIRCLE_REPOSITORY_URL`` or the first remote URL found
   by running ``git config --local -l`` in the directory that contains the code calling this constructor.
@@ -243,12 +243,12 @@ graphs = [
       "max:aws.elb.latency{host:#{elb_name}}"
     ]
   ),
-  # Instance CPU Utilization from DataDog/EC2 integration
+  # Instance CPU Utilization from Datadog/EC2 integration
   dog.graphdef(
     "Instance EC2 CPU Utilization",
     "avg:aws.ec2.cpuutilization{name:#{instance_name}}"
   ),
-  # Instance Free Memory from DataDog Agent on instance
+  # Instance Free Memory from Datadog Agent on instance
   dog.graphdef(
     "Instance Free Memory",
     "avg:system.mem.free{name:#{instance_name}}"

data/lib/dogtrainer/api.rb

@@ -1,6 +1,7 @@
 require 'dogapi'
 require 'dogapi/v1'
 require 'dogtrainer/logging'
+require 'dogtrainer/dogapiexception'
 
 module DogTrainer
   # Helper methods to upsert/ensure existence and configuration of DataDog
@@ -36,6 +37,20 @@ module DogTrainer
       end
     end
 
+    # Check the result of a Dogapi::Client call.
+    #
+    # Dogapi::Client returns responses as arrays, with the first element being
+    # the HTTP response code and the second element being the actual response.
+    #
+    # Check the specified
+    #
+    # @param r [Array] the Dogapi result/response
+    # @param accepted_codes [Array] Array of acceptable (success) HTTP codes
+    # @raise [DogApiException] if the response code indicates an error
+    def check_dog_result(r, accepted_codes = ['200'])
+      raise DogApiException, r unless accepted_codes.include?(r[0])
+    end
+
     # Return a human-usable string identifying where to make changes to the
     # resources created by this class. Returns the first of:
     #
@@ -195,8 +210,10 @@ module DogTrainer
           'no_data_timeframe' => 20
         }
       }
-      monitor_data['options']['escalation_message'] = \
-        options[:escalation_message] unless options[:escalation_message].nil?
+      unless options[:escalation_message].nil?
+        monitor_data['options']['escalation_message'] = \
+          options[:escalation_message]
+      end
       monitor_data
     end
 
@@ -303,7 +320,7 @@ module DogTrainer
 
     # Create a monitor that doesn't already exist; return its id
     #
-    # @param mon_name [String] mane of the monitor to create
+    # @param _mon_name [String] mane of the monitor to create
     # @param mon_params [Hash] params to pass to the DataDog API call. Must
     #   include "type" and "query" keys.
     def create_monitor(_mon_name, mon_params)
@@ -356,14 +373,15 @@ module DogTrainer
     # @param [Hash] options
     # @option options [Integer] :end_timestamp optional timestamp
     #  for when the mute should end; Integer POSIX timestamp.
+    # @raise [DogApiException] if the Datadog API returns an error
     def mute_monitor_by_id(mon_id, options = { end_timestamp: nil })
       if options.fetch(:end_timestamp, nil).nil?
         logger.info "Muting monitor by ID #{mon_id}"
-        @dog.mute_monitor(mon_id)
+        check_dog_result(@dog.mute_monitor(mon_id))
       else
         end_ts = options[:end_timestamp]
         logger.info "Muting monitor by ID #{mon_id} until #{end_ts}"
-        @dog.mute_monitor(mon_id, end: end_ts)
+        check_dog_result(@dog.mute_monitor(mon_id, end: end_ts))
       end
     end
 
@@ -383,17 +401,18 @@ module DogTrainer
     # @option options [Integer] :end_timestamp optional timestamp
     #  for when the mute should end; Integer POSIX timestamp.
     # @raise [RuntimeError] raised if the specified monitor name can't be found
+    # @raise [DogApiException] if the Datadog API returns an error
     def mute_monitor_by_name(mon_name, options = { end_timestamp: nil })
       mon = get_existing_monitor_by_name(mon_name)
       raise "ERROR: Could not find monitor with name #{mon_name}" if mon.nil?
       if options.fetch(:end_timestamp, nil).nil?
         logger.info "Muting monitor by name #{mon_name} (#{mon['id']})"
-        @dog.mute_monitor(mon['id'])
+        check_dog_result(@dog.mute_monitor(mon['id']))
       else
         end_ts = options[:end_timestamp]
         logger.info "Muting monitor by name #{mon_name} (#{mon['id']}) " \
           "until #{end_ts}"
-        @dog.mute_monitor(mon['id'], end: end_ts)
+        check_dog_result(@dog.mute_monitor(mon['id'], end: end_ts))
       end
     end
 
@@ -442,9 +461,10 @@ module DogTrainer
     # Unute the monitor identified by the specified unique ID.
     #
     # @param mon_id [Integer] ID of the monitor to mute
+    # @raise [DogApiException] if the Datadog API returns an error
     def unmute_monitor_by_id(mon_id)
       logger.info "Unmuting monitor by ID #{mon_id}"
-      @dog.unmute_monitor(mon_id, all_scopes: true)
+      check_dog_result(@dog.unmute_monitor(mon_id, all_scopes: true))
     end
 
     # Unmute the monitor identified by the specified name.
@@ -522,12 +542,14 @@ module DogTrainer
     #
     # @param dash_name [String] Account-unique dashboard name
     # @param graphs [Array] Array of graphdefs to add to dashboard
+    # @raise [DogApiException] if the Datadog API returns an error
     def upsert_timeboard(dash_name, graphs)
       logger.info "Upserting timeboard: #{dash_name}"
       desc = "created by DogTrainer RubyGem via #{@repo_path}"
       dash = get_existing_timeboard_by_name(dash_name)
       if dash.nil?
         d = @dog.create_dashboard(dash_name, desc, graphs)
+        check_dog_result(d)
         logger.info "Created timeboard #{d[1]['dash']['id']}"
         return
       end
@@ -548,9 +570,10 @@ module DogTrainer
 
       if needs_update
         logger.info "\tUpdating timeboard #{dash['dash']['id']}"
-        @dog.update_dashboard(
+        d = @dog.update_dashboard(
           dash['dash']['id'], dash_name, desc, graphs
         )
+        check_dog_result(d)
         logger.info "\tTimeboard updated."
       else
         logger.info "\tTimeboard is up-to-date"
@@ -566,6 +589,7 @@ module DogTrainer
     # @param widgets [Array] Array of Hash widget definitions to pass to
     #   the DataDog API. For further information, see:
     #   http://docs.datadoghq.com/api/screenboards/
+    # @raise [DogApiException] if the Datadog API returns an error
     def upsert_screenboard(dash_name, widgets)
       logger.info "Upserting screenboard: #{dash_name}"
       desc = "created by DogTrainer RubyGem via #{@repo_path}"
@@ -574,6 +598,7 @@ module DogTrainer
         d = @dog.create_screenboard(board_title: dash_name,
                                     description: desc,
                                     widgets: widgets)
+        check_dog_result(d)
         logger.info "Created screenboard #{d[1]['id']}"
         return
       end
@@ -594,9 +619,10 @@ module DogTrainer
 
       if needs_update
         logger.info "\tUpdating screenboard #{dash['id']}"
-        @dog.update_screenboard(dash['id'], board_title: dash_name,
-                                            description: desc,
-                                            widgets: widgets)
+        d = @dog.update_screenboard(dash['id'], board_title: dash_name,
+                                                description: desc,
+                                                widgets: widgets)
+        check_dog_result(d)
         logger.info "\tScreenboard updated."
       else
         logger.info "\tScreenboard is up-to-date"

data/lib/dogtrainer/dogapiexception.rb

@@ -0,0 +1,26 @@
+module DogTrainer
+  # Exception raised for Datadog API errors (non-200 status code)
+  class DogApiException < StandardError
+    attr_reader :statuscode
+    attr_reader :content
+
+    def initialize(response)
+      @statuscode = response[0]
+      @content = if response.length > 1
+                   response[1]
+                 else
+                   {}
+                 end
+      msg = "Datadog API call returned status #{@statuscode}"
+      if @content.include?('errors')
+        msg << ":\n"
+        if @content['errors'].is_a?(Array)
+          @content['errors'].each { |e| msg << "#{e}\n" }
+        else
+          msg << "#{content['errors']}\n"
+        end
+      end
+      super(msg)
+    end
+  end
+end

data/lib/dogtrainer/version.rb

@@ -1,4 +1,4 @@
 module DogTrainer
   # store the verson of the Gem/module; used in the gemspec and in messages
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/spec/unit/api_spec.rb

@@ -60,6 +60,39 @@ describe DogTrainer::API do
       expect(x.instance_variable_get('@repo_path')).to eq('foo/bar')
     end
   end
+  describe '#check_dog_result' do
+    let(:response) { { 'foo' => 'bar' } }
+    context 'with default accepted_codes' do
+      describe 'when code is in accepted array' do
+        it 'does not raise an exception' do
+          expect { subject.check_dog_result(['200', response]) }
+            .to_not raise_error
+        end
+      end
+      describe 'when code is not in accepted array' do
+        it 'raises an exception' do
+          expect { subject.check_dog_result(['400', response]) }
+            .to raise_error DogTrainer::DogApiException,
+                            /Datadog API call returned status 400/
+        end
+      end
+    end
+    context 'with custom accepted_codes' do
+      describe 'when code is in accepted array' do
+        it 'does not raise an exception' do
+          expect { subject.check_dog_result(['404', response], %w(200 404)) }
+            .to_not raise_error
+        end
+      end
+      describe 'when code is not in accepted array' do
+        it 'raises an exception' do
+          expect { subject.check_dog_result(['400', response], %w(200 404)) }
+            .to raise_error DogTrainer::DogApiException,
+                            /Datadog API call returned status 400/
+        end
+      end
+    end
+  end
   describe '#get_repo_path' do
     it 'calls #get_git_url_for_directory if ENV vars are not set' do
       allow(ENV).to receive(:has_key?).with('GIT_URL').and_return(false)
@@ -1000,19 +1033,25 @@ describe DogTrainer::API do
   describe '#mute_monitor_by_id' do
     it 'calls dog.mute_monitor with id' do
       dog = double(Dogapi::Client)
-      allow(dog).to receive(:mute_monitor).with(any_args)
+      resp = double
+      allow(dog).to receive(:mute_monitor).with(any_args).and_return(resp)
+      allow(subject).to receive(:check_dog_result)
       subject.instance_variable_set('@dog', dog)
 
       expect(dog).to receive(:mute_monitor).once.with(12_345)
+      expect(subject).to receive(:check_dog_result).once.with(resp)
       subject.mute_monitor_by_id(12_345)
     end
     it 'calls dog.mute_monitor with id and timestamp if specified' do
       dog = double(Dogapi::Client)
-      allow(dog).to receive(:mute_monitor).with(any_args)
+      resp = double
+      allow(dog).to receive(:mute_monitor).with(any_args).and_return(resp)
+      allow(subject).to receive(:check_dog_result)
       subject.instance_variable_set('@dog', dog)
 
       expect(dog).to receive(:mute_monitor).once
         .with(12_345, end: 6_789)
+      expect(subject).to receive(:check_dog_result).once.with(resp)
       subject.mute_monitor_by_id(12_345, end_timestamp: 6_789)
     end
   end
@@ -1020,39 +1059,48 @@ describe DogTrainer::API do
     it 'calls dog.mute_monitor with id' do
       monitor = { 'id' => 5_678 }
       dog = double(Dogapi::Client)
-      allow(dog).to receive(:mute_monitor).with(any_args)
+      resp = double
+      allow(dog).to receive(:mute_monitor).with(any_args).and_return(resp)
       allow(subject).to receive(:get_existing_monitor_by_name)
         .and_return(monitor)
+      allow(subject).to receive(:check_dog_result)
       subject.instance_variable_set('@dog', dog)
 
       expect(subject).to receive(:get_existing_monitor_by_name).once
         .with('mymon')
       expect(dog).to receive(:mute_monitor).once.with(5_678)
+      expect(subject).to receive(:check_dog_result).once.with(resp)
       subject.mute_monitor_by_name('mymon')
     end
     it 'calls dog.mute_monitor with id and timestamp if specified' do
       monitor = { 'id' => 5_678 }
       dog = double(Dogapi::Client)
-      allow(dog).to receive(:mute_monitor).with(any_args)
+      resp = double
+      allow(dog).to receive(:mute_monitor).with(any_args).and_return(resp)
       allow(subject).to receive(:get_existing_monitor_by_name)
         .and_return(monitor)
+      allow(subject).to receive(:check_dog_result)
       subject.instance_variable_set('@dog', dog)
 
       expect(subject).to receive(:get_existing_monitor_by_name).once
         .with('mymon')
       expect(dog).to receive(:mute_monitor).once.with(5_678, end: 1_234)
+      expect(subject).to receive(:check_dog_result).once.with(resp)
       subject.mute_monitor_by_name('mymon', end_timestamp: 1_234)
     end
     it 'raises error if monitor cannot be found' do
       dog = double(Dogapi::Client)
-      allow(dog).to receive(:mute_monitor).with(any_args)
+      resp = double
+      allow(dog).to receive(:mute_monitor).with(any_args).and_return(resp)
       allow(subject).to receive(:get_existing_monitor_by_name)
         .and_return(nil)
+      allow(subject).to receive(:check_dog_result)
       subject.instance_variable_set('@dog', dog)
 
       expect(subject).to receive(:get_existing_monitor_by_name).once
         .with('mymon')
       expect(dog).to_not receive(:mute_monitor)
+      expect(subject).to_not receive(:check_dog_result)
       expect { subject.mute_monitor_by_name('mymon') }
         .to raise_error(RuntimeError,
                         'ERROR: Could not find monitor with name mymon')
@@ -1126,11 +1174,14 @@ describe DogTrainer::API do
   describe '#unmute_monitor_by_id' do
     it 'calls dog.unmute_monitor with id' do
       dog = double(Dogapi::Client)
-      allow(dog).to receive(:unmute_monitor).with(any_args)
+      resp = double
+      allow(dog).to receive(:unmute_monitor).with(any_args).and_return(resp)
+      allow(subject).to receive(:check_dog_result)
       subject.instance_variable_set('@dog', dog)
 
       expect(dog).to receive(:unmute_monitor).once
         .with(12_345, all_scopes: true)
+      expect(subject).to receive(:check_dog_result).once.with(resp)
       subject.unmute_monitor_by_id(12_345)
     end
   end
@@ -1326,6 +1377,7 @@ describe DogTrainer::API do
       allow(subject).to receive(:get_existing_timeboard_by_name).with(any_args)
         .and_return(nil)
       allow(subject.logger).to receive(:info).with(any_args)
+      allow(subject).to receive(:check_dog_result)
 
       expect(subject).to receive(:get_existing_timeboard_by_name).once
         .with('t')
@@ -1337,6 +1389,7 @@ describe DogTrainer::API do
         )
       expect(dog).to_not receive(:update_dashboard)
       expect(subject.logger).to receive(:info).with('Created timeboard id1')
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_timeboard('t', [1, 2])
     end
     it 'does not update if params are current' do
@@ -1359,12 +1412,14 @@ describe DogTrainer::API do
       allow(subject).to receive(:get_existing_timeboard_by_name).with(any_args)
         .and_return(res[1])
       allow(subject.logger).to receive(:info).with(any_args)
+      allow(subject).to receive(:check_dog_result)
 
       expect(subject).to receive(:get_existing_timeboard_by_name).once
         .with('t')
       expect(dog).to_not receive(:create_dashboard)
       expect(dog).to_not receive(:update_dashboard)
       expect(subject.logger).to receive(:info).with("\tTimeboard is up-to-date")
+      expect(subject).to_not receive(:check_dog_result)
       subject.upsert_timeboard('t', [1, 2])
     end
     it 'updates if title changed' do
@@ -1382,11 +1437,12 @@ describe DogTrainer::API do
       ]
       dog = double(Dogapi::Client)
       allow(dog).to receive(:create_dashboard).with(any_args)
-      allow(dog).to receive(:update_dashboard).with(any_args)
+      allow(dog).to receive(:update_dashboard).with(any_args).and_return(res)
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_timeboard_by_name).with(any_args)
         .and_return(res[1])
       allow(subject.logger).to receive(:info).with(any_args)
+      allow(subject).to receive(:check_dog_result)
 
       expect(subject).to receive(:get_existing_timeboard_by_name).once
         .with('t')
@@ -1399,6 +1455,7 @@ describe DogTrainer::API do
       )
       expect(subject.logger).to receive(:info).with("\tUpdating timeboard id1")
       expect(subject.logger).to receive(:info).with("\tTimeboard updated.")
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_timeboard('t', [1, 2])
     end
     it 'updates if repo_path changed' do
@@ -1416,11 +1473,12 @@ describe DogTrainer::API do
       ]
       dog = double(Dogapi::Client)
       allow(dog).to receive(:create_dashboard).with(any_args)
-      allow(dog).to receive(:update_dashboard).with(any_args)
+      allow(dog).to receive(:update_dashboard).with(any_args).and_return(res)
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_timeboard_by_name).with(any_args)
         .and_return(res[1])
       allow(subject.logger).to receive(:info).with(any_args)
+      allow(subject).to receive(:check_dog_result)
 
       expect(subject).to receive(:get_existing_timeboard_by_name).once
         .with('t')
@@ -1433,6 +1491,7 @@ describe DogTrainer::API do
       )
       expect(subject.logger).to receive(:info).with("\tUpdating timeboard id1")
       expect(subject.logger).to receive(:info).with("\tTimeboard updated.")
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_timeboard('t', [1, 2])
     end
     it 'updates if graphs changed' do
@@ -1450,11 +1509,12 @@ describe DogTrainer::API do
       ]
       dog = double(Dogapi::Client)
       allow(dog).to receive(:create_dashboard).with(any_args)
-      allow(dog).to receive(:update_dashboard).with(any_args)
+      allow(dog).to receive(:update_dashboard).with(any_args).and_return(res)
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_timeboard_by_name).with(any_args)
         .and_return(res[1])
       allow(subject.logger).to receive(:info).with(any_args)
+      allow(subject).to receive(:check_dog_result)
 
       expect(subject).to receive(:get_existing_timeboard_by_name).once
         .with('t')
@@ -1467,6 +1527,7 @@ describe DogTrainer::API do
       )
       expect(subject.logger).to receive(:info).with("\tUpdating timeboard id1")
       expect(subject.logger).to receive(:info).with("\tTimeboard updated.")
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_timeboard('t', [3, 4])
     end
   end
@@ -1487,6 +1548,7 @@ describe DogTrainer::API do
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_screenboard_by_name)
         .with(any_args).and_return(nil)
+      allow(subject).to receive(:check_dog_result)
       allow(subject.logger).to receive(:info).with(any_args)
 
       expect(subject).to receive(:get_existing_screenboard_by_name).once
@@ -1499,6 +1561,7 @@ describe DogTrainer::API do
         )
       expect(dog).to_not receive(:update_screenboard)
       expect(subject.logger).to receive(:info).with('Created screenboard id1')
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_screenboard('t', [1, 2])
     end
     it 'does nothing if it is up to date' do
@@ -1517,6 +1580,7 @@ describe DogTrainer::API do
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_screenboard_by_name)
         .with(any_args).and_return(res[1])
+      allow(subject).to receive(:check_dog_result)
       allow(subject.logger).to receive(:info).with(any_args)
 
       expect(subject).to receive(:get_existing_screenboard_by_name).once
@@ -1525,6 +1589,7 @@ describe DogTrainer::API do
       expect(dog).to_not receive(:update_screenboard)
       expect(subject.logger).to receive(:info)
         .with("\tScreenboard is up-to-date")
+      expect(subject).to_not receive(:check_dog_result)
       subject.upsert_screenboard('t', [1, 2])
     end
     it 'updates if repo_path in description is different' do
@@ -1539,10 +1604,11 @@ describe DogTrainer::API do
       ]
       dog = double(Dogapi::Client)
       allow(dog).to receive(:create_screenboard).with(any_args)
-      allow(dog).to receive(:update_screenboard).with(any_args)
+      allow(dog).to receive(:update_screenboard).with(any_args).and_return(res)
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_screenboard_by_name)
         .with(any_args).and_return(res[1])
+      allow(subject).to receive(:check_dog_result)
       allow(subject.logger).to receive(:info).with(any_args)
 
       expect(subject).to receive(:get_existing_screenboard_by_name).once
@@ -1555,6 +1621,8 @@ describe DogTrainer::API do
           description: 'created by DogTrainer RubyGem via my_repo_path',
           widgets: [1, 2]
         )
+      expect(subject.logger).to receive(:info).with("\tScreenboard updated.")
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_screenboard('t', [1, 2])
     end
     it 'updates if title is different' do
@@ -1569,10 +1637,11 @@ describe DogTrainer::API do
       ]
       dog = double(Dogapi::Client)
       allow(dog).to receive(:create_screenboard).with(any_args)
-      allow(dog).to receive(:update_screenboard).with(any_args)
+      allow(dog).to receive(:update_screenboard).with(any_args).and_return(res)
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_screenboard_by_name)
         .with(any_args).and_return(res[1])
+      allow(subject).to receive(:check_dog_result)
       allow(subject.logger).to receive(:info).with(any_args)
 
       expect(subject).to receive(:get_existing_screenboard_by_name).once
@@ -1585,6 +1654,8 @@ describe DogTrainer::API do
           description: 'created by DogTrainer RubyGem via my_repo_path',
           widgets: [1, 2]
         )
+      expect(subject.logger).to receive(:info).with("\tScreenboard updated.")
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_screenboard('t', [1, 2])
     end
     it 'updates if widgets are different' do
@@ -1599,10 +1670,11 @@ describe DogTrainer::API do
       ]
       dog = double(Dogapi::Client)
       allow(dog).to receive(:create_screenboard).with(any_args)
-      allow(dog).to receive(:update_screenboard).with(any_args)
+      allow(dog).to receive(:update_screenboard).with(any_args).and_return(res)
       subject.instance_variable_set('@dog', dog)
       allow(subject).to receive(:get_existing_screenboard_by_name)
         .with(any_args).and_return(res[1])
+      allow(subject).to receive(:check_dog_result)
       allow(subject.logger).to receive(:info).with(any_args)
 
       expect(subject).to receive(:get_existing_screenboard_by_name).once
@@ -1615,6 +1687,8 @@ describe DogTrainer::API do
           description: 'created by DogTrainer RubyGem via my_repo_path',
           widgets: [1, 2]
         )
+      expect(subject.logger).to receive(:info).with("\tScreenboard updated.")
+      expect(subject).to receive(:check_dog_result).once.with(res)
       subject.upsert_screenboard('t', [1, 2])
     end
   end

data/spec/unit/dogapiexception_spec.rb

@@ -0,0 +1,50 @@
+require 'dogtrainer'
+
+describe DogTrainer::DogApiException do
+  subject { DogTrainer::DogApiException }
+  describe 'attr_readers' do
+    it 'has statuscode attr_reader' do
+      expect(subject.new(['500', { 'errors' => ['foo'] }]).statuscode)
+        .to eq('500')
+    end
+    it 'has content attr_reader' do
+      expect(subject.new(['500', { 'errors' => ['foo'] }]).content)
+        .to eq('errors' => ['foo'])
+    end
+  end
+  describe 'when response is a single-element array' do
+    it 'sets content to an empty hash' do
+      expect(subject.new(['500']).content).to eq({})
+    end
+  end
+  describe 'with errors in content' do
+    context 'when errors is an Array' do
+      it 'includes errors in the message' do
+        # rubocop:disable Style/WordArray
+        x = subject.new(['500', { 'errors' => ['foo', "bar\nbaz"] }])
+        # rubocop:enable Style/WordArray
+        expect(x.to_s)
+          .to eq("Datadog API call returned status 500:\nfoo\nbar\nbaz\n")
+      end
+    end
+    context 'when errors is a String' do
+      it 'includes errors in the message' do
+        x = subject.new(['500', { 'errors' => 'foo' }])
+        expect(x.to_s)
+          .to eq("Datadog API call returned status 500:\nfoo\n")
+      end
+    end
+  end
+  describe 'without errors in content' do
+    it 'does not include errors in the message' do
+      x = subject.new(['500', {}])
+      expect(x.to_s).to eq('Datadog API call returned status 500')
+    end
+  end
+  describe 'with a nil content' do
+    it 'produces a correct message' do
+      x = subject.new(['404', {}])
+      expect(x.to_s).to eq('Datadog API call returned status 404')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogtrainer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - jantman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogapi
@@ -386,10 +386,12 @@ files:
 - dogtrainer.gemspec
 - lib/dogtrainer.rb
 - lib/dogtrainer/api.rb
+- lib/dogtrainer/dogapiexception.rb
 - lib/dogtrainer/logging.rb
 - lib/dogtrainer/version.rb
 - spec/spec_helper.rb
 - spec/unit/api_spec.rb
+- spec/unit/dogapiexception_spec.rb
 - spec/unit/logging_spec.rb
 homepage: http://github.com/Manheim/dogtrainer
 licenses:
@@ -420,4 +422,5 @@ summary: Wrapper around DataDog dogapi gem to simplify creation and management o
 test_files:
 - spec/spec_helper.rb
 - spec/unit/api_spec.rb
+- spec/unit/dogapiexception_spec.rb
 - spec/unit/logging_spec.rb