zas-service 0.0.2 → 0.0.3

data/lib/zas/authenticators/filtered_authenticator.rb

@@ -1,6 +1,6 @@
 module Zas
   module Authenticators
-    # An authenticator that filters the credentials through 1 or more filters that can transform
+    # Public: An authenticator that filters the credentials through 1 or more filters that can transform
     # the credentials before passing them to another authenticator.
     #
     # Example:
@@ -10,7 +10,7 @@ module Zas
     class FilteredAuthenticator
       attr_accessor :logger
 
-      # Initialize the filtered authenticator with the given delegate
+      # Public: Initialize the filtered authenticator with the given delegate
       # and filters. Filters will be applied when the authentication
       # occurs.
       #
@@ -21,13 +21,16 @@ module Zas
         self.filters = [filters].compact.flatten
       end
 
-      # Authenticate the given credentials.
+      # Public: Authenticate the given credentials.
       #
       # credentials - The credentials
+      #
+      # Returns true if the credentials are authenticated
       def authenticate(credentials)
-        logger.info "Applying filters to credentials: #{filters.join(', ')}"
+        logger.info "Applying filters to credentials: #{filters.join(', ')}" if logger
         credentials = filters.reduce(credentials) { |credentials, filter| filter.authenticate(credentials) }
-        logger.info "Delegating to #{delegate.class.name}"
+        logger.info "Delegating to #{delegate.class.name}" if logger
+        delegate.logger ||= logger
         delegate.authenticate(*credentials)
       end
 

data/lib/zas/authenticators/sequel_password_authenticator.rb

@@ -30,9 +30,10 @@ module Zas
         end
       end
 
+      # Public: a logger.
       attr_accessor :logger
       
-      # Initialize the autenticator with the given sequel DB. Optionally pass in additional
+      # Public: Initialize the autenticator with the given sequel DB. Optionally pass in additional
       # configuration for the authenticator.
       #
       # sequel_db - The Sequel Datbase instance
@@ -45,11 +46,16 @@ module Zas
         self.salt_field = config.salt_field.to_sym
       end
 
-      # Authenticate the given username/password pair
+      # Public: Authenticate the given username/password pair
+      #
+      # username - The username
+      # password - The password
+      #
+      # Returns true if the username/password pair are authenticated. Will return a falsey value otherwise. 
       def authenticate(username, password)
-        logger.info "Authenticating #{username} (table: #{table_name}, username_field: #{username_field})"
+        logger.info "Authenticating #{username} (table: #{table_name}, username_field: #{username_field})" if logger
         record = db[table_name].filter(username_field => username).first
-        logger.info "Record found for #{username}"
+        logger.info "Record found for #{username}" if logger
         tokens = [password, record[salt_field]].compact
         matches?(record[password_field], *tokens) if record
       end

data/lib/zas/crypto_providers/sha512.rb

@@ -1,25 +1,30 @@
 module Zas  
   module CryptoProviders
-    # = Sha512
-    #
-    # Uses the Sha512 hash algorithm to encrypt passwords.
+    # Public: Uses the Sha512 hash algorithm to encrypt passwords.
     class Sha512
       require 'digest/sha2'
 
-      # The number of times to loop through the encryption. This is twenty because that is what restful_authentication defaults to.
+      # Public: The number of times to loop through the encryption. This is twenty because that is what restful_authentication defaults to.
       def stretches
         @stretches ||= 20
       end
       attr_writer :stretches
 
-      # Turns your raw password into a Sha512 hash.
+      # Public: Turns your raw password into a Sha512 hash.
+      #
+      # tokens - The tokens to encrypt
+      #
+      # Returns the encrypted string
       def encrypt(*tokens)
         digest = tokens.flatten.join(nil)
         stretches.times { digest = Digest::SHA512.hexdigest(digest) }
         digest
       end
 
-      # Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
+      # Public: Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
+      #
+      # crytped - The crypted value
+      # tokens - A collection of tokens to encrypt
       def matches?(crypted, *tokens)
         encrypt(*tokens) == crypted
       end

data/lib/zas/filters/http_basic_auth.rb

@@ -1,12 +1,12 @@
 require 'base64'
 module Zas
   module Filters 
-    # Filter that base64 decodes the credentials and splits them
+    # Public: Filter that base64 decodes the credentials and splits them
     # on a colon (based on the HTTP Basic Authentication
     # speciications).
     module HttpBasicAuth 
       module_function
-      # Filter the authentication credentials.
+      # Public: Filter the authentication credentials.
       #
       # credentials - The credentials
       #

data/lib/zas/filters/standard_auth.rb

@@ -1,8 +1,14 @@
 module Zas
   module Filters
+    # Filter that converts from a Hash to an Array.
     module StandardAuth
       module_function
-
+      # Filter the authentication credentials by converting from
+      # a Hash to an array.
+      #
+      # credentials - The credentials Hash
+      #
+      # Returns a pair of [username, password]
       def authenticate(credentials)
         [credentials['username'], credentials['password']]
       end

data/lib/zas/service.rb

@@ -4,7 +4,7 @@ require 'yajl'
 require 'hashie'
 
 module Zas
-  # Authentication service class. Construct a new instance of this
+  # Public: Authentication service class. Construct a new instance of this
   # class and call the instance method #run to start it.
   class Service
     require 'zas/service_configuration'
@@ -12,14 +12,17 @@ module Zas
     require 'zas/authenticators'
     require 'zas/crypto_providers'
 
+    # Public: A syslog logger
     attr_accessor :logger
 
-    # A collection authenticators mapped to keys.
+    # Public: A collection authenticators mapped to keys.
+    #
+    # Returns a Hash of authenticators.
     def authenticators 
       @authenticators ||= {}
     end
 
-    # Initialize the service. The service will not be running yet. Invoke the #run method on the service
+    # Public: Initialize the service. The service will not be running yet. Invoke the #run method on the service
     # instantce to run the service.
     #
     # config - Configuration spec for the service.
@@ -30,7 +33,8 @@ module Zas
       self.logger = Syslogger.new(config.name, Syslog::LOG_PID, Syslog::LOG_LOCAL0)
     end
 
-    # Run the service.
+    # Public: Run the service. This method will block while awaiting incoming requests. The service
+    # may be stopped by sending the INT signal.
     def run
       socket = context.socket ZMQ::REP
       socket.bind "tcp://#{host}:#{port}"
@@ -54,7 +58,7 @@ module Zas
     attr_accessor :context
     attr_writer :logger
 
-    # Handle the authentication.
+    # Internal: Handle the authentication.
     #
     # req_string - A JSON string
     # 
@@ -63,13 +67,14 @@ module Zas
       req = Hashie::Mash.new(Yajl::Parser.parse(req_string))
       authenticator = authenticators[req.strategy]
       raise "No authenticator found for #{req.strategy}" unless authenticator
+      authenticator.logger ||= logger
       {:authenticated? => authenticator.authenticate(req.credentials)}
     rescue => e
       logger.info "Error authenticating: #{e.message}"
       {:error => e.message}
     end
 
-    # Encode the response object
+    # Internal: Encode the response object
     #
     # data - The object
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zas-service
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: