hawkular-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c2bd7524ca6889a513ffac38121ecd21626d26c
+  data.tar.gz: c8a90d9d4a3b042baf12c8fd046601d5442ccce1
+SHA512:
+  metadata.gz: d3015ffa0cb3c714b9141a9b6783539b115c556a617911e931bc5905fd7e10bfa37727bd927a9e629e0021027495c01be5c62af8158810091624ce0a5790a6bb
+  data.tar.gz: 64541ba6774f5f67582586acafd3c806861a51b1dc6452848716c8c552ada2db434b2a3c5be37cfd6aef059023d2fe9873a6b9c5f30ec5f706683701dbfe9006

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# test config
+spec/endpoint.yml

data/CHANGES.rdoc

@@ -0,0 +1,5 @@
+== Changes
+
+This document describes the relevant changes beween releases of the
+_hawkular-client_ project.
+

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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.rdoc

@@ -0,0 +1,33 @@
+= hawkular-client-ruby
+
+A Ruby Hawkular Client.
+
+== Contributing to hawkular-client-ruby
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Running the tests
+
+* Copy the file spec/endpoint.yml.example to spec/endpoint.yml
+* Edit the endpoint properties (user, password and host name)
+* From command line run => rake spec
+
+== Logging
+
+If you want to see API requests and responses, use the following environment
+variables:
+
+    RESTCLIENT_LOG=stdout HAWKULARCLIENT_LOG_RESPONSE=1 rake spec
+
+== Generate documentation
+
+Client documentation can be generated using http://yardoc.org
+
+    yardoc
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = "./spec/**/*_spec.rb"
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec

data/hawkularclient.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metrics/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hawkular-client"
+  gem.version       = Hawkular::Metrics::VERSION
+  gem.authors       = ['Libor Zoubek']
+  gem.email         = ['lzoubek@redhat.com']
+  gem.homepage      = "https://github.com/hawkular/hawkular-client-ruby"
+  gem.summary       = %q{A Ruby client for Hawkular}
+  gem.description   = <<-EOS
+    A Ruby client for Hawkular
+  EOS
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency('rest-client')
+  gem.add_development_dependency('shoulda')
+  gem.add_development_dependency('rspec-rails', '~> 2.6')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('yardoc')
+
+  gem.rdoc_options << '--title' << gem.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
+  gem.extra_rdoc_files = ['README.rdoc', 'CHANGES.rdoc']
+end

data/lib/hawkularclient.rb

