imperium 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0843f656e4b5c634136bdcddd59a8a81528ca45b'
+  data.tar.gz: 85309c76a17789e23090a36c8d076c119755d1c9
+SHA512:
+  metadata.gz: 1e2acf912515f5ebd12282d4f7f6f13a164b386741a0578c8a2180d21f8828552c1ed6c480396ce057486fa7fb8d56e5315be11fc08b306eeaa0c8317e516c7f
+  data.tar.gz: 2538b80f19905a4b360252681615fce837b4f28e5c4a9e59c3b42914454e2e303756fe67818aaf1882c9dc82d2812b2a3cf0e5d513599a75e113b6b33d80efe2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+docker-compose.override.yml

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+before_install: gem install bundler -v 1.13.6
+rvm:
+  - "2.1"
+  - "2.2"
+  - "2.3"
+  - "2.4.0"

data/Dockerfile.ci

@@ -0,0 +1,19 @@
+FROM instructure/rvm
+
+WORKDIR /app
+
+COPY imperium.gemspec Gemfile* /app/
+COPY lib/imperium/version.rb /app/lib/imperium/version.rb
+
+USER root
+RUN chown -R docker:docker /app
+USER docker
+
+RUN /bin/bash -l -c "cd /app && bundle install"
+COPY . /app
+
+USER root
+RUN chown -R docker:docker /app
+USER docker
+
+CMD /bin/bash -l -c "bundle exec wwtd --parallel"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in imperium.gemspec
+gemspec

data/README.md

