hawkular-client 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3f91327af0cba7955ceeabb25999cafb2e29331
-  data.tar.gz: 8b6efcd11c9fbab70e57f4a36b6b4f8babafb38a
+  metadata.gz: f5ef004e3d7f65c23d6519f703d3fe8cec0f02da
+  data.tar.gz: 8e3c54a206009a3e4aa9028a5dcf763156883bc4
 SHA512:
-  metadata.gz: fe4775cc86dff4e7778df1c6fafc48dda3da8581a2afcb02ed3f1be0a8c76ba251da0a7a49b60e17bcd816325b67fbaa0c9bfbd1f669a89679774f6d7b465ea6
-  data.tar.gz: 40143d8e9afefdb08eac2b1ff8ee0c6c9f4dd1116283cddf17a5fcb5869172380421d652ccebbdbb0f5e7899a4d157d682ac1230627e3cf842ef6575f9e2bc60
+  metadata.gz: da305496d926efb03b970a52ce00f20109dfc08a1952bfe63fd8d0d5289c156ab0ae1a1f625ed2c1720a38e30c4d45b8992b397652bcb3f22bd0dea0f216f0db
+  data.tar.gz: 3b1674b21b0fc2d4defc566f5666dbbcf923fe8752ccaf97d64256a633a2ac5541b11d6037ee3a70583227d3a0bbdb8b6d2183cf4a81ca7d389ccbed7932413c

data/.rubocop.yml

@@ -5,7 +5,10 @@
 # Overrides
 #
 CyclomaticComplexity:
+  Max: 9
   Severity: refactor
+PerceivedComplexity:
+  Max: 9
 Metrics/LineLength:
   Max: 120
 Metrics/ParameterLists:

data/.yardopts

@@ -0,0 +1 @@
+- CHANGES.rdoc api_breaking_changes.rdoc

data/CHANGES.rdoc

@@ -3,6 +3,19 @@
 This document describes the relevant changes between releases of the
 _hawkular-client_ project.
 
+=== V 1.0.0
+* This major release contains changes that <b>may break the backward compatibility</b>, more info here: link:api_breaking_changes.rdoc
+* To use the client use the <code>require 'hawkular/hawkular_client'</code> instead of <code>require 'hawkular_all'</code>
+* Inventory client has been rewritten to use the cannonical paths
+* New supoort for group triggers in alert sub-client
+* New method for creating event in the hawkular alert component
+* New method for listing the available operation types on a resource type in inventory
+* Hawkular-Tenant HTTP header is automatically added to each HTTP request
+* New support for proxy option in the internal rest_client
+* Improved VCR tests - some changing parameters in the data can be parametrized and the cassettes are stored as templates. Now, it's also possible to record those templates with <code>VCR_UPDATE=1</code>
+* Tests are run also on ruby 2.3.0
+* Couple of new tests
+
 === V 0.2.2
 
 * Bug fix to correctly read resource info for resources that are not directly below a feed.
@@ -22,16 +35,16 @@ _hawkular-client_ project.
 
 * Add support for Hawkular-Inventory and Hawkular-Alerts
 * Reshuffling of inner classes
-* The sub-url that is passed to `http_*` methods is escaped via
-  `Addressable::URI.escape()`
+* The sub-url that is passed to +http_*+ methods is escaped via
+  +Addressable::URI.escape()+
 
 
 === V 0.1.2
 
-* Fix exception handling - this was missing `require 'English'`
+* Fix exception handling - this was missing <code>require 'English'</code>
 
 === V 0.1.1
 
 * Add VCR tests
-* Metrics::Client.new now requires a hash for credentials
+* +Metrics::Client.new+ now requires a hash for credentials
 * Code cleanup and enforcement via RuboCop

data/README.rdoc

