uuidtools 2.1.0 → 3.0.0

data/lib/uuidtools.rb

@@ -1,26 +1,21 @@
+# encoding:utf-8
 #--
-# UUIDTools, Copyright (c) 2005-2008 Bob Aman
+# Copyright (C) 2005-2014 Bob Aman
 #
-# 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:
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+#        http://www.apache.org/licenses/LICENSE-2.0
 #
-# 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.
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
 #++
 
+
 $:.unshift(File.dirname(__FILE__))
 
 require 'uri'
@@ -38,30 +33,50 @@ rescue LoadError
 end
 
 module UUIDTools
-  #= uuidtools.rb
-  #
+  ##
   # UUIDTools was designed to be a simple library for generating any
   # of the various types of UUIDs.  It conforms to RFC 4122 whenever
   # possible.
   #
-  #== Example
-  #  UUID.md5_create(UUID_DNS_NAMESPACE, "www.widgets.com")
-  #  => #<UUID:0x287576 UUID:3d813cbb-47fb-32ba-91df-831e1593ac29>
-  #  UUID.sha1_create(UUID_DNS_NAMESPACE, "www.widgets.com")
-  #  => #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
-  #  UUID.timestamp_create
-  #  => #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
-  #  UUID.random_create
-  #  => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>
+  # @example
+  #   UUID.md5_create(UUID_DNS_NAMESPACE, "www.widgets.com")
+  #   # => #<UUID:0x287576 UUID:3d813cbb-47fb-32ba-91df-831e1593ac29>
+  #   UUID.sha1_create(UUID_DNS_NAMESPACE, "www.widgets.com")
+  #   # => #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
+  #   UUID.timestamp_create
+  #   # => #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
+  #   UUID.random_create
+  #   # => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>
   class UUID
     include Comparable
 
+    ##
+    # @api private
     @@last_timestamp = nil
+
+    ##
+    # @api private
     @@last_node_id = nil
+
+    ##
+    # @api private
     @@last_clock_sequence = nil
+
+    ##
+    # @api private
     @@state_file = nil
+
+    ##
+    # @api private
     @@mutex = Mutex.new
 
+    ##
+    # Creates a new UUID structure from its component values.
+    # @see UUID.md5_create
+    # @see UUID.sha1_create
+    # @see UUID.timestamp_create
+    # @see UUID.random_create
+    # @api private
     def initialize(time_low, time_mid, time_hi_and_version,
         clock_seq_hi_and_reserved, clock_seq_low, nodes)
       unless time_low >= 0 && time_low < 4294967296
@@ -110,22 +125,38 @@ module UUIDTools
       @nodes = nodes
     end
 
+    ##
+    # Returns the value of attribute `time_low`
     attr_accessor :time_low
+
+    ##
+    # Returns the value of attribute `time_mid`
     attr_accessor :time_mid
+
+    ##
+    # Returns the value of attribute `time_hi_and_version`
     attr_accessor :time_hi_and_version
+
+    ##
+    # Returns the value of attribute `clock_seq_hi_and_reserved`
     attr_accessor :clock_seq_hi_and_reserved
+
+    ##
+    # Returns the value of attribute `clock_seq_low`
     attr_accessor :clock_seq_low
+
+    ##
+    # Returns the value of attribute `nodes`
     attr_accessor :nodes
 
+    ##
     # Parses a UUID from a string.
     def self.parse(uuid_string)
       unless uuid_string.kind_of? String
         raise TypeError,
           "Expected String, got #{uuid_string.class.name} instead."
       end
-      uuid_components = uuid_string.downcase.scan(
-        Regexp.new("^([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-" +
-          "([0-9a-f]{2})([0-9a-f]{2})-([0-9a-f]{12})$")).first
+      uuid_components = uuid_string.downcase.scan(UUIDTools::UUID_REGEXP).first
       raise ArgumentError, "Invalid UUID format." if uuid_components.nil?
       time_low = uuid_components[0].to_i(16)
       time_mid = uuid_components[1].to_i(16)
