diplomat-scalp42 0.224

data/lib/diplomat/session.rb

@@ -0,0 +1,75 @@
+module Diplomat
+  # Methods for interacting with the Consul session API endpoint
+  class Session < Diplomat::RestClient
+    @access_methods = %i[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
+    # @return [String] The sesssion id
+    def create(value = nil, options = {})
+      # TODO: only certain keys are recognised in a session create request,
+      # should raise an error on others.
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      data = value.is_a?(String) ? value : JSON.generate(value) unless value.nil?
+      raw = send_put_request(@conn, ['/v1/session/create'], options, data, custom_params)
+      body = JSON.parse(raw.body)
+      body['ID']
+    end
+
+    # Destroy a session
+    # @param id [String] session id
+    # @param options [Hash] session options
+    # @return [String] Success or failure of the session destruction
+    def destroy(id, options = {})
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      raw = send_put_request(@conn, ["/v1/session/destroy/#{id}"], options, nil, custom_params)
+      raw.body
+    end
+
+    # List sessions
+    # @param options [Hash] session options
+    # @return [OpenStruct]
+    def list(options = {})
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      raw = send_get_request(@conn, ['/v1/session/list'], options, custom_params)
+      JSON.parse(raw.body).map { |session| OpenStruct.new session }
+    end
+
+    # Renew session
+    # @param id [String] session id
+    # @param options [Hash] session options
+    # @return [OpenStruct]
+    def renew(id, options = {})
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      raw = send_put_request(@conn, ["/v1/session/renew/#{id}"], options, nil, custom_params)
+      JSON.parse(raw.body).map { |session| OpenStruct.new session }
+    end
+
+    # Session information
+    # @param id [String] session id
+    # @param options [Hash] session options
+    # @return [OpenStruct]
+    def info(id, options = {})
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      raw = send_get_request(@conn, ["/v1/session/info/#{id}"], options, custom_params)
+      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
+    # @return [OpenStruct]
+    def node(name, options = {})
+      custom_params = []
+      custom_params << use_named_parameter('dc', options[:dc]) if options[:dc]
+      raw = send_get_request(@conn, ["/v1/session/node/#{name}"], options, custom_params)
+      JSON.parse(raw.body).map { |session| OpenStruct.new session }
+    end
+  end
+end

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
+    # @param options [Hash] options parameter hash
+    # @return [OpenStruct] the address of the leader
+    def leader(options = {})
+      ret = send_get_request(@conn, ['/v1/status/leader'], options)
+      JSON.parse(ret.body)
+    end
+
+    # Get an array of Raft peers for the datacenter in which the agent is running
+    # @param options [Hash] options parameter hash
+    # @return [OpenStruct] an array of peers
+    def peers(options = {})
+      ret = send_get_request(@conn, ['/v1/status/peers'], options)
+      JSON.parse(ret.body)
+    end
+  end
+end

data/lib/diplomat/token.rb

@@ -0,0 +1,129 @@
+module Diplomat
+  # Methods for interacting with the Consul ACL Policy API endpoint
+  class Token < Diplomat::RestClient
+    @access_methods = %i[list read create delete update clone self]
+    attr_reader :id, :type, :acl
+
+    # Read ACL token with the given Accessor ID
+    # @param id [String] accessor ID of the ACL token to read
+    # @param options [Hash] options parameter hash
+    # @return [Hash] existing ACL token
+    # rubocop:disable PerceivedComplexity
+    def read(id, options = {}, not_found = :reject, found = :return)
+      @options = options
+      custom_params = []
+      custom_params << use_consistency(options)
+
+      @raw = send_get_request(@conn_no_err, ["/v1/acl/token/#{id}"], options, custom_params)
+
+      if @raw.status == 200 && @raw.body.chomp != 'null'
+        case found
+        when :reject
+          raise Diplomat::AclNotFound, id
+        when :return
+          return parse_body
+        end
+      elsif @raw.status == 403
+        case not_found
+        when :reject
+          raise Diplomat::AclNotFound, id
+        when :return
+          return nil
+        end
+      else
+        raise Diplomat::UnknownStatus, "status #{@raw.status}: #{@raw.body}"
+      end
+    end
+    # rubocop:enable PerceivedComplexity
+
+    # List all the ACL tokens
+    # @param policy [String] filters the token list matching the specific policy ID
+    # @param options [Hash] options parameter hash
+    # @return [List] list of [Hash] of ACL tokens
+    def list(policy = nil, options = {})
+      custom_params = []
+      custom_params << use_named_parameter('policy', policy) if policy
+      @raw = send_get_request(@conn_no_err, ['/v1/acl/tokens'], options, custom_params)
+      raise Diplomat::AclNotFound if @raw.status == 403
+
+      parse_body
+    end
+
+    # Update an existing ACL token
+    # @param value [Hash] ACL token definition, AccessorID is mandatory
+    # @param options [Hash] options parameter hash
+    # @return [Hash] result ACL token
+    def update(value, options = {})
+      id = value[:AccessorID] || value['AccessorID']
+      raise Diplomat::AccessorIdParameterRequired if id.nil?
+
+      custom_params = use_cas(@options)
+      @raw = send_put_request(@conn, ["/v1/acl/token/#{id}"], options, value, custom_params)
+      if @raw.status == 200
+        parse_body
+      elsif @raw.status == 403
+        raise Diplomat::AclNotFound, id
+      elsif @raw.status == 400
+        raise Diplomat::TokenMalformed, @raw.body
+      else
+        raise Diplomat::UnknownStatus, "status #{@raw.status}: #{@raw.body}"
+      end
+    end
+
+    # Create a new ACL token
+    # @param value [Hash] ACL token definition
+    # @param options [Hash] options parameter hash
+    # @return [Hash] new ACL token
+    def create(value, options = {})
+      id = value[:AccessorID] || value['AccessorID']
+      raise Diplomat::TokenMalformed if id
+
+      custom_params = use_cas(@options)
+      @raw = send_put_request(@conn, ['/v1/acl/token'], options, value, custom_params)
+      return parse_body if @raw.status == 200
+
+      raise Diplomat::UnknownStatus, "status #{@raw.status}: #{@raw.body}"
+    end
+
+    # Delete an existing ACL token
+    # @param id [String] UUID of the ACL token to delete
+    # @param options [Hash] options parameter hash
+    # @return [Bool]
+    def delete(id, options = {})
+      @raw = send_delete_request(@conn, ["/v1/acl/token/#{id}"], options, nil)
+      @raw.body.chomp == 'true'
+    end
+
+    # Clone an existing ACL token
+    # @param value [Hash] ACL token definition, AccessorID is mandatory
+    # @param options [Hash] options parameter hash
+    # @return [Hash] cloned ACL token
+    def clone(value, options = {})
+      id = value[:AccessorID] || value['AccessorID']
+      raise Diplomat::AccessorIdParameterRequired if id.nil?
+
+      custom_params = use_cas(@options)
+      @raw = send_put_request(@conn, ["/v1/acl/token/#{id}/clone"], options, value, custom_params)
+      if @raw.status == 200
+        parse_body
+      elsif @raw.status == 403
+        raise Diplomat::AclNotFound, id
+      else
+        raise Diplomat::UnknownStatus, "status #{@raw.status}: #{@raw.body}"
+      end
+    end
+
+    # Returns ACL token details matching X-Consul-Token header
+    # @param options [Hash] options parameter hash
+    # @return [Hash] ACL token
+    def self(options = {})
+      custom_params = use_cas(@options)
+      @raw = send_get_request(@conn, ['/v1/acl/token/self'], options, custom_params)
+      if @raw.status == 200
+        parse_body
+      elsif @raw.status == 403
+        raise Diplomat::AclNotFound, id
+      end
+    end
+  end
+end

data/lib/diplomat/version.rb

@@ -0,0 +1,3 @@
+module Diplomat
+  VERSION = '0.224'.freeze
+end

data/lib/diplomat.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'base64'
+require 'faraday'
+
+# Top level namespace ensures all required libraries are included and initializes the gem configration.
+module Diplomat
+  class << self
+    attr_accessor :root_path
+    attr_accessor :lib_path
+    attr_accessor :configuration
+
+    # Internal: Requires internal Faraday libraries.
+    # @param *libs One or more relative String names to Faraday classes.
+    # @return [nil]
+    def require_libs(*libs)
+      libs.each do |lib|
+        require "#{lib_path}/#{lib}"
+      end
+    end
+
+    alias require_lib require_libs
+  end
+
+  raise 'Diplomat only supports ruby >= 2.0.0' unless RUBY_VERSION.to_f >= 2.0
+
+  self.root_path = File.expand_path __dir__
+  self.lib_path = File.expand_path 'diplomat', __dir__
+
+  require_libs 'configuration', 'rest_client', 'kv', 'datacenter', 'service',
+               'members', 'node', 'nodes', 'check', 'health', 'session', 'lock',
+               'error', 'event', 'acl', 'maintenance', 'query', 'agent', 'status',
+               'policy', 'token'
+  self.configuration ||= Diplomat::Configuration.new
+
+  class << self
+    # Build optional configuration by yielding a block to configure
+    # @yield [Diplomat::Configuration]
+    def configure
+      self.configuration ||= Diplomat::Configuration.new
+      yield(configuration)
+    end
+
+    private
+
+    # Send all other unknown commands to Diplomat::Kv
+    # @deprecated Please use Diplomat::Kv instead.
+    # @param name [Symbol] Method to send to Kv
+    # @param *args List of arguments to send to Kv
+    # @param &block block to send to Kv
+    # @return [Object]
+    def method_missing(name, *args, &block)
+      Diplomat::Kv.new.send(name, *args, &block) || super
+    end
+
+    # Make `respond_to_missing?` fall back to super
+    #
+    # @param meth_id [Symbol] the tested method
+    # @oaram with_private if private methods should be tested too
+    def respond_to_missing?(meth_id, with_private = false)
+      access_method?(meth_id) || super
+    end
+  end
+end

metadata

@@ -0,0 +1,267 @@
+--- !ruby/object:Gem::Specification
+name: diplomat-scalp42
+version: !ruby/object:Gem::Version
+  version: '0.224'
+platform: ruby
+authors:
+- John Hamelink
+- Trevor Wood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fakes-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    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: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Diplomat is a simple wrapper for Consul
+email:
+- john@johnhamelink.com
+- trevor.g.wood@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- features/configuration.feature
+- features/step_definitions/setup_diplomat.rb
+- features/step_definitions/test_key_value.rb
+- lib/diplomat.rb
+- lib/diplomat/acl.rb
+- lib/diplomat/agent.rb
+- lib/diplomat/check.rb
+- lib/diplomat/configuration.rb
+- lib/diplomat/datacenter.rb
+- lib/diplomat/error.rb
+- lib/diplomat/event.rb
+- lib/diplomat/health.rb
+- lib/diplomat/kv.rb
+- lib/diplomat/lock.rb
+- lib/diplomat/maintenance.rb
+- lib/diplomat/members.rb
+- lib/diplomat/node.rb
+- lib/diplomat/nodes.rb
+- lib/diplomat/policy.rb
+- lib/diplomat/query.rb
+- lib/diplomat/rest_client.rb
+- lib/diplomat/service.rb
+- lib/diplomat/session.rb
+- lib/diplomat/status.rb
+- lib/diplomat/token.rb
+- lib/diplomat/version.rb
+homepage: https://github.com/WeAreFarmGeek/diplomat
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Diplomat is a simple wrapper for Consul
+test_files: []