sys-admin 1.7.4 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3516d935d00221a18c46e91cc08de3886bde14c81c2ba5a39e2c9b7072618695
-  data.tar.gz: 81996006820e530e449c79f9857031913ce040bed5d9bfea6668cf27338107a0
+  metadata.gz: d20b0abf74cb8d4769f69346ac22ade3d1336bd10d3b6f83eeca2865ab9b85fe
+  data.tar.gz: 7c56cb4dec18928e3ea4fb1371e9c3f4e660fb5ec94519b0385a1448c07e0d84
 SHA512:
-  metadata.gz: e1fe74964b0e0896e31426229a3f79267984b3c73f9e78c551116bb225a075f2f814e9b8d3b06a589250cd4f1b750c11bea2cc3fccdc0c2d0a540d2fd5a8b2e4
-  data.tar.gz: 4a2593fdff4e15657e88651248e0d26512d4d020f46589cee595615f66c7671f8f91393a621444d6bc3eb032b0a621e262d7334ad3994fd8c349f9c7e87bebc4
+  metadata.gz: 55d12a7b5d4999eec9801b60a06d1da16bfb2879a4270b0d5188b7d20a397a170619fb0dc75f9fd394952c02e3228d686ff9c908f15a38750220bea7eb2a2e9d
+  data.tar.gz: 3ec5f6ac0690458751f5dd5e2ccaf764b977f1aa46fc6f2acf0c506417c39a4baf704338c712614728fe8d89c289bd76c20dcd62b41f6b28ab5205404ef338e3

data/{CHANGES.rdoc → CHANGES.md}

@@ -1,39 +1,67 @@
-== 1.7.3 - 16-Jan-2020
+## 1.8.1 - 25-Sep-2021
+* The users and get_user methods on Darwin now take an optional :lastlog key
+  that you can set to false in order to significantly speed up those methods
+  at the expense of taking away lastlog information.
+* Some internal rspec refactoring.
+
+## 1.8.0 - 26-Aug-2021
+* Switched from test-unit to rspec, with some tests refactored. The Rakefile
+  and gemspec files were updated accordingly.
+* The User and Group classes for the Windows implementation are now properly
+  scoped under Sys::Admin instead of just Sys.
+* Fixed a bug in the get_user and get_group methods on Windows where the WQL
+  it generates internally might not be correct.
+
+## 1.7.6 - 24-Mar-2021
+* Changed the implementation for `Admin.get_login` on Linux since the
+  underlying `getlogin` C function is unreliable, especially in certain
+  virtualized environments.
+* Added win32-security back to the gemspec as a dependency for Windows.
+  I'm not sure why I removed it, and bundler definitely needs it.
+* Fixed some private access modifiers that weren't actually doing anything.
+
+## 1.7.5 - 30-Dec-2020
+* Switched from rdoc to markdown since github isn't rendering rdoc properly.
+
+## 1.7.4 - 19-Mar-2020
+* Properly include a LICENSE file as per the Apache-2.0 license.
+
+## 1.7.3 - 16-Jan-2020
 * Add explicit .rdoc extension to various rdoc files so that they show up
   better in github.
 * Some formatting adjustments to the rdoc files.
 
-== 1.7.2 - 28-Jan-2019
+## 1.7.2 - 28-Jan-2019
 * Fixed the license name, was missing a hyphen.
 * Fixed the homepage in the gemspec.
 
-== 1.7.1 - 19-Mar-2018
+## 1.7.1 - 19-Mar-2018
 * Fixed deprecation warnings in tests.
 * Added gemspec metadata.
 * Updated cert again, this one should last 10 years.
  
-== 1.7.0 - 21-Feb-2018
+## 1.7.0 - 21-Feb-2018
 * Changed the license to Apache 2.0.
 * VERSION constant is now frozen.
 * Ignore dependency warnings in gem:create task.
 * Minor README updates.
 * Updated cert.
 
