consul-ruby-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea81d2569729debbb271b229358775f919a0de0c
-  data.tar.gz: 521ad0389c65a8d57ca62202faada9546d467416
+  metadata.gz: 16424ed2483c59320693c5fa6e98ae986c2c20c7
+  data.tar.gz: a2a578aefa883f5ce9da392619724479ae2f4324
 SHA512:
-  metadata.gz: 5c86f347a8a0ca26a65a4cf825688544ce14d75d2988a6e38d78c5c4adfdb3f9f9cbfbef0ebe78dab87212220bf13bcf68a43be07f18160aa1253ceac90e7073
-  data.tar.gz: 93e0c798a11880043e1545daa87eb84e6210af4f91f5849bd1640c0a3adbc6db127db645943f7a5ed40244bcbb65591367d05196ed177908bae3c2cc6c27546a
+  metadata.gz: 83ed8596afaacb62abdb09acb649093c97f36cafb1c2fd1cb0f032132bb98e5e33ad0f9db772b55755bb9d988f6dc6d9340fbb3e737a57e17d531dd85c779c99
+  data.tar.gz: 95222ebb6153c603f5292ffa0e2eb0710c9e3c1aaffef719adaa00336da64d36b2b6259ed7d1fc82396d42bf06831575eae359af07871808b73e18ad3b6034de

data/consul-ruby-client.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'simplecov', '~> 0.9'
   spec.add_development_dependency 'webmock', '~> 1.21'
-  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_dependency 'rest-client', '~> 1.8'
   spec.add_dependency 'representable', '~> 2.1'
   spec.add_dependency 'json', '~> 1.8'
 end

data/lib/consul/client/agent.rb

@@ -1,4 +1,5 @@
 require_relative 'base'
+require_relative '../model/agent'
 require_relative '../model/service'
 require_relative '../model/health_check'
 
@@ -6,8 +7,39 @@ require_relative '../model/health_check'
 # Represents Ruby endpoint as described here: https://www.consul.io/docs/agent/http/agent.html
 module Consul
   module Client
-    class Agent
-      include Consul::Client::Base
+    class Agent < Base
+
+      # Public: Describes the agent.  It is actually the same method as /v1/agent/self
+      #
+      # Example:
+      #          a = Agent.new
+      #          a.describe =>
+      #             <Consul::Model::Agent config=#<Consul::Model::Config bootstrap=true, server=true,
+      #               datacenter="dc1", datadir="/path/to/data", dns_recursor="", dns_recursors=[],
+      #               domain="consul.", log_level="INFO", node_name="MyComputer.local", client_addr="127.0.0.1",
+      #               bind_addr="0.0.0.0", advertise_addr="172.19.12.106", ports={"DNS"=>8600, "HTTP"=>8500, "HTTPS"=>-1,
+      #               "RPC"=>8400, "SerfLan"=>8301, "SerfWan"=>8302, "Server"=>8300}, leave_on_term=false,
+      #               skip_leave_on_int=false, stat_site_addr="", protocol=2, enable_debug=false, verify_incoming=false,
+      #               verify_outgoing=false, ca_file="", cert_file="", key_file="", start_join=[], ui_dir="", pid_file="",
+      #               enable_syslog=false, rejoin_after_leave=false>, member=#<Consul::Model::Member name="MyComputer.local",
+      #               addr="172.19.12.106", port=8301, tags={"bootstrap"=>"1", "build"=>"0.5.0:0c7ca91c", "dc"=>"dc1", "port"=>"8300",
+      #               "role"=>"consul", "vsn"=>"2", "vsn_max"=>"2", "vsn_min"=>"1"}, status=1, protocol_min=1, protocol_max=2,
+      #               protocol_cur=2, delegate_min=2, delegate_max=4, delegate_cur=4>>
+      #           a.describe.config.node_name =>
+      #             "MyComputer.local"
+      #           a.describe.member.name =>
+      #             "MyComputer.local"
+      #
+      # Return: Consul::Model::Agent instance that represents this agent.
+      def describe
+        begin
+          resp = _get build_agent_url('self')
+        rescue
+          logger.warn('Unable to request all the services on this through the HTTP API')
+          return nil
+        end
+        Consul::Model::Agent.new.extend(Consul::Model::Agent::Representer).from_json(resp)
+      end
 
       # Public: Returns all the services registered with this Agent.
       #