@@ -133,52 +164,114 @@ module UUIDTools
       clock_seq_hi_and_reserved = uuid_components[3].to_i(16)
       clock_seq_low = uuid_components[4].to_i(16)
       nodes = []
-      for i in 0..5
+      6.times do |i|
         nodes << uuid_components[5][(i * 2)..(i * 2) + 1].to_i(16)
       end
       return self.new(time_low, time_mid, time_hi_and_version,
         clock_seq_hi_and_reserved, clock_seq_low, nodes)
     end
 
+    ##
     # Parses a UUID from a raw byte string.
     def self.parse_raw(raw_string)
       unless raw_string.kind_of? String
         raise TypeError,
           "Expected String, got #{raw_string.class.name} instead."
       end
-      integer = self.convert_byte_string_to_int(raw_string)
 
-      time_low = (integer >> 96) & 0xFFFFFFFF
-      time_mid = (integer >> 80) & 0xFFFF
-      time_hi_and_version = (integer >> 64) & 0xFFFF
-      clock_seq_hi_and_reserved = (integer >> 56) & 0xFF
-      clock_seq_low = (integer >> 48) & 0xFF
+      if raw_string.respond_to?(:force_encoding)
+        raw_string.force_encoding(Encoding::ASCII_8BIT)
+      end
+
+      raw_length = raw_string.length
+      if raw_length < 16
+        # Option A: Enforce raw_string be 16 characters (More strict)
+        #raise ArgumentError,
+        #  "Expected 16 bytes, got #{raw_string.length} instead."
+
+        # Option B: Pad raw_string to 16 characters (Compatible with existing behavior)
+        raw_string = raw_string.rjust(16, "\0")
+      elsif raw_length > 16
+        # NOTE: As per "Option B" above, existing behavior would use the lower
+        # 128-bits of an overly long raw_string instead of using the upper 128-bits.
+        start_index = raw_length - 16
+        raw_string = raw_string[start_index...raw_length]
+      end
+
+      raw_bytes = []
+      if raw_string[0].respond_to? :ord
+        for i in 0...raw_string.size
+          raw_bytes << raw_string[i].ord
+        end
+      else
+        raw_bytes = raw_string
+      end
+
+      time_low = ((raw_bytes[0] << 24) +
+                  (raw_bytes[1] << 16)  +
+                  (raw_bytes[2] << 8)  +
+                   raw_bytes[3])
+      time_mid = ((raw_bytes[4] << 8) +
+                   raw_bytes[5])
+      time_hi_and_version = ((raw_bytes[6] << 8) +
+                              raw_bytes[7])
+      clock_seq_hi_and_reserved = raw_bytes[8]
+      clock_seq_low = raw_bytes[9]
       nodes = []
-      for i in 0..5
-        nodes << ((integer >> (40 - (i * 8))) & 0xFF)
+      for i in 10...16
+        nodes << raw_bytes[i]
       end
+
       return self.new(time_low, time_mid, time_hi_and_version,
-        clock_seq_hi_and_reserved, clock_seq_low, nodes)
+                      clock_seq_hi_and_reserved, clock_seq_low, nodes)
     end
 
+    ##
     # Parses a UUID from an Integer.
     def self.parse_int(uuid_int)
       unless uuid_int.kind_of?(Integer)
         raise ArgumentError,
           "Expected Integer, got #{uuid_int.class.name} instead."
       end
-      return self.parse_raw(self.convert_int_to_byte_string(uuid_int, 16))
+
+      time_low = (uuid_int >> 96) & 0xFFFFFFFF
+      time_mid = (uuid_int >> 80) & 0xFFFF
+      time_hi_and_version = (uuid_int >> 64) & 0xFFFF
+      clock_seq_hi_and_reserved = (uuid_int >> 56) & 0xFF
+      clock_seq_low = (uuid_int >> 48) & 0xFF
+      nodes = []
+      for i in 0..5
+        nodes << ((uuid_int >> (40 - (i * 8))) & 0xFF)
+      end
+
+      return self.new(time_low, time_mid, time_hi_and_version,
+                      clock_seq_hi_and_reserved, clock_seq_low, nodes)
     end
 