@@ -0,0 +1,187 @@
+
+
+require "json"
+require "rest-client"
+
+module Hawkular
+  # Metrics module provides access to Hawkular Metrics REST API
+  # @see http://www.hawkular.org/docs/rest/rest-metrics.html Hawkular Metrics REST API Documentation
+  # @example Create Hawkular-Metrics client and start pushing some metric data
+  #  # create client instance
+  #  client = Hawkular::Metrics::Client::new("http://server","username","password",{"tenant" => "your tenant ID"})
+  #  # push gauge metric data for metric called "myGauge" (no need to create metric definition unless you wish to specify data retention)
+  #  client.gauges.push_data("myGauge", {:value => 3.1415925})
+  module Metrics
+  end
+end
+
+require "metrics/types"
+require "metrics/tenant_api"
+require "metrics/metric_api"
+
+
+module Hawkular::Metrics
+
+  class HawkularException < StandardError
+    def initialize(message)
+      @message = message
+      super
+    end
+
+    def message
+      @message
+    end
+  end
+
+  class Client
+
+    # @!visibility private
+    attr_reader :credentials, :entrypoint, :options
+    # @return [Tenants] access tenants API
+    attr_reader :tenants
+    # @return [Counters] access counters API
+    attr_reader :counters
+    # @return [Gauges] access gauges API
+    attr_reader :gauges
+    # @return [Availability] access counters API
+    attr_reader :avail
+
+    # Construct a new Hawkular Metrics client class.
+    # optional parameters
+    # @param entrypoint [String]
+    # @param username [String]
+    # @param password [String]
+    # @param options [Hash{String=>String}] client options
+    # @example initialize with Hawkular-tenant option
+    #   Hawkular::Metrics::Client::new("http://server","username","password",{"tenant" => "your tenant ID"})
+    #
+    def initialize(entrypoint='http://localhost:8080/hawkular/metrics',username=nil, password=nil, options={})
+      @entrypoint = entrypoint
+      @credentials = { :username => username, :password => password }
+      @options = {
+        :tenant => nil,
+      }.merge(options)
+
+      @tenants = Client::Tenants::new self
+      @counters = Client::Counters::new self
+      @gauges = Client::Gauges::new self
+      @avail = Client::Availability::new self
+    end
+
+
+    def http_get(suburl, headers={})
+      begin
+        res = rest_client(suburl).get(http_headers(headers))
+        puts "#{res}\n" if ENV['HAWKULARCLIENT_LOG_RESPONSE']
+        res.empty? ? {} : JSON.parse(res)
+      rescue
+        handle_fault $!
+      end
+    end
+
+
+    def http_post(suburl, hash, headers={})
+      begin
+        body = JSON.generate(hash)
+        res = rest_client(suburl).post(body, http_headers(headers))
+        puts "#{res}\n" if ENV['HAWKULARCLIENT_LOG_RESPONSE']
+        res.empty? ? {} : JSON.parse(res)
+      rescue
+        handle_fault $!
+      end
+    end
+
+    def http_put(suburl, hash, headers={})
+      begin
+        body = JSON.generate(hash)
+        res = rest_client(suburl).put(body, http_headers(headers))
+        puts "#{res}\n" if ENV['HAWKULARCLIENT_LOG_RESPONSE']
+        res.empty? ? {} : JSON.parse(res)
+      rescue
+        handle_fault $!
+      end
+    end
+
+    def http_delete(suburl, headers={})
+      begin
+        res = rest_client(suburl).delete(http_headers(headers))
+        puts "#{res}\n" if ENV['HAWKULARCLIENT_LOG_RESPONSE']
+        res.empty? ? {} : JSON.parse(res)
+      rescue
+        handle_fault $!
+      end
+    end
+
+
+
+    # @!visibility private
+    def rest_client(suburl)
+      options[:timeout] = ENV['HAWKULARCLIENT_REST_TIMEOUT'] if ENV['HAWKULARCLIENT_REST_TIMEOUT']
+      # strip @endpoint in case suburl is absolute
+      if suburl.match(/^http/)
+        suburl = suburl[@entrypoint.length,suburl.length]
+      end
+      RestClient::Resource.new(@entrypoint, options)[suburl]
+    end
+
+    # @!visibility private
+    def base_url
+      url = URI.parse(@entrypoint)
+      "#{url.scheme}://#{url.host}:#{url.port}"
+    end
+
+    # @!visibility private
+    def self.parse_response(response)
+      JSON.parse(response)
+    end
+
+    # @!visibility private
+    def http_headers(headers ={})
+      {}.merge(auth_header)
+        .merge(tenant_header)
+        .merge({
+          :content_type => 'application/json',
+          :accept => 'application/json',
+        })
+        .merge(headers)
+    end
+
+    # timestamp of current time
+    # @return [Integer] timestamp
+    def now
+      Integer(Time::now.to_f * 1000)
+    end
+
+    private
+
+
+      def tenant_header
+        @options[:tenant].nil? ? {} : { :'Hawkular-Tenant' => @options[:tenant], "tenantId" => @options[:tenant] }
+      end
+
+
+      def auth_header
+        if @credentials[:username].nil? and @credentials[:password].nil?
+          return {}
+        end
+        # This is the method for strict_encode64:
+        encoded_credentials = ["#{@credentials[:username]}:#{@credentials[:password]}"].pack("m0").gsub(/\n/,'')
+        {:authorization => "Basic " + encoded_credentials }
+      end
+
+      def handle_fault(f)
+        if defined? f.http_body and !f.http_body.nil?
+          begin
+            fault = "#{f.errorMsg}\n%s\n" % JSON.parse(f.http_body)["errorMsg"]
+          rescue
+            fault = f.http_body
+            raise HawkularException::new(fault)
+          end
+        else
+          raise f
+        end
+
+      end
+  end
+
+end

