diplomat 2.5.0 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d49b45dca93184126a7c0762ee8a56e878ef35c578d1e437b8831f01e3956ab
-  data.tar.gz: e3c5bf7d7cfbf00a6b4672a88038427c22adb3f6121f6d11e67f402d65bb8bff
+  metadata.gz: 602c9e392d4e521d6b749aa0b9cfb46cead8e1a16547c6e62f480e12230bbde5
+  data.tar.gz: 67fac5cfa5529c346e3a7deb2108dda46aeda3c728b4376b347a34b9781edded
 SHA512:
-  metadata.gz: 888579ae16fade603364f7f8aa671c172b2563fcff913d5f5361686406d0ae248e6365ee9c89532dd3127f540d4a41227c6663ad4055cf0d6868f7460b9b75d2
-  data.tar.gz: 484da6f36e8207472912d7b107b8812f008791d83833967902b4e1b21af5cd90ad1ed4c6417c2d83dd466d6792c4b3c01a2d7a3bd035d3c41a28c2f61a0bc370
+  metadata.gz: e75b590b288dec5984484dca08ae682459fae2855cad9e09566b9d6f5cff151a53522b698e19542d986a8b1a6682f57f567e353f17d1c8166212d92e19f41a6c
+  data.tar.gz: 1d0f7b3878d1431a2e45525cd9ac74d11965a051141ef245e4fd884a8848ee8f1bf09ab356daa10914392152f5be7b10c81880ce934f0a6775a8e91e54163870

data/README.md

@@ -331,6 +331,40 @@ Get the health status from autopilot
 Diplomat::Autopilot.get_health()
 ```
 
+### Health
+
+Retrieve health of a node
+
+```ruby
+Diplomat::Health.node('fooNode', :dc => 'abc')
+```
+
+Retrieve health of a given check
+
+```ruby
+Diplomat::Health.checks('fooCheck', :dc => 'abc')
+```
+
+Retrieve health of a given service
+
+```ruby
+Diplomat::Health.service('fooService', :dc => 'abc')
+```
+
+Retrieve a list of anything that correspond to the state ("any", "passing", "warning", or "critical")
+You can use filters too !
+
+```ruby
+Diplomat::Health.state("critical", {:dc => 'abc', :filter => 'Node==foo'})
+```
+
+You also have some convenience method (`any`, `passing`, `warning`, `critical`)
+That can be filtered
+
+```ruby
+Diplomat::Health.critical({:dc => 'abc', :filter => 'Service==foo'})
+```
+
 ### Maintenance mode
 
 Enable maintenance mode on a host, with optional reason and DC (requires access to local agent)

data/lib/diplomat/health.rb

@@ -33,17 +33,25 @@ module Diplomat
     # Get service health
     # @param s [String] the service
     # @param options [Hash] options parameter hash
+    # @param meta [Hash] output structure containing header information about the request (index)
     # @return [OpenStruct] all data associated with the node
     # rubocop:disable Metrics/PerceivedComplexity
-    def service(s, options = {})
+    def service(s, options = {}, meta = nil)
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
       custom_params << ['passing'] if options[:passing]
       custom_params += [*options[:tag]].map { |value| use_named_parameter('tag', value) } if options[:tag]
       custom_params << use_named_parameter('near', options[:near]) if options[:near]
       custom_params << use_named_parameter('node-meta', options[:node_meta]) if options[:node_meta]
+      custom_params << use_named_parameter('index', options[:index]) if options[:index]
 
       ret = send_get_request(@conn, ["/v1/health/service/#{s}"], options, custom_params)
+      if meta && ret.headers
+        meta[:index] = ret.headers['x-consul-index'] if ret.headers['x-consul-index']
+        meta[:knownleader] = ret.headers['x-consul-knownleader'] if ret.headers['x-consul-knownleader']
+        meta[:lastcontact] = ret.headers['x-consul-lastcontact'] if ret.headers['x-consul-lastcontact']
+      end
+
       JSON.parse(ret.body).map { |service| OpenStruct.new service }
     end
 
@@ -51,35 +59,44 @@ module Diplomat
 
     # Get service health
     # @param s [String] the state ("any", "passing", "warning", or "critical")
-    # @param options [Hash] :dc string for dc specific query
+    # @param options [Hash] :dc, :near, :filter string for specific query
     # @return [OpenStruct] all data associated with the node
     def state(s, options = {})
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
       custom_params << use_named_parameter('near', options[:near]) if options[:near]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/state/#{s}"], options, custom_params)
       JSON.parse(ret.body).map { |status| OpenStruct.new status }
     end
 
     # Convenience method to get services in any state
-    def any
-      state('any')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def any(options = {})
+      state('any', options)
     end
 
     # Convenience method to get services in passing state
-    def passing
-      state('passing')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def passing(options = {})
+      state('passing', options)
     end
 
     # Convenience method to get services in warning state
-    def warning
-      state('warning')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def warning(options = {})
+      state('warning', options)
     end
 
     # Convenience method to get services in critical state
-    def critical
-      state('critical')
+    # @param options [Hash] :dc, :near, :filter string for specific query
+    # @return [OpenStruct] all data associated with the node
+    def critical(options = {})
+      state('critical', options)
     end
   end
 end

data/lib/diplomat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Diplomat
-  VERSION = '2.5.0'
+  VERSION = '2.6.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.2
 platform: ruby
 authors:
 - John Hamelink
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,16 +184,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Diplomat is a simple wrapper for Consul
 email:
 - john@johnhamelink.com
@@ -252,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Diplomat is a simple wrapper for Consul