diplomat 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 821e0c50069009a97db9397d14f0c5c4eefba50c
-  data.tar.gz: 0204f17c74c81cc3676ef9332ed5bace9150e5ab
+SHA256:
+  metadata.gz: df1251c77ca0e65f2e2b046a8f5c9c596a165fe08f382051f4b71646cd455f10
+  data.tar.gz: 5f53957806d93db43c1d8c0fae7497a07c8f62e1fcb2cc07d1608274b52436f4
 SHA512:
-  metadata.gz: fdf627aad378afb53880105c43ad280d4eb81900f1c1ec82bed4d37abcaff34a9ea17cc7db8e022fb44ea4c4167019d32366687648d4233585645f83d8936788
-  data.tar.gz: 5df07529deabb282661cb8cae6ccd5939685c7a4ab86d60f93306942d562f5301fa41fbd93cbcde9ce8ca5f3630cf21c9596e75d77b492611ec198f3a4036342
+  metadata.gz: 02d8ac73def0d239a67bb809870689f22708bac587b4820583d6bff0d0bc8c82326667cf9e9b1f2a496d4930a777e53cc80d9395c1e7198f62ce9bce0366011e
+  data.tar.gz: 6b5736c9f3d33df4686356e2baadebb41caf51cce148442f6a94a2440478fae0400de6f961e1a9b282736845cec6b97b3fa13ac6d2c90a6557d3ee40e6c6f8b3

data/README.md

@@ -1,5 +1,5 @@
 # Diplomat
