ruby-activeldap 0.8.3 → 0.8.3.1

data/LICENSE

@@ -0,0 +1,58 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README

@@ -0,0 +1,104 @@
+Ruby/ActiveLdap -- ruby library for object-oriented LDAP interction
+Copyright (C) 2004-2006 Will Drewry <will@alum.bu.edu>, Kouhei Sutou <kou@cozmixng.org>
+Contributors:
+ * Dick Davies <rasputnik@hellooperator.net>
+ * Nathan Kinder <quicksilver02@mac.com>
+ * Patrick Cole <pac@independent.com.au>
+ * Google Inc.
+
+DESCRIPTION
+'Ruby/ActiveLdap' is a ruby extension library which provides a clean objected
+oriented interface to the Ruby/LDAP[0] library.  It was inspired by
+ActivRecord[2]. This is not nearly as clean or as flexible as ActiveRecord, but
+it is still trivial to define new objects and manipulate them with minimal
+difficulty.
+
+For example and usage - read the rdoc in doc/ from lib/activeldap.rb.
+It is also available on the web at:
+
+http://ruby-activeldap.rubyforge.org/
+
+PREREQUISITES
+
+  * Ruby 1.8.x [1]
+  * Ruby/LDAP [0]
+  * Log4r [4]
+  * ActiveRecord [2]
+  * (Optional) Ruby/LDAP+GSSAPI [3]
+  * An LDAP server compatible with Ruby/LDAP: OpenLDAP, etc
+
+
+NOTES
+
+  * Only GSSAPI SASL support exists due to Ruby/LDAP limitations
+  * The API is subject to change as this package slowly approaches 1.0.0
+
+
+INSTALL
+
+  - Edit active_ldap/configuration.rb with your LDAP preferences
+  - Run -
+    sudo rake install
+
+RAILS
+
+There is a small rails plugin included that allows the use of a file named
+'ldap.yml' in the config directory of your rails app. This file has a similar
+function to the 'database.yml' file that allows you to set your database
+connection settings per environment. Similarly, the ldap.yml file allows
+settings to be set for development, test, and production environments. For
+instance, the development entry would look something like the following:
+
+          development:
+            host: 127.0.0.1
+            port: 389
+            base: dc=localhost
+            bind_dn: cn=admin,dc=localhost
+            password: secret
+
+
+To install, simply copy the rails/plugin/active_ldap folder into the
+vendor/plugins directory of your rails application and create config/ldap.yml.
+When your application starts up, the plugin will call #establish_connection
+using the parameters specified for your current environment.
+
+
+LICENCE
+
+This program is free software; you can redistribute it and/or modify it.  It is
+dual licensed under Ruby's license and under the terms of the GNU General
+Public License as published by the Free Software Foundation; either version 2,
+or (at your option) any later version.
+
+Please see the file LICENSE for the terms of the licence.
+
+
+REFERENCES
+
+[0] - http://ruby-ldap.sourceforge.net
+[1] - http://www.ruby-lang.org
+[2] - http://activerecord.rubyonrails.org
+[3] - http://caliban.org/files/redhat/RPMS/i386/ruby-ldap-0.8.2-4.i386.rpm
+[4] - http://log4r.sourceforge.net/
+
+
+THANKS
+
+This list may not be correct. If you notice mistakes of this
+list, please point out.
+
+* Nobody: Bug reports.
+* James Hughes: Bug reports and advices and documentations.
+* Buzz Chopra: Documentations.
+* Christoph Lipp: Bug reports.
+* Jeff Hall: Bug reports.
+* Ernie Miller: Bug reports and advices.
+* Daniel Pfile: Patches.
+* Jacob Wilkins: Bug reports.
+* Ace Suares:
+  * Bug reports.
+  * Nederlands translations.
+* Iain Pople: Bug reports and API improvement ideas.
+* Christoph Lipp: Tell us character escape syntax.
+* Kevin McCarthy: Patches.
+* Perry Smith: Patches and bug reports.

data/Rakefile

