Module: IPAddress

Included in:
IPv4, IPv6
Defined in:
lib/ipaddress.rb,
lib/ipaddress/ipv4.rb,
lib/ipaddress/ipv6.rb,
lib/ipaddress/prefix.rb,
lib/ipaddress/mongoid.rb

Defined Under Namespace

Classes: IPv4, IPv6, Prefix, Prefix128, Prefix32

Constant Summary collapse

NAME =
"IPAddress"
GEM =
"ipaddress"
AUTHORS =
["Marco Ceresa <ceresa@ieee.org>"]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.demongoize(string) ⇒ Object

Mongoid field deserialization



55
56
57
58
59
# File 'lib/ipaddress/mongoid.rb', line 55

def self.demongoize(string)
  parse(string)
rescue ArgumentError
  nil
end

.deprecate(message = nil) ⇒ Object

Deprecate method



149
150
151
152
# File 'lib/ipaddress.rb', line 149

def self.deprecate(message = nil) # :nodoc:
  message ||= "You are using deprecated behavior which will be removed from the next major or minor release."
  warn("DEPRECATION WARNING: #{message}")
end

.evolve(ipaddress) ⇒ Object

Delegates to IPAddress.mongoize



64
65
66
# File 'lib/ipaddress/mongoid.rb', line 64

def self.evolve(ipaddress)
  mongoize(ipaddress)
end

.mongoize(ipaddress) ⇒ Object

Mongoid field serialization

IPAddress objects are converted to String

IPAddress.mongoize IPAddress.parse("172.16.10.1")
  #=> "172.16.10.1"

Prefix will be removed from host adresses

IPAddress.mongoize "172.16.10.1/32"
  #=> "172.16.10.1"

Prefix will be kept for network addresses

IPAddress.mongoize "172.16.10.1/24"
  #=> "172.16.10.1/24"

IPv6 addresses will be stored uncompressed to ease DB search and sorting

IPAddress.mongoize "2001:db8::8:800:200c:417a"
  #=> "2001:0db8:0000:0000:0008:0800:200c:417a"
IPAddress.mongoize "2001:db8::8:800:200c:417a/64"
  #=> "2001:0db8:0000:0000:0008:0800:200c:417a/64"

Invalid addresses will be serialized as nil

IPAddress.mongoize "invalid"
  #=> nil
IPAddress.mongoize ""
  #=> nil
IPAddress.mongoize 1
  #=> nil
IPAddress.mongoize nil
  #=> nil


39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/ipaddress/mongoid.rb', line 39

def self.mongoize(ipaddress)
  ipaddress = self.parse(ipaddress) unless ipaddress.is_a?(IPAddress)
  if ipaddress.bits.length == ipaddress.prefix
    ipaddress.address
  elsif ipaddress.is_a?(IPAddress::IPv6)
    ipaddress.to_string_uncompressed
  else
    ipaddress.to_string
  end
rescue ArgumentError
  nil
end

.parse(str) ⇒ Object

Parse the argument string to create a new IPv4, IPv6 or Mapped IP object

ip  = IPAddress.parse "172.16.10.1/24"
ip6 = IPAddress.parse "2001:db8::8:800:200c:417a/64"
ip_mapped = IPAddress.parse "::ffff:172.16.10.1/128"

All the object created will be instances of the correct class:

ip.class
  #=> IPAddress::IPv4
ip6.class
  #=> IPAddress::IPv6
ip_mapped.class
  #=> IPAddress::IPv6::Mapped


43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/ipaddress.rb', line 43

def IPAddress::parse(str)
  case str
  when /:.+\./
    IPAddress::IPv6::Mapped.new(str)
  when /\./
    IPAddress::IPv4.new(str) 
  when /:/
    IPAddress::IPv6.new(str)
  else
    raise ArgumentError, "Unknown IP Address #{str}"
  end
end

.valid?(addr) ⇒ Boolean

Checks if the given string is a valid IP address, either IPv4 or IPv6

Example:

IPAddress::valid? "2002::1"
  #=> true

IPAddress::valid? "10.0.0.256"   
  #=> false

Returns:

  • (Boolean)


92
93
94
# File 'lib/ipaddress.rb', line 92

def self.valid?(addr)
  valid_ipv4?(addr) || valid_ipv6?(addr)
end

.valid_ipv4?(addr) ⇒ Boolean

Checks if the given string is a valid IPv4 address

Example:

IPAddress::valid_ipv4? "2002::1"
  #=> false

IPAddress::valid_ipv4? "172.16.10.1"
  #=> true

Returns:

  • (Boolean)


107
108
109
110
111
112
# File 'lib/ipaddress.rb', line 107

def self.valid_ipv4?(addr)
  if /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/ =~ addr
    return $~.captures.all? {|i| i.to_i < 256}
  end
  false
end

.valid_ipv4_netmask?(addr) ⇒ Boolean

Checks if the argument is a valid IPv4 netmask expressed in dotted decimal format.

IPAddress.valid_ipv4_netmask? "255.255.0.0"
  #=> true

Returns:

  • (Boolean)


121
122
123
124
125
126
# File 'lib/ipaddress.rb', line 121

def self.valid_ipv4_netmask?(addr)
  arr = addr.split(".").map{|i| i.to_i}.pack("CCCC").unpack("B*").first.scan(/01/)
  arr.empty? && valid_ipv4?(addr)
rescue
  return false
end

.valid_ipv6?(addr) ⇒ Boolean

Checks if the given string is a valid IPv6 address

Example:

IPAddress::valid_ipv6? "2002::1"
  #=> true

IPAddress::valid_ipv6? "2002::DEAD::BEEF"
  #=> false

Returns:

  • (Boolean)


139
140
141
142
143
144
# File 'lib/ipaddress.rb', line 139

def self.valid_ipv6?(addr) 
  # https://gist.github.com/cpetschnig/294476
  # http://forums.intermapper.com/viewtopic.php?t=452
  return true if /^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/ =~ addr
  false
end

Instance Method Details

#ipv4?Boolean

True if the object is an IPv4 address

ip = IPAddress("192.168.10.100/24")

ip.ipv4?
  #-> true

Returns:

  • (Boolean)


64
65
66
# File 'lib/ipaddress.rb', line 64

def ipv4?
  self.kind_of? IPAddress::IPv4
end

#ipv6?Boolean

True if the object is an IPv6 address

ip = IPAddress("192.168.10.100/24")

ip.ipv6?
  #-> false

Returns:

  • (Boolean)


76
77
78
# File 'lib/ipaddress.rb', line 76

def ipv6?
  self.kind_of? IPAddress::IPv6
end

#mongoizeObject

Sends self object to IPAddress#mongoize



71
72
73
# File 'lib/ipaddress/mongoid.rb', line 71

def mongoize
  IPAddress.mongoize(self)
end