packetgen 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be94839db4cb9f9a818fdf5b948f34185198d7f8445545d13763cf57f313eb3a
-  data.tar.gz: 0cf02398bb76d3bb9083f6bbcb1e873b81c686e822ac3e63790a0b5f5d5155b7
+  metadata.gz: 877d57dd457d4cde03fca6e13c0042168c8630b08073533b7b7fb95da49632a0
+  data.tar.gz: 5c18abe50abcb423edf22571e88241cddb6095a0c626fb6018bfbafac49278b1
 SHA512:
-  metadata.gz: c72f91e241484140503a997aca5aa930cb8d3e357103b0af617231d7c49fa791b49537916fd68bb5c8d77b901c203500babf18cfe5c2df40900bfc2a30feb90b
-  data.tar.gz: d76180f3c3089218d67a0840d4f94c802c94bd8990cc45b91062414bba175973cc6f97287c1be99ccd87c063d7ebb17f210f15cc49fdd9eb649ec3465b29ea8e
+  metadata.gz: '09c0197e3f3d1bf72dffbaf97abc4007902ade04b94a6893d1a79e97944e6560eb16aad024726497a064b9fdc59fed5efd8e456cffcaa3f7bf64b7b0c7a2604c'
+  data.tar.gz: 575402b40e5be3c8bf6d68e8dfd01fa3b4a9d3e917fda6cefa17b0759f99193bb69a5e3b5734cfa839e149856d7d98ea88e13bb8fa273c9ac295a94a79e7502b

data/lib/packetgen/deprecation.rb

@@ -4,7 +4,19 @@ module PacketGen
   # @author Sylvain Daubert
   # @api private
   module Deprecation
-    def self.deprecated(klass, deprecated_method, new_method=nil, klass_method: false, remove_version: '4.0.0')
+    # Default remove version for deprecated classes/methods
+    # @since 3.1.0
+    REMOVE_VERSION = '4.0.0'
+
+    # Warn when using a deprecated method
+    # @param [Module] klass class/module of deprecated method
+    # @param [Symbol,String] deprecated_method
+    # @param [Symbol,String,nil] new_method method to use instead of deprecated one
+    # @param [Boolean] klass_method +deprecated_method+ is a class method (+true+)
+    #                  or a, instance one (+false+)
+    # @param [String] remove_version version from which +deprecated_method+ will
+    #                 no more exist.
+    def self.deprecated(klass, deprecated_method, new_method=nil, klass_method: false, remove_version: REMOVE_VERSION)
       separator = klass_method ? '.' : '#'
       base_name = klass.to_s + separator
       complete_deprecated_method_name = base_name + deprecated_method.to_s
@@ -12,7 +24,21 @@ module PacketGen
 
       file, line = caller(2).first.split(':')[0, 2]
       message = +"#{file}:#{line}: #{complete_deprecated_method_name} is deprecated"
-      message << "in favor of #{complete_new_method_name}" unless new_method.nil?
+      message << " in favor of #{complete_new_method_name}" unless new_method.nil?
+      message << ". It will be remove in PacketGen #{remove_version}."
+      warn message
+    end
+
+    # Warn when using a deprecated method
+    # @param [Module] klass deprecated class/module
+    # @param [Module] new_klass class/module to use instead of +klass+
+    # @param [String] remove_version version from which +klass+ will
+    #                 no more exist.
+    # @since 3.1.0
+    def self.deprecated_class(klass, new_klass=nil, remove_version: REMOVE_VERSION)
+      file, line = caller(2..2).first.split(':')[0, 2]
+      message = +"#{file}:#{line}: #{klass} is deprecated"
+      message << " in favor od #{new_klass}" unless new_klass.nil?
       message << ". It will be remove in PacketGen #{remove_version}."
       warn message
     end

data/lib/packetgen/header/dhcp/option.rb

@@ -8,54 +8,70 @@
 module PacketGen
   module Header
     class DHCP
