mackerel-client 0.8.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a8025a2dd9cbfd378bc719250d994bb31af4f047
-  data.tar.gz: fe92c27be56baefd72f2f1de9452075b9e520237
+SHA256:
+  metadata.gz: 0b8f49f34db204737703ca6814bca0b82f66360060ef9658c31c9937189027a7
+  data.tar.gz: f5f98e1939a2f69794cb43dafb5fb8fd8e21f2784904cbfb8d97b754f8f32857
 SHA512:
-  metadata.gz: 61fd86ed9588edbe18390f187387239bd9bb9bc0741bbbe41f36feda23aab143f5187b78716a9dedf4b6c746121896081ae559163181545677a4399c80074cfb
-  data.tar.gz: 3ba6941136bfb4fa2eeb2a099dff83f385a786d71f0b5bdcb346533b8f0fd0bdbc2e8162a2ceaa6dd4191bc09405bed3b4cd26f4246388f6d0a5509bb1756e78
+  metadata.gz: e120aac91332700d0ef14137b699bef524755c9a8c876bc675486865fd84a50eff070a19da00df18d79dc77e2a2dfbe814a7c3f55ca8fbd0b02423b7b4ab8f1a
+  data.tar.gz: 14a98ef43f4431615b7f2141a54790c5c4177d9126542fd42acffe6ce3d6bc3af05e8cecb95fd2958ee792f6e8a87d868f27643102d40d177b8e923eb2e324bd

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "01:00"
+    timezone: Asia/Tokyo
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-20.04', 'macOS-10.15']
+        # See https://github.com/actions/runner/issues/849 for quoting '3.0'
+        ruby: [2.6, 2.7, '3.0']
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # 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)
+
+## v0.10.0 (2021-03-15)
+
+## Breaking change
+
+Previously `Host` has `type` attribute, but it is removed.
+
+* Drop `type` attribute from `Host` and introduce `size` instead #58 (astj)
+
+## v0.9.0 (2020-01-23)
+
+* Use Faraday v1.0 #54 (onk)
+
 ## v0.8.0 (2019-06-26)
 
 ### Breaking change

data/README.md

