diplomat 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29561e5c607d45e0a6339e2cead4c2721dc5d90e
-  data.tar.gz: b82255ac4419a411300b22b0e76cc37546065da9
+  metadata.gz: 2244d84cc7a0fe952223ad6001d8f473be47a024
+  data.tar.gz: b86af2a9b85baadf3d45382a55ad25a12c1e70d5
 SHA512:
-  metadata.gz: e9e71c7eb3886233575aa00184f13179c190fa86d6ae34b1896e453ab354783132bdbbb6940f32aa3c388e53f123ada0aa258e2a5b97e7f76220ad4be413d7ba
-  data.tar.gz: b12d5ee9ac1ded146904fea9594e7736dc4ba3233dd521c9067c20cd15d4aebf8436814c156ef616aac4f7b014bca1aef048d884f12230ac567c611a9c90eb18
+  metadata.gz: e176ec9e8b1e1eebb570c8c0698d38eadab706654ceaba1d8d0f981cd8c046aad6f70cbb9772a8562e2ece337ff02c11417829425af2b142d16d4445d6147ec1
+  data.tar.gz: 3faa78e2307bb3c0bb00e4722adfc8eb3bedd1e2afd5f5f98d0ae4efd6f919ec03f3e5d59087e17ade656b762c06b273416f2a44fc096343802754545a263f14

data/README.md

@@ -82,6 +82,42 @@ foo_service = Diplomat::Service.get('foo', :all)
 # => [#<OpenStruct Node="hotel", Address="1.2.3.4", ServiceID="hotel_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>,#<OpenStruct Node="indigo", Address="1.2.3.5", ServiceID="indigo_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>]
 ```
 
+### Sessions
+
+Creating a session:
+
+```ruby
+sessionid = Diplomat::Session.create({:hostname => "server1", :ipaddress => "4.4.4.4"})
+# => "fc5ca01a-c317-39ea-05e8-221da00d3a12"
+```
+Or destroying a session:
+
+```ruby
+Diplomat::Session.destroy("fc5ca01a-c317-39ea-05e8-221da00d3a12")
+```
+
+### Locks
+
+Acquire a lock:
+
+```ruby
+sessionid = Diplomat::Session.create({:hostname => "server1", :ipaddress => "4.4.4.4"})
+lock_acquired = Diplomat::Lock.acquire("/key/to/lock", sessionid)
+# => true
+```
+Or wait for a lock to be acquired:
+
+```ruby
+sessionid = Diplomat::Session.create({:hostname => "server1", :ipaddress => "4.4.4.4"})
+lock_acquired = Diplomat::Lock.wait_to_acquire("/key/to/lock", sessionid)
+```
+
+Release a lock:
+
+```ruby
+Diplomat::Lock.release("/key/to/lock", sessionid )
+```
+
 ### Custom configuration
 
 You can create a custom configuration using the following syntax:
@@ -99,14 +135,15 @@ This is traditionally kept inside the `config/initializers` directory if you're
 
 ### Todo
 
- - Updating docs with latest changes
- - PUTting and DELETEing services
- - Allowing the custom configuration of the consul url to connect to
- - - ~~Deleting Keys~~ **Needs a test**
- - ~~Listing available Services~~ **Done**
- - ~~Health~~ **Done**
- - ~~Members~~ **Done**
- - ~~Status~~ **Done**
+-  [ ] Updating Docs with latest changes
+-  [ ] PUTing and DELETEing services
+-  [x] Allowing the custom configuration of the consul url to connect to
+-  [x] Deleting Keys
+-  [x] Listing available services
+-  [x] Health
+-  [x] Members
+-  [x] Status
+
 
 ## Enjoy!
 

data/lib/diplomat.rb

@@ -20,7 +20,7 @@ module Diplomat
   self.root_path = File.expand_path "..", __FILE__
   self.lib_path = File.expand_path "../diplomat", __FILE__
 
-  require_libs "configuration", "rest_client", "kv", "service", "members", "check", "health"
+  require_libs "configuration", "rest_client", "kv", "service", "members", "check", "health", "session", "lock"
   self.configuration ||= Diplomat::Configuration.new
 
   class << self

data/lib/diplomat/lock.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+
+module Diplomat
+  class Lock < Diplomat::RestClient
+
+    # Acquire a lock
+    # @param key [String] the key
+    # @param session [String] the session, generated from Diplomat::Session.create
+    # @return [Boolean] If the lock was acquired
+    def acquire key, session
+      raw = @conn.put do |req|
+        req.url "/v1/kv/#{key}?acquire=#{session}"
+      end
+      return true if raw.body == 'true'
+      return false
+
+    end
+
+    # wait to aquire a lock
+    # @param key [String] the key
+    # @param session [String] the session, generated from Diplomat::Session.create
+    # @param check_interval [Integer] number of seconds to wait between retries
+    # @return [Boolean] If the lock was acquired
+    def wait_to_acquire key, session, check_interval=10
+      acquired = false
+      while !acquired
+        acquired = self.acquire key, session
+        sleep(check_interval) if !acquired
+        return true if acquired
+      end
+    end
+
+
+    # Release a lock
+    # @param key [String] the key
+    # @param session [String] the session, generated from Diplomat::Session.create
+    # @return [nil]
+    def release  key, session
+      raw = @conn.put do |req|
+        req.url "/v1/kv/#{key}?release=#{session}"
+      end
+      return raw.body
+    end
+
+    # @note This is sugar, see (#acquire)
+    def self.acquire *args
+      Diplomat::Lock.new.acquire *args
+    end
+
+    # @note This is sugar, see (#wait_to_acquire)
+    def self.wait_to_acquire *args
+      Diplomat::Lock.new.wait_to_acquire *args
+    end
+
+    # @note This is sugar, see (#release)
+    def self.release *args
+      Diplomat::Lock.new.release *args
+    end
+  end
+end

data/lib/diplomat/session.rb

@@ -0,0 +1,38 @@
+require 'faraday'
+
+module Diplomat
+  class Session < Diplomat::RestClient
+
+    # Create a new session
+    # @param value [String] json representation of the local node
+    # @return [String] The sesssion id
+    def create value
+      raw = @conn.put do |req|
+        req.url "/v1/session/create"
+        req.body = value
+      end
+      body = JSON.parse(raw.body)
+      return body["ID"]
+    end
+
+    # Destroy a session
+    # @param id [String] session id
+    # @return [nil]
+    def destroy id
+      raw = @conn.put do |req|
+        req.url "/v1/session/destroy/#{id}"
+      end
+      return raw.body
+    end
+
+    # @note This is sugar, see (#create)
+    def self.create *args
+      Diplomat::Session.new.create *args
+    end
+
+    # @note This is sugar, see (#destroy)
+    def self.destroy *args
+      Diplomat::Session.new.destroy *args
+    end
+  end
+end

data/lib/diplomat/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - John Hamelink
@@ -181,9 +181,11 @@ files:
 - lib/diplomat/configuration.rb
 - lib/diplomat/health.rb
 - lib/diplomat/kv.rb
+- lib/diplomat/lock.rb
 - lib/diplomat/members.rb
 - lib/diplomat/rest_client.rb
 - lib/diplomat/service.rb
+- lib/diplomat/session.rb
 - lib/diplomat/version.rb
 homepage: https://github.com/johnhamelink/diplomat
 licenses: