diplomat 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ace94d171ba67ae1b4b8ddbb3a5ff959564925e9fc35f9449de864445f61318
-  data.tar.gz: fc1e85c7e9b2e327fa765d4a14d6df65407dd8851bfaee43769c44acadefe179
+  metadata.gz: dc7fe7869eadb5b93aa45340e84587d631975b4a90507a05168bea3018670054
+  data.tar.gz: 6e5516f00e6d51bc36cb7ee8abf39d8a4f2c8c4b689ff15b39bbf7586cdb8613
 SHA512:
-  metadata.gz: df7576f01b09a1475b3149c16a85b7142aa0367b2934f8fd1689309f2ce55b0424437f102f2face472f447929a6e029be08ddfa272d56b4590c3b681b05dec19
-  data.tar.gz: da846235b84bb59ff064d1530eaeb9f62c25308ba71bd4e6b3c3056a1420ab6dd5115f350b348c6c55ee201810659ce62d0d3f3568a1d46b4f82f3c60646ac71
+  metadata.gz: 41dc809f1752060d51e33edb6a4989a451ec7690ebb80516906b914ce8fa1b9a2ddee570ee98216ec19ad6921f162e0c8ee732d674f46c7e9bc2f63bbe1077fa
+  data.tar.gz: 1cb32fb53c7e619de9170733918e0e359092ba453c6574277df69ebb63b50bb2027fa0467183cfb1f52046cb974c5e1741a76322539be14ccf02eacfc1da25bd

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 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: 2020-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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