Class: UUID

Inherits:
Object show all
Defined in:
lib/gems/uuidtools-1.0.3/lib/uuidtools.rb,
lib/gems/uuidtools-1.0.3/lib/uuidtools/version.rb

Overview

– Copyright © 2005-2008 Robert 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:

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. ++

Defined Under Namespace

Modules: UUID_TOOLS_VERSION

Constant Summary collapse

@@mac_address = 
nil
@@last_timestamp = 
nil
@@last_node_id = 
nil
@@last_clock_sequence = 
nil
@@state_file = 
nil
@@mutex = 
Mutex.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(time_low, time_mid, time_hi_and_version, clock_seq_hi_and_reserved, clock_seq_low, nodes) ⇒ UUID

Returns a new instance of UUID.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 116

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
    raise ArgumentError,
      "Expected unsigned 32-bit number for time_low, got #{time_low}."
  end
  unless time_mid >= 0 && time_mid < 65536
    raise ArgumentError,
      "Expected unsigned 16-bit number for time_mid, got #{time_mid}."
  end
  unless time_hi_and_version >= 0 && time_hi_and_version < 65536
    raise ArgumentError,
      "Expected unsigned 16-bit number for time_hi_and_version, " +
      "got #{time_hi_and_version}."
  end
  unless clock_seq_hi_and_reserved >= 0 && clock_seq_hi_and_reserved < 256
    raise ArgumentError,
      "Expected unsigned 8-bit number for clock_seq_hi_and_reserved, " +
      "got #{clock_seq_hi_and_reserved}."
  end
  unless clock_seq_low >= 0 && clock_seq_low < 256
    raise ArgumentError,
      "Expected unsigned 8-bit number for clock_seq_low, " +
      "got #{clock_seq_low}."
  end
  unless nodes.respond_to? :size
    raise ArgumentError,
      "Expected nodes to respond to :size."
  end  
  unless nodes.size == 6
    raise ArgumentError,
      "Expected nodes to have size of 6."
  end
  for node in nodes
    unless node >= 0 && node < 256
      raise ArgumentError,
        "Expected unsigned 8-bit number for each node, " +
        "got #{node}."
    end
  end
  @time_low = time_low
  @time_mid = time_mid
  @time_hi_and_version = time_hi_and_version
  @clock_seq_hi_and_reserved = clock_seq_hi_and_reserved
  @clock_seq_low = clock_seq_low
  @nodes = nodes
end

Instance Attribute Details

#clock_seq_hi_and_reserved ⇒ Object

Returns the value of attribute clock_seq_hi_and_reserved.



167
168
169
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 167

def clock_seq_hi_and_reserved
  @clock_seq_hi_and_reserved
end

#clock_seq_low ⇒ Object

Returns the value of attribute clock_seq_low.



168
169
170
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 168

def clock_seq_low
  @clock_seq_low
end

#nodes ⇒ Object

Returns the value of attribute nodes.



169
170
171
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 169

def nodes
  @nodes
end

#time_hi_and_version ⇒ Object

Returns the value of attribute time_hi_and_version.



166
167
168
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 166

def time_hi_and_version
  @time_hi_and_version
end

#time_low ⇒ Object

Returns the value of attribute time_low.



164
165
166
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 164

def time_low
  @time_low
end

#time_mid ⇒ Object

Returns the value of attribute time_mid.



165
166
167
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 165

def time_mid
  @time_mid
end

Class Method Details

.convert_byte_string_to_int(byte_string) ⇒ Object

:nodoc:



635
636
637
638
639
640
641
642
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 635

def self.convert_byte_string_to_int(byte_string) #:nodoc:
  integer = 0
  size = byte_string.size
  for i in 0..(size - 1)
    integer += (byte_string[i] << (((size - 1) - i) * 8))
  end
  return integer
end

.convert_int_to_byte_string(integer, size) ⇒ Object

:nodoc:



627
628
629
630
631
632
633
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 627

def self.convert_int_to_byte_string(integer, size) #:nodoc:
  byte_string = ""
  for i in 0..(size - 1)
    byte_string << ((integer >> (((size - 1) - i) * 8)) & 0xFF)
  end
  return byte_string
end

.create_from_hash(hash_class, namespace, name) ⇒ Object

:nodoc:



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 452

def self.create_from_hash(hash_class, namespace, name) #:nodoc:
  if hash_class == Digest::MD5
    version = 3
  elsif hash_class == Digest::SHA1
    version = 5
  else
    raise ArgumentError,
      "Expected Digest::SHA1 or Digest::MD5, got #{hash_class.name}."
  end
  hash = hash_class.new
  hash.update(namespace.raw)
  hash.update(name)
  hash_string = hash.to_s[0..31]
  new_uuid = self.parse("#{hash_string[0..7]}-#{hash_string[8..11]}-" +
    "#{hash_string[12..15]}-#{hash_string[16..19]}-#{hash_string[20..31]}")
  
  new_uuid.time_hi_and_version &= 0x0FFF
  new_uuid.time_hi_and_version |= (version << 12)
  new_uuid.clock_seq_hi_and_reserved &= 0x3F
  new_uuid.clock_seq_hi_and_reserved |= 0x80
  return new_uuid
