zas-client 0.0.8 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Zero Authentication Service - Ruby Client
 
-This is a ruby client libraty for the Zero Authentication Service.
+This is a ruby client libraty for the Zero Authentication Service (https://github.com/zero-as/zas-service).
 
 ## Usage
 
@@ -22,6 +22,32 @@ In irb:
     bundle exec irb -Ilib -rzas
     => # everything from general usage
 
+## Adding Support for Other Credential Types
+
+Any object that responds to `#to_wire` may be based to `Client#authenticate`. The wire format is JSON and
+includes a strategy key/value pair and a credentials key/value pair. For example, here is what a simple
+authentication wire representation looks like:
+
+    {
+      "strategy": "auth",
+      "credentials": {
+        "username": "jdoe",
+        "password": "password"
+      }
+    }
+
+Here is an example of what a custom authentication type might look like:
+
+    {
+      "strategy": "my_auth",
+      "credentials": {
+        "id": "my_identifier",
+        "token": "123456gregergjerg"
+      }
+    }
+
+In order to handle a custom strategy you will need to register an authenticator when starting up your
+Zas service.
 
 ## Configuration
   

data/lib/zas/client.rb

@@ -4,32 +4,45 @@ require 'yajl'
 require 'hashie'
 
 module Zas
-  # A TimeoutError may be raised if the Zas authentication service fails to respond
+  # Public: A TimeoutError may be raised if the Zas authentication service fails to respond
   # within a timeout limit.
   class TimeoutError < RuntimeError
   end
 
+  # Public: A client for the Zero Authentication Service.
   class Client
     require 'zas/client_configuration'
     require 'zas/credentials'
     require 'zas/http_basic_credentials'
 
-    # Initialize the client with the given configuration.
+    # Public: Initialize the client with the given configuration.
     #
     # config - Configuration spec for the client.
     def initialize(config=ClientConfiguration.new)
       self.host = config.host
       self.port = config.port
       self.timeout = config.timeout
+      self.logger = config.logger
       self.context = ZMQ::Context.new
-      self.logger = Syslogger.new(config.name, Syslog::LOG_PID, Syslog::LOG_LOCAL0) 
 
-      at_exit { close }
+      Signal.trap(:INT) { 
+        begin
+          puts "Trapped INT in Zas client"
+          disconnect
+          close
+        rescue => e
+          puts "Error while trying to shut down zas client: #{e.message}"
+        end
+      }
     end
 
     # Public: Authenticate the given credentials.
     #
-    # credentials - The credentials
+    # credentials - The credentials. The credentials may be any object that implements
+    # the #to_wire method. This method must construct a JSON data structure with
+    # at least the following two keys:
+    #   strategy - The name of the strategy to use
+    #   credentials - A data structure with the credentials
     #
     # Returns the results of the authentication.
     #
@@ -38,9 +51,12 @@ module Zas
     def authenticate(credentials)
       begin
         socket.send credentials.to_wire
+        logger.debug "Selecting on socket #{socket.inspect} with timeout #{timeout}"
         if ZMQ.select([socket], nil, nil, timeout)
+          logger.debug("Receiving from socket #{socket.inspect}")
           Hashie::Mash.new(Yajl::Parser.parse(socket.recv))
         else
+          logger.debug("Failed to select on socket #{socket.inspect}")
           disconnect
           raise Zas::TimeoutError, "Response from authentication service not received in time"
         end
@@ -51,13 +67,20 @@ module Zas
 
     # Public: Disconnect the socket.
     def disconnect
-      socket.close if socket
+      if socket
+        logger.debug "Closing socket #{socket.inspect}"
+        socket.close
+      end
       @socket = nil
     end
 
     # Public: Close the context.
     def close
-      context.close if context
+      if context
+        logger.debug "Closing context #{context.inspect}"
+        context.close
+        context = nil
+      end
     end
 
     private
@@ -72,10 +95,14 @@ module Zas
     end
 
     def build_socket
-      socket = context.socket ZMQ::REQ
-      socket.connect "tcp://#{host}:#{port}"
-      Signal.trap(:INT) { disconnect }
-      socket
+      if context
+        logger.info "Building new socket for Zas Client, connecting to #{host}:#{port}"
+        socket = context.socket ZMQ::REQ
+        socket.connect "tcp://#{host}:#{port}"
+        socket
+      else
+        logger.info "Cannot build a new socket as there is no context"
+      end
     end
   end
 end

data/lib/zas/client_configuration.rb

@@ -1,27 +1,44 @@
 module Zas
-  # Struct used to configure the Zas::Client.
+  # Public: Struct used to configure the Zas::Client. Configuration options are:
   #
-  # 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.
-  # timeout - The timeout for responses. Defaults to 1 second.
-  class ClientConfiguration < Struct.new(:host, :port, :name, :timeout)
+  # host - The IP address of the service (default: 127.0.0.1)
+  # port - The port number for the service (default: 5555)
+  # name - The name of the client for logging (default: zas-client)  
+  # timeout - The timeout, in seconds, to wait for a response from the service (default: 1 second)
+  # logger - The logger (default: syslog)
+  class ClientConfiguration < Struct.new(:host, :port, :name, :timeout, :logger)
+    # Public: Construct the ClientConfiguration.
+    #
+    # attributes - A Hash of attributes. All attributes are optional:
+    #              host - The IP address of the service (default: 127.0.0.1)
+    #              port - The port number for the service (default: 5555)
+    #              name - The name of the client for logging (default: zas-client)  
+    #              timeout - The timeout, in seconds, to wait for a response from the service (default: 1 second)
+    #              logger - The logger (default: syslog)
     def initialize(attributes={})
       attributes.each do |k, v|
         self[k] = v
       end
     end
+
     def host
       self[:host] || '127.0.0.1'
     end
+    
     def port
       self[:port] || '5555'
     end
+    
     def name
       self[:name] || 'zas-client'
     end
+    
     def timeout
       self[:timeout] || 1
     end
+
+    def logger
+      self[:logger] || Syslogger.new(config.name, Syslog::LOG_PID, Syslog::LOG_LOCAL0) 
+    end
   end
 end

data/lib/zas/credentials.rb

@@ -1,14 +1,14 @@
 module Zas
-  # Handle credentials as a Hash
+  # Public: Handle credentials as a Hash
   class Credentials
-    # Initialize the credentials with the given Hash.
+    # Public: 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
+    # Public: Construct a wire representation of the credentials
     #
     # Returns the encoded JSON
     def to_wire

data/lib/zas/http_basic_credentials.rb

@@ -1,13 +1,15 @@
 module Zas
-  # Credentials as taken from HTTP Basic Authentication.
+  # Public: Credentials as taken from HTTP Basic Authentication.
   class HttpBasicCredentials
-    # Construct the credentials with the base64 encoded value
+    # Public: Construct the credentials with the base64 encoded value
     # passed directly from an HTTP request.
+    #
+    # base64_encoded_credentials - The Base64 encoded HTTP Basic credentials
     def initialize(base64_encoded_credentials)
       self.base64_encoded_credentials = base64_encoded_credentials
     end
 
-    # Construct a wire representation of the credentials.
+    # Public: Construct a wire representation of the credentials.
     #
     # Returns the encoded JSON
     def to_wire

metadata

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