treequel 1.0.0 → 1.0.1

data/examples/ldap-rack-auth.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require 'rack'
+require 'treequel'
+
+### A collection of Rack middleware for adding LDAP authentication/authorization
+### to Rack applications.
+module LdapAuthentification
+
+	### The simplest kind of authentication -- if the user provides credentials that allow
+	### her to bind to the directory, access is granted.
+	class BindAuth
+
+		### Create a new LdapAuthentication::Bind middleware that will wrap +app+. Supported options
+		### are:
+		### 
+		### url::
+		###   The LDAP URL (RFC4516) used to specify how to bind to the directory.
+		def initialize( app, options )
+			@app = app
+			@url = options[:url]
+			@dir, @attributes, @scope, @filter = self.split_url( @url )
+		end
+
+
+		######
+		public
+		######
+
+		### Rack Interface: handle a request.
+		def call( env )
+			request = Rack::Request.new( env )
+			if self.can_bind?( request.params.values_at('uid','password') )
+				return @app.call( env )
+			else
+				return [
+					401,
+					{
+						'Content-Type' => 'text/plain',
+						'Content-Length' => '0',
+						'WWW-Authenticate' => www_authenticate.to_s
+					},
+					[]
+				]
+			end
+		end
+
+
+		#########
+		protected
+		#########
+
+		### Parse the given +url+ into a Treequel::Directory, an Array of selection attributes,
+		### a scope, and a filter for selecting users.
+		def split_url( url )
+			url = URI.parse( url )
+			directory = Treequel.directory( url )
+
+			parts = url.query.split( '?' )
+			attributes = self.normalize_attributes( parts.shift )
+			scope = self.normalize_scope( parts.shift )
+			filter = self.normalize_filter( parts.shift )
+
+			return directory, attributes, scope, filter
+		end
+
+
+		### Parse the attributes in the given +attrlist+ and return an Array of Symbols suitable
+		### for passing to Treequel::Branch#select.
+		def normalize_attributes( attrlist=nil )
+			return [] unless attrlist
+			return attrlist.split( /,/ ).
+				reject  {|attrname| attrname !~ /^[a-z][^\w\-]$/i }.
+				collect {|attrname| attrname.untaint.to_sym }
+		end
+
+
+		### Parse the scope from the given +scopename+ and return it as one of the Symbols:
+		### [ :sub, :one, :base ]
+		def normalize_scope( scopename )
+			if scopename =~ /^(one|sub|base)/i
+				return $1.untaint.to_sym
+			else
+				raise ArgumentError, "Invalid scope %p" % [ scopename ]
+			end
+		end
+
+
+		### Returns +true+ if the specified +user+ can bind to the directory
+		### with the specified +password+.
+		def can_bind?( username, password )
+			filter = @filter.gsub( /:username/, username )
+			@user = @dir.scope( @scope.to_sym ).filter( filter )
+			@dir.bind( @user, password )
+			return true
+		rescue LDAP::ResultError => err
+			# How the hell do you log from Rack middleware?
+			return false
+		end
+
+	end # class BindAuth

data/lib/treequel/branchset.rb

@@ -332,6 +332,17 @@ class Treequel::Branchset
 	end
 
 
+	### Return a clone of the receiving Branchset that will return instances of the
+	### give +branchclass+ instead of Treequel::Branch objects. This may be a subclass
+	### of Treequel::Branch, but it doesn't need to be as long as they duck-type the 
+	### same.
+	def as( branchclass )
+		newset = self.clone
+		newset.branch = branchclass.new( self.branch.directory, self.branch.dn )
+		return newset
+	end
+	
+
 	# Hiding this until we figure out how to do server-side ordering (i.e., 
 	# http://tools.ietf.org/html/rfc2891)
 

data/lib/treequel/directory.rb

@@ -207,9 +207,7 @@ class Treequel::Directory
 	end
 
 
-	### Bind as the specified +user_dn+ and +password+. If the optional +block+ is given,
-	### it will be executed with the receiver bound, then returned to its previous state when
-	### the block exits.
+	### Bind as the specified +user_dn+ and +password+.
 	def bind( user_dn, password )
 		user_dn = user_dn.dn if user_dn.respond_to?( :dn )
 

