mackerel-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 484eafb1d615ca3170a466e17a1faaeb79367337
-  data.tar.gz: 4dce1406131b8c9b2c6781263fd71b62a3fc7364
+  metadata.gz: 176593e33e5352c3d08929deccb4b9057444c94a
+  data.tar.gz: 29c015261d264cd3c009e22ae82891ec21a50986
 SHA512:
-  metadata.gz: 45071cc8bb854e41d34c88ace12165c725df742af6b7b7cd632c2fca5236c530e967c1aaa5ade3dbc49315286422441e87180620a81f42c66d8c6d18ea71afb5
-  data.tar.gz: fe36bddcd86ffdfbd46f1907d2e7a2c1b61d7084f09441f284b18cbdd15ff735216681f5fd251c5d50b76d6afff91fdeddb3f9780a71e57158b8f1bdac8111e1
+  metadata.gz: 0fb8fb582562ffe056601ffd24841e7e38d03b84ce1dc0b2790cade417d5c73179de2f4a659870288751dd25eb4c26e44d8e4015bddf73eda02e1817a57f7232
+  data.tar.gz: b45742f7555629d72650ee922921ae5a9abee7144e454570935e7e1acd37f36df95701aad9df623cdeef31ffa635a570313228e0914e6dd7a9a225e154a5f46b

data/README.md

@@ -1,14 +1,34 @@
 # 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 is a ruby library to access Mackerel (https://mackerel.io/). CLI tool `mkr` is also provided.
