diplomat 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88a912b85c1348113d9b8e5f941bb652295dbac8
-  data.tar.gz: 64c21697ea68210e172293afc90b0bc894a238cc
+  metadata.gz: 1acdbd2886416cb3307f284fd3ebeecd6cd66852
+  data.tar.gz: 6b23b7466aa7155f5a2f434f947810d83fe7f6aa
 SHA512:
-  metadata.gz: e17459f8b810a4213ffa6a1e87aa4e4a91391f289c954526ed06a4601a754d9e3d230d5666bf9b5775f053627258a45dd163d1cb327f27424588e08c959d1b95
-  data.tar.gz: 0b0300f116e79dafb2fd26a2b123962e0ccecfabb7733dfacf034f9ee69b15c728f3da15a07a1974a17591fb0cc5237da60e8ffa176594310d3c252134c57945
+  metadata.gz: be17ae2b3b8c6f3cb6ec2c7a5f389b7a125eb7ffedc9b4bc0d81b8ebe2ffa139ea0415023b792c38db7939d68696a416ef0ce0fed02d6d13fb73ce4b4127a037
+  data.tar.gz: 32396d3ee97ad0e0451e59cf41b1785f90ad4f2361fa165619575f7493e54e3ae0cb5e7e92bba48931d687231b349ef4667798c6dc09ad781bc87b19d991e83b

data/lib/diplomat.rb

@@ -8,6 +8,7 @@ module Diplomat
 
     # Internal: Requires internal Faraday libraries.
     # @param *libs One or more relative String names to Faraday classes.
+    # @return [nil]
     def require_libs(*libs)
       libs.each do |lib|
         require "#{lib_path}/#{lib}"
@@ -26,6 +27,7 @@ module Diplomat
   class << self
 
     # Build optional configuration by yielding a block to configure
+    # @yield [Diplomat::Configuration]
     def configure
       self.configuration ||= Diplomat::Configuration.new
       yield(configuration)
@@ -33,6 +35,12 @@ module Diplomat
 
     private
 
+    # Send all other unknown commands to Diplomat::Kv
+    # @deprecated Please use Diplomat::Kv instead.
+    # @param name [Symbol] Method to send to Kv
+    # @param *args List of arguments to send to Kv
+    # @param &block block to send to Kv
+    # @return [Object]
     def method_missing(name, *args, &block)
       Diplomat::Kv.new.send(name, *args, &block)
     end

data/lib/diplomat/check.rb

@@ -41,15 +41,19 @@ module Diplomat
       return ret.status == 200
     end
 
+    # Register a TTL check
+    # @param check_id [String] the unique id of the check
+    # @param name [String] the name
+    # @param notes [String] notes about the check
+    # @param ttl [String] time (with units) to mark a check down
+    # @return [Boolean] Success
     def register_ttl check_id, name, notes, ttl
-      json = JSON.generate(
-      {
-        "ID" => check_id,
-        "Name" => name,
+      json = JSON.generate({
+        "ID"    => check_id,
+        "Name"  => name,
         "Notes" => notes,
-        "TTL" => ttl,
-      }
-      )
+        "TTL"   => ttl,
+      })
 
       ret = @conn.put do |req|
         req.url "/v1/agent/check/register"

data/lib/diplomat/configuration.rb

@@ -3,12 +3,17 @@ module Diplomat
     attr_accessor :middleware
     attr_accessor :url, :acl_token
 
+    # Override defaults for configuration
+    # @param url [String] consul's connection URL
+    # @param acl_token [String] a connection token used when making requests to consul
     def initialize(url="http://localhost:8500", acl_token=nil)
       @middleware = []
       @url = url
       @acl_token = acl_token
     end
 
+    # Define a middleware for Faraday
+    # @param middleware [Class] Faraday Middleware class
     def middleware=(middleware)
       return @middleware = middleware if middleware.is_a? Array
       @middleware = [middleware]

data/lib/diplomat/rest_client.rb

@@ -6,14 +6,23 @@ module Diplomat
 
     @access_methods = []
 
+    # Initialize the fadaray connection
+    # @param api_connection [Faraday::Connection,nil] supply mock API Connection
     def initialize api_connection=nil
       start_connection api_connection
     end
 
+    # Format url parameters into strings correctly
+    # @param name [String] the name of the parameter
+    # @param value [String] the value of the parameter
+    # @return [Array] the resultant parameter string inside an array.
     def use_named_parameter(name, value)
       if value then ["#{name}=#{value}"] else [] end
     end
 
+    # Assemble a url from an array of parts.
+    # @param parts [Array] the url chunks to be assembled
+    # @return [String] the resultant url string
     def concat_url parts
       if parts.length > 1 then
         parts.first + '?' + parts.drop(1).join('&')
@@ -24,12 +33,17 @@ module Diplomat
 
     class << self
 
-      def access_method? methId
-        @access_methods.include? methId
+      def access_method? meth_id
+        @access_methods.include? meth_id
       end
 
-      def method_missing(methId, *args)
-        access_method?(methId) ? new.send(methId, *args) : super
+      # Allow certain methods to be accessed
+      # without defining "new".
+      # @param meth_id [Symbol] symbol defining method requested
+      # @param *args Arguments list
+      # @return [Boolean]
+      def method_missing(meth_id, *args)
+        access_method?(meth_id) ? new.send(meth_id, *args) : super
       end
 
     end

data/lib/diplomat/version.rb

@@ -1,3 +1,3 @@
 module Diplomat
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diplomat
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - John Hamelink