data/lib/metrics/metric_api.rb

@@ -0,0 +1,176 @@
+module Hawkular::Metrics
+  class Client
+
+      # @!visibility private
+      def default_timestamp(array)
+        n = now
+        array.each { |p|
+          p[:timestamp] ||= n
+        }
+        array
+      end
+
+
+    # Push data for multiple metrics of all supported types
+    # @param gauges [Array]
+    # @param counters [Array]
+    # @param availabilities [Array]
+    # @example push datapoints of 2 counter metrics
+    #    client = Hawkular::Metrics::client::new
+    #    client.push_data(counters: [{:id => "counter1", :data => [{:value => 1}, {:value => 2}]},{:id => "counter2", :data => [{:value => 1}, {:value => 3}]}])
+    # @example push gauge and availability datapoints
+    #    client.push_data(gauges: [{:id => "gauge1", :data => [{:value => 1}, {:value => 2}]}], availabilities: [{:id => "avail1", :data => [{:value => "up"}]}])
+    def push_data(gauges: [], counters: [], availabilities: [])
+      gauges.each { |g|
+        default_timestamp g[:data]
+      }
+      counters.each { |g|
+        default_timestamp g[:data]
+      }
+      availabilities.each { |g|
+        default_timestamp g[:data]
+      }
+      data = {:gauges => gauges, :counters => counters, :availabilities => availabilities}
+      http_post("/metrics/data", data)
+    end
+
+    # Base class for accessing metric definition and data of all types (counters, gauges, availabilities)
+    class Metrics
+
+      # @param client [Client]
+      # @param metricType [String] metric type (one of "counter", "gauge", "availability")
+      # @param resource [String] REST resource name for accessing metrics of given type (one of "counters", "gauges", "availability")
+      def initialize(client, metricType, resource)
+        @client = client
+        @type = metricType
+        @resource = resource
+      end
+
+      # Create new  metric definition
+      # @param definition [MetricDefinition or Hash] gauge/counter/availability options.
+      # @example Create gauge metric definition using Hash
+      #   client = Hawkular::Metrics::client::new
+      #   client.gauges.create({:id => "id", :dataRetention => 90, :tags => {:tag1 => "value1"}, :tenantId => "your tenant id"})
+      def create(definition)
+        if definition.kind_of?(Hawkular::Metrics::MetricDefinition)
+          definition = definition.hash
+        end
+        @client.http_post('/'+@resource, definition)
+      end
+
+      # Query metric definitions by tags
+      # @param tags [Hash]
+      # @return [Array[MetricDefinition]]
+      def query(tags)
+          tags = tags.map do |k,v|
+            "#{k}:#{v}"
+          end
+          @client.http_get("/metrics/?type=#{@type}&tags=#{tags.join(',')}").map do |g|
+            Hawkular::Metrics::MetricDefinition::new(g)
+          end
+      end
+
+      # Get metric definition by id
+      # @param id [String]
+      # @return [MetricDefinition]
+      def get(id)
+        Hawkular::Metrics::MetricDefinition::new(@client.http_get("/#{@resource}/#{id}"))
+      end
+
+      # update tags for given metric definition
+      # @param metricDefinition [MetricDefinition]
+      def update_tags(metricDefinition)
+        @client.http_put("/#{@resource}/#{metricDefinition.id}/tags",metricDefinition.hash[:tags])
+      end
+
+      # Push metric data
+      # @param id [String] metric definition ID
+      # @param data [Array[Hash]] Single datapoint or array of datapoints
+      # @example Push counter data with timestamp
+      #   client = Hawkular::Metics::Client::new
+      #   now = Integer(Time::now.to_f * 1000)
+      #   client.counters.push_data("counter id", [{:value => 1, :timestamp => now - 1000}, {:value => 2, :timestamp => now}])
+      # @example Push single availability without timestamp
+      #   client.avail.push_data("avail_id", {:value => "up"})
+      # @example Push gague data with tags
+      #   client.gagues.push_data("gauge_id", [{:value => 0.1, :tags => {:tagName => "myMin"}},{:value => 99.9, :tags => {:tagName => "myMax"}}])
+      def push_data(id, data)
+        if !data.kind_of?(Array)
+          data = [data]
+        end
+
+        @client.default_timestamp data
+        @client.http_post("/#{@resource}/#{id}/data", data)
+      end
+
+      # Retrieve metric datapoints
+      # @param id [String] metric definition id
+      # @param starts [Integer] optional timestamp (default now - 8h)
+      # @param ends [Integer] optional timestamp (default now)
+      # @return [Array[Hash]] datapoints
+      # @see #push_data #push_data for datapoint detail
+      def get_data(id, starts: nil, ends: nil)
+        params = {:start => starts, :end => ends}
+        params.delete_if { |k, v| v.nil? }
+        resp = @client.http_get("/#{@resource}/#{id}/data/?"+URI.encode_www_form(params))
+        return [] if !resp.kind_of?(Array) # API returns no content (empty Hash) instead of empty array
+        resp
+      end
+    end
+
+    # Class that interracts with "gauge" metric types
+    class Gauges < Metrics
+
+      # @param client [Client]
+      def initialize(client)
+        super(client, 'gauge', 'gauges')
+      end
+
+      # Retrieve time ranges when given gauge matches given operation and threshold
+      # @param id [String] gauge ID
+      # @param starts [Integer] timestamp (default now - 8h)
+      # @param ends [Integer] timestamp (default now)
+      # @param threshold [Numeric]
+      # @param operation [String] A comparison operation to perform between values and the threshold. Supported operations include "ge", "gte", "lt", "lte", and "eq"
+      # @example Get time periods when metric "gauge1" was under 10 in past 4 hours
+      #   before4h = client.now - (4 * 60 * 60 * 1000)
+      #   client.gauges.get_periods("gauge1", starts: before4h, threshold: 10, operation: "lte")
+      def get_periods(id, starts: nil, ends: nil, threshold:, operation:)
+          params = {:start => starts, :end => ends, :threshold => threshold, :op => operation}
+          params.delete_if { |k, v| v.nil? }
+          @client.http_get("/#{@resource}/#{id}/periods?"+URI.encode_www_form(params))
+      end
+
+    end
+
+    # Class that interracts with "counter" metric types
+    class Counters < Metrics
+
+      # @param client [Client]
+      def initialize(client)
+        super(client, 'counter', 'counters')
+      end
+
+      # get rate for given metric
+      # @param id [String] metric ID
+      def get_rate(id:)
+        @client.http_get("/#{@resource}/#{id}/rate")
+      end
+    end
+
+    # Class that interracts with "availability" metric types
+    class Availability < Metrics
+
+      # @param client [Client]
+      def initialize(client)
+        super(client, 'availability', 'availability')
+      end
+
+    end
+
+
+    private
+
+
+  end
+end