+    ##
     # Parse a UUID from a hexdigest String.
-    def self.parse_hexdigest(uuid_hexdigest)
-      unless uuid_hexdigest.kind_of?(String)
+    def self.parse_hexdigest(uuid_hex)
+      unless uuid_hex.kind_of?(String)
         raise ArgumentError,
-          "Expected String, got #{uuid_hexdigest.class.name} instead."
+          "Expected String, got #{uuid_hex.class.name} instead."
+      end
+
+      time_low = uuid_hex[0...8].to_i(16)
+      time_mid = uuid_hex[8...12].to_i(16)
+      time_hi_and_version = uuid_hex[12...16].to_i(16)
+      clock_seq_hi_and_reserved = uuid_hex[16...18].to_i(16)
+      clock_seq_low = uuid_hex[18...20].to_i(16)
+      nodes_string = uuid_hex[20...32]
+      nodes = []
+      for i in 0..5
+        nodes << nodes_string[(i * 2)..(i * 2) + 1].to_i(16)
       end
-      return self.parse_int(uuid_hexdigest.to_i(16))
+
+      return self.new(time_low, time_mid, time_hi_and_version,
+                      clock_seq_hi_and_reserved, clock_seq_low, nodes)
     end
 
+    ##
     # Creates a UUID from a random value.
     def self.random_create()
       new_uuid = self.parse_raw(SecureRandom.random_bytes(16))
@@ -189,6 +282,7 @@ module UUIDTools
       return new_uuid
     end
 
+    ##
     # Creates a UUID from a timestamp.
     def self.timestamp_create(timestamp=nil)
       # We need a lock here to prevent two threads from ever
@@ -213,7 +307,7 @@ module UUIDTools
           nodes = SecureRandom.random_bytes(6).unpack("C*")
           nodes[0] |= 0b00000001
         end
-        for i in 0..5
+        6.times do |i|
           node_id += (nodes[i] << (40 - (i * 8)))
         end
         clock_sequence = @@last_clock_sequence
@@ -248,16 +342,19 @@ module UUIDTools
       end
     end
 
+    ##
     # Creates a UUID using the MD5 hash.  (Version 3)
     def self.md5_create(namespace, name)
       return self.create_from_hash(Digest::MD5, namespace, name)
     end
 
+    ##
     # Creates a UUID using the SHA1 hash.  (Version 5)
     def self.sha1_create(namespace, name)
       return self.create_from_hash(Digest::SHA1, namespace, name)
     end
 
+    ##
     # This method applies only to version 1 UUIDs.
     # Checks if the node ID was generated from a random number
     # or from an IEEE 802 address (MAC address).
@@ -269,6 +366,7 @@ module UUIDTools
       return ((self.nodes.first & 0x01) == 1)
     end
 
+    ##
     # Returns true if this UUID is the
     # nil UUID (00000000-0000-0000-0000-000000000000).
     def nil_uuid?
@@ -283,6 +381,7 @@ module UUIDTools
       return true
     end
 
+    ##
     # Returns the UUID version type.
     # Possible values:
     # 1 - Time-based with unique or random host identifier
@@ -294,6 +393,7 @@ module UUIDTools
       return (time_hi_and_version >> 12)
     end
 
+    ##
     # Returns the UUID variant.
     # Possible values:
     # 0b000 - Reserved, NCS backward compatibility.
@@ -313,16 +413,13 @@ module UUIDTools
       return (result >> 6)
     end
 
+    ##
     # Returns true if this UUID is valid.
     def valid?
-      if [0b000, 0b100, 0b110, 0b111].include?(self.variant) &&
-        (1..5).include?(self.version)
-        return true
-      else
-        return false
-      end
+      return self.variant == 0b100 && (1..8).cover?(self.version)
     end
 
+    ##
     # Returns the IEEE 802 address used to generate this UUID or
     # nil if a MAC address was not used.
     def mac_address