-== 1.6.4 - 6-Sep-2015
+## 1.6.4 - 6-Sep-2015
 * Added a sys-admin.rb file for convenience.
 * Set VERSION in a single place.
 * Assume Rubygems 2.x for Rakefile tasks.
 * This gem is now signed.
 
-== 1.6.3 - 8-Mar-2014
+## 1.6.3 - 8-Mar-2014
 * The Admin#get_group method now handles groups with very large numbers
   of members more robustly.
 
-== 1.6.2 - 11-Feb-2014
+## 1.6.2 - 11-Feb-2014
 * The User#gid method is now supported on MS Windows. It returns the user's
   primary group ID.
 
-== 1.6.1 - 24-Jan-2014
+## 1.6.1 - 24-Jan-2014
 * Added the Admin.add_group_member and Admin.remove_group member methods. These
   let you add a user to a specific group. Thanks go to Alexey Kolyanov for the
   idea and the code.
@@ -43,7 +71,7 @@
 * Updated the gem:create task in the Rakefile.
 * Added rake as a development dependency.
 
-== 1.6.0 - 5-Jan-2013
+## 1.6.0 - 5-Jan-2013
 * Converted code to use FFI. This mostly only affects the unix flavors.
 * The Admin.users and Admin.groups methods no longer accept a block.
 * Some test suite updates.
@@ -51,13 +79,13 @@
   separate gems. There is now a single, unified gem that works on all
   supported platforms.
 
-== 1.5.6 - 30-Jul-2011
+## 1.5.6 - 30-Jul-2011
 * Fixed issue for non-gnu platforms where it would use the wrong function
   prototype because the Ruby core team took it upon themselves to explicitly
   defined _GNU_SOURCE in config.h in 1.8.7 and later for reasons that baffle me.
 * Some tests on Windows are now skipped unless run with elevated security.
 
-== 1.5.5 - 5-Jul-2011
+## 1.5.5 - 5-Jul-2011
 * Modified lastlog handling, and ignore getpwent_r and getgrent_r, on AIX.
   Thanks go to Rick Ohnemus for the spot and patches.
 * Explicitly set spec.cpu on Windows to 'universal' in the gem creation task.
@@ -65,21 +93,21 @@
   being generated was incorrect if no options were passed. Thanks go to
   Matthew Brown for the spot.
 
-== 1.5.4 - 7-Oct-2010
+## 1.5.4 - 7-Oct-2010
 * Prefer the getlastlogx() function over lastlog() where supported.
 
-== 1.5.3 - 6-Oct-2010
+## 1.5.3 - 6-Oct-2010
 * Refactored the Rakefile. The old installation tasks have been replaced
   with gem build and install tasks. In addition, the platform handling has
   been updated for MS Windows.
 * Portions of the gemspec have been moved into the Rakefile gem tasks.
 * Deploying the mingw gem by default for MS Windows now.
 
-== 1.5.2 - 2-Aug-2009
+## 1.5.2 - 2-Aug-2009
 * Now compatible with Ruby 1.9.x.
 * Added test-unit as a development dependency.
 
-== 1.5.1 - 23-Jul-2009
+## 1.5.1 - 23-Jul-2009
 * Added the User#dir attribute. This attribute contains a user's home
   directory if set, or nil if it isn't.
 * User objects returned by the Admin.users method now include the uid.
@@ -87,7 +115,7 @@
 * Added win32-security as a dependency.
 * Changed license to Artistic 2.0.
 
-== 1.5.0 - 29-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
@@ -104,14 +132,14 @@
   get lastlog information even if the lastlog.h or utmp.h headers couldn't
   be found.
 
-== 1.4.4 - 19-Nov-2008
+## 1.4.4 - 19-Nov-2008
 * Added the User#uid method for MS Windows (which is just the user's relative
   identifier).
 * Now requires test-unit 2.x.
 * Some updates to the test suite to take advantage of test-unit 2.x features.
 * Some minor gemspec tweaks.
 
