sys-admin 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd8a632a7bc840cae58cdd7785e2501581b43c41630937f5a63ae5469564eb3
-  data.tar.gz: 5b60547b6032b02f07e44681f2c0ff4a3235baa3183a91f8a58388c82211c31e
+  metadata.gz: ed8265d7faf748f05d74e14aeef599e1e9101d5480d10c282f5c731b56281f2b
+  data.tar.gz: eaca7073f23fc715de53c8a0fc6487390add8f05253f1834f1df9be7b0b0126c
 SHA512:
-  metadata.gz: 1102939c04babc0b7dfacd9c4e6dea17206d0407b432dd8dd8cae377663dfc3ecd2f1a48933bbc2b9c78516656e9e2fc7cb7e46a2e970b35396ff118ebf8b1fe
-  data.tar.gz: c8574438594e1ea2096fce59cafcce9319652ac43e22a98e5d47692109d0ed0fde1e0a2e4706843dd61c048a9913348307c531cce0d84c4a11da70e4d1980a22
+  metadata.gz: 3a49546596e70769a87c1d9833605959e2a3652ae06bc62349feddb56a1e7d6925f2abfab9bb8d122c8cbe4086b83ba27d65bb438583841e8dea52a72af4ac21
+  data.tar.gz: 85f6523a0390542e60d0c63c3954961c4218487db29ca40a9b4c2f35bf3be228d2eec5969f5bc1df091a6d263249caa271484b26dceb4ff39684c5c566df98d8

data/{CHANGES → CHANGES.rdoc}

@@ -1,3 +1,8 @@
+== 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.

data/{MANIFEST → MANIFEST.rdoc}

@@ -1,8 +1,8 @@
 * sys-admin.gemspec
-* CHANGES
-* MANIFEST
+* CHANGES.rdoc
+* MANIFEST.rdoc
 * Rakefile
-* README
+* README.rdoc
 * certs/djberg96_pub.pem
 * examples/groups.rb
 * examples/users.rb

data/README.rdoc

@@ -0,0 +1,153 @@
+== Description
+The sys-admin library is a unified, cross platform replacement for the Etc module.
+   
+== Installation
+  gem install sys-admin
+
+== Synopsis
+  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

data/lib/sys/admin.rb

@@ -1,7 +1,7 @@
 module Sys
   class Admin
     # The version of the sys-admin library.
-    VERSION = '1.7.2'.freeze
+    VERSION = '1.7.3'.freeze
   end
 end
 

data/sys-admin.gemspec

@@ -3,7 +3,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-admin'
-  spec.version    = '1.7.2'
+  spec.version    = '1.7.3'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
+  spec.extra_rdoc_files = Dir['*.rdoc']
 	
   spec.add_dependency('ffi', '>= 1.1.0')
 

data/test/test_sys_admin.rb

@@ -14,7 +14,7 @@ end
 
 class TC_Sys_Admin_All < Test::Unit::TestCase
   test "version is set to expected value" do
-    assert_equal('1.7.2', Sys::Admin::VERSION)
+    assert_equal('1.7.3', Sys::Admin::VERSION)
   end
 
   test "version constant is frozen" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-admin
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -89,25 +89,21 @@ email: djberg96@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGES
-- README
-- MANIFEST
+- CHANGES.rdoc
+- MANIFEST.rdoc
+- README.rdoc
 files:
-- CHANGES
 - test
 - test/test_sys_admin_unix.rb
-- test/test_sys_admin.rb
 - test/test_sys_admin_windows.rb
-- sys-admin.gemspec
+- test/test_sys_admin.rb
 - examples
 - examples/example_groups.rb
 - examples/example_users.rb
 - doc
 - doc/sys-admin-windows.txt
 - doc/sys-admin-unix.txt
-- README
 - Rakefile
-- MANIFEST
 - lib
 - lib/windows
 - lib/windows/sys
@@ -129,12 +125,16 @@ files:
 - lib/unix/sys
 - lib/unix/sys/admin.rb
 - lib/sys
-- lib/sys/admin.rb
 - lib/sys/admin
 - lib/sys/admin/custom.rb
 - lib/sys/admin/common.rb
+- lib/sys/admin.rb
 - certs
 - certs/djberg96_pub.pem
+- CHANGES.rdoc
+- MANIFEST.rdoc
+- README.rdoc
+- sys-admin.gemspec
 homepage: http://www.github.com/djberg96/sys-admin
 licenses:
 - Apache-2.0
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A unified, cross platform replacement for the "etc" library.

data/README

@@ -1,148 +0,0 @@
-== Description
-  The sys-admin library is a unified, cross platform replacement for the Etc module.
-   
-== Installation
-  gem install sys-admin
-
-== Synopsis
-  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-2019, Daniel J. Berger
-  All Rights Reserved
-
-== Author
-  Daniel J. Berger