ruby-activeldap 0.8.3 → 0.8.3.1

data/benchmark/config.yaml.sample

@@ -0,0 +1,5 @@
+host: 127.0.0.1
+base: dc=bench,dc=localcomain
+method: :tls
+bind_dn: cn=user-name,dc=localdomain
+password: secret

data/examples/al-admin/README

@@ -0,0 +1,182 @@
+== Welcome to Rails
+
+Rails is a web-application and persistence framework that includes everything
+needed to create database-backed web-applications according to the
+Model-View-Control pattern of separation. This pattern splits the view (also
+called the presentation) into "dumb" templates that are primarily responsible
+for inserting pre-built data in between HTML tags. The model contains the
+"smart" domain objects (such as Account, Product, Person, Post) that holds all
+the business logic and knows how to persist themselves to a database. The
+controller handles the incoming requests (such as Save New Account, Update
+Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting started
+
+1. At the command prompt, start a new rails application using the rails command
+   and your application name. Ex: rails myapp
+   (If you've downloaded rails in a complete tgz or zip, this step is already done)
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
+Rails will use the WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+Mongrel is a Ruby-based webserver with a C-component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
+
+== Debugging Rails
+
+Have "tail -f" commands running on the server.log and development.log. Rails will
+automatically display debugging and runtime information to these files. Debugging
+info will also be shown in the browser on requests from 127.0.0.1.
+
+
+== Breakpoints
+
+Breakpoint support is available through the script/breakpointer client. This
+means that you can break out of execution at any point in the code, investigate
+and change the model, AND then resume execution! Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      breakpoint "Breaking out from the list"
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the breakpointer window. Here you can do things like:
+
+Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint'
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a breakpoint"
+  => "hello from a breakpoint"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you press CTRL-D
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+
+
+== Description of contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.rhtml for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.rhtml. Inside default.rhtml,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+components
+  Self-contained mini-applications that can bundle together controllers, models, and views.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  This directory is in the load path.

data/examples/al-admin/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/examples/al-admin/app/controllers/account_controller.rb

@@ -0,0 +1,50 @@
+class AccountController < ApplicationController
+  def index
+    if logged_in?
+      redirect_to(top_path)
+    else
+      redirect_to(:action => 'login')
+    end
+  end
+
+  def login
+    return unless request.post?
+    self.current_user = User.authenticate(params[:login], params[:password])
+    if logged_in?
+      if params[:remember_me] == "1"
+        current_user.remember_me
+        cookies[:auth_token] = {
+          :value => current_user.remember_token,
+          :expires => current_user.remember_token_expires_at
+        }
+      end
+      redirect_back_or_default(top_url)
+      flash[:notice] = _("Logged in successfully")
+    else
+      flash[:notice] = _("Login or Password is incorrect")
+    end
+  end
+
+  def sign_up
+    @user = LdapUser.new(params[:user])
+    return unless request.post?
+    if @user.save
+      @system_user = User.create(:login => @user.id)
+      unless @system_user.new_record?
+        self.current_user = @system_user
+        redirect_back_or_default(top_path)
+        flash[:notice] = _("Thanks for signing up!")
+      end
+    else
+      @user.password = @user.password_confirmation = nil
+    end
+  end
+
+  def logout
+    current_user.forget_me if logged_in?
+    cookies.delete :auth_token
+    reset_session
+    flash[:notice] = _("You have been logged out.")
+    redirect_back_or_default(top_path)
+  end
+end

data/examples/al-admin/app/controllers/application.rb

@@ -0,0 +1,15 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  # Pick a unique cookie name to distinguish our session data from others'
+  session :session_key => '_al-admin_session_id'
+
+  init_gettext "al-admin"
+
+  include ExceptionNotifiable
+
+  include AuthenticatedSystem
+  before_filter :check_connectivity
+  before_filter :login_from_cookie
+end

data/examples/al-admin/app/controllers/directory_controller.rb

@@ -0,0 +1,22 @@
+class DirectoryController < ApplicationController
+  before_filter :login_required, :except => [:populate]
+  before_filter :empty_entries_required, :only => [:populate]
+
+  def index
+    @entries = Entry.search(:limit => 10)
+  end
+
+  def populate
+    ActiveLdap::Populate.ensure_base
+    ActiveLdap::Populate.ensure_ou(LdapUser.prefix)
+  end
+
+  private
+  def empty_entries_required
+    return true if Entry.empty?
+
+    flash.now[:notice] = _("Populating is only for initialization")
+    redirect_to(top_url)
+    false
+  end
+end

data/examples/al-admin/app/controllers/users_controller.rb

@@ -0,0 +1,38 @@
+class UsersController < ApplicationController
+  verify :method => :post, :only => [:update],
+         :redirect_to => {:action => :index}
+
+  before_filter :login_required
+
+  def index
+    @users = find(:all)
+  end
+
+  def show
+    @user = find(params[:id])
+  end
+
+  def edit
+    @user = find(params[:id])
+  end
+
+  def update
+    @user = find(params[:id])
+    previous_user_password = @user.user_password
+    if @user.update_attributes(params[:user])
+      if previous_user_password != @user.user_password
+        @user.establish_connection(:password => @user.password)
+      end
+      flash[:notice] = _('User was successfully updated.')
+      redirect_to :action => 'show', :id => @user
+    else
+      @user.password = @user.password_confirmation = nil
+      render :action => 'edit'
+    end
+  end
+
+  private
+  def find(*args)
+    current_user.ldap_user.find(*args)
+  end
+end

data/examples/al-admin/app/controllers/welcome_controller.rb

@@ -0,0 +1,4 @@
+class WelcomeController < ApplicationController
+  def index
+  end
+end

data/examples/al-admin/app/helpers/account_helper.rb

@@ -0,0 +1,2 @@
+module AccountHelper
+end

data/examples/al-admin/app/helpers/application_helper.rb

@@ -0,0 +1,6 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+  def sign_up_path
+    url_for(:controller => "/account", :action => "sign_up")
+  end
+end

data/examples/al-admin/app/helpers/directory_helper.rb

@@ -0,0 +1,2 @@
+module DirectoryHelper
+end

data/examples/al-admin/app/helpers/users_helper.rb

@@ -0,0 +1,13 @@
+module UsersHelper
+  def user_link(user, with_edit=false)
+    user_link_if(true, user, with_edit)
+  end
+
+  def user_link_if(condition, user, with_edit=false)
+    result = link_to_if(condition, h(user.dn), :action => "show", :id => user)
+    if with_edit and current_user and current_user.ldap_user == user
+      result << "\n(#{link_to(_('Edit'), :action => 'edit', :id => user)})"
+    end
+    result
+  end
+end

data/examples/al-admin/app/helpers/welcome_helper.rb

@@ -0,0 +1,2 @@
+module WelcomeHelper
+end

data/examples/al-admin/app/models/entry.rb

@@ -0,0 +1,19 @@
+class Entry < ActiveLdap::Base
+  ldap_mapping :prefix => "",
+               :classes => ["top"],
+               :scope => :sub
+  self.dn_attribute = nil
+
+  validate :always_fail
+
+  class << self
+    def empty?
+      search(:scope => :base).empty?
+    end
+  end
+
+  private
+  def always_fail
+    errors.add("save", _("disable saving"))
+  end
+end

data/examples/al-admin/app/models/ldap_user.rb

@@ -0,0 +1,49 @@
+require 'active_ldap/user_password'
+
+class LdapUser < ActiveLdap::Base
+  ldap_mapping :prefix => "ou=Users",
+               :classes => ["person"],
+               :dn_attribute => "cn"
+
+  N_("LdapUser|Password")
+  N_("LdapUser|Password confirmation")
+  attr_accessor :password
+
+  validates_presence_of :password, :password_confirmation,
+                        :if => :password_required?
+  validates_length_of :password, :within => 4..40,
+                      :if => :password_required?
+  validates_confirmation_of :password, :if => :password_required?
+  before_save :encrypt_password
+
+  class << self
+    def authenticate(dn, password)
+      user = find(dn)
+      user.authenticated?(password) ? user : nil
+    rescue ActiveLdap::EntryNotFound
+      nil
+    end
+  end
+
+  def authenticated?(password)
+    establish_connection(:password => password)
+    true
+  rescue ActiveLdap::AuthenticationError,
+      ActiveLdap::LdapError::UnwillingToPerform
+    false
+  end
+
+  private
+  def encrypt_password
+    return if password.blank?
+    hash_type = "ssha"
+    if /\A\{([A-Z][A-Z\d]+)\}/ =~ userPassword.to_s
+      hash_type = $1.downcase
+    end
+    self.user_password = ActiveLdap::UserPassword.send(hash_type, password)
+  end
+
+  def password_required?
+    user_password.blank? or !password.blank?
+  end
+end