-      # define DHCP Options.
-      # keys are option type, value are arrays containing option names
-      # as strings, and a hash passed to {Option#initialize}.
-      # @since 2.7.0
+      # Known DHCP options
+      # @since 3.1.0
       DHCP_OPTIONS = {
-        1  => ['subnet_mask', length: 4, v: IP::Addr],
-        2  => ['time_zone'],
-        3  => ['router', length: 4, v: IP::Addr],
-        4  => ['time_server', length: 4, v: IP::Addr],
-        5  => ['IEN_name_server', length: 4, v: IP::Addr],
-        6  => ['name_server', length: 4, v: IP::Addr],
-        7  => ['log_server', length: 4, v: IP::Addr],
-        8  => ['cookie_server', length: 4, v: IP::Addr],
-        9  => ['lpr_server', length: 4, v: IP::Addr],
-        12 => ['hostname'],
-        14 => ['dump_path'],
-        15 => ['domain'],
-        17 => ['root_disk_path'],
-        23 => ['default_ttl'],
-        24 => ['pmtu_timeout'],
-        28 => ['broadcast_address', length: 4, v: IP::Addr],
-        40 => ['NIS_domain'],
-        41 => ['NIS_server', length: 4, v: IP::Addr],
-        42 => ['NTP_server', length: 4, v: IP::Addr],
-        43 => ['vendor_specific'],
-        44 => ['NetBIOS_server', length: 4, v: IP::Addr],
-        45 => ['NetBIOS_dist_server', length: 4, v: IP::Addr],
-        50 => ['requested_addr', length: 4, v: IP::Addr],
-        51 => ['lease_time', length: 4, v: Types::Int32, value: 43_200],
-        53 => ['message-type', length: 1, v: Types::Int8],
-        54 => ['server_id', length: 4, v: IP::Addr],
-        55 => ['param_req_list'],
-        56 => ['error_message'],
-        57 => ['max_dhcp_size', length: 2, v: Types::Int16, value: 1_500],
-        58 => ['renewal_time', length: 4, v: Types::Int32, value: 21_600],
-        59 => ['rebinding_time', length: 4, v: Types::Int32, value: 37_800],
-        60 => ['vendor_class_id'],
-        61 => ['client_id'],
-        64 => ['NISplus_domain'],
-        65 => ['NISplus_server', length: 4, v: IP::Addr],
-        69 => ['SMTP_server', length: 4, v: IP::Addr],
-        70 => ['POP3_server', length: 4, v: IP::Addr],
-        71 => ['NNTP_server', length: 4, v: IP::Addr],
-        72 => ['WWW_server', length: 4, v: IP::Addr],
-        73 => ['finger_server', length: 4, v: IP::Addr],
-        74 => ['IRC_server', length: 4, v: IP::Addr]
+        'pad' => 0,
+        'subnet_mask' => 1,
+        'time_zone' => 2,
+        'router' => 3,
+        'time_server' => 4,
+        'IEN_name_server' => 5,
+        'name_server' => 6,
+        'log_server' => 7,
+        'cookie_server' => 8,
+        'lpr_server' => 9,
+        'hostname' => 12,
+        'dump_path' => 14,
+        'domain' => 15,
+        'root_disk_path' => 17,
+        'default_ttl' => 23,
+        'pmtu_timeout' => 24,
+        'broadcast_address' => 28,
+        'NIS_domain' => 40,
+        'NIS_server' => 41,
+        'NTP_server' => 42,
+        'vendor_specific' => 43,
+        'NetBIOS_server' => 44,
+        'NetBIOS_dist_server' => 45,
+        'requested_addr' => 50,
+        'lease_time' => 51,
+        'message-type' => 53,
+        'server_id' => 54,
+        'param_req_list' => 55,
+        'error_message' => 56,
+        'max_dhcp_size' => 57,
+        'renewal_time' => 58,
+        'rebinding_time' => 59,
+        'vendor_class_id' => 60,
+        'client_id' => 61,
+        'NISplus_domain' => 64,
+        'NISplus_server' => 65,
+        'SMTP_server' => 69,
+        'POP3_server' => 70,
+        'NNTP_server' => 71,
+        'WWW_server' => 72,
+        'finger_server' => 73,
+        'IRC_server' => 74,
+        'end' => 255
       }.freeze
 
+      # Option class with string value
+      Option = Types::AbstractTLV.create
+      Option.define_type_enum DHCP_OPTIONS
+      # Option class with IP address value
+      IPAddrOption = Types::AbstractTLV.create(value_class: IP::Addr)
+      IPAddrOption.define_type_enum DHCP_OPTIONS
+      # Option class with int8 value
+      Int8Option = Types::AbstractTLV.create(value_class: Types::Int8)
+      Int8Option.define_type_enum DHCP_OPTIONS
+      # Option class with int16 value
+      Int16Option = Types::AbstractTLV.create(value_class: Types::Int16)
+      Int16Option.define_type_enum DHCP_OPTIONS
+      # Option class with int32 value
+      Int32Option = Types::AbstractTLV.create(value_class: Types::Int32)
+      Int32Option.define_type_enum DHCP_OPTIONS
+
       # Class to indicate DHCP options end
       class End < Types::Int8
         def initialize(value=255)
@@ -74,90 +90,6 @@ module PacketGen
           super
         end
       end
-
-      # DHCP option
-      #
-      # A DHCP option is a {Types::TLV TLV}, so it has:
-      # * a {#type} ({Types::Int8}),
-      # * a {#length} ({Types::Int8}),
-      # * and a {#value}. Defalt type is {Types::String} but some options
-      #   may use more suitable type (by example, a {IP::Addr} for +router+
-      #   option).
-      # @author Sylvain Daubert
-      class Option < Types::TLV
-        # Option types
-        TYPES = Hash[DHCP_OPTIONS.to_a.map { |type, ary| [type, ary[0]] }]
-
-        # @param [Hash] options
-        # @option options [Integer] :type
-        # @option options [Integer] :length
-        # @option options [String] :value
-        def initialize(options={})
-          super
-          return unless DHCP_OPTIONS.key?(self.type)
-
-          h = DHCP_OPTIONS[self.type].last
-          return unless h.is_a? Hash
-
-          h.each do |k, v|
-            self.length = v if k == :length
-            if k == :v
-              self[:value] = v.new
-              self.value = options[:value] if options[:value]
-            end
-          end
-        end
-
-        # @private
-        alias private_read read
-
-        # Populate object from a binary string
-        # @param [String] str
-        # @return [Option,End,Pad] may return another object than itself
-        def read(str)
-          read_type = str[0].unpack('C').first
-          if read_type.zero?
-            Pad.new.read(str)
-          elsif read_type == 255
-            End.new.read(str)
-          elsif DHCP_OPTIONS.key?(read_type)
-            Option.new(DHCP_OPTIONS[read_type][1] || {}).private_read(str)
-          else
-            super
-          end
-        end
-
-        # @since 2.7.0
-        # @return [true]
-        def human_types?
-          true
-        end
-
-        # Get human-readable type
-        # @return [String]
-        def human_type
-          if DHCP_OPTIONS.key?(type)
-            DHCP_OPTIONS[type].first.dup
-          else
-            type.to_s
-          end
-        end
-
-        # @return [String]
-        def to_human
-          s = human_type
-          if length > 0
-            s << if value.respond_to? :to_human
-                   ":#{value.to_human}"
-                 elsif self[:value].is_a? Types::Int
-                   ":#{self.value.to_i}"
-                 else
-                   ":#{value.inspect}"
-                 end
-          end
-          s
-        end
-      end
     end
   end
 end

data/lib/packetgen/header/dhcp/options.rb

@@ -26,15 +26,23 @@ module PacketGen
 
         private
 
