sys-admin 1.8.0-universal-mingw32

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da216caeef1d2038bbbeace7ed087e6835ec210870a34f89653945ffa2245b72
+  data.tar.gz: 7c36e9ed782cb6be87cdc69cd94ff3c06894afb96cc54fa3db1af06fa48499dc
+SHA512:
+  metadata.gz: 6ad2079f20c0d05e4d9d6efac82e560d88f6c78a248131135c7e1455ef02d84bbf0dc628a5913a21689c888be614f5b30b7ce4ab61c63bb9a77c6c44a174420c
+  data.tar.gz: b564a7e2cf651b86ecb08084b13813a33ac199707292fc56f7b3daad770cdd150358b7110dfb53c2913864ebb5d9ec25f1bcac30828c140748fcabfc59f8152f

data/CHANGES.md

@@ -0,0 +1,204 @@
+## 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 Winodws 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
+* Fixed the license name, was missing a hyphen.
+* Fixed the homepage in the gemspec.
+
+## 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
+* 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
+* 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
+* The Admin#get_group method now handles groups with very large numbers
+  of members more robustly.
+
+## 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
+* 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.
+* Modified the Admin.configure_user method so that you don't need to know the
+  old password. Just pass a single string argument for the new password.
+* Fixed a potential encoding issue for the Admin.get_login method on JRuby.
+* Updated the gem:create task in the Rakefile.
+* Added rake as a development dependency.
+
+## 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.
+* Because all code is now pure Ruby, there is longer any need for two
+  separate gems. There is now a single, unified gem that works on all
+  supported platforms.
+
+## 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
+* 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.
+* Fixed a bug in the User.get_login and User.get_group methods where the query
+  being generated was incorrect if no options were passed. Thanks go to
+  Matthew Brown for the spot.
+
+## 1.5.4 - 7-Oct-2010
+* Prefer the getlastlogx() function over lastlog() where supported.
+
+## 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
+* Now compatible with Ruby 1.9.x.
+* Added test-unit as a development dependency.
+
+## 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.
+  Previously only the Admin.get_user method set it.
+* Added win32-security as a dependency.
+* Changed license to Artistic 2.0.
+
+## 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.
+* 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
+  be found.
+
+## 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
+* 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
+  broke out of the block before it terminated.
+* The AdminError class is now Admin::Error.
+* Some internal directory layout changes.
+
+## 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
+  underlying C code.
+* Removed the install.rb file. The logic in that file has been moved directly
+  into the Rakefile.
+
+## 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
+* 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.
+* Added corresponding tests.
+* Added much more inline documentation.
+* Major refactoring of the get_lastlog_info helper function in admin.h.  This
+  fixed a major bug in some flavors of Linux where the Admin.users method
+  could go into an infinite loop.  It also fixed some minor bugs where console
+  and host values were sometimes filled with junk characters.
+* Added the User#change attribute, and a check for the pw_change struct member
+  in the extconf.rb file.
+* The User#expire attribute is now handled as a Time object instead of an
+  integer.
+* Renamed tc_win32.rb to tc_windows.rb
+
+## 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
+* 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
+* 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
+  now an attribute of a Group object.  The issue was forced by WMI.
+* The default for users and groups on Win32 systems is now local rather than
+  global.  See the documentation for why you probably don't want to iterate
+  over global accounts.
+* Corresponding doc changes and test suite changes.
+
+## 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.
+* Added lastlog information tothe User class (Unix).
+* Modified the way User objects are created internally (Unix).
+* Fixed a bug in the User#shell attribute (Unix).
+
+## 1.0.0 - 25-Mar-2005
+* Initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/MANIFEST.md

@@ -0,0 +1,20 @@
+* sys-admin.gemspec
+* CHANGES.md
+* LICENSE
+* MANIFEST.md
+* README.md
+* Gemfile
+* Rakefile
+* certs/djberg96_pub.pem
+* examples/groups.rb
+* examples/users.rb
+* lib/sys/admin.rb
+* lib/darwin/sys/admin.rb
+* lib/linux/sys/admin.rb
+* lib/bsd/sys/admin.rb
+* lib/sunos/sys/admin.rb
+* lib/sys/admin/common.rb
+* lib/sys/admin/custom.rb
+* test/test_sys_admin.rb
+* test/test_sys_admin_unix.rb
+* test/test_sys_admin_windows.rb

data/README.md

@@ -0,0 +1,162 @@
+## Description
+The sys-admin library is a unified, cross platform replacement for the Etc module.
+   
+## 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
+```ruby
+require 'sys/admin' # or sys-admin
+include Sys
+
+# Returns an Array of User objects
+a = Admin.users
+
+# 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 group
+p Admin.get_group("adm")
+p Admin.get_group("adm", :localaccount => true)
+```
+
+## Admin
+  `Admin.get_login`
+
+Returns the user name (only) of the current login.
+
+```
+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'.
+   
+```
+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 = {})`
+
+Returns an Array of Group objects.
+
+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 = {})`
+
+Returns an Array of User objects.
+   
+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)
+The User class has the following attributes on MS Windows systems:
+	
+  * account_type
+  * caption
+  * description
+  * domain
+  * password
+  * full_name
+  * gid
+  * install_date
+  * name
+  * sid
+  * status
+  * disabled?
+  * local?
+  * lockout?
+  * password_changeable?
+  * password_expires?
+  * password_required?
+  * uid
+     
+### User (Unix)
+The User class has the following attributes on Unix systems:
+	
+  * name
+  * passwd
+  * uid
+  * gid
+  * dir
+  * shell
+  * gecos
+  * quota
+  * age
+  * class
+  * comment
+  * change
+  * expire
+
+## Group Classes
+### Group (Windows)
+The Group class has the following attributes on MS Windows systems:
+	
+  * caption
+  * description
+  * domain
+  * install_date
+  * name
+  * sid
+  * status
+  * gid
+  * local?
+	
+### Group (Unix)
+The Group class has the following attributes on Unix systems:
+	
+  * name
+  * gid
+  * members
+  * passwd
+
+## Error Classes
+`Admin::Error < StandardError`
+
+Raised if anything goes wrong with any of the above methods.
+
+## 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
+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
+* Make the User and Group objects comparable.
+* 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 page at:
+
+  https://github.com/djberg96/sys-admin
+
+## License
+Apache-2.0
+
+## Copyright
+(C) 2005-2020, Daniel J. Berger
+All Rights Reserved
+
+## Author
+Daniel J. Berger