opentsdb-consumer 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a78304f73686cf40a865ef0546337c5b11a69847
-  data.tar.gz: f216a7b347b229066c52ab2dd04d5a9ef272ffad
+  metadata.gz: 334956afe7507b50e68bdb15ee3fb1259e308c9a
+  data.tar.gz: 39e5074094710e559e0354f8eb6fd941b653f838
 SHA512:
-  metadata.gz: 853a0322f569c5efc7818d1a2ea2e03b6903059cce7707a0f13dad2ba6e3de41b69a23957c310f2fec7e51831b8e51b60bc42824d6a1c42731ae89579451721d
-  data.tar.gz: cb611732fbd5b61b6cb53cd7afa54d7feb48a5c71079baa552728a6777ff12550058857fd0b59bfb20b5bd9283a005f50f27baa804ab7d5e3cd0d8805e863298
+  metadata.gz: 04482b0690cc6e8b86e09300c17f10f5a999cb20e56fd6cf326aca2c191e633e65f5e8a5b63313d1d802c771dcf98487869eb3dff07cf082f77cd76ce63697d4
+  data.tar.gz: 16b717f60281eed71d6c8ec0e93b8661e63889576cb93564862d0fc87e1862df872fb8cef57f1da1a988502c7388d9f196bfc3b7e5dd6c411c5742f2b4233131

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/README.md

