packetgen 3.3.3 → 4.1.0

data/lib/packetgen/header/http/response.rb

@@ -10,25 +10,26 @@ module PacketGen
   module Header
     module HTTP
       # An HTTP/1.1 Response packet consists of:
-      # * the version ({Types::String}).
-      # * the status code ({Types::String}).
-      # * the status message ({Types::String}).
-      # * associated http headers ({HTTP::Headers}).
-      # * the actual http payload body ({Types::String}).
+      # * the version (+BinStruct::String+).
+      # * the status code (+BinStruct::String+).
+      # * the status message (+BinStruct::String+).
+      # * associated HTTP headers ({HTTP::Headers}).
+      # * the actual HTTP payload body (+BinStruct::String+).
       #
-      # == Create a HTTP Response header
+      # Note: When creating a HTTP Response packet, +sport+ and +dport+
+      # attributes of TCP header are not set.
+      #
+      # @example Create a HTTP Response header
       #   # standalone
       #   http_resp = PacketGen::Header::HTTP::Response.new
       #   # in a packet
       #   pkt = PacketGen.gen("IP").add("TCP").add("HTTP::Response")
       #   # access to HTTP Response header
-      #   pkt.http_response # => PacketGen::Header::HTTP::Response
+      #   pkt.http_response.class # => PacketGen::Header::HTTP::Response
       #
-      # Note: When creating a HTTP Response packet, +sport+ and +dport+
-      # attributes of TCP header are not set.
-      #
-      # == HTTP Response attributes
-      #   http_resp.version     = "HTTP/1.1"
+      # @example HTTP Response attributes
+      #   http_resp = PacketGen::Header::HTTP::Response.new
+      #   http_resp.version     #=> "HTTP/1.1"
       #   http_resp.status_code = "200"
       #   http_resp.status_mesg = "OK"
       #   http_resp.body        = "this is a body"
@@ -36,23 +37,28 @@ module PacketGen
       #   http_resp.headers     = { "Host": "tcpdump.org" } # even a hash
       #
       # @author Kent 'picat' Gruber
+      # @author LemonTree55
       class Response < Base
         # @!attribute version
-        #   @return [Types::String]
-        define_field :version,     Types::String, default: 'HTTP/1.1'
+        #   HTTP version
+        #   @return [BinStruct::String]
+        define_attr :version,     BinStruct::String, default: 'HTTP/1.1'
         # @!attribute status_code
-        #   @return [Types::String]
-        define_field :status_code, Types::String
+        #   Response status code
+        #   @return [BinStruct::String]
+        define_attr :status_code, BinStruct::String
         # @!attribute status_mesg
-        #   @return [Types::String]
-        define_field :status_mesg, Types::String
+        #   Response status message
+        #   @return [BinStruct::String]
+        define_attr :status_mesg, BinStruct::String
         # @!attribute headers
         #   associated http/1.1 headers
-        #   @return [Types::String]
-        define_field :headers, HTTP::Headers
+        #   @return [HTTP::Headers]
+        define_attr :headers, HTTP::Headers
         # @!attribute body
-        #   @return [HTTP::PHeaders]
-        define_field :body, Types::String
+        #   Response body
+        #   @return [BinStruct::String]
+        define_attr :body, BinStruct::String
 
         # @param [Hash] options
         # @option options [String] :version
@@ -61,12 +67,12 @@ module PacketGen
         # @option options [String] :body
         # @option options [Hash]   :headers
         def initialize(options={})
-          super(options)
+          super
           self.headers ||= options[:headers]
         end
 
         # Read in the HTTP portion of the packet, and parse it.
-        # @return [PacketGen::HTTP::Response]
+        # @return [self]
         def read(str)
           headers, data = collect_headers_and_data(str)
 
@@ -79,6 +85,8 @@ module PacketGen
           self
         end
 
+        # May be parsed as a HTTP response if version is +HTTP/1.x+.
+        # @return [Boolean]
         def parse?
           version.start_with?('HTTP/1.')
         end
@@ -125,9 +133,9 @@ module PacketGen
           first_line = headers.shift.split
           return if first_line.size < 3
 
-          self[:version].read first_line[0]
-          self[:status_code].read first_line[1]
-          self[:status_mesg].read first_line[2..].join(' ')
+          self[:version].read(first_line[0])
+          self[:status_code].read(first_line[1])
+          self[:status_mesg].read(first_line[2..].join(' '))
         end
 
         def raise_on_bad_version_status

data/lib/packetgen/header/http/verbs.rb

@@ -9,10 +9,8 @@
 module PacketGen
   module Header
     # @since 2.2.0
+    # @author Kent 'picat' Gruber
     module HTTP
-      # @abstract Collection of useful HTTP verbs.
-      # @author Kent 'picat' Gruber
-
       # Valid HTTP Verbs
       VERBS = %w[GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH].freeze
 

data/lib/packetgen/header/icmp.rb

@@ -15,24 +15,25 @@ module PacketGen
     #   |     Type      |     Code      |          Checksum             |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMP header consists of:
-    # * a {#type} field ({Types::Int8} type),
-    # * a {#code} field ({Types::Int8} type),
-    # * a {#checksum} field ({Types::Int16} type),
+    # * a {#type} field (+BinStruct::Int8+ type),
+    # * a {#code} field (+BinStruct::Int8+ type),
+    # * a {#checksum} field (+BinStruct::Int16+ type),
     # * and a {#body}.
     #
-    # == Create a ICMP header
+    # @example Create a ICMP header
     #  # standalone
     #  icmp = PacketGen::Header::ICMP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('ICMP')
     #  # access to ICMP header
-    #  pkt.icmp     # => PacketGen::Header::ICMP
+    #  pkt.icmp.class   # => PacketGen::Header::ICMP
     #
-    # == ICMP attributes
+    # @example ICMP attributes
+    #  icmp = PacketGen::Header::ICMP.new
     #  icmp.code = 0
     #  icmp.type = 200
     #  icmp.checksum = 0x248a
-    #  icmp.body.read 'this is a body'
+    #  icmp.body = 'this is a body'
     # @author Sylvain Daubert
     class ICMP < Base
       # ICMP internet protocol number
@@ -41,18 +42,19 @@ module PacketGen
       # @!attribute type
       #  8-bit ICMP type
       #  @return [Integer]
-      define_field :type, Types::Int8
+      define_attr :type, BinStruct::Int8
       # @!attribute code
       #  8-bit ICMP code
       #  @return [Integer]
-      define_field :code, Types::Int8
+      define_attr :code, BinStruct::Int8
       # @!attribute checksum
       #  16-bit ICMP checksum
       #  @return [Integer]
-      define_field :checksum, Types::Int16
+      define_attr :checksum, BinStruct::Int16
       # @!attribute body
-      #  @return [Types::String,Header::Base]
-      define_field :body, Types::String
+      # ICMP body
+      #  @return [BinStruct::String,Headerable]
+      define_attr :body, BinStruct::String
 
       # Compute checksum and set +checksum+ field
       # @return [Integer]
@@ -61,9 +63,7 @@ module PacketGen
         self.checksum = IP.reduce_checksum(sum)
       end
     end
-
     self.add_class ICMP
-
     IP.bind ICMP, protocol: ICMP::IP_PROTOCOL
   end
 end

data/lib/packetgen/header/icmpv6.rb

@@ -15,30 +15,31 @@ module PacketGen
     #   |     Type      |     Code      |          Checksum             |
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     # A ICMPv6 header consists of:
-    # * a +type+ field ({Types::Int8} type),
-    # * a +code+ field ({Types::Int8} type),
-    # * a +checksum+ field ({Types::Int16} type),
-    # * and a +body+.
+    # * a {#type #type} field (+BinStruct::Int8+ type),
+    # * a {#code #code} field (+BinStruct::Int8+ type),
+    # * a {#checksum #checksum} field (+BinStruct::Int16+ type),
+    # * and a {#body #body}.
     #
-    # == Create a ICMPv6 header
+    # @example Create a ICMPv6 header
     #  # standalone
     #  icmpv6 = PacketGen::Header::ICMPv6.new
     #  # in a packet
     #  pkt = PacketGen.gen('IPv6').add('ICMPv6')
     #  # access to ICMPv6 header
-    #  pkt.icmpv6     # => PacketGen::Header::ICMPv6
+    #  pkt.icmpv6.class  # => PacketGen::Header::ICMPv6
     #