-== 1.4.3 - 2-Mar-2008
+## 1.4.3 - 2-Mar-2008
 * The block form of Admin.users now properly ensures that endpwent() is
   called. Likewise, the block form of Admin.groups now properly ensures
   that endgrent() is called. This would only have been an issue if you
@@ -119,7 +147,7 @@
 * The AdminError class is now Admin::Error.
 * Some internal directory layout changes.
 
-== 1.4.2 - 26-Jun-2007
+## 1.4.2 - 26-Jun-2007
 * Fixed a bug in the Admin.get_login method where it would return junk
   if the underlying getlogin() function failed (Unix). Thanks go to Gonzalo
   Garramuno for the spot. This bug also resulted in some refactoring of the
@@ -127,13 +155,13 @@
 * Removed the install.rb file. The logic in that file has been moved directly
   into the Rakefile.
 
-== 1.4.1 - 21-Mar-2007
+## 1.4.1 - 21-Mar-2007
 * Bug fix for OS X. Thanks go to an anonymous user for the spot.
 * Added a Rakefile. Building, testing and installing should now use the
   Rake tasks (for non-gem installs).
 * Much more inline documentation, especially for User and Group attributes.
 
-== 1.4.0 - 20-Jan-2007
+## 1.4.0 - 20-Jan-2007
 * Added the following methods: add_local_user, config_local_user,
   delete_local_user, add_global_group, config_global_group, and
   delete_global_group.  MS Windows only at the moment.
@@ -149,18 +177,18 @@
   integer.
 * Renamed tc_win32.rb to tc_windows.rb
 
-== 1.3.1 - 29-Jun-2005
+## 1.3.1 - 29-Jun-2005
 * Fixed a bug where the inability to read the lastlog file caused an error.
   From now on that error is ignored, and the lastlog attributes of the User
   object are set to nil.
 * Added a beta version of Admin.delete_user (Windows only).
 
-== 1.3.0 - 3-Jun-2005
+## 1.3.0 - 3-Jun-2005
 * Bug fixes for Linux.
 * Removed the version.h file - no longer needed since the Win32 version is
   pure Ruby.
 
-== 1.2.0 - 30-Apr-2005
+## 1.2.0 - 30-Apr-2005
 * Replaced the Win32 version with a pure Ruby version that uses Win32API and
   win32ole + WMI.
 * The LocalGroup class no longer exists in the Win32 version.  Instead, it is
@@ -170,7 +198,7 @@
   over global accounts.
 * Corresponding doc changes and test suite changes.
 
-== 1.1.0 - 1-Apr-2005
+## 1.1.0 - 1-Apr-2005
 * Fixed bug where a segfault could occur when trying to retrieve a user or
   group by an ID that didn't exist (Unix).
 * Added tests for intentional failures.
@@ -178,5 +206,5 @@
 * Modified the way User objects are created internally (Unix).
 * Fixed a bug in the User#shell attribute (Unix).
 
-== 1.0.0 - 25-Mar-2005
+## 1.0.0 - 25-Mar-2005
 * Initial release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/{MANIFEST.rdoc → MANIFEST.md}

@@ -1,9 +1,10 @@
 * sys-admin.gemspec
-* CHANGES.rdoc
+* CHANGES.md
 * LICENSE
-* MANIFEST.rdoc
+* MANIFEST.md
+* README.md
+* Gemfile
 * Rakefile
-* README.rdoc
 * certs/djberg96_pub.pem
 * examples/groups.rb
 * examples/users.rb

data/{README.rdoc → README.md}