@@ -0,0 +1,90 @@
+# Imperium
+
+Imperium is a Latin word which roughly translates to 'power to command'. It was
+often applied to official, and unofficial, positions of power. In this case,
+specifically the office of Consul.
+
+Imperium is a Consul client for Ruby applications, it aims to be as ergonomic
+as possible for users while giving the flexibility required for complex
+applications. At first only the KV store will be supported but additional
+functionality is expected to be added as needed (or as pull requests are
+submitted).
+
+## Motivation.
+As Instructure's use of Consul has grown so have our wants and needs in a client
+library have grown. The goal of this gem is to provide a lightweight, thread
+safe interface to the full power of Consul's API while not forcing the consumer
+to use all of it where unnecessary. For now we're focusing on the KV store since
+most of our use revolves around it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'imperium'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imperium
+
+## Usage
+
+Configure:
+
+```
+# The following configuration values are used for the default client for each
+# service. This isn't the only way to get a client set up but will fill the
+# needs of most applications.
+Imperium.configure do |config|
+  # Connection values can be specified separately
+  config.host = 'consul.example.com'
+  config.port = 8585 
+  config.ssl = false
+
+  # Or, as a url (this is equivilant to the example above).
+  config.url = 'http://consul.example.com:8585'
+
+  confg.token = 'super-sekret-value'
+end
+
+# If you want a client that uses some other configuration values without altering
+# the default ones you can directly instantiate a Configuration object:
+
+config = Imperium::Configuration.new(url: 'https://other-consul.example.com', token: 'foobar')
+# This client will contact other-consul.example.com rather than the one configured above.
+kv_client = Imperium::KV.new(config) 
+```
+
+GET values from the KV store:
+```
+# Get a single value
+response = Imperium::KV.get('config/single-value', :stale) 
+response.values # => 'qux'
+
+# Get a set of nested values
+response = Imperium::KV.get('config/complex-value', :recurse) 
+response.values # => {first: 'value', second: 'value'}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/rspec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/instructure/imperium.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "imperium"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/build.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+
+docker-compose build
+docker-compose run --rm app $@

data/docker-compose.override.yml.example

@@ -0,0 +1,9 @@
+version: "2"
+services:
+  app:
+    volumes:
+      - "gems:/home/docker/.gem"
+      - ".:/app"
+
+volumes:
+  gems: {}

data/docker-compose.yml

@@ -0,0 +1,20 @@
+version: "2"
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile.ci
+    links:
+      - consul
+    environment:
+      IMPERIUM_CONSUL_HOST: "consul"
+      IMPERIUM_CONSUL_PORT: 8500
+      IMPERIUM_CONSUL_SSL: "false"
+
+  consul:
+    image: consul:0.7.2
+    command: agent -dev -client 0.0.0.0 -datacenter imperium-dev -node imperium-consul -bootstrap
+    environment:
+      GOMAXPROCS: "2"
+      VIRTUAL_PORT: 8500

data/imperium.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imperium/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'imperium'
+  spec.version       = Imperium::VERSION
+  spec.authors       = ['Tyler Pickett']
+  spec.email         = ['t.pickett66@gmail.com']
+
+  spec.summary       = %q{A powerful, easy to use, Consul client}
+  spec.description   = %q{A powerful, easy to use, Consul client}
+  spec.homepage      = 'https://github.com/instructure/imperium'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'addressable', '~> 2.5.0'
+  spec.add_dependency 'httpclient', '~> 2.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3.2'
+  spec.add_development_dependency 'wwtd', '~> 1.3'
+  spec.add_development_dependency 'yard'
+end

data/lib/imperium.rb

@@ -0,0 +1,22 @@
+require 'imperium/error'
+
+require 'imperium/configuration'
+require 'imperium/client'
+require 'imperium/http_client'
+require 'imperium/kv'
+require 'imperium/kv_pair'
+require 'imperium/kv_get_response'
+require 'imperium/response'
+require 'imperium/version'
+
+module Imperium
+  def self.configure
+    yield configuration
+  ensure
+    Client.reset_default_clients
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/imperium/client.rb

@@ -0,0 +1,58 @@
+require 'base64'
+require 'json'
+
+module Imperium
+  class Client
+    class << self
+      attr_reader :subclasses
+      attr_accessor :path_prefix
+
+      def default_client
+        @default_client ||= new(Imperium.configuration)
+      end
+
+      def reset_default_client
+        @default_client = nil
+      end
+    end
+
+    @subclasses = []
+    def self.inherited(subclass)
+      @subclasses << subclass
+    end
+
+    def self.reset_default_clients
+      @subclasses.each(&:reset_default_client)
+    end
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+      @http_client = Imperium::HTTPClient.new(config)
+    end
+
+    def path_prefix
+      self.class.path_prefix
+    end
+
+    private
+
+    def extract_query_params(full_options, allowed_params: :all)
+      if full_options.key?(:consistent) && full_options.key?(:stale)
+        raise InvalidConsistencySpecification, 'Both consistency modes (consistent, stale) supplied, this is not allowed by the HTTP API'
+      end
+      allowed_params == :all ? full_options : full_options.select { |k, _| allowed_params.include?(k.to_sym) }
+    end
+
+    def hashify_options(options_array)
+      options_array.inject({}) { |hash, value|
+        value.is_a?(Hash) ? hash.merge(value) : hash.merge(value.to_sym => nil)
+      }
+    end
+
+    def prefix_path(main_path, prefix = self.path_prefix)
+      "#{prefix}/#{main_path}"
+    end
+  end
+end

data/lib/imperium/configuration.rb

@@ -0,0 +1,76 @@
+require 'addressable/uri'
+require 'forwardable'
+
+module Imperium
+  # The Configuration class represents the values necessary for making contact
+  # with a Consul agent.
+  #
+  # @!attribute [rw] connect_timeout
+  #   @return [Integer] The number of seconds to wait for a connection to Consul
+  #   to open before failing, default: 5
+  # @!attribute [rw] receive_timeout
+  #   @return [Integer] The number of seconds to wait for a response from Consul
+  #   to open before failing, default: 60. This default is quite high in order to
+  #   support long polling.
+  # @!attribute [rw] send_timeout
+  #   @return [Integer] The number of seconds to wait for the request body to
+  #   finish uploading to Consul to open before failing, default: 15.
+  # @!attribute [rw] token
+  #   @return [String] The token to be used when making requests to the Consul
+  #   APIs. Defaults to `nil`
+  # @!attribute [rw] url
+  #   @return [Addressable::URI] The base URL, including port, for contacting
+  #   the Consul agent. Defaults to `http://localhost:8500`
+  class Configuration
+    extend Forwardable
+
+    attr_reader :url
+    attr_accessor :connect_timeout, :receive_timeout, :send_timeout, :token
+
+    def initialize(url: 'http://localhost:8500', token: nil)
+      @url = Addressable::URI.parse(url)
+      @connect_timeout = 5
+      @send_timeout = 15
+      @receive_timeout = 60
+      @token = token
+    end
+
+    def_delegators :@url, :host, :host=, :port, :port=
+
+    # Check if the specified URL is using SSL/TLS
+    # @return [Boolean]
+    def ssl?
+      @url.scheme == 'https'
+    end
+
+    # Configure the clients to use SSL/TLS (or not).
+    #
+    # @param value [Boolean]
+    # @raise [NoMethodError] When the URL has previously been set to nil.
+    def ssl=(value)
+      @url.scheme = (!!value ? 'https' : 'http')
+    end
+
+    # Check for the presence of a token
+    # @return [Boolean]
+    def token?
+      @token && !@token.empty?
+    end
+
+    # Set the URL
+    #
+    # This method will append a trailing slash to the supplied URL if not
+    # included. We're doing this because merging a path onto a URL missing the
+    # trailing slash will remove any extant path components.
+    #
+    # @param value [String, Addressable::URI, URI::GenericURI] The new value to use.
+    def url=(value)
+      if value.nil?
+        @url = nil
+      else
+        @url = Addressable::URI.parse(value)
+        @url.path << '/' unless @url.path.end_with?('/')
+      end
+    end
+  end
+end