data/lib/metrics/tenant_api.rb

@@ -0,0 +1,27 @@
+module Hawkular::Metrics
+  class Client
+    # Provides access to tenants API
+    class Tenants
+
+      # @param client [Client]
+      def initialize(client)
+        @client = client
+        @resource = "tenants"
+      end
+
+      # Create new tenant
+      # @param id [String] tenant ID/Name
+      def create(id)
+        @client.http_post("/#{@resource}", {:id => id})
+      end
+
+      # Query existing tenants
+      # @return [Array[Tenant]]
+      def query
+        @client.http_get("/#{@resource}").map do |t|
+          Hawkular::Metrics::Tenant::new(t)
+        end
+      end
+    end
+  end
+end

data/lib/metrics/types.rb

@@ -0,0 +1,38 @@
+module Hawkular
+  module Metrics
+    class BaseObject
+      attr_reader :json
+      attr_accessor :id
+
+      def initialize(json)
+        @json = json
+        if !json.nil?
+          @id = @json['id']
+        end
+      end
+    end
+
+    class Tenant < BaseObject
+    end
+
+    class MetricDefinition < BaseObject
+      attr_accessor :tenantId, :dataRetention, :tags
+
+      def initialize(json=nil)
+        super(json)
+        if !json.nil?
+          @tenantId = @json['tenantId']
+          @dataRetention = @json['dataRetention']
+          @tags = @json['tags']
+        end
+      end
+
+      def hash
+        h = {:id => @id, :tenantId => @tenantId, :dataRetention => @dataRetention, :tags => @tags}
+        h.delete_if { |k, v| v.nil? }
+        h
+      end
+
+    end
+  end
+end

