diplomat 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd8fd2de1577af47ba483ec661d17065898e0347
-  data.tar.gz: 67472f8f9b059e34acb2da7565416545a16a4150
+  metadata.gz: ce6e11c99998e8ccde4674d2f25b1c65a7dadcb6
+  data.tar.gz: 0ed7b4a14cedf79aed1f0856b60f8eb96744adbe
 SHA512:
-  metadata.gz: fc1c47f0f2a6fd0ef1d8d368ff476c2943b7ac28d0ea8baa69cedd18e22ba78131196b8b6867c0ab8debfcd6b5ee84d5e26b9065a994bb11148e17c6bc91d435
-  data.tar.gz: c6c453c1bebd64a5354304820e3946abb3f98ff3974e0ba15cb9c4c9939b5016a2dcc6bda78bbaf17f7d2c3d547f1db1ac0b3de1d07d3e04304256645137f45f
+  metadata.gz: dae2bbf4adfdcda941ce8d9ad5b09868dfe7abbd957122e217159fc27d15f585201edfd8de4ac570fb0e28baf284352ba9c4e4a750808b9e95b8149e074eaf80
+  data.tar.gz: 4a5b3fb941c350acc1a2272727fb4eaefe63df2c5814bca82fd9dc0f889acf6709aa85b1fb531431d2c092b96cff766d48ae5fe392c6f6c84a8d81e659d191e8

data/README.md

