imperium 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f8ec25d8bf0eabed10730fd5f3b7e0816e46755
-  data.tar.gz: e18d19959119ac246651320b0e98d4e28be48ab9
+  metadata.gz: 5bd55423ed578c5f67828e03fa2f543650b45ee4
+  data.tar.gz: 6ad6505a0763f99f72d4dbdf0cb59da6cfa47371
 SHA512:
-  metadata.gz: a071a3d5c661f65cb0bd7a985658907c6a7b04f176a4e72f50b8bbe4bbf540ed76f14a9ce9ddc0a4ec0d1e2bbc1215e1dbb35ff8fe9bb1fd72a4f6278107d39b
-  data.tar.gz: 3fed32e141babe6ff5e1de09534efce75c0e92ebf9aca32ffbba87460dfbb1d62aa8bf38c0778cee66331e9d8de577bfc6c977a258db987b5db3685fa862e09e
+  metadata.gz: e6907eb064bcb3e1b4ef97c1baa871b6e983f4fd94b408a88d45e5e13e49bd87262630e57f90d85ebfcb4801c2090f4fed83f0297b9042aa639f2d548a9521f7
+  data.tar.gz: 8fa3313caa6f2ae61f83049b49fea64ea132c87286d57a3d2d72117ef4f0804ca8d4ea151c743f010cbef9bc698139aa1b967d40972085e9c08672c861a263fd

data/README.md

@@ -44,13 +44,13 @@ Configure:
 Imperium.configure do |config|
   # Connection values can be specified separately
   config.host = 'consul.example.com'
-  config.port = 8585 
+  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'
+  config.token = 'super-sekret-value'
 end
 
 # If you want a client that uses some other configuration values without altering
@@ -58,17 +58,17 @@ end
 
 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) 
+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 = 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 = Imperium::KV.get('config/complex-value', :recurse)
 response.values # => {first: 'value', second: 'value'}
 ```
 

data/build.sh

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

data/lib/imperium.rb

@@ -13,6 +13,7 @@ require 'imperium/kv'
 require 'imperium/kv_pair'
 require 'imperium/kv_get_response'
 require 'imperium/kv_put_response'
+require 'imperium/kv_delete_response'
 require 'imperium/response'
 require 'imperium/service'
 require 'imperium/service_check'

data/lib/imperium/http_client.rb

@@ -12,10 +12,11 @@ module Imperium
       @driver.receive_timeout = @config.receive_timeout
     end
 
-    def delete(path)
+    def delete(path, query: {})
       wrapping_exceptions do
         url = config.url.join(path)
-        @driver.delete(url)
+        url.query_values = query
+        @driver.delete(url, header: build_request_headers)
       end
     end
 
@@ -32,9 +33,9 @@ module Imperium
         url = config.url.join(path)
         url.query_values = query
         if value.is_a?(String)
-          @driver.put(url, body: value)
+          @driver.put(url, body: value, header: build_request_headers)
         else
-          @driver.put(url, body: JSON.generate(value))
+          @driver.put(url, body: JSON.generate(value), header: build_request_headers)
         end
       end
     end

data/lib/imperium/kv.rb

@@ -15,20 +15,10 @@ module Imperium
       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
-    #   {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))
+    # {#delete DELETE} a key using the {.default_client}
+    # @see #delete
+    def self.delete(key, *options)
+      default_client.delete(key, *options)
     end
 
     GET_ALLOWED_OPTIONS = %i{consistent stale recurse keys separator raw}.freeze
@@ -37,6 +27,9 @@ module Imperium
     PUT_ALLOWED_OPTIONS = %i{flags cas acquire release}.freeze
     private_constant :PUT_ALLOWED_OPTIONS
 
+    DELETE_ALLOWED_OPTIONS = %i{cas}.freeze
+    private_constant :DELETE_ALLOWED_OPTIONS
+
     # Get the specified key/prefix using the supplied options.
     #
     # @example Fetching a key that is allowed to be stale.
@@ -111,6 +104,29 @@ module Imperium
       KVPUTResponse.new(response, options: expanded_options)
     end
 
+    # Delete the specified key
+    #
+    # @todo Decide whether to support recursive deletion by accepting the
+    #   :recurse parameter
+    #
+    # @param key [String] The key to be created or updated.
+    # @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] :cas Specifies to use a Check-And-Set operation.
+    #   This is very useful as a building block for more complex synchronization
+    #   primitives. Unlike PUT, the index must be greater than 0 for Consul to
+    #   take any action: a 0 index will not delete the key. If the index is
+    #   non-zero, the key is only deleted if the index matches the ModifyIndex
+    #   of that key.
+    # @return [KVDELETEResponse]
+    def delete(key, *options)
+      expanded_options = hashify_options(options)
+      query_params = extract_query_params(expanded_options, allowed_params: DELETE_ALLOWED_OPTIONS)
+      response = @http_client.delete(prefix_path(key), query: query_params)
+      KVDELETEResponse.new(response, options: expanded_options)
+    end
+
     private
 
     def construct_nested_hash(key_parts, value)

data/lib/imperium/kv_delete_response.rb

@@ -0,0 +1,34 @@
+require_relative 'response'
+
+module Imperium
+  # KVDELETEResponse 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#delete}
+  #
+  # @!attribute [rw] options
+  #   @return [Hash<Symbol, Object>] The options for the get request after being
+  #   coerced from an array to hash.
+  class KVDELETEResponse < 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/kv_put_response.rb

@@ -9,9 +9,6 @@ module Imperium
   # @!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
 

data/lib/imperium/version.rb

@@ -1,3 +1,3 @@
 module Imperium
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imperium
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Tyler Pickett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -170,6 +170,7 @@ files:
 - lib/imperium/events.rb
 - lib/imperium/http_client.rb
 - lib/imperium/kv.rb
+- lib/imperium/kv_delete_response.rb
 - lib/imperium/kv_get_response.rb
 - lib/imperium/kv_pair.rb
 - lib/imperium/kv_put_response.rb