memoir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 684b447befdf0b8cdaf05389e5e0dc60e6e803d2
+  data.tar.gz: 1a1b49ac8e00ed1a69f848f007dc95bfbf49bd0b
+SHA512:
+  metadata.gz: 0c18b10cea866bc3f156698e1ae97a60d3450f17537c41abe1c7dabe182e7e4448c7a8cace2c8e9c60f9d33c9005aa9df79121d3eb5bbf8c979d0b0c650e002d
+  data.tar.gz: 8e457a5b1625ed73d13bb6794da504c5ffce7f02773ca827fc9fcd2e9b430df40f4205aa20886a66b61933da03eaedab277e5eb9f75bacb416c898fef9eae85c

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,46 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2.1
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  exclude:
+    - rvm: 1.9.3
+      jdk: openjdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: openjdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: 2.1
+      jdk: openjdk7
+    - rvm: 2.1
+      jdk: oraclejdk7
+    - rvm: 2.2.1
+      jdk: openjdk7
+    - rvm: 2.2.1
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: oraclejdk7
+  fast_finish: true
+
+branches:
+  only:
+    - master

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2016 Michal Kimle
+
+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,56 @@
+# Memoir
+Ruby client library for easy communication with OpenTSDB v2.2+
+
+[![Build Status](https://secure.travis-ci.org/Misenko/memoir.png)](http://travis-ci.org/Misenko/memoir)
+[![Dependency Status](https://gemnasium.com/Misenko/memoir.png)](https://gemnasium.com/Misenko/memoir)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/memoir.png)](https://badge.fury.io/rb/memoir)
+[![Code Climate](https://codeclimate.com/github/Misenko/memoir.png)](https://codeclimate.com/github/Misenko/memoir)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'memoir'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install memoir
+```
+
+## Usage example
+Memoir classes and attributes loosely follow the OpenTSDB query api described here:
+[http://opentsdb.net/docs/build/html/api_http/query/index.html](http://opentsdb.net/docs/build/html/api_http/query/index.html)
+
+```ruby
+# Create a 'literal_or' filter for tag 'hostname' matching any of values 'some.host1', 'some.host2' and 'some.host3' without grouping
+filter = Memoir::Filter.new Memoir::FilterType::LITERAL_OR, 'hostname', 'some.host1|some.host2|some.host3', false
+# Create a query for metric 'some.important.metric' with aggregator 'sum'
+query = Memoir::Query.new Memoir::Aggregator::SUM, 'some.important.metric'
+# Create a downsample per one day with aggregator 'avg'
+downsample = Memoir::Downsample.new Memoir::TimePeriod.new(1, Memoir::Units::DAYS), Memoir::Aggregator::AVG
+query.downsample = downsample
+# Add filter to the query
+query << filter
+# Create a request for data from one month ago till now (default value for no end time)
+request = Memoir::Request.new Memoir::TimePeriod.new(1, Memoir::Units::MONTHS)
+# Add query to the request
+request << query
+# Initialize client
+client = Memoir::Client.new 'http://opentsdb.host.org', 4242
+# Dry running a request will print a request body in JSON format
+client.dry_run request
+# Run request
+response = client.run request
+
+puts response.status
+puts response.data_sets.first.dps unless response.data_sets.empty?
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/Misenko/memoir.

data/Rakefile

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

data/lib/memoir/aggregator.rb

@@ -0,0 +1,29 @@
+class Memoir::Aggregator
+  AVG = 'avg'.freeze
+  COUNT = 'count'.freeze
+  DEV = 'dev'.freeze
+  EP50R3 = 'ep50r3'.freeze
+  EP50R7 = 'ep50r7'.freeze
+  EP75R3 = 'ep75r3'.freeze
+  EP75R7 = 'ep75r7'.freeze
+  EP90R3 = 'ep90r3'.freeze
+  EP90R7 = 'ep90r7'.freeze
+  EP95R3 = 'ep95r3'.freeze
+  EP95R7 = 'ep95r7'.freeze
+  EP99R3 = 'ep99r3'.freeze
+  EP99R7 = 'ep99r7'.freeze
+  EP999R3 = 'ep999r3'.freeze
+  EP999R7 = 'ep999r7'.freeze
+  MIMMIN = 'mimmin'.freeze
+  MIMMAX = 'mimmax'.freeze
+  MIN = 'min'.freeze
+  MAX = 'max'.freeze
+  P50 = 'p50'.freeze
+  P75 = 'p75'.freeze
+  P90 = 'p90'.freeze
+  P95 = 'p95'.freeze
+  P99 = 'p99'.freeze
+  P999 = 'p999'.freeze
+  SUM = 'sum'.freeze
+  ZIMSUM = 'zimsum'.freeze
+end

data/lib/memoir/client.rb

@@ -0,0 +1,44 @@
+class Memoir::Client
+  attr_accessor :host, :port, :connection, :logger
+
+  API_QUERY_URL = '/api/query'.freeze
+
+  def initialize(host, port, logger = nil)
+    @host = host
+    @port = port
+    @logger = logger
+    prepare_connection
+  end
+
+  def host=(host)
+    @host = host
+    prepare_connection
+  end
+
+  def port=(port)
+    @port = port
+    prepare_connection
+  end
+
+  def run(request)
+    Memoir::Response.new(connection.post API_QUERY_URL, request.to_h)
+  end
+
+  def dry_run(request)
+    if logger
+      logger.info request.to_json
+    else
+      puts request.to_json
+    end
+  end
+
+  private
+
+  def prepare_connection
+    @connection = Faraday.new(url: "#{host}:#{port}") do |builder|
+      builder.request :json
+      builder.response :json
+      builder.adapter Faraday.default_adapter
+    end
+  end
+end

data/lib/memoir/data_set.rb

@@ -0,0 +1,19 @@
+# Class representing individual results in response
+class Memoir::DataSet
+  attr_accessor :metric, :tags, :aggregated_tags, :dps, :annotations, :global_annotations, :tsuids, :query
+
+  def initialize(data_set)
+    @metric = data_set['metric']
+    @tags = data_set['tags'] || {}
+    @aggregated_tags = data_set['aggregatedTags'] || []
+    @annotations = data_set['annotations'] || []
+    @global_annotations = data_set['globalAnnotations'] || []
+    @tsuids = data_set['tsuids'] || []
+    @query = query || {}
+    self.dps = data_set['dps'] || {}
+  end
+
+  def dps=(dps_object)
+    @dps = dps_object.instance_of?(Array) ? dps_object.to_h : dps_object
+  end
+end

data/lib/memoir/downsample.rb

@@ -0,0 +1,16 @@
+class Memoir::Downsample
+  attr_accessor :time_period, :aggregator, :fill_policy
+
+  def initialize(time_period, aggregator, fill_policy = nil)
+    @time_period = time_period
+    @aggregator = aggregator
+    @fill_policy = fill_policy
+  end
+
+  def to_s
+    downsample = "#{time_period}-#{aggregator}"
+    downsample = "#{downsample}-#{fill_policy}" if fill_policy
+
+    downsample
+  end
+end

data/lib/memoir/errors/argument_error.rb

@@ -0,0 +1 @@
+class Memoir::Errors::ArgumentError < Memoir::Errors::StandardError; end

data/lib/memoir/errors/request_error.rb

@@ -0,0 +1 @@
+class Memoir::Errors::RequestError < Memoir::Errors::StandardError; end

data/lib/memoir/errors/standard_error.rb

@@ -0,0 +1 @@
+class Memoir::Errors::StandardError < ::StandardError; end

data/lib/memoir/errors.rb

@@ -0,0 +1,5 @@
+module Memoir::Errors
+  require File.join(File.dirname(__FILE__), 'errors', 'standard_error')
+  require File.join(File.dirname(__FILE__), 'errors', 'argument_error')
+  Dir.glob(File.join(File.dirname(__FILE__), name.demodulize.underscore, '*.rb')) { |error_file| require error_file.chomp('.rb') }
+end

data/lib/memoir/fill_policy.rb

@@ -0,0 +1,5 @@
+class Memoir::FillPolicy
+  NAN = 'nan'.freeze
+  NULL = 'null'.freeze
+  ZERO = 'zero'.freeze
+end

data/lib/memoir/filter.rb

@@ -0,0 +1,19 @@
+class Memoir::Filter
+  attr_accessor :type, :tagk, :filter, :group_by
+
+  def initialize(type, tagk, filter, group_by = false)
+    @type = type
+    @tagk = tagk
+    @filter = filter
+    @group_by = group_by
+  end
+
+  def to_h
+    {
+      'type' => type,
+      'tagk' => tagk,
+      'filter' => filter,
+      'groupBy' => group_by
+    }
+  end
+end

data/lib/memoir/filter_type.rb

@@ -0,0 +1,9 @@
+class Memoir::FilterType
+  LITERAL_OR = 'literal_or'.freeze
+  ILITERAL_OR = 'iliteral_or'.freeze
+  NOT_LITERAL_OR = 'not_literal_or'.freeze
+  NOT_ILITERAL_OR = 'not_iliteral_or'.freeze
+  WILDCARD = 'wildcard'.freeze
+  IWILDCARD = 'iwildcard'.freeze
+  REGEXP = 'regexp'.freeze
+end

data/lib/memoir/query.rb

@@ -0,0 +1,43 @@
+class Memoir::Query
+  attr_accessor :aggregator, :metric, :rate, :rate_options, :downsample, :filters
+
+  def initialize(aggregator, metric, downsample = nil, rate = false, rate_options = {})
+    @aggregator = aggregator
+    @metric = metric
+    @downsample = downsample
+    @rate = rate
+    @rate_options = rate_options
+    @tags = {}
+    @filters = []
+  end
+
+  def <<(filter)
+    add_filter(filter)
+  end
+
+  def add_filter(filter)
+    filters << filter
+  end
+
+  def remove_filter(filter)
+    filters.delete filter
+  end
+
+  def clear_filters
+    filters.clear
+  end
+
+  def to_h
+    hash = {
+      'aggregator' => aggregator,
+      'metric' => metric,
+      'rate' => rate
+    }
+
+    hash['rateOptions'] = rate_options unless rate_options.empty?
+    hash['downsample'] = downsample.to_s if downsample
+    hash['filters'] = filters.map(&:to_h) unless filters.empty?
+
+    hash
+  end
+end

data/lib/memoir/request.rb

@@ -0,0 +1,66 @@
+class Memoir::Request
+  attr_accessor :start_time, :end_time, :queries, :options
+
+  VALID_OPTIONS = {
+    no_annotations: 'noAnnotations',
+    global_annotations: 'globalAnnotations',
+    ms_resolution: 'msResolution',
+    show_tsuids: 'showTSUIDs',
+    show_summary: 'showSummary',
+    show_query: 'showQuery',
+    delete: 'delete'
+  }.freeze
+
+  def initialize(start_time, end_time = nil, **options)
+    fail Memoir::Errors::ArgumentError, 'start_time cannot be nil' unless start_time
+
+    @start_time = start_time
+    @end_time = end_time
+    @queries = []
+    @options = options
+  end
+
+  def <<(query)
+    add_query(query)
+  end
+
+  def add_query(query)
+    queries << query
+  end
+
+  def remove_query(query)
+    queries.delete query
+  end
+
+  def clear_queries
+    queries.clear
+  end
+
+  def to_json
+    JSON.pretty_generate(to_h)
+  end
+
+  def to_h
+    validate!
+
+    hash = {
+      'start' => start_time.instance_of?(Memoir::TimePeriod) ? "#{start_time}-ago" : start_time.to_i,
+      'queries' => queries.map(&:to_h)
+    }
+
+    hash['end'] = end_time.to_i if end_time
+    options.each_pair { |key, value| hash[VALID_OPTIONS[key]] = value }
+
+    hash
+  end
+
+  private
+
+  def validate!
+    fail Memoir::Errors::RequestError, 'Request has to contain at least one query' if queries.empty?
+
+    options.keys.each do |key|
+      fail Memoir::Errors::RequestError, "Unknown option #{key.inspect}" unless VALID_OPTIONS.keys.include? key
+    end
+  end
+end

data/lib/memoir/response.rb

@@ -0,0 +1,23 @@
+class Memoir::Response
+  attr_accessor :data_sets, :stats_summary, :status, :raw
+
+  def initialize(faraday_response)
+    @data_sets = []
+    @status = faraday_response.status
+    @raw = faraday_response.body
+    parse_response(raw)
+  end
+
+  private
+
+  def parse_response(response)
+    response.each do |field|
+      if field.include? 'statsSummary'
+        @stats_summary = field['statsSummary']
+        next
+      end
+
+      data_sets << Memoir::DataSet.new(field)
+    end
+  end
+end

data/lib/memoir/time_period.rb

@@ -0,0 +1,12 @@
+class Memoir::TimePeriod
+  attr_accessor :interval, :units
+
+  def initialize(interval, units)
+    @interval = interval
+    @units = units
+  end
+
+  def to_s
+    "#{interval}#{units}"
+  end
+end

data/lib/memoir/units.rb

@@ -0,0 +1,10 @@
+class Memoir::Units
+  MILISECONDS = 'ms'.freeze
+  SECONDS = 's'.freeze
+  MINUTES = 'm'.freeze
+  HOURS = 'h'.freeze
+  DAYS = 'd'.freeze
+  WEEKS = 'w'.freeze
+  MONTHS = 'n'.freeze
+  YEARS = 'y'.freeze
+end

data/lib/memoir/version.rb

@@ -0,0 +1,3 @@
+module Memoir
+  VERSION = '0.1.0'.freeze
+end

data/lib/memoir.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+
+module Memoir
+  require File.join(File.dirname(__FILE__), 'memoir', 'version')
+  require File.join(File.dirname(__FILE__), 'memoir', 'errors')
+  require File.join(File.dirname(__FILE__), 'memoir', 'aggregator')
+  require File.join(File.dirname(__FILE__), 'memoir', 'fill_policy')
+  require File.join(File.dirname(__FILE__), 'memoir', 'filter_type')
+  require File.join(File.dirname(__FILE__), 'memoir', 'time_period')
+  require File.join(File.dirname(__FILE__), 'memoir', 'units')
+  require File.join(File.dirname(__FILE__), 'memoir', 'downsample')
+  require File.join(File.dirname(__FILE__), 'memoir', 'filter')
+  require File.join(File.dirname(__FILE__), 'memoir', 'query')
+  require File.join(File.dirname(__FILE__), 'memoir', 'request')
+  require File.join(File.dirname(__FILE__), 'memoir', 'data_set')
+  require File.join(File.dirname(__FILE__), 'memoir', 'response')
+  require File.join(File.dirname(__FILE__), 'memoir', 'client')
+end

data/memoir.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memoir/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'memoir'
+  spec.version       = Memoir::VERSION
+  spec.authors       = ['Michal Kimle']
+  spec.email         = ['kimle.michal@gmail.com']
+
+  spec.summary       = 'Client library for easy communication with OpenTSDB'
+  spec.homepage      = 'https://github.com/Misenko/memoir'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'rubocop', '~> 0.36'
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.10'
+  spec.add_runtime_dependency 'yell', '~> 2.0'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: memoir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michal Kimle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+- !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: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 
+email:
+- kimle.michal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/memoir.rb
+- lib/memoir/aggregator.rb
+- lib/memoir/client.rb
+- lib/memoir/data_set.rb
+- lib/memoir/downsample.rb
+- lib/memoir/errors.rb
+- lib/memoir/errors/argument_error.rb
+- lib/memoir/errors/request_error.rb
+- lib/memoir/errors/standard_error.rb
+- lib/memoir/fill_policy.rb
+- lib/memoir/filter.rb
+- lib/memoir/filter_type.rb
+- lib/memoir/query.rb
+- lib/memoir/request.rb
+- lib/memoir/response.rb
+- lib/memoir/time_period.rb
+- lib/memoir/units.rb
+- lib/memoir/version.rb
+- memoir.gemspec
+homepage: https://github.com/Misenko/memoir
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Client library for easy communication with OpenTSDB
+test_files: []