@@ -23,6 +23,14 @@ metric = OpenTSDBConsumer::Metric.new name: 'my.metric', rate: true, aggregator:
 OpenTSDBConsumer::Query.new([metric], client).run start: '24h-ago'
 ```
 
+The rate can be configured by providing an hash with the rate options.
+```ruby
+metric = OpenTSDBConsumer::Metric.new name: 'my.metric',
+                                      rate: { counter: true, counterMax: 65535, resetValue: 2000 },
+                                      aggregator: 'sum'
+```
+
+
 ## Contributing to opentsdb-consumer
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/opentsdb-consumer.rb

@@ -4,5 +4,6 @@ end
 require 'opentsdb-consumer/errors'
 require 'opentsdb-consumer/client'
 require 'opentsdb-consumer/metric'
+require 'opentsdb-consumer/rate'
 require 'opentsdb-consumer/query'
 require 'opentsdb-consumer/result'

data/lib/opentsdb-consumer/metric.rb

@@ -1,3 +1,5 @@
+require 'opentsdb-consumer/rate'
+
 module OpenTSDBConsumer
   class Metric
     attr_reader :name, :aggregator, :rate, :downsample, :tags
@@ -5,24 +7,26 @@ module OpenTSDBConsumer
     def initialize(name: nil, aggregator: 'sum', rate: false, downsample: '10m-avg', tags: {})
       @name = name
       @aggregator = aggregator
-      @rate = rate
+      @rate = Rate.new(rate) if rate
       @downsample = downsample
       @tags = tags
     end
 
     def to_s
       query = tags.any? ? "{#{tags_to_query}}" : ''
-      [aggregator, downsample, rate_to_query, name].compact.join(':') + query
+      query += ":#{rate}" if rate
+      [aggregator, downsample, name].compact.join(':') + query
     end
 
     def to_h
-      {
+      hash = {
         aggregator: aggregator,
         downsample: downsample,
         metric: name,
-        rate: rate,
         tags: tags,
       }
+      hash.merge! rate.to_h if rate
+      hash
     end
 
     private
@@ -30,9 +34,5 @@ module OpenTSDBConsumer
     def tags_to_query
       tags.map { |key, value| [key, value].join '=' }.join(',')
     end
-
-    def rate_to_query
-      'rate' if rate
-    end
   end
 end

data/lib/opentsdb-consumer/rate.rb

@@ -0,0 +1,28 @@
+module OpenTSDBConsumer
+  class Rate
+    attr_reader :options
+
+    def initialize(options_or_true = {})
+      @options = options_or_true.is_a?(Hash) ? options_or_true : {}
+    end
+
+    def to_h
+      hash = { rate: true }
+      hash[:rateOptions] = options if options.any?
+      hash
+    end
+
+    def to_s
+      string = 'rate'
+      string += ":rateOptions{#{compiled_options}}" if options.any?
+      string
+    end
+
+    private
+
+    def compiled_options
+      return '' if options.empty?
+      options.map { |key, value| [key, value].join '=' }.join(',')
+    end
+  end
+end

data/opentsdb-consumer.gemspec

@@ -1,84 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: opentsdb-consumer 0.4.0 ruby lib
+#
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = "opentsdb-consumer"
-  s.version = "0.4.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Philippe H\u{e4}ssig"]
-  s.date = "2016-01-13"
+  s.name        = 'opentsdb-consumer'
+  s.version     = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  s.authors     = ['Philippe Hassig']
+  s.email       = ['phil@nine.ch']
+  s.homepage    = 'http://github.com/ninech/'
+  s.license     = 'MIT'
+  s.summary     = "Client library to consume metrics from OpenTSDB"
   s.description = "Client library to consume metrics from OpenTSDB"
-  s.email = "phil@nine.ch"
-  s.executables = ["opentsdb-consumer"]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".travis.yml",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "bin/opentsdb-consumer",
-    "lib/opentsdb-consumer.rb",
-    "lib/opentsdb-consumer/client.rb",
-    "lib/opentsdb-consumer/errors.rb",
-    "lib/opentsdb-consumer/metric.rb",
-    "lib/opentsdb-consumer/query.rb",
-    "lib/opentsdb-consumer/result.rb",
-    "opentsdb-consumer.gemspec",
-    "spec/opentsdb-consumer/client_spec.rb",
-    "spec/opentsdb-consumer/metric_spec.rb",
-    "spec/opentsdb-consumer/query_spec.rb",
-    "spec/opentsdb-consumer/result_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/ninech/opentsdb-consumer"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.5.1"
-  s.summary = "Client library to consume metrics from OpenTSDB"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<excon>, ["~> 0.45.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 3.3.0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_development_dependency(%q<byebug>, [">= 0"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
-      s.add_development_dependency(%q<coveralls>, [">= 0"])
-    else
-      s.add_dependency(%q<excon>, ["~> 0.45.0"])
-      s.add_dependency(%q<rspec>, ["~> 3.3.0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_dependency(%q<byebug>, [">= 0"])
-      s.add_dependency(%q<pry>, [">= 0"])
-      s.add_dependency(%q<coveralls>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<excon>, ["~> 0.45.0"])
-    s.add_dependency(%q<rspec>, ["~> 3.3.0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-    s.add_dependency(%q<byebug>, [">= 0"])
-    s.add_dependency(%q<pry>, [">= 0"])
-    s.add_dependency(%q<coveralls>, [">= 0"])
-  end
-end
+  s.add_runtime_dependency 'excon', '~> 0.45.0'
 
+  s.add_development_dependency 'rspec', '~> 3.3', '>= 3.3.0'
+  s.add_development_dependency 'rdoc', '~> 3.12'
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'byebug', '~> 0'
+  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'coveralls', '~> 0'
+end

data/spec/opentsdb-consumer/metric_spec.rb

@@ -1,14 +1,20 @@
 require 'spec_helper'
 require 'opentsdb-consumer/metric'
+require 'opentsdb-consumer/rate'
 
 RSpec.describe OpenTSDBConsumer::Metric do
   let(:name) { 'my.metric' }
   let(:aggregator) { 'avg' }
   let(:rate) { false }
   let(:tags) { {} }
+  let(:rate) { false }
   let(:downsample) { '1h-avg' }
   let(:metric) do
-    described_class.new name: name, aggregator: aggregator, rate: rate, tags: tags, downsample: downsample
+    described_class.new name: name,
+                        aggregator: aggregator,
+                        rate: rate,
+                        tags: tags,
+                        downsample: downsample
   end
 
   describe '#to_s' do
@@ -24,14 +30,34 @@ RSpec.describe OpenTSDBConsumer::Metric do
     end
 
     context 'with rate' do
-      let(:rate) { true }
-      it { should eq 'avg:1h-avg:rate:my.metric' }
+      let(:rate) { { counter: true } }
+      it { should eq 'avg:1h-avg:my.metric:rate:rateOptions{counter=true}' }
     end
   end
 
   describe '#to_h' do
     subject { metric.to_h }
 
-    it { should eq(aggregator: aggregator, downsample: downsample, metric: name, rate: rate, tags: tags) }
+    it do
+      should eq(aggregator: aggregator,
+                downsample: downsample,
+                metric: name,
+                tags: tags)
+    end
+
+    context 'with rate options' do
+      let(:rate) { { counter: true } }
+
+      it do
+        should eq(aggregator: aggregator,
+                  downsample: downsample,
+                  metric: name,
+                  rate: true,
+                  rateOptions: {
+                    counter: true
+                  },
+                  tags: tags)
+      end
+    end
   end
 end

data/spec/opentsdb-consumer/query_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe OpenTSDBConsumer::Query do
   let(:response_body) { '[{}]' }
   let(:mock_response) { instance_double 'Excon::Response', status: status, body: response_body }
   let(:expected_query) do
-    { aggregator: 'sum', downsample: '10m-avg', metric: 'my.metric', rate: false, tags: {} }
+    { aggregator: 'sum', downsample: '10m-avg', metric: 'my.metric', tags: {} }
   end
 
   describe '#run' do

data/spec/opentsdb-consumer/rate_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'opentsdb-consumer/rate'
+
+RSpec.describe OpenTSDBConsumer::Rate do
+  describe '#to_s' do
+    subject { described_class.new(options).to_s }
+
+    context 'without options' do
+      let(:options) { {} }
+
+      it { should eq 'rate' }
+    end
+
+    context 'with options' do
+      let(:options) { { counter: true, counterMax: 1337 } }
+
+      it { should eq 'rate:rateOptions{counter=true,counterMax=1337}' }
+    end
+  end
+
+  describe '#to_h' do
+    let(:options) { {} }
+
+    subject { described_class.new(options).to_h }
+
+    it { should eq({ rate: true }) }
+
+    context 'with options' do
+      let(:options) { { counter: true, counterMax: 1337, resetValue: 100 } }
+
+      it do
+        should eq ({
+          rate: true,
+          rateOptions: options,
+        })
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentsdb-consumer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
-- Philippe Hässig
+- Philippe Hassig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -29,6 +29,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0
   type: :development
@@ -36,6 +39,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0
 - !ruby/object:Gem::Dependency
@@ -66,72 +72,58 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: byebug
   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: pry
   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: coveralls
   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'
 description: Client library to consume metrics from OpenTSDB
-email: phil@nine.ch
+email:
+- phil@nine.ch
 executables:
 - opentsdb-consumer
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
 - ".document"
+- ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -146,14 +138,16 @@ files:
 - lib/opentsdb-consumer/errors.rb
 - lib/opentsdb-consumer/metric.rb
 - lib/opentsdb-consumer/query.rb
+- lib/opentsdb-consumer/rate.rb
 - lib/opentsdb-consumer/result.rb
 - opentsdb-consumer.gemspec
 - spec/opentsdb-consumer/client_spec.rb
 - spec/opentsdb-consumer/metric_spec.rb
 - spec/opentsdb-consumer/query_spec.rb
+- spec/opentsdb-consumer/rate_spec.rb
 - spec/opentsdb-consumer/result_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/ninech/opentsdb-consumer
+homepage: http://github.com/ninech/
 licenses:
 - MIT
 metadata: {}
@@ -173,8 +167,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Client library to consume metrics from OpenTSDB
-test_files: []
+test_files:
+- spec/opentsdb-consumer/client_spec.rb
+- spec/opentsdb-consumer/metric_spec.rb
+- spec/opentsdb-consumer/query_spec.rb
+- spec/opentsdb-consumer/rate_spec.rb
+- spec/opentsdb-consumer/result_spec.rb
+- spec/spec_helper.rb