@@ -1,62 +1,73 @@
-== Description
+[![Ruby](https://github.com/djberg96/sys-admin/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/sys-admin/actions/workflows/ruby.yml)
+
+## Description
 The sys-admin library is a unified, cross platform replacement for the Etc module.
    
-== Installation
-  gem install sys-admin
+## Installation
+`gem install sys-admin`
+
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-admin/main/certs/djberg96_pub.pem)`
 
-== Synopsis
-  require 'sys/admin' # or sys-admin
-  include Sys
+## Synopsis
+```ruby
+require 'sys/admin' # or sys-admin
+include Sys
 
-  # Returns an Array of User objects
-  a = Admin.users
+# Returns an Array of User objects
+a = Admin.users
 
-  # Returns an Array of Group objects
-  g = Admin.groups
+# Returns an Array of Group objects
+g = Admin.groups
 
-  # Get information about a particular user
-  p Admin.get_user("nobody")
-  p Admin.get_user("nobody", :localaccount => true)
+# Get information about a particular user
+p Admin.get_user("nobody")
+p Admin.get_user("nobody", :localaccount => true)
 
-  # Get information about a particular group
-  p Admin.get_group("adm")
-  p Admin.get_group("adm", :localaccount => true)
+# Get information about a particular group
+p Admin.get_group("adm")
+p Admin.get_group("adm", :localaccount => true)
+```
 
-== Admin
-  Admin.get_login
+## Admin
+  `Admin.get_login`
 
 Returns the user name (only) of the current login.
 
-  Admin.get_user(name, options = {})
-  Admin.get_user(uid, options = {})
+```
+Admin.get_user(name, options = {})
+Admin.get_user(uid, options = {})
+```
 
-Returns a User object based on +name+ or +uid+. The +options+ hash is
+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'.
    
-  Admin.get_group(name, options = {})
-  Admin.get_group(gid, options = {})
+```
+Admin.get_group(name, options = {})
+Admin.get_group(gid, options = {})
+```
 
-Returns a Group object based on +name+ or +uid+. The +options+ hash is
+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 = {})`
 
 Returns an Array of Group objects.
 
-The +options+ hash is for MS Windows only, and allows you to restrict the
+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(options = {})
+`Admin.users(options = {})`
 
 Returns an Array of User objects.
    
-The +options+ hash is for MS Windows only, and allows you to restrict the
+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)
+## User class
+### User (Windows)
 The User class has the following attributes on MS Windows systems:
 	
   * account_type
@@ -78,7 +89,7 @@ The User class has the following attributes on MS Windows systems:
   * password_required?
   * uid
      
-=== User (Unix)
+### User (Unix)
 The User class has the following attributes on Unix systems:
 	
   * name
@@ -95,8 +106,8 @@ The User class has the following attributes on Unix systems:
   * change
   * expire
 
-== Group Classes
-=== Group (Windows)
+## Group Classes
+### Group (Windows)
 The Group class has the following attributes on MS Windows systems:
 	
   * caption
@@ -109,7 +120,7 @@ The Group class has the following attributes on MS Windows systems:
   * gid
   * local?
 	
-=== Group (Unix)
+### Group (Unix)
 The Group class has the following attributes on Unix systems:
 	
   * name
@@ -117,37 +128,37 @@ The Group class has the following attributes on Unix systems:
   * members
   * passwd
 
-== Error Classes
-  Admin::Error < StandardError
+## Error Classes
+`Admin::Error < StandardError`
 
 Raised if anything goes wrong with any of the above methods.
 
-== Developer's Notes
-=== MS Windows
+## Developer's Notes
+### MS Windows
 The Windows version now uses a win32ole + WMI approach to getting
 information.  This means that the WMI service must be running on the
 target machine in order to work (which it is, by default).
 	
-=== UNIX
+### 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
+## Future Plans
 * Make the User and Group objects comparable.
 * Add ability to add, configure and delete users on Unix platforms.
 
-== Known Bugs
+## Known Bugs
 None that I'm aware of. If you find any, please log them on the project page at:
 
   https://github.com/djberg96/sys-admin
 
-== License
+## License
 Apache-2.0
 
-== Copyright
+## Copyright
 (C) 2005-2020, Daniel J. Berger
 All Rights Reserved
 
-== Author
+## Author
 Daniel J. Berger

data/Rakefile

@@ -1,17 +1,17 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 require 'rbconfig'
 