@@ -0,0 +1,165 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'find'
+
+base_dir = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(base_dir, 'lib'))
+require 'active_ldap'
+
+truncate_base_dir = Proc.new do |x|
+  x.gsub(/^#{Regexp.escape(base_dir + File::SEPARATOR)}/, '')
+end
+
+manifest = File.join(base_dir, "Manifest.txt")
+manifest_contents = []
+base_dir_included_components = %w(CHANGES COPYING LICENSE Manifest.txt
+                                  README Rakefile TODO)
+excluded_components = %w(.svn .test-result .config doc log tmp
+                         pkg html config.yaml database.yml ldap.yml)
+excluded_suffixes = %w(.help .sqlite3)
+white_list_paths =
+  [
+   "rails/plugin/active_ldap/generators/scaffold_al/templates/ldap.yml"
+  ]
+Find.find(base_dir + "/") do |target|
+  target = truncate_base_dir[target]
+  components = target.split(File::SEPARATOR)
+  if components.size == 1 and !File.directory?(target)
+    next unless base_dir_included_components.include?(components[0])
+  end
+  unless white_list_paths.include?(target)
+    Find.prune if (excluded_components - components) != excluded_components
+    next if excluded_suffixes.include?(File.extname(target))
+  end
+  manifest_contents << target if File.file?(target)
+end
+
+File.open(manifest, "w") do |f|
+  f.puts manifest_contents.sort.join("\n")
+end
+at_exit do
+  FileUtils.rm_f(manifest)
+end
+
+
+project = Hoe.new('ruby-activeldap', ActiveLdap::VERSION) do |project|
+  project.rubyforge_name = 'ruby-activeldap'
+  project.author = ['Will Drewry', 'Kouhei Sutou']
+  project.email = ['will@alum.bu.edu', 'kou@cozmixng.org']
+  project.summary = 'Ruby/ActiveLdap is a object-oriented API to LDAP'
+  project.url = 'http://rubyforge.org/projects/ruby-activeldap/'
+  project.test_globs = ['test/test_*.rb']
+  project.changes = project.paragraphs_of('CHANGES', 0..1).join("\n\n")
+  project.extra_deps = [['log4r', '>= 1.0.4'], 'activerecord']
+  project.spec_extras = {
+    :requirements => ['ruby-ldap >= 0.8.2', '(Open)LDAP server'],
+    :autorequire => 'active_ldap',
+    :executables => [],
+  }
+  project.description = String.new(<<-EOF)
+    'Ruby/ActiveLdap' is a ruby extension library which provides a clean
+    objected oriented interface to the Ruby/LDAP library.  It was inspired
+    by ActiveRecord. This is not nearly as clean or as flexible as
+    ActiveRecord, but it is still trivial to define new objects and manipulate
+    them with minimal difficulty.
+  EOF
+end
+
+publish_docs_actions = task(:publish_docs).instance_variable_get("@actions")
+original_project_name = nil
+before_publish_docs = Proc.new do
+  original_project_name = project.name
+  project.name = "doc"
+end
+after_publish_docs = Proc.new do
+  project.name = original_project_name
+end
+publish_docs_actions.unshift(before_publish_docs)
+publish_docs_actions.push(after_publish_docs)
+
+# fix Hoe's incorrect guess.
+project.spec.executables.clear
+project.bin_files = project.spec.files.grep(/^bin/)
+
+# fix Hoe's install and uninstall task.
+task(:install).instance_variable_get("@actions").clear
+task(:uninstall).instance_variable_get("@actions").clear
+
+task :install do
+  [
+   [project.lib_files, "lib", Hoe::RUBYLIB, 0444],
+   [project.bin_files, "bin", File.join(Hoe::PREFIX, 'bin'), 0555]
+  ].each do |files, prefix, dest, mode|
+    FileUtils.mkdir_p dest unless test ?d, dest
+    files.each do |file|
+      base = File.dirname(file.sub(/^#{prefix}#{File::SEPARATOR}/, ''))
+      _dest = File.join(dest, base)
+      FileUtils.mkdir_p _dest unless test ?d, _dest
+      install file, _dest, :mode => mode
+    end
+  end
+end
+
+desc 'Uninstall the package.'
+task :uninstall do
+  Dir.chdir Hoe::RUBYLIB do
+    rm_f project.lib_files.collect {|f| f.sub(/^lib#{File::SEPARATOR}/, '')}
+  end
+  Dir.chdir File.join(Hoe::PREFIX, 'bin') do
+    rm_f project.bin_files.collect {|f| f.sub(/^bin#{File::SEPARATOR}/, '')}
+  end
+end
+
+desc 'Tag the repository for release.'
+task :tag do
+  system "svn copy -m 'New release tag' https://ruby-activeldap.googlecode.com/svn/trunk https://ruby-activeldap.googlecode.com/svn/tags/r#{ActiveLdap::VERSION}"
+end
+
+
+desc "Update *.po/*.pot files and create *.mo from *.po files"
+task :gettext => ["gettext:po:update", "gettext:mo:create"]
+
+namespace :gettext do
+  desc "Setup environment for GetText"
+  task :environment do
+    require "gettext/utils"
+  end
+
+  namespace :po do
+    desc "Update po/pot files (GetText)"
+    task :update => "gettext:environment" do
+      require 'active_ldap/get_text/parser'
+      dummy_file = "@@@dummy-for-active-ldap@@@"
+      parser = Object.new
+      parser.instance_eval do
+        @parser = ActiveLdap::GetText::Parser.new
+        @dummy_file = dummy_file
+      end
+      def parser.target?(file)
+        file == @dummy_file
+      end
+      def parser.parse(file, targets)
+        @parser.extract_all_in_schema(targets)
+      end
+
+      GetText::RGetText.add_parser(parser)
+      files = [dummy_file] + Dir.glob("{lib,rails,benchmark}/**/*.rb")
+      GetText.update_pofiles("active-ldap",
+                             files,
+                             "Ruby/ActiveLdap #{ActiveLdap::VERSION}")
+    end
+  end
+
+  namespace :mo do
+    desc "Create *.mo from *.po (GetText)"
+    task :create => "gettext:environment" do
+      GetText.create_mofiles(false)
+    end
+  end
+end
+
+task(:gem).prerequisites.unshift("gettext:mo:create")
+
+# vim: syntax=ruby

data/TODO

@@ -0,0 +1,22 @@
+- Test SASL bind.
+- Add result pagination via LDAP::Controls
+- serialize & serialized_attributes
+- schema mgmt - how does AR handle it?
+- columns() -- ?
+http://api.rubyonrails.com/classes/ActiveRecord/Base.html#M000865
+- provide full documentation for new API.
+- handle all exception raised from Ruby/LDAP and wrap as
+  ActiveLdap exception. I think we need to develop an
+  application using ActiveLdap.
+- Add locking around Timeout.alarm() to ensure a multithreaded ruby
+  app doesn't hit any race conditions
+- Add AR matching exceptions:
+* ActiveRecordError -- ActiveLdapError as base
+* AssociationTypeMismatch
+* SerializationTypeMismatch
+* ConnectionNotEstablished
+* RecordNotFound
+* LdapActionInvalid - like StatementInvalid
+* MultiparameterAssignmentErrors
+* AttributeAssignmentError
+* RecordNotSaved

data/benchmark/bench-al.rb

@@ -0,0 +1,202 @@
+base = File.dirname(__FILE__)
+$LOAD_PATH.unshift(File.expand_path(base))
+$LOAD_PATH.unshift(File.expand_path(File.join(base, "..", "lib")))
+
+require "active_ldap"
+require "benchmark"
+
+include ActiveLdap::GetTextSupport
+
+argv, opts, options = ActiveLdap::Command.parse_options do |opts, options|
+  options.prefix = "ou=People"
+
+  opts.on("--prefix=PREFIX",
+          _("Specify prefix for benchmarking"),
+          _("(default: %s)") % options.prefix) do |prefix|
+    options.prefix = prefix
+  end
+end
+
+ActiveLdap::Base.establish_connection
+config = ActiveLdap::Base.configuration
+
+LDAP_HOST = config[:host]
+LDAP_PORT = config[:port]
+LDAP_BASE = config[:base]
+LDAP_PREFIX = options.prefix
+LDAP_USER = config[:bind_dn]
+LDAP_PASSWORD = config[:password]
+
+class ALUser < ActiveLdap::Base
+  ldap_mapping :dn_attribute => 'uid', :prefix => LDAP_PREFIX,
+               :classes => ['posixAccount', 'person']
+end
+
+# === search_al
+#
+def search_al
+  count = 0
+  ALUser.find(:all).each do |e|
+    count += 1
+  end
+  count
+end # -- search_al
+
+def search_al_without_object_creation
+  count = 0
+  ALUser.search.each do |e|
+    count += 1
+  end
+  count
+end
+
+# === search_ldap
+#
+def search_ldap(conn)
+  count = 0
+  conn.search("#{LDAP_PREFIX},#{LDAP_BASE}",
+              LDAP::LDAP_SCOPE_SUBTREE,
+              "(uid=*)") do |e|
+    count += 1
+  end
+  count
+end # -- search_ldap
+
+def search_net_ldap(conn)
+  count = 0
+  conn.search(:base => "#{LDAP_PREFIX},#{LDAP_BASE}",
+              :scope => Net::LDAP::SearchScope_WholeSubtree,
+              :filter => "(uid=*)") do |e|
+    count += 1
+  end
+  count
+end
+
+def ldap_connection
+  require 'ldap'
+  conn = LDAP::Conn.new(LDAP_HOST, LDAP_PORT)
+  conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+  conn.bind(LDAP_USER, LDAP_PASSWORD) if LDAP_USER and LDAP_PASSWORD
+  conn
+rescue LoadError
+  nil
+end
+
+def net_ldap_connection
+  require 'net/ldap'
+  net_ldap_conn = Net::LDAP::Connection.new(:host => LDAP_HOST,
+                                            :port => LDAP_PORT)
+  if LDAP_USER and LDAP_PASSWORD
+    net_ldap_conn.bind(:method => :simple,
+                       :username => LDAP_USER,
+                       :password => LDAP_PASSWORD)
+  end
+  net_ldap_conn
+rescue LoadError
+  nil
+end
+
+def populate_base
+  suffixes = []
+  ActiveLdap::Base.base.split(/,/).reverse_each do |suffix|
+    prefix = suffixes.join(",")
+    suffixes.unshift(suffix)
+    name, value = suffix.split(/=/, 2)
+    next unless name == "dc"
+    dc_class = Class.new(ActiveLdap::Base)
+    dc_class.ldap_mapping :dn_attribute => "dc",
+                          :prefix => "",
+                          :scope => :base,
+                          :classes => ["top", "dcObject", "organization"]
+    dc_class.instance_variable_set("@base", prefix)
+    next if dc_class.exists?(value, :prefix => "dc=#{value}")
+    dc = dc_class.new(value)
+    dc.o = dc.dc
+    begin
+      dc.save
+    rescue ActiveLdap::OperationNotPermitted
+    end
+  end
+
+  if ActiveLdap::Base.search.empty?
+    raise "Can't populate #{ActiveLdap::Base.base}"
+  end
+end
+
+def populate_users
+  ou_class = Class.new(ActiveLdap::Base)
+  ou_class.ldap_mapping :dn_attribute => "ou",
+                        :prefix => "",
+                        :classes => ["top", "organizationalUnit"]
+  ou_class.new(LDAP_PREFIX.split(/=/)[1]).save!
+
+  100.times do |i|
+    name = i.to_s
+    user = ALUser.new(name)
+    user.uid_number = 100000 + i
+    user.gid_number = 100000 + i
+    user.cn = name
+    user.sn = name
+    user.home_directory = "/nonexistent"
+    user.save!
+  end
+end
+
+def populate
+  populate_base
+  populate_users
+end
+
+# === main
+#
+def main(do_populate)
+  if do_populate
+    puts(_("Populating..."))
+    dumped_data = ActiveLdap::Base.dump(:scope => :sub)
+    ActiveLdap::Base.delete_all(nil, :scope => :sub)
+    populate
+  end
+
+  # Standard connection
+  #
+  ldap_conn = ldap_connection
+  net_ldap_conn = net_ldap_connection
+
+  al_count = 0
+  al_count_without_object_creation = 0
+  ldap_count = 0
+  net_ldap_count = 0
+  Benchmark.bm(20) do |x|
+    [1].each do |n|
+      x.report("%3dx: AL" % n) {n.times {al_count = search_al}}
+      x.report("%3dx: AL(No Obj)" % n) do
+        n.times do
+          al_count_without_object_creation = search_al_without_object_creation
+        end
+      end
+      if ldap_conn
+        x.report("%3dx: LDAP" % n) do
+          n.times {ldap_count = search_ldap(ldap_conn)}
+        end
+      end
+      if net_ldap_conn
+        x.report("%3dx: Net::LDAP" % n) do
+          n.times {net_ldap_count = search_net_ldap(net_ldap_conn)}
+        end
+      end
+    end
+  end
+  puts(_("Entries processed by Ruby/ActiveLdap: %d") % al_count)
+  puts(_("Entries processed by Ruby/ActiveLdap (without object creation): " \
+         "%d") % al_count_without_object_creation)
+  puts(_("Entries processed by Ruby/LDAP: %d") % ldap_count)
+  puts(_("Entries processed by Net::LDAP: %d") % net_ldap_count)
+ensure
+  if do_populate
+    puts(_("Cleaning..."))
+    ActiveLdap::Base.delete_all(nil, :scope => :sub)
+    ActiveLdap::Base.load(dumped_data)
+  end
+end
+
+main(LDAP_USER && LDAP_PASSWORD)