sys-admin 1.4.5 → 1.5.0

data/CHANGES

@@ -1,8 +1,15 @@
-== 1.4.5 - 1-Mar-2009
+== 1.5.0 - 29-Mar-2009
+* INTERFACE CHANGE (WINDOWS ONLY): The interface for MS Windows has undergone
+  a radical change. Most methods now accept a hash of options that are
+  passed directly to the underlying WMI class. Please see the documentation
+  for details.
+* Now works on various BSD flavors.
 * Added the User#groups method. This returns an array of groups that the
   user belongs to. Suggestion inspired by Gonzalo Garramuno.
-* Changed User#class to User#access_class to avoid conflicts with the
-  Ruby core Object method. 
+* Added the Group#members method. The returns an array of users that the
+  group contains.
+* Changed User#class to User#access_class for UNIX flavors to avoid
+  conflicts with the Ruby core Object method. 
 * Added more tests and renamed the test files.
 * Removed an unnecessary function call where a platform might try to
   get lastlog information even if the lastlog.h or utmp.h headers couldn't

data/README

@@ -39,39 +39,33 @@
 Admin.get_login
    Returns the user name (only) of the current login.
 
-Admin.get_user(name, host=localhost)
-Admin.get_user(uid, host=localhost, local=true)
-   Returns a User object based on +name+ or +uid+.
+Admin.get_user(name, options = {})
+Admin.get_user(uid, options = {})
+   Returns a User object based on +name+ or +uid+. The +options+ hash is
+   for MS Windows only, and allows you to restrict the search based on the
+   options you provide, e.g. 'domain' or 'localaccount'.
    
-   Windows only: you may specify a host from which information is retrieved.
-   The default is the local machine.  You may also specify whether to
-   retrieve a local or global account.  The default is local.
-
-Admin.get_group(name, host=localhost, local=true) 
-Admin.get_group(gid, host=localhost, local=true)
-   Returns a Group object based on +name+ or +uid+.
-   
-   Windows only: you may specify a host from which information is retrieved.
-   The default is the local machine.  You can retrieve either a global or
-   local group, depending on the value of the +local+ argument.
-
-Admin.groups(host=localhost, local=true)
-Admin.groups(host=localhost, local=true){ |group| ... }
+Admin.get_group(name, options = {})
+Admin.get_group(gid, options = {})
+   Returns a Group object based on +name+ or +uid+. The +options+ hash is
+   for MS Windows only, and allows you to restrict the search based on the
+   options you provide, e.g. 'domain' or 'localaccount'.
+
+Admin.groups(options = {})
+Admin.groups(options = {}){ |group| ... }
    In block form, yields a Group object for each user on the system.  In
    non-block form, returns an Array of Group objects.
 
-   Windows only: you may specify a host from which information is retrieved.
-   The default is the local machine.  You can retrieve either a global or
-   local group, depending on the value of the +local+ argument.
+   The +options+ hash is for MS Windows only, and allows you to restrict the
+   search based on the options you provide, e.g. 'domain' or 'localaccount'.
 
-Admin.users(host=localhost, local=true)
-Admin.users(host=localhost, local=true){ |user| ... }
+Admin.users(options = {})
+Admin.users(options = {}){ |user| ... }
    In block form, yields a User object for each user on the system.  In
    non-block form, returns an Array of User objects.
    
-   Windows only: you may specify a host from which information is retrieved.
-   The default is the local machine.  You can retrieve either a global or
-   local group, depending on the value of the +local+ argument.
+   The +options+ hash is for MS Windows only, and allows you to restrict the
+   search based on the options you provide, e.g. 'domain' or 'localaccount'.
    
 == User class
 === User (Windows)
@@ -143,34 +137,14 @@ Admin::Error < StandardError
    information.  This means that the WMI service must be running on the
    target machine in order to work (which it is, by default).
 	
-   Note that, by default, local user and group information is retrieved
-   instead of global.  You probably do NOT want to iterate over global users
-   or groups because there can be quite a few on your domain.
-   
 === UNIX
    The underlying implementation is similar to core Ruby's Etc implementation.
    But, in addition to the different interface, I use the re-entrant version
    of the appropriate functions when available.
 
 == Future Plans
