netid-tools 0.3.0 → 0.3.1

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem "nokogiri"
-
+gem "colored"
 group :development do
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"

data/LICENSE.txt

@@ -1,20 +1,3 @@
-Copyright (c) 2012 Nikky Southerland
+This software is licensed under the Apache License, Version 2.0.
 
-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.
+http://www.apache.org/licenses/LICENSE-2.0

data/README.md

@@ -1,6 +1,136 @@
-UA Tools
-=================
+NetID Tools
+===========
 
-Collect of tools for interacting and using the Uniform Access systems. These
-are all under various forms of construction, so there won't be further documentation
-until I get them in a somewhat stable state and stop adding features.
+NetID Tools is a Ruby Gem that contains various methods for supporting Uniform Access computing at the University of Washington. These are mainly methods that I've found useful to create during the course of my job, but may be useful to others as well.
+
+Currently the focus is on finding and displaying information on any MySQL database server(s) that users may be running, as well as highlight potential quota issues. 
+
+## Usage Notes
+
+* Using keybased SSH authentication is highly recommended, both from your system->UA, and for UA->UA.
+* You may need membership of certain Unix Groups in order to run some of these checks.
+
+## Dependencies
+
+* Ruby 1.9
+* Nokogiri
+* Colored
+
+Executables
+===========
+
+`ua_check` is provided as an included executable.
+
+## Example
+
+	nikky@uvb76:~/Repositories/www ☿  on default at tip % ua_check nikky
+	Running UA Check for NetID nikky on behalf of nikky
+
+	MySQLd detected on ovid02.u.washington.edu:5280
+	/ov03/d20/nikky
+
+	Disk quotas for nikky (uid 247520):
+	Filesystem        Usage      Quota      Limit       Grace   Files  Limit
+	/cg32a           15.574   5120.000   105120.0                 219  10000
+	/da21            17.523   1937.254     5370.0                1535  10000
+	etc
+
+Methods
+=======
+
+## Netid#validate_netid?(netid)
+
+### What it does
+
+This class method will return a true/false depending on if a given string could potentially be a NetID. It does not check to see if the NetID exists; only if a NetID has a valid structure. Namely:
+
+* 1-8 Characters in length
+* First character is *not* a number
+* Only a word characters [a-zA-Z0-9]
+
+### Example
+
+	>> require 'netid-tools'
+	=> true
+	>> Netid.validate_netid?("nikky")
+	=> true
+	>> Netid.validate_netid?("1nikky")
+	=> false
+	>> Netid.validate_netid?("1nikky111")
+	=> false
+	>> Netid.validate_netid?("nikky@1")
+	=> false
+
+## Netid#check_for_mysql_presence(host,user,system_user)
+
+### What it does
+
+This class method will check to see if a specific NetID is running a MySQL instance on a specified host. It will return false if no MySQL server is found, and return [host,port] if true.
+
+### Method variables
+
+#### host
+
+The FQDN of the server you want to check for MySQL
+
+#### user
+
+The NetID you want to check
+
+#### system_user
+
+*Your* NetID, required for login to the host.
+
+### Example
+
+	>> Netid.check_for_mysql_presence("ovid02.u.washington.edu","nikky","nikky")
+	=> ["ovid02.u.washington.edu", "5280"]
+
+## Netid#check_for_localhome(user,system_user)
+
+### What it does
+
+Checks to see if a user has a localhome, and if they do, return the location.
+
+### Method variables
+
+#### user
+
+The NetID you want to check
+
+#### system_user
+
+*Your* NetID, required for login to the host.
+
+### Example
+
+	>> Netid.check_for_localhome("nikky","nikky")
+	=> "/ov03/d20/nikky"
+
+## Netid#quota_check(user,system_user)
+
+### What it does
+
+Spits out various quota information, and highlights a line in red if a user is over quota. This writes directly to stdout.
+
+### Method variables
+
+#### user
+
+The NetID you want to check
+
+#### system_user
+
+*Your* NetID, required for login to the host.
+
+Version History
+===============
+
+## 0.3.1
+
+* Initial documented release
+* Swich to Apache License
+
+## 0.3.0
+
+Initial release

data/Rakefile

@@ -16,13 +16,13 @@ Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "netid-tools"
   gem.homepage = "http://github.com/allynfolksjr/netid-tools"
-  gem.license = "MIT"
+  gem.license = "Apache License, Version 2.0"
   gem.summary = %Q{Gem with various methods to support UW NetIDs}
   gem.description = %Q{Gem with various methods to support UW NetIDs}
   gem.email = "nikky@uw.edu"
   gem.authors = ["Nikky Southerland"]
   gem.add_dependency 'nokogiri'
- # gem.add_dependency 'colored'
+  gem.add_dependency 'colored'
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/netid-tools.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "netid-tools"
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nikky Southerland"]
+  s.date = "2012-12-13"
+  s.description = "Gem with various methods to support UW NetIDs"
+  s.email = "nikky@uw.edu"
+  s.executables = ["ua_check"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/ua_check",
+    "lib/netid-tools.rb",
+    "netid-tools.gemspec",
+    "test/helper.rb",
+    "test/test_netid-tools.rb"
+  ]
+  s.homepage = "http://github.com/allynfolksjr/netid-tools"
+  s.licenses = ["Apache License, Version 2.0"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Gem with various methods to support UW NetIDs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<colored>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<colored>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<colored>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<colored>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<colored>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<colored>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netid-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +139,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem with various methods to support UW NetIDs
 email: nikky@uw.edu
 executables:
@@ -134,18 +166,18 @@ extra_rdoc_files:
 files:
 - .document
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
 - bin/ua_check
 - lib/netid-tools.rb
+- netid-tools.gemspec
 - test/helper.rb
 - test/test_netid-tools.rb
 homepage: http://github.com/allynfolksjr/netid-tools
 licenses:
-- MIT
+- Apache License, Version 2.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -156,6 +188,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1235800762409252497
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/Gemfile.lock

@@ -1,46 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.2.9)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    bourne (1.1.2)
-      mocha (= 0.10.5)
-    git (1.2.5)
-    i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.7.5)
-    metaclass (0.0.1)
-    mocha (0.10.5)
-      metaclass (~> 0.0.1)
-    multi_json (1.5.0)
-    nokogiri (1.5.5)
-    rake (10.0.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    shoulda (3.3.2)
-      shoulda-context (~> 1.0.1)
-      shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.1)
-    shoulda-matchers (1.4.2)
-      activesupport (>= 3.0.0)
-      bourne (~> 1.1.2)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  jeweler (~> 1.8.4)
-  nokogiri
-  rdoc (~> 3.12)
-  shoulda
-  simplecov