@@ -1,10 +1,18 @@
-{<img src="https://coveralls.io/repos/github/hawkular/hawkular-client-ruby/badge.svg?branch=master" alt="Coverage Status" />}[https://coveralls.io/github/hawkular/hawkular-client-ruby?branch=master]
 {<img src="https://travis-ci.org/hawkular/hawkular-client-ruby.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/hawkular/hawkular-client-ruby]
+{<img src="https://coveralls.io/repos/github/hawkular/hawkular-client-ruby/badge.svg?branch=master" alt="Coverage Status" />}[https://coveralls.io/github/hawkular/hawkular-client-ruby?branch=master]
+{<img src="https://codeclimate.com/github/hawkular/hawkular-client-ruby/badges/gpa.svg" />}[https://codeclimate.com/github/hawkular/hawkular-client-ruby]
 
 = hawkular-client-ruby
 
 A Ruby Hawkular Client.
 
+Documentation[http://www.hawkular.org/hawkular-client-ruby/]
+
+== Changelog
+
+See {CHANGELOG}[link:file.CHANGES.html] for a list of changes and 
+{API-Breaking-Changes}[link:file.api_breaking_changes.html] for a list of api-breaking changes.
+
 == 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
@@ -13,7 +21,7 @@ A Ruby Hawkular Client.
 * 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.
-* Run your code through RuboCop (which is default when running `rake`) and fix complaints.
+* Run your code through RuboCop (which is default when running +rake+) and fix complaints.
 * When you open a pull request, watch out for failures on Travis.
 * 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 we can cherry-pick around it.
@@ -23,14 +31,15 @@ A Ruby Hawkular Client.
 Integration tests are recorded and played against cassettes recorded with VCR
 (http://www.relishapp.com/vcr/vcr/docs)
 
-* Edit the endpoint properties in the file `spec/endpoint.yml`(user, password and host name) if needed
+* Edit the endpoint properties in the file +spec/endpoint.yml+ (user, password and host name) if needed
 * From command line run
     rake spec
-* To run the tests against a live server, set VCR_OFF to 1 as in
+* To run the tests against a live server, set +VCR_OFF+ to +1+ as in
     VCR_OFF=1 rake spec
-* To run the tests for operations against a live server using the WebSockets, set WEBSOCKET_ON to 1 as in
+* To update the VCR tapes that supports it, set +VCR_UPDATE+ to +1+ as in
+    VCR_UPDATE=1 rake spec
+* To run the tests for operations against a live server using the WebSockets, set +WEBSOCKET_ON+ to +1+ as in
     WEBSOCKET_ON=1 rake spec
-(WebSocket communication can't be recorded by VCR)
 
 == Logging
 

data/api_breaking_changes.rdoc

@@ -0,0 +1,79 @@
+== Breaking changes in the major releases
+
+=== 1.0.0
+
+To use the client use the <code>require 'hawkular/hawkular_client'</code> instead of <code>require 'hawkular_all'</code>
+
+---
+
+While it's still possible to use individual component clients (inventory, alert, metrics, operation, token), the preferred way is to use
+the unified client that has reference on those 'sub-clients':
+
+<code>::Hawkular::Client.new(:entrypoint => 'http://localhost:8080', :credentials => {username: 'jdoe', password: 'password'})</code>
+
+See the link:spec/integraion/hawkular_client_spec.rb to see more details.
+
+
+---
+
+In the <code>lib/hawkular/inventory/inventory_api.rb</code> all following methods have different signatures (+old+ -> +new+):
+
+<code>list_resources_for_type(feed_id, type, fetch_properties = false)</code>
+->
+<code>list_resources_for_type(type_path, fetch_properties = false, filter = {})</code>
+
+
+<code>get_config_data_for_resource(feed_id, res_ids)</code>
+->
+<code>get_config_data_for_resource(resource_path)</code>
+
+
+<code>def list_child_resources(Resource parent_resource, recursive = false)</code>
+->
+<code>def list_child_resources(parent_resource_path, recursive = false)</code>
+
+
+<code>list_relationships(Resource resource, named = nil)</code>
+->
+<code>list_relationships(path, named = nil)</code>
+
+
+<code>list_relationships_for_feed(feed_id, named = nil)</code>
+->
+<code>list_relationships_for_feed(path, named = nil)</code>
+
+
+<code>list_metrics_for_metric_type(feed_id, type)</code>
+->
+<code>list_metrics_for_metric_type(met_type_path)</code>
+
+
+<code>list_metrics_for_resource_type(feed, type)</code>
+->
+<code>list_metrics_for_resource_type(res_type_path)</code>
+
+
+<code>list_metrics_for_resource(Resource resource, filter = {})</code>
+->
+<code>list_metrics_for_resource(resource_path, filter = {})</code>
+
+
+<code>create_resource(feed_id, type_path, resource_id, resource_name = nil, properties = {})</code>
+->
+<code>create_resource(type_path, resource_id, resource_name = nil, properties = {})</code>
+
+
+<code>create_resource_under_resource(feed_id, type_path, parent_resource_ids, resource_id, resource_name = nil, properties = {})</code>
+->
+<code>create_resource_under_resource(type_path, parent_resource_path, resource_id, resource_name = nil, properties = {})</code>
+
+
+<code>get_resource(feed_id, res_ids, fetch_resource_config = true)</code>
+->
+<code>get_resource(res_path, fetch_resource_config = true)</code>
+
+
+<code>create_metric_for_resource(feed_id, metric_id, type_path, res_ids, metric_name = nil)</code>
+->
+<code>create_metric_for_resource(metric_type_path, resource_path, metric_id, metric_name = nil)</code>
+

data/hawkularclient.gemspec

@@ -1,16 +1,16 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
+require 'hawkular/version'
 
 Gem::Specification.new do |gem|
   gem.name          = 'hawkular-client'
   gem.version       = Hawkular::VERSION
-  gem.authors       = ['Libor Zoubek', 'Heiko W. Rupp', 'Federico Simoncelli']
-  gem.email         = %w(lzoubek@redhat.com hrupp@redhat.com)
+  gem.authors       = ['Libor Zoubek', 'Heiko W. Rupp', 'Jirka Kremser', 'Federico Simoncelli']
+  gem.email         = %w(lzoubek@redhat.com hrupp@redhat.com jkremser@redhat.com)
   gem.homepage      = 'https://github.com/hawkular/hawkular-client-ruby'
   gem.summary       = 'A Ruby client for Hawkular'
-  gem.license       = 'ASL 2.0'
+  gem.license       = 'Apache-2.0'
   gem.required_ruby_version = '>= 2.0.0'
   gem.description = <<-EOS
     A Ruby client for Hawkular
@@ -27,8 +27,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('shoulda')
   gem.add_development_dependency('rspec-rails', '~> 3.0')
   gem.add_development_dependency('rake', '< 11')
+  gem.add_development_dependency('simple-websocket-vcr', '= 0.0.7')
   gem.add_development_dependency('yard')
-  gem.add_development_dependency('webmock')
+  gem.add_development_dependency('webmock', '~> 1.24.0')
   gem.add_development_dependency('vcr')
   gem.add_development_dependency('rubocop', '= 0.34.2')
   gem.add_development_dependency('coveralls')

data/lib/{alerts → hawkular/alerts}/alerts_api.rb

@@ -1,4 +1,4 @@
-require 'hawkular'
+require 'hawkular/base_client'
 require 'ostruct'
 
 # Alerts module provides access to Hawkular-Alerts.
@@ -81,12 +81,95 @@ module Hawkular::Alerts
       http_post 'triggers/trigger', full_trigger
     end
 
+    # Creates the group trigger definition.
+    # @param [Trigger] trigger The group trigger to be created
+    # @return [Trigger] The newly created group trigger
+    def create_group_trigger(trigger)
+      ret = http_post 'triggers/groups', trigger.to_h
+      Trigger.new(ret)
+    end
+
+    # Updates a given group trigger definition
+    # @param [Trigger] trigger the group trigger to be updated
+    # @return [Trigger] The updated group trigger
+    def update_group_trigger(trigger)
+      http_put "triggers/groups/#{trigger.id}/", trigger.to_h
+      get_single_trigger trigger.id, false
+    end
+
+    # Creates the group conditions definitions.
+    # @param [String] trigger_id ID of the group trigger to set conditions
+    # @param [String] trigger_mode Mode of the trigger where conditions are attached (:FIRING, :AUTORESOLVE)
+    # @param [GroupConditionsInfo] group_conditions_info the conditions to set into the group trigger with the mapping
+    #                                                    with the data_id members map
+    # @return [Array<Condition>] conditions Array of associated conditions
+    def set_group_conditions(trigger_id, trigger_mode, group_conditions_info)
+      ret = http_put "triggers/groups/#{trigger_id}/conditions/#{trigger_mode}", group_conditions_info.to_h
+      conditions = []
+      ret.each { |c| conditions.push(Trigger::Condition.new(c)) }
+      conditions
+    end
+
+    # Creates a member trigger
+    # @param [GroupMemberInfo] group_member_info the group member to be added
+    # @return [Trigger] the newly created member trigger
+    def create_member_trigger(group_member_info)
+      ret = http_post 'triggers/groups/members', group_member_info.to_h
+      Trigger.new(ret)
+    end
+
+    # Detaches a member trigger from its group trigger
+    # @param [String] trigger_id ID of the member trigger to detach
+    # @return [Trigger] the orphan trigger
+    def orphan_member(trigger_id)
+      http_post "triggers/groups/members/#{trigger_id}/orphan", {}
+      get_single_trigger trigger_id, false
+    end
+
+    # Lists members of a group trigger
+    # @param [String] trigger_id ID of the group trigger to list members
+    # @param [boolean] orphans flag to include orphans
+    # @return [Array<Trigger>] Members found
+    def list_members(trigger_id, orphans = false)
+      ret = http_get "triggers/groups/#{trigger_id}/members?includeOrphans=#{orphans}"
+      ret.collect { |t| Trigger.new(t) }
+    end
+
+    # Creates a dampening for a group trigger
+    # @param [Dampening] dampening the dampening to create
+    # @return [Dampening] the newly created dampening
+    def create_group_dampening(dampening)
+      ret = http_post "triggers/groups/#{dampening.trigger_id}/dampenings", dampening.to_h
+      Trigger::Dampening.new(ret)
+    end
+
+    # Updates a dampening for a group trigger
+    # @param [Dampening] dampening the dampening to update
+    # @return [Dampening] the updated dampening
+    def update_group_dampening(dampening)
+      ret = http_put "triggers/groups/#{dampening.trigger_id}/dampenings/#{dampening.dampening_id}", dampening.to_h
+      Trigger::Dampening.new(ret)
+    end
+
+    # Deletes the dampening of a group trigger
+    # @param [String] trigger_id ID of the group trigger
+    # @param [String] dampening_id ID
+    def delete_group_dampening(trigger_id, dampening_id)
+      http_delete "/triggers/groups/#{trigger_id}/dampenings/#{dampening_id}"
+    end
+
     # Deletes the trigger definition.
-    # @param [String] trigger_id Id of the trigger to delete
+    # @param [String] trigger_id ID of the trigger to delete
     def delete_trigger(trigger_id)
       http_delete "/triggers/#{trigger_id}"
     end
 
+    # Deletes the group trigger definition.
+    # @param [String] trigger_id ID of the group trigger to delete
+    def delete_group_trigger(trigger_id)
+      http_delete "/triggers/groups/#{trigger_id}"
+    end
+
     # Obtains action definition/plugin from the server.
     # @param [String] action_plugin Id of the action plugin to fetch. If nil, all the plugins are fetched
     def get_action_definition(action_plugin = nil)
@@ -210,6 +293,22 @@ module Hawkular::Alerts
       query = generate_query_params(*criteria)
       http_get('/events' + query).map { |e| Event.new(e) }
     end
+
+    # Inject an event into Hawkular-alerts
+    # @param [String] id Id of the event must be unique
+    # @param [String] category Event category for further distinction
+    # @param [String] text Some text to the user
+    # @param [Hash<String,Object>] extras additional parameters
+    def create_event(id, category, text, extras)
+      event = {}
+      event['id'] = id
+      event['ctime'] = Time.now.to_i * 1000
+      event['category'] = category
+      event['text'] = text
+      event.merge!(extras) { |_key, v1, _v2| v1 }
+
+      http_post('/events', event)
+    end
   end
 
   # Representation of one Trigger
@@ -220,7 +319,7 @@ module Hawkular::Alerts
   class Trigger
     attr_accessor :id, :name, :context, :actions, :auto_disable, :auto_enable
     attr_accessor :auto_resolve, :auto_resolve_alerts, :tags, :type
-    attr_accessor :tenant, :description, :group, :severity, :event_type
+    attr_accessor :tenant, :description, :group, :severity, :event_type, :event_category, :member_of, :data_id_map
     attr_reader :conditions, :dampenings
     attr_accessor :enabled, :actions
 
@@ -238,6 +337,9 @@ module Hawkular::Alerts
       @auto_resolve = trigger_hash['autoResolve']
       @auto_resolve_alerts = trigger_hash['autoResolveAlerts']
       @event_type = trigger_hash['eventType']
+      @event_category = trigger_hash['eventCategory']
+      @member_of = trigger_hash['memberOf']
+      @data_id_map = trigger_hash['dataIdMap']
       @tenant = trigger_hash['tenantId']
       @description = trigger_hash['description']
       @auto_enable = trigger_hash['autoEnable']
@@ -255,8 +357,8 @@ module Hawkular::Alerts
         ret = x.to_s.split('_').collect(&:capitalize).join
         ret[0, 1].downcase + ret[1..-1]
       end
-      fields = [:id, :name, :enabled, :severity, :auto_resolve, :auto_resolve_alerts, :event_type,
-                :description, :auto_enable, :auto_disable, :context, :type, :tags]
+      fields = [:id, :name, :enabled, :severity, :auto_resolve, :auto_resolve_alerts, :event_type, :event_category,
+                :description, :auto_enable, :auto_disable, :context, :type, :tags, :member_of, :data_id_map]
 
       fields.each do |field|
         camelized_field = to_camel.call(field)
@@ -274,7 +376,7 @@ module Hawkular::Alerts
     # Representing of one Condition
     class Condition
       attr_accessor :condition_id, :type, :operator, :threshold
-      attr_accessor :trigger_mode, :data_id
+      attr_accessor :trigger_mode, :data_id, :data2_id, :data2_multiplier
       attr_reader :condition_set_size, :condition_set_index, :trigger_id
 
       def initialize(cond_hash)
@@ -285,6 +387,8 @@ module Hawkular::Alerts
         @type = cond_hash['type']
         @trigger_mode = cond_hash['triggerMode']
         @data_id = cond_hash['dataId']
+        @data2_id = cond_hash['data2Id']
+        @data2_multiplier = cond_hash['data2Multiplier']
         @trigger_id = cond_hash['triggerId']
       end
 
@@ -297,25 +401,82 @@ module Hawkular::Alerts
         cond_hash['type'] = @type
         cond_hash['triggerMode'] = @trigger_mode
         cond_hash['dataId'] = @data_id
+        cond_hash['data2Id'] = @data2_id
+        cond_hash['data2Multiplier'] = @data2_multiplier
         cond_hash['triggerId'] = @trigger_id
         cond_hash
       end
     end
 
+    # Representing of one GroupConditionsInfo
+    # - The data_id_member_map should be null if the group has no members.
+    # - The data_id_member_map should be null if this is a [data-driven] group trigger.
+    #   In this case the member triggers are removed and will be re-populated as incoming data demands.
+    # - For [non-data-driven] group triggers with existing members the data_id_member_map is handled as follows.
+    #   For members not included in the dataIdMemberMap their most recently supplied dataIdMap will be used.
+    #   This means that it is not necessary to supply mappings if the new condition set uses only dataIds found
+    #   in the old condition set. If the new conditions introduce new dataIds a full dataIdMemberMap must be supplied.
+    class GroupConditionsInfo
+      attr_accessor :conditions, :data_id_member_map
+
+      def initialize(conditions)
+        @conditions = conditions
+        @data_id_member_map = {}
+      end
+
+      def to_h
+        cond_hash = {}
+        cond_hash['conditions'] = []
+        @conditions.each { |c| cond_hash['conditions'].push(c.to_h) }
+        cond_hash['dataIdMemberMap'] = @data_id_member_map
+        cond_hash
+      end
+    end
+
+    # Representing of one GroupMemberInfo
+    class GroupMemberInfo
+      attr_accessor :group_id, :member_id, :member_name, :member_description
+      attr_accessor :member_context, :member_tags, :data_id_map
+
+      def to_h
+        cond_hash = {}
+        cond_hash['groupId'] = @group_id
+        cond_hash['memberId'] = @member_id
+        cond_hash['memberName'] = @member_name
+        cond_hash['memberDescription'] = @member_description
+        cond_hash['memberContext'] = @member_context
+        cond_hash['memberTags'] = @member_tags
+        cond_hash['dataIdMap'] = @data_id_map
+        cond_hash
+      end
+    end
+
     # Representation of one Dampening setting
     class Dampening
-      attr_accessor :dampening_id, :type, :eval_true_setting, :eval_total_setting,
+      attr_accessor :dampening_id, :trigger_id, :type, :eval_true_setting, :eval_total_setting,
                     :eval_time_setting
       attr_accessor :current_evals
 
       def initialize(damp_hash)
         @current_evals = {}
         @dampening_id = damp_hash['dampeningId']
+        @trigger_id = damp_hash['triggerId']
         @type = damp_hash['type']
         @eval_true_setting = damp_hash['evalTrueSetting']
         @eval_total_setting = damp_hash['evalTotalSetting']
         @eval_time_setting = damp_hash['evalTimeSetting']
       end
+
+      def to_h
+        cond_hash = {}
+        cond_hash['dampeningId'] = @dampening_id
+        cond_hash['triggerId'] = @trigger_id
+        cond_hash['type'] = @type
+        cond_hash['evalTrueSetting'] = @eval_true_setting
+        cond_hash['evalTotalSetting'] = @eval_total_setting
+        cond_hash['evalTimeSetting'] = @eval_time_setting
+        cond_hash
+      end
     end
 
     class Action