imperium 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ccb3188557a0e0648bc10cbab9b28578dd74c48
-  data.tar.gz: 3867b7fe25029fbd90b050794a4b088de1f78af3
+  metadata.gz: 70b5342210c6ee5d4e7876d0899b224b36092bbb
+  data.tar.gz: 660c0bba85f85516ead3f5c8b00fe3ad7bb437fd
 SHA512:
-  metadata.gz: cd4236a9e242ec0a1e94eb3593c4b7a7e76aa8bc12dc68d17da06874d8e8d366c0f4e2cceb53da838d4f82e8c65fd623209e3da4a3885f6eacedb67f0504a9c8
-  data.tar.gz: e888b8ba124a1fbf6e67965143a084882c67f11ff823778603c1e469d464903f8e36fa34448f1d7f3ee6fb8076c0efd969491e88c45a836522ef7105dc285c68
+  metadata.gz: 699233998e7e26e9036f2362b4a5ca6eff394e258935966609dde0215b6283dada530510c4ca537ca1a3d474c3739234e69133b7117095b3eb5722edbb8eef7a
+  data.tar.gz: f52e244277ad058e270ab111ebd287a6959ff9c2a65168d4bf399ebfee05c0ef0d93df5f26950400ac85acd985431b544a845d8a8b5cbd4af076097e3c2e0178

data/.travis.yml

@@ -2,7 +2,6 @@ sudo: false
 language: ruby
 before_install: gem install bundler -v 1.13.6
 rvm:
-  - "2.1"
   - "2.2"
   - "2.3"
-  - "2.4.0"
+  - "2.4"

data/Dockerfile.ci

@@ -16,4 +16,4 @@ USER root
 RUN chown -R docker:docker /app
 USER docker
 
-CMD /bin/bash -l -c "bundle exec wwtd --parallel"
+CMD /bin/bash -l -c "bundle exec wwtd"

data/lib/imperium.rb

@@ -6,6 +6,7 @@ require 'imperium/http_client'
 require 'imperium/kv'
 require 'imperium/kv_pair'
 require 'imperium/kv_get_response'
+require 'imperium/kv_put_response'
 require 'imperium/response'
 require 'imperium/version'
 

data/lib/imperium/client.rb

@@ -3,6 +3,9 @@ require 'json'
 
 module Imperium
   class Client
+    # Options that are allowed for all API endpoints
+    UNIVERSAL_API_OPTIONS = %i{dc}.freeze
+
     class << self
       attr_reader :subclasses
       attr_accessor :path_prefix
@@ -42,7 +45,11 @@ module Imperium
       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) }
+      allowed_params == :all ?
+        full_options :
+        full_options.select { |k, _|
+          allowed_params.include?(k.to_sym) || UNIVERSAL_API_OPTIONS.include?(k.to_sym)
+        }
     end
 
     def hashify_options(options_array)

data/lib/imperium/error.rb

@@ -1,3 +1,4 @@
+require 'socket'
 
 module Imperium
   class Error < StandardError; end

data/lib/imperium/http_client.rb

@@ -27,9 +27,10 @@ module Imperium
       end
     end
 
-    def put(path, value)
+    def put(path, value, query: {})
       wrapping_exceptions do
         url = config.url.join(path)
+        url.query_values = query
         @driver.put(url, body: value)
       end
     end

data/lib/imperium/kv.rb

@@ -9,6 +9,12 @@ module Imperium
       default_client.get(key, *options)
     end
 
+    # {#put Create or update} a key using the {.default_client}
+    # @see #put
+    def self.put(key, value, *options)
+      default_client.put(key, value, *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
@@ -27,6 +33,10 @@ module Imperium
 
     GET_ALLOWED_OPTIONS = %i{consistent stale recurse keys separator raw}.freeze
     private_constant :GET_ALLOWED_OPTIONS
+
+    PUT_ALLOWED_OPTIONS = %i{flags cas acquire release}.freeze
+    private_constant :PUT_ALLOWED_OPTIONS
+
     # Get the specified key/prefix using the supplied options.
     #
     # @example Fetching a key that is allowed to be stale.
@@ -40,6 +50,7 @@ module Imperium
     # @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 [String] :dc Specify the datacenter to use for 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
@@ -62,20 +73,42 @@ module Imperium
     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]
+    # @param [Array<Symbol,String,Hash>] options The options for constructing
+    #   the request
+    # @option options [String] :dc Specify the datacenter to use for the request
+    # @option options [Integer] :flags Specifies an unsigned value
+    #   between 0 and (2^64)-1. Clients can choose to use this however makes
+    #   sense for their application.
+    # @option options [Integer] :cas Specifies to use a Check-And-Set operation.
+    #   This is very useful as a building block for more complex synchronization
+    #   primitives. If the index is 0, Consul will only put the key if it does
+    #   not already exist. If the index is non-zero, the key is only set if the
+    #   index matches the ModifyIndex of that key.
+    # @option options [String] :acquire Supply a session key for use in
+    #   acquiring lock on the key. From the Consul docs: Specifies to use a lock
+    #   acquisition operation. This is useful as it allows leader election to be
+    #   built on top of Consul. If the lock is not held and the session is
+    #   valid, this increments the LockIndex and sets the Session value of the
+    #   key in addition to updating the key contents. A key does not need to
+    #   exist to be acquired. If the lock is already held by the given session,
+    #   then the LockIndex is not incremented but the key contents are updated.
+    #   This lets the current lock holder update the key contents without having
+    #   to give up the lock and reacquire it.
+    # @option options [String] :release Supply a session key for releasing a
+    #   lock. From the Consul docs: Specifies to use a lock release operation.
+    #   This is useful when paired with ?acquire= as it allows clients to yield
+    #   a lock. This will leave the LockIndex unmodified but will clear the
+    #   associated Session of the key. The key must be held by this session to
+    #   be unlocked.
+    # @return [KVPUTResponse]
     def put(key, value, *options)
-      @http_client.put(prefix_path(key), value)
+      expanded_options = hashify_options(options)
+      query_params = extract_query_params(expanded_options, allowed_params: PUT_ALLOWED_OPTIONS)
+      response = @http_client.put(prefix_path(key), value, query: query_params)
+      KVPUTResponse.new(response, options: expanded_options)
     end
 
     private

data/lib/imperium/kv_put_response.rb

@@ -0,0 +1,37 @@
+require_relative 'response'
+
+module Imperium
+  # KVPUTResponse 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#put}
+  #
+  # @!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 KVPUTResponse < Response
+    attr_accessor :options
+
+    def initialize(message, options: {})
+      super message
+      @options = options
+    end
+
+    if RUBY_VERSION < "2.4"
+      def success?
+        return @success if defined? @success
+        @success = (body.chomp == "true")
+      end
+    else
+      def success?
+        return @success if defined? @success
+        @success = JSON.parse(body)
+      rescue JSON::ParserError
+        body.empty? ? @success = false : raise
+      end
+    end
+  end
+end

data/lib/imperium/version.rb

@@ -1,3 +1,3 @@
 module Imperium
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imperium
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Tyler Pickett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -164,6 +164,7 @@ files:
 - lib/imperium/kv.rb
 - lib/imperium/kv_get_response.rb
 - lib/imperium/kv_pair.rb
+- lib/imperium/kv_put_response.rb
 - lib/imperium/response.rb
 - lib/imperium/testing.rb
 - lib/imperium/version.rb
@@ -187,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A powerful, easy to use, Consul client