@@ -333,6 +430,7 @@ module UUIDTools
       end).join(":")
     end
 
+    ##
     # Returns the timestamp used to generate this UUID
     def timestamp
       return nil if self.version != 1
@@ -345,8 +443,10 @@ module UUIDTools
         (gmt_timestamp_100_nanoseconds - 0x01B21DD213814000) / 10000000.0)
     end
 
+    ##
     # Compares two UUIDs lexically
     def <=>(other_uuid)
+      return nil unless other_uuid.is_a?(UUIDTools::UUID)
       check = self.time_low <=> other_uuid.time_low
       return check if check != 0
       check = self.time_mid <=> other_uuid.time_mid
@@ -358,7 +458,7 @@ module UUIDTools
       return check if check != 0
       check = self.clock_seq_low <=> other_uuid.clock_seq_low
       return check if check != 0
-      for i in 0..5
+      6.times do |i|
         if (self.nodes[i] < other_uuid.nodes[i])
           return -1
         end
@@ -369,169 +469,252 @@ module UUIDTools
       return 0
     end
 
+    ##
     # Returns a representation of the object's state
     def inspect
       return "#<UUID:0x#{self.object_id.to_s(16)} UUID:#{self.to_s}>"
     end
 
+    ##
     # Returns the hex digest of the UUID object.
     def hexdigest
-      return self.to_i.to_s(16).rjust(32, "0")
+      (self.frozen? ?
+        generate_hexdigest : (@hexdigest ||= generate_hexdigest)
+      ).dup
     end
 
+    ##
     # Returns the raw bytes that represent this UUID.
     def raw
-      return self.class.convert_int_to_byte_string(self.to_i, 16)
+      (self.frozen? ? generate_raw : (@raw ||= generate_raw)).dup
     end
 
+    ##
     # Returns a string representation for this UUID.
     def to_s
-      result = sprintf("%8.8x-%4.4x-%4.4x-%2.2x%2.2x-", @time_low, @time_mid,
-        @time_hi_and_version, @clock_seq_hi_and_reserved, @clock_seq_low);
-      for i in 0..5
-        result << sprintf("%2.2x", @nodes[i])
-      end
-      return result.downcase
+      (self.frozen? ? generate_s : (@string ||= generate_s)).dup
     end
     alias_method :to_str, :to_s
 
+    ##
     # Returns an integer representation for this UUID.
     def to_i
