diplomat 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6feb74783d35459eb7f08e895688ffe20ed975b1
-  data.tar.gz: 21a8d4d02987f5d6298414c047fa86758968dd58
+  metadata.gz: 7e314345fea055152e86ff0e0a166185de4889f0
+  data.tar.gz: 7630435e44ebfab12efe41d3949a880bb9538d7d
 SHA512:
-  metadata.gz: 709cdba5352b6c9f045065e8d335d4ce00d3b0065d0dbba39b83ed1d0ba8ea873088de4dd7b998fd127682dcd40104d5726daf91e9af40a45c13a2837c8240f9
-  data.tar.gz: 0621ad4ca2152759913a2e82f6daf650e2044bb2083f66b028caa73bac19e38f7cefcf044f1e73d79c4edbf1b1a9d1a2e40d0d82b43be58f51d91064d9d50f45
+  metadata.gz: 180b5d54fb5ee0ef5758ec5f22da3408b2cc2b9bfe135640a0755f84e5dc8d8176bf4215a0a24e44091f247a392e49cd3ec3996f0b812e657a6f0fa4346c4a4d
+  data.tar.gz: 4045fb41d2ae39d4e6a2de5412782574e67834f7932042dcb4b52f1250add0666f7506290183d200d86ed6d8638810360be275a7f4c7a5bb3c1fbf20524f2661

data/README.md

