hawkular-client 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed7c1be5e375b0389cf9a4849fb45c78641becd0
-  data.tar.gz: 03c792250b1ba9ed81c25f9ecda174b983c843e2
+  metadata.gz: 5bb18420ad9844b7c10d6e5e4e0df657dce7c172
+  data.tar.gz: 1bcac0ba50a633ecbf512a225c78aae0fb06fdf1
 SHA512:
-  metadata.gz: b5b8f44790e31b63e0574a4d09b510de537275f121d88e93712e24fc33c1e7543ace9e9539f1beb410ff70f1fce8148edee7b4b7431601d7341407f820d4c05c
-  data.tar.gz: b77f46b103e59f10d7568dd1c96de81399192a01fe1fef2038d0f3635fbb8d1a545bcedc785b52bf60cbfea0d29a94eaa2a92f39b7e20f7c6e166057d770bd97
+  metadata.gz: b2adc059140248e2a9abea8c4000ae4df32b6004534b7eb1c1eb02a2f234b5a3294993142abb4e37cc8f4d5319f47a45729fbb1f4c335aac66d978852b271ee8
+  data.tar.gz: 0945f21efb375d356404683b19888fecadc3698dd55e496eb33a727d9cd411caabd2a883e23e13fe77dd829578f4c082d107fbefd8de5756379226133daa51ba

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -9,6 +9,7 @@
 /test/version_tmp/
 /tmp/
 spec/vcr.log
+Gemfile.lock
 
 ## Specific to RubyMotion:
 .dat*
@@ -28,7 +29,7 @@ build/
 
 # 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
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/.rubocop.yml

@@ -1,14 +1,27 @@
-MethodLength:
-  Enabled: false
+# possible values:
+# https://github.com/bbatsov/rubocop/blob/master/config/
+
+#
+# Overrides
+#
+CyclomaticComplexity:
+  Severity: refactor
+Metrics/LineLength:
+  Max: 120
+Metrics/ParameterLists:
+  Max: 8
+#
+# Enabled/Disabled
+#
 ClassLength:
   Enabled: false
-ModuleLength:
+Documentation:
+  Enabled: false
+MethodLength:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
-Documentation:
+ModuleLength:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
-Metrics/LineLength:
-  Max: 100

data/CHANGES.rdoc

@@ -1,12 +1,22 @@
 == Changes
 
-This document describes the relevant changes beween releases of the
+This document describes the relevant changes between releases of the
 _hawkular-client_ project.
 
+=== V 0.2.1
+
+* Add support to create items in inventory
+* Add support to percentiles, limit and order parameters in Metrics API
+* Add support to run operations on WildFly agent via websockets
+* Add support to create items in alerts
+* Add support for auth tokens (can be created by the client on the server)
+* Add support to consume inventory events via websockets
+* Add support to (offline) test websockets by recorded communication (VCR)
+
 === V 0.2.0
 
 * Add support for Hawkular-Inventory and Hawkular-Alerts
-* Reshuffeling of inner classes
+* Reshuffling of inner classes
 * The sub-url that is passed to `http_*` methods is escaped via
   `Addressable::URI.escape()`
 
@@ -18,5 +28,5 @@ _hawkular-client_ project.
 === V 0.1.1
 
 * Add VCR tests
-* Metrics::Client.new now requries a hash for credentials
+* Metrics::Client.new now requires a hash for credentials
 * Code cleanup and enforcement via RuboCop

data/README.rdoc

@@ -1,3 +1,6 @@
+{<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]
+
 = hawkular-client-ruby
 
 A Ruby Hawkular Client.