data/lib/imperium/error.rb

@@ -0,0 +1,5 @@
+
+module Imperium
+  class Error < StandardError; end
+  class InvalidConsistencySpecification < Error; end
+end

data/lib/imperium/http_client.rb

@@ -0,0 +1,41 @@
+require 'httpclient'
+
+module Imperium
+  class HTTPClient
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+      @driver = ::HTTPClient.new
+      @driver.connect_timeout = @config.connect_timeout
+      @driver.send_timeout = @config.send_timeout
+      @driver.receive_timeout = @config.receive_timeout
+    end
+
+    def delete(path)
+      url = config.url.join(path)
+      @driver.delete(url)
+    end
+
+    def get(path, query: {})
+      url = config.url.join(path)
+      url.query_values = query
+      @driver.get(url, header: build_request_headers)
+    end
+
+    def put(path, value)
+      url = config.url.join(path)
+      @driver.put(url, body: value)
+    end
+
+    private
+
+    def build_request_headers
+      if config.token?
+        {'X-Consul-Token' => config.token}
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/imperium/kv.rb

@@ -0,0 +1,92 @@
+module Imperium
+  # A client for the KV API.
+  class KV < Client
+    self.path_prefix = 'v1/kv'.freeze
+
+    # {#get GET} a key using the {.default_client}
+    # @see #get
+    def self.get(key, *options)
+      default_client.get(key, *options)
+    end
+
+    # Delete the specified key
+    # @note This is really a stub of this method, it will delete the key but
+    #   you'll get back a raw
+    #   {http://www.rubydoc.info/gems/httpclient/HTTP/Message HTTP::Message}
+    #   object. If you're really serious about using this we'll probably want
+    #   to build a wrapper around the response with some logic to simplify
+    #   interpreting the response.
+    #
+    # @param key [String] The key to be deleted
+    # @param options [Array] Un-used, only here to prevent changing the method
+    #   signature when we actually implement more advanced functionality.
+    # @return [HTTP::Message]
+    def delete(key, *options)
+      @http_client.delete(prefix_path(key))
+    end
+
+    GET_ALLOWED_OPTIONS = %i{consistent stale recurse keys separator raw}.freeze
+    private_constant :GET_ALLOWED_OPTIONS
+    # Get the specified key/prefix using the supplied options.
+    #
+    # @example Fetching a key that is allowed to be stale.
+    #   response = Imperium::KV.get('foo/bar', :stale) # => KVGETResponse...
+    #
+    # @example Fetching a prefix recursively allowing values to be stale.
+    #   response = Imperium::KV.get('foo/bar', :stale, :recurse) # => KVGETResponse...
+    #
+    # @todo Support blocking queries by accepting an :index parameter
+    #
+    # @param [String] key The key/prefix to be fetched from Consul.
+    # @param [Array<Symbol,String,Hash>] options The options for constructing
+    #   the request
+    # @option options [Symbol] :consistent Specify the consistent option to the
+    #   API resulting in the most up to date value possible at the expense of a
+    #   bit of latency and the requirement of a validly elected leader. See
+    #   {https://www.consul.io/docs/agent/http.html#consistency-modes Consistency Modes documentation}.
+    # @option options [Symbol] :stale Specify the stale option to the API
+    #   resulting in a potentially stale value with the benefit of a faster,
+    #   more scaleable read. See
+    #   {https://www.consul.io/docs/agent/http.html#consistency-modes Consistency Modes documentation}.
+    # @option options [Symbol] :recurse Supply the recurse option to the API to
+    #   fetch any keys with the specified prefix.
+    # @option options [Symbol] :keys Fetch only the keys with the specified prefix.
+    # @option options [String] :separator See
+    #   {https://www.consul.io/docs/agent/http/kv.html#get-method Consul's Documentation}
+    # @return [KVGETResponse]
+    def get(key, *options)
+      expanded_options = hashify_options(options)
+      query_params = extract_query_params(expanded_options, allowed_params: GET_ALLOWED_OPTIONS)
+      response = @http_client.get(prefix_path(key), query: query_params)
+      KVGETResponse.new(response, prefix: key, options: expanded_options)
+    end
+
+    # Update or create the specified key
+    # @note This is really a stub of this method, it will put the key but
+    #   you'll get back a raw
+    #   {http://www.rubydoc.info/gems/httpclient/HTTP/Message HTTP::Message}
+    #   object. If you're really serious about using this we'll probably want
+    #   to build a wrapper around the response with some logic to simplify
+    #   interpreting the response.
+    #
+    # @param key [String] The key to be created or updated.
+    # @param value [String] The value to be set on the key.
+    # @param options [Array] Un-used, only here to prevent changing the method
+    #   signature when we actually implement more advanced functionality.
+    # @return [HTTP::Message]
+    def put(key, value, *options)
+      @http_client.put(prefix_path(key), value)
+    end
+
+    private
+
+    def construct_nested_hash(key_parts, value)
+      key = key_parts.shift
+      if key_parts.empty?
+        {key => value}
+      else
+        {key => construct_nested_hash(key_parts, value)}
+      end
+    end
+  end
+end