@@ -1,4 +1,4 @@
-# mackerel-client [![Build Status](https://travis-ci.org/mackerelio/mackerel-client-ruby.svg?branch=master)](https://travis-ci.org/mackerelio/mackerel-client-ruby) [![Gem Version](https://badge.fury.io/rb/mackerel-client.png)](http://badge.fury.io/rb/mackerel-client)
+# mackerel-client [![CI](https://github.com/mackerelio/mackerel-client-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/mackerelio/mackerel-client-ruby/actions/workflows/ci.yml) [![Gem Version](https://badge.fury.io/rb/mackerel-client.svg)](https://badge.fury.io/rb/mackerel-client)
 
 mackerel-client is a ruby library to access Mackerel (https://mackerel.io/).
 

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.8.0
+0.12.0

data/example/03_host.rb

@@ -14,11 +14,7 @@ pp mc.post_host({
     'agent-revision' => 'bc2f9f6',
     'agent-version'  => '0.6.1',
   },
-  'type' => 'unknown',
-  'status' => 'working',
   'memo' => 'test web host',
-  'isRetired' => false,
-  'createdAt' => '1401291970',
   'roleFullnames' => [
     'mackerel:web'
   ],
@@ -35,11 +31,7 @@ pp mc.post_host({
     'agent-revision' => 'bc2f9f6',
     'agent-version'  => '0.6.1',
   },
-  'type' => 'unknown',
-  'status' => 'working',
   'memo' => 'test db host',
-  'isRetired' => false,
-  'createdAt' => '1401291976',
   'roleFullnames' => [
     'mackerel:db'
   ],
@@ -75,12 +67,7 @@ pp mc.update_host(target_host.id,{
     'agent-revision' => 'bc2f9f6',
     'agent-version'  => '0.6.1',
   },
-  'type' => 'unknown',
-  'status' => 'working',
   'memo' => 'test host',
-  'isRetired' => false,
-  'createdAt' => '1401291976',
-  'id' => target_host.id,
   'roleFullnames' => [
     'mackerel:db'
   ],
@@ -93,5 +80,3 @@ pp mc.update_host(target_host.id,{
 
 # retire the host
 pp mc.retire_host(target_host.id)
-
-

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/api_command.rb

@@ -34,7 +34,7 @@ module Mackerel
         req.body = @body
       end
       JSON.parse(response.body)
-    rescue Faraday::Error::ClientError => e
+    rescue Faraday::ClientError, Faraday::ServerError => e
       begin
         body = JSON.parse(e.response[:body])
         message = body["error"].is_a?(Hash) ? body["error"]["message"] : body["error"]

data/lib/mackerel/client.rb

@@ -21,6 +21,7 @@ require 'mackerel/metric'
 require 'mackerel/metadata'
 require 'mackerel/notification_group'
 require 'mackerel/channel'
+require 'mackerel/downtime'
 
 module Mackerel
   class Client
@@ -38,6 +39,7 @@ module Mackerel
     include Mackerel::REST::Metadata
     include Mackerel::REST::Channel
     include Mackerel::REST::NotificationGroup
+    include Mackerel::REST::Downtime
 
     def initialize(args = {})
       @origin       = args[:mackerel_origin]  || 'https://api.mackerelio.com'

data/lib/mackerel/downtime.rb

@@ -0,0 +1,27 @@
+module Mackerel
+  module REST
+    module Downtime
+      def post_downtime(downtime)
+        command = ApiCommand.new(:post, "/api/v0/downtimes", @api_key)
+        command.body = downtime.to_json
+        command.execute(client)
+      end
+
+      def get_downtimes()
+        command = ApiCommand.new(:get, "/api/v0/downtimes", @api_key)
+        command.execute(client)
+      end
+
+      def update_downtime(downtime_id, downtime)
+        command = ApiCommand.new(:put, "/api/v0/downtimes/#{downtime_id}", @api_key)
+        command.body = downtime.to_json
+        command.execute(client)
+      end
+
+      def delete_downtime(downtime_id)
+        command = ApiCommand.new(:delete, "/api/v0/downtimes/#{downtime_id}", @api_key)
+        command.execute(client)
+      end
+    end
+  end
+end

data/lib/mackerel/host.rb

@@ -3,13 +3,13 @@ module Mackerel
   class Host
 
     MACKEREL_INTERFACE_NAME_PATTERN = /^eth\d/
-    attr_accessor :name, :type, :status, :memo, :isRetired, :id, :createdAt, :roles, :interfaces, :customIdentifier
+    attr_accessor :name, :size, :status, :memo, :isRetired, :id, :createdAt, :roles, :interfaces, :customIdentifier
 
     def initialize(args = {})
       @hash             = args
       @name             = args["name"]
       @meta             = args["meta"]
-      @type             = args["type"]
+      @size             = args["size"]
       @status           = args["status"]
       @memo             = args["memo"]
       @isRetired        = args["isRetired"]

data/lib/mackerel/version.rb

@@ -1,3 +1,3 @@
 module Mackerel
-    VERSION = "0.8.0"
+    VERSION = "0.12.0"
 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', '~> 0.9'
+  spec.add_dependency 'faraday', '~> 1.0'
 
   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) {
       [

data/spec/mackerel/client_spec.rb

@@ -125,7 +125,7 @@ RSpec.describe Mackerel::Client do
           'agent-revision' => 'bc2f9f6',
           'agent-version'  => '0.6.1',
         },
-        'type' => 'unknown',
+        'size' => 'standard',
         'status' => 'working',
         'memo' => 'test host',
         'isRetired' => false,
@@ -354,7 +354,7 @@ RSpec.describe Mackerel::Client do
             'agent-revision' => 'bc2f9f6',
             'agent-version'  => '0.6.1',
           },
-          'type' => 'unknown',
+          'size' => 'standard',
           'status' => 'working',
           'memo' => 'test host',
           'isRetired' => false,

data/spec/mackerel/downtime_spec.rb

@@ -0,0 +1,192 @@
+RSpec.describe Mackerel::Client do
+  let(:api_key) { 'xxxxxxxx' }
+  let(:client) { Mackerel::Client.new(:mackerel_api_key => api_key) }
+
+  describe '#post_downtime' 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.post(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:api_path) { '/api/v0/downtimes' }
+    let(:downtime_id) { 'abcxyz' }
+    let(:name) { 'HogeHoge' }
+    let(:start) { 1234567890 }
+    let(:duration) { 10 }
+
+    let(:response_object) {
+      {
+        'id' => downtime_id,
+        'name' => name,
+        'start' => start,
+        'duration' => duration
+      }
+    }
+
+    let(:downtime) {
+      {
+        'name' => name,
+        'start' => start,
+        'duration' => duration
+      }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully post downtime" do
+      expect(client.post_downtime(downtime).to_h).to eq(response_object)
+    end
+  end
+
+  describe '#get_downtimes' 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/downtimes' }
+    let(:downtime_id) { 'abcxyz' }
+    let(:name) { 'HogeHoge' }
+    let(:start) { 1234567890 }
+    let(:duration) { 10 }
+
+    let(:response_object) {
+      {
+        'downtimes' => [
+          {
+            'id' => downtime_id,
+            'name' => name,
+            'start' => start,
+            'duration' => duration
+          }
+        ]
+      }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully get downtimes" do
+      expect(client.get_downtimes.to_h).to eq(response_object)
+    end
+  end
+
+  describe '#update_downtime' 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.put(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:api_path) { "/api/v0/downtimes/#{downtime_id}" }
+    let(:downtime_id) { 'abcxyz' }
+    let(:name) { 'HogeHoge' }
+    let(:start) { 1234567890 }
+    let(:duration) { 10 }
+
+    let(:response_object) {
+      {
+        'id' => downtime_id,
+        'name' => name,
+        'start' => start,
+        'duration' => duration
+      }
+    }
+
+    let(:downtime) {
+      {
+        'name' => name,
+        'start' => start,
+        'duration' => duration
+      }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully update downtime" do
+      expect(client.update_downtime(downtime_id, downtime).to_h).to eq(response_object)
+    end
+  end
+
+  describe '#delete_downtime' 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.delete(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:api_path) { "/api/v0/downtimes/#{downtime_id}" }
+    let(:downtime_id) { 'abcxyz' }
+    let(:name) { 'HogeHoge' }
+    let(:start) { 1234567890 }
+    let(:duration) { 10 }
+
+    let(:response_object) {
+      {
+        'id' => downtime_id,
+        'name' => name,
+        'start' => start,
+        'duration' => duration
+      }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully delete downtime" do
+      expect(client.delete_downtime(downtime_id).to_h).to eq(response_object)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mackerel-client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Mackerel developer team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,9 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -101,6 +102,7 @@ files:
 - lib/mackerel/client.rb
 - lib/mackerel/client/helper.rb
 - lib/mackerel/dashboard.rb
+- lib/mackerel/downtime.rb
 - lib/mackerel/error.rb
 - lib/mackerel/host.rb
 - lib/mackerel/invitation.rb
@@ -122,6 +124,7 @@ files:
 - spec/mackerel/client/helper_spec.rb
 - spec/mackerel/client_spec.rb
 - spec/mackerel/dashboard_spec.rb
+- spec/mackerel/downtime_spec.rb
 - spec/mackerel/invitation_spec.rb
 - spec/mackerel/metric_spec.rb
 - spec/mackerel/monitor_spec.rb
@@ -135,7 +138,7 @@ homepage: https://mackerel.io/
 licenses:
 - Apache 2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,9 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Mackerel client implemented by Ruby.
 test_files:
@@ -163,6 +165,7 @@ test_files:
 - spec/mackerel/client/helper_spec.rb
 - spec/mackerel/client_spec.rb
 - spec/mackerel/dashboard_spec.rb
+- spec/mackerel/downtime_spec.rb
 - spec/mackerel/invitation_spec.rb
 - spec/mackerel/metric_spec.rb
 - spec/mackerel/monitor_spec.rb

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-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"