imperium 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5bd55423ed578c5f67828e03fa2f543650b45ee4
-  data.tar.gz: 6ad6505a0763f99f72d4dbdf0cb59da6cfa47371
+SHA256:
+  metadata.gz: f7231972c5ebe74723a4eeb085545b3e04829d9b090350dc4768544b432f55f9
+  data.tar.gz: 3e7213cb2b41cacacad8124e232142b48906df5632b8d0e74e99b8d8387e5992
 SHA512:
-  metadata.gz: e6907eb064bcb3e1b4ef97c1baa871b6e983f4fd94b408a88d45e5e13e49bd87262630e57f90d85ebfcb4801c2090f4fed83f0297b9042aa639f2d548a9521f7
-  data.tar.gz: 8fa3313caa6f2ae61f83049b49fea64ea132c87286d57a3d2d72117ef4f0804ca8d4ea151c743f010cbef9bc698139aa1b967d40972085e9c08672c861a263fd
+  metadata.gz: eb0f038f9476123ce5287d26095c7aa9fb6980a2349e063c1d9bdd284d2043a78776c79d036703c75e20573209a9ad7121263ea80d89d3101eabe01d75fe5b9b
+  data.tar.gz: 487de77a4b1fcebff0b021cb0ba80233a4b3d4d759886bf044142bfdea64f6f4a7dada9ee17726e3232d16fff16121dd97367ca1dc9818bf009f3364cf284b8e

data/lib/imperium.rb

@@ -17,6 +17,8 @@ require 'imperium/kv_delete_response'
 require 'imperium/response'
 require 'imperium/service'
 require 'imperium/service_check'
+require 'imperium/transaction'
+require 'imperium/transaction_response'
 require 'imperium/version'
 
 module Imperium

data/lib/imperium/kv.rb

@@ -127,6 +127,21 @@ module Imperium
       KVDELETEResponse.new(response, options: expanded_options)
     end
 
+    # Perform operation in the transaction
+    #
+    #   This is useful when having a number of statements that must be executed
+    #   together or not at all.
+    #
+    #   @yieldparam [Transaction] a Transaction instance that can be used to
+    #     perform operations in the transaction
+    # @return [TransactionResponse]
+    def transaction
+      tx = Imperium::Transaction.new
+      yield tx
+      response = @http_client.put('v1/txn', tx.body)
+      Imperium::TransactionResponse.new(response)
+    end
+
     private
 
     def construct_nested_hash(key_parts, value)

data/lib/imperium/transaction.rb

@@ -0,0 +1,48 @@
+module Imperium
+  # A Transaction support for KV API
+  class Transaction
+    # Initializa a new transaction containing an array of
+    # operations
+    def initialize
+      @operations = []
+    end
+
+    # {#set Set or Put} a key value pair
+    # @see #set
+    def set(key, value, flags: nil)
+      add_operation('set', key, value: value, flags: flags)
+    end
+
+    # Get JSON object for operations
+    #
+    # @return JSON KV object
+    def body
+      @operations.to_json
+    end
+
+    # Add operation to a Transaction
+
+    # @param verb [string] Specifies the type of operation to perform
+    # @param key [string] Specifies the full path of the entry
+    # @param value [string] Specifies a base64-encoded blob of data.
+    #   Values cannot be larger than 512kB.
+    # @param flags [int] Specifies an opaque unsigned integer that
+    #   can be attached to each entry. Clients can choose to use this
+    #   however makes sense for their application.
+    # @param index [int] Specifies an index.
+    # @param session [string] Specifies a session.
+    #
+    # @return list of operations to perform inside the atomic transaction
+    def add_operation(verb, key, value: nil, flags: nil, index: nil, session_id: nil)
+      kv = {
+        'Verb' => verb,
+        'Key' => key
+      }
+      kv['Value'] = Base64.encode64(value) if value
+      kv['Flags'] = flags if flags
+      kv['Index'] = index if index
+      kv['Session'] = session_id if session_id
+      @operations << { 'KV' => kv }
+    end
+  end
+end

data/lib/imperium/transaction_response.rb

@@ -0,0 +1,25 @@
+module Imperium
+  # A Response is a decorator around the
+  # {http://www.rubydoc.info/gems/httpclient/HTTP/Message HTTP::Message} object
+  # returned when a transaction is made.
+  #
+  # It exposes, through a convenient API, headers common to all interactions
+  # with the Consul HTTP API
+  class TransactionResponse < Response
+    # Add Results as a KVPair to the response coerced body
+    #
+    # @return Imperium::KVPair
+    def results
+      coerced_body['Results'].map do |result|
+        KVPair.new(result['KV']) if result['KV']
+      end
+    end
+
+    # Add Errors to the response coerced body
+    #
+    # @return the error
+    def errors
+      coerced_body['Errors']
+    end
+  end
+end

data/lib/imperium/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imperium
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tyler Pickett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -179,6 +179,8 @@ files:
 - lib/imperium/service.rb
 - lib/imperium/service_check.rb
 - lib/imperium/testing.rb
+- lib/imperium/transaction.rb
+- lib/imperium/transaction_response.rb
 - lib/imperium/version.rb
 homepage: https://github.com/instructure/imperium
 licenses:
@@ -200,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A powerful, easy to use, Consul client