@@ -16,7 +48,7 @@ module Consul
         begin
           resp = _get build_agent_url('services')
         rescue
-          @logger.warn('Unable to request all the services on this through the HTTP API')
+          logger.warn('Unable to request all the services on this through the HTTP API')
           return nil
         end
         # Consul returns id => ConsulServiceObjects.
@@ -36,7 +68,7 @@ module Consul
         begin
           resp = _get build_agent_url('checks')
         rescue
-          @logger.warn('Unable to request all the checks on this through the HTTP API')
+          logger.warn('Unable to request all the checks on this through the HTTP API')
           return nil
         end
         # Consul returns id => ConsulServiceObjects.
@@ -81,11 +113,11 @@ module Consul
             entity = entity.extend(Consul::Model::Service::Representer)
             success = register_with_backoff(build_service_url('register'), entity, 0, 3)
             if success
-              @logger.info("Successfully registered service #{entity.name}.")
+              logger.info("Successfully registered service #{entity.name}.")
               unless entity.check.nil?
                 # Pass the first health check
                 c = check("service:#{entity.name}")
-                @logger.info("Updating status for health check #{c.check_id} to \"pass\".")
+                logger.info("Updating status for health check #{c.check_id} to \"pass\".")
                 _get build_check_status_url(c.check_id, 'pass')
               end
             end
@@ -174,7 +206,7 @@ module Consul
           c
         end
 
-        # Public: TTL Check
+        # Public: Script Check
         #
         # name      - The name of the check, Cannot be nil
         # script    - The script to run locally
@@ -193,7 +225,7 @@ module Consul
           c
         end
 
-        # Public: TTL Check
+        # Public: HTTP Check
         #
         # name      - The name of the check, Cannot be nil
         # http      - The HTTP endpoint to hit with periodic GET.
@@ -287,10 +319,11 @@ module Consul
           success, _ = _put(url, entity.to_json)
           unless success # Unless we successfully registered.
             if threshold == iteration
-              @logger.error("Unable to complete registration after #{threshold + 1} attempts")
+              logger.error("Unable to complete registration after #{threshold + 1} attempts")
+              return false
             else
               # Attempt to register again using the exponential backoff.
-              @logger.warn("Unable to complete registration after #{iteration + 1} attempts, Retrying up to #{threshold+1} attempts")
+              logger.warn("Unable to complete registration after #{iteration + 1} attempts, Retrying up to #{threshold+1} attempts")
               register_with_backoff(url, entity, iteration + 1, threshold)
             end
           end
@@ -319,4 +352,4 @@ module Consul
 
     end
   end
-end
+end

data/lib/consul/client/base.rb

@@ -7,22 +7,22 @@ module Consul
   module Client
 
     # Public API Base.
-    module Base
+    class Base
 
-      # Public: Creates an API Endpoint
+      # Public: Constructor with options hash
       #
-      # data_center - The data center to utilize, defaults to bootstrap 'dc1' datat center
-      # api_host    - The host the Consul Agent is running on. Default: 127.0.0.1
-      # api_port    - The port the Consul Agent is listening on. Default: 8500
-      # version     - The version of the api to use.
-      # logger      - Logging mechanism.  Must conform to Ruby Logger interface
+      # Optional Parameters:
+      #   options[:data_center] - The consul data center. Default: 'dc1'.
+      #   options[:api_host]    - The api host to request against.  Default: '127.0.0.1'.
+      #   options[:api_port]    - The api port the api host is listening to. Default: '8500'.
+      #   options[:version]     - The Consul API version to use. Default: 'v1'.
+      #   options[:logger]      - The default logging mechanism. Default: Logger.new(STDOUT).
       #
-      def initialize(data_center = 'dc1', api_host = '127.0.0.1', api_port = '8500', version = 'v1', logger = Logger.new(STDOUT))
-        @dc = data_center
-        @host = api_host
-        @port = api_port
-        @logger = logger
-        @version = version
+      # Return: This instance
+      def initialize(options = nil)
+        options = {} if options.nil?
+        raise TypeError, 'Options must be nil or a Hash' unless options.is_a?(Hash)
+        @options = options.clone
       end
 
       # Public: Test if this Consul Client is reachable.
@@ -88,24 +88,28 @@ module Consul
         end
       end
 
+      def options
+        @options ||= {}
+      end
+
       def data_center
-        @data_center ||= 'dc1'
+        @data_center ||= options[:data_center] || 'dc1'
       end
 
       def host
-        @host ||= '127.0.0.1'
+        @host ||= options[:api_host] || '127.0.0.1'
       end
 
       def port
-        @port ||= '8500'
+        @port ||= options[:api_port] || '8500'
       end
 
       def version
-        @version ||= 'v1'
+        @version ||= options[:version] || 'v1'
       end
 
       def logger
-        @logger ||= Logger.new(STDOUT)
+        @logger ||= options[:logger] || Logger.new(STDOUT)
       end
 
       def https

data/lib/consul/client/catalog.rb

@@ -4,8 +4,7 @@ require_relative '../model/node'
 # Consul Catalog End Point.
 module Consul
   module Client
-    class Catalog
-      include Consul::Client::Base
+    class Catalog < Base
 
       # Public: Returns a list of all the nodes on this client
       #
@@ -87,8 +86,6 @@ module Consul
 
       # Public: Builds the base url
       #
-      # Example:
-      #
       # Returns: The base
       def build_url(suffix)
         "#{base_versioned_url}/catalog/#{suffix}"

data/lib/consul/client/key_value.rb

@@ -4,30 +4,21 @@ require_relative '../model/key_value'
 
 module Consul
   module Client
-    class KeyValue
-      include Consul::Client::Base
+    class KeyValue < Base
 
-      # Public: Creates an API Endpoint
+      # Public: Constructor with options hash
       #
-      # data_center - The data center to utilize, defaults to bootstrap 'dc1' datat center
-      # api_host    - The host the Consul Agent is running on. Default: 127.0.0.1
-      # api_port    - The port the Consul Agent is listening on. Default: 8500
-      # version     - The version of the api to use.
-      # logger      - Logging mechanism.  Must conform to Ruby Logger interface
+      # Optional Parameters:
+      #   options[:namespace]   - The KeyValue Store namespace.
+      #   options[:data_center] - The consul data center.
+      #   options[:api_host]    - The api host to request against.
+      #   options[:api_port]    - The api port the api host is listening to.
+      #   options[:version]     - The Consul API version to use.
+      #   options[:logger]      - The default logging mechanism.
       #
-      def initialize(name_space = '', data_center = 'dc1', api_host = '127.0.0.1', api_port = '8500', version = 'v1', logger = Logger.new(STDOUT))
-        name_space = sanitize(name_space)
-        name_space = "#{name_space}/" unless name_space.nil? or name_space.empty?
-        @namespace = sanitize(name_space)
-        @dc = data_center
-        @host = api_host
-        @port = api_port
-        @logger = logger
-        @version = version
-      end
-
-      def name_space
-        @namespace ||= ''
+      # Return: This instance
+      def initialize(options = nil)
+        super(options)
       end
 
       # Public: Gets the value associated with a given key.
@@ -52,21 +43,14 @@ module Consul
         params[:index] = nil if index
         params[:keys] = nil if only_keys
         params[:separator] = separator unless separator.nil?