data/lib/treequel/filter.rb

@@ -490,7 +490,7 @@ class Treequel::Filter
 				Treequel::Filter.new( :or, subfilters )
 			else
 				Treequel.logger.debug "    value is a scalar; creating a single filter"
-				Treequel::Filter.new( key, expr )
+				Treequel::Filter.new([ key.to_sym, expr ])
 			end
 		end
 

data/lib/treequel/mixins.rb

@@ -116,23 +116,7 @@ module Treequel # :nodoc:
 	end # module Delegation
 
 
-	# 
 	# Add logging to a Treequel class. Including classes get #log and #log_debug methods.
-	# 
-	# == Version
-	#
-	#  $Id$
-	#
-	# == Authors
-	#
-	# * Michael Granger <ged@FaerieMUD.org>
-	#
-	# :include: LICENSE
-	#
-	# --
-	#
-	# Please see the file LICENSE in the 'docs' directory for licensing details.
-	#
 	module Loggable
 
 		LEVEL = {
@@ -319,6 +303,71 @@ module Treequel # :nodoc:
 
 	end # module AttributeDeclarations
 
+
+	### A collection of ANSI color utility functions
+	module ANSIColorUtilities
+
+		# Set some ANSI escape code constants (Shamelessly stolen from Perl's
+		# Term::ANSIColor by Russ Allbery <rra@stanford.edu> and Zenin <zenin@best.com>
+		ANSI_ATTRIBUTES = {
+			'clear'      => 0,
+			'reset'      => 0,
+			'bold'       => 1,
+			'dark'       => 2,
+			'underline'  => 4,
+			'underscore' => 4,
+			'blink'      => 5,
+			'reverse'    => 7,
+			'concealed'  => 8,
+
+			'black'      => 30,   'on_black'   => 40,
+			'red'        => 31,   'on_red'     => 41,
+			'green'      => 32,   'on_green'   => 42,
+			'yellow'     => 33,   'on_yellow'  => 43,
+			'blue'       => 34,   'on_blue'    => 44,
+			'magenta'    => 35,   'on_magenta' => 45,
+			'cyan'       => 36,   'on_cyan'    => 46,
+			'white'      => 37,   'on_white'   => 47
+		}
+
+		###############
+		module_function
+		###############
+
+		### Create a string that contains the ANSI codes specified and return it
+		def ansi_code( *attributes )
+			attributes.flatten!
+			attributes.collect! {|at| at.to_s }
+			return '' unless /(?:vt10[03]|xterm(?:-color)?|linux|screen)/i =~ ENV['TERM']
+			attributes = ANSI_ATTRIBUTES.values_at( *attributes ).compact.join(';')
+
+			if attributes.empty? 
+				return ''
+			else
+				return "\e[%sm" % attributes
+			end
+		end
+
+
+		### Colorize the given +string+ with the specified +attributes+ and return it, handling 
+		### line-endings, color reset, etc.
+		def colorize( *args )
+			string = ''
+
+			if block_given?
+				string = yield
+			else
+				string = args.shift
+			end
+
+			ending = string[/(\s)$/] || ''
+			string = string.rstrip
+
+			return ansi_code( args.flatten ) + string + ansi_code( 'reset' ) + ending
+		end
+
+	end # module ANSIColorUtilities
+
 end # module Treequel
 
 # vim: set nosta noet ts=4 sw=4:

data/lib/treequel/utils.rb

@@ -6,7 +6,7 @@ require 'bigdecimal'
 require 'date'
 
 require 'treequel'
-# require 'treequel/constants'
+require 'treequel/mixins'
 
 
 module Treequel # :nodoc:
@@ -87,6 +87,81 @@ module Treequel # :nodoc:
 	end # class LogFormatter
 
 
+	# 
+	# A ANSI-colorized formatter for Logger instances.
+	# 
+	# == Usage
+	# 
+	#   require 'treequel/utils'
+	#   Treequel.logger.formatter = Treequel::ColorLogFormatter.new( Treequel.logger )
+	# 
+	# == Version
+	#
+	#  $Id$
+	#
+	# == Authors
+	#
+	# * Michael Granger <ged@FaerieMUD.org>
+	#
+	# :include: LICENSE
+	#
+	#--
+	#
+	# Please see the file LICENSE in the 'docs' directory for licensing details.
+	#
+	class ColorLogFormatter < Logger::Formatter
+		extend Treequel::ANSIColorUtilities
+
+		# Color settings
+		LEVEL_FORMATS = {
+			:debug => colorize( :bold, :black ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s {%6$s} -- %7$s\n"},
+			:info  => colorize( :normal ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+			:warn  => colorize( :bold, :yellow ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+			:error => colorize( :red ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+			:fatal => colorize( :bold, :red, :on_white ) {"[%1$s.%2$06d %3$d/%4$s] %5$5s -- %7$s\n"},
+		}
+
+
+		### Initialize the formatter with a reference to the logger so it can check for log level.
+		def initialize( logger, settings={} ) # :notnew:
+			settings = LEVEL_FORMATS.merge( settings )
+
+			@logger   = logger
+			@settings = settings
+
+			super()
+		end
+
+		######
+		public
+		######
+
+		# The Logger object associated with the formatter
+		attr_accessor :logger
+
+		# The formats, by level
+		attr_accessor :settings
+
+
+		### Log using the format associated with the severity
+		def call( severity, time, progname, msg )
+			args = [
+				time.strftime( '%Y-%m-%d %H:%M:%S' ),                         # %1$s
+				time.usec,                                                    # %2$d
+				Process.pid,                                                  # %3$d
+				Thread.current == Thread.main ? 'main' : Thread.object_id,    # %4$s
+				severity,                                                     # %5$s
+				progname,                                                     # %6$s
+				msg                                                           # %7$s
+			]
+
+			return self.settings[ severity.downcase.to_sym ] % args
+		end
+	end # class LogFormatter
+
+
+	
+
 	# 
 	# An alternate formatter for Logger instances that outputs +div+ HTML
 	# fragments.

data/lib/treequel.rb

@@ -32,10 +32,10 @@ end
 module Treequel
 
 	# Library version
-	VERSION = '1.0.0'
+	VERSION = '1.0.1'
 
 	# VCS revision
-	REVISION = %q$rev: e352bc86498a $
+	REVISION = %q$rev: ca660bd12f7f $
 
 	# Load the logformatters and some other stuff first
 	require 'treequel/constants'

data/rake/manual.rb

@@ -69,7 +69,7 @@ module Manual
 		DEFAULT_CONFIG = {
 			'filters' => [ 'erb', 'links', 'textile' ],
 			'layout'  => 'default.page',
-			'cleanup' => true,
+			'cleanup' => false,
 		  }.freeze
 
 		# Pattern to match a source page with a YAML header

data/rake/packaging.rb

@@ -133,3 +133,12 @@ end
 
 
 
+desc "Add development depdendencies to the gemspec -- this is meant to be chained " +
+     "together with :gem"
+task :include_dev_dependencies do
+	DEVELOPMENT_DEPENDENCIES.each do |name, version|
+		version = '>= 0' if version.length.zero?
+		GEMSPEC.add_development_dependency( name, version )
+	end
+end
+

data/rake/publishing.rb

@@ -34,7 +34,7 @@ class Net::SMTP
 
 	def do_ssl_start( helodomain, user, secret, authtype )
 		raise IOError, 'SMTP session already started' if @started
-		check_auth_args user, secret, authtype if user or secret
+		check_auth_args user, secret if user or secret
 
 		# Open the connection
       	@debug_output << "opening connection to #{@address}...\n" if @debug_output
@@ -238,7 +238,7 @@ begin
 
 		desc 'Publish the new release to RubyForge'
 		task :publish => [:clean, :package, :notes] do |task|
-			project = GEMSPEC.rubyforge_project
+			project = RUBYFORGE_PROJECT
 
 			if $publish_privately
 				log "Skipping push of release files to RubyForge"

data/spec/treequel/branchset_spec.rb

@@ -346,6 +346,17 @@ describe Treequel::Branchset do
 			@branchset.all.should == [:matching_branches]
 		end
 
+		# 
+		# #as
+		# 
+		it "can create a new branchset cloned from itself that will return instances of a different branch class" do
+			subclass = Class.new( Treequel::Branch )
+			@branch.stub!( :directory ).and_return( :the_directory )
+			@branch.stub!( :dn ).and_return( TEST_HOSTS_DN )
+			newset = @branchset.as( subclass )
+			newset.branch.should be_an_instance_of( subclass )
+		end
+
 	end
 
 	describe "instance with no filter, and scope set to 'onelevel'" do

data/spec/treequel/filter_spec.rb

@@ -71,6 +71,10 @@ describe Treequel::Filter do
 		Treequel::Filter.new( :uid, 'bigthung' ).to_s.should == '(uid=bigthung)'
 	end
 
+	it "parses a String+value hash as a simple item equal filter" do
+		Treequel::Filter.new( 'uid' => 'bigthung' ).to_s.should == '(uid=bigthung)'
+	end
+
 	it "parses a single-item Symbol+value hash as a simple item equal filter" do
 		Treequel::Filter.new({ :uidNumber => 3036 }).to_s.should == '(uidNumber=3036)'
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: treequel
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Michael Granger, Mahlon E. Smith
@@ -9,9 +9,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-13 00:00:00 -07:00
+date: 2009-11-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: columnize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: termios
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-terminfo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: ruby-ldap
   type: :runtime
@@ -27,9 +57,10 @@ description: |-
   the impedence mismatch of trying to treat LDAP as if it's a relational database, and
   instead embrace its hierarchical, free-form nature.
 email: 
-- ged@FaerieMUD.org
 - mahlon@martini.nu
+- ged@FaerieMUD.org
 executables: 
+- treequel.orig
 - treeirb
 - treequel
 extensions: []
@@ -43,74 +74,76 @@ files:
 - ChangeLog
 - README
 - LICENSE
-- spec/treequel/branch_spec.rb
-- spec/treequel/branchcollection_spec.rb
-- spec/treequel/branchset_spec.rb
-- spec/treequel/directory_spec.rb
-- spec/treequel/filter_spec.rb
-- spec/treequel/mixins_spec.rb
+- spec/treequel_spec.rb
 - spec/treequel/schema/attributetype_spec.rb
 - spec/treequel/schema/ldapsyntax_spec.rb
-- spec/treequel/schema/matchingrule_spec.rb
 - spec/treequel/schema/matchingruleuse_spec.rb
+- spec/treequel/schema/matchingrule_spec.rb
 - spec/treequel/schema/objectclass_spec.rb
 - spec/treequel/schema_spec.rb
+- spec/treequel/filter_spec.rb
 - spec/treequel/utils_spec.rb
-- spec/treequel_spec.rb
+- spec/treequel/branch_spec.rb
+- spec/treequel/directory_spec.rb
+- spec/treequel/branchset_spec.rb
+- spec/treequel/mixins_spec.rb
+- spec/treequel/branchcollection_spec.rb
 - spec/lib/constants.rb
 - spec/lib/helpers.rb
+- bin/treequel.orig
 - bin/treeirb
 - bin/treequel
-- lib/treequel/branch.rb
-- lib/treequel/branchcollection.rb
-- lib/treequel/branchset.rb
-- lib/treequel/constants.rb
-- lib/treequel/directory.rb
-- lib/treequel/exceptions.rb
-- lib/treequel/filter.rb
-- lib/treequel/mixins.rb
+- lib/treequel.rb
+- lib/treequel/schema/matchingrule.rb
 - lib/treequel/schema/attributetype.rb
 - lib/treequel/schema/ldapsyntax.rb
-- lib/treequel/schema/matchingrule.rb
 - lib/treequel/schema/matchingruleuse.rb
 - lib/treequel/schema/objectclass.rb
+- lib/treequel/directory.rb
+- lib/treequel/exceptions.rb
+- lib/treequel/branchcollection.rb
+- lib/treequel/mixins.rb
+- lib/treequel/utils.rb
 - lib/treequel/schema.rb
+- lib/treequel/constants.rb
+- lib/treequel/branchset.rb
+- lib/treequel/filter.rb
+- lib/treequel/branch.rb
 - lib/treequel/sequel_integration.rb
-- lib/treequel/utils.rb
-- lib/treequel.rb
-- rake/191_compat.rb
-- rake/dependencies.rb
-- rake/helpers.rb
+- rake/style.rb
+- rake/rdoc.rb
 - rake/hg.rb
-- rake/manual.rb
+- rake/svn.rb
 - rake/packaging.rb
 - rake/publishing.rb
-- rake/rdoc.rb
-- rake/style.rb
-- rake/svn.rb
-- rake/testing.rb
-- rake/verifytask.rb
+- rake/191_compat.rb
+- rake/dependencies.rb
 - rake/win32.rb
+- rake/manual.rb
+- rake/verifytask.rb
+- rake/helpers.rb
+- rake/testing.rb
+- ./examples/ldap_state.rb
 - ./examples/company-directory.rb
 - ./examples/ldap-monitor.rb
-- ./examples/ldap_state.rb
+- ./examples/ldap-rack-auth.rb
 - ./examples/ldap-monitor/views/backends.erb
 - ./examples/ldap-monitor/views/connections.erb
+- ./examples/ldap-monitor/views/listeners.erb
 - ./examples/ldap-monitor/views/databases.erb
-- ./examples/ldap-monitor/views/dump_subsystem.erb
 - ./examples/ldap-monitor/views/index.erb
+- ./examples/ldap-monitor/views/dump_subsystem.erb
 - ./examples/ldap-monitor/views/layout.erb
-- ./examples/ldap-monitor/views/listeners.erb
 - ./examples/ldap-monitor/public/css/master.css
-- ./examples/ldap-monitor/public/images/card_small.png
-- ./examples/ldap-monitor/public/images/chain_small.png
-- ./examples/ldap-monitor/public/images/globe_small.png
-- ./examples/ldap-monitor/public/images/globe_small_green.png
 - ./examples/ldap-monitor/public/images/plug.png
 - ./examples/ldap-monitor/public/images/shadows/large-30-down.png
-- ./examples/ldap-monitor/public/images/tick.png
+- ./examples/ldap-monitor/public/images/globe_small.png
+- ./examples/ldap-monitor/public/images/chain_small.png
 - ./examples/ldap-monitor/public/images/tick_circle.png
+- ./examples/ldap-monitor/public/images/globe_small_green.png
+- ./examples/ldap-monitor/public/images/card_small.png
 - ./examples/ldap-monitor/public/images/treequel-favicon.png
+- ./examples/ldap-monitor/public/images/tick.png
 - Rakefile.local
 has_rdoc: true
 homepage: http://deveiate.org/projects/Treequel
@@ -145,25 +178,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: 
 - ldap >=0
-rubyforge_project: treequel
+rubyforge_project: deveiate
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: An honest LDAP library
 test_files: 
-- spec/treequel/branch_spec.rb
-- spec/treequel/branchcollection_spec.rb
-- spec/treequel/branchset_spec.rb
-- spec/treequel/directory_spec.rb
-- spec/treequel/filter_spec.rb
-- spec/treequel/mixins_spec.rb
+- spec/treequel_spec.rb
 - spec/treequel/schema/attributetype_spec.rb
 - spec/treequel/schema/ldapsyntax_spec.rb
-- spec/treequel/schema/matchingrule_spec.rb
 - spec/treequel/schema/matchingruleuse_spec.rb
+- spec/treequel/schema/matchingrule_spec.rb
 - spec/treequel/schema/objectclass_spec.rb
 - spec/treequel/schema_spec.rb
+- spec/treequel/filter_spec.rb
 - spec/treequel/utils_spec.rb
-- spec/treequel_spec.rb
+- spec/treequel/branch_spec.rb
+- spec/treequel/directory_spec.rb
+- spec/treequel/branchset_spec.rb
+- spec/treequel/mixins_spec.rb
+- spec/treequel/branchcollection_spec.rb
 - spec/lib/constants.rb
 - spec/lib/helpers.rb