hostinfo 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 abrader
+
+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.rdoc

@@ -0,0 +1,17 @@
+= hostinfo
+
+A library with simplified methods for retrieving pertinent system information
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 abrader. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'rake'
+
+GEM = "hostinfo"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = GEM
+    gem.summary = %Q{Simplified methods for retrieving system information}
+    gem.description = %Q{Provides simple methods for retreiving user, system, and network information}
+    gem.email = "andrew@brader.us"
+    gem.homepage = "http://github.com/abrader/hostinfo"
+    gem.authors = ["abrader"]
+    gem.add_dependency "ohai", "<=0.5.6"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.require_path = 'lib'
+    gem.rubyforge_project = "nowarning"
+    gem.has_rdoc = true
+    gem.platform = Gem::Platform::RUBY
+    gem.files = %w(LICENSE README.rdoc Rakefile) + Dir.glob("{docs,lib,spec}/**/*")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/lib/hostinfo.rb

@@ -0,0 +1,191 @@
+require 'ohai'
+require 'resolv'
+
+class HostInfo
+  
+  @hst = Ohai::System.new
+  @hst.all_plugins
+  @hst_os = @hst[:platform]
+
+  # Returns string of shortened OS type
+  def self.os()
+    return @hst_os
+  end
+	
+	# Returns string of verbose OS type
+  def self.os_long()
+    os_long = case @hst_os
+      when "fedora" then self.first_line("/etc/fedora-release")
+      when "redhat" then self.first_line("/etc/redhat-release")
+      when "centos" then self.first_line("/etc/redhat-release")
+      when "debian" then self.debissue()
+      when "ubuntu" then self.ubuissue()
+      when "mac_os_x" then "Mac OS X Version " + self.version()
+    end
+    return os_long
+  end
+
+  # Returns string of the numerical version of the OS (unless Debian or Ubuntu)
+  def self.version()
+    ver = case @hst_os
+      when "fedora" then self.os_long().split(" ")[2]
+      when "centos" then self.os_long().split(" ")[2]
+      when "redhat" then self.os_long().split(" ")[2]
+      when "debian" then self.os_long().split(" ")[2]
+      when "ubuntu" then self.os_long().split(" ")[1]
+      when "mac_os_x" then @hst[:platform_version]
+    end
+    return ver 
+  end
+  
+  # Returns string of fully qualified domain name for host
+  def self.hostname()
+    return @hst[:fqdn]
+  end
+  
+  # Returns string containing the domain name of the host
+  def self.domain()
+    return @hst[:domain]
+  end
+  
+  # Returns string containing default network interface
+  def self.default_network_interface()
+    begin
+      return interface = @hst[:network][:default_interface]
+    rescue
+      return nil
+    end
+  end
+  
+  # Returns string containing IPv4 address.  If interface is not passed as an argument, method assumes primary interface.
+  def self.ipv4(interface=nil)
+    interface = self.default_network_interface() unless interface != nil
+    if interface.nil? then return nil end
+      
+      begin
+        ipv4addr_array = Array.new
+        output_array = Array.new
+        @hst[:network][:interfaces][interface][:addresses].each_key do |key|
+          if key[Resolv::IPv4::Regex] != nil
+            ipv4addr_array << key 
+          end
+        end
+
+        if ipv4addr_array.nil? then return nil end
+
+        ipv4addr_array.each do |ipv4ip|
+          if (@hst[:network][:interfaces][interface][:addresses][ipv4ip][:family] == "inet")
+            output_array << ipv4ip
+          end
+        end
+        return output_array
+      rescue
+        return nil
+      end
+  end
+  
+  # Returns string containing IPv6 address.  If interface is not passed as an argument, method assumes primary interface.
+  def self.ipv6(interface=nil)
+    interface = self.default_network_interface() unless interface != nil
+    if interface.nil? then return nil end
+
+    begin
+      ipv6addr_array = Array.new
+      output_array = Array.new
+      @hst[:network][:interfaces][interface][:addresses].each_key do |key|
+        if key[Resolv::IPv6::Regex] != nil
+          ipv6addr_array << key 
+        end
+      end
+      
+      if ipv6addr_array.nil? then return nil end
+        
+      ipv6addr_array.each do |ipv6ip|
+        if (@hst[:network][:interfaces][interface][:addresses][ipv6ip][:family] == "inet6")
+          output_array << ipv6ip
+        end
+      end
+      return output_array
+    rescue
+      return nil
+    end
+  end
+  
+  # Returns string containing the netmask for a particular network interface.  If interface is not passed as an argument, method assumes primary interface.
+  def self.netmask(interface=nil)
+    interface = self.default_network_interface() unless interface != nil
+    if interface.nil? then return nil end
+    
+    begin
+      ipaddr = self.ipv4(interface)
+      return @hst[:network][:interfaces][interface][:addresses][ipaddr][:netmask]
+    rescue
+      return nil
+    end
+  end
+  
+  # Returns string containing the broadcast address for a particular network interface.  If interface is not passed as an argument, method assumes primary interface.
+  def self.broadcast(interface=nil)
+    interface = self.default_network_interface() unless interface != nil
+    if interface.nil? then return nil end
+    
+    begin
+      ipaddr = self.ipv4(interface)
+      return @hst[:network][:interfaces][interface][:addresses][ipaddr][:broadcast]
+    rescue
+      return nil
+    end
+  end
+  
+  # Returns string containing the MAC address for a particular network interface.  If interface is not passed as an argument, method assumes primary interface.
+  def self.mac_address(interface=nil)
+    interface = self.default_network_interface() unless interface != nil
+    if interface.nil? then return nil end
+    
+    begin
+      ipaddr = self.ipv4(interface)
+      macaddr =  @hst[:network][:interfaces][interface][:addresses].to_s[/[0-9a-f]{2}\:[0-9a-f]{2}\:[0-9a-f]{2}\:[0-9a-f]{2}\:[0-9a-f]{2}\:[0-9a-f]{2}/]
+      if (@hst[:network][:interfaces][interface][:addresses][macaddr][:family] == "lladdr")
+        return macaddr
+      else
+        return nil
+      end
+    rescue
+      return nil
+    end
+  end
+  
+  # Returns string of current users' public SSH key.  If type is not passed as an argument, method assumes DSA.
+  def self.ssh_pub_key(type=nil)
+    if type.nil?
+      return @hst[:keys][:ssh][:host_dsa_public]
+    else
+      begin
+        key_type = "host_" + type.downcase + "_public"
+        return @hst[:keys][:ssh][key_type]
+      rescue
+        return nil
+      end
+    end    
+  end
+       
+  
+  private
+  
+  
+  def self.first_line(filename)
+    lines = IO.readlines(filename)
+    return lines.first
+  end
+  
+  def self.debissue()
+    line_split = self.first_line("/etc/issue").split(" ")
+    return (line_split[0] + " " + line_split[1] + " " + line_split[2])
+  end
+  
+  def self.ubuissue()
+    line_split = self.first_line("/etc/issue").split(" ")
+    return (line_split[0] + " " + line_split[1])
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'hostinfo'
+
+class Test::Unit::TestCase
+end

data/test/test_hostinfo.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestHostinfo < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: hostinfo
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- abrader
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ohai
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <=
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 5
+        - 6
+        version: 0.5.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Provides simple methods for retreiving user, system, and network information
+email: andrew@brader.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/hostinfo.rb
+- test/helper.rb
+- test/test_hostinfo.rb
+has_rdoc: true
+homepage: http://github.com/abrader/hostinfo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: nowarning
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simplified methods for retrieving system information
+test_files: 
+- test/helper.rb
+- test/test_hostinfo.rb