mackerel-client 0.11.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68b096795c66861001227bf41e3cb6a7b940306dc404b555691a239031fd8fd6
-  data.tar.gz: e6516bd4b135f946b3198e5971fca264cfb3e66d8d35e695d5c49773252bb4b9
+  metadata.gz: 1c256ae64c9db044569a48a32de536f25bf194d41def84e7e2f862f9730c7973
+  data.tar.gz: 87b3521e311375f682a001dd7cbf9d5864095a9fd376e60ca15b7bcb21bed7f6
 SHA512:
-  metadata.gz: dd58f6dae6a96848018b4cdd5ba2686bb0ce96f4c521465f782dd45a016c6def438e90b7646a357bc5f93a5905f3e561bcf504124956205c54d9f03543495146
-  data.tar.gz: 1640a65f29e6641551769642cac689a3e7c1b9d497bb5ee0b33da1c6081c1083bed6c6dc4b225727f95c2ca4d74de6ea66bdf9eade658fb692c43fe6896ac3ee
+  metadata.gz: 83bd86498f4e491ea2dc54a4e4c3bd4f2c4583b2c25d6138af217a74280db52b7f93278ae3f055f2e5f1fd20c075e7e890df3c2e5aec709f2140b8ff1dbc7424
+  data.tar.gz: b9755848c7670e397133c3ffd7519459b673f699a3e3adf95c4ae8f2b029a63acab58908a0ade1f905244816a37f208ea9d10bd7c77b2c28f76c5bd764bf0c28

data/.github/workflows/ci.yml

@@ -9,9 +9,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-20.04', 'macOS-10.15']
+        os: ['ubuntu-latest', 'macOS-latest']
         # See https://github.com/actions/runner/issues/849 for quoting '3.0'
-        ruby: [2.6, 2.7, '3.0']
+        ruby: [2.6, 2.7, '3.0', 3.1]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.12.1 (2023-10-20)
+
+* Update faraday requirement from ~> 1.0 to >= 1, < 3 #67 (dependabot[bot])
+* added ruby 3.1 on ci #68 (yset)
+
+## 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.1

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.1"
 end

data/mackerel-client.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'faraday', '>= 1', '< 3'
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "bundler"

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,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: mackerel-client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Mackerel developer team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Mackerel client implemented by Ruby.