class Diplomat::Session

Methods for interacting with the Consul session API endpoint

Public Instance Methods

create(value = nil, options = nil) click to toggle source

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

# File lib/diplomat/session.rb, line 11
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|
    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)
  body['ID']
end
destroy(id, options = nil) click to toggle source

Destroy a session @param id [String] session id @param options [Hash] session options @param options [String] :dc datacenter to destroy session for @return [String] Success or failure of the session destruction

# File lib/diplomat/session.rb, line 30
def destroy(id, options = nil)
  raw = @conn.put do |req|
    url = ["/v1/session/destroy/#{id}"]
    url += use_named_parameter('dc', options[:dc]) if options && options[:dc]

    req.url concat_url url
  end
  raw.body
end
info(id, options = nil) click to toggle source

Session information @param id [String] session id @param options [Hash] session options @param options [String] :dc datacenter to renew session for @return [OpenStruct]

# File lib/diplomat/session.rb, line 74
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
list(options = nil) click to toggle source

List sessions @param options [Hash] session options @param options [String] :dc datacenter to list sessions @return [OpenStruct]

# File lib/diplomat/session.rb, line 44
def list(options = nil)
  raw = @conn.get do |req|
    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).map { |session| OpenStruct.new session }
end
node(name, options = nil) click to toggle source

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]

# File lib/diplomat/session.rb, line 89
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).map { |session| OpenStruct.new session }
end
renew(id, options = nil) click to toggle source

Renew session @param id [String] session id @param options [Hash] session options @param options [String] :dc datacenter to renew session for @return [OpenStruct]

# File lib/diplomat/session.rb, line 59
def renew(id, options = nil)
  raw = @conn.put do |req|
    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