Feature/http check

.rubocop.yml

@@ -2,12 +2,30 @@
 AllCops:
   DisplayCopNames: true
 
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
 Metrics/LineLength:
   # This will disable the rule completely, regardless what other options you put
   Enabled: true
   # Change the default 80 chars limit value
   Max: 120
 
+Metrics/MethodLength:
+  # This cop checks if the length of a method exceeds some maximum value
+  Enabled: true
+  # Change the default 10 lines limit value
+  Max: 50
+
 # Allow classes longer than 100 lines of code
 ClassLength:
   Max: 250
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Lint/UnneededCopDisableDirective:
+  Enabled: false

.travis.yml

@@ -1,11 +1,17 @@
 language: ruby
-before_install: 
-  - gem install bundler
+before_install:
+- gem install bundler
 rvm:
-    - "2.0.0"
-    - "2.1.0"
-    - "2.2.1"
-    - "2.2.2"
+- 2.3.8
+- 2.4.5
+- 2.5.3
+- 2.6.1
 addons:
-    code_climate:
-        repo_token: 0c910d8f8af55cc2d2f38170d5362be4e16be8ce232df9c565057985af264b7b
+  code_climate:
+    repo_token: 0c910d8f8af55cc2d2f38170d5362be4e16be8ce232df9c565057985af264b7b
+deploy:
+  provider: rubygems
+  api_key:
+    secure: RbB9Va0vmEY3hyCDuvDxj6G/cmgD8ZQ3Wwg2Xx+oi64AWOckmTa4e4nVR6231kkgF63fG2swpkRhyHU+pfRSy+m/Ng8qAK4IIDgce6FTMPbzY45TlzPDq9OKsLyChYtkCnRTjXI16cS9+t1OBAXtwEDgQnXG7VDU4cRi3NMyFCk=
+  on:
+    tags: true

CHANGELOG.md

@@ -1,5 +1,56 @@
 # Changelog
 
+## Next
+
+## 2.1.3
+
+- 2019-03-20 Lars Remes [lars.remes@ramboll.fi][1] Support HTTP service checks
+
+## 2.1.2
+
+Bugfix relase: fix #188
+
+Release 2.1.0 did break a few things. Ensure more compatibility with 2.0.x
+
+## 2.1.1
+
+Bugfix release.
+
+- Fix for #186
+
+## 2.1.0
+
+This release cleanup a lot the existing APIs while preserving ascending compatibility.
+It will avoid relying on side effects to configure diplomat and allow to override most
+configuration options per API call as implemented in https://github.com/WeAreFarmGeek/diplomat/pull/179.
+It is now easy to use one instance of the lib and to perform several calls with different tokens and/or
+consistency options for instance.
+
+Full changelog:
+
+- Fix behavior of HTTP 302 on some 2.5 ruby releases (#181 fix #171)
+- Set flags attribute on KVPair during lock acquisition and release (#180)
+- Now allow to override most parameters per request (#179)
+- use dedup for safer/simpler conversion of results to hash #176
+
+## 2.0.5
+
+- Fix incorrect verbs for checks Fix https://github.com/WeAreFarmGeek/diplomat/issues/173
+- Use json_pure to avoid the need for installing a compiler. Fix https://github.com/WeAreFarmGeek/diplomat/issues/177
+- Allow updating Output with TTL checks https://github.com/WeAreFarmGeek/diplomat/pull/178
+
+## 2.0.4
+
+- automatic GEM publication from Travis when a tag is pushed
+- Depreciate old Ruby version 2.2.x
+- Bump bundler to version 2.0.x
+
+## 2.0.3
+
+- 2018-09-06 Allow to register/deregister entities using tokens
+- 2017-11-09 Josep M. Blanquer (@blanquer) Fix service deregister to use the proper verb (`PUT` instead of `GET`). Consul 1.x seems to
+have started enforcing [it](https://www.consul.io/docs/upgrade-specific.html#http-verbs-are-enforced-in-many-http-apis).
+
 ## 2.0.2
 
 - 2017-08-23 Trevor Wood [trevor.g.wood@gmail.com][1] Revert the change to single values

README.md

@@ -1,8 +1,8 @@
 # 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)](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)
 ### A HTTP Ruby API for [Consul](http://www.consul.io/)
 
-![Diplomacy Boad Game](http://i.imgur.com/Nkuy4b7.jpg)
+![Diplomacy Board Game](http://i.imgur.com/Nkuy4b7.jpg)
 
 
 ## FAQ
@@ -72,12 +72,14 @@ foo = Diplomat::Kv.get('foo')
 ```
 
 Or retrieve a value from another datacenter:
+
 ```ruby
 foo = Diplomat::Kv.get('foo', :dc => 'dc-west')
 # => "baz"
 ```
 
 You can also retrieve values recursively:
+
 ```ruby
 Diplomat::Kv.put('foo/a', 'lorem')
 Diplomat::Kv.put('foo/b', 'ipsum')
@@ -94,6 +96,7 @@ Or list all available keys:
 Diplomat::Kv.get('/', :keys => true) # => ['foo/a', 'foo/b']
 ```
 You can convert the consul data to a ruby hash
+
 ```ruby
 Diplomat::Kv.put('foo/a', 'lorem')
 Diplomat::Kv.put('foo/b', 'ipsum')
@@ -180,6 +183,14 @@ services = Diplomat::Service.get_all({ :dc => 'My_Datacenter' })
 # => #<OpenStruct consul=[], foo=[], bar=[]>
 ```
 
+#### Checks
+
+Register a check:
+```ruby
+headers = { "Authorization" => [ "Basic ZGlwbG9tYXQ6cGFzc3dvcmQ=" ] }
+Diplomat::Check.register_http("http://#{addr}:#{port}/health_check", '10s', id: 'health-check-1', name: 'Health check', notes: 'Node level HTTP health check', method: 'GET', headers: {}, timeout: '1s')
+```
+
 ### Datacenters
 
 Getting a list of datacenters is quite simple and gives you the option to extract all services out of
@@ -310,15 +321,27 @@ 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
 ```
 
 This is traditionally kept inside the `config/initializers` directory if you're using rails. The middleware allows you to customise what happens when faraday sends and receives data. This can be useful if you want to instrument your use of diplomat, for example. You can read more about Faraday's custom middleware [here](http://stackoverflow.com/a/20973008).
 
+Alternatively, configuration settings can be overriden at each method call allowing for instance to address different consul agents, with some other token.
+
+```ruby
+Diplomat::Service.get('foo', { http_addr: 'http://consu01:8500' })
+Diplomat::Service.get('foo', { http_addr: 'http://consu02:8500' })
+Diplomat::Kv.put('key/path', 'value', { http_addr: 'http://localhost:8500', dc: 'dc1', token: '111-222-333-444-555' })
+```
+
+Most common options are:
+* dc: target datacenter
+* token: identity used to perform the corresponding action
+* http_addr: to target a remote consul node
+* stale: use consistency mode that allows any server to service the read regardless of whether it is the leader
+
 ### Todo
 
 -  [ ] Updating Docs with latest changes

diplomat.gemspec

@@ -9,17 +9,19 @@ Gem::Specification.new 'diplomat', Diplomat::VERSION do |spec|
 
   spec.files         = `git ls-files lib README.md LICENSE features`.split("\n")
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'pry', '~> 0.9'
-  spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'fakes-rspec', '~> 2.1'
+  spec.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.1'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.0'
+  spec.add_development_dependency 'cucumber', '~> 2.0'
+  spec.add_development_dependency 'fakes-rspec', '~> 2.1'
   spec.add_development_dependency 'fivemat', '~> 1.3'
   spec.add_development_dependency 'gem-release', '~> 0.7'
-  spec.add_development_dependency 'cucumber', '~> 2.0'
-  spec.add_development_dependency 'rubocop', '~> 0.47', '>= 0.47.1'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'webmock'
 
-  spec.add_runtime_dependency 'json' if RUBY_VERSION < '1.9.3'
+  spec.add_runtime_dependency 'deep_merge', '~> 1.0', '>= 1.0.1'
   spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'json_pure' if RUBY_VERSION < '1.9.3'
 end

lib/diplomat.rb

@@ -23,11 +23,11 @@ def require_libs(*libs)
 
   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
 

lib/diplomat/acl.rb

@@ -1,23 +1,22 @@
 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
 
     # Get Acl info by ID
     # @param id [String] ID of the Acl to get
+    # @param options [Hash] options parameter hash
     # @return [Hash]
-    # rubocop:disable PerceivedComplexity, MethodLength, CyclomaticComplexity, AbcSize
-    def info(id, options = nil, not_found = :reject, found = :return)
+    # rubocop:disable PerceivedComplexity
+    def info(id, options = {}, not_found = :reject, found = :return)
       @id = id
       @options = options
-      url = ["/v1/acl/info/#{id}"]
-      url << check_acl_token
-      url << use_consistency(options)
+      custom_params = []
+      custom_params << use_consistency(options)
+
+      raw = send_get_request(@conn_no_err, ["/v1/acl/info/#{id}"], options, custom_params)
 
-      raw = @conn_no_err.get concat_url url
       if raw.status == 200 && raw.body.chomp != 'null'
         case found
         when :reject
@@ -37,55 +36,45 @@ def info(id, options = nil, not_found = :reject, found = :return)
         raise Diplomat::UnknownStatus, "status #{raw.status}: #{raw.body}"
       end
     end
-    # rubocop:enable PerceivedComplexity, MethodLength, CyclomaticComplexity, AbcSize
+    # rubocop:enable PerceivedComplexity
 
     # List all Acls
+    # @param options [Hash] options parameter hash
     # @return [List] list of [Hash] of Acls
-    def list
-      url = ['/v1/acl/list']
-      url += check_acl_token
-      @raw = @conn_no_err.get concat_url url
+    def list(options = {})
+      @raw = send_get_request(@conn_no_err, ['/v1/acl/list'], options)
       parse_body
     end
 
     # Update an Acl definition, create if not present
     # @param value [Hash] Acl definition, ID field is mandatory
+    # @param options [Hash] options parameter hash
     # @return [Hash] The result Acl
-    def update(value)
-      raise Diplomat::IdParameterRequired unless value['ID']
+    def update(value, options = {})
+      raise Diplomat::IdParameterRequired unless value['ID'] || value[:ID]
 
-      @raw = @conn.put do |req|
-        url = ['/v1/acl/update']
-        url += check_acl_token
-        url += use_cas(@options)
-        req.url concat_url url
-        req.body = value.to_json
-      end
+      custom_params = use_cas(@options)
+      @raw = send_put_request(@conn, ['/v1/acl/update'], options, value.to_json, custom_params)
       parse_body
     end
 
     # Create an Acl definition
     # @param value [Hash] Acl definition, ID field is mandatory
+    # @param options [Hash] options parameter hash
     # @return [Hash] The result Acl
-    def create(value)
-      @raw = @conn.put do |req|
-        url = ['/v1/acl/create']
-        url += check_acl_token
-        url += use_cas(@options)
-        req.url concat_url url
-        req.body = value.to_json
-      end
+    def create(value, options = {})
+      custom_params = use_cas(@options)
+      @raw = send_put_request(@conn, ['/v1/acl/create'], options, value.to_json, custom_params)
       parse_body
     end
 
     # Destroy an ACl token by its id
     # @param ID [String] the Acl ID
+    # @param options [Hash] options parameter hash
     # @return [Bool]
-    def destroy(id)
+    def destroy(id, options = {})
       @id = id
-      url = ["/v1/acl/destroy/#{@id}"]
-      url << check_acl_token
-      @raw = @conn.put concat_url url
+      @raw = send_put_request(@conn, ["/v1/acl/destroy/#{@id}"], options, nil)
       @raw.body.chomp == 'true'
     end
   end