@@ -269,6 +269,22 @@ end
 events.each{ |e| puts e }
 ```
 
+### Status
+
+Returns information about the status of the Consul cluster.
+
+Get the raft leader for the datacenter in which the local consul agent is running
+
+```ruby
+Diplomat::Status.leader()
+```
+
+Get an array of Raft peers for the datacenter in which the agent is running
+
+```ruby
+Diplomat::Status.peers()
+```
+
 ### Maintenance mode
 
 Enable maintenance mode on a host, with optional reason and DC (requires access to local agent)

data/lib/diplomat.rb

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

data/lib/diplomat/acl.rb

@@ -3,7 +3,7 @@ module Diplomat
   class Acl < Diplomat::RestClient
     include ApiOptions
 
-    @access_methods = [:list, :info, :create, :destroy, :update]
+    @access_methods = %i[list info create destroy update]
     attr_reader :id, :type, :acl
 
     # Get Acl info by ID
@@ -18,7 +18,7 @@ module Diplomat
       url << use_consistency(options)
 
       raw = @conn_no_err.get concat_url url
-      if raw.status == 200 && raw.body != 'null'
+      if raw.status == 200 && raw.body.chomp != 'null'
         case found
         when :reject
           raise Diplomat::AclAlreadyExists, id
@@ -26,7 +26,7 @@ module Diplomat
           @raw = raw
           return parse_body
         end
-      elsif raw.status == 200 && raw.body == 'null'
+      elsif raw.status == 200 && raw.body.chomp == 'null'
         case not_found
         when :reject
           raise Diplomat::AclNotFound, id
@@ -86,7 +86,7 @@ module Diplomat
       url = ["/v1/acl/destroy/#{@id}"]
       url << check_acl_token
       @raw = @conn.put concat_url url
-      @raw.body == 'true'
+      @raw.body.chomp == 'true'
     end
   end
 end

data/lib/diplomat/agent.rb

@@ -0,0 +1,70 @@
+require 'base64'
+require 'faraday'
+
+module Diplomat
+  # Agent API endpoint methods
+  # @see https://www.consul.io/docs/agent/http/agent.html
+  class Agent < Diplomat::RestClient
+    @access_methods = %i[self checks services members]
+
+    # Get agent configuration
+    # @return [OpenStruct] all data associated with the node
+    def self
+      url = ['/v1/agent/self']
+
+      # If the request fails, it's probably due to a bad path
+      # so return a PathNotFound error.
+      begin
+        ret = @conn.get concat_url url
+      rescue Faraday::ClientError
+        raise Diplomat::PathNotFound
+      end
+      JSON.parse(ret.body).tap { |node| OpenStruct.new node }
+    end
+
+    # Get local agent checks
+    # @return [OpenStruct] all agent checks
+    def checks
+      url = ['/v1/agent/checks']
+
+      # If the request fails, it's probably due to a bad path
+      # so return a PathNotFound error.
+      begin
+        ret = @conn.get concat_url url
+      rescue Faraday::ClientError
+        raise Diplomat::PathNotFound
+      end
+      JSON.parse(ret.body).tap { |node| OpenStruct.new node }
+    end
+
+    # Get local agent services
+    # @return [OpenStruct] all agent services
+    def services
+      url = ['/v1/agent/services']
+
+      # If the request fails, it's probably due to a bad path
+      # so return a PathNotFound error.
+      begin
+        ret = @conn.get concat_url url
+      rescue Faraday::ClientError
+        raise Diplomat::PathNotFound
+      end
+      JSON.parse(ret.body).tap { |node| OpenStruct.new node }
+    end
+
+    # Get cluster members (as seen by the agent)
+    # @return [OpenStruct] all members
+    def members
+      url = ['/v1/agent/members']
+
+      # If the request fails, it's probably due to a bad path
+      # so return a PathNotFound error.
+      begin
+        ret = @conn.get concat_url url
+      rescue Faraday::ClientError
+        raise Diplomat::PathNotFound
+      end
+      JSON.parse(ret.body).map { |node| OpenStruct.new node }
+    end
+  end
+end

data/lib/diplomat/api_options.rb

@@ -12,5 +12,35 @@ module Diplomat
     def use_consistency(options)
       options && options[:consistency] ? [options[:consistency].to_s] : []
     end
+
+    # Mapping for valid key/value store transaction verbs and required parameters
+    #
+    # @return [Hash] valid key/store transaction verbs and required parameters
+    # rubocop:disable MethodLength
+    def valid_transaction_verbs
+      {
+        'set' => %w[Key Value],
+        'cas' => %w[Key Value Index],
+        'lock' => %w[Key Value Session],
+        'unlock' => %w[Key Value Session],
+        'get' => %w[Key],
+        'get-tree' => %w[Key],
+        'check-index' => %w[Key Index],
+        'check-session' => %w[Key Session],
+        'delete' => %w[Key],
+        'delete-tree' => %w[Key],
+        'delete-cas' => %w[Key Index]
+      }
+    end
+    # rubocop:enable MethodLength
+
+    # Key/value store transactions that require that a value be set
+    #
+    # @return [Array<String>] verbs that require a value be set
+    def valid_value_transactions
+      @valid_value_transactions ||= valid_transaction_verbs.select do |verb, requires|
+        verb if requires.include? 'Value'
+      end
+    end
   end
 end

data/lib/diplomat/check.rb

@@ -1,8 +1,8 @@
 module Diplomat
   # Methods for interacting with the Consul check API endpoint
   class Check < Diplomat::RestClient
-    @access_methods = [:checks, :register_script, :register_ttl,
-                       :deregister, :pass, :warn, :fail]
+    @access_methods = %i[checks register_script register_ttl
+                         deregister pass warn fail]
 
     # Get registered checks
     # @return [OpenStruct] all data associated with the service

data/lib/diplomat/error.rb

@@ -10,4 +10,5 @@ module Diplomat
   class QueryAlreadyExists < StandardError; end
   class UnknownStatus < StandardError; end
   class IdParameterRequired < StandardError; end
+  class InvalidTransaction < StandardError; end
 end

data/lib/diplomat/event.rb

@@ -3,7 +3,7 @@ module Diplomat
   class Event < Diplomat::RestClient
     include ApiOptions
 
-    @access_methods = [:fire, :get_all, :get]
+    @access_methods = %i[fire get_all get]
 
     # Send an event
     # @param name [String] the event name
@@ -11,17 +11,21 @@ module Diplomat
     # @param service [String] the target service name
     # @param node [String] the target node name
     # @param tag [String] the target tag name, must only be used with service
+    # @param dc [String] the dc to target
     # @return [nil]
-    def fire(name, value = nil, service = nil, node = nil, tag = nil)
+    # rubocop:disable Metrics/ParameterLists
+    def fire(name, value = nil, service = nil, node = nil, tag = nil, dc = nil)
       url = ["/v1/event/fire/#{name}"]
       url += check_acl_token
       url += use_named_parameter('service', service) if service
       url += use_named_parameter('node', node) if node
       url += use_named_parameter('tag', tag) if tag
+      url += use_named_parameter('dc', dc) if dc
 
       @conn.put concat_url(url), value
       nil
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # Get the list of events matching name
     # @param name [String] the name of the event (regex)

data/lib/diplomat/health.rb

@@ -1,8 +1,8 @@
 module Diplomat
   # Methods for interacting with the Consul health API endpoint
   class Health < Diplomat::RestClient
-    @access_methods = [:node, :checks, :service, :state,
-                       :any, :passing, :warning, :critical]
+    @access_methods = %i[node checks service state
+                         any passing warning critical]
 
     # Get node health
     # @param n [String] the node

data/lib/diplomat/kv.rb

@@ -3,7 +3,7 @@ module Diplomat
   class Kv < Diplomat::RestClient
     include ApiOptions
 
-    @access_methods = [:get, :put, :delete]
+    @access_methods = %i[get put delete txn]
     attr_reader :key, :value, :raw
 
     # Get a value by its key, potentially blocking for the first or next value
@@ -115,9 +115,11 @@ module Diplomat
         req.url concat_url url
         req.body = value
       end
-      @key = key if @raw.body == 'true'
-      @value = value if @raw.body == 'true'
-      @raw.body == 'true'
+      if @raw.body.chomp == 'true'
+        @key = key
+        @value = value
+      end
+      @raw.body.chomp == 'true'
     end
     # rubocop:enable MethodLength, AbcSize
 
@@ -137,6 +139,43 @@ module Diplomat
       @raw = @conn.delete concat_url url
     end
 
+    # Perform a key/value store transaction.
+    #
+    # @since 1.3.0
+    # @see https://www.consul.io/docs/agent/http/kv.html#txn Transaction key/value store API documentation
+    # @example Valid key/value store transaction format
+    #   [
+    #     {
+    #       'KV' => {
+    #         'Verb' => 'get',
+    #         'Key' => 'hello/world'
+    #       }
+    #     }
+    #   ]
+    # @raise [Diplomat::InvalidTransaction] if transaction format is invalid
+    # @param value [Array] an array of transaction hashes
+    # @param [Hash] options transaction params
+    # @option options [Boolean] :decode_values of any GET requests, default: true
+    # @option options [String] :dc Target datacenter
+    # @option options [String] :consistency the accepted staleness level of the transaction.
+    #   Can be 'stale' or 'consistent'
+    # @return [OpenStruct] result of the transaction
+    def txn(value, options = nil)
+      # Verify the given value for the transaction
+      transaction_verification(value)
+      # Will return 409 if transaction was rolled back
+      raw = @conn_no_err.put do |req|
+        url = ['/v1/txn']
+        url += check_acl_token
+        url += dc(options)
+        url += transaction_consistency(options)
+
+        req.url concat_url url
+        req.body = JSON.generate(value)
+      end
+      transaction_return JSON.parse(raw.body), options
+    end
+
     private
 
     def recurse_get(options)
@@ -154,5 +193,63 @@ module Diplomat
     def separator(options)
       options && options[:separator] ? use_named_parameter('separator', options[:separator]) : []
     end
+
+    def transaction_consistency(options)
+      return [] unless options
+      if options[:consistency] && options[:consistency] == 'stale'
+        ['stale']
+      elsif options[:consistency] && options[:consistency] == 'consistent'
+        ['consistent']
+      else
+        []
+      end
+    end
+
+    def transaction_verification(transaction)
+      raise Diplomat::InvalidTransaction unless transaction.is_a?(Array)
+      transaction.each do |req|
+        raise Diplomat::InvalidTransaction unless transaction_type_verification(req)
+        raise Diplomat::InvalidTransaction unless transaction_verb_verification(req['KV'])
+      end
+      # Encode all value transacations if all checks pass
+      encode_transaction(transaction)
+    end
+
+    def transaction_type_verification(txn)
+      txn.is_a?(Hash) && txn.keys == %w[KV]
+    end
+
+    def transaction_verb_verification(txn)
+      transaction_verb = txn['Verb']
+      raise Diplomat::InvalidTransaction unless valid_transaction_verbs.include? transaction_verb
+      test_requirements = valid_transaction_verbs[transaction_verb] - txn.keys
+      test_requirements.empty?
+    end
+
+    def encode_transaction(transaction)
+      transaction.each do |txn|
+        next unless valid_value_transactions.include? txn['KV']['Verb']
+        value = txn['KV']['Value']
+        txn['KV']['Value'] = Base64.encode64(value).chomp
+      end
+    end
+
+    def transaction_return(raw_return, options)
+      decoded_return =
+        options && options[:decode_values] == false ? raw_return : decode_transaction(raw_return)
+      OpenStruct.new decoded_return
+    end
+
+    def decode_transaction(transaction)
+      return transaction if transaction['Results'].nil? || transaction['Results'].empty?
+
+      transaction.tap do |txn|
+        txn['Results'].each do |resp|
+          next unless resp['KV']['Value']
+          value = resp['KV']['Value']
+          resp['KV']['Value'] = Base64.decode64(value) rescue nil # rubocop:disable RescueModifier
+        end
+      end
+    end
   end
 end

data/lib/diplomat/lock.rb

@@ -3,7 +3,7 @@ module Diplomat
   class Lock < Diplomat::RestClient
     include ApiOptions
 
-    @access_methods = [:acquire, :wait_to_acquire, :release]
+    @access_methods = %i[acquire wait_to_acquire release]
 
     # Acquire a lock
     # @param key [String] the key
@@ -11,6 +11,7 @@ module Diplomat
     # @param value [String] the value for the key
     # @param options [Hash] :dc string for dc specific query
     # @return [Boolean] If the lock was acquired
+    # rubocop:disable AbcSize
     def acquire(key, session, value = nil, options = nil)
       raw = @conn.put do |req|
         url = ["/v1/kv/#{key}"]
@@ -21,8 +22,9 @@ module Diplomat
         req.url concat_url url
         req.body = value unless value.nil?
       end
-      raw.body == 'true'
+      raw.body.chomp == 'true'
     end
+    # rubocop:enable AbcSize
 
     # wait to aquire a lock
     # @param key [String] the key

data/lib/diplomat/maintenance.rb

@@ -1,7 +1,7 @@
 module Diplomat
   # Methods to interact with the Consul maintenance API endpoint
   class Maintenance < Diplomat::RestClient
-    @access_methods = [:enabled, :enable]
+    @access_methods = %i[enabled enable]
 
     # Get the maintenance state of a host
     # @param n [String] the node

data/lib/diplomat/node.rb

@@ -3,7 +3,7 @@ module Diplomat
   class Node < Diplomat::RestClient
     include ApiOptions
 
-    @access_methods = [:get, :get_all, :register, :deregister]
+    @access_methods = %i[get get_all register deregister]
 
     # Get a node by it's key
     # @param key [String] the key

data/lib/diplomat/nodes.rb

@@ -2,7 +2,7 @@ module Diplomat
   # @depreciated
   # Methods for interacting with the Consul nodes API endpoint
   class Nodes < Diplomat::RestClient
-    @access_methods = [:get, :get_all]
+    @access_methods = %i[get get_all]
 
     # Get all nodes
     # @deprecated Please use Diplomat::Node instead.

data/lib/diplomat/query.rb

@@ -3,7 +3,7 @@ module Diplomat
   class Query < Diplomat::RestClient
     include ApiOptions
 
-    @access_methods = [:get, :get_all, :create, :delete, :update, :execute, :explain]
+    @access_methods = %i[get get_all create delete update execute explain]
 
     # Get a prepared query by it's key
     # @param key [String] the prepared query ID

data/lib/diplomat/service.rb

@@ -3,7 +3,7 @@ module Diplomat
   class Service < Diplomat::RestClient
     include ApiOptions
 
-    @access_methods = [:get, :get_all, :register, :deregister, :register_external, :deregister_external]
+    @access_methods = %i[get get_all register deregister register_external deregister_external]
 
     # Get a service by it's key
     # @param key [String] the key

data/lib/diplomat/session.rb

@@ -1,7 +1,7 @@
 module Diplomat
   # Methods for interacting with the Consul session API endpoint
   class Session < Diplomat::RestClient
-    @access_methods = [:create, :destroy, :list, :renew, :info, :node]
+    @access_methods = %i[create destroy list renew info node]
 
     # Create a new session
     # @param value [Object] hash or json representation of the session arguments

data/lib/diplomat/status.rb

@@ -0,0 +1,22 @@
+module Diplomat
+  # Methods for interacting with the Consul status API endpoints, leader and peers
+  class Status < Diplomat::RestClient
+    @access_methods = %i[leader peers]
+
+    # Get the raft leader for the datacenter in which the local consul agent is running
+    # @return [OpenStruct] the address of the leader
+    def leader
+      url = ['/v1/status/leader']
+      ret = @conn.get concat_url url
+      JSON.parse(ret.body)
+    end
+
+    # Get an array of Raft peers for the datacenter in which the agent is running
+    # @return [OpenStruct] an array of peers
+    def peers
+      url = ['/v1/status/peers']
+      ret = @conn.get concat_url url
+      JSON.parse(ret.body)
+    end
+  end
+end

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - John Hamelink
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -29,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -99,16 +99,16 @@ dependencies:
   name: fivemat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -141,16 +141,22 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.47.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.47.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +200,7 @@ files:
 - features/step_definitions/test_key_value.rb
 - lib/diplomat.rb
 - lib/diplomat/acl.rb
+- lib/diplomat/agent.rb
 - lib/diplomat/api_options.rb
 - lib/diplomat/check.rb
 - lib/diplomat/configuration.rb
@@ -211,6 +218,7 @@ files:
 - lib/diplomat/rest_client.rb
 - lib/diplomat/service.rb
 - lib/diplomat/session.rb
+- lib/diplomat/status.rb
 - lib/diplomat/version.rb
 homepage: https://github.com/WeAreFarmGeek/diplomat
 licenses: