librato-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 451f581cef2f4102c93734ca13fe10bd467e6b7c
+  data.tar.gz: 3a544e9e7de8f597fb0cadd3d99633a119da194d
+SHA512:
+  metadata.gz: 7cbbf4c94b83f4f77254d8218da1ae9b84460a2cce263029ffb11e359b58b8c2dc480d702d46d798d6ae8873e547aefde1bb4657cceb553d4368fb4318b3e543
+  data.tar.gz: 342cf76e5aa4cbfd71332bfb04c8bfa0170d5f31ca3eaddf0d840d631e2cab9004a4454bf222ff3270f2dbaee5462f21f523789d4345194be8668bc22c754e70

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test.rb

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in librato-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Genki Sugawara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# Librato::Client
+
+Librato API Client for for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'librato-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install librato-client
+
+## Usage
+
+* [Librato API Documentation — Librato API Documentation](http://dev.librato.com/v1)
+* [RESOURCES](https://github.com/winebarrel/librato-client/blob/master/lib/librato/client/client.rb#L11)
+* [SUB_RESOURCES](https://github.com/winebarrel/librato-client/blob/master/lib/librato/client/resource.rb#L2)
+
+### Create client
+
+```ruby
+client = Librato::Client.new(
+  user: '...',
+  token: '...'
+  # [, Other Options]
+)
+```
+
+* Other Options
+  * `:debug`
+  * `:expand_pageable_resources`
+  * `:raise_error_if_not_exist`
+  * `:wrap_faraday_client_error`
+  * `:default_alerts_version`
+
+### List metrics
+
+```ruby
+client.metrics.get
+#=> [{"name"=>"login-delay",
+#     "display_name"=>nil,
+#     "type"=>"gauge",
+#     "attributes"=>{"created_by_ua"=>"Ruby Librato Client 0.1.0"},
+#     "description"=>nil,
+#     "period"=>nil,
+#     "source_lag"=>nil}]
+```
+
+### Show a metric
+
+```ruby
+client.metrics("login-delay").get
+#=> {"name"=>"login-delay",
+#    "display_name"=>nil,
+#    "type"=>"gauge",
+#    "attributes"=>{"created_by_ua"=>"Ruby Librato Client 0.1.0"},
+#    "description"=>nil,
+#    "period"=>nil,
+#    "source_lag"=>nil}
+```
+
+```ruby
+client.metrics("login-delay").get(
+  compose: 'series("*")',
+  start_time: 1439108273,
+  resolution: 300
+)
+
+#=> {"measurements"=>
+#     {"foo.bar.com"=>
+#       [{"measure_time"=>1439108400,
+#         "value"=>3.5,
+#         "count"=>5,
+#         "min"=>3.5,
+#         "max"=>3.5,
+#         "sum"=>17.5,
+#         "sum_squares"=>61.25},
+#         ...
+```
+
+see [Composite Metrics Language Specification – Customer Feedback & Support for Librato](http://support.metrics.librato.com/knowledgebase/articles/337431-composite-metrics-language-specification)
+
+### Create a metric
+
+```ruby
+client.metrics.post({
+  gauges: {
+    "login-delay" => {
+      value: 3.5,
+      source: "foo.bar.com"
+    }
+  }
+}
+```
+
+### Update a metric
+
+```ruby
+client.metrics("login-delay").put(display_name: "Login delay")
+```
+
+### Delete a metrics
+
+```ruby
+client.metrics("login-delay").delete
+```
+
+### List spaces
+
+```ruby
+client.spaces.get
+```
+
+### Show a space
+
+```ruby
+client.spaces(12345).get
+```
+
+### Create a space
+
+```ruby
+client.spaces.post(name: "My Space")
+```
+
+### List charts
+
+```ruby
+client.spaces(12345).charts.get
+```
+
+### Show a chart
+
+```ruby
+client.spaces(12345).charts(6789).get
+```
+
+### Create a chart
+
+```ruby
+client.spaces(77109).charts.post(
+  name: "My Chart",
+  type: "line",
+  streams: [...]
+)
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "librato/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/librato/client/client.rb

@@ -0,0 +1,85 @@
+class Librato::Client
+  ENDPOINT = 'https://metrics-api.librato.com'
+  API_VERSION = 'v1'
+  USER_AGENT = "Ruby Librato Client #{Librato::Client::VERSION}"
+
+  DEFAULT_ADAPTERS = [
+    Faraday::Adapter::NetHttp,
+    Faraday::Adapter::Test
+  ]
+
+  RESOURCES = {
+    :metrics      => [:get, :post, :put, :delete],
+    :annotations  => [:get, :post, :put, :delete],
+    :alerts       => [:get, :post, :put, :delete],
+    :api_tokens   => [:get, :post, :put, :delete],
+    :charts       => [:get, :post,       :delete],
+    :dashboards   => [:get, :post, :put, :delete],
+    :instruments  => [:get, :post, :put, :delete],
+    :jobs         => [:get                      ],
+    :services     => [:get, :post, :put, :delete],
+    :sources      => [:get,        :put, :delete],
+    :spaces       => [:get, :post, :put, :delete, :charts],
+    :users        => [:get, :post, :put, :delete],
+  }
+
+  RESOURCE_OPTIONS = {
+    :expand_pageable_resources => true,
+    :raise_error_if_not_exist  => false,
+    :wrap_faraday_client_error => true,
+    :default_alerts_version    => 2,
+  }
+
+  def initialize(options)
+    unless user = options.delete(:user)
+      raise ArgumentError, ':user is required'
+    end
+
+    unless token = options.delete(:token)
+      raise ArgumentError, ':token is required'
+    end
+
+    @debug = options.delete(:debug)
+    @resource_options = {}
+
+    RESOURCE_OPTIONS.each do |key, default_value|
+      if options.has_key?(key)
+        @resource_options[key] = options.delete(key)
+      else
+        @resource_options[key] = default_value
+      end
+    end
+
+    options[:url] ||= ENDPOINT
+
+    @conn = Faraday.new(options) do |faraday|
+      faraday.request  :url_encoded
+      faraday.response :json, :content_type => /\bjson\b/
+      faraday.response :raise_error
+      faraday.response :logger if @debug
+
+      faraday.basic_auth user, token
+
+      yield(faraday) if block_given?
+
+      unless DEFAULT_ADAPTERS.any? {|i| faraday.builder.handlers.include?(i) }
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    @conn.headers[:user_agent] = USER_AGENT
+  end
+
+  def method_missing(name, *args)
+    unless RESOURCES.has_key?(name)
+      raise NoMethodError, "undefined method: #{name} for #{self.inspect}"
+    end
+
+    unless (0..1).include?(args.length)
+      raise ArgumentError, "wrong number of arguments (#{args.length} for 0..1)"
+    end
+
+    Librato::Client::Resource.new(
+      @conn, nil, name, args[0], RESOURCES[name], @resource_options)
+  end
+end

data/lib/librato/client/error.rb

@@ -0,0 +1,8 @@
+class Librato::Client::Error < StandardError
+  attr_reader :cause
+
+  def initialize(cause)
+    super(cause.response)
+    @cause = cause
+  end
+end

data/lib/librato/client/pageable_resources.rb

@@ -0,0 +1,60 @@
+class Librato::Client::PageableResources
+  include Enumerable
+
+  def initialize(resource, name, method_name, params, body)
+    @resource = resource
+    @name = name
+    @method_name = method_name
+    @params = params
+    @body = body
+  end
+
+  def resources
+    @body[@name.to_s]
+  end
+
+  def length
+    @body['query']['length'] || 0
+  end
+
+  def offset
+    @body['query']['offset'] || 0
+  end
+
+  def total
+    @body['query']['total'] || 0
+  end
+
+  def found
+    @body['query']['found'] || 0
+  end
+
+  def has_next?
+    offset + length < found
+  end
+
+  def next_page
+    params = @params.merge(:offset => offset + length)
+    @resource.request(@method_name, params, :expand_pageable_resources => false)
+  end
+
+  def each
+    page = self
+
+    loop do
+      yield(page)
+      break unless page.has_next?
+      page = page.next_page
+    end
+  end
+
+  def each_resource(&block)
+    if block
+      self.each do |page|
+        page.resources.each(&block)
+      end
+    else
+      self.enum_for(:each_resource)
+    end
+  end
+end

data/lib/librato/client/resource.rb

@@ -0,0 +1,96 @@
+class Librato::Client::Resource
+  SUB_RESOURCES = {
+    :charts => [:get, :post, :put, :delete],
+  }
+
+  def initialize(conn, root, name, resource_id, methods, options = {})
+    @conn = conn
+    @root = root
+    @name = name
+    @resource_id = resource_id
+    @methods = methods
+    @options = options
+  end
+
+  def request(method_name, params = {}, options = {})
+    options = @options.merge(options)
+
+    begin
+      url = [Librato::Client::API_VERSION]
+      url << @root if @root
+      url << @name
+      url << @resource_id if @resource_id
+
+      if @name == :alerts and options[:default_alerts_version]
+        params[:version] = options[:default_alerts_version]
+      end
+
+      res = @conn.send(method_name) do |req|
+        req.url url.join('/')
+
+        if [:post, :put].include?(method_name)
+          req.headers['Content-Type'] = 'application/json'
+          req.body = JSON.dump(params)
+        else
+          req.params = params
+        end
+      end
+
+      if res.body.kind_of?(Hash) and res.body.has_key?('query')
+        pageable_resources = Librato::Client::PageableResources.new(
+          self, @name, method_name, params, res.body)
+
+        if options[:expand_pageable_resources]
+          pageable_resources.each_resource.to_a
+        else
+          pageable_resources
+        end
+      else
+        res.body
+      end
+    rescue Faraday::ClientError => e
+      if not options[:raise_error_if_not_exist] and e.kind_of?(Faraday::ResourceNotFound)
+        nil
+      else
+        if options[:wrap_faraday_client_error]
+          e = Librato::Client::Error.new(e)
+        end
+
+        raise e
+      end
+    end
+  end
+
+  def method_missing(name, *args, &block)
+    unless @methods.include?(name)
+      raise NoMethodError, "undefined method: #{name} for #{self.inspect}"
+    end
+
+    if SUB_RESOURCES.has_key?(name)
+      unless (0..1).include?(args.length)
+        raise ArgumentError, "wrong number of arguments (#{args.length} for 0..1)"
+      end
+
+      root = [@name]
+      root << @resource_id if @resource_id
+
+      Librato::Client::Resource.new(
+        @conn, root.join('/'), name, args[0], SUB_RESOURCES[name], @options)
+    else
+      unless (0..2).include?(args.length)
+        raise ArgumentError, "wrong number of arguments (#{args.length} for 0..2)"
+      end
+
+      params  = args[0]
+      options = args[1]
+
+      [params, options].each do |arg|
+        if not arg.nil? and not arg.kind_of?(Hash)
+          raise TypeError, "wrong argument: #{arg.inspect} (expected Hash)"
+        end
+      end
+
+      request(name, params || {}, options || {}, &block)
+    end
+  end
+end

data/lib/librato/client/version.rb

@@ -0,0 +1,5 @@
+module Librato
+  class Client
+    VERSION = '0.1.0'
+  end
+end

data/lib/librato/client.rb

@@ -0,0 +1,10 @@
+require 'json'
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'librato/client/version'
+require 'librato/client/client'
+require 'librato/client/error'
+require 'librato/client/pageable_resources'
+require 'librato/client/resource'

data/librato-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'librato/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'librato-client'
+  spec.version       = Librato::Client::VERSION
+  spec.authors       = ['Genki Sugawara']
+  spec.email         = ['sgwr_dts@yahoo.co.jp']
+
+  spec.summary       = %q{Librato API Client for for Ruby.}
+  spec.description   = %q{Librato API Client for for Ruby.}
+  spec.homepage      = 'https://github.com/winebarrel/librato-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: librato-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Genki Sugawara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Librato API Client for for Ruby.
+email:
+- sgwr_dts@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/librato/client.rb
+- lib/librato/client/client.rb
+- lib/librato/client/error.rb
+- lib/librato/client/pageable_resources.rb
+- lib/librato/client/resource.rb
+- lib/librato/client/version.rb
+- librato-client.gemspec
+homepage: https://github.com/winebarrel/librato-client
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Librato API Client for for Ruby.
+test_files: []