simple-unix-users 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple-unix-users.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Keith R. Bennett
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# SimpleUnixUsers
+
+Reads and parses user information from /etc/passwd or a specified
+filespec, and provides simple operations on the collection of users,
+and individual users.
+
+This code was written as an example of something Ruby could be useful
+for when administering a Unix system.
+
+It's just a starting point, and lacks necessary error checking and
+polish.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple-unix-users'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-unix-users
+:w
+
+## Usage
+
+```ruby
+require 'simple-unix-users'
+
+users = Users.new
+# or
+users = Users.new('my-test-passwd-file')
+```
+
+Then you can use the services provided by the Users and User classes.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple-unix-users.rb

@@ -0,0 +1,22 @@
+require "simple-unix-users/version"
+
+if /darwin/ === RUBY_PLATFORM
+  $stderr.puts "
+
+A message from the simple-unix-users gem...
+
+Although simple-unix-users will read a passwd file on Mac OS,
+it is not guaranteed to work correctly.  In addition, according to the Mac's
+/etc/passwd file:
+
+# Note that this file is consulted directly only when the system is running
+# in single-user mode.  At other times this information is provided by
+# Open Directory.
+
+"
+end
+
+module SimpleUnixUsers
+  require_relative 'simple-unix-users/user'
+  require_relative 'simple-unix-users/users'
+end

data/lib/simple-unix-users/user.rb

@@ -0,0 +1,40 @@
+# This class is for illustrative purposes and lacks necessary error handling.
+
+# Stores state, and provides some useful behavior, relating to a given user.
+class User
+
+  attr_accessor :name, :dummy_pw, :uid, :gid, :personal_data, :home_dir, :shell
+
+  NULL_SHELL     = '/bin/false'
+  NULL_HOME_DIR  = '/nonexistent'
+
+  def initialize(line)
+    @name, @dummy_pw, @uid, @gid, p_data, @home_dir, @shell = line.chomp.split(':')
+    @personal_data = p_data.split(',')
+  end
+
+  def uid_number
+    uid.to_i
+  end
+
+  def gid_number
+    gid.to_i
+  end
+
+  def home_dir_size_in_mb
+    `du -sm #{home_dir}`.to_i
+  end
+
+  def has_shell?
+    shell != NULL_SHELL
+  end
+
+  def has_home_dir?
+     home_dir != NULL_HOME_DIR
+  end
+
+  def groups
+    `groups #{name}`.chomp.split(':').last.strip.split(' ')
+  end
+
+end

data/lib/simple-unix-users/users.rb