data/lib/imperium/kv_get_response.rb

@@ -0,0 +1,102 @@
+require_relative 'response'
+
+module Imperium
+  # KVGETResponse is a wrapper for the raw HTTP::Message response from the API
+  #
+  # @note This class doesn't really make sense to be instantiated outside of
+  #   {KV#get}
+  #
+  # @!attribute [rw] options
+  #   @return [Hash<Symbol, Object>] The options for the get request after being
+  #   coerced from an array to hash.
+  # @attribute [rw] prefix
+  #   @return [String] The key prefix requested from the api, used to coerce the
+  #   returned values from the API into their various shapes.
+  class KVGETResponse < Response
+    attr_accessor :options, :prefix
+
+    def initialize(message, options: {}, prefix: '')
+      super message
+      @prefix = prefix
+      @options = options
+    end
+
+    # Construct an Array of KV pairs from a response, including their full
+    # metadata.
+    #
+    # @return [nil] When the keys option was supplied.
+    # @return [Array<KVPair>] When there are values present, and an empty array
+    #   when the response is a 404.
+    def found_objects
+      return if options.key?(:keys)
+      return [] if not_found?
+      @found_objects ||= parsed_body.map { |attrs| KVPair.new(attrs) }
+    end
+
+    def prefix=(value)
+      @prefix = (value.nil? ? nil : value.sub(/\/\z/, ''))
+    end
+
+    MERGING_FUNC = -> (_, old, new) {
+      if old.is_a?(Hash) && new.is_a?(Hash)
+        old.merge(new, &MERGING_FUNC)
+      else
+        new
+      end
+    }
+    private_constant :MERGING_FUNC
+
+    # Extracts the values from the response and smashes them into a simple
+    # object depending on options provided on the request.
+    #
+    # @example A nested hash constructed from recursively found values
+    #   # Given a response including the following values (metadata ommitted for clarity):
+    #   # [
+    #   #   {"Key" => "foo/bar/baz/first", "Value" => "cXV4Cg=="},
+    #   #   {"Key" => "foo/bar/baz/second/deep", "Value" => "cHVycGxlCg=="}
+    #   # ]
+    #   response = Imperium::KV.get('foo/bar/baz', :recurse)
+    #   response.values # => {'first' => 'qux', 'second' => {'deep' => 'purple'}}
+    #
+    # @return [String] When the matching key is found without the `recurse`
+    #   option as well as when a single value is found with the recurse option
+    #   and the key exactly matches the prefix.
+    # @return [Hash{String => Hash,String}] When the recurse option is included
+    #   and there are keys present nested within the prefix.
+    # @return [Array<String>] An array of strings representing all of the keys
+    #   within the specified prefix when the keys option is included.
+    # @return [nil] When the response status code is 404 (Not Found)
+    def values
+      return if not_found?
+      return parsed_body if options.key?(:keys)
+      if options.key?(:recurse)
+        if found_objects.size == 1 && found_objects.first.key == prefix
+          found_objects.first.value
+        else
+          found_objects.inject({}) do |hash, obj|
+            if prefix.empty?
+              unprefixed_key = obj.key
+            else
+              unprefixed_key = obj.key[prefix.length + 1..-1]
+            end
+            key_parts = unprefixed_key.split('/')
+            hash.merge(construct_nested_hash(key_parts, obj.value), &MERGING_FUNC)
+          end
+        end
+      else
+        found_objects.first.value
+      end
+    end
+
+    private
+
+    def construct_nested_hash(key_parts, value)
+      key = key_parts.shift
+      if key_parts.empty?
+        {key => value}
+      else
+        {key => construct_nested_hash(key_parts, value)}
+      end
+    end
+  end
+end