-        def record_from_hash(hsh)
-          case hsh[:type]
-          when 'pad', 0
-            Pad.new
-          when 'end', 255
-            End.new
+        def real_type(obj)
+          case obj.type
+          when 0
+            Pad
+          when 1, 3, 4, 5, 6, 7, 8, 9, 28, 41, 42, 44, 45, 50, 54, 65, 69,
+               70, 71, 72, 73, 74
+            IPAddrOption
+          when 53
+            Int8Option
+          when 57
+            Int16Option
+          when 51, 58, 59
+            Int32Option
+          when 255
+            End
           else
-            obj_klass = self.class.set_of_klass
-            obj_klass.new(hsh)
+            Option
           end
         end
       end

data/lib/packetgen/header/dns/option.rb

@@ -9,14 +9,8 @@ module PacketGen
   module Header
     class DNS
       # DNS option
-      # @author Sylvain Daubert
-      class Option < Types::TLV
-        # Force {#type} and {#length} fields to be {Types::Int16}
-        # @see TLV#initialize
-        def initialize(options={})
-          super options.merge!(t: Types::Int16, l: Types::Int16)
-        end
-      end
+      Option = Types::AbstractTLV.create(type_class: Types::Int16,
+                                         length_class: Types::Int16)
     end
   end
 end

data/lib/packetgen/header/dot11/element.rb

@@ -12,8 +12,9 @@ module PacketGen
       # IEEE 802.11 information element
       #
       # An {Element} is a piece of data contained in a Dot11 management frame.
-      # @author Sylvain Daubert
-      class Element < Types::TLV
+      Element = Types::AbstractTLV.create
+
+      class Element
         # Known element types
         TYPES = {
           0 =>   'SSID',
@@ -33,6 +34,7 @@ module PacketGen
           221 => 'vendor'
         }.freeze
       end
+      Element.define_type_enum Element::TYPES.invert
     end
   end
 end

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

@@ -9,7 +9,7 @@ module PacketGen
   module Header
     module HTTP
       # An HTTP/1.1 Request packet consists of:
-      # * the http method ({Types::String}).
+      # * the http verb ({Types::String}).
       # * the path ({Types::String}).
       # * the version ({Types::String}).
       # * associated http headers ({HTTP::Headers}).
@@ -27,16 +27,19 @@ module PacketGen
       #
       # == HTTP Request attributes
       #   http_rqst.version = "HTTP/1.1"
-      #   http_rqst.method  = "GET"
+      #   http_rqst.verb  = "GET"
       #   http_rqst.path    = "/meow.html"
       #   http_rqst.headers = "Host: tcpdump.org"     # string or
       #   http_rqst.headers = { "Host": "tcpdump.org" } # even a hash
       #
       # @author Kent 'picat' Gruber
+      # @author Sylvain Daubert
+      # @since 3.1.0 Rename +#method+ into {#verb} to not mask +Object#method+.
       class Request < Base
-        # @!attribute method
+        # @!attribute verb
         #   @return [Types::String]
-        define_field :method,  Types::String
+        #   @since 3.1.0
+        define_field :verb,  Types::String
         # @!attribute path
         #   @return [Types::String]
         define_field :path,    Types::String
@@ -52,7 +55,7 @@ module PacketGen
         define_field :body, Types::String
 
         # @param [Hash] options
-        # @option options [String] :method
+        # @option options [String] :verb
         # @option options [String] :path
         # @option options [String] :version
         # @option options [Hash]   :headers
@@ -69,7 +72,7 @@ module PacketGen
           str = vrb + str.split(vrb)[-1]
           str = str.split("\n").map(&:chomp)
           first_line = str.shift.split
-          self[:method].read first_line[0]
+          self[:verb].read first_line[0]
           self[:path].read first_line[1]
           self[:version].read first_line[2]
           # requests can sometimes have a payload
@@ -87,12 +90,12 @@ module PacketGen
         # String representation of data.
         # @return [String]
         def to_s
-          raise FormatError, 'Missing #method.'  if self.method.empty?
+          raise FormatError, 'Missing #verb.'  if self.verb.empty?
           raise FormatError, 'Missing #path.'    if self.path.empty?
           raise FormatError, 'Missing #version.' if self.version.empty?
 
           str = ''.dup # build 'dat string
