mackerel-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82cd57e63e053eb6b8b4fd8c0d89c4747fba5937
+  data.tar.gz: 0394eeecb9618458630f2520a7af71375a4c8d12
+SHA512:
+  metadata.gz: 453706639f925b91cfe33bd3cba00f4d797f83ba5d9522e8f608d5b5e5f15b47dfb790fb34d9432f3c2905f807ef8ce3356f8880f3a558eb2c45722c24203e1f
+  data.tar.gz: a87577caee432f325600cfecf4cd6e934b6f228e62d126358bb5c6a2081bbd3a9a34ccd4b9f8e8928b2f654d3d28fbd1ba1bf44ac232e123322c308b970c3a78

data/.gitignore

@@ -0,0 +1,18 @@
+/vendor/
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'faraday'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,15 @@
+This software is licensed under the Apache 2 license, quoted below.
+
+Copyright 2014 Hatena
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,33 @@
+# Mackerel::Client
+
+TODO: Write a gem description
+
+
+# CLI
+
+## Host
+
+* Get host(s) information from hostname or service, role.
+```
+mkr host info [--name foo] [--service service] [--role role]
+```
+
+* Set status of a host
+```
+mkr host status --host-id foo --status working
+```
+
+* Get status of a host (not implemented yet)
+```
+mkr host status --host-id foo
+```
+
+## Authentication
+```
+export MACKEREL_APIKEY=foobar
+```
+
+## reference
+* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html
+* https://github.com/aws/aws-cli
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/mkr

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+
+# mkr(1)
+
+require 'mackerel'
+Mackerel::Runner.execute(ARGV)
+

data/lib/mackerel/client.rb

@@ -0,0 +1,97 @@
+require 'faraday'
+require 'uri'
+
+require 'json' unless defined? ::JSON
+require 'mackerel/host'
+
+module Mackerel
+
+  class Client
+
+    def initialize(args = {})
+      @origin  = args[:mackerel_origin] || 'https://mackerel.io'
+      @api_key = args[:mackerel_api_key]
+    end
+
+    def get_host(host_id)
+      client = http_client
+
+      response = client.get "/api/v0/hosts/#{host_id}" do |req|
+        req.headers['X-Api-Key'] = @api_key
+      end
+
+      unless response.success?
+        raise "GET /api/v0/hosts/#{host_id} faild: #{response.status}"
+      end
+
+      data = JSON.parse(response.body)
+      Host.new(data['host'])
+    end
+
+    def update_host_status(host_id, status)
+      unless [:standby, :working, :maintenance, :poweroff].include?(status.to_sym)
+        raise "no such status: #{status}"
+      end
+
+      client = http_client
+
+      response = client.post "/api/v0/hosts/#{host_id}/status" do |req|
+        req.headers['X-Api-Key'] = @api_key
+        req.headers['Content-Type'] = 'application/json'
+        req.body = { "status" => status }.to_json
+      end
+
+      unless response.success?
+        raise "POST /api/v0/hosts/#{host_id}/status faild: #{response.status}"
+      end
+
+      data = JSON.parse(response.body)
+    end
+
+    def post_metrics(metrics)
+      client = http_client
+
+      response = client.post '/api/v0/tsdb' do |req|
+        req.headers['X-Api-Key'] = @api_key
+        req.headers['Content-Type'] = 'application/json'
+        req.body = metrics.to_json
+      end
+
+      unless response.success?
+        raise "POST /api/v0/tsdb faild: #{response.status}"
+      end
+
+      data = JSON.parse(response.body)
+    end
+
+    def get_hosts(opts = {})
+      client = http_client
+
+      response = client.get '/api/v0/hosts.json' 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]
+        req.params['name']       = opts[:name]    if opts[:name]
+      end
+
+      unless response.success?
+        raise "GET /api/v0/hosts.json faild: #{response.status}"
+      end
+
+      data = JSON.parse(response.body)
+      data['hosts'].map{ |host_json| Host.new(host_json) }
+    end
+
+    private
+
+    def http_client
+      Faraday.new(:url => @origin) do |faraday|
+        faraday.response :logger if ENV['DEBUG']
+        faraday.adapter Faraday.default_adapter
+        faraday.options.params_encoder = Faraday::FlatParamsEncoder
+      end
+    end
+
+  end
+
+end

data/lib/mackerel/host.rb

@@ -0,0 +1,41 @@
+module Mackerel
+
+  class Host
+
+    MACKEREL_INTERFACE_NAME_PATTERN = /^eth\d/
+    attr_accessor :name, :type, :status, :memo, :isRetired, :id, :createdAt, :roles, :interfaces
+
+    def initialize(args = {})
+      @hash       = args
+      @name       = args["name"]
+      @meta       = args["meta"]
+      @type       = args["type"]
+      @status     = args["status"]
+      @memo       = args["memo"]
+      @isRetired  = args["isRetired"]
+      @id         = args["id"]
+      @createdAt  = args["createdAt"]
+      @roles      = args["roles"]
+      @interfaces = args["interfaces"]
+    end
+
+    def ip_addr
+      interface = @interfaces.find do |i|
+        MACKEREL_INTERFACE_NAME_PATTERN === i['name']
+      end
+      interface['ipAddress'] if interface
+    end
+
+    def mac_addr
+      interface = @interfaces.find do |i|
+        MACKEREL_INTERFACE_NAME_PATTERN === i['name']
+      end
+      interface['macAddress'] if interface
+    end
+
+    def to_h
+      return @hash
+    end
+  end
+
+end

data/lib/mackerel/runner.rb

@@ -0,0 +1,103 @@
+require 'optparse'
+require 'json' unless defined? ::JSON
+
+module Mackerel
+
+  class Runner
+    attr_reader :args
+
+    def initialize(args)
+
+      args.unshift 'help' if args.empty?
+
+      @args = args
+      cmd = args.shift
+
+      if Runner.method_defined?(cmd) and cmd != 'run'
+        send(cmd, args)
+      else
+        puts "Error: `#{cmd}` command not found.\n\n"
+        send('help', args)
+        abort
+      end
+    end
+
+    # Shortcut
+    def self.execute(args)
+      new(args)
+    end
+
+    def help(args)
+      puts <<-EOS
+#{$0}: Command line interface for Mackerel (https://mackerel.io/).
+  Get host(s) information from hostname or service, role.
+    mkr host info [--name foo] [--service service] [--role role]
+
+  Set status of a host
+    mkr host status --host-id foo --status working
+
+  Authentication
+    API key must be set to the environment variable as follows.
+      export MACKEREL_APIKEY=foobar
+
+      EOS
+    end
+
+    # mkr host status --host-id foo
+    def host(args)
+      mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+      params = {}
+      opt = OptionParser.new
+      opt.on('--host-id HOSTID'){|v| params[:hostid] = v }
+
+      cmd = args.shift
+      case cmd
+      when 'status'
+          opt.on('--status STATUS'){|v| params[:status] = v }
+          opt.parse!(args)
+          if params[:status]
+            begin
+              res = mc.update_host_status(params[:hostid], params[:status])
+              puts "Updated to '#{params[:status]}'"
+            rescue => msg
+              abort "Error: #{msg}"
+            end
+          else
+            begin
+              res = mc.get_hosts(:hostid => params[:hostid])[0]
+              puts "#{res.status}"
+            rescue => msg
+              abort "Error: #{msg}"
+            end
+
+          end
+ 
+      when 'info'
+          opt.on('--service SERVICE'){|v| params[:service] = v }
+          opt.on('--role ROLE')      {|v| params[:role] = v }
+          opt.on('--name NAME')      {|v| params[:name] = v }
+          opt.on('--host-id HOSTID') {|v| params[:hostId] = v }
+          opt.parse!(args)
+          begin
+            if params[:hostid]
+              res = [ mc.get_host(params[:hostId]) ]
+            else
+              res = mc.get_hosts(params)
+            end
+          rescue => msg
+            abort "Error: #{msg}"
+          end
+          res.each do |res|
+            puts <<-EOS
+name: #{res.name}, status: #{res.status}, id: #{res.id}, roles: #{res.roles}
+          EOS
+          end
+      else
+        abort "Error: `#{command}` command not found for host."
+      end
+    end
+
+  end
+
+end
+

data/lib/mackerel.rb

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

data/mackerel-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "mackerel-client"
+  spec.version       = File.read("VERSION").strip
+  spec.authors       = ["Mackerel developer team"]
+  spec.email         = ["developers@mackerel.io"]
+  spec.summary       = 'Mackerel client implemented by Ruby.'
+  spec.description   = 'Mackerel client is a library to access Mackerel (https://mackerel.io/). CLI tool `mkr` is also provided.'
+  spec.homepage      = "https://mackerel.io/"
+  spec.license       = "Apache 2"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.9'
+
+  spec.add_development_dependency "rake", '~> 0'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec", '~> 2'
+end

