ip_address 0.1

data/lib/ip_address.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/ruby
+
+class NotAnIPError < Exception
+	def initialize(not_an_ip)
+		super("#{not_an_ip.inspect} isn't a valid IP address")
+	end
+end
+
+# This class represents an IP address.
+class IPAddress
+	# Things that match this are (mostly) IPs.
+	IP_REGEXP = /^(?:\d{1,3}\.){3}\d{1,3}$/
+
+	# Is _addr_ a string representation of an IP (without a netmask)?
+	def self.is_an_ip?(addr)
+		!!( IP_REGEXP =~ addr and addr.split(".").all?{|x| x.to_i < 256} )
+	end
+
+	# our netmask
+	attr_reader :netmask
+
+	# Set our netmask to _val_.
+	def netmask=(val)
+		@ip = mask(@ip, val)
+		@netmask = val
+	end
+
+	# @overload new(ip)
+	#  @param [String] ip an IP like "12.4.97.8"
+	# @overload new(ip)
+	#  @param [String] ip an IP like "12.4.97.0/24"
+	# @overload new(ip)
+	#  @param [String] ip an IP like [12, 4, 97, 8]
+	# @overload new(ip)
+	#  @param [IPAddress] ip another IPAddress instance
+	# @overload new(ip)
+	#  @param [Fixnum] ip an IP like (12*256**3 + 4*256**2 + 97*256 + 8)
+	def initialize(ip)
+		@ip, nmask = any_to_int_and_netmask(ip)
+
+		self.netmask = nmask
+	end
+
+	# Get our _indx_th quad.
+	# @example
+	#  IPAddress.new("12.4.97.8")[1] #=> 4
+	def [](index)
+		unless (0..3) === index
+			raise ArgumentError, "there are four parts to an IP address"
+		end
+
+		to_a[index]
+	end
+
+	# Set our _index_th quad to the integer _val_.
+	# @example
+	#  ip = IPAddress.new("12.4.97.0")
+	#  ip[3] = 8
+	#  ip #=> #<IPAddress: 12.4.97.8>
+	def []=(index, val)
+		if not (0..3) === index
+			raise ArgumentError, "there are four parts to an IP address"
+		elsif not (0..256) === val
+			raise ArgumentError, "each of the IP parts is between 0 and 256"
+		end
+
+		ip_as_array = to_a
+		ip_as_array[index] = val
+		@ip, @netmask = any_to_int_and_netmask(ip_as_array)
+
+		val
+	end
+
+	# our quads
+	def to_a
+		int_to_array(@ip)
+	end
+
+	def to_s
+		to_a.join(".") + (@netmask == 32 ? "" : "/#{@netmask}")
+	end
+
+	def to_i
+		@ip
+	end
+
+	def inspect
+		"#<#{self.class}: #{self}>"
+	end
+
+	# Return a new IPAddress instance with a netmask of _nmask_ with an IP the
+	# same as ours.
+	# @example
+	#  ip = IPAddress.new("12.4.97.8") / 24 #=> #<IPAddress: 12.4.97.0/24>
+	def /(nmask)
+		self.class.new(self).tap{|x| x.netmask = nmask}
+	end
+
+	def ==(ip)
+		ip = self.class.new(ip) unless ip.is_a? self.class
+
+		ip.to_i == to_i and ip.netmask == @netmask
+	end
+
+	# Is _ip_ in our IP range?
+	def ===(ip)
+		self == ( self.class.new(ip) / @netmask )
+	end
+
+	private
+	def mask(ip_int, nmask)
+		(ip_int >> (32 - nmask)) << (32 - nmask)
+	end
+
+	# Convert an IP address of any of the forms supported by IPAddress#new() to a
+	# Fixnum (also described there) and a netmask.
+	# @return [Fixnum, Fixnum] something like [201613576, 32]
+	def any_to_int_and_netmask(ip)
+		case ip
+			when /^((?:\d+\.){3}\d+)(?:\/(\d+))?$/
+				m = $~
+				int_ip = array_to_int(m[1].split(".").map{|x| x.to_i})
+				nmask = (m[2] || 32).to_i
+
+				return int_ip, nmask
+
+			when Array
+				return array_to_int(ip), 32
+
+			when Integer
+				return ip, 32
+
+			when self.class
+				return ip.to_i, ip.netmask
+
+			else
+				raise NotAnIPError.new(ip)
+		end
+	end
+
+	# Turn an Array representation of an IP address _array_ to an equivalent
+	# Fixnum representation.
+	# @param [Array] array an Array like [12, 4, 97, 8]
+	# @return [Fixnum] array.reduce{ |x, y| x*256 + y }
+	def array_to_int(array)
+		unless array.all?{ |i| (0..256) === i } and array.length == 4
+			raise NotAnIPError.new(array)
+		end
+
+		return array.reduce{ |x, y| x*256 + y }
+	end
+
+	# Turn a Fixnum representation of an IP address _ip_int_ to its Array
+	# equivalent.
+	# @param [Fixnum] ip_int something like 201613576
+	# @return [Array] something like [12, 4, 97, 8]
+	def int_to_array(ip_int)
+		ip_array = Array.new
+
+		4.times do
+			ip_array.unshift( ip_int % 256 )
+			ip_int /= 256
+		end
+
+		ip_array
+	end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: ip_address
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- katmagic
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA90aGUu
+  bWFnaWNhbC5rYXQxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0xMDExMjcwMTQwMTRaFw0xMTExMjcwMTQwMTRaMEYxGDAWBgNV
+  BAMMD3RoZS5tYWdpY2FsLmthdDEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  vVnssXKFL/qdWKIjTbLKZNz+gg78DICoQSVxeO63aSaYMxFtbv0KGXPZDkiFF1Jl
+  m9ZIh+iVmoo9UcENk6CqY1BiMTMZ9QnHPdIFOsw3eBujh1wJ9cXybhaoma2apiIS
+  CtPYPbTs1ucJ8tZUv2jddnj3hlFB2LRjMCquWs70uYhjOAwLkxAi6mijLyeQ+NCk
+  X+wPgYF8mTylt2VbQAQEDtmchURoPtSjc1RTsPmD09JbLVV/5yxqKxZFBP5UfWRy
+  ah/sKsDKIu/GonFvX0t4XQGwDRbT39eETQ/zbkLjwb4Mf32r4CrcWUWN8jqLVonB
+  p59Fvw9gNb7eC2VvCPuF6QIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUEirhbP8V735WXh9StgsdQNg5NXkwDQYJKoZIhvcNAQEFBQAD
+  ggEBAIkMv0N2VTwBvUeEv036tpOAl91MiweXUoPmLba+/ekzowQDb1Y6zQD+Oi10
+  bgae6Je3Vr/t3fewldVLO6zar90rQo9MXa0+QDilogtmDSVQc8gO0eHRnFtix7VM
+  wKcje4Ns3w7zE0ztOkGwdTQaDWKFMGwd1es6hnLTOH09vGtaO2Xu39KXijA71XLM
+  0WspZe4zNBRmcdsNUYArw0KOcB3WLFZ2pI9K9rveB7hkwgAn6rSBf8/evZ9qPinZ
+  PcrsoLG0ZZxFAoFhlVaxZsQhw8aIev48+0uD9l1cy1+rrYsgL4lHlUzK8tndhR0+
+  kCxJ3nT4fqhTbbQYnOuTu8+un3E=
+  -----END CERTIFICATE-----
+
+date: 2010-11-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Easily manipulate IPv4 addresses.
+email: the.magical.kat@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ip_address.rb
+has_rdoc: true
+homepage: https://github.com/katmagic/ip_address
+licenses: 
+- Unlicense (http://unlicense.org)
+post_install_message: 
+rdoc_options: []
+
+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: ip_address
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Work with IP addresses.
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1 @@
+Z�$.���:{���a0��&G�����_J�Zd����ݴ�S�9�[��*�w���r�-Z��Ĥ�T�p>/p�@T�"���%��7th�C���;��Z��������;��m�P]iܩ�����>�w�i���4�4�`����$���]+��O��t/QtY��]%~���
�A)�<C-3�c"&�ޱ�/�憄���R�J[+r�گ�Q�5n�	���T�ڎ�!Cl�?�\|ڞ�$	����DGi�Z��ҥ`�,WU������|