mackerel-client 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 42b290cb5732009e65951d7266bd3be6e8fd59bb0377a2fc3ee0fc6090595f02
-  data.tar.gz: c2c1a12ddd63fe3361ebca84f1ecb09217dde000e64ccc95237ea58d4b729f13
+SHA1:
+  metadata.gz: a8025a2dd9cbfd378bc719250d994bb31af4f047
+  data.tar.gz: fe92c27be56baefd72f2f1de9452075b9e520237
 SHA512:
-  metadata.gz: f4a4b4b9cb47596e63df03bbb9cb3253816fde131531b7f504be1ae56837a33ec7691878f8aa05309581ae04eb26b441022ed26eb40290eeab1ea0e49b6f6a60
-  data.tar.gz: 49f080bc2bb99898a311aa7739c1760fda76dcc3428d4e7e8653517683c39cffd217c945c56f5e0c79dad69339c272947e01eb856047e120818f25994bbf34fd
+  metadata.gz: 61fd86ed9588edbe18390f187387239bd9bb9bc0741bbbe41f36feda23aab143f5187b78716a9dedf4b6c746121896081ae559163181545677a4399c80074cfb
+  data.tar.gz: 3ba6941136bfb4fa2eeb2a099dff83f385a786d71f0b5bdcb346533b8f0fd0bdbc2e8162a2ceaa6dd4191bc09405bed3b4cd26f4246388f6d0a5509bb1756e78

data/.travis.yml

@@ -3,6 +3,7 @@ before_install:
   # https://github.com/travis-ci/travis-ci/issues/3531
   - gem install bundler # -v 1.7.14 if a specific version is needed
 rvm:
+  - "2.6"
   - "2.5"
   - "2.4"
   - "2.3"

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v0.8.0 (2019-06-26)
+
+### Breaking change
+
+Now mackerel-client raises `Mackerel::Error` when HTTP requests failed.
+Previously various exceptions (mainly `RuntimeError` or `NoMethodError`) happened in such cases.
+
+* Use Faraday::Response::RaiseError middleware #49 (onk)
+
 ## v0.7.0 (2018-10-22)
 
 * fix unintended initializing http headers #47 (y_uuki)

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/lib/mackerel/api_command.rb

@@ -33,32 +33,20 @@ module Mackerel
         req.params = @params
         req.body = @body
       end
-      check_status(response.status)
-
       JSON.parse(response.body)
+    rescue Faraday::Error::ClientError => e
+      begin
+        body = JSON.parse(e.response[:body])
+        message = body["error"].is_a?(Hash) ? body["error"]["message"] : body["error"]
+        raise Mackerel::Error, "#{@method.upcase} #{@path} failed: #{e.response[:status]} #{message}"
+      rescue JSON::ParserError
+        # raise Mackerel::Error with original response body
+        raise Mackerel::Error, "#{@method.upcase} #{@path} failed: #{e.response[:status]} #{e.response[:body]}"
+      end
     end
 
     private
 
-    def check_status(status)
-      case status
-      when 200...300
-        nil
-      when 400
-        message ="Invalid parameter"
-        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
-      when 403
-        message ="Not authorized"
-        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
-      when 404
-        message ="Resource not found"
-        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
-      when 409
-        message ="Already exists"
-        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
-      end
-    end
-
     def make_escaped_query
       @query.map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"}.join("&")
     end

data/lib/mackerel/client.rb

@@ -4,6 +4,7 @@ require 'uri'
 require 'json' unless defined? ::JSON
 
 require 'mackerel/api_command'
+require 'mackerel/error'
 
 require 'mackerel/role'
 require 'mackerel/host'
@@ -54,6 +55,7 @@ module Mackerel
 
     def http_client
       Faraday.new(:url => @origin) do |faraday|
+        faraday.response :raise_error
         faraday.response :logger if ENV['DEBUG']
         faraday.adapter Faraday.default_adapter
         faraday.options.params_encoder = Faraday::FlatParamsEncoder

data/lib/mackerel/error.rb

@@ -0,0 +1,4 @@
+module Mackerel
+  class Error < StandardError
+  end
+end

data/lib/mackerel/version.rb

@@ -1,3 +1,3 @@
 module Mackerel
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
 end

data/spec/mackerel/alert_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -62,6 +63,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end

data/spec/mackerel/annotation_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -58,6 +59,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -118,6 +120,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.put(api_path) { stubbed_response }
         end
@@ -165,6 +168,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.delete(api_path) { stubbed_response }
         end

data/spec/mackerel/api_commend_spec.rb