-      @integer ||= (begin
+      self.frozen? ? generate_i : (@integer ||= generate_i)
+    end
+
+    ##
+    # Returns a URI string for this UUID.
+    def to_uri
+      return "urn:uuid:#{self.to_s}"
+    end
+
+    ##
+    # Returns an integer hash value.
+    def hash
+      self.frozen? ? generate_hash : (@hash ||= generate_hash)
+    end
+
+  protected
+    ##
+    # Generates the hex digest of the UUID object.
+    #
+    # @api private
+    def generate_hexdigest
+      return self.to_i.to_s(16).rjust(32, "0")
+    end
+
+    # Generates an integer hash value.
+    #
+    # @api private
+    def generate_hash
+      return self.to_i % 0x3fffffff
+    end
+
+    ##
+    # Generates an integer representation for this UUID.
+    #
+    # @api private
+    def generate_i
+      return (begin
         bytes = (time_low << 96) + (time_mid << 80) +
           (time_hi_and_version << 64) + (clock_seq_hi_and_reserved << 56) +
           (clock_seq_low << 48)
-        for i in 0..5
+        6.times do |i|
           bytes += (nodes[i] << (40 - (i * 8)))
         end
         bytes
       end)
     end
 
-    # Returns a URI string for this UUID.
-    def to_uri
-      return "urn:uuid:#{self.to_s}"
+    ##
+    # Generates a string representation for this UUID.
+    #
+    # @api private
+    def generate_s
+      result = sprintf("%8.8x-%4.4x-%4.4x-%2.2x%2.2x-", @time_low, @time_mid,
+        @time_hi_and_version, @clock_seq_hi_and_reserved, @clock_seq_low);
+      6.times do |i|
+        result << sprintf("%2.2x", @nodes[i])
+      end
+      return result.downcase
     end
 
-    # Returns an integer hash value.
-    def hash
-      @hash ||= self.to_i % 0x3fffffff
+    ##
+    # Generates the raw bytes that represent this UUID.
+    #
+    # @api private
+    def generate_raw
+      return self.class.convert_int_to_byte_string(self.to_i, 16)
     end
 
+  public
+    ##
     # Returns true if this UUID is exactly equal to the other UUID.
     def eql?(other)
       return self == other
     end
 
+    #
+    # Determine what OS we're running on.  Helps decide how to find the MAC
+    #
+    def self.os_class
+      require 'rbconfig'
+      os_platform = RbConfig::CONFIG['target_os']
+      if (os_platform =~ /win/i && !(os_platform =~ /darwin/i)) ||
+          os_platform =~ /w32/i
+        :windows
+      elsif os_platform =~ /solaris/i
+        :solaris
+      elsif os_platform =~ /netbsd/i
+        :netbsd
+      elsif os_platform =~ /openbsd/i
+        :openbsd
+      end
+    end
+
+    # making these class variables helps with testing
+    @ipconfig_command = "ipconfig"
+    @ipconfig_path_default = "c:\\windows\\system32\\ipconfig.exe"
+    @ifconfig_command = "ifconfig"
+    @ifconfig_path_default = "/sbin/ifconfig"
+    @ip_command = "ip"
+    @ip_path_default = "/sbin/ip"
+
+    class << self
+      attr_accessor :ipconfig_command, :ipconfig_path_default
+      attr_accessor :ifconfig_command, :ifconfig_path_default
+      attr_accessor :ip_command, :ip_path_default
+    end
+
+    #
+    # Find the path of the ipconfig command if it is present
+    #
+    def self.ipconfig_path
+      path = `where #{UUID.ipconfig_command}`.strip
+      path = UUID.ipconfig_path_default if path == "" && File.exist?(UUID.ipconfig_path_default)
+      return (path === "" ? nil : path)
+    end
+
+    #
+    # Find the path of the ifconfig(8) command if it is present
+    #
+    def self.ifconfig_path
+      path = `which #{UUID.ifconfig_command} 2>/dev/null`.strip
+      path = UUID.ifconfig_path_default if path == "" && File.exist?(UUID.ifconfig_path_default)
+      return (path === "" ? nil : path)
+    end
+
+    #
+    # Find the path of the ip(8) command if it is present
+    #
+    def self.ip_path
+      path = `which #{UUID.ip_command} 2>/dev/null`.strip
+      path = UUID.ip_path_default if path == "" && File.exist?(UUID.ip_path_default)
+      return (path === "" ? nil : path)
+    end
+
+    #
+    # Call the ipconfig command that is found
+    #
+    def self.ipconfig(all = nil)
+      ipconfig_path = UUID.ipconfig_path
+      command =
+        if ipconfig_path
+          "#{ipconfig_path}#{all ? ' /all' : ''}"
+        end
+      `#{command}` if command
+    end
+
+    #
+    # Call the ifconfig or ip command that is found
+    #
+    def self.ifconfig(all = nil)
+      ifconfig_path = UUID.ifconfig_path
+      ip_path = UUID.ip_path
+      command =
+        if ifconfig_path
+          "#{ifconfig_path}#{all ? ' -a' : ''}"
+        elsif ip_path
+          "#{ip_path} addr list"
+        end
+      `#{command}` if command
+    end
+
+    # Match and return the first Mac address found
+    def self.first_mac(instring)
+      return nil if instring.nil?
+
+      mac_regexps = [
+        Regexp.new("address:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
+        Regexp.new("addr:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
+        Regexp.new("ether:? (#{(["[0-9a-fA-F]{1,2}"] * 6).join(":")})"),
+        Regexp.new("HWaddr:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
+        Regexp.new("link/ether? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
+        Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
+        Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join("-")})")
+      ]
+      parse_mac = lambda do |output|
+        (mac_regexps.map do |regexp|
+           result = output[regexp, 1]
+           result.downcase.gsub(/-/, ":") if result != nil
+        end).compact.first
+      end
+
+      mac = parse_mac.call(instring)
+      if mac
+        # expand octets that were compressed (solaris)
+        return (mac.split(':').map do |octet|
+          (octet.length == 1 ? "0#{octet}" : octet)
+        end).join(':')
+      else
+        return nil
+      end
+    end
+
+    ##
     # Returns the MAC address of the current computer's network card.
     # Returns nil if a MAC address could not be found.
-    def self.mac_address #:nodoc:
+    def self.mac_address
       if !defined?(@@mac_address)
+        @@mac_address = nil
         require 'rbconfig'
-        os_platform = Config::CONFIG['target_os']
-        os_class = nil
-        if (os_platform =~ /win/i && !(os_platform =~ /darwin/i)) ||
-            os_platform =~ /w32/i
-          os_class = :windows
-        elsif os_platform =~ /solaris/i
-          os_class = :solaris
-        elsif os_platform =~ /netbsd/i
-          os_class = :netbsd
-        elsif os_platform =~ /openbsd/i
-          os_class = :openbsd
-        end
-        mac_regexps = [
-          Regexp.new("address:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
-          Regexp.new("addr:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
-          Regexp.new("ether:? (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
-          Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"),
-          Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join("-")})")
-        ]
-        parse_mac = lambda do |output|
-          (mac_regexps.map do |regexp|
-            result = output[regexp, 1]
-            result.downcase.gsub(/-/, ":") if result != nil
-          end).compact.first
-        end
+
+        os_class = UUID.os_class
+
         if os_class == :windows
-          script_in_path = true
-        else
-          script_in_path = Kernel.system("which ifconfig 2>&1 > /dev/null")
-        end
-        if os_class == :solaris
-          begin
-            ifconfig_output =
-              (script_in_path ? `ifconfig -a` : `/sbin/ifconfig -a`)
-            ip_addresses = ifconfig_output.scan(
-              /inet\s?(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/)
-            ip = ip_addresses.find {|addr| addr[0] != '127.0.0.1'}[0]
-            @@mac_address = `/usr/sbin/arp #{ip}`.split(' ')[3]
-          rescue Exception
-          end
-          if @@mac_address == "" || @@mac_address == nil
-            begin
-              ifconfig_output =
-                (script_in_path ?
-                  `ifconfig -a` : `/sbin/ifconfig -a`).split(' ')
-              index = ifconfig_output.index("inet") + 1
-              ip = ifconfig_output[index]
-              @@mac_address = `arp #{ip}`.split(' ')[3]
-            rescue Exception
-            end
-          end
-        elsif os_class == :windows
           begin
-            @@mac_address = parse_mac.call(`ipconfig /all`)
+            ipconfig_output = UUID.ipconfig(:all)
+            @@mac_address = UUID.first_mac ipconfig_output
           rescue
           end
         else
-          begin
-            if os_class == :netbsd
-              @@mac_address = parse_mac.call(
-                script_in_path ? `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
-              )
-            elsif os_class == :openbsd
-              @@mac_address = parse_mac.call(
-                script_in_path ? `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
-              )
-            elsif File.exists?('/sbin/ifconfig')
-              @@mac_address = parse_mac.call(
-                script_in_path ? `ifconfig 2>&1` : `/sbin/ifconfig 2>&1`
-              )
-              if @@mac_address == nil
-                @@mac_address = parse_mac.call(
-                  script_in_path ?
-                    `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
-                )
-              end
-              if @@mac_address == nil
-                @@mac_address = parse_mac.call(
-                  script_in_path ?
-                    `ifconfig | grep HWaddr | cut -c39- 2>&1` :
-                    `/sbin/ifconfig | grep HWaddr | cut -c39- 2>&1`
-                )
-              end
-            else
-              @@mac_address = parse_mac.call(
-                script_in_path ? `ifconfig 2>&1` : `/sbin/ifconfig 2>&1`
-              )
-              if @@mac_address == nil
-                @@mac_address = parse_mac.call(
-                  script_in_path ?
-                    `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`
-                )
-              end
-              if @@mac_address == nil
-                @@mac_address = parse_mac.call(
-                  script_in_path ?
-                    `ifconfig | grep HWaddr | cut -c39- 2>&1` :
-                    `/sbin/ifconfig | grep HWaddr | cut -c39- 2>&1`
-                )
-              end
-            end
-          rescue
+          ifconfig_output = UUID.ifconfig(:all)
+          if ifconfig_output
+            # linux, bsd, macos, solaris
+            @@mac_address = UUID.first_mac ifconfig_output
           end
         end
+
         if @@mac_address != nil
           if @@mac_address.respond_to?(:to_str)
             @@mac_address = @@mac_address.to_str
@@ -552,6 +735,7 @@ module UUIDTools
       return @@mac_address
     end
 
+    ##
     # Allows users to set the MAC address manually in cases where the MAC
     # address cannot be obtained programatically.
     def self.mac_address=(new_mac_address)
@@ -561,8 +745,12 @@ module UUIDTools
     # The following methods are not part of the public API,
     # and generally should not be called directly.
 
+
+    ##
     # Creates a new UUID from a SHA1 or MD5 hash
-    def self.create_from_hash(hash_class, namespace, name) #:nodoc:
+    #
+    # @api private
+    def self.create_from_hash(hash_class, namespace, name)
       if hash_class == Digest::MD5
         version = 3
       elsif hash_class == Digest::SHA1
@@ -585,28 +773,60 @@ module UUIDTools
       return new_uuid
     end
 
-    def self.convert_int_to_byte_string(integer, size) #:nodoc:
-      byte_string = ""
-      for i in 0..(size - 1)
+    ##
+    # @api private
+    def self.convert_int_to_byte_string(integer, size)
+      byte_string = +""
+      if byte_string.respond_to?(:force_encoding)
+        byte_string.force_encoding(Encoding::ASCII_8BIT)
+      end
+      size.times do |i|
         byte_string << ((integer >> (((size - 1) - i) * 8)) & 0xFF)
       end
       return byte_string
     end
 
-    def self.convert_byte_string_to_int(byte_string) #:nodoc:
+    ##
+    # @api private
+    def self.convert_byte_string_to_int(byte_string)
+      if byte_string.respond_to?(:force_encoding)
+        byte_string.force_encoding(Encoding::ASCII_8BIT)
+      end
+
       integer = 0
       size = byte_string.size
-      for i in 0..(size - 1)
-        ordinal = (byte_string[i].respond_to?(:ord) ?
-          byte_string[i].ord : byte_string[i])
-        integer += (ordinal << (((size - 1) - i) * 8))
+      if byte_string[0].respond_to? :ord
+        for i in 0...size
+          integer += (byte_string[i].ord << (((size - 1) - i) * 8))
+        end
+      else
+        for i in 0...size
+          integer += (byte_string[i] << (((size - 1) - i) * 8))
+        end
       end
+      
       return integer
     end
   end
 
+  ##
+  # Constant Regexp that matches a UUID and captures its components.
+  UUID_REGEXP = Regexp.new("\\A([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-" +
+                          "([0-9a-f]{2})([0-9a-f]{2})-([0-9a-f]{12})\\z")
+
+  ##
+  # Constant that represents the DNS namespace.
   UUID_DNS_NAMESPACE = UUID.parse("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
+
+  ##
+  # Constant that represents the URL namespace.
   UUID_URL_NAMESPACE = UUID.parse("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
+
+  ##
+  # Constant that represents the OID namespace.
   UUID_OID_NAMESPACE = UUID.parse("6ba7b812-9dad-11d1-80b4-00c04fd430c8")
+
+  ##
+  # Constant that represents the X500 namespace.
   UUID_X500_NAMESPACE = UUID.parse("6ba7b814-9dad-11d1-80b4-00c04fd430c8")
 end