data/spec/mackerel/client_spec.rb

@@ -0,0 +1,197 @@
+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 '#get_host' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump({'host' => host.to_h})
+      ]
+    }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.get(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:hostId) { '21obeF4PhZN' }
+
+    let(:api_path) { "/api/v0/hosts/#{hostId}" }
+
+    let(:host) {
+      Mackerel::Host.new(
+        'name' => 'db001',
+        'meta' => {
+          'agent-name' => 'mackerel-agent/0.6.1',
+          'agent-revision' => 'bc2f9f6',
+          'agent-version'  => '0.6.1',
+        },
+        'type' => 'unknown',
+        'status' => 'working',
+        'memo' => 'test host',
+        'isRetired' => false,
+        'id' => hostId,
+        'createdAt' => '1401291976',
+        'roles' => [
+          'mackerel' => ['db']
+        ],
+        'interfaces' => [{
+            "ipAddress"   => "10.0.0.1",
+            "macAddress"  => "08:00:27:ce:08:3d",
+            "name"        => "eth0"
+        }],
+      )
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully find host" do
+      expect(client.get_host(hostId).to_h).to eq(host.to_h)
+    end
+  end
+
+  describe '#update_host_status' 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(:hostId) { '21obeF4PhZN' }
+
+    let(:api_path) { "/api/v0/hosts/#{hostId}/status" }
+
+    let(:response_object) {
+      { 'success' => true }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully update host status" do
+      expect(client.update_host_status(hostId, :maintenance)).to eq(response_object)
+    end
+  end
+
+  describe '#post_metrics' 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(:hostId) { '21obeF4PhZN' }
+
+    let(:api_path) { "/api/v0/tsdb" }
+
+    let(:response_object) {
+      { 'success' => true }
+    }
+
+    let(:metrics) { [
+        { 'hostId' => hostId, 'name' => 'custom.metrics.loadavg', 'time' => 1401537844, 'value' => 1.4 },
+        { 'hostId' => hostId, 'name' => 'custom.metrics.uptime',  'time' => 1401537844, 'value' => 500 },
+    ] }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully post metrics" do
+      expect(client.post_metrics(metrics)).to eq(response_object)
+    end
+  end
+
+  describe '#get_hosts' do
+    let(:stubbed_response) {
+      [
+        200,
+        {},
+        JSON.dump({ 'hosts' => hosts.map(&:to_h) })
+      ]
+    }
+
+    let(:test_client) {
+      Faraday.new do |builder|
+        builder.adapter :test do |stubs|
+          stubs.get(api_path) { stubbed_response }
+        end
+      end
+    }
+
+    let(:hostId) { '21obeF4PhZN' }
+
+    let(:api_path) { "/api/v0/hosts.json" }
+
+    let(:hosts) {
+      [
+        Mackerel::Host.new(
+          'name' => 'mackereldb001',
+          'meta' => {
+            'agent-name' => 'mackerel-agent/0.6.1',
+            'agent-revision' => 'bc2f9f6',
+            'agent-version'  => '0.6.1',
+          },
+          'type' => 'unknown',
+          'status' => 'working',
+          'memo' => 'test host',
+          'isRetired' => false,
+          'id' => hostId,
+          'createdAt' => '1401291976',
+          'roles' => [
+            'mackerel' => ['db']
+          ],
+          'interfaces' => [{
+              "ipAddress"   => "10.0.0.1",
+              "macAddress"  => "08:00:27:ce:08:3d",
+              "name"        => "eth0"
+          }],
+        )
+      ]
+    }
+
+    let(:opts) {
+      { :service => 'mackerel', :roles => 'db' }
+    }
+
+    before do
+      allow(client).to receive(:http_client).and_return(test_client)
+    end
+
+    it "successfully get hosts" do
+      expect(client.get_hosts(opts).map(&:to_h)).to eq(hosts.map(&:to_h))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'mackerel'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mackerel-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mackerel developer team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Mackerel client is a library to access Mackerel (https://mackerel.io/).
+  CLI tool `mkr` is also provided.
+email:
+- developers@mackerel.io
+executables:
+- mkr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/mkr
+- lib/mackerel.rb
+- lib/mackerel/client.rb
+- lib/mackerel/host.rb
+- lib/mackerel/runner.rb
+- mackerel-client.gemspec
+- spec/mackerel/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://mackerel.io/
+licenses:
+- Apache 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Mackerel client implemented by Ruby.
+test_files:
+- spec/mackerel/client_spec.rb
+- spec/spec_helper.rb