-    # == ICMPv6 attributes
+    # @example ICMPv6 attributes
+    #  icmpv6 = PacketGen::Header::ICMPv6.new
     #  icmpv6.code = 0
     #  icmpv6.type = 200
     #  icmpv6.checksum = 0x248a
-    #  icmpv6.body.read 'this is a body'
+    #  icmpv6.body = 'this is a body'
     # @author Sylvain Daubert
     class ICMPv6 < ICMP
       # ICMPv6 internet protocol number
       IP_PROTOCOL = 58
 
-      # Compute checksum and set +checksum+ field
+      # Compute IPV6-style checksum and set +checksum+ field
       # @return [Integer]
       def calc_checksum
         sum = ip_header(self).pseudo_header_checksum

data/lib/packetgen/header/igmp.rb

@@ -20,25 +20,29 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A IGMP header consists of:
-    # * a {#type} field ({Types::Int8Enum} type),
-    # * a {#max_resp_time} field ({Types::Int8} type),
-    # * a {#checksum} field ({Types::Int16} type),
+    # * a {#type} field (+BinStruct::Int8Enum+ type),
+    # * a {#max_resp_time} field (+BinStruct::Int8+ type),
+    # * a {#checksum} field (+BinStruct::Int16+ type),
     # * a {#group_addr} field ({Header::IP::Addr} type),
     # * and a {#body} (unused for IGMPv2).
     #
-    # == Create a IGMP header
+    # After adding a IGMP header to a packet, you have to call {#igmpize} to ensure
+    # resulting packet conforms to RFC 2236.
+    #
+    # @example Create a IGMP header
     #  # standalone
     #  igmp = PacketGen::Header::IGMP.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('IGMP')
     #  # access to IGMP header
-    #  pkt.igmp    # => PacketGen::Header::IGMP
+    #  pkt.igmp.class  # => PacketGen::Header::IGMP
     #
-    # == IGMP attributes
-    #  icmp.type = 'MembershipQuery'   # or 0x11
-    #  icmp.max_resp_time = 20
-    #  icmp.checksum = 0x248a
-    #  icmp.group_addr = '224.0.0.1'
+    # @example IGMP attributes
+    #  igmp = PacketGen::Header::IGMP.new
+    #  igmp.type = 'MembershipQuery'   # or 0x11
+    #  igmp.max_resp_time = 20
+    #  igmp.checksum = 0x248a
+    #  igmp.group_addr = '224.0.0.1'
     # @author Sylvain Daubert
     # @since 2.4.0
     class IGMP < Base
@@ -56,26 +60,28 @@ module PacketGen
       # @!attribute type
       #  8-bit IGMP Type
       #  @return [Integer]
-      define_field :type, Types::Int8Enum, enum: TYPES
+      define_attr :type, BinStruct::Int8Enum, enum: TYPES
       # @!attribute max_resp_time
       #  8-bit IGMP Max Response Time
       #  @return [Integer]
-      define_field :max_resp_time, Types::Int8
+      define_attr :max_resp_time, BinStruct::Int8
       # @!attribute checksum
       #  16-bit IGMP Checksum
       #  @return [Integer]
-      define_field :checksum, Types::Int16
+      define_attr :checksum, BinStruct::Int16
       # @!attribute group_addr
       #  IP Group address
       #  @return [IP::Addr]
-      define_field :group_addr, IP::Addr, default: '0.0.0.0'
+      define_attr :group_addr, IP::Addr, default: '0.0.0.0'
       # @!attribute body
+      #  IGMP body (not used in IGMPv2)
       #  @return [String,Base]
-      define_field :body, Types::String
+      define_attr :body, BinStruct::String
 
       # @api private
       # @note This method is used internally by PacketGen and should not be
       #       directly called
+      #   Define +#igmpize+ method onto +packet+. This method calls {#igmpize}.
       def added_to_packet(packet)
         igmp_idx = packet.headers.size
         packet.instance_eval "def igmpize() @headers[#{igmp_idx}].igmpize; end" # def igmpize() @headers[2].igmpize; end
@@ -103,6 +109,11 @@ module PacketGen
       #    pkt.igmp.igmpize
       #    # second method
       #    pkt.igmpize
+      # @example
+      #   pkt = PacketGen.gen('IP').add('IGMP', type: 'MembershipQuery', max_resp_time: 20, group_addr: '1.2.3.4')
+      #   pkt.igmpize
+      #   pkt.ip.ttl     #=> 1
+      #   pkt.ip.options.map(&:class) #=> [PacketGen::Header::IP::RA]
       # @return [void]
       def igmpize
         iph = ip_header(self)

data/lib/packetgen/header/igmpv3/group_record.rb

@@ -11,7 +11,7 @@ module PacketGen
     class IGMPv3
       # Class to handle IGMPv3 Group Records.
       #
-      # A Group Record is a block of fields containing information
+      # A Group Record is a block of attributes containing information
       # pertaining to the sender's membership in a single multicast group on
       # the interface from which the Report is sent.
       #
@@ -40,8 +40,8 @@ module PacketGen
       #   |                                                               |
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       # @author Sylvain Daubert
-      class GroupRecord < Types::Fields
-        include Types::Fieldable
+      class GroupRecord < BinStruct::Struct
+        include BinStruct::Structable
 
         # Known record types
         RECORD_TYPES = {
@@ -56,34 +56,39 @@ module PacketGen
         # @!attribute type
         #  8-bit record type
         #  @return [Integer]
-        define_field :type, Types::Int8Enum, enum: RECORD_TYPES
+        define_attr :type, BinStruct::Int8Enum, enum: RECORD_TYPES
         # @!attribute aux_data_len
         #  8-bit length of of the Auxiliary Data field ({#aux_data}), in unit of
         #  32-bit words
         #  @return [Integer]
-        define_field :aux_data_len, Types::Int8, default: 0
+        define_attr :aux_data_len, BinStruct::Int8, default: 0
         # @!attribute number_of_sources
         #  16-bit Number of source addresses in {#source_addr}
         #  @return [Integer]
-        define_field :number_of_sources, Types::Int16, default: 0
+        define_attr :number_of_sources, BinStruct::Int16, default: 0
         # @!attribute multicast_addr
         #  IP multicast address to which this Group Record pertains
         #  @return [IP::Addr]
-        define_field :multicast_addr, IP::Addr, default: '0.0.0.0'
+        define_attr :multicast_addr, IP::Addr, default: '0.0.0.0'
         # @!attribute source_addr
         #  Array of source addresses
         #  @return [IP::ArrayOfAddr]
-        define_field :source_addr, IP::ArrayOfAddr,
-                     builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
+        define_attr :source_addr, IP::ArrayOfAddr,
+                    builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
         # @!attribute aux_data
+        #    Not used in IGMPv3
         #  @return [String]
-        define_field :aux_data, Types::String,
-                     builder: ->(h, t) { t.new(length_from: -> { h[:aux_data_len].to_i * 4 }) }
+        define_attr :aux_data, BinStruct::String,
+                    builder: ->(h, t) { t.new(length_from: -> { h[:aux_data_len].to_i * 4 }) }
 
+        # Human-readable type
+        # @return [String]
         def human_type
           self[:type].to_human
         end
 
+        # Human-readable description of a group record
+        # @return [String]
         def to_human
           "#{human_type}(ma:#{multicast_addr}|src:#{source_addr.to_human})"
         end
@@ -91,10 +96,10 @@ module PacketGen
 
       # Class to handle series of {GroupRecord}.
       # @author Sylvain Daubert
-      class GroupRecords < Types::Array
+      class GroupRecords < BinStruct::Array
         set_of GroupRecord
 
-        # Separator used in {#to_human}.
+        # Separator used in +#to_human+.
         HUMAN_SEPARATOR = ';'
       end
     end

data/lib/packetgen/header/igmpv3/mq.rb

@@ -31,7 +31,7 @@ module PacketGen
       #   |                       Source Address [N]                      |
       #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
       #
-      # Fields are:
+      # Struct are:
       # * 32-bit {#group_addr} field ({Header::IP::Addr} type),
       # * 4-bit {#resv}, a reserved field,
       # * 1-bit {#flag_s} (Suppress Router-Side Processing),
@@ -44,36 +44,34 @@ module PacketGen
         # @!attribute group_addr
         #  IP Group address
         #  @return [IP::Addr]
-        define_field :group_addr, IP::Addr, default: '0.0.0.0'
+        define_attr :group_addr, IP::Addr, default: '0.0.0.0'
         # @!attribute u8
         #  First 8-bit field, composed of {#resv}, {#flag_s} and {#qrv}
         #  @return [Integer]
-        define_field :u8, Types::Int8
+        # @!attribute resv
+        #  4-bit reserved field
+        #  @return [Integer]
+        # @!attribute flag_s
+        #  1-bit S flag (Suppress Router-Side Processing)
+        #  @return [Integer]
+        # @!attribute qrv
+        #  3-bit Querier's Robustness Variable
+        #  @return [Integer]
+        define_bit_attr :u8, resv: 4, flag_s: 1, qrv: 3
         # @!attribute qqic
         #  8-bit QQIC
         #  @return [Integer,Float]
-        define_field :qqic, Types::Int8
+        define_attr :qqic, BinStruct::Int8
         # @!attribute number_of_sources
         #  16-bit Number of Sources in {#source_addr}
         #  @return [Integer]
-        define_field :number_of_sources, Types::Int16
+        define_attr :number_of_sources, BinStruct::Int16
 
         # @!attribute source_addr
         #  Array of IP source addresses
         #  @return [IP::ArrayOfAddr]
-        define_field :source_addr, IP::ArrayOfAddr,
-                     builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
-
-        # @!attribute resv
-        #  4-bit reserved field in
-        #  @return [Integer]
-        # @!attribute flag_s
-        #  1-bit S flag (Suppress Router-Side Processing)
-        #  @return [Boolean]
-        # @!attribute qrv
-        #  3-bit Querier's Robustness Variable
-        #  @return [Integer]
-        define_bit_fields_on :u8, :resv, 4, :flag_s, :qrv, 3
+        define_attr :source_addr, IP::ArrayOfAddr,
+                    builder: ->(h, t) { t.new(counter: h[:number_of_sources]) }
 
         undef qqic, qqic=
 

data/lib/packetgen/header/igmpv3/mr.rb

@@ -48,18 +48,18 @@ module PacketGen
       class MR < Base
         # @!attribute reserved
         #  16-bit reserved field
-        # @return [Integer]
-        define_field :reserved, Types::Int16, default: 0
+        #  @return [Integer]
+        define_attr :reserved, BinStruct::Int16, default: 0
         # @!attribute number_of_gr
         #  16-bit Number of group records in {#group_records}
         #  @return [Integer]
-        define_field :number_of_gr, Types::Int16, default: 0
+        define_attr :number_of_gr, BinStruct::Int16, default: 0
 
         # @!attribute group_records
         #  Array of group records
         #  @return [GroupRecords]
-        define_field :group_records, GroupRecords,
-                     builder: ->(h, t) { t.new(counter: h[:number_of_gr]) }
+        define_attr :group_records, GroupRecords,
+                    builder: ->(h, t) { t.new(counter: h[:number_of_gr]) }
       end
     end
 

data/lib/packetgen/header/igmpv3.rb

@@ -18,23 +18,24 @@ module PacketGen
     #   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
     #
     # A IGMP header consists of:
-    # * a {#type} field ({Types::Int8Enum} type),
-    # * a {#max_resp_time} field ({Types::Int8} type),
-    # * a {#checksum} field ({Types::Int16} type),
-    # * and a {#body}, containing more fields (see below).
+    # * a {#type #type} field (+BinStruct::Int8Enum+ type),
+    # * a {#max_resp_time #max_resp_time} field (+BinStruct::Int8+ type),
+    # * a {#checksum #checksum} field (+BinStruct::Int16+ type),
+    # * and a {#body #body}, containing more fields (see below).
     #
-    # A IGMPv3 header may have additionnal fields. These fields are handled by
+    # A IGMPv3 header may have additionnal fields. These attributes are handled by
     # additional headers (see {IGMPv3::MQ}).
     #
-    # == Create a IGMPv3 header
+    # @example Create a IGMPv3 header
     #  # standalone
     #  igmp = PacketGen::Header::IGMPv3.new
     #  # in a packet
     #  pkt = PacketGen.gen('IP').add('IGMPv3')
     #  # access to IGMPv3 header
-    #  pkt.igmp    # => PacketGen::Header::IGMPv3
+    #  pkt.igmpv3.class  # => PacketGen::Header::IGMPv3
     #
-    # == IGMPv3 attributes
+    # @example IGMPv3 attributes
+    #  igmp = PacketGen::Header::IGMPv3.new
     #  igmp.type = 'MembershipQuery'   # or 0x11
     #  igmp.max_resp_time = 20
     #  igmp.checksum = 0x248a
@@ -50,14 +51,14 @@ module PacketGen
     #   igmp.max_resp_code   #=> 9728  error due to encoding as a floating point value
     #
     # === IGMPv3 Membership Query
-    # With IGMPv3, a Membership Query packet has more fields than with IGMPv2. To
+    # With IGMPv3, a Membership Query packet has more attributes than with IGMPv2. To
     # handle those fields, an additional header should be used:
     #   pkt = PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MQ')
     #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3
     #   pkt.igmpv3_mq   #=> PacketGen::Header::IGMPv3::MQ
     #
     # === IGMPv3 Membership Report
-    # With IGMPv3, a Membership Report packet has more fields than with IGMPv2. To
+    # With IGMPv3, a Membership Report packet has more attributes than with IGMPv2. To
     # handle those fields, an additional header should be used:
     #   pkt =  PacketGen.gen('IP').add('IGMPv3', type: 'MembershipQuery').add('IGMPv3::MR')
     #   pkt.igmpv3      #=> PacketGen::Header::IGMPv3
@@ -71,7 +72,7 @@ module PacketGen
         'MembershipReport' => 0x22,
       }.freeze
 