-CLEAN.include("**/*.gem", "**/*.rbx", "**/*.rbc", "ruby.core")
+CLEAN.include("**/*.gem", "**/*.rbx", "**/*.rbc", "ruby.core", "**/*.lock")
 
 namespace :gem do
   desc "Create the sys-uname gem"
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('sys-admin.gemspec'))
+    spec = Gem::Specification.load('sys-admin.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the sys-uname gem"
@@ -21,27 +21,22 @@ namespace :gem do
   end
 end
 
-Rake::TestTask.new('test') do |t|
+desc "Run the specs for the sys-admin library"
+RSpec::Core::RakeTask.new(:spec) do |t|
   case RbConfig::CONFIG['host_os']
   when /darwin|osx/i
-    t.libs << 'lib/darwin'
+    t.rspec_opts = '-Ilib/darwin'
   when /linux/i
-    t.libs << 'lib/linux'
+    t.rspec_opts = '-Ilib/linux'
   when /sunos|solaris/i
-    t.libs << 'lib/sunos'
+    t.rspec_opts = '-Ilib/sunos'
   when /bsd/i
-    t.libs << 'lib/bsd'
+    t.rspec_opts = '-Ilib/bsd'
   when /windows|win32|mingw|cygwin|dos/i
-    t.libs << 'lib/windows'
+    t.rspec_opts = '-Ilib/windows'
   else
-    t.libs << 'lib/unix'
+    t.rspec_opts = '-Ilib/unix'
   end
-
-  t.warning = true
-  t.verbose = true
-
-  t.libs << 'test'
-  t.test_files = FileList['test/test_sys_admin.rb']
 end
 
-task :default => :test
+task :default => :spec

data/lib/bsd/sys/admin.rb

@@ -6,10 +6,9 @@ require 'rbconfig'
 
 module Sys
   class Admin
-    private
-
     # :no-doc:
     BUF_MAX = 65536 # Max buffer for retry
+    private_constant :BUF_MAX
 
     # I'm making some aliases here to prevent potential conflicts
     attach_function :open_c, :open, [:string, :int], :int
@@ -22,8 +21,7 @@ module Sys
     attach_function :getgrnam_r, [:string, :pointer, :pointer, :size_t, :pointer], :int
     attach_function :getgrgid_r, [:long, :pointer, :pointer, :size_t, :pointer], :int
 
-    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r, :getgrnam_r
-    private_class_method :getgrgid_r
+    private_class_method :getlogin_r, :getpwnam_r, :getpwuid_r, :getgrnam_r, :getgrgid_r
     private_class_method :open_c, :pread_c, :close_c
 
     # struct passwd from /usr/include/pwd.h
@@ -48,6 +46,8 @@ module Sys
       layout(*fields)
     end
 
+    private_constant :PasswdStruct
+
     # struct group from /usr/include/grp.h
     class GroupStruct < FFI::Struct
       layout(
@@ -58,6 +58,8 @@ module Sys
       )
     end
 
+    private_constant :GroupStruct
+
     # I'm blending the timeval struct in directly here
     class LastlogStruct < FFI::Struct
       layout(
@@ -67,7 +69,7 @@ module Sys
       )
     end
 
-    public
+    private_constant :LastlogStruct
 
     # Returns the login for the current process.
     #
@@ -192,8 +194,6 @@ module Sys
       groups
     end
 
-    private
-
     # Takes a GroupStruct and converts it to a Group object.
     def self.get_group_from_struct(grp)
       Group.new do |g|
@@ -204,6 +204,8 @@ module Sys
       end
     end
 
+    private_class_method :get_group_from_struct
+
     # Takes a UserStruct and converts it to a User object.
     def self.get_user_from_struct(pwd)
       user = User.new do |u|
@@ -230,6 +232,8 @@ module Sys
       user
     end
 
+    private_class_method :get_user_from_struct
+
     # Get lastlog information for the given user.
     def self.get_lastlog_info(uid)
       logfile = '/var/log/lastlog'
@@ -252,5 +256,7 @@ module Sys
 
       lastlog
     end
+
+    private_class_method :get_lastlog_info
   end
 end