-          str << self[:method] << ' ' << self[:path] << ' ' << self[:version] << "\r\n" << self[:headers].to_s << self[:body]
+          str << self[:verb] << ' ' << self[:path] << ' ' << self[:version] << "\r\n" << self[:headers].to_s << self[:body]
         end
       end
     end

data/lib/packetgen/header/ipv6/hop_by_hop.rb

@@ -8,9 +8,10 @@
 module PacketGen
   module Header
     class IPv6
-      # Option for {HopByHop} IPv6 extension header
-      # @author Sylvain Daubert
-      class Option < Types::TLV
+      # Option for {HopByHop} IPv6 extension header.
+      Option = Types::AbstractTLV.create
+
+      class Option
         # Known option types
         TYPES = {
           1 => 'padn',
@@ -27,6 +28,7 @@ module PacketGen
           end
         end
       end
+      Option.define_type_enum Option::TYPES.invert
 
       # Special option pad1, for {HopByHop} IPv6 extension header
       # @author Sylvain Daubert

data/lib/packetgen/packet.rb

@@ -181,7 +181,7 @@ module PacketGen
     # Recalculate all packet length fields
     # @return [void]
     def calc_length
-      headers.each do |header|
+      headers.reverse_each do |header|
         header.calc_length if header.respond_to? :calc_length
       end
     end

data/lib/packetgen/types/abstract_tlv.rb

@@ -0,0 +1,137 @@
+# coding: utf-8
+# This file is part of PacketGen
+# See https://github.com/sdaubert/packetgen for more informations
+# Copyright (C) 2016 Sylvain Daubert <sylvain.daubert@laposte.net>
+# This program is published under MIT license.
+
+# frozen_string_literal: true
+
+module PacketGen
+  module Types
+    # This class is an abstract class to define type-length-value data.
+    #
+    # This class supersede {TLV} class, which is not well defined on some corner
+    # cases.
+    #
+    # ===Usage
+    # To simply define a new TLV class, do:
+    #   MyTLV = PacketGen::Types::AbstractTLV.create
+    #   MyTLV.define_type_enum 'one' => 1, 'two' => 2
+    # This will define a new +MyTLV+ class, subclass of {Fields}. This class will
+    # define 3 fields:
+    # * +#type+, as a {Int8Enum} by default,
+    # * +#length+, as a {Int8} by default,
+    # * and +#value+, as a {String} by default.
+    # +.define_type_enum+ is, here, necessary to define enum hash to be used
+    # for +#type+ accessor, as this one is defined as an {Enum}.
+    #
+    # This class may then be used as older {TLV} class:
+    #   tlv = MyTLV.new(type: 1, value: 'abcd')  # automagically set #length from value
+    #   tlv.type        #=> 1
+    #   tlv.human_type  #=> 'one'
+    #   tlv.length      #=> 4
+    #   tlv.value       #=> "abcd"
+    #
+    # ===Advanced usage
+    # Each field's type may be change at generating TLV class:
+    #   MyTLV = PacketGen::Types::AbstractTLV.create(type_class: PacketGen::Types::Int16,
+    #                                                length_class: PacketGen::Types::Int16,
+    #                                                value_class: PacketGen::Header::IP::Addr)
+    #   tlv = MyTLV.new(type: 1, value: '1.2.3.4')
+    #   tlv.type        #=> 1
+    #   tlv.length      #=> 4
+    #   tlv.value       #=> 42
+    #   tlv.to_s        #=> "\x00\x01\x00\x04\x01\x02\x03\x04"
+    # @author Sylvain Daubert
+    # @since 3.1.0
+    class AbstractTLV < Types::Fields
+      # Generate a TLV class
+      # @param [Class] type_class Class to use for +type+
+      # @param [Class] length_class Class to use for +length+
+      # @param [Class] value_class Class to use for +value+
+      # @return [Class]
+      def self.create(type_class: Int8Enum, length_class: Int8, value_class: String)
+        raise Error, '.create cannot be called on a subclass of PacketGen::Types::AbstractTLV' unless self.equal? AbstractTLV
+
+        klass = Class.new(self)
+
+        if type_class < Enum
+          klass.define_field :type, type_class, enum: {}
+        else
+          klass.define_field :type, type_class
+        end
+        klass.define_field :length, length_class
+        klass.define_field :value, value_class
+
+        klass
+      end
+      # @!attribute type
+      #   @abstract Type attribute for real TLV class
+      #   @return [Integer]
+      # @!attribute length
+      #   @abstract Length attribute for real TLV class
+      #   @return [Integer]
+      # @!attribute value
+      #   @abstract Value attribute for real TLV class
+      #   @return [Object]
+
+      # @abstract Should only be called on real TLV classes, created by {.create}.
+      # Set enum hash for {#type} field.
+      # @param [Hash] hsh enum hash
+      # @return [void]
+      def self.define_type_enum(hsh)
+        field_defs[:type][:enum].clear
+        field_defs[:type][:enum].merge!(hsh)
+      end
+
+      # @abstract Should only be called on real TLV classes, created by {.create}.
+      # @param [Hash] options
+      # @option options [Integer] :type
+      # @option options [Integer] :length
+      # @option options [Object] :value
+      def initialize(options={})
+        super
+        # used #value= defined below, which set length if needed
+        self.value = options[:value] if options[:value]
+      end
+
+      # @abstract Should only be called on real TLV class instances.
+      # Populate object from a binary string
+      # @param [String] str
+      # @return [Fields] self
+      def read(str)
+        idx = 0
+        self[:type].read str[idx, self[:type].sz]
+        idx += self[:type].sz
+        self[:length].read str[idx, self[:length].sz]
+        idx += self[:length].sz
+        self[:value].read str[idx, self.length]
+        self
+      end
+
+      # @abstract Should only be called on real TLV class instances.
+      # Set +value+. May set +length+ if value is a {Types::String}.
+      # @param [::String,Integer] val
+      # @return [::String,Integer]
+      def value=(val)
+        self[:value].from_human val
+        self.length = self[:value].sz
+        val
+      end
+
+      # @abstract Should only be called on real TLV class instances.
+      # Get human-readable type
+      # @return [String]
+      def human_type
+        self[:type].to_human.to_s
+      end
+
+      # @abstract Should only be called on real TLV class instances.
+      # @return [String]
+      def to_human
+        my_value = self[:value].is_a?(String) ? value.inspect : value.to_human
+        "type:%s,length:%u,value:#{my_value}" % [human_type, length]
+      end
+    end
+  end
+end

data/lib/packetgen/types/fields.rb

@@ -115,6 +115,11 @@ module PacketGen
       @bit_fields = {}
 
       class <<self
+        # Get field definitions for this class.
+        # @return [Hash]
+        # @since 3.1.0
+        attr_reader :field_defs
+
         # On inheritage, create +@field_defs+ class variable
         # @param [Class] klass
         # @return [void]
@@ -188,15 +193,15 @@ module PacketGen
                       "end"
           end
 
-          define.delete(1) if type.instance_methods.include? "#{name}=".to_sym
-          define.delete(0) if type.instance_methods.include? name
+          define.delete_at(1) if instance_methods.include? "#{name}=".to_sym
+          define.delete_at(0) if instance_methods.include? name
           class_eval define.join("\n")
-          @field_defs[name] = FieldDef.new(type,
-                                           options.delete(:default),
-                                           options.delete(:builder),
-                                           options.delete(:optional),
-                                           options.delete(:enum),
-                                           options)
+          field_defs[name] = FieldDef.new(type,
+                                          options.delete(:default),
+                                          options.delete(:builder),
+                                          options.delete(:optional),
+                                          options.delete(:enum),
+                                          options)
           fields << name
         end
 
@@ -257,13 +262,13 @@ module PacketGen
         # @raise [ArgumentError] unknown +field+
         # @since 2.8.4
         def update_field(field, options)
-          raise ArgumentError, "unkown #{field} field for #{self}" unless @field_defs.key?(field)
+          raise ArgumentError, "unkown #{field} field for #{self}" unless field_defs.key?(field)
 
-          @field_defs[field].default = options.delete(:default) if options.key?(:default)
-          @field_defs[field].builder = options.delete(:builder) if options.key?(:builder)
-          @field_defs[field].optional = options.delete(:optional) if options.key?(:optional)
-          @field_defs[field].enum = options.delete(:enum) if options.key?(:enum)
-          @field_defs[field].options.merge!(options)
+          field_defs[field].default = options.delete(:default) if options.key?(:default)
+          field_defs[field].builder = options.delete(:builder) if options.key?(:builder)
+          field_defs[field].optional = options.delete(:optional) if options.key?(:optional)
+          field_defs[field].enum = options.delete(:enum) if options.key?(:enum)
+          field_defs[field].options.merge!(options)
         end
 
         # Define a bitfield on given attribute
@@ -286,7 +291,7 @@ module PacketGen
         #   by bitfield size. If no size is given, 1 bit is assumed.
         # @return [void]
         def define_bit_fields_on(attr, *args)
-          attr_def = @field_defs[attr]
+          attr_def = field_defs[attr]
           raise ArgumentError, "unknown #{attr} field" if attr_def.nil?
 
           type = attr_def.type
@@ -366,7 +371,7 @@ module PacketGen
         @fields = {}
         @optional_fields = {}
 
-        field_defs = self.class.class_eval { @field_defs }
+        field_defs = self.class.field_defs
         self.class.fields.each do |field|
           type = field_defs[field].type
           default = field_defs[field].default

data/lib/packetgen/types/string.rb

@@ -8,7 +8,8 @@
 
 module PacketGen
   module Types
-    # This class is just like regular String. It only adds {#read} and {#sz} methods
+    # This class is just like regular String. It only adds {#read}, {#sz},
+    # #{to_human} and {#from_human} methods
     # to be compatible with others {Types}.
     # @author Sylvain Daubert
     class String < ::String

data/lib/packetgen/types/tlv.rb

@@ -28,6 +28,8 @@ module PacketGen
     # * print human readable type using {#human_type},
     # * set type as String with {#type=}.
     # @author Sylvain Daubert
+    # @deprecated Use {AbstractTLV} instead.
+    # @since 3.1.0 deprecated
     class TLV < Fields
       # @!attribute type
       #  @return [Integer]
@@ -50,6 +52,7 @@ module PacketGen
       # @option options [Class] :v {String} subclass for +:value+ attribute.
       #   Default: {Types::String}.
       def initialize(options={})
+        Deprecation.deprecated_class(self.class, AbstractTLV)
         super
         self[:type] = options[:t].new(self.type) if options[:t]
         self[:length] = options[:l].new(self.length) if options[:l]

data/lib/packetgen/types.rb

@@ -17,5 +17,6 @@ require_relative 'types/int_string'
 require_relative 'types/cstring'
 require_relative 'types/fields'
 require_relative 'types/array'
-require_relative 'types/tlv'
 require_relative 'types/oui'
+require_relative 'types/abstract_tlv'
+require_relative 'types/tlv'

data/lib/packetgen/version.rb

@@ -10,5 +10,5 @@
 # @author Sylvain Daubert
 module PacketGen
   # PacketGen version
-  VERSION = '3.0.2'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packetgen
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Sylvain Daubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interfacez
@@ -247,6 +247,7 @@ files:
 - lib/packetgen/pcapng/unknown_block.rb
 - lib/packetgen/proto.rb
 - lib/packetgen/types.rb
+- lib/packetgen/types/abstract_tlv.rb
 - lib/packetgen/types/array.rb
 - lib/packetgen/types/cstring.rb
 - lib/packetgen/types/enum.rb