-      remove_field :group_addr
+      remove_attr :group_addr
 
       # Encode value for IGMPv3 Max Resp Code and QQIC.
       # Value may be encoded as a float, so some error may occur.

data/lib/packetgen/header/ip/addr.rb

@@ -11,23 +11,24 @@ module PacketGen
     class IP
       # IP address, as a group of 4 bytes
       # @author Sylvain Daubert
-      class Addr < Types::Fields
-        include Types::Fieldable
+      class Addr < BinStruct::Struct
+        include BinStruct::Structable
 
         # @!attribute a1
         #  @return [Integer] IP address first byte
-        define_field :a1, Types::Int8
+        define_attr :a1, BinStruct::Int8
         # @!attribute a2
-        #  @return [Integer] IP address seconf byte
-        define_field :a2, Types::Int8
+        #  @return [Integer] IP address second byte
+        define_attr :a2, BinStruct::Int8
         # @!attribute a3
         #  @return [Integer] IP address third byte
-        define_field :a3, Types::Int8
+        define_attr :a3, BinStruct::Int8
         # @!attribute a4
         #  @return [Integer] IP address fourth byte
-        define_field :a4, Types::Int8
+        define_attr :a4, BinStruct::Int8
 
-        IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/.freeze
+        ## Regex to match IPv4 addresses
+        IPV4_ADDR_REGEX = /^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/
 
         # Read a dotted address
         # @param [String] str