data/lib/imperium/kv_pair.rb

@@ -0,0 +1,66 @@
+require 'base64'
+
+module Imperium
+  # KVPair provides a more OO/Rubyish interface to the objects returned from
+  # the KV API on a GET request.
+  #
+  # @see https://www.consul.io/docs/agent/http/kv.html#get-method Consul KV GET Documentation
+  #
+  # @!attribute [rw] lock_index
+  #   @return [Integer] The number of times this key has successfully been
+  #     locked, the {#session} attribute indicates which session owns the lock.
+  # @!attribute [rw] session
+  #   @return [String] The identifier for the session that owns the lock.
+  # @!attribute [rw] key
+  #   @return [String] The full path for the entry.
+  # @!attribute [rw] flags
+  #   @return [Integer] An opaque unsigned integer for use by the client
+  #     application.
+  # @!attribute [rw] value
+  #   @return [String] The stored value (returned already base64 decoded)
+  # @!attribute [rw] create_index
+  #   @return [Integer] The internal index value representing when the entry
+  #     was created.
+  # @!attribute [rw] modify_index
+  #   @return [Integer] The internal index value representing when the entry
+  #     was last updated.
+  class KVPair
+    ATTRIBUTE_MAP = {
+      'LockIndex' => :lock_index,
+      'Session' => :session,
+      'Key' => :key,
+      'Flags' => :flags,
+      'Value' => :value,
+      'CreateIndex' => :create_index,
+      'ModifyIndex' => :modify_index,
+    }.freeze
+    private_constant :ATTRIBUTE_MAP
+
+    ATTRIBUTE_NAMES = ATTRIBUTE_MAP.values
+    private_constant :ATTRIBUTE_NAMES
+
+    attr_accessor *ATTRIBUTE_NAMES
+
+    # Initialize a {KVPair}
+    #
+    # @param attributes [Hash] The attributes for this object as parsed from the
+    #   API response.
+    def initialize(attributes = {})
+      ATTRIBUTE_MAP.each do |key, attribute_name|
+        send("#{attribute_name}=", attributes[key])
+      end
+    end
+
+    def ==(other)
+      return false unless self.class === other
+      ATTRIBUTE_NAMES.all? { |attr| self.send(attr) == other.send(attr )}
+    end
+
+    # Capture and base64 decode a value from the api.
+    #
+    # @param value [String] The base64 encoded value from the response.
+    def value=(value)
+      @value = Base64.decode64 value
+    end
+  end
+end

