diplomat 2.3.3 → 2.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ace94d171ba67ae1b4b8ddbb3a5ff959564925e9fc35f9449de864445f61318
-  data.tar.gz: fc1e85c7e9b2e327fa765d4a14d6df65407dd8851bfaee43769c44acadefe179
+  metadata.gz: e64194c0344267aaf676dd5d7b6c38eeefa47bb212abf933d6d6194e3fb5381a
+  data.tar.gz: 5ea9866b9a9f1a0e62a3bad1f15f1187868ca7c9c6961489748b8f4e454512ba
 SHA512:
-  metadata.gz: df7576f01b09a1475b3149c16a85b7142aa0367b2934f8fd1689309f2ce55b0424437f102f2face472f447929a6e029be08ddfa272d56b4590c3b681b05dec19
-  data.tar.gz: da846235b84bb59ff064d1530eaeb9f62c25308ba71bd4e6b3c3056a1420ab6dd5115f350b348c6c55ee201810659ce62d0d3f3568a1d46b4f82f3c60646ac71
+  metadata.gz: 78e17bb1d532d06e8314641f08e721677181f4b59e18b72299b8c031c2e0c58a118da1d03bdacb6a0125fa3759a78a9a7c8c1846e00a32d86f4389a4fab817de
+  data.tar.gz: ca9f3e479ba0351b1c17e5c81a2c3e2bbbb623ce24c5e34560fd04f5a963e48e015a979bd188f062e307d553f8ea025bd70fc0a09d738587c238e17fee049b37

data/README.md

@@ -1,5 +1,6 @@
 # Diplomat