+mackerel-client is a ruby library to access Mackerel (https://mackerel.io/). CLI tool `mkr.rb` is also provided.
 
 ## Usage
 
 ```ruby
-@mackerel = Mackerel::Client.new(:mackerel_api_key => "<Put your API key")
+@mackerel = Mackerel::Client.new(:mackerel_api_key => "<Put your API key>")
 host = @mackerel.get_host("<hostId>")
 ```
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mackerel-client'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install mackerel-client
+```
+
 # CLI
 
 ## Host
@@ -33,7 +53,7 @@ mkr.rb host retire --host-id foo
 mkr.rb host status --host-id foo
 ```
 
-Note: CLI command name has been changed to `mkr.rb` from 0.0.7.
+Note: CLI command has been renamed to `mkr.rb` from 0.0.7.
 Primary CLI `mkr` is implemented in Go (https://github.com/mackerelio/mkr).
 
 ## Authentication

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/mackerel.rb

@@ -1,3 +1,4 @@
 require 'mackerel/client'
+require 'mackerel/monitor'
 require 'mackerel/runner'
 

data/lib/mackerel/client.rb

@@ -128,14 +128,14 @@ module Mackerel
       end
 
       unless response.success?
-        raise "POST /api/v0/graph-defs/create failed: #{res.status} #{res.body}"
+        raise "POST /api/v0/graph-defs/create failed: #{response.status} #{response.body}"
       end
 
       JSON.parse(response.body)
     end
 
     def get_hosts(opts = {})
-      response = client.get '/api/v0/hosts.json' do |req|
+      response = client.get '/api/v0/hosts' do |req|
         req.headers['X-Api-Key'] = @api_key
         req.params['service']    = opts[:service] if opts[:service]
         req.params['role']       = opts[:roles]   if opts[:roles]
@@ -144,13 +144,27 @@ module Mackerel
       end
 
       unless response.success?
-        raise "GET /api/v0/hosts.json failed: #{response.status}"
+        raise "GET /api/v0/hosts failed: #{response.status}"
       end
 
       data = JSON.parse(response.body)
       data['hosts'].map{ |host_json| Host.new(host_json) }
     end
 
+    def post_graph_annotation(annotation)
+      response = client.post '/api/v0/graph-annotations' do |req|
+        req.headers['X-Api-Key'] = @api_key
+        req.headers['Content-Type'] = 'application/json'
+        req.body = annotation.to_json
+      end
+
+      unless response.success?
+        raise "POST /api/v0/graph-annotations failed: #{response.status} #{response.body}"
+      end
+
+      JSON.parse(response.body)
+    end
+
     private
 
     def client

data/lib/mackerel/monitor.rb

@@ -0,0 +1,106 @@
+module Mackerel
+
+  class Monitor
+
+    attr_accessor :id, :type, :name, :duration, :metric, :url, :service, :maxCheckAttempts, :operator, :warning, :critical, :responseTimeWarning, :responseTimeCritical, :responseTimeDuration, :certificationExpirationWarning, :certificationExpirationCritical, :containsString, :expression, :notificationInterval, :scopes, :excludeScopes, :isMute
+
+    def initialize(args = {})
+      @id                              = args["id"]
+      @type                            = args["type"]
+      @name                            = args["name"]
+      @duration                        = args["duration"]
+      @metric                          = args["metric"]
+      @url                             = args["url"]
+      @service                         = args["service"]
+      @maxCheckAttempts                = args["maxCheckAttempts"]
+      @operator                        = args["operator"]
+      @warning                         = args["warning"]
+      @critical                        = args["critical"]
+      @responseTimeWarning             = args["responseTimeWarning"]
+      @responseTimeCritical            = args["responseTimeCritical"]
+      @responseTimeDuration            = args["responseTimeDuration"]
+      @certificationExpirationWarning  = args["certificationExpirationWarning"]
+      @certificationExpirationCritical = args["certificationExpirationCritical"]
+      @containsString                  = args["containsString"]
+      @expression                      = args["expression"]
+      @notificationInterval            = args["notificationInterval"]
+      @scopes                          = args["scopes"]
+      @excludeScopes                   = args["excludeScopes"]
+      @isMute                          = args["isMute"]
+    end
+
+    def to_h
+      instance_variables.flat_map do |name|
+        respond_to?(name[1..-1]) ? [name[1..-1]] : []
+      end.each_with_object({}) do |name, hash| 
+        hash[name] = public_send(name)
+      end.delete_if { |key, val| val == nil }
+    end
+
+    def to_json
+      return to_h.to_json
+    end
+
+  end
+
+  class Client
+
+    def post_monitor(monitor)
+      response = client.post "/api/v0/monitors" do |req|
+        req.headers['X-Api-Key'] = @api_key
+        req.headers['Content-Type'] = 'application/json'
+        req.body = monitor.to_json
+      end
+
+      unless response.success?
+        raise "POST /api/v0/monitors failed: #{response.status}"
+      end
+
+      data = JSON.parse(response.body)
+      Monitor.new(data)
+    end
+
+    def get_monitors()
+      response = client.get '/api/v0/monitors' do |req|
+        req.headers['X-Api-Key'] = @api_key
+      end
+
+      unless response.success?
+        raise "GET /api/v0/monitors failed: #{response.status}"
+      end
+
+      data = JSON.parse(response.body)
+      data['monitors'].map{ |monitor_json| Monitor.new(monitor_json) }
+    end
+
+    def update_monitor(monitor_id, monitor)
+      response = client.put "/api/v0/monitors/#{monitor_id}" do |req|
+        req.headers['X-Api-Key'] = @api_key
+        req.headers['Content-Type'] = 'application/json'
+        req.body = monitor.to_json
+      end
+
+      unless response.success?
+        raise "PUT /api/v0/monitors/#{monitor_id} failed: #{response.status}"
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def delete_monitor(monitor_id)
+      response = client.delete "/api/v0/monitors/#{monitor_id}" do |req|
+        req.headers['X-Api-Key'] = @api_key
+        req.headers['Content-Type'] = 'application/json'
+      end
+
+      unless response.success?
+        raise "DELETE /api/v0/monitors/#{monitor_id} failed: #{response.status}"
+      end
+
+      data = JSON.parse(response.body)
+      Monitor.new(data)
+    end
+
+  end
+
+end

data/spec/mackerel/client_spec.rb

@@ -373,7 +373,7 @@ describe Mackerel::Client do
 
     let(:hostId) { '21obeF4PhZN' }
 
-    let(:api_path) { "/api/v0/hosts.json" }
+    let(:api_path) { "/api/v0/hosts" }
 
     let(:hosts) {
       [
@@ -414,4 +414,55 @@ describe Mackerel::Client do
       expect(client.get_hosts(opts).map(&:to_h)).to eq(hosts.map(&:to_h))
     end
   end
+
+  describe '#post_graph_annotation' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump(response_object)
+      ]
+    }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.post(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:api_path) { '/api/v0/graph-annotations' }
+
+    let(:response_object) {
+      {
+        'id' => 'XXX',
+        'service' => 'myService',
+        'role' => ['role1', 'role2'],
+        'from' => 123456,
+        'to' => 123457,
+        'title' => 'Some event',
+        'description' => 'Something happend!'
+      }
+    }
+
+    let(:annotation) {
+      {
+        service: 'myService',
+        role: ['role1', 'role2'],
+        from: 123456,
+        to: 123457,
+        title: 'Some event',
+        description: 'Something happend!'
+      }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully post annotations" do
+      expect(client.post_graph_annotation(annotation)).to eq(response_object)
+    end
+  end
 end

data/spec/mackerel/monitor_spec.rb

@@ -0,0 +1,218 @@
+require 'mackerel'
+require 'mackerel/host'
+require 'json'
+
+describe Mackerel::Client do
+  let(:api_key) { 'xxxxxxxx' }
+  let(:client) { Mackerel::Client.new(:mackerel_api_key => api_key) }
+
+  describe '#post_monitor' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump(response_object.to_h)
+      ]
+    }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.post(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:api_path) { '/api/v0/monitors' }
+
+    let(:monitor) {
+      Mackerel::Monitor.new(
+        'type' => 'host',
+        'name' => 'monitor001',
+        'duration' => 5,
+        'metric' => 'loadavg5',
+        'operator' => '>',
+        'warning' => 4,
+        'critical' => 6,
+        'notificationInterval' => 600,
+        'isMute' => false,
+      )
+    }
+
+    let(:response_object) {
+      Mackerel::Monitor.new(monitor.to_h.merge('id' => 'sgyzowm'))
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully post monitor" do
+      expect(client.post_monitor(monitor).to_h).to eq(response_object.to_h)
+    end
+  end
+
+  describe '#get_monitors' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump({'monitors' => monitors})
+      ]
+    }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.get(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:api_path) { '/api/v0/monitors' }
+
+    let(:monitors) {
+      [
+        {
+          'id' => 'sgyzowm',
+          'type' => 'host',
+          'name' => 'monitor001',
+          'duration' => 5,
+          'metric' => 'loadavg5',
+          'operator' => '>',
+          'warning' => 4,
+          'critical' => 6,
+          'notificationInterval' => 600,
+          'isMute' => false,
+        },
+        {
+          'id' => 'Ux89M3G',
+          'type' => 'service',
+          'name' => 'monitor002',
+          'service' => 'servicefoo',
+          'duration' => 5,
+          'metric' => 'foo.bar',
+          'operator' => '>',
+          'warning' => 40.0,
+          'critical' => 60.0,
+          'notificationInterval' => 600,
+          'isMute' => false,
+        },
+        {
+          'id' => '2mNFJaz3',
+          'type' => 'external',
+          'name' => 'monitor003',
+          'url' => 'https://example.com',
+          'maxCheckAttempts' => 3,
+          'isMute' => false,
+        }
+      ]
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully find monitors" do
+      expect(client.get_monitors().map{|monitor| monitor.to_h }).to eq(monitors)
+    end
+  end
+
+  describe '#update_monitor' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump(response_object)
+      ]
+    }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.put(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:monitorId) { 'sgyzowm' }
+
+    let(:api_path) { "/api/v0/monitors/#{monitorId}" }
+
+    let(:monitor) {
+      Mackerel::Host.new(
+        'type' => 'host',
+        'name' => 'monitor001',
+        'duration' => 5,
+        'metric' => 'loadavg5',
+        'operator' => '>',
+        'warning' => 4,
+        'critical' => 6,
+        'notificationInterval' => 600,
+        'isMute' => false,
+      )
+    }
+
+    let(:response_object) {
+      { 'id' => monitorId }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully update a monitor" do
+      expect(client.update_monitor(monitorId, monitor)).to eq(response_object)
+    end
+  end
+
+  describe '#delete_monitor' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump(response_object.to_h)
+      ]
+    }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.delete(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:monitorId) { 'sgyzowm' }
+
+    let(:api_path) { "/api/v0/monitors/#{monitorId}" }
+
+    let(:monitor) {
+      Mackerel::Monitor.new(
+        'id' => monitorId,
+        'type' => 'host',
+        'name' => 'monitor001',
+        'duration' => 5,
+        'metric' => 'loadavg5',
+        'operator' => '>',
+        'warning' => 4,
+        'critical' => 6,
+        'notificationInterval' => 600,
+        'isMute' => false,
+      )
+    }
+
+    let(:response_object) {
+      monitor
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully delete a monitor" do
+      expect(client.delete_monitor(monitorId).to_h).to eq(response_object.to_h)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mackerel-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Mackerel developer team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -90,10 +90,12 @@ files:
 - lib/mackerel/client.rb
 - lib/mackerel/client/helper.rb
 - lib/mackerel/host.rb
+- lib/mackerel/monitor.rb
 - lib/mackerel/runner.rb
 - mackerel-client.gemspec
 - spec/mackerel/client/helper_spec.rb
 - spec/mackerel/client_spec.rb
+- spec/mackerel/monitor_spec.rb
 - spec/spec_helper.rb
 homepage: https://mackerel.io/
 licenses:
@@ -122,4 +124,5 @@ summary: Mackerel client implemented by Ruby.
 test_files:
 - spec/mackerel/client/helper_spec.rb
 - spec/mackerel/client_spec.rb
+- spec/mackerel/monitor_spec.rb
 - spec/spec_helper.rb