@@ -10,7 +13,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.
@@ -20,11 +23,14 @@ 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
+    WEBSOCKET_ON=1 rake spec
+(WebSocket communication can't be recorded by VCR)
 
 == Logging
 

data/hawkularclient.gemspec

@@ -6,8 +6,8 @@ require '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'
@@ -22,13 +22,17 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_runtime_dependency('rest-client')
+  gem.add_runtime_dependency('websocket-client-simple', '~> 0.3.0')
+  gem.add_runtime_dependency('addressable')
   gem.add_development_dependency('shoulda')
-  gem.add_development_dependency('rspec-rails', '~> 2.6')
-  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec-rails', '~> 3.0')
+  gem.add_development_dependency('rake', '< 11')
+  gem.add_development_dependency('simple-websocket-vcr', '= 0.0.4')
   gem.add_development_dependency('yard')
   gem.add_development_dependency('webmock')
   gem.add_development_dependency('vcr')
   gem.add_development_dependency('rubocop', '= 0.34.2')
+  gem.add_development_dependency('coveralls')
 
   gem.rdoc_options << '--title' << gem.name <<
     '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'

data/lib/alerts/alerts_api.rb

@@ -2,8 +2,10 @@ require 'hawkular'
 require 'ostruct'
 
 # Alerts module provides access to Hawkular-Alerts.
-# There are two main parts here: Triggers, that define alertable conditions
-# and Alerts that represent a fired trigger.
+# There are three main parts here:
+#   Triggers, that define alertable conditions
+#     Alerts, that represent a fired Alert trigger
+#     Events, that represent a fired Event trigger or an externally injected event (hawkular, not miq event)
 # @see http://www.hawkular.org/docs/rest/rest-alerts.html
 module Hawkular::Alerts
   # Interface to use to talk to the Hawkular-Alerts component.
@@ -11,7 +13,7 @@ module Hawkular::Alerts
   #   http://localhost:8080/hawkular/alerts
   # @param credentials [Hash{String=>String}] Hash of username, password, token(optional)
   class AlertsClient < Hawkular::BaseClient
-    def initialize(entrypoint = nil, credentials = {})
+    def initialize(entrypoint = 'http://localhost:8080/hawkular/alerts', credentials = {})
       @entrypoint = entrypoint
 
       super(entrypoint, credentials)
@@ -53,6 +55,88 @@ module Hawkular::Alerts
       trigger
     end
 
+    # Import multiple trigger or action definitions specified as a hash to the server.
+    # @param [Hash] hash The hash with the trigger and action definitions.
+    #               see the https://git.io/va5UO for more details about the structure
+    # @return [Hash] The newly entities as hash
+    def bulk_import_triggers(hash)
+      http_post 'import/all', hash
+    end
+
+    # Creates the trigger definition.
+    # @param [Trigger] trigger The trigger to be created
+    # @param [Array<Condition>] conditions Array of associated conditions
+    # @param [Array<Dampening>] dampenings Array of associated dampenings
+    # @return [Trigger] The newly created trigger
+    def create_trigger(trigger, conditions = [], dampenings = [], _actions = [])
+      full_trigger = {}
+      full_trigger[:trigger] = trigger.to_h
+      conds = []
+      conditions.each { |c| conds.push(c.to_h) }
+      full_trigger[:conditions] = conds
+      damps = []
+      dampenings.each { |d| damps.push(d.to_h) } unless dampenings.nil?
+      full_trigger[:dampenings] = damps
+
+      http_post 'triggers/trigger', full_trigger
+    end
+
+    # Deletes the trigger definition.
+    # @param [String] trigger_id Id of the trigger to delete
+    def delete_trigger(trigger_id)
+      http_delete "/triggers/#{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)
+      if action_plugin.nil?
+        plugins = http_get('plugins')
+      else
+        plugins = [action_plugin]
+      end
+      ret = {}
+      plugins.each do |p|
+        ret[p] = http_get("/plugins/#{p}")
+      end
+      ret
+    end
+
+    # Creates the action.
+    # @param [String] plugin The id of action definition/plugin
+    # @param [String] action_id The id of action
+    # @param [Hash] properties Troperties of action
+    # @return [Action] The newly created action
+    def create_action(plugin, action_id, properties = {})
+      the_plugin = hawk_escape plugin
+      # Check if plugin exists
+      http_get("/plugins/#{the_plugin}")
+
+      payload = { actionId: action_id, actionPlugin: plugin, properties: properties }
+      ret = http_post('/actions', payload)
+      Trigger::Action.new(ret)
+    end
+
+    # Obtains one action of given action plugin from the server.
+    # @param [String] plugin Id of the action plugin
+    # @param [String] action_id Id of the action
+    # @return [Action] the selected trigger
+    def get_action(plugin, action_id)
+      the_plugin = hawk_escape plugin
+      the_action_id = hawk_escape action_id
+      ret = http_get "/actions/#{the_plugin}/#{the_action_id}"
+      Trigger::Action.new(ret)
+    end
+
+    # Deletes the action of given action plugin.
+    # @param [String] plugin Id of the action plugin
+    # @param [String] action_id Id of the action
+    def delete_action(plugin, action_id)
+      the_plugin = hawk_escape plugin
+      the_action_id = hawk_escape action_id
+      http_delete "/actions/#{the_plugin}/#{the_action_id}"
+    end
+
     # Obtain the alerts for the Trigger with the passed id
     # @param [String] trigger_id Id of the trigger that has fired the alerts
     # @return [Array<Alert>] List of alerts for the trigger. Can be empty
@@ -67,9 +151,11 @@ module Hawkular::Alerts
     end
 
     # List fired alerts
+    # @param [Hash]criteria optional query criteria
     # @return [Array<Alert>] List of alerts in the system. Can be empty
-    def list_alerts
-      ret = http_get('/')
+    def list_alerts(criteria = {})
+      query = generate_query_params(criteria)
+      ret = http_get('/' + query)
       val = []
       ret.each { |a| val.push(Alert.new(a)) }
       val
@@ -109,20 +195,42 @@ module Hawkular::Alerts
 
       true
     end
+
+    # List Events given optional criteria. Criteria keys are strings (not symbols):
+    #  startTime   numeric, milliseconds from epoch
+    #  endTime     numeric, milliseconds from epoch
+    #  eventIds    array of strings
+    #  triggerIds  array of strings
+    #  categories  array of strings
+    #  tags        array of strings, each tag of format 'name|value'. Specify '*' for value to match all values
+    #  thin        boolean, return lighter events (omits triggering data for trigger-generated events)
+    # @param [Hash] criteria optional query criteria
+    # @return [Array<Event>] List of events. Can be empty
+    def list_events(*criteria)
+      query = generate_query_params(*criteria)
+      http_get('/events' + query).map { |e| Event.new(e) }
+    end
   end
 
   # Representation of one Trigger
+  ## (22 known properties: "enabled", "autoResolveMatch", "name", "memberOf", "autoEnable",
+  # "firingMatch", "tags", "id", "source", "tenantId", "eventText", "context", "eventType",
+  # "autoResolveAlerts", "dataIdMap", "eventCategory", "autoDisable", "type", "description",
+  # "severity", "autoResolve", "actions"])
   class Trigger
-    attr_reader :id, :name, :context, :actions, :auto_disable, :auto_enable
-    attr_reader :auto_resolve, :auto_resolve_alerts
-    attr_reader :tenant, :description, :group, :severity
-    attr_reader :conditions, :dampenings, :event_type
-    attr_accessor :enabled
+    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_reader :conditions, :dampenings
+    attr_accessor :enabled, :actions
 
     def initialize(trigger_hash)
+      return if trigger_hash.nil?
+
       @_hash = trigger_hash
       @conditions = []
       @dampenings = []
+      @actions = []
       @id = trigger_hash['id']
       @name = trigger_hash['name']
       @enabled = trigger_hash['enabled']
@@ -134,41 +242,71 @@ module Hawkular::Alerts
       @description = trigger_hash['description']
       @auto_enable = trigger_hash['autoEnable']
       @auto_disable = trigger_hash['autoDisable']
+      @context = trigger_hash['context']
+      @type = trigger_hash['type']
+      @tags = trigger_hash['tags']
+      # acts = trigger_hash['actions']
+      # acts.each { |a| @actions.push(Action.new(a)) } unless acts.nil?
     end
 
-    #     def enable
-    #       @enabled = true
-    #       @_hash['enabled'] = true
-    #       url = '/triggers/' + @id
-    #       Hawkular::BaseClient.http_put(url, @_hash)
-    #     end
-    #
-    #     def disable
-    #       @enabled = false
-    #       url = '/triggers/' + @id
-    #       AlertsClient.http_put(url, self)
-    #     end
+    def to_h
+      trigger_hash = {}
+      to_camel = lambda do |x|
+        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.each do |field|
+        camelized_field = to_camel.call(field)
+        field_value = __send__ field
+        trigger_hash[camelized_field] = field_value unless field_value.nil?
+      end
+
+      trigger_hash['tenantId'] = @tenant unless @tenant.nil?
+      trigger_hash['actions'] = []
+      @actions.each { |d| trigger_hash['actions'].push d.to_h }
+
+      trigger_hash
+    end
 
     # Representing of one Condition
     class Condition
-      attr_reader :condition_id, :type, :operator_low, :operator_high, :threshold_low
-      attr_reader :in_range, :threshold_high
+      attr_accessor :condition_id, :type, :operator, :threshold
+      attr_accessor :trigger_mode, :data_id
+      attr_reader :condition_set_size, :condition_set_index, :trigger_id
 
       def initialize(cond_hash)
         @condition_id = cond_hash['conditionId']
         @type = cond_hash['type']
-        @operator_low = cond_hash['operatorLow']
-        @operator_high = cond_hash['operatorHigh']
-        @threshold_low = cond_hash['thresholdLow']
-        @threshold_high = cond_hash['thresholdHigh']
-        @in_range = cond_hash['inRange']
+        @operator = cond_hash['operator']
+        @threshold = cond_hash['threshold']
+        @type = cond_hash['type']
+        @trigger_mode = cond_hash['triggerMode']
+        @data_id = cond_hash['dataId']
+        @trigger_id = cond_hash['triggerId']
+      end
+
+      def to_h
+        cond_hash = {}
+        cond_hash['conditionId'] = @condition_id
+        cond_hash['type'] = @type
+        cond_hash['operator'] = @operator
+        cond_hash['threshold'] = @threshold
+        cond_hash['type'] = @type
+        cond_hash['triggerMode'] = @trigger_mode
+        cond_hash['dataId'] = @data_id
+        cond_hash['triggerId'] = @trigger_id
+        cond_hash
       end
     end
 
     # Representation of one Dampening setting
     class Dampening
-      attr_reader :dampening_id, :type, :eval_true_setting, :eval_total_setting, :eval_time_setting
-      attr_reader :current_evals
+      attr_accessor :dampening_id, :type, :eval_true_setting, :eval_total_setting,
+                    :eval_time_setting
+      attr_accessor :current_evals
 
       def initialize(damp_hash)
         @current_evals = {}
@@ -179,15 +317,47 @@ module Hawkular::Alerts
         @eval_time_setting = damp_hash['evalTimeSetting']
       end
     end
+
+    class Action
+      attr_accessor :action_plugin, :action_id, :states, :tenant_id
+
+      def initialize(action_hash)
+        return if action_hash.nil?
+
+        @action_plugin = action_hash['actionPlugin']
+        @action_id = action_hash['actionId']
+        @tenant_id = action_hash['tenantId']
+        @states = action_hash['states']
+      end
+
+      def to_h
+        action_hash = {}
+        action_hash['actionPlugin'] = @action_plugin
+        action_hash['actionId'] = @action_id
+        action_hash['tenantId'] = @tenant_id
+        action_hash['states'] = @states
+        action_hash
+      end
+    end
   end
 
   # Representation of one alert.
   # The name of the members are literally what they are in the JSON sent from the
-  # server and not 'rubyfied'. So 'alertId' and not 'alert_ic'
+  # server and not 'rubyfied'. So 'alertId' and not 'alert_id'
   # Check http://www.hawkular.org/docs/rest/rest-alerts.html#Alert for details
   class Alert < OpenStruct
     def initialize(alert_hash)
       super(alert_hash)
     end
   end
+
+  # Representation of one event.
+  # The name of the members are literally what they are in the JSON sent from the
+  # server and not 'rubyfied'. So 'eventId' and not 'event_id'
+  # Check http://www.hawkular.org/docs/rest/rest-alerts.html#Event for details
+  class Event < OpenStruct
+    def initialize(event_hash)
+      super(event_hash)
+    end
+  end
 end