-[![Gem Version](https://badge.fury.io/rb/diplomat.svg)](https://rubygems.org/gems/diplomat) [![Gem](https://img.shields.io/gem/dt/diplomat.svg)](https://rubygems.org/gems/diplomat/versions/2.0.0) [![Build Status](https://travis-ci.org/WeAreFarmGeek/diplomat.svg?branch=master)](https://travis-ci.org/WeAreFarmGeek/diplomat) [![Code Climate](https://codeclimate.com/github/johnhamelink/diplomat.svg)](https://codeclimate.com/github/WeAreFarmGeek/diplomat) [![Inline docs](http://inch-ci.org/github/wearefarmgeek/diplomat.svg?branch=master)](http://inch-ci.org/github/wearefarmgeek/diplomat)
+[![Build Status](https://github.com/WeAreFarmGeek/diplomat/workflows/Ruby/badge.svg?branch=master)](https://github.com/WeAreFarmGeek/diplomat/actions?query=branch%3Amaster)
+[![Gem Version](https://badge.fury.io/rb/diplomat.svg)](https://rubygems.org/gems/diplomat) [![Gem](https://img.shields.io/gem/dt/diplomat.svg)](https://rubygems.org/gems/diplomat) [![Code Climate](https://codeclimate.com/github/johnhamelink/diplomat.svg)](https://codeclimate.com/github/WeAreFarmGeek/diplomat) [![Inline docs](http://inch-ci.org/github/wearefarmgeek/diplomat.svg?branch=master)](http://inch-ci.org/github/wearefarmgeek/diplomat)
 ### A HTTP Ruby API for [Consul](http://www.consul.io/)
 
 ![Diplomacy Board Game](http://i.imgur.com/Nkuy4b7.jpg)
@@ -41,7 +42,7 @@ production:
 
 ### Which versions of Ruby does Diplomat support? Where did my ruby 1.9 compatibility go?
 
-Check out [Travis](https://travis-ci.org/WeAreFarmGeek/diplomat) to see which versions of ruby we currently test when we're making builds.
+Check out [GitHub Actions](https://github.com/WeAreFarmGeek/diplomat/blob/master/.github/workflows/ruby.yml) to see which versions of ruby we currently test when we're making builds.
 
 We've dropped ruby 1.9 support. You can still depend on Diplomat by directly using the `ruby-1.9-compatible` branch on github, although be advised it's not actively maintained anymore.
 
@@ -314,6 +315,22 @@ Get an array of Raft peers for the datacenter in which the agent is running
 Diplomat::Status.peers()
 ```
 
+### Autopilot
+
+Returns information about the autopilot configuration of the Consul cluster
+
+Get the current autopilot configuration
+
+```ruby
+Diplomat::Autopilot.get_configuration()
+```
+
+Get the health status from autopilot
+
+```ruby
+Diplomat::Autopilot.get_health()
+```
+
 ### Maintenance mode
 
 Enable maintenance mode on a host, with optional reason and DC (requires access to local agent)

data/lib/diplomat.rb

@@ -31,7 +31,7 @@ module Diplomat
   require_libs 'configuration', 'rest_client', 'kv', 'datacenter', 'service',
                'members', 'node', 'nodes', 'check', 'health', 'session', 'lock',
                'error', 'event', 'acl', 'maintenance', 'query', 'agent', 'status',
-               'policy', 'token', 'role'
+               'policy', 'token', 'role', 'autopilot'
   self.configuration ||= Diplomat::Configuration.new
 
   class << self

data/lib/diplomat/acl.rb

@@ -73,7 +73,7 @@ module Diplomat
     # Destroy an ACl token by its id
     # @param ID [String] the Acl ID
     # @param options [Hash] options parameter hash
-    # @return [Bool]
+    # @return [Bool] true if operation succeeded
     def destroy(id, options = {})
       @id = id
       @raw = send_put_request(@conn, ["/v1/acl/destroy/#{@id}"], options, nil)

data/lib/diplomat/autopilot.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Diplomat
+  # Methods for interacting with the Consul operator autopilot API endpoint
+  class Autopilot < Diplomat::RestClient
+    @access_methods = %i[get_configuration get_health update]
+
+    # Get autopilot configuration
+    # @param options [Hash] options parameter hash
+    # @return [OpenStruct] all data associated with the autopilot configuration
+    def get_configuration(options = {})
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+
+      ret = send_get_request(@conn, ['/v1/operator/autopilot/configuration'], options, custom_params)
+      JSON.parse(ret.body)
+    end
+
+    # Get health status from the autopilot
+    # @param options [Hash] options parameter hash
+    # @return [OpenStruct] all data associated with the health of the autopilot
+    def get_health(options = {})
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+
+      ret = send_get_request(@conn, ['/v1/operator/autopilot/health'], options, custom_params)
+      JSON.parse(ret.body)
+    end
+  end
+end

data/lib/diplomat/configuration.rb

@@ -6,11 +6,20 @@ module Diplomat
     attr_reader :middleware
     attr_accessor :url, :acl_token, :options
 
+    # Get the most appropriate consul agent value from env
+    # Parse the environment variable `CONSUL_HTTP_ADDR` and prefixes it with http:// if needed
+    # Return default http://localhost:8500 if not found
+    def self.parse_consul_addr
+      ret = ENV['CONSUL_HTTP_ADDR'] || 'http://localhost:8500'
+      ret = "http://#{ret}" unless ret.start_with?('http://', 'https://')
+      ret
+    end
+
     # Override defaults for configuration
     # @param url [String] consul's connection URL
     # @param acl_token [String] a connection token used when making requests to consul
     # @param options [Hash] extra options to configure Faraday::Connection
-    def initialize(url = 'http://localhost:8500', acl_token = nil, options = {})
+    def initialize(url = Configuration.parse_consul_addr, acl_token = ENV['CONSUL_HTTP_TOKEN'], options = {})
       @middleware = []
       @url = url
       @acl_token = acl_token
@@ -19,6 +28,7 @@ module Diplomat
 
     # Define a middleware for Faraday
     # @param middleware [Class] Faraday Middleware class
+    # @return [Array] Array of Faraday Middlewares
     def middleware=(middleware)
       if middleware.is_a? Array
         @middleware = middleware

data/lib/diplomat/health.rb

@@ -39,12 +39,14 @@ module Diplomat
       custom_params = []
       custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
       custom_params << ['passing'] if options[:passing]
-      custom_params << use_named_parameter('tag', options[:tag]) if options[:tag]
+      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]
 
       ret = send_get_request(@conn, ["/v1/health/service/#{s}"], options, custom_params)
       JSON.parse(ret.body).map { |service| OpenStruct.new service }
     end
+
     # rubocop:enable Metrics/PerceivedComplexity
 
     # Get service health

data/lib/diplomat/rest_client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'deep_merge'
+require 'deep_merge/core'
 
 module Diplomat
   # Base class for interacting with the Consul RESTful API
@@ -140,15 +140,26 @@ module Diplomat
         faraday.request  :url_encoded
         faraday.response :raise_error unless raise_error
 
-        faraday.adapter  Faraday.default_adapter
+        # We have to provide a custom params encoder here because Faraday - by default - assumes that
+        # list keys have [] as part of their name. This is however does not match the expectation of
+        # the Consul API, which assumes the same query param to simply be repeated
+        #
+        # So faraday reduces this: http://localhost:8500?a=1&a=2 to http://localhost:8500?a=2 unless you
+        # explicitly tell it not to.
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+
+        faraday.adapter Faraday.default_adapter
       end
     end
 
     # Converts k/v data into ruby hash
     def convert_to_hash(data)
-      data.map do |item|
+      data_h = data.map do |item|
         item[:key].split('/').reverse.reduce(item[:value]) { |h, v| { v => h } }
-      end.reduce(:deep_merge)
+      end
+      data_h.reduce({}) do |dest, source|
+        DeepMerge.deep_merge!(source, dest, { preserve_unmergeables: true })
+      end
     end
 
     # Parse the body, apply it to the raw attribute
@@ -226,6 +237,8 @@ module Diplomat
       consistency = 'consistent' if options[:consistent]
       query_params << consistency
 
+      query_params << 'cached' if options[:cached]
+
       # Parse url host
       url_prefix = options[:http_addr] if options[:http_addr]
       { query_params: query_params, headers: headers, url_prefix: url_prefix }

data/lib/diplomat/service.rb

@@ -17,21 +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]
-      if options[:tag]
-        # tag can be either a String, or an array of strings
-        # by splatting it is guaranteed to be an array of strings
-        [*options[:tag]].each do |value|
-          custom_params << use_named_parameter('tag', value)
-        end
-      end
-
-      # We have to provide a custom params encoder here because Faraday - by default - assumes that
-      # list keys have [] as part of their name. This is however not the case for consul tags, which
-      # just use repeated occurences of the same key.
-      #
-      # So faraday reduces this: http://localhost:8500?a=1&a=2 to http://localhost:8500?a=2 unless you
-      # explicitly tell it not to.
-      options[:params_encoder] = Faraday::FlatParamsEncoder
+      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)
       if meta && ret.headers

data/lib/diplomat/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.4
 platform: ruby
 authors:
 - John Hamelink
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,7 +201,7 @@ dependencies:
         version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -211,7 +211,7 @@ dependencies:
         version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.1.0
 description: Diplomat is a simple wrapper for Consul
 email:
 - john@johnhamelink.com
@@ -229,6 +229,7 @@ files:
 - lib/diplomat.rb
 - lib/diplomat/acl.rb
 - lib/diplomat/agent.rb
+- lib/diplomat/autopilot.rb
 - lib/diplomat/check.rb
 - lib/diplomat/configuration.rb
 - lib/diplomat/datacenter.rb
@@ -269,8 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Diplomat is a simple wrapper for Consul