-[![Gem Version](https://badge.fury.io/rb/diplomat.svg)](http://badge.fury.io/rb/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.png)](https://codeclimate.com/github/WeAreFarmGeek/diplomat) [![Dependency Status](https://gemnasium.com/WeAreFarmGeek/diplomat.svg)](https://gemnasium.com/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)](http://badge.fury.io/rb/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)
 ### A HTTP Ruby API for [Consul](http://www.consul.io/)
 
 ![Diplomacy Boad Game](http://i.imgur.com/Nkuy4b7.jpg)
@@ -310,10 +310,8 @@ Diplomat.configure do |config|
   config.url = "http://localhost:8888"
   # Set up a custom Faraday Middleware
   config.middleware = MyCustomMiddleware
-  # Connect into consul with custom access token (ACL)
-  config.acl_token =  "xxxxxxxx-yyyy-zzzz-1111-222222222222"
-  # Set extra Faraday configuration options
-  config.options = {ssl: { version: :TLSv1_2 }}
+  # Set extra Faraday configuration options and custom access token (ACL)
+  config.options = {ssl: {version: :TLSv1_2}, headers: {"X-Consul-Token" => "xxxxxxxx-yyyy-zzzz-1111-222222222222"}}
 end
 ```
 

data/lib/diplomat.rb

@@ -23,11 +23,11 @@ module Diplomat
 
   raise 'Diplomat only supports ruby >= 2.0.0' unless RUBY_VERSION.to_f >= 2.0
 
-  self.root_path = File.expand_path '..', __FILE__
-  self.lib_path = File.expand_path '../diplomat', __FILE__
+  self.root_path = File.expand_path __dir__
+  self.lib_path = File.expand_path 'diplomat', __dir__
 
-  require_libs 'configuration', 'rest_client', 'api_options', 'kv', 'datacenter',
-               'service', 'members', 'node', 'nodes', 'check', 'health', 'session', 'lock',
+  require_libs 'configuration', 'rest_client', 'kv', 'datacenter', 'service',
+               'members', 'node', 'nodes', 'check', 'health', 'session', 'lock',
                'error', 'event', 'acl', 'maintenance', 'query', 'agent', 'status'
   self.configuration ||= Diplomat::Configuration.new
 

data/lib/diplomat/acl.rb

@@ -1,8 +1,6 @@
 module Diplomat
   # Methods for interacting with the Consul ACL API endpoint
   class Acl < Diplomat::RestClient
-    include ApiOptions
-
     @access_methods = %i[list info create destroy update]
     attr_reader :id, :type, :acl
 

data/lib/diplomat/configuration.rb

@@ -1,7 +1,7 @@
 module Diplomat
   # Methods for configuring Diplomat
   class Configuration
-    attr_accessor :middleware
+    attr_reader :middleware
     attr_accessor :url, :acl_token, :options
 
     # Override defaults for configuration
@@ -18,7 +18,10 @@ module Diplomat
     # Define a middleware for Faraday
     # @param middleware [Class] Faraday Middleware class
     def middleware=(middleware)
-      return @middleware = middleware if middleware.is_a? Array
+      if middleware.is_a? Array
+        @middleware = middleware
+        return
+      end
       @middleware = [middleware]
     end
   end

data/lib/diplomat/event.rb

@@ -1,8 +1,6 @@
 module Diplomat
   # Methods for interacting with the Consul event API endpoint
   class Event < Diplomat::RestClient
-    include ApiOptions
-
     @access_methods = %i[fire get_all get]
 
     # Send an event

data/lib/diplomat/kv.rb

@@ -1,8 +1,6 @@
 module Diplomat
   # Methods for interacting with the Consul KV API endpoint
   class Kv < Diplomat::RestClient
-    include ApiOptions
-
     @access_methods = %i[get put delete txn]
     attr_reader :key, :value, :raw
 
@@ -80,6 +78,7 @@ module Diplomat
           return @raw.first['Session'] if @options && @options[:session]
           return decode_values if @options && @options[:decode_values]
           return convert_to_hash(return_value(return_nil_values, transformation, true)) if @options && @options[:convert_to_hash]
+
           return return_value(return_nil_values, transformation)
         when :wait
           index = raw.headers['x-consul-index']
@@ -204,6 +203,7 @@ module Diplomat
 
     def transaction_consistency(options)
       return [] unless options
+
       if options[:consistency] && options[:consistency] == 'stale'
         ['stale']
       elsif options[:consistency] && options[:consistency] == 'consistent'
@@ -215,6 +215,7 @@ module Diplomat
 
     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'])
@@ -230,6 +231,7 @@ module Diplomat
     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
@@ -237,6 +239,7 @@ module Diplomat
     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
@@ -248,14 +251,18 @@ module Diplomat
       OpenStruct.new decoded_return
     end
 
-    def decode_transaction(transaction)
+    def decode_transaction(transaction) # rubocop:disable Metrics/MethodLength
       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
+
+          begin
+            resp['KV']['Value'] = Base64.decode64(resp['KV']['Value'])
+          rescue StandardError
+            nil
+          end
         end
       end
     end

data/lib/diplomat/lock.rb

@@ -1,8 +1,6 @@
 module Diplomat
   # Methods for interacting with the Consul lock API endpoint
   class Lock < Diplomat::RestClient
-    include ApiOptions
-
     @access_methods = %i[acquire wait_to_acquire release]
 
     # Acquire a lock

data/lib/diplomat/maintenance.rb

@@ -37,6 +37,7 @@ module Diplomat
 
       return_status = raw.status == 200
       raise Diplomat::UnknownStatus, "status #{raw.status}: #{raw.body}" unless return_status
+
       return_status
     end
     # rubocop:enable AbcSize

data/lib/diplomat/node.rb

@@ -1,8 +1,6 @@
 module Diplomat
   # Methods for interacting with the Consul node API endpoint
   class Node < Diplomat::RestClient
-    include ApiOptions
-
     @access_methods = %i[get get_all register deregister]
 
     # Get a node by it's key

data/lib/diplomat/query.rb

@@ -1,8 +1,6 @@
 module Diplomat
   # Methods for interacting with the Consul query API endpoint
   class Query < Diplomat::RestClient
-    include ApiOptions
-
     @access_methods = %i[get get_all create delete update execute explain]
 
     # Get a prepared query by it's key

data/lib/diplomat/rest_client.rb

@@ -2,13 +2,22 @@ module Diplomat
   # Base class for interacting with the Consul RESTful API
   class RestClient
     @access_methods = []
+    @configuration = nil
 
     # Initialize the fadaray connection
     # @param api_connection [Faraday::Connection,nil] supply mock API Connection
-    def initialize(api_connection = nil)
+    # @param configuration [Diplomat::Configuration] a dedicated config to use
+    def initialize(api_connection = nil, configuration: nil)
+      @configuration = configuration
       start_connection api_connection
     end
 
+    # Get client configuration or global one if not specified via initialize.
+    # @return [Diplomat::Configuration] used by this client
+    def configuration
+      @configuration || ::Diplomat.configuration
+    end
+
     # Format url parameters into strings correctly
     # @param name [String] the name of the parameter
     # @param value [String] the value of the parameter
@@ -80,8 +89,8 @@ module Diplomat
     end
 
     def build_connection(api_connection, raise_error = false)
-      api_connection || Faraday.new(Diplomat.configuration.url, Diplomat.configuration.options) do |faraday|
-        Diplomat.configuration.middleware.each do |middleware|
+      api_connection || Faraday.new(configuration.url, configuration.options) do |faraday|
+        configuration.middleware.each do |middleware|
           faraday.use middleware
         end
 
@@ -134,14 +143,20 @@ module Diplomat
     # Parse the body, apply it to the raw attribute
     def parse_body
       return JSON.parse(@raw.body) if @raw.status == 200
+
       raise Diplomat::UnknownStatus, "status #{@raw.status}: #{@raw.body}"
     end
 
     # Return @raw with Value fields decoded
     def decode_values
       return @raw if @raw.first.is_a? String
+
       @raw.each_with_object([]) do |acc, el|
-        acc['Value'] = Base64.decode64(acc['Value']) rescue nil # rubocop:disable RescueModifier
+        begin
+          acc['Value'] = Base64.decode64(acc['Value'])
+        rescue StandardError
+          nil
+        end
         el << acc
         el
       end
@@ -152,6 +167,7 @@ module Diplomat
     def return_value(nil_values = false, transformation = nil, return_hash = false)
       @value = decode_values
       return @value if @value.first.is_a? String
+
       if @value.count == 1 && !return_hash
         @value = @value.first['Value']
         @value = transformation.call(@value) if transformation && !@value.nil?
@@ -172,5 +188,47 @@ module Diplomat
           payload: (Base64.decode64(e['Payload']) unless e['Payload'].nil?) }
       end
     end
+
+    def check_acl_token
+      use_named_parameter('token', configuration.acl_token)
+    end
+
+    def use_cas(options)
+      options ? use_named_parameter('cas', options[:cas]) : []
+    end
+
+    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/service.rb

@@ -1,8 +1,6 @@
 module Diplomat
   # Methods for interacting with the Consul serivce API endpoint.
   class Service < Diplomat::RestClient
-    include ApiOptions
-
     @access_methods = %i[get get_all register deregister register_external deregister_external maintenance]
 
     # Get a service by it's key
@@ -66,8 +64,10 @@ module Diplomat
     # @param definition [Hash] Hash containing definition of service
     # @return [Boolean]
     def register(definition, path = '/v1/agent/service/register')
+      url = [path]
+      url += check_acl_token
       json_definition = JSON.dump(definition)
-      register = @conn.put path, json_definition
+      register = @conn.put concat_url(url), json_definition
       register.status == 200
     end
 
@@ -75,7 +75,9 @@ module Diplomat
     # @param service_name [String] Service name to de-register
     # @return [Boolean]
     def deregister(service_name)
-      deregister = @conn.get "/v1/agent/service/deregister/#{service_name}"
+      url = ["/v1/agent/service/deregister/#{service_name}"]
+      url += check_acl_token
+      deregister = @conn.put concat_url(url)
       deregister.status == 200
     end
 
@@ -113,6 +115,5 @@ module Diplomat
       end
       maintenance.status == 200
     end
-    # rubocop:enable AbcSize
   end
 end

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.0.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - John Hamelink
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,56 +17,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: fakes-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -82,95 +74,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: fivemat
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: fivemat
+  name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '0.49'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -201,7 +187,6 @@ files:
 - lib/diplomat.rb
 - lib/diplomat/acl.rb
 - lib/diplomat/agent.rb
-- lib/diplomat/api_options.rb
 - lib/diplomat/check.rb
 - lib/diplomat/configuration.rb
 - lib/diplomat/datacenter.rb
@@ -240,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Diplomat is a simple wrapper for Consul

data/lib/diplomat/api_options.rb

@@ -1,46 +0,0 @@
-module Diplomat
-  # Helper methods for interacting with the Consul RESTful API
-  module ApiOptions
-    def check_acl_token
-      use_named_parameter('token', Diplomat.configuration.acl_token)
-    end
-
-    def use_cas(options)
-      options ? use_named_parameter('cas', options[:cas]) : []
-    end
-
-    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