end

.mac_address ⇒ Object Also known as: get_mac_address

Returns the MAC address of the current computer’s network card. Returns nil if a MAC address could not be found.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 477

def self.mac_address #:nodoc:
  if @@mac_address.nil?
    require 'rbconfig'
    os_platform = Config::CONFIG['target_os']
    if os_platform =~ /win/ && !(os_platform =~ /darwin/)
      script_in_path = true
    else
      script_in_path = !(`which ifconfig`.strip =~ /no .+ in/)
    end
    if os_platform =~ /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_platform =~ /win/ && !(os_platform =~ /darwin/)
      begin
        ifconfig_output = `ipconfig /all`
        mac_addresses = ifconfig_output.scan(
          Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join("-")})"))
        if mac_addresses.size > 0
          @@mac_address = mac_addresses.first.first.downcase.gsub(/-/, ":")
        end
      rescue
      end
    else
      begin
        mac_addresses = []
        if os_platform =~ /netbsd/
          ifconfig_output =
            (script_in_path ? `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`)
          mac_addresses = ifconfig_output.scan(
            Regexp.new("address\: (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
        elsif os_platform =~ /openbsd/
          ifconfig_output = `/sbin/ifconfig -a 2>&1`
          ifconfig_output =
            (script_in_path ? `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`)
          mac_addresses = ifconfig_output.scan(
            Regexp.new("addr (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
        elsif File.exists?('/sbin/ifconfig')
          ifconfig_output =
            (script_in_path ? `ifconfig 2>&1` : `/sbin/ifconfig 2>&1`)
          mac_addresses = ifconfig_output.scan(
            Regexp.new("ether (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
          if mac_addresses.size == 0
            ifconfig_output =
              (script_in_path ?
                `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`)
            mac_addresses = ifconfig_output.scan(
              Regexp.new("ether (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
          end
          if mac_addresses.size == 0
            ifconfig_output =
              (script_in_path ?
                `ifconfig | grep HWaddr | cut -c39- 2>&1` :
                `/sbin/ifconfig | grep HWaddr | cut -c39- 2>&1`)
            mac_addresses = ifconfig_output.scan(
              Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
          end
        else
          ifconfig_output =
            (script_in_path ? `ifconfig 2>&1` : `/sbin/ifconfig 2>&1`)
          mac_addresses = ifconfig_output.scan(
            Regexp.new("ether (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
          if mac_addresses.size == 0
            ifconfig_output =
              (script_in_path ?
                `ifconfig -a 2>&1` : `/sbin/ifconfig -a 2>&1`)
            mac_addresses = ifconfig_output.scan(
              Regexp.new("ether (#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
          end
          if mac_addresses.size == 0
            ifconfig_output =
              (script_in_path ?
                `ifconfig | grep HWaddr | cut -c39- 2>&1` :
                `/sbin/ifconfig | grep HWaddr | cut -c39- 2>&1`)
            mac_addresses = ifconfig_output.scan(
              Regexp.new("(#{(["[0-9a-fA-F]{2}"] * 6).join(":")})"))
          end
        end
        if mac_addresses.size > 0
          @@mac_address = mac_addresses.first.first
        end
      rescue
      end
    end
    if @@mac_address != nil
      if @@mac_address.respond_to?(:to_str)
        @@mac_address = @@mac_address.to_str
      else
        @@mac_address = @@mac_address.to_s
      end
      @@mac_address.downcase!
      @@mac_address.strip!
    end

    # Verify that the MAC address is in the right format.
    # Nil it out if it isn't.
    unless @@mac_address.respond_to?(:scan) &&
        @@mac_address.scan(/#{(["[0-9a-f]{2}"] * 6).join(":")}/)
      @@mac_address = nil
    end
  end
  return @@mac_address
end

.mac_address=(new_mac_address) ⇒ Object

Allows users to set the MAC address manually in cases where the MAC address cannot be obtained programatically.



603
604
605
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 603

def self.mac_address=(new_mac_address)
  @@mac_address = new_mac_address
end

.md5_create(namespace, name) ⇒ Object

Creates a UUID using the MD5 hash. (Version 3)



281
282
283
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 281

def self.md5_create(namespace, name)
  return self.create_from_hash(Digest::MD5, namespace, name)
end

.parse(uuid_string) ⇒ Object

Parses a UUID from a string.

Raises:

  • (ArgumentError) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 172

def self.parse(uuid_string)
  unless uuid_string.kind_of? String
    raise ArgumentError,
      "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
  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)
  time_hi_and_version = uuid_components[2].to_i(16)
  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
    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

.parse_raw(raw_string) ⇒ Object

Parses a UUID from a raw byte string.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 195

def self.parse_raw(raw_string)
  unless raw_string.kind_of? String
    raise ArgumentError,
      "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
  nodes = []
  for i in 0..5
    nodes << ((integer >> (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

.random_128 ⇒ Object

128 bits of unpredictable data.



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 608

def self.random_128 #:nodoc:
  if !defined?(@random_device) || @random_device == nil
    begin
      @random_device = nil
      if File.exists? "/dev/urandom"
        @random_device = File.open "/dev/urandom", "r"
      elsif File.exists? "/dev/random"
        @random_device = File.open "/dev/random", "r"
      end
    rescue Exception
    end
  end
  begin
    return @random_device.read(16) if @random_device != nil
  rescue Exception
  end
  return (1..8).to_a.map { rand(0x10000) }.pack("n8")
end

.random_create ⇒ Object

Creates a UUID from a random value.



216
217
218
219
220
221
222
223
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 216

def self.random_create()
  new_uuid = self.parse_raw(self.random_128)
  new_uuid.time_hi_and_version &= 0x0FFF
  new_uuid.time_hi_and_version |= (4 << 12)
  new_uuid.clock_seq_hi_and_reserved &= 0x3F
  new_uuid.clock_seq_hi_and_reserved |= 0x80
  return new_uuid
end

.sha1_create(namespace, name) ⇒ Object

Creates a UUID using the SHA1 hash. (Version 5)



286
287
288
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 286

def self.sha1_create(namespace, name)
  return self.create_from_hash(Digest::SHA1, namespace, name)
end

.timestamp_create(timestamp = nil) ⇒ Object

Creates a UUID from a timestamp.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 226

def self.timestamp_create(timestamp=nil)
  # We need a lock here to prevent two threads from ever
  # getting the same timestamp.
  @@mutex.synchronize do
    # Always use GMT to generate UUIDs.
    if timestamp.nil?
      gmt_timestamp = Time.now.gmtime
    else
      gmt_timestamp = timestamp.gmtime
    end
    # Convert to 100 nanosecond blocks
    gmt_timestamp_100_nanoseconds = (gmt_timestamp.tv_sec * 10000000) +
      (gmt_timestamp.tv_usec * 10) + 0x01B21DD213814000
    mac_address = self.get_mac_address
    if mac_address == nil || mac_address == ""
      raise StandardError,
        "MAC address could not be autodetected.  " +
        "Set the MAC address manually."
    end
    nodes = mac_address.split(":").collect do |octet|
      octet.to_i(16)
    end
    node_id = 0
    for i in 0..5
      node_id += (nodes[i] << (40 - (i * 8)))
    end
    clock_sequence = @@last_clock_sequence
    if clock_sequence.nil?
      clock_sequence = self.convert_byte_string_to_int(self.random_128)
    end
    if @@last_node_id != nil && @@last_node_id != node_id
      # The node id has changed.  Change the clock id.
      clock_sequence = self.convert_byte_string_to_int(self.random_128)
    elsif @@last_timestamp != nil &&
        gmt_timestamp_100_nanoseconds <= @@last_timestamp
      clock_sequence = clock_sequence + 1
    end
    @@last_timestamp = gmt_timestamp_100_nanoseconds
    @@last_node_id = node_id
    @@last_clock_sequence = clock_sequence

    time_low = gmt_timestamp_100_nanoseconds & 0xFFFFFFFF
    time_mid = ((gmt_timestamp_100_nanoseconds >> 32) & 0xFFFF)
    time_hi_and_version = ((gmt_timestamp_100_nanoseconds >> 48) & 0x0FFF)
    time_hi_and_version |= (1 << 12)
    clock_seq_low = clock_sequence & 0xFF;
    clock_seq_hi_and_reserved = (clock_sequence & 0x3F00) >> 8
    clock_seq_hi_and_reserved |= 0x80
    
    return self.new(time_low, time_mid, time_hi_and_version,
      clock_seq_hi_and_reserved, clock_seq_low, nodes)
  end
end

Instance Method Details

#<=>(other_uuid) ⇒ Object

Compares two UUIDs lexically



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 378

def <=>(other_uuid)
  check = self.time_low <=> other_uuid.time_low
  return check if check != 0
  check = self.time_mid <=> other_uuid.time_mid
  return check if check != 0
  check = self.time_hi_and_version <=> other_uuid.time_hi_and_version
  return check if check != 0
  check = self.clock_seq_hi_and_reserved <=>
    other_uuid.clock_seq_hi_and_reserved
  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
    if (self.nodes[i] < other_uuid.nodes[i])
      return -1
    end
    if (self.nodes[i] > other_uuid.nodes[i])
      return 1
    end
  end
  return 0
end

#eql?(other) ⇒ Boolean

Returns true if this UUID is exactly equal to the other UUID.

Returns:



448
449
450
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 448

def eql?(other)
  return (self <=> other) == 0
end

#hash ⇒ Object

Returns an integer hash value.



443
444
445
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 443

def hash
  return self.to_i
end

#hexdigest ⇒ Object

Returns the hex digest of the UUID object.



407
408
409
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 407

def hexdigest
  return self.to_i.to_s(16)
end

#inspect ⇒ Object

Returns a representation of the object’s state



402
403
404
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 402

def inspect
  return "#<UUID:0x#{self.object_id.to_s(16)} UUID:#{self.to_s}>"
end

#mac_address ⇒ Object

Returns the IEEE 802 address used to generate this UUID or nil if a MAC address was not used.



357
358
359
360
361
362
363
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 357

def mac_address
  return nil if self.version != 1
  return nil if self.random_node_id?
  return (self.nodes.collect do |node|
    sprintf("%2.2x", node)
  end).join(":")
end

#nil_uuid? ⇒ Boolean

Returns true if this UUID is the nil UUID (00000000-0000-0000-0000-000000000000).

Returns:



303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 303

def nil_uuid?
  return false if self.time_low != 0
  return false if self.time_mid != 0
  return false if self.time_hi_and_version != 0
  return false if self.clock_seq_hi_and_reserved != 0
  return false if self.clock_seq_low != 0
  self.nodes.each do |node|
    return false if node != 0
  end
  return true
end

#random_node_id? ⇒ Boolean

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). Always returns false for UUIDs that aren’t version 1. This should not be confused with version 4 UUIDs where more than just the node id is random.

Returns:



296
297
298
299
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 296

def random_node_id?
  return false if self.version != 1
  return ((self.nodes.first & 0x01) == 1)
end

#raw ⇒ Object

Returns the raw bytes that represent this UUID.



412
413
414
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 412

def raw
  return self.class.convert_int_to_byte_string(self.to_i, 16)
end

#timestamp ⇒ Object

Returns the timestamp used to generate this UUID



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 366

def timestamp
  return nil if self.version != 1
  gmt_timestamp_100_nanoseconds = 0
  gmt_timestamp_100_nanoseconds +=
    ((self.time_hi_and_version  & 0x0FFF) << 48)
  gmt_timestamp_100_nanoseconds += (self.time_mid << 32)
  gmt_timestamp_100_nanoseconds += self.time_low
  return Time.at(
    (gmt_timestamp_100_nanoseconds - 0x01B21DD213814000) / 10000000.0)
end

#to_i ⇒ Object

Returns an integer representation for this UUID.



427
428
429
430
431
432
433
434
435
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 427

def to_i
  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
    bytes += (nodes[i] << (40 - (i * 8)))
  end
  return bytes
end

#to_s ⇒ Object

Returns a string representation for this UUID.



417
418
419
420
421
422
423
424
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 417

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
end

#to_uri ⇒ Object

Returns a URI string for this UUID.



438
439
440
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 438

def to_uri
  return "urn:uuid:#{self.to_s}"
end

#valid? ⇒ Boolean

Returns true if this UUID is valid.

Returns:



346
347
348
349
350
351
352
353
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 346

def valid?
  if [0b000, 0b100, 0b110, 0b111].include?(self.variant) &&
    (1..5).include?(self.version)
    return true
  else
    return false
  end
end

#variant ⇒ Object

Returns the UUID variant. Possible values: 0b000 - Reserved, NCS backward compatibility. 0b100 - The variant specified in this document. 0b110 - Reserved, Microsoft Corporation backward compatibility. 0b111 - Reserved for future definition.



332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 332

def variant
  variant_raw = (clock_seq_hi_and_reserved >> 5)
  result = nil
  if (variant_raw >> 2) == 0
    result = 0x000
  elsif (variant_raw >> 1) == 2
    result = 0x100
  else
    result = variant_raw
  end
  return (result >> 6)
end

#version ⇒ Object

Returns the UUID version type. Possible values: 1 - Time-based with unique or random host identifier 2 - DCE Security version (with POSIX UIDs) 3 - Name-based (MD5 hash) 4 - Random 5 - Name-based (SHA-1 hash)



322
323
324
 
# File 'lib/gems/uuidtools-1.0.3/lib/uuidtools.rb', line 322

def version
  return (time_hi_and_version >> 12)
end