data/lib/metrics/version.rb

@@ -0,0 +1,5 @@
+module Hawkular
+  module Metrics
+    VERSION = "0.1.0"
+  end
+end

data/spec/endpoint.yml.example

@@ -0,0 +1,7 @@
+# This is example configuration for integration tests and it should
+# work out-of-box with hawkular in dev environment
+
+url: "http://localhost:8080/hawkular/metrics"
+# authentication is not yet supported in hawkular-metrics 0.5.0
+# user: "jdoe"
+# password: "jdoe"

data/spec/integration/metric_spec.rb

@@ -0,0 +1,243 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+require "securerandom"
+
+# examples related to Hawkular Metrics
+
+
+# time constants
+t4h = 4 * 60 * 60 * 1000
+
+# more or less generic methodc common for all metric types (counters, gauges, availabilities)
+def create_metric_using_hash(endpoint)
+  id = SecureRandom.uuid
+  endpoint.create({:id => id, :dataRetention => 123, :tags => {:some => "value"}, :tenantId => @tenant})
+  metric = endpoint.get(id)
+
+  expect(metric).to be_a(Hawkular::Metrics::MetricDefinition)
+  expect(metric.id).to eql(id)
+  expect(metric.dataRetention).to eql(123)
+  expect(metric.tenantId).to eql(@tenant)
+end
+
+def create_metric_using_md(endpoint)
+  metric = Hawkular::Metrics::MetricDefinition::new
+  metric.id = SecureRandom.uuid
+  metric.dataRetention = 90
+  metric.tags = {:tag => "value"}
+  endpoint.create(metric)
+
+  created = endpoint.get(metric.id)
+  expect(created).to be_a(Hawkular::Metrics::MetricDefinition)
+  expect(created.id).to eql(metric.id)
+  expect(created.dataRetention).to eql(metric.dataRetention)
+end
+
+def push_data_to_non_existing_metric(endpoint, data)
+  id = SecureRandom.uuid
+  # push one value without timestamp (which means now)
+  endpoint.push_data(id, data)
+
+  data = endpoint.get_data(id)
+  expect(data.size).to be 1
+
+  #verify metric was auto-created
+  counter = endpoint.get(id)
+  expect(counter).to be_a(Hawkular::Metrics::MetricDefinition)
+  expect(counter.id).to eql(id)
+end
+
+def update_metric_by_tags(endpoint)
+  id = SecureRandom.uuid
+  endpoint.create({:id => id, :tags => {:myTag => id}})
+  metric = endpoint.get(id)
+  metric.tags = {:newTag => "newValue"}
+  endpoint.update_tags(metric)
+
+  metric = endpoint.get(id)
+  expect(metric.tags).to include({"newTag" => "newValue","myTag" => id})
+
+  # query API for a metric with given tag
+  data = endpoint.query({:myTag => id})
+  expect(data.size).to be 1
+end
+
+describe "Tenants" do
+
+  before(:all) do
+    setup_client
+  end
+
+  it "Should create and return tenant" do
+    tenant = SecureRandom.uuid
+    @client.tenants.create(tenant)
+    created = @client.tenants.query.select { |t|
+      t.id == tenant
+    }
+    expect(created).not_to be nil
+  end
+end
+
+describe "Mixed metrics" do
+
+  before(:all) do
+    setup_client_new_tenant
+  end
+
+  it "Should send mixed metric request of a single type" do
+    id = SecureRandom.uuid
+    @client.push_data(counters:[{:id => id, :data => [{:value => 1}]} ] )
+    data = @client.counters.get_data(id)
+    expect(data.size).to be 1
+
+    @client.push_data(availabilities:[{:id => id, :data => [{:value => "down"}]} ] )
+    data = @client.avail.get_data(id)
+    expect(data.size).to be 1
+
+    @client.push_data(gauges:[{:id => id, :data => [{:value => 1.1}]} ] )
+    data = @client.gauges.get_data(id)
+    expect(data.size).to be 1
+  end
+
+  it "Should send mixed metric request" do
+    id = SecureRandom.uuid
+
+    expect(@client.counters.get_data(id).size).to be 0
+    expect(@client.gauges.get_data(id).size).to be 0
+    expect(@client.avail.get_data(id).size).to be 0
+
+    @client.push_data(
+      counters:[{:id => id, :data => [{:value => 1}]}],
+      availabilities:[{:id => id, :data => [{:value => "down"}]}],
+      gauges:[{:id => id, :data => [{:value => 1.1}]}]
+    )
+
+    expect(@client.counters.get_data(id).size).to be 1
+    expect(@client.gauges.get_data(id).size).to be 1
+    expect(@client.avail.get_data(id).size).to be 1
+  end
+end
+
+describe "Counter metrics" do
+
+  before(:all) do
+    setup_client_new_tenant
+  end
+
+  it "Should create and return counter using Hash parameter" do
+    create_metric_using_hash @client.counters
+  end
+
+  it "Should create counter definition using MetricDefinition parameter" do
+    create_metric_using_md @client.counters
+  end
+
+  it "Should push metric data to existing counter" do
+    id = SecureRandom.uuid
+    #create counter
+    @client.counters.create({:id => id})
+    now = @client.now
+
+    # push 3  values with timestamps
+    @client.counters.push_data(id, [{:value => 1, :timestamp => now - 30}, {:value => 2, :timestamp => now - 20}, {:value => 3, :timestamp => now -10 }])
+
+    data = @client.counters.get_data(id)
+    expect(data.size).to be 3
+
+    # push one value without timestamp (which means now)
+    @client.counters.push_data(id, {:value => 4})
+    data = @client.counters.get_data(id)
+    expect(data.size).to be 4
+
+    # retrieve values from past
+    data = @client.counters.get_data(id, starts: @client.now - (2 * t4h), ends: @client.now - t4h)
+    expect(data.empty?).to be true
+  end
+
+  it "Should push metric data to non-existing counter" do
+    push_data_to_non_existing_metric @client.counters, {:value => 4}
+  end
+
+end
+
+describe "Availability metrics" do
+
+  before(:all) do
+    setup_client_new_tenant
+  end
+
+  it "Should create and return Availability using Hash parameter" do
+    create_metric_using_hash @client.avail
+  end
+
+  it "Should create Availability definition using MetricDefinition parameter" do
+    create_metric_using_md @client.avail
+  end
+
+  it "Should push metric data to non-existing Availability" do
+    push_data_to_non_existing_metric @client.avail, {:value =>"UP"}
+  end
+  it "Should update tags for Availability definition" do
+    update_metric_by_tags @client.avail
+  end
+end
+
+describe "Gauge metrics" do
+
+  before(:all) do
+    setup_client_new_tenant
+  end
+
+  it "Should create gauge definition using MetricDefinition" do
+    create_metric_using_md @client.gauges
+  end
+
+  it "Should create gauge definition using Hash" do
+    create_metric_using_hash @client.gauges
+  end
+
+  it "Should push metric data to non-existing gauge" do
+    push_data_to_non_existing_metric @client.gauges, {:value =>3.1415926}
+  end
+
+  it "Should push metric data to existing gauge" do
+    id = SecureRandom.uuid
+    #create gauge
+    @client.gauges.create({:id => id})
+    now = @client.now
+
+    # push 3  values with timestamps
+    @client.gauges.push_data(id, [{:value => 1, :timestamp => now - 30}, {:value => 2, :timestamp => now - 20}, {:value => 3, :timestamp => now -10 }])
+
+    data = @client.gauges.get_data(id)
+    expect(data.size).to be 3
+
+    # push one value without timestamp (which means now)
+    @client.gauges.push_data(id, {:value => 4})
+    data = @client.gauges.get_data(id)
+    expect(data.size).to be 4
+
+    # retrieve values from past
+    data = @client.counters.get_data(id, starts: @client.now - (2 * t4h), ends: @client.now - t4h)
+    expect(data.empty?).to be true
+  end
+
+  it "Should update tags for gauge definition" do
+    update_metric_by_tags @client.gauges
+  end
+
+  it "Should return periods" do
+    id = SecureRandom.uuid
+    now = @client.now
+    # push 3  values with timestamps
+    @client.gauges.push_data(id, [{:value => 1, :timestamp => now - 30}, {:value => 2, :timestamp => now - 20}, {:value => 3, :timestamp => now}])
+
+    before4h = @client.now - t4h
+    data = @client.gauges.get_periods(id, operation: "lte", threshold: 4, starts: before4h)
+    expect(data.size).to be 1
+    expect(data[0][0]).to eql(now - 30)
+    expect(data[0][1]).to eql(now)
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'hawkularclient'
+require 'rspec/core'
+require 'rspec/mocks'
+require 'socket'
+require 'uri'
+require 'yaml'
+
+module Hawkular::Metrics::RSpec
+
+  def setup_client(options = {})
+    user, password, url = config['user'], config['password'], config['url']
+    @client = Hawkular::Metrics::Client.new(url, user, password, options)
+  end
+
+  def setup_client_new_tenant(options = {})
+	setup_client
+    @tenant = SecureRandom.uuid
+    @client.tenants.create(@tenant)
+    setup_client({:tenant => @tenant})
+  end
+
+  def config
+    @config ||= YAML.load(File.read(File.expand_path("endpoint.yml", File.dirname(__FILE__))))
+  end
+
+end
+
+RSpec.configure do |config|
+  config.include Hawkular::Metrics::RSpec
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,44 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe Hawkular::Metrics::Client do
+  context "client initialization" do
+    it "should accept no option" do
+      Hawkular::Metrics::Client::new("http://localhost:8080/hawkular/metrics","mockuser","mockpass")
+    end
+
+    it "should support no parameters" do
+      Hawkular::Metrics::Client::new()
+    end
+
+    it "should accept Hawkular-Tenant option" do
+      @client = Hawkular::Metrics::Client::new("http://localhost:8080/hawkular/metrics","mockuser","mockpass",{:tenant => "foo"})
+      headers = @client.send(:http_headers)
+      expect(headers[:"Hawkular-Tenant"]).to eql("foo")
+    end
+
+    it "should define subcomponents" do
+      client = Hawkular::Metrics::Client::new()
+      expect(client.tenants).not_to be nil
+      expect(client.counters).not_to be nil
+      expect(client.gauges).not_to be nil
+    end
+
+  end
+
+  context "http comms" do
+    before(:each) do
+      @client = Hawkular::Metrics::Client::new("http://localhost:8080/hawkular/metrics","mockuser","mockpass")
+    end
+
+    it "should add Accept: headers" do
+      headers = @client.send(:http_headers)
+      expect(headers[:accept]).to eql("application/json")
+    end
+
+    it "should keep existing Accept: headers" do
+      value = "application/json; foo=bar;"
+      headers = @client.send(:http_headers, {:accept => value})
+      expect(headers[:accept]).to eql(value)
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: hawkular-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Libor Zoubek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: shoulda
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !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: yardoc
+  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: |2
+      A Ruby client for Hawkular
+email:
+- lzoubek@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGES.rdoc
+files:
+- ".gitignore"
+- CHANGES.rdoc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- hawkularclient.gemspec
+- lib/hawkularclient.rb
+- lib/metrics/metric_api.rb
+- lib/metrics/tenant_api.rb
+- lib/metrics/types.rb
+- lib/metrics/version.rb
+- spec/endpoint.yml.example
+- spec/integration/metric_spec.rb
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb
+homepage: https://github.com/hawkular/hawkular-client-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- hawkular-client
+- "--main"
+- README.rdoc
+- "--line-numbers"
+- "--inline-source"
+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.5
+signing_key: 
+specification_version: 4
+summary: A Ruby client for Hawkular
+test_files:
+- spec/endpoint.yml.example
+- spec/integration/metric_spec.rb
+- spec/spec_helper.rb
+- spec/unit/client_spec.rb
+has_rdoc: