diplomat 2.6.1 → 2.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7d8de13c2c322771e2077560a34336a92744122540db247dc5ee8f4c97a7f1
-  data.tar.gz: a13421e5a4c9672f8f8410065ee5f4ab38833acc027f8cfb0edc6c2c0bfd30fd
+  metadata.gz: a511e72072393dd5a7ae290168917f50e27f13bfa46384ca480840277bd33f22
+  data.tar.gz: be98732d7e185789f5d62011d208dbff64088e2634a863d2da3ea9d35f029058
 SHA512:
-  metadata.gz: c1f93bed5e1bf7d1ebd3a62dc3fb0a869c34ce774ae0e992bd0efdbb6a0004ab57e757e5e8d850456032c739bc86ae86bbc1e9b1cd3e7a64e8d5635402f7d851
-  data.tar.gz: 332e033972fc6e8aed716800553edcab761320eea3d2353647102310e199a0eadcdba85a926b2dedbfdc8f4348b7cc3a1d0ed94562dffeacc24251d852d2f698
+  metadata.gz: 1ab4b6033d60b9a9930da3736e105980da473cf186e289db808d0eb5d8bc964d2712fec70711c3d918a84968696ea1ea1a51926e0c41aa663971d4e3825988eb
+  data.tar.gz: 6df7409db9894e31b74d764354c305a70997eef07053d9369756d1572be004239c3268f8d79842116e5d6e8a962e3c21ef97b6c43bcefdaf9898a38735605ce0

data/README.md

@@ -196,6 +196,13 @@ foo_service = Diplomat::Service.get('foo', :all, { :dc => 'My_Datacenter'})
 # => [#<OpenStruct Node="hotel", Address="1.2.3.4", ServiceID="hotel_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>,#<OpenStruct Node="indigo", Address="1.2.3.5", ServiceID="indigo_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>]
 ```
 
+Or if you want to filter services
+
+```ruby
+foo_service = Diplomat::Service.get('foo', :all, { :filter => 'ServiceID == "indigo_foo"'})
+# => [#<OpenStruct Node="indigo", Address="1.2.3.5", ServiceID="indigo_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>]
+```
+
 If you wish to list all the services on consul:
 
 ```ruby
@@ -331,6 +338,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 => 'ServiceName==foo'})
+```
+
 ### Maintenance mode
 
 Enable maintenance mode on a host, with optional reason and DC (requires access to local agent)

data/lib/diplomat/health.rb

@@ -8,11 +8,12 @@ module Diplomat
 
     # Get node health
     # @param n [String] the node
-    # @param options [Hash] :dc string for dc specific query
+    # @param options [Hash] :dc, :filter string for specific query
     # @return [OpenStruct] all data associated with the node
     def node(n, options = {})
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/node/#{n}"], options, custom_params)
       JSON.parse(ret.body).map { |node| OpenStruct.new node }
@@ -20,11 +21,12 @@ module Diplomat
 
     # Get service checks
     # @param s [String] the service
-    # @param options [Hash] :dc string for dc specific query
+    # @param options [Hash] :dc, :filter string for specific query
     # @return [OpenStruct] all data associated with the node
     def checks(s, options = {})
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/checks/#{s}"], options, custom_params)
       JSON.parse(ret.body).map { |check| OpenStruct.new check }
@@ -44,6 +46,7 @@ module Diplomat
       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]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
 
       ret = send_get_request(@conn, ["/v1/health/service/#{s}"], options, custom_params)
       if meta && ret.headers
@@ -59,35 +62,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/service.rb

@@ -17,6 +17,7 @@ module Diplomat
       custom_params << use_named_parameter('wait', options[:wait]) if options[:wait]
       custom_params << use_named_parameter('index', options[:index]) if options[:index]
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      custom_params << use_named_parameter('filter', options[:filter]) if options[:filter]
       custom_params += [*options[:tag]].map { |value| use_named_parameter('tag', value) } if options[:tag]
 
       ret = send_get_request(@conn, ["/v1/catalog/service/#{key}"], options, custom_params)

data/lib/diplomat/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.4
 platform: ruby
 authors:
 - John Hamelink
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -187,9 +187,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -197,9 +200,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: Diplomat is a simple wrapper for Consul
 email:
 - john@johnhamelink.com