mackerel-client 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68b096795c66861001227bf41e3cb6a7b940306dc404b555691a239031fd8fd6
-  data.tar.gz: e6516bd4b135f946b3198e5971fca264cfb3e66d8d35e695d5c49773252bb4b9
+  metadata.gz: 0b8f49f34db204737703ca6814bca0b82f66360060ef9658c31c9937189027a7
+  data.tar.gz: f5f98e1939a2f69794cb43dafb5fb8fd8e21f2784904cbfb8d97b754f8f32857
 SHA512:
-  metadata.gz: dd58f6dae6a96848018b4cdd5ba2686bb0ce96f4c521465f782dd45a016c6def438e90b7646a357bc5f93a5905f3e561bcf504124956205c54d9f03543495146
-  data.tar.gz: 1640a65f29e6641551769642cac689a3e7c1b9d497bb5ee0b33da1c6081c1083bed6c6dc4b225727f95c2ca4d74de6ea66bdf9eade658fb692c43fe6896ac3ee
+  metadata.gz: e120aac91332700d0ef14137b699bef524755c9a8c876bc675486865fd84a50eff070a19da00df18d79dc77e2a2dfbe814a7c3f55ca8fbd0b02423b7b4ab8f1a
+  data.tar.gz: 14a98ef43f4431615b7f2141a54790c5c4177d9126542fd42acffe6ce3d6bc3af05e8cecb95fd2958ee792f6e8a87d868f27643102d40d177b8e923eb2e324bd

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.12.0 (2021-12-15)
+
+* Add get_alert to Alert API #65 (inommm, pyto86)
+* Send query parameters to alerts api #64 (kenchan)
+
 ## v0.11.0 (2021-03-24)
 
 * Implements downtime API #61 (myoan)

data/RELEASE.md

@@ -1,10 +1,10 @@
 RELEASE
 =======
 
-1. Create release branch. (`git checkout -b version-<VERSION>`)
+1. Create release branch. (`git switch -c version-<VERSION>`)
 1. Bump version `VERSION` and `lib/mackerel/version.rb` files.
 1. Write changes in CHANGELOG.md
 1. Push release branch to upstream(GitHub). (`git push -u origin version-<VERSION>`)
-1. Create Pull-Request on Github.
-1. Merge Pull-Request to master branch on Github.
+1. Create Pull-Request on GitHub.
+1. Merge Pull-Request to master branch on GitHub.
 1. Tagging and Release. (`rake release`)

data/VERSION

@@ -1 +1 @@
-0.11.0
+0.12.0

data/lib/mackerel/alert.rb

@@ -31,12 +31,21 @@ module Mackerel
 
   module REST
     module Alert
-      def get_alerts()
+      def get_alerts(opts = {})
         command = ApiCommand.new(:get, "/api/v0/alerts", @api_key)
+        command.params['withClosed'] = opts[:with_closed] if opts[:with_closed]
+        command.params['nextId'] = opts[:next_id] if opts[:next_id]
+        command.params['limit'] = opts[:limit] if opts[:limit]
         data = command.execute(client)
         data["alerts"].map { |a| Mackerel::Alert.new(a) }
       end
 
+      def get_alert(alert_id)
+        command = ApiCommand.new(:get, "/api/v0/alerts/#{alert_id}", @api_key)
+        data = command.execute(client)
+        Mackerel::Alert.new(data)
+      end
+
       def close_alert(alertId, reason)
         command = ApiCommand.new(:post, "/api/v0/alerts/#{alertId}/close", @api_key)
         command.body = { reason: reason.to_s }.to_json

data/lib/mackerel/version.rb

@@ -1,3 +1,3 @@
 module Mackerel
-    VERSION = "0.11.0"
+    VERSION = "0.12.0"
 end

data/spec/mackerel/alert_spec.rb

@@ -11,15 +11,6 @@ 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
-      end
-    }
-
     let(:api_path) { '/api/v0/alerts' }
 
     let(:alertId) { 'abcdefg' }
@@ -42,16 +33,98 @@ RSpec.describe Mackerel::Client do
       { 'alerts' => alerts }
     }
 
+    context 'no parameters' do
+      let(:test_client) {
+        Faraday.new do |builder|
+          builder.response :raise_error
+          builder.adapter :test do |stubs|
+            stubs.get(api_path) { stubbed_response }
+          end
+        end
+      }
+
+      before do
+        allow(client).to receive(:http_client).and_return(test_client)
+      end
+
+      it "successfully get alerts" do
+        expect(client.get_alerts().map(&:to_h)).to eq(alerts)
+      end
+    end
+
+    context 'with parameters' do
+      let(:with_closed) { true }
+      let(:next_id) { alertId }
+      let(:limit) { 100 }
+
+      let(:test_client) {
+        Faraday.new do |builder|
+          builder.response :raise_error
+          builder.adapter :test do |stubs|
+            stubs.get("#{api_path}?limit=#{limit}&nextId=#{next_id}&withClosed=#{with_closed}") { stubbed_response }
+          end
+        end
+      }
+
+      before do
+        allow(client).to receive(:http_client).and_return(test_client)
+      end
+
+      it "successfully get alerts" do
+        expect(
+          client.get_alerts(with_closed: with_closed, next_id: next_id, limit: limit).map(&:to_h)
+        ).to eq(alerts)
+      end
+    end
+  end
+
+  describe '#get_alert' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump(response_object)
+      ]
+    }
+
+    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(:api_path) { "/api/v0/alerts/#{alert_id}" }
+    let(:alert_id) { 'abcdefg' }
+    let(:monitor_id) { 'hijklmnopqr' }
+    let(:reason) { 'Nantonaku' }
+
+    let(:alert) {
+      {
+        'id' => alert_id,
+        'status' => 'OK',
+        'reason' => reason,
+        'monitorId' => monitor_id,
+        'type' => 'check',
+        'openedAt' => 1234567890
+      }
+    }
+
+    let(:response_object) {
+      alert
+    }
+
     before do
       allow(client).to receive(:http_client).and_return(test_client)
     end
 
-    it "successfully get alerts" do
-      expect(client.get_alerts().map(&:to_h)).to eq(alerts)
+    it "successfully get alert" do
+      expect(client.get_alert(alert_id).to_h).to eq(response_object)
     end
   end
 
-
   describe '#close_alert' do
     let(:stubbed_response) {
       [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mackerel-client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Mackerel developer team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -138,7 +138,7 @@ homepage: https://mackerel.io/
 licenses:
 - Apache 2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Mackerel client implemented by Ruby.
 test_files: