diplomat 1.1.0 → 1.2.0

data/lib/diplomat/service.rb

@@ -1,27 +1,28 @@
-require 'base64'
-require 'faraday'
-
 module Diplomat
+  # Methods for interacting with the Consul serivce API endpoint.
   class Service < Diplomat::RestClient
-
     include ApiOptions
 
-    @access_methods = [ :get, :get_all, :register, :deregister, :register_external, :deregister_external ]
+    @access_methods = [:get, :get_all, :register, :deregister, :register_external, :deregister_external]
 
     # Get a service by it's key
     # @param key [String] the key
     # @param scope [Symbol] :first or :all results
-    # @param options [Hash] :wait string for wait time and :index for index of last query
+    # @param options [Hash] options parameter hash
+    # @option wait [Integer] :wait string for wait time
+    # @option index [String] :index for index of last query
+    # @option dc [String] :dc data center to make request for
+    # @option tag [String] :tag service tag to get
     # @param meta [Hash] output structure containing header information about the request (index)
     # @return [OpenStruct] all data associated with the service
-    def get key, scope=:first, options=nil, meta=nil
-
+    # rubocop:disable PerceivedComplexity, MethodLength, CyclomaticComplexity, AbcSize
+    def get(key, scope = :first, options = nil, meta = nil)
       url = ["/v1/catalog/service/#{key}"]
       url += check_acl_token
-      url << use_named_parameter('wait', options[:wait]) if options and options[:wait]
-      url << use_named_parameter('index', options[:index]) if options and options[:index]
-      url << use_named_parameter('dc', options[:dc]) if options and options[:dc]
-      url << use_named_parameter('tag', options[:tag]) if options and options[:tag]
+      url << use_named_parameter('wait', options[:wait]) if options && options[:wait]
+      url << use_named_parameter('index', options[:index]) if options && options[:index]
+      url << use_named_parameter('dc', options[:dc]) if options && options[:dc]
+      url << use_named_parameter('tag', options[:tag]) if options && options[:tag]
 
       # If the request fails, it's probably due to a bad path
       # so return a PathNotFound error.
@@ -31,42 +32,43 @@ module Diplomat
         raise Diplomat::PathNotFound, e
       end
 
-      if meta and ret.headers
-        meta[:index] = ret.headers["x-consul-index"]
-        meta[:knownleader] = ret.headers["x-consul-knownleader"]
-        meta[:lastcontact] = ret.headers["x-consul-lastcontact"]
+      if meta && ret.headers
+        meta[:index] = ret.headers['x-consul-index']
+        meta[:knownleader] = ret.headers['x-consul-knownleader']
+        meta[:lastcontact] = ret.headers['x-consul-lastcontact']
       end
 
       if scope == :all
-        return JSON.parse(ret.body).map { |service| OpenStruct.new service }
+        JSON.parse(ret.body).map { |service| OpenStruct.new service }
+      else
+        OpenStruct.new JSON.parse(ret.body).first
       end
-
-      return OpenStruct.new JSON.parse(ret.body).first
     end
+    # rubocop:enable PerceivedComplexity, MethodLength, CyclomaticComplexity, AbcSize
 
     # Get all the services
     # @param options [Hash] :dc Consul datacenter to query
     # @return [OpenStruct] the list of all services
-    def get_all options=nil
-      url = ["/v1/catalog/services"]
+    def get_all(options = nil)
+      url = ['/v1/catalog/services']
       url += check_acl_token
-      url << use_named_parameter('dc', options[:dc]) if options and options[:dc]
+      url << use_named_parameter('dc', options[:dc]) if options && options[:dc]
       begin
         ret = @conn.get concat_url url
       rescue Faraday::ClientError
         raise Diplomat::PathNotFound
       end
 
-      return OpenStruct.new JSON.parse(ret.body)
+      OpenStruct.new JSON.parse(ret.body)
     end
 
     # Register a service
     # @param definition [Hash] Hash containing definition of service
     # @return [Boolean]
-    def register(definition, path='/v1/agent/service/register')
+    def register(definition, path = '/v1/agent/service/register')
       json_definition = JSON.dump(definition)
       register = @conn.put path, json_definition
-      return register.status == 200
+      register.status == 200
     end
 
     # De-register a service
@@ -74,7 +76,7 @@ module Diplomat
     # @return [Boolean]
     def deregister(service_name)
       deregister = @conn.get "/v1/agent/service/deregister/#{service_name}"
-      return deregister.status == 200
+      deregister.status == 200
     end
 
     # Register an external service
@@ -90,7 +92,7 @@ module Diplomat
     def deregister_external(definition)
       json_definition = JSON.dump(definition)
       deregister = @conn.put '/v1/catalog/deregister', json_definition
-      return deregister.status == 200
+      deregister.status == 200
     end
   end
 end

data/lib/diplomat/session.rb

@@ -1,52 +1,99 @@
-require 'faraday'
-
 module Diplomat
+  # Methods for interacting with the Consul session API endpoint
   class Session < Diplomat::RestClient
-
-    @access_methods = [ :create, :destroy, :list, :renew ]
+    @access_methods = [:create, :destroy, :list, :renew, :info, :node]
 
     # Create a new session
     # @param value [Object] hash or json representation of the session arguments
+    # @param options [Hash] session options
+    # @param options [String] :dc datacenter to create session for
     # @return [String] The sesssion id
-    def create value=nil
+    def create(value = nil, options = nil)
       # TODO: only certain keys are recognised in a session create request,
       # should raise an error on others.
       raw = @conn.put do |req|
-        req.url "/v1/session/create"
-        req.body = (if value.kind_of?(String) then value else JSON.generate(value) end) unless value.nil?
+        url = ['/v1/session/create']
+        url += use_named_parameter('dc', options[:dc]) if options && options[:dc]
+
+        req.url concat_url url
+        req.body = (value.is_a?(String) ? value : JSON.generate(value)) unless value.nil?
       end
       body = JSON.parse(raw.body)
-      return body["ID"]
+      body['ID']
     end
 
     # Destroy a session
     # @param id [String] session id
-    # @return [nil]
-    def destroy id
+    # @param options [Hash] session options
+    # @param options [String] :dc datacenter to destroy session for
+    # @return [String] Success or failure of the session destruction
+    def destroy(id, options = nil)
       raw = @conn.put do |req|
-        req.url "/v1/session/destroy/#{id}"
+        url = ["/v1/session/destroy/#{id}"]
+        url += use_named_parameter('dc', options[:dc]) if options && options[:dc]
+
+        req.url concat_url url
       end
-      return raw.body
+      raw.body
     end
-    
+
     # List sessions
-    # @return [Struct]
-    def list
+    # @param options [Hash] session options
+    # @param options [String] :dc datacenter to list sessions
+    # @return [OpenStruct]
+    def list(options = nil)
       raw = @conn.get do |req|
-        req.url "/v1/session/list"
+        url = ['/v1/session/list']
+        url += use_named_parameter('dc', options[:dc]) if options && options[:dc]
+
+        req.url concat_url url
       end
-      JSON.parse(raw.body)
+      JSON.parse(raw.body).map { |session| OpenStruct.new session }
     end
-    
+
     # Renew session
     # @param id [String] session id
-    # @return [Struct]
-    
-    def renew id
+    # @param options [Hash] session options
+    # @param options [String] :dc datacenter to renew session for
+    # @return [OpenStruct]
+    def renew(id, options = nil)
       raw = @conn.put do |req|
-        req.url "/v1/session/renew/#{id}"
+        url = ["/v1/session/renew/#{id}"]
+        url += use_named_parameter('dc', options[:dc]) if options && options[:dc]
+
+        req.url concat_url url
+      end
+      JSON.parse(raw.body).map { |session| OpenStruct.new session }
+    end
+
+    # Session information
+    # @param id [String] session id
+    # @param options [Hash] session options
+    # @param options [String] :dc datacenter to renew session for
+    # @return [OpenStruct]
+    def info(id, options = nil)
+      raw = @conn.get do |req|
+        url = ["/v1/session/info/#{id}"]
+        url += use_named_parameter('dc', options[:dc]) if options && options[:dc]
+
+        req.url concat_url url
+      end
+      JSON.parse(raw.body).map { |session| OpenStruct.new session }
+    end
+
+    # Session information for a given node
+    # @param name [String] node name
+    # @param options [Hash] session options
+    # @param options [String] :dc datacenter to renew session for
+    # @return [OpenStruct]
+    def node(name, options = nil)
+      raw = @conn.get do |req|
+        url = ["/v1/session/node/#{name}"]
+        url += use_named_parameter('dc', options[:dc]) if options && options[:dc]
+
+        req.url concat_url url
       end
-      JSON.parse(raw.body)
+      JSON.parse(raw.body).map { |session| OpenStruct.new session }
     end
   end
 end

data/lib/diplomat/version.rb

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

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - John Hamelink
+- Trevor Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +182,7 @@ dependencies:
 description: Diplomat is a simple wrapper for Consul
 email:
 - john@johnhamelink.com
+- trevor.g.wood@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -191,11 +207,12 @@ files:
 - lib/diplomat/members.rb
 - lib/diplomat/node.rb
 - lib/diplomat/nodes.rb
+- lib/diplomat/query.rb
 - lib/diplomat/rest_client.rb
 - lib/diplomat/service.rb
 - lib/diplomat/session.rb
 - lib/diplomat/version.rb
-homepage: https://github.com/johnhamelink/diplomat
+homepage: https://github.com/WeAreFarmGeek/diplomat
 licenses:
 - BSD-3-Clause
 metadata: {}
@@ -215,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Diplomat is a simple wrapper for Consul