data/lib/imperium/response.rb

@@ -0,0 +1,50 @@
+require 'delegate'
+
+module Imperium
+  # A Response is a decorator around the
+  # {http://www.rubydoc.info/gems/httpclient/HTTP/Message HTTP::Message} object
+  # returned when a request is made.
+  #
+  # It exposes, through a convenient API, headers common to all interactions
+  # with the Consul HTTP API
+  class Response < SimpleDelegator
+    # Indicates if the contacted server has a known leader.
+    #
+    # @return [TrueClass] When the response indicates there is a known leader
+    # @return [FalseClass] When the response indicates there is not a known leader
+    # @return [NilClass] When the X-Consul-KnownLeader header is not present.
+    def known_leader?
+      return unless headers.key?('X-Consul-KnownLeader')
+      headers['X-Consul-KnownLeader'] == 'true'
+    end
+
+    # The time in miliseconds since the contacted server has been in contact
+    # with the leader.
+    #
+    # @return [NilClass] When the X-Consul-LastContact header is not present.
+    # @return [Integer]
+    def last_contact
+      return unless headers.key?('X-Consul-LastContact')
+      Integer(headers['X-Consul-LastContact'])
+    end
+
+    # A convenience method for checking if the response had a 404 status code.
+    def not_found?
+      status == 404
+    end
+
+    # Indicate status of translate_wan_addrs setting on the server.
+    #
+    # @return [TrueClass] When X-Consul-Translate-Addresses is set
+    # @return [FalseClass] When X-Consul-Translate-Addresses is unset
+    def translate_addresses?
+      headers.key?('X-Consul-Translate-Addresses')
+    end
+
+    private
+
+    def parsed_body
+      JSON.parse(content)
+    end
+  end
+end

data/lib/imperium/version.rb

@@ -0,0 +1,3 @@
+module Imperium
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: imperium
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Pickett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  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: yard
+  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'
+description: A powerful, easy to use, Consul client
+email:
+- t.pickett66@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dockerfile.ci
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- build.sh
+- docker-compose.override.yml.example
+- docker-compose.yml
+- imperium.gemspec
+- lib/imperium.rb
+- lib/imperium/client.rb
+- lib/imperium/configuration.rb
+- lib/imperium/error.rb
+- lib/imperium/http_client.rb
+- lib/imperium/kv.rb
+- lib/imperium/kv_get_response.rb
+- lib/imperium/kv_pair.rb
+- lib/imperium/response.rb
+- lib/imperium/version.rb
+homepage: https://github.com/instructure/imperium
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A powerful, easy to use, Consul client
+test_files: []