@@ -82,6 +82,24 @@ Diplomat::Kv.get('foo/', recurse: true)
 # => [{:key=>"foo/a", :value=>"lorem"}, {:key=>"foo/b", :value=>"ipsum"}, {:key=>"foo/c", :value=>"dolor"}]
 ```
 
+### Nodes
+
+#### Getting
+
+Look up a node:
+
+```ruby
+foo_service = Diplomat::Node.get('foo')
+# => {"Node"=>{"Node"=>"foobar", "Address"=>"10.1.10.12"}, "Services"=>{"consul"=>{"ID"=>"consul", "Service"=>"consul", "Tags"=>nil, "Port"=>8300}, "redis"=>{"ID"=>"redis", "Service"=>"redis", "Tags"=>["v1"], "Port"=>8000}}}
+```
+
+Get all nodes:
+
+```ruby
+nodes = Diplomat::Node.get_all
+# => [#<OpenStruct Address="10.1.10.12", Node="foo">, #<OpenStruct Address="10.1.10.13", Node="bar">]
+```
+
 ### Services
 
 #### Getting

data/lib/diplomat/acl.rb

@@ -0,0 +1,100 @@
+require 'base64'
+require 'faraday'
+
+module Diplomat
+  class Acl < Diplomat::RestClient
+
+    include ApiOptions
+
+    @access_methods = [ :list, :info, :create, :destroy, :update ]
+    attr_reader :id, :type, :acl
+
+    # Get Acl info by ID
+    # @param id [String] ID of the Acl to get
+    # @return [Hash]
+    def info id, options=nil, not_found=:reject, found=:return
+      @id = id
+      @options = options
+
+      url = ["/v1/acl/info/#{@id}"]
+      url += check_acl_token
+      url += use_consistency(@options)
+
+      raw = @conn_no_err.get concat_url url
+      if raw.status == 200 and raw.body
+        case found
+          when :reject
+            raise Diplomat::AclAlreadyExists, @id
+          when :return
+            @raw = raw
+            return parse_body
+        end
+      elsif raw.status == 200 and !raw.body
+        case not_found
+          when :reject
+            raise Diplomat::AclNotFound, @id
+          when :return
+            return nil
+        end
+      else
+        raise Diplomat::UnknownStatus, "status #{raw.status}"
+      end
+    end
+
+    # List all Acls
+    # @return [List] list of [Hash] of Acls
+    def list
+      url = ["/v1/acl/list"]
+      url += check_acl_token
+      raw = @conn_no_err.get concat_url url
+
+      if raw.status == 200
+        @raw = raw
+        return parse_body
+      else
+        raise Diplomat::UnknownStatus, "status #{raw.status}"
+      end
+    end
+
+    # Update an Acl definition, create if not present
+    # @param value [Hash] Acl definition, ID field is mandatory
+    # @return [Hash] The result Acl
+    def update value
+      raise Diplomat::IdParameterRequired unless value['ID']
+
+      @raw = @conn.put do |req|
+        url = ["/v1/acl/update"]
+        url += check_acl_token
+        url += use_cas(@options)
+        req.url concat_url url
+        req.body = value.to_json
+      end
+      JSON.parse(@raw.body)
+    end
+
+    # Create an Acl definition
+    # @param value [Hash] Acl definition, ID field is mandatory
+    # @return [Hash] The result Acl
+    def create value
+      @raw = @conn.put do |req|
+        url = ["/v1/acl/create"]
+        url += check_acl_token
+        url += use_cas(@options)
+        req.url concat_url url
+        req.body = value.to_json
+      end
+      JSON.parse(@raw.body)
+    end
+
+    # Destroy an ACl token by its id
+    # @param ID [String] the Acl ID
+    # @return [Bool]
+    def destroy id
+      @id = id
+      url = ["/v1/acl/destroy/#{@id}"]
+      url += check_acl_token
+      @raw = @conn.put concat_url url
+      @raw.body == "true"
+    end
+  end
+end

data/lib/diplomat/api_options.rb

@@ -0,0 +1,15 @@
+module Diplomat
+  module ApiOptions
+    def check_acl_token
+      use_named_parameter("token", Diplomat.configuration.acl_token)
+    end
+
+    def use_cas(options)
+      if options then use_named_parameter("cas", options[:cas]) else [] end
+    end
+
+    def use_consistency(options)
+      if options && options[:consistency] then ["#{options[:consistency]}"] else [] end
+    end
+  end
+end

data/lib/diplomat/error.rb

@@ -2,7 +2,10 @@ module Diplomat
   class KeyNotFound < StandardError; end
   class PathNotFound < StandardError; end
   class KeyAlreadyExists < StandardError; end
+  class AclNotFound < StandardError; end
+  class AclAlreadyExists < StandardError; end
   class EventNotFound < StandardError; end
   class EventAlreadyExists < StandardError; end
   class UnknownStatus < StandardError; end
+  class IdParameterRequired < StandardError; end
 end

data/lib/diplomat/kv.rb

@@ -3,6 +3,9 @@ require 'faraday'
 
 module Diplomat
   class Kv < Diplomat::RestClient
+
+    include ApiOptions
+
     @access_methods = [ :get, :put, :delete ]
     attr_reader :key, :value, :raw
 
@@ -12,6 +15,8 @@ module Diplomat
     # @option options [Boolean] :recurse If to make recursive get or not
     # @option options [String] :consistency The read consistency type
     # @option options [String] :dc Target datacenter
+    # @option options [Boolean] :keys Only return key names.
+    # @option options [String] :separator List only up to a given separator. Only applies when combined with :keys option.
     # @option options [Boolean] :nil_values If to return keys/dirs with nil values
     # @param not_found [Symbol] behaviour if the key doesn't exist;
     #   :reject with exception, :return degenerate value, or :wait for it to appear
@@ -43,6 +48,8 @@ module Diplomat
       url += check_acl_token
       url += use_consistency(@options)
       url += dc(@options)
+      url += keys(@options)
+      url += separator(@options)
 
       return_nil_values = (@options and @options[:nil_values])
 
@@ -122,24 +129,20 @@ module Diplomat
 
     private
 
-    def check_acl_token
-      use_named_parameter("token", Diplomat.configuration.acl_token)
-    end
-
-    def use_cas(options)
-      if options then use_named_parameter("cas", options[:cas]) else [] end
-    end
-
-    def use_consistency(options)
-      if options && options[:consistency] then ["#{options[:consistency]}"] else [] end
-    end
-
     def recurse_get(options)
-      if options && options[:recurse] then ['recurse'] else [] end
+      if options && options[:recurse] == true then ['recurse'] else [] end
     end
 
     def dc(options)
       if options && options[:dc] then use_named_parameter("dc", options[:dc]) else [] end
     end
+    
+    def keys(options)
+      if options && options[:keys] == true then ['keys'] else [] end
+    end
+    
+    def separator(options)
+      if options && options[:separator] then use_named_parameter("separator", options[:separator]) else [] end
+    end
   end
 end

data/lib/diplomat/node.rb

@@ -0,0 +1,41 @@
+require 'base64'
+require 'faraday'
+
+module Diplomat
+  class Node < Diplomat::RestClient
+
+    @access_methods = [ :get, :get_all ]
+
+    # Get a node by it's key
+    # @param key [String] the key
+    # @param options [Hash] :dc string for dc specific query
+    # @return [OpenStruct] all data associated with the node
+    def get key, options=nil
+
+      url = ["/v1/catalog/node/#{key}"]
+      url << use_named_parameter('dc', options[:dc]) if options and options[:dc]
+
+      # If the request fails, it's probably due to a bad path
+      # so return a PathNotFound error.
+      begin
+        ret = @conn.get concat_url url
+      rescue Faraday::ClientError
+        raise Diplomat::PathNotFound
+      end
+      return JSON.parse(ret.body)
+    end
+
+    # Get all the nodes
+    # @return [OpenStruct] the list of all nodes
+    def get_all
+      url = "/v1/catalog/nodes"
+      begin
+        ret = @conn.get url
+      rescue Faraday::ClientError
+        raise Diplomat::PathNotFound
+      end
+
+      return JSON.parse(ret.body).map { |service| OpenStruct.new service }
+    end
+  end
+end

data/lib/diplomat/nodes.rb

@@ -6,6 +6,7 @@ module Diplomat
     @access_methods = [ :get ]
 
     # Get all nodes
+    # @deprecated Please use Diplomat::Node instead.
     # @return [OpenStruct] all data associated with the nodes in catalog
     def get
       ret = @conn.get "/v1/catalog/nodes"

data/lib/diplomat/rest_client.rb

@@ -76,6 +76,7 @@ module Diplomat
 
     # Get the key/value(s) from the raw output
     def return_value(nil_values=false)
+      return @value = @raw if @raw.first.is_a? String
       if @raw.count == 1
         @value = @raw.first["Value"]
         @value = Base64.decode64(@value) unless @value.nil?

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

data/lib/diplomat.rb

@@ -21,7 +21,9 @@ module Diplomat
   self.root_path = File.expand_path "..", __FILE__
   self.lib_path = File.expand_path "../diplomat", __FILE__
 
-  require_libs "configuration", "rest_client", "kv", "datacenter", "service", "members", "nodes", "check", "health", "session", "lock", "error", "event"
+  require_libs "configuration", "rest_client", "api_options", "kv", "datacenter",
+    "service", "members", "node", "nodes", "check", "health", "session", "lock",
+    "error", "event", "acl"
   self.configuration ||= Diplomat::Configuration.new
 
   class << self
@@ -45,4 +47,4 @@ module Diplomat
       Diplomat::Kv.new.send(name, *args, &block)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - John Hamelink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,6 +177,8 @@ files:
 - features/step_definitions/setup_diplomat.rb
 - features/step_definitions/test_key_value.rb
 - lib/diplomat.rb
+- lib/diplomat/acl.rb
+- lib/diplomat/api_options.rb
 - lib/diplomat/check.rb
 - lib/diplomat/configuration.rb
 - lib/diplomat/datacenter.rb
@@ -186,6 +188,7 @@ files:
 - lib/diplomat/kv.rb
 - lib/diplomat/lock.rb
 - lib/diplomat/members.rb
+- lib/diplomat/node.rb
 - lib/diplomat/nodes.rb
 - lib/diplomat/rest_client.rb
 - lib/diplomat/service.rb