zas-client 0.0.5 → 0.0.6

data/lib/zas/client.rb

@@ -4,6 +4,11 @@ require 'yajl'
 require 'hashie'
 
 module Zas
+  # A TimeoutError may be raised if the Zas authentication service fails to respond
+  # within a timeout limit.
+  class TimeoutError < RuntimeError
+  end
+
   class Client
     require 'zas/client_configuration'
     require 'zas/credentials'
@@ -15,6 +20,7 @@ module Zas
     def initialize(config=ClientConfiguration.new)
       self.host = config.host
       self.port = config.port
+      self.timeout = config.timeout
       self.context = ZMQ::Context.new
       self.logger = Syslogger.new(config.name, Syslog::LOG_PID, Syslog::LOG_LOCAL0) 
 
@@ -26,12 +32,19 @@ module Zas
     # credentials - The credentials
     #
     # Returns the results of the authentication.
+    #
+    # Raises a Zas::TimeoutError if the authentication service does not respond
+    # within the timeout as specified the configuration.
     def authenticate(credentials)
       begin
         socket.send credentials.to_wire
-        Hashie::Mash.new(Yajl::Parser.parse(socket.recv))
+        if ZMQ.select(socket, nil, nil, timeout)
+          Hashie::Mash.new(Yajl::Parser.parse(socket.recv))
+        else
+          raise Zas::TimeoutError, "Response from authentication service not received in time"
+        end
       rescue IOError => e
-        logger.error "Shutting down: #{e.message}" 
+        logger.error "IO error occurred: #{e.message}" 
       end 
     end
 
@@ -50,6 +63,7 @@ module Zas
     attr_accessor :context
     attr_accessor :host
     attr_accessor :port
+    attr_accessor :timeout
     attr_accessor :logger
 
     def socket

data/lib/zas/client_configuration.rb

@@ -4,7 +4,8 @@ module Zas
   # host - The IP address of the service. Defaults to 127.0.0.1
   # port - The port number for the service.
   # name - The name of the client for logging.
-  class ClientConfiguration < Struct.new(:host, :port, :name)
+  # timeout - The timeout for responses. Defaults to 1 second.
+  class ClientConfiguration < Struct.new(:host, :port, :name, :timeout)
     def initialize(attributes={})
       attributes.each do |k, v|
         self[k] = v
@@ -19,5 +20,8 @@ module Zas
     def name
       self[:name] || 'zas-client'
     end
+    def timeout
+      self[:timeout] || 1
+    end
   end
 end

data/lib/zas/credentials.rb

@@ -1,9 +1,16 @@
 module Zas
+  # Handle credentials as a Hash
   class Credentials
+    # Initialize the credentials with the given Hash.
+    #
+    # credentials - A Hash with the keys :username and :password
     def initialize(credentials)
       self.credentials = credentials
     end
 
+    # Construct a wire representation of the credentials
+    #
+    # Returns the encoded JSON
     def to_wire
       Yajl::Encoder.encode({:strategy => :auth, :credentials => credentials}) 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zas-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-22 00:00:00.000000000 Z
+date: 2012-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zmq