-   Add the following methods for UNIX:
-
-   * Admin.add_local_user
-   * Admin.config_local_user
-   * Admin.delete_local_user
-   * Admin.add_global_user
-   * Admin.config_global_user
-   * Admin.delete_global_user
-   
-   * Admin.add_local_group
-   * Admin.config_local_group
-   * Admin.delete_local_group
-   * Admin.add_global_group
-   * Admin.config_global_group
-   * Admin.delete_global_group
-
    Make the User and Group objects comparable.
-   Support BSD.
+   Add ability to add, configure and delete users on Unix platforms.
 
 == Known Bugs
    None that I'm aware of. If you find any, please log them on the project

data/ext/extconf.rb

@@ -48,7 +48,7 @@ else
    end
 
    $CFLAGS += " -D_POSIX_PTHREAD_SEMANTICS"
-   if RUBY_PLATFORM.match("linux")
+   if RUBY_PLATFORM =~ /linux|bsd/i
       $CFLAGS += " -D_GNU_SOURCE -D_REENTRANT"
    end
 end

data/ext/sys/admin.c

@@ -159,7 +159,11 @@ static VALUE admin_groups_body(VALUE klass){
    char buf[GROUP_BUF_SIZE];
 #ifdef _GNU_SOURCE
    struct group* grp_p;
+
    while(!getgrent_r(&grp, buf, GROUP_BUF_SIZE, &grp_p)){
+      if(grp_p == NULL)
+         break;
+
       if(rb_block_given_p())
          rb_yield(get_group(grp_p));
       else
@@ -221,7 +225,11 @@ static VALUE admin_users_body(VALUE klass){
 
 #ifdef _GNU_SOURCE
    struct passwd* pwd_p;
+
    while(!getpwent_r(&pwd, buf, USER_BUF_SIZE, &pwd_p)){
+      if(pwd_p == NULL)
+         break;
+
       if(rb_block_given_p())
          rb_yield(get_user(pwd_p));
       else
@@ -396,6 +404,6 @@ void Init_admin(){
 
    /* Constants */
 
-   /* 1.4.5: The version of this library */
+   /* 1.5.0: The version of this library */
    rb_define_const(cAdmin, "VERSION", rb_str_new2(SYS_ADMIN_VERSION));
 }

data/ext/sys/admin.h

@@ -8,7 +8,15 @@
 #include <errno.h>
 #include <string.h>
 
-#define SYS_ADMIN_VERSION "1.4.5"
+#define SYS_ADMIN_VERSION "1.5.0"
+
+#if defined(__MACH__) || defined(__APPLE__)
+#define __BSD__
+#endif
+
+#if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
+#define __BSD__
+#endif
 
 #ifdef HAVE_LASTLOG_H
 #include <lastlog.h>
@@ -20,8 +28,8 @@
 #define _POSIX_LOGIN_NAME_MAX 9
 #endif
 
-/* OS X returns -1 on this for some reason, so check for it */
-#if defined(__MACH__) || defined(__APPLE__)
+// BSD platforms are problematic with explicit inclusion of unistd.h
+#if defined(__BSD__)
 #define USER_BUF_SIZE 1024
 #else
 #ifdef _SC_GETPW_R_SIZE_MAX
@@ -31,8 +39,8 @@
 #endif
 #endif
 
-/* OS X returns -1 on this for some reason, so check for it */
-#if defined(__MACH__) || defined(__APPLE__)
+// BSD platforms are problematic with explicit inclusion of unistd.h
+#if defined(__BSD__)
 #define GROUP_BUF_SIZE 7296
 #else
 #ifdef _SC_GETGR_R_SIZE_MAX
@@ -61,7 +69,7 @@ VALUE cUser, cGroup, cAdminError;
  * Helper function that returns a User object based on user ID.
  */
 static VALUE get_user_by_num(VALUE v_uid){
-   VALUE v_user;
+   volatile VALUE v_user;
    uid_t uid = NUM2INT(v_uid);
 
 #ifdef HAVE_GETPWUID_R
@@ -95,7 +103,7 @@ static VALUE get_user_by_num(VALUE v_uid){
  * Helper function that returns a User object based on name.
  */
 static VALUE get_user_by_name(VALUE v_name){
-   VALUE v_user;
+   volatile VALUE v_user;
    SafeStringValue(v_name);
 
 #ifdef HAVE_GETPWNAM_R
@@ -129,7 +137,7 @@ static VALUE get_user_by_name(VALUE v_name){
  * Helper function that returns a Group object based on group ID.
  */
 static VALUE get_group_by_num(VALUE v_gid){
-   VALUE v_group;
+   volatile VALUE v_group;
    gid_t gid = NUM2INT(v_gid);
 
 #ifdef HAVE_GETGRGID_R
@@ -163,7 +171,7 @@ static VALUE get_group_by_num(VALUE v_gid){
  * Helper function that returns a Group object based on group name.
  */
 static VALUE get_group_by_name(VALUE v_name){
-   VALUE v_group = Qnil;
+   volatile VALUE v_group = Qnil;
    SafeStringValue(v_name);
 #ifdef HAVE_GETGRNAM_R
    char buf[GROUP_BUF_SIZE];

data/test/test_sys_admin.rb

@@ -16,6 +16,6 @@ end
 
 class TC_Sys_Admin_All < Test::Unit::TestCase
    def test_version
-      assert_equal('1.4.5', Sys::Admin::VERSION)
+      assert_equal('1.5.0', Sys::Admin::VERSION)
    end
 end

data/test/test_sys_admin_windows.rb

@@ -22,117 +22,160 @@ class TC_Sys_Admin_Win32 < Test::Unit::TestCase
 
    def setup
       @user       = User.new
-      @user_name  = 'guest'
+      @user_name  = 'Guest'
       @user_id    = 501        # best guess, may fail
       @group      = Group.new
-      @group_name = 'guests'
+      @group_name = 'Guests'
       @group_id   = 546        # best guess, may fail
    end
 
-   def test_01_add_local_user
-      assert_respond_to(Admin, :add_local_user)
-      assert_nothing_raised{ Admin.add_local_user('foo') }
-   end
-   
-   def test_add_global_user
-      assert_respond_to(Admin, :add_global_user)
-   end
-   
-   def test_02_config_local_user
-      assert_respond_to(Admin, :config_local_user)
+   # Admin singleton methods
+
+   def test_01_add_user
+      assert_respond_to(Admin, :add_user)
       assert_nothing_raised{
-         Admin.config_local_user("foo", {
-            :description => "delete me",
-            :fullname    => "fubar"
-         })
+         Admin.add_user(:name => 'foo', :password => 'a1b2c3D4')
       }
    end
-   
-   def test_config_global_user
-      assert_respond_to(Admin, :config_global_user)
-   end
-   
-   def test_03_delete_local_user
-      assert_respond_to(Admin, :delete_local_user)
-      assert_nothing_raised{ Admin.delete_local_user("foo") }
-   end
-   
-   def test_delete_global_user
-      assert_respond_to(Admin, :delete_global_user)
+
+   def test_02_config_user
+      assert_respond_to(Admin, :configure_user)
+      assert_nothing_raised{
+         Admin.configure_user(
+            :name        => 'foo',
+            :description => 'delete me',
+            :fullname    => 'fubar',
+            :password    => ['a1b2c3D4', 'd1c2b3A4']
+         )
+      }
    end
    
-   def test_01_add_local_group
-      assert_respond_to(Admin, :add_local_group)
-      assert_nothing_raised{ Admin.add_local_group("bar") }
+   def test_03_delete_user
+      assert_respond_to(Admin, :delete_user)
+      assert_nothing_raised{ Admin.delete_user('foo') }
    end
-   
-   def test_add_global_group
-      assert_respond_to(Admin, :add_global_group)
+  
+   def test_01_add_group
+      assert_respond_to(Admin, :add_group)
+      assert_nothing_raised{ Admin.add_group(:name => 'bar') }
    end
    
-   def test_02_config_local_group
-      assert_respond_to(Admin, :config_local_group)
+   def test_02_configure_group
+      assert_respond_to(Admin, :configure_group)
       assert_nothing_raised{
-         Admin.config_local_group('bar', {:description => 'delete me'})
+         Admin.configure_group(:name => 'bar', :description => 'delete me')
       }
    end
    
-   def test_config_global_group
-      assert_respond_to(Admin, :config_global_group)
-   end
-   
-   def test_03_delete_local_group
-      assert_respond_to(Admin, :delete_local_group)
-      assert_nothing_raised{ Admin.delete_local_group("bar") }
+   def test_03_delete_group
+      assert_respond_to(Admin, :delete_group)
+      assert_nothing_raised{ Admin.delete_group('bar') }
    end
    
-   def test_delete_global_group
-      assert_respond_to(Admin, :delete_global_group)
+   def test_get_login_basic
+      assert_respond_to(Admin, :get_login)
+      assert_nothing_raised{ Admin.get_login }
    end
 
    def test_get_login
-      assert_respond_to(Admin, :get_login)
-      assert_nothing_raised{ Admin.get_login }
       assert_kind_of(String, Admin.get_login)
    end
+
+   def test_get_login_expected_errors
+      assert_raise(ArgumentError){ Admin.get_login('foo') }
+   end
    
-   def test_get_user
+   def test_get_user_basic
       assert_respond_to(Admin, :get_user)
-      assert_raises(ArgumentError){ Admin.get_user }
    end
   
-   def test_get_user_local
-      assert_nothing_raised{ Admin.get_user(@user_name) }     
-      assert_nothing_raised{ Admin.get_user(@user_id) }     
-      assert_kind_of(User, Admin.get_user(@user_name))      
-      assert_kind_of(User, Admin.get_user(@user_id))      
+   def test_get_user_by_string
+      assert_nothing_raised{ Admin.get_user(@user_name, :localaccount => true) }     
+      assert_kind_of(User, Admin.get_user(@user_name, :localaccount => true))
+   end
+
+   def test_get_user_by_uid
+      assert_nothing_raised{ Admin.get_user(@user_id, :localaccount => true) }
+      assert_kind_of(User, Admin.get_user(@user_id, :localaccount => true))
    end
    
-   def test_get_user_remote
-      assert_nothing_raised{ Admin.get_user(@user_name, @@host) }
-      assert_nothing_raised{ Admin.get_user(@user_id, @@host) }
-      assert_kind_of(User, Admin.get_user(@user_name, @@host))
-      assert_kind_of(User, Admin.get_user(@user_id, @@host))
+   def test_get_user_by_string_with_options
+      options = {:host => @@host, :localaccount => true}
+      assert_nothing_raised{ Admin.get_user(@user_name, options) }
+      assert_kind_of(User, Admin.get_user(@user_name, options))
+   end
+
+   def test_get_user_by_uid_with_options
+      options = {:host => @@host, :localaccount => true}
+      assert_nothing_raised{ Admin.get_user(@user_id, options) }
+      assert_kind_of(User, Admin.get_user(@user_id, options))
+   end
+
+   def test_get_user_expected_errors
+      assert_raises(ArgumentError){ Admin.get_user }
    end
    
-   def test_users
+   def test_users_basic
       assert_respond_to(Admin, :users)
+      assert_nothing_raised{ Admin.users(:localaccount => true) }
    end
 
-   def test_users_local     
-      assert_nothing_raised{ Admin.users }      
-      assert_nothing_raised{ Admin.users{ |u| } }     
-      assert_nothing_raised{ Admin.users(nil) }
-      assert_nothing_raised{ Admin.users(nil){ |u| } }
-      assert_kind_of(Array, Admin.users)
-      assert_kind_of(User, Admin.users.first)
+   def test_users
+      assert_kind_of(Array, Admin.users(:localaccount => true))
+      assert_kind_of(User, Admin.users(:localaccount => true).first)
+   end
+
+   def test_users_with_block
+      array = []
+      assert_nothing_raised{
+         Admin.users(:localaccount => true){ |u| array << u }
+      }
+      assert_kind_of(User, array[0])
+   end
+
+   def test_get_group_basic
+      assert_respond_to(Admin, :get_group)
+   end
+     
+   def test_get_group_by_name
+      assert_nothing_raised{ Admin.get_group(@group_name, :localaccount => true) }
+      assert_kind_of(Group, Admin.get_group(@group_name, :localaccount => true))
+   end
+
+   def test_get_group_by_gid
+      assert_nothing_raised{ Admin.get_group(@group_id, :localaccount => true) }
+      assert_kind_of(Group, Admin.get_group(@group_id, :localaccount => true))
    end
    
-   def test_users_remote
-      assert_nothing_raised{ Admin.users(@@host) }
-      assert_nothing_raised{ Admin.users(@@host){ |u| } }
+   def test_get_group_with_options
+      assert_nothing_raised{ Admin.get_group(@group_name, :localaccount => true) }
+      assert_kind_of(Group, Admin.get_group(@group_name, :localaccount => true))
+   end
+
+   def test_get_group_expected_errors
+      assert_raise(ArgumentError){ Admin.get_group }
    end
    
+   def test_groups_basic
+      assert_respond_to(Admin, :groups)
+      assert_nothing_raised{ Admin.groups(:localaccount => true) }
+   end
+
+   def test_groups
+      assert_kind_of(Array, Admin.groups(:localaccount => true))
+      assert_kind_of(Group, Admin.groups(:localaccount => true).first)
+   end
+  
+   def test_groups_with_block
+      array = []
+      assert_nothing_raised{
+         Admin.groups(:localaccount => true){ |g| array << g }
+      }
+      assert_kind_of(Group, array[0])
+   end
+
+   # User class
+   
    def test_user_instance_caption
       assert_respond_to(@user, :caption)
       assert_respond_to(@user, :caption=)
@@ -213,40 +256,7 @@ class TC_Sys_Admin_Win32 < Test::Unit::TestCase
       assert_respond_to(@user, :uid=)
    end
    
-   def test_get_group
-      assert_respond_to(Admin, :get_group)
-      assert_raises(ArgumentError){ Admin.get_group }
-   end
-     
-   def test_get_group_local     
-      assert_nothing_raised{ Admin.get_group(@group_name) }     
-      assert_kind_of(Group, Admin.get_group(@group_name))
-      assert_nothing_raised{ Admin.get_group(@group_id) }     
-      assert_kind_of(Group, Admin.get_group(@group_id))
-   end
-   
-   def test_get_group_remote
-      assert_nothing_raised{ Admin.get_group(@group_name, @@host) }
-      assert_kind_of(Group, Admin.get_group(@group_name, @@host))
-   end
-   
-   def test_groups
-      assert_respond_to(Admin, :groups)
-   end
-  
-   def test_groups_local      
-      assert_nothing_raised{ Admin.groups }     
-      assert_nothing_raised{ Admin.groups{ |g| } }      
-      assert_kind_of(Array, Admin.groups)     
-      assert_kind_of(Group, Admin.groups.first)     
-   end
-   
-   def test_groups_remote
-      assert_nothing_raised{ Admin.groups(@@host) }
-      assert_nothing_raised{ Admin.groups(@@host){ |g| } }
-      assert_kind_of(Array, Admin.groups(@@host))
-      assert_kind_of(Group, Admin.groups(@@host).first)
-   end
+   # Group class
    
    def test_group_instance_caption
       assert_respond_to(@group, :caption)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sys-admin
 version: !ruby/object:Gem::Version 
-  version: 1.4.5
+  version: 1.5.0
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-26 00:00:00 -07:00
+date: 2009-03-29 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -27,19 +27,21 @@ extra_rdoc_files:
 files: 
 - doc/sys-admin-unix.txt
 - doc/sys-admin-windows.txt
-- examples/users.rb
 - examples/groups.rb
-- test/test_sys_admin_windows.rb
+- examples/users.rb
 - test/test_sys_admin.rb
 - test/test_sys_admin_unix.rb
-- MANIFEST
-- README
+- test/test_sys_admin_windows.rb
 - CHANGES
+- MANIFEST
 - Rakefile
+- README
 - ext/sys/admin.c
 - ext/sys/admin.h
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/sysutils
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -60,9 +62,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sysutils
-rubygems_version: 1.3.1
+rubygems_version: 1.3.1.2403
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A unified, cross platform replacement for the "etc" library.
 test_files: 
 - test/test_sys_admin.rb