@@ -0,0 +1,82 @@
+RSpec.describe Mackerel::ApiCommand do
+  let(:api_key) { "xxxxxxxx" }
+  let(:command) { Mackerel::ApiCommand.new(:get, "/api/v0/services", api_key) }
+
+  describe "#execute" do
+    let(:api_path) { "/api/v0/services" }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.response :raise_error
+        builder.adapter :test do |stubs|
+          stubs.get(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:services) {
+      {
+        "services" => [
+          {
+            "name" => "Web",
+            "memo" => "store",
+            "roles" => [
+              "normal role",
+              "special role"
+            ]
+          },
+          {
+             "name" => "Web",
+             "memo" => "store",
+             "roles" => [
+               "a role",
+               "the role"
+             ]
+          }
+        ]
+      }
+    }
+
+    context "when success" do
+      let(:stubbed_response) {
+        [
+          200,
+          {},
+          JSON.dump(services)
+        ]
+      }
+
+      it {
+        expect(command.execute(test_client)).to eq(services)
+      }
+    end
+
+    context "when 404 Not Found" do
+      let(:stubbed_response) {
+        [
+          404,
+          {},
+          JSON.dump({"error" => { "message" => "Host Not Found."} })
+        ]
+      }
+
+      it {
+        expect { command.execute(test_client) }.to raise_error Mackerel::Error, "GET /api/v0/services failed: 404 Host Not Found."
+      }
+    end
+
+    context "when 401 Unauthorized" do
+      let(:stubbed_response) {
+        [
+          401,
+          {},
+          JSON.dump({ "error" => "Authentication failed. Please try with valid Api Key." })
+        ]
+      }
+
+      it {
+        expect { command.execute(test_client) }.to raise_error Mackerel::Error, "GET /api/v0/services failed: 401 Authentication failed. Please try with valid Api Key."
+      }
+    end
+  end
+end

data/spec/mackerel/channel_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end

data/spec/mackerel/client_spec.rb

@@ -20,6 +20,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -62,6 +63,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.put(api_path) { stubbed_response }
         end
@@ -104,6 +106,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -159,6 +162,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -194,6 +198,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.put(api_path) { stubbed_response }
         end
@@ -236,6 +241,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -270,6 +276,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -327,6 +334,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -388,6 +396,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -433,6 +442,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -466,6 +476,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -501,6 +512,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.put(api_path) { stubbed_response }
         end
@@ -540,6 +552,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.delete(api_path) { stubbed_response }
         end

data/spec/mackerel/dashboard_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -61,6 +62,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.put(api_path) { stubbed_response }
         end
@@ -110,6 +112,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -160,6 +163,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -208,6 +212,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.delete(api_path) { stubbed_response }
         end

data/spec/mackerel/invitation_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -56,6 +57,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end

data/spec/mackerel/metric_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -52,6 +53,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -98,6 +100,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -141,6 +144,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -181,6 +185,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -222,6 +227,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end

data/spec/mackerel/monitor_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -59,6 +60,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -125,6 +127,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.put(api_path) { stubbed_response }
         end
@@ -173,6 +176,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.delete(api_path) { stubbed_response }
         end

data/spec/mackerel/monitoring_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end

data/spec/mackerel/notification_group_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.post(api_path) { stubbed_response }
         end
@@ -76,6 +77,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -159,6 +161,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.put(api_path) { stubbed_response }
         end
@@ -219,6 +222,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.delete(api_path) { stubbed_response }
         end

data/spec/mackerel/organization_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end

data/spec/mackerel/service_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -71,6 +72,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -120,6 +122,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end

data/spec/mackerel/user_spec.rb

@@ -15,6 +15,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.get(api_path) { stubbed_response }
         end
@@ -64,6 +65,7 @@ RSpec.describe Mackerel::Client do
 
     let(:test_client) {
       Faraday.new do |builder|
+        builder.response :raise_error
         builder.adapter :test do |stubs|
           stubs.delete(api_path) { stubbed_response }
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mackerel-client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mackerel developer team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -101,6 +101,7 @@ files:
 - lib/mackerel/client.rb
 - lib/mackerel/client/helper.rb
 - lib/mackerel/dashboard.rb
+- lib/mackerel/error.rb
 - lib/mackerel/host.rb
 - lib/mackerel/invitation.rb
 - lib/mackerel/metadata.rb
@@ -116,6 +117,7 @@ files:
 - mackerel-client.gemspec
 - spec/mackerel/alert_spec.rb
 - spec/mackerel/annotation_spec.rb
+- spec/mackerel/api_commend_spec.rb
 - spec/mackerel/channel_spec.rb
 - spec/mackerel/client/helper_spec.rb
 - spec/mackerel/client_spec.rb
@@ -149,13 +151,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Mackerel client implemented by Ruby.
 test_files:
 - spec/mackerel/alert_spec.rb
 - spec/mackerel/annotation_spec.rb
+- spec/mackerel/api_commend_spec.rb
 - spec/mackerel/channel_spec.rb
 - spec/mackerel/client/helper_spec.rb
 - spec/mackerel/client_spec.rb