active_directory 1.4.0 → 1.5.0

data/README.md

@@ -4,6 +4,9 @@ Ruby Integration with Microsoft's Active Directory system based on original code
 
 See documentation on ActiveDirectory::Base for more information.
 
+Caching:
+Queries for membership and group membership are based on the distinguished name of objects.  Doing a lot of queries, especially for a Rails app, is a sizable slowdown.  To alleviate the problem, I've implemented a very basic cache for queries which search by :distinguishedname.  This is diabled by default.  All other queries are unaffected.
+
 
 A code example is worth a thousand words:
 
@@ -31,4 +34,10 @@ ActiveDirectory::User.find(:all)
 ActiveDirectory::User.find(:first, :userprincipalname => "john.smith@domain.com")
 
 ActiveDirectory::Group.find(:all)
+
+#Caching is disabled by default, to enable:
+ActiveDirectory::Base.enable_cache
+ActiveDirectory::Base.disable_cache
+ActiveDirectory::Base.cache?
+
 </pre>

data/Rakefile

@@ -1,3 +1,4 @@
+require 'psych'
 
 begin
   require 'jeweler'
@@ -16,4 +17,4 @@ begin
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+end

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.0

data/active_directory.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{active_directory}
-  s.version = "1.4.0"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam T Kerr"]
-  s.date = %q{2011-03-02}
+  s.date = %q{2011-03-03}
   s.description = %q{ActiveDirectory uses Net::LDAP to provide a means of accessing and modifying an Active Directory data store.  This is a fork of the activedirectory gem.}
   s.email = %q{ajrkerr@gmail.com}
   s.extra_rdoc_files = [
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = %q{http://github.com/ajrkerr/active_directory}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
+  s.rubygems_version = %q{1.6.0}
   s.summary = %q{An interface library for accessing Microsoft's Active Directory.}
 
   if s.respond_to? :specification_version then

data/lib/active_directory/base.rb

@@ -239,7 +239,7 @@ module ActiveDirectory
 			}
 
 			cached_results = find_cached_results(args[1])
-			return cached_results unless cached_results.nil?
+			return cached_results if cached_results or cached_results.nil?
 
 			options[:in] = [ options[:in].to_s, @@settings[:base] ].delete_if { |part| part.empty? }.join(",")
 
@@ -258,55 +258,56 @@ module ActiveDirectory
 			end
 		end
 
-		##
-		# Filters the cache result by the object type we're looking for
-		#
-		def self.filter_cache_result(result)
-			result.delete_if { |entry| !entry.kind_of? self }
-		end
-
 		##
 		# Searches the cache and returns the result
+		# Returns false on failure, nil on wrong object type
 		#
 		def self.find_cached_results(filters)
-			return nil unless cache?
+			return false unless cache?
 
 			#Check to see if we're only looking for :distinguishedname
-			if filters.is_a? Hash and filters.keys == [:distinguishedname]
-				#Find keys we're looking up, convert to array
-				dns = filters[:distinguishedname]
+			return false unless filters.is_a? Hash and filters.keys == [:distinguishedname]
 
-				if dns.kind_of? Array
-					#Check to see if all of the results are in teh cache
-					return nil unless (dns & @@cache.keys == dns)
+			#Find keys we're looking up
+			dns = filters[:distinguishedname]
 
-					result = []
+			if dns.kind_of? Array
+				result = []
 
-					dns.each { |dn| result << @@cache[dn] }
+				dns.each do |dn| 
+					entry = @@cache[dn]
 
-					return filter_cache_result(result) if result.size == dns.size
-				else
-					return @@cache[dns] if @@cache.key? dns and @@cache[dns].is_a? self.class
+					#If the object isn't in the cache just run the query
+					return false if entry.nil?
+
+					#Only permit objects of the type we're looking for
+					result << entry if entry.kind_of? self
 				end
+
+				return result
+			else
+				return false unless @@cache.key? dns
+				return @@cache[dns] if @@cache[dns].is_a? self
 			end
 		end
 
 		def self.find_all(options)
 			results = []
-			@@ldap.search(:filter => options[:filter], :base => options[:in], :return_result => false) do |entry|
-				ad_entry = new(entry)
-				@@cache[ad_entry.dn] = ad_entry
-				results << ad_entry
+			ldap_objs = @@ldap.search(:filter => options[:filter], :base => options[:in])
+
+			ldap_objs.each do |entry|
+				ad_obj = new(entry)
+				@@cache[entry.dn] = ad_obj unless ad_obj.instance_of? Base 
+				results << ad_obj
 			end
+
 			results
 		end
 
 		def self.find_first(options)
-			@@ldap.search(:filter => options[:filter], :base => options[:in], :return_result => false) do |entry|
-				ad_entry = new(entry)
-				@@cache[ad_entry.dn] = ad_entry
-				return ad_entry
-			end
+			ad_obj = new(@@ldap.search(:filter => options[:filter], :base => options[:in]))
+			@@cache[ad_obj.dn] = ad_obj unless ad_obj.instance_of? Base
+			return ad_obj
 		end
 
 		def self.method_missing(name, *args) # :nodoc:
@@ -336,7 +337,7 @@ module ActiveDirectory
 
 		def ==(other) # :nodoc:
 			return false if other.nil?
-			other.objectGUID == objectGUID
+			other[:objectguid] == get_attr(:objectguid)
 		end
 
 		#
@@ -386,7 +387,7 @@ module ActiveDirectory
 					values = values.collect { |v| v.to_s }
 
 					current_value = begin
-						@entry.send(attribute)
+						@entry[attribute]
 					rescue NoMethodError
 						nil
 					end
@@ -494,29 +495,73 @@ module ActiveDirectory
 			end
 		end
 
+		##
+		# Pull the class we're in
+		# This isn't quite right, as extending the object does funny things to how we
+		# lookup objects
+		def self.class_name
+			@klass ||= (self.name.include?('::') ? self.name[/.*::(.*)/, 1] : self.name)
+		end
+
 		## 
 		# Grabs the field type depending on the class it is called from 
 		# Takes the field name as a parameter
 		def self.get_field_type(name)
 			#Extract class name
 			throw "Invalid field name" if name.nil?
-			klass = self.name.include?('::') ? self.name[/.*::(.*)/, 1] : self.name
-			type = ::ActiveDirectory.special_fields[klass.to_sym][name.to_s.downcase.to_sym]
+			type = ::ActiveDirectory.special_fields[class_name.to_sym][name.to_s.downcase.to_sym]
 			type.to_s unless type.nil?
 		end
 
+		@types = {}
+
 		def self.decode_field(name, value) # :nodoc:
 			type = get_field_type name
-			return ::ActiveDirectory::FieldType::const_get(type).decode(value) if !type.nil? and ::ActiveDirectory::FieldType::const_defined? type
+			if !type.nil? and ::ActiveDirectory::FieldType::const_defined? type
+				return ::ActiveDirectory::FieldType::const_get(type).decode(value)
+			end
 			return value
 		end
 
 		def self.encode_field(name, value) # :nodoc:
 			type = get_field_type name
-			return ::ActiveDirectory::FieldType::const_get(type).encode(value) if !type.nil? and ::ActiveDirectory::FieldType::const_defined? type
+			if !type.nil? and ::ActiveDirectory::FieldType::const_defined? type
+				return ::ActiveDirectory::FieldType::const_get(type).encode(value)
+			end
 			return value
 		end
 
+	  ##
+	  # Reads the array of values for the provided attribute. The attribute name
+	  # is canonicalized prior to reading. Returns an empty array if the
+	  # attribute does not exist.
+	  def [](name)
+	  	get_attr(name)
+	  end
+
+	  ##
+	  # Ensure that flattening works correctly
+	  def to_ary
+	  end
+
+	  def valid_attribute? name
+	  	@attributes.has_key?(name) || @entry.attribute_names.include?(name)
+	  end
+
+		def get_attr(name)
+			name = name.to_s.downcase
+
+			return decode_field(name, @attributes[name.to_sym]) if @attributes.has_key?(name.to_sym)
+				
+			if @entry.attribute_names.include? name.to_sym
+				value = @entry[name.to_sym]
+				value = value.first if value.kind_of?(Array) && value.size == 1
+				value = value.to_s if value.nil? || value.size == 1
+				value = nil.to_s if value.empty?
+				return self.class.decode_field(name, value)
+			end
+		end
+
 		def method_missing(name, args = []) # :nodoc:
 			name = name.to_s.downcase
 
@@ -525,20 +570,11 @@ module ActiveDirectory
 				@attributes[name.to_sym] = encode_field(name, args)
 			end
 
-			return decode_field(name, @attributes[name.to_sym]) if @attributes.has_key?(name.to_sym)
-				
-			if @entry
-				begin
-					value = @entry.send(name.to_sym)
-					value = value.first if value.kind_of?(Array) && value.size == 1
-					value = value.to_s if value.nil? || value.size == 1
-					return self.class.decode_field(name, value)
-				rescue NoMethodError => e
-					return nil
-				end
+			if valid_attribute? name.to_sym
+				get_attr(name)
+			else
+				super
 			end
-
-			super
 		end
 
 	end

data/lib/active_directory/field_type/binary.rb

@@ -32,7 +32,7 @@ module ActiveDirectory
       # Decodes a binary GUID as a hex string
       #
       def self.decode(guid)
-        guid.unpack("H*").to_s
+        guid.unpack("H*").first.to_s
       end
     end
   end

data/lib/active_directory/field_type/dn_array.rb

@@ -33,7 +33,7 @@ module ActiveDirectory
 			#
 			def self.decode(dn_array)
 				# How to do user or group?
-				Base.find( :all, :distinguishedname => dn_array)
+				Base.find(:all, :distinguishedname => dn_array)
 			end
 		end
 	end

data/lib/active_directory/field_type/group_dn_array.rb

@@ -33,7 +33,7 @@ module ActiveDirectory
 			#
 			def self.decode(dn_array)
 				# How to do user or group?
-				Group.find( :all, :distinguishedname => dn_array)
+				Group.find(:all, :distinguishedname => dn_array)
 			end
 		end
 	end

data/lib/active_directory/field_type/member_dn_array.rb

@@ -33,10 +33,14 @@ module ActiveDirectory
 			#
 			def self.decode(dn_array)
 				# Ensures that the objects are cast correctly
-				users = [User.find( :all, :distinguishedname => dn_array)].flatten
-				groups = [Group.find(:all, :distinguishedname => dn_array)].flatten
+				users = User.find(:all, :distinguishedname => dn_array)
+				groups = Group.find(:all, :distinguishedname => dn_array)
 
-				users + groups
+				arr = Array.new
+				arr << users unless users.nil?
+				arr << groups unless groups.nil?
+
+				return arr.flatten
 			end
 		end
 	end

data/lib/active_directory/field_type/user_dn_array.rb

@@ -33,7 +33,7 @@ module ActiveDirectory
 			#
 			def self.decode(dn_array)
 				# How to do user or group?
-				User.find( :all, :distinguishedname => dn_array)
+				User.find(:all, :distinguishedname => dn_array)
 			end
 		end
 	end

metadata

@@ -1,48 +1,36 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: active_directory
-version: !ruby/object:Gem::Version 
-  hash: 7
+version: !ruby/object:Gem::Version
+  version: 1.5.0
   prerelease: 
-  segments: 
-  - 1
-  - 4
-  - 0
-  version: 1.4.0
 platform: ruby
-authors: 
+authors:
 - Adam T Kerr
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-02 00:00:00 -05:00
+date: 2011-03-03 00:00:00.000000000 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-ldap
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152460440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 1
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.1.1
   type: :runtime
-  version_requirements: *id001
-description: ActiveDirectory uses Net::LDAP to provide a means of accessing and modifying an Active Directory data store.  This is a fork of the activedirectory gem.
+  prerelease: false
+  version_requirements: *2152460440
+description: ActiveDirectory uses Net::LDAP to provide a means of accessing and modifying
+  an Active Directory data store.  This is a fork of the activedirectory gem.
 email: ajrkerr@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - README.md
 - Rakefile
 - VERSION
@@ -65,36 +53,26 @@ files:
 has_rdoc: true
 homepage: http://github.com/ajrkerr/active_directory
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: An interface library for accessing Microsoft's Active Directory.
 test_files: []
-