@@ -0,0 +1,78 @@
+require_relative 'user'
+
+# This class is for illustrative purposes and lacks necessary error handling.
+
+# Manages a collection of users (instances of class 'User'),
+# optionally loaded from /etc/passwd.
+class Users < Array
+
+  # Reads the user information from the passwd file, and returns
+  # a Users instance.
+  def self.from_passwd_file(filespec = '/etc/passwd')
+    file_lines = File.readlines(filespec)
+    non_comment_lines = file_lines.reject { |line| /^#/ === line }
+    Users.new(non_comment_lines)
+  end
+
+  # Constructor; takes an array of passwd-formatted lines, or
+  # User instances, or any combination thereof.
+  def initialize(array)
+    array.each do |element|
+      user = element.is_a?(String) ? User.new(element) : element
+      self << user
+    end
+  end
+
+  # Methods that will return arrays of field objects (e.g. names).
+  def names;          self.map(&:name)          end
+  def uids;           self.map(&:uid)           end
+  def gids;           self.map(&:gid)           end
+  def personal_datas; self.map(&:personal_data) end
+  def home_dirs;      self.map(&:home_dir)      end
+  def shells;         self.map(&:shell)         end
+
+  def uid_numbers;    self.map(&:uid_number)    end
+  def gid_numbers;    self.map(&:gid_number)    end
+
+  # Returns a new instance of Users containing only those users
+  # whose shell is not '/bin/false'.
+  def having_shell
+    Users.new(select { |user| user.has_shell? })
+  end
+
+  def having_shell_of(shell)
+    Users.new(select { |user| user.shell == shell })
+  end
+
+  def not_having_shell
+    Users.new(self - having_shell)
+  end
+
+  def having_home_dir
+    Users.new(select { |user| user.has_home_dir? })
+  end
+
+  def not_having_home_dir
+    Users.new(select { |user| ! user.has_home_dir? })
+    # or, less efficiently: Users.new(self - having_home_dir)
+  end
+
+  # Returns a new Users instance consisting only of
+  # those users having the specified group id.
+  def having_gid(gid)
+    gid = (gid.is_a?(Fixnum) ? gid.to_s : gid)
+    filtered_array = (select { |user| user.gid == gid })
+    Users.new(filtered_array)
+  end
+
+  def find_by_name(name)
+    detect { |user| user.name == name }
+  end
+
+  def find_by_uid(uid)
+    uid = uid.is_a?(String) ? uid : uid.to_s
+    detect { |user| user.uid == uid }
+  end
+end
+
+

data/lib/simple-unix-users/version.rb

@@ -0,0 +1,3 @@
+module SimpleUnixUsers
+  VERSION = "0.0.1"
+end

data/simple-unix-users.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple-unix-users/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple-unix-users"
+  gem.version       = SimpleUnixUsers::VERSION
+  gem.authors       = ["Keith R. Bennett"]
+  gem.email         = ["keithrbennett@gmail.com"]
+  gem.description   = %q{
+Reads and parses user information from /etc/passwd or a specified
+filespec, and provides simple operations on the collection of users,
+and individual users.
+ }
+  gem.summary       = %q{Manages Unix user information based on the content of /etc/passwd.}
+  gem.homepage      = "https://github.com/keithrbennett/simple-unix-users"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/simple-unix-users/passwd-sample

@@ -0,0 +1,38 @@
+root:x:0:0:root:/root:/bin/bash
+daemon:x:1:1:daemon:/usr/sbin:/bin/sh
+bin:x:2:2:bin:/bin:/bin/sh
+sys:x:3:3:sys:/dev:/bin/sh
+sync:x:4:65534:sync:/bin:/bin/sync
+games:x:5:60:games:/usr/games:/bin/sh
+man:x:6:12:man:/var/cache/man:/bin/sh
+lp:x:7:7:lp:/var/spool/lpd:/bin/sh
+mail:x:8:8:mail:/var/mail:/bin/sh
+news:x:9:9:news:/var/spool/news:/bin/sh
+uucp:x:10:10:uucp:/var/spool/uucp:/bin/sh
+proxy:x:13:13:proxy:/bin:/bin/sh
+www-data:x:33:33:www-data:/var/www:/bin/sh
+backup:x:34:34:backup:/var/backups:/bin/sh
+list:x:38:38:Mailing List Manager:/var/list:/bin/sh
+irc:x:39:39:ircd:/var/run/ircd:/bin/sh
+gnats:x:41:41:Gnats Bug-Reporting System (admin):/var/lib/gnats:/bin/sh
+nobody:x:65534:65534:nobody:/nonexistent:/bin/sh
+libuuid:x:100:101::/var/lib/libuuid:/bin/sh
+syslog:x:101:103::/home/syslog:/bin/false
+messagebus:x:102:105::/var/run/dbus:/bin/false
+colord:x:103:108:colord colour management daemon,,,:/var/lib/colord:/bin/false
+whoopsie:x:105:114::/nonexistent:/bin/false
+avahi-autoipd:x:106:117:Avahi autoip daemon,,,:/var/lib/avahi-autoipd:/bin/false
+avahi:x:107:118:Avahi mDNS daemon,,,:/var/run/avahi-daemon:/bin/false
+usbmux:x:108:46:usbmux daemon,,,:/home/usbmux:/bin/false
+kernoops:x:109:65534:Kernel Oops Tracking Daemon,,,:/:/bin/false
+pulse:x:110:119:PulseAudio daemon,,,:/var/run/pulse:/bin/false
+rtkit:x:111:122:RealtimeKit,,,:/proc:/bin/false
+speech-dispatcher:x:112:29:Speech Dispatcher,,,:/var/run/speech-dispatcher:/bin/sh
+hplip:x:113:7:HPLIP system user,,,:/var/run/hplip:/bin/false
+saned:x:114:123::/home/saned:/bin/false
+haldaemon:x:115:125:Hardware abstraction layer,,,:/var/run/hald:/bin/false
+mdm:x:116:128:MDM Display Manager:/var/lib/mdm:/bin/false
+kbennett:x:1000:1000:Keith Bennett,,,:/home/kbennett:/usr/bin/zsh
+sshd:x:104:65534::/var/run/sshd:/usr/sbin/nologin
+mysql:x:117:129:MySQL Server,,,:/nonexistent:/bin/false
+postgres:x:118:130:PostgreSQL administrator,,,:/var/lib/postgresql:/bin/bash

data/spec/simple-unix-users/user_spec.rb

@@ -0,0 +1,41 @@
+require 'rspec'
+
+require_relative '../../lib/simple-unix-users/user'
+
+describe User do
+
+subject { User.new( 'kbennett:x:1000:1000:Keith Bennett,,,:/home/kbennett:/usr/bin/zsh') }
+
+it 'should create correctly from the passwd line' do
+  subject.class.should == User
+end
+
+it 'should create fields correctly' do
+  subject.name.should == 'kbennett'
+  subject.uid.should == '1000'
+  subject.gid.should == '1000'
+  subject.personal_data.first.should == 'Keith Bennett'
+  subject.home_dir.should == '/home/kbennett'
+  subject.shell.should == '/usr/bin/zsh'
+end
+
+it 'should detect an existing home correctly' do
+  subject.has_home_dir?.should be_true
+end
+
+it 'should detect a nonexistent home correctly' do
+  subject.home_dir = User::NULL_HOME_DIR
+  subject.has_home_dir?.should be_false
+end
+
+it 'should calculate uid_number correctly' do
+  subject.uid_number.should == subject.uid.to_i
+end
+
+it 'should calculate gid_number correctly' do
+  subject.gid_number.should == subject.gid.to_i
+end
+
+end
+
+

data/spec/simple-unix-users/users_spec.rb

@@ -0,0 +1,79 @@
+require 'rspec'
+
+require_relative '../../lib/simple-unix-users/users.rb'
+
+describe Users do
+
+subject { Users.from_passwd_file(File.join(File.dirname(__FILE__), 'passwd-sample')) }
+
+it 'should load a list of users' do
+  subject.should be_a Array
+  subject.should_not be_empty
+end
+
+it 'should return a list of names for the names function' do
+  names = subject.names.sort
+  names.sort.uniq.size.should > 1
+end
+
+it 'should be able to get uids as numbers' do
+  uid_numbers = subject.uid_numbers
+  uid_numbers.should_not be_empty
+  uid_numbers.first.should be_a(Fixnum)
+end
+
+it 'should be able to get gids as numbers' do
+  gid_numbers = subject.gid_numbers
+  gid_numbers.should_not be_empty
+  gid_numbers.first.should be_a(Fixnum)
+end
+
+it 'should be able to get the field objects arrays' do
+  [:names, :uids, :gids, :personal_datas, :home_dirs, :shells].each do |field|
+    array = subject.send(field)
+    array.size.should == subject.size
+  end
+end
+
+it 'should calculate having_shell correctly' do
+  num_with_shell = subject.inject(0) do |num, user|
+    num += 1 if user.has_shell?
+    num
+  end
+  subject.having_shell.size.should == num_with_shell
+  subject.not_having_shell.size.should == (subject.size - num_with_shell)
+end
+
+it 'should correctly include users in having_shell_of' do
+  first_user = subject.first
+  subject.having_shell_of(first_user.shell).should include(first_user)
+  subject.having_shell_of('ja;ksdfja;sdfkajsdf;k').should_not include(first_user)
+end
+
+it 'should correctly include users in having_home and not_having_home' do
+  user_with_home_dir = subject.detect { |user| user.has_home_dir? }
+  subject.having_home_dir.should include(user_with_home_dir)
+  subject.not_having_home_dir.should_not include(user_with_home_dir) 
+end
+
+it 'should correctly find users with having_gid' do
+  first_gid = subject.first.gid
+  having_first_gid = subject.having_gid(first_gid)
+  having_first_gid.should include(subject.first)
+  
+  first_user_with_different_gid = subject.detect { |user| user.gid != first_gid }
+  having_first_gid.should_not include(first_user_with_different_gid)
+end
+
+it 'should find_by_name correctly' do
+  last_user = subject.last
+  subject.find_by_name(last_user.name).should == last_user
+end
+
+it 'should find_by_uid correctly' do
+  last_user = subject.last
+  subject.find_by_uid(last_user.uid).should == last_user
+end
+
+end
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: simple-unix-users
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Keith R. Bennett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-15 00:00:00.000000000 Z
+dependencies: []
+description: ! "\nReads and parses user information from /etc/passwd or a specified\nfilespec,
+  and provides simple operations on the collection of users,\nand individual users.\n "
+email:
+- keithrbennett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple-unix-users.rb
+- lib/simple-unix-users/user.rb
+- lib/simple-unix-users/users.rb
+- lib/simple-unix-users/version.rb
+- simple-unix-users.gemspec
+- spec/simple-unix-users/passwd-sample
+- spec/simple-unix-users/user_spec.rb
+- spec/simple-unix-users/users_spec.rb
+homepage: https://github.com/keithrbennett/simple-unix-users
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Manages Unix user information based on the content of /etc/passwd.
+test_files:
+- spec/simple-unix-users/passwd-sample
+- spec/simple-unix-users/user_spec.rb
+- spec/simple-unix-users/users_spec.rb