-        # begin
-        #   resp = RestClient.get key_url(key), {:params => params}
-        # rescue
-        #   # TODO need to pass more information back to the client.
-        #   logger.warn("Unable to get value for #{key}")
-        #   nil
-        # end
         begin
-          resp = _get key_url(key), params
+          resp = _get build_url(compose_key(key)), params
         rescue Exception => e
           logger.warn("Unable to get value for #{key} due to: #{e}")
           return nil
         end
         return nil if resp.code == 404
-        json = JSON.parse(_get key_url(key), params)
+        json = JSON.parse(resp)
         return json if only_keys
         json.map { |kv|
           kv = Consul::Model::KeyValue.new.extend(Consul::Model::KeyValue::Representer).from_hash(kv)
@@ -105,9 +89,9 @@ module Consul
         begin
           value = JSON.generate(value)
         rescue JSON::GeneratorError
-          @logger.debug("Using non-JSON value for key #{key}")
+          logger.debug("Using non-JSON value for key #{key}")
         end
-        _put build_url(key), value, {:params => params}
+        _put build_url(compose_key(key)), value, {:params => params}
       end
 
       # Public: Delete the Key Value pair in consul.
@@ -123,6 +107,14 @@ module Consul
         RestClient.delete build_url(key), {:params => params}
       end
 
+      # Public: Returns the name space of this KeyValue Store.  This allows you to
+      # identify what root namespace all keys will be placed under.
+      #
+      # Returns: Namespace String.
+      def namespace
+        @namespace ||= options[:namespace] || ''
+      end
+
       def build_url(suffix)
         "#{base_versioned_url}/kv/#{suffix}"
       end
@@ -130,11 +122,21 @@ module Consul
       private
 
       def sanitize(key)
-        key.gsub(/^\//,'').gsub(/\/$/,'')
+        unless key.nil? or !key.respond_to?(:to_s)
+          key = key.to_s
+          while !key.empty? and key[0] == '/' do
+            key[0] = ''
+          end
+          while !key.empty? and key[key.length - 1] == '/' do
+            key[key.length - 1] = ''
+          end
+        end
       end
 
-      def key_url(key)
-        build_url("#{name_space}#{key}")
+      def compose_key(key)
+        ns = namespace.strip
+        return "#{key}" if ns.empty?
+        "#{ns}/#{key}"
       end
 
     end

data/lib/consul/client/session.rb

@@ -5,8 +5,7 @@ require_relative '../util/utils'
 module Consul
   module Client
     # Consul Session Client
-    class Session
-      include Consul::Client::Base
+    class Session < Base
 
       # Public: Creates an instance of Consul::Model::Session with as many preset
       # defaults as possible.

data/lib/consul/client/status.rb

@@ -2,8 +2,7 @@ require_relative 'base'
 
 module Consul
   module Client
-    class Status
-      include Consul::Client::Base
+    class Status < Base
 
       # Public: This endpoint is used to get the Raft leader for the
       # datacenter in which the agent is running

data/lib/consul/client/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Client
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/consul/client.rb

@@ -10,6 +10,7 @@ require_relative '../consul/client/catalog'
 require_relative '../consul/client/key_value'
 require_relative '../consul/client/session'
 require_relative '../consul/client/status'
+require_relative '../consul/extensions/uid'
 
 module Consul
   module Client

data/lib/consul/extensions/base.rb

@@ -0,0 +1,49 @@
+
+module Consul
+  module Extensions
+    class Base
+
+      # Public: Constructor for this extension.  Ensures a global unique ID for this client for a given namespace.
+      #
+      #   options               - (Optional) Hash of Consul Client and extension options.
+      #   options[:data_center] - (Optional) The Consul data center. Default: 'dc1'.
+      #   options[:api_host]    - (Optional) The Consul api host to request against.  Default: '127.0.0.1'.
+      #   options[:api_port]    - (Optional) The Consul api port the api host is listening to. Default: '8500'.
+      #   options[:version]     - (Optional) The Consul API version to use. Default: 'v1'.
+      #   options[:logger]      - (Optional) The default logging mechanism. Default: Logger.new(STDOUT).
+      #
+      # Extension instance capable of generating GUID.
+      def initialize(options)
+        options = {} if options.nil?
+        @options = options.clone
+      end
+
+      protected
+
+      # Semantically private namespace for consul-ruby-client extensions.
+      def extensions_namespace
+        '.extensions'
+      end
+
+      # The Consul Agent Client to use
+      def agent
+        @agent = Agent.new(options)
+      end
+
+      # The Key Value Store to use.
+      def key_value_store
+        @kvs = KeyValue.new(options)
+      end
+
+      # TODO Add other clients here.
+
+      private
+
+      def options
+      @options
+      end
+
+
+    end
+  end
+end

data/lib/consul/extensions/uid.rb

@@ -0,0 +1,69 @@
+require_relative 'base'
+require_relative '../../consul/client/key_value'
+
+module Consul
+  module Extensions
+
+    # Global Unique ID Generator Extension.
+    #
+    # A utility extension that helps in syncronously and safely generating unique id.
+    #
+    class UID < Base
+      include Consul::Client
+
+      # Public: Constructor for this extension.  Ensures a global unique ID for this client for a given namespace.
+      #
+      #   options               - (Required) Hash of Consul Client and extension options.
+      #   options[:name]        - (Required) The name or name space of the GUID to generate.  This extension will
+      #                           generate a GUID with respect to other clients is this name space.
+      #   options[:client_id]   - (Optional) External Client ID.  This is an additional semantic parameter external to consul.
+      #                           This provides the capability to unique identify your external client.
+      #                           Default: Consul Agent name.  Cannot begin with "."
+      #   options[:data_center] - (Optional) The Consul data center. Default: 'dc1'.
+      #   options[:api_host]    - (Optional) The Consul api host to request against.  Default: '127.0.0.1'.
+      #   options[:api_port]    - (Optional) The Consul api port the api host is listening to. Default: '8500'.
+      #   options[:version]     - (Optional) The Consul API version to use. Default: 'v1'.
+      #   options[:logger]      - (Optional) The default logging mechanism. Default: Logger.new(STDOUT).
+      #
+      # Extension instance capable of generating GUID.
+      def initialize(options)
+        raise TypeError.new "Options must not be a Hash that contains \":name\"" unless options.is_a?(Hash)
+        if options.has_key?(:name) or options[:name].strip.empty?
+          raise ArgumentError.new "Illegal GUID Name: \"#{options[:name]}\". Must not be nil or empty"
+        end
+        raise ArgumentError.new "GUID Name cannot start with special character"
+        options[:namespace] = namespace
+        @options = options.clone
+      end
+
+      # Public: Generate a global unique id syncronously with other
+      def generate
+        # TODO Has the key ever been generated
+        # Create a Consul Session the the underlying namespace
+        # Get the current value for
+        # Set the check and set primitive
+      end
+
+      private
+
+      # The FQ namespace for this GUID
+      def namespace
+        @namespace ||= "#{extensions_namespace}/uid/#{@options[:name]}"
+      end
+
+      def available_uid
+        "#{namespace}/.available"
+      end
+
+      # The individual client id for this uid generator
+      def client_id
+        client_id = nil
+        unless @options[:client_id].nil? or @options[:client_id].strip.empty?
+          client_id = client_id.strip
+        end
+        @client_id ||= client_id || agent.describe.member.name
+      end
+
+    end
+  end
+end

data/lib/consul/model/agent.rb

@@ -0,0 +1,26 @@
+require 'representable/json'
+require 'ostruct'
+require_relative 'config'
+require_relative 'member'
+
+module Consul
+  module Model
+    # Agent Model class
+    #
+    # Common use case Agent.self
+    #
+    # Reference: https://www.consul.io/docs/agent/http/agent.html#agent_self
+    #
+    class Agent < OpenStruct
+      module Representer
+        include Representable::JSON
+        include Representable::Hash
+        include Representable::Hash::AllowSymbols
+
+        property :config, as: :Config, extend: Consul::Model::Config::Representer, class: Consul::Model::Config
+        property :member, as: :Member, extend: Consul::Model::Member::Representer, class: Consul::Model::Member
+      end
+      extend Representer
+    end
+  end
+end

data/lib/consul/model/config.rb

@@ -0,0 +1,49 @@
+require 'representable/json'
+require 'ostruct'
+
+module Consul
+  module Model
+    # Consul Config Object Representation
+    #
+    # Reference:  https://www.consul.io/docs/agent/http/agent.html#agent_self
+    #
+    class Config < OpenStruct
+      module Representer
+        include Representable::JSON
+        include Representable::Hash
+        include Representable::Hash::AllowSymbols
+
+        property :bootstrap, as: :Bootstrap
+        property :server, as: :Server
+        property :datacenter, as: :Datacenter
+        property :datadir, as: :DataDir
+        property :dns_recursor, as: :DNSRecursor
+        property :dns_recursors, as: :DNSRecursors
+        property :domain, as: :Domain
+        property :log_level, as: :LogLevel
+        property :node_name, as: :NodeName
+        property :client_addr, as: :ClientAddr
+        property :bind_addr, as: :BindAddr
+        property :advertise_addr, as: :AdvertiseAddr
+        property :ports, as: :Ports
+        property :leave_on_term, as: :LeaveOnTerm
+        property :skip_leave_on_int, as: :SkipLeaveOnInt
+        property :stat_site_addr, as: :StatsiteAddr
+        property :protocol, as: :Protocol
+        property :enable_debug, as: :EnableDebug
+        property :verify_incoming, as: :VerifyIncoming
+        property :verify_outgoing, as: :VerifyOutgoing
+        property :ca_file, as: :CAFile
+        property :cert_file, as: :CertFile
+        property :key_file, as: :KeyFile
+        property :start_join, as: :StartJoin
+        property :ui_dir, as: :UiDir
+        property :pid_file, as: :PidFile
+        property :enable_syslog, as: :EnableSyslog
+        property :rejoin_after_leave, as: :RejoinAfterLeave
+
+      end
+      extend Representer
+    end
+  end
+end

data/lib/consul/model/member.rb

@@ -0,0 +1,33 @@
+require 'representable/json'
+require 'ostruct'
+
+module Consul
+  module Model
+
+    # Consul Member representation
+    #
+    # Reference: https://www.consul.io/docs/commands/members.html
+    #
+    class Member < OpenStruct
+      module Representer
+        include Representable::JSON
+        include Representable::Hash
+        include Representable::Hash::AllowSymbols
+
+        property :name, as: :Name
+        property :addr, as: :Addr
+        property :port, as: :Port
+        # TODO Ensure we map tags into a ruby hash and back
+        property :tags, as: :Tags
+        property :status, as: :Status
+        property :protocol_min, as: :ProtocolMin
+        property :protocol_max, as: :ProtocolMax
+        property :protocol_cur, as: :ProtocolCur
+        property :delegate_min, as: :DelegateMin
+        property :delegate_max, as: :DelegateMax
+        property :delegate_cur, as: :DelegateCur
+      end
+      extend Representer
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Hotan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement
@@ -145,8 +145,13 @@ files:
 - lib/consul/client/session.rb
 - lib/consul/client/status.rb
 - lib/consul/client/version.rb
+- lib/consul/extensions/base.rb
+- lib/consul/extensions/uid.rb
+- lib/consul/model/agent.rb
+- lib/consul/model/config.rb
 - lib/consul/model/health_check.rb
 - lib/consul/model/key_value.rb
+- lib/consul/model/member.rb
 - lib/consul/model/node.rb
 - lib/consul/model/service.rb
 - lib/consul/model/session.rb