diplomat 2.3.1 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e0764ce5272f8bc0489d08464baed5d2a04739aa26e10a74fffad4ac0715527
-  data.tar.gz: 81eb41a5f94c964fbdb72a0b04d004e1277a0557ec30d60a178831792cafac7c
+  metadata.gz: 9c7e8a3d9eafc0f8f531682772b965cae7d19fce0e7cfb875b8c28c0cceda992
+  data.tar.gz: dba720fa8b559c3a7ff1f9456ccf4f97fad2376144fbf4712676a09c6edc4798
 SHA512:
-  metadata.gz: 62e99375359cf2c4c2a0323d4b2821c3546ed2bdd72957325847108afaafcdf6b503699bbf7ec9cb380644d34e5de963310a49e5d7028e2a71a850eac85d13a2
-  data.tar.gz: 29f693149be1d59799bd5ba7a59e0de702bb624b94799310e2ec15458daf9be548b084b8969cd7b0e846efc6f1eaed08c56614eaf7515743e7dee90253d43f9d
+  metadata.gz: 75aed31505c916be58fb45ee7c8c761279d7eb8b24a35819bfdb0a18e5807603d1fecca5dc0dcfadd9bf7d81259164143be09b455774cde3096b42cec2190184
+  data.tar.gz: 1034365593d00617b244e20cdcc1e7c0718ac488f9ba8b6ec615a0069fa491f1f6e8fb41380fa3f5a38a8d5808408b2cc34f72d2315dfd850315219b34e16567

data/README.md

@@ -1,5 +1,5 @@
 # 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)
+[![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) [![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)
 ### A HTTP Ruby API for [Consul](http://www.consul.io/)
 
 ![Diplomacy Board Game](http://i.imgur.com/Nkuy4b7.jpg)
@@ -314,6 +314,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

@@ -41,10 +41,12 @@ module Diplomat
       custom_params << ['passing'] if options[:passing]
       custom_params << use_named_parameter('tag', options[:tag]) 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
@@ -146,9 +146,12 @@ module Diplomat
 
     # 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 +229,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/version.rb

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

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.2
 platform: ruby
 authors:
 - John Hamelink
 - Trevor Wood
+- Pierre Souchay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,14 +122,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -200,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
@@ -210,11 +211,12 @@ 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
 - trevor.g.wood@gmail.com
+- p.souchay@criteo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -227,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
@@ -260,15 +263,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Diplomat is a simple wrapper for Consul