@@ -37,10 +38,10 @@ module PacketGen
 
           m = str.match(IPV4_ADDR_REGEX)
           if m
-            self[:a1].read m[1].to_i
-            self[:a2].read m[2].to_i
-            self[:a3].read m[3].to_i
-            self[:a4].read m[4].to_i
+            self[:a1].from_human(m[1].to_i)
+            self[:a2].from_human(m[2].to_i)
+            self[:a3].from_human(m[3].to_i)
+            self[:a4].from_human(m[4].to_i)
           end
           self
         end
@@ -48,10 +49,10 @@ module PacketGen
         # Addr in human readable form (dotted format)
         # @return [String]
         def to_human
-          fields.map { |f| self[f].to_i.to_s }.join('.')
+          attributes.map { |f| self[f].to_i.to_s }.join('.')
         end
 
-        # Addr as an integer
+        # Addr as a 32-bit integer
         # @return [Integer]
         def to_i
           (self.a1 << 24) | (self.a2 << 16) | (self.a3 << 8) |
@@ -64,9 +65,12 @@ module PacketGen
           self.a1 >= 224 && self.a1 <= 239
         end
 
+        # Check equality.
+        # Equal is other has same class and all attributes are equal.
+        # @return [Boolean]
         def ==(other)
           other.is_a?(self.class) &&
-            fields.all? { |attr| self[attr].value == other[attr].value }
+            attributes.all? { |attr| self[attr].value == other[attr].value }
         end
       end
     end