devise_active_directory_authenticatable 0.3.2 → 0.3.3

data/README.md

@@ -5,6 +5,8 @@ Devise ActiveDirectory Authenticatable is a AD based authentication strategy for
 
 If you are building applications for use within your organization which require authentication and you want to use AD, this plugin is for you.
 
+Please note, this plugin is currently under heavy development.
+
 Requirements
 ------------
 
@@ -13,8 +15,9 @@ Requirements
 
 These gems are dependencies of the gem:
 
-- Devise 1.1.2
-- active_directory 1.0.4 from http://github.com/ajrkerr/activedirectory
+- Devise 1.1.5
+- active_directory 1.2.4
+- ancestry 1.2.3 _(For storing the group heirarchy)_
 
 Installation
 ------------
@@ -25,12 +28,8 @@ This will *only* work for Rails 3 applications.
 
 In the Gemfile for your application:
 
-    gem "devise", ">=1.1.2"
+    gem "devise"
     gem "devise_active_directory_authenticatable"
-    
-To get the latest version, pull directly from github instead of the gem:
-
-    gem "devise_active_directory_authenticatable", :git => "git://github.com/ajrkerr/devise_active_directory_authenticatable.git"
 
 
 Setup
@@ -49,11 +48,21 @@ This will update the devise.rb initializer, and update your user model. There ar
 
 Options:
 
-    [--user-model=USER_MODEL]  # Model to update
+    [--user-model=USER_MODEL]  # User Model to update
                                # Default: user
+    [--group-model=USER_MODEL] # Group Model to update
+                               # Default: group
     [--add-rescue]             # Update Application Controller with resuce_from for DeviseActiveDirectoryAuthenticatable::ActiveDirectoryException
                                # Default: true
 
+The rest of this documentation needs to be revised.  To get going on this, run the installer which will add some configuration options to config/intializers/devise.rb
+
+In your user model add:
+  devise :ad_user
+
+In your group model add:
+  devise :ad_group
+
 
 Usage
 -----
@@ -73,7 +82,7 @@ In initializer  `config/initializers/devise.rb` :
   * Active Directory server configuration settings
 
 * ad\_attr\_mapping 
-  * Attribute mapping between active directory and the user model
+  * Attribute mapping between active directory and the user model.  These attributes will be pulled from the AD
 
 * ad\_username _(default: :userPrincipalName)_
   * Username attribute on the AD to login with.  Maps with the login_with attribute from devise.
@@ -85,6 +94,19 @@ In initializer  `config/initializers/devise.rb` :
 * ad\_logger _(default: true)_
   * If set to true, will log Active Directory queries to the Rails logger.
 
+* ad\_update\_users _(default: true)_
+  * If true, devise will update the user attributes from the Active Directory when the user logs in
+
+* ad\_update\_groups _(default: true)_
+  * If true, devise will allow the group models to be update from the Active Directory
+
+* ad\_update\_group\_memberships _(default: true)_ _[unimplemented]_
+  * If true, devise will allow the memberships for groups and users to be updated.  It will also update the memberships when a user logs in.
+
+* ad\_update\_user\_memberships _(default: true)_ _[unimplemented]_
+  * If true, devise will allow the memberships for groups and users to be updated.  It will also update the memberships when a user logs in.
+
+
 
 References
 ----------

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/devise_active_directory_authenticatable.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{devise_active_directory_authenticatable}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Kerr"]

data/lib/devise_active_directory_authenticatable.rb

@@ -64,6 +64,22 @@ module Devise
   # Log LDAP queries to the Rails logger
   mattr_accessor :ad_logger
   @@ad_logger = true
+
+  ##Update the user object from the AD
+  mattr_accessor :ad_update_users
+  @@ad_update_users = true
+
+  ##Update the group object from the AD
+  mattr_accessor :ad_update_groups
+  @@ad_update_groups = true
+
+  ##Update the group memberships from the AD, this uses the ancestory gem
+  mattr_accessor :ad_update_group_memberships
+  @@ad_update_group_memberships = true
+
+  ##Update the user memberships from the AD
+  mattr_accessor :ad_update_user_memberships
+  @@ad_update_user_memberships = true
 end
 
 # Add ldap_authenticatable strategy to defaults.

data/lib/generators/devise_active_directory_authenticatable/install_generator.rb

@@ -2,8 +2,9 @@ module DeviseActiveDirectoryAuthenticatable
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path("../templates", __FILE__)
     
-    class_option :user_model, :type => :string, :default => "user", :desc => "Model to update"
-    class_option :update_model, :type => :boolean, :default => true, :desc => "Update model to change from database_authenticatable to active_directory_authenticatable"
+    class_option :user_model, :type => :string, :default => "user", :desc => "User model to update"
+    class_option :group_model, :type => :string, :default => "group", :desc => "Group model to update"
+    class_option :update_model, :type => :boolean, :default => true, :desc => "Update models to change from database_authenticatable to active_directory_authenticatable or insert the code"
     class_option :add_rescue, :type => :boolean, :default => true, :desc => "Update Application Controller with resuce_from for DeviseActiveDirectoryAuthenticatable::ActiveDirectoryException"
     
     
@@ -14,6 +15,10 @@ module DeviseActiveDirectoryAuthenticatable
     def update_user_model
       gsub_file "app/models/#{options.user_model}.rb", /:database_authenticatable/, ":ad_user" if options.update_model?
     end
+
+    def update_group_model
+      inject_into_class "app/models/#{options.group_model}.rb", options.group_model, "devise :ad_group" if options.update_model?
+    end
     
     def update_application_controller
       inject_into_class "app/controllers/application_controller.rb", ApplicationController, rescue_from_exception if options.add_rescue?
@@ -74,6 +79,18 @@ module DeviseActiveDirectoryAuthenticatable
   ##Log LDAP queries to the Rails logger
   # config.ad_logger = true
 
+  ##Update the user object from the AD
+  # config.ad_update_users = true
+
+  ##Update the group object from the AD
+  # config.ad_update_groups = true
+
+  ##Update the group memberships from the AD, this uses the ancestory gem to store the hierarchy
+  # config.ad_update_group_memberships = true
+
+  ##Update the user memberships from the AD
+  # config.ad_update_user_memberships = true
+
         eof
       
       settings

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: devise_active_directory_authenticatable
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Adam Kerr