pio 0.30.0 → 0.30.1

data/lib/pio/icmp.rb

@@ -1,14 +1,17 @@
 require 'pio/icmp/format'
 require 'pio/icmp/reply'
 require 'pio/icmp/request'
-require 'pio/message_type_selector'
+require 'pio/parse_error'
 
-# Packet parser and generator library.
 module Pio
   # Icmp parser and generator.
   class Icmp
-    extend MessageTypeSelector
-    message_type Request::TYPE => Request, Reply::TYPE => Reply
+    def self.read(raw_data)
+      format = Format.read(raw_data)
+      { Request.icmp_type => Request,
+        Reply.icmp_type => Reply }.fetch(format.icmp_type).create(format)
+    rescue
+      raise Pio::ParseError, $ERROR_INFO.message
+    end
   end
-  ICMP = Icmp
 end

data/lib/pio/icmp/format.rb

@@ -1,37 +1,33 @@
-require 'bindata'
 require 'pio/ethernet_header'
 require 'pio/ipv4_header'
+require 'pio/monkey_patch/bindata_record'
 
 module Pio
-  # Icmp parser and generator.
+  # ICMP parser and generator
   class Icmp
-    # Icmp parser.
+    # ICMP format
     class Format < BinData::Record
-      MINIMUM_IP_PACKET_LENGTH = 50
-
-      include EthernetHeader
-      include IPv4Header
+      include Ethernet
+      include IPv4
 
       endian :big
 
-      ethernet_header ether_type: EtherType::IPV4
+      ethernet_header ether_type: Ethernet::Type::IPV4
       ipv4_header ip_protocol: ProtocolNumber::ICMP
       uint8 :icmp_type
       uint8 :icmp_code, initial_value: 0
       uint16 :icmp_checksum, value: :calculate_icmp_checksum
       uint16 :icmp_identifier
       uint16 :icmp_sequence_number
-      string :echo_data, read_length: :echo_data_read_length
-      string :padding, read_length: 0, initial_value: :icmp_padding_length
-
-      def message_type
-        icmp_type
-      end
-
-      alias_method :to_binary, :to_binary_s
+      string :echo_data, read_length: :echo_data_length
+      string :padding, length: :padding_length
 
       private
 
+      def icmp_header_length
+        8
+      end
+
       def calculate_icmp_checksum
         sum = [icmp_type * 0x100 + icmp_code,
                icmp_identifier,
@@ -40,14 +36,15 @@ module Pio
         ~((sum & 0xffff) + (sum >> 16)) & 0xffff
       end
 
-      def echo_data_read_length
-        ip_total_length - (ip_header_length * 4) - 8
+      def echo_data_length
+        ip_total_length - ip_header_length_in_bytes - icmp_header_length
       end
 
-      def icmp_padding_length
-        length = MINIMUM_IP_PACKET_LENGTH -
-                 (ip_header_length * 4) - 8 - echo_data.length
-        length > 0 ? "\x00" * length : ''
+      def padding_length
+        tmp = Ethernet::MINIMUM_FRAME_SIZE -
+              ethernet_header_length - ip_header_length_in_bytes -
+              icmp_header_length - echo_data.length
+        tmp > 0 ? tmp : 0
       end
     end
   end

data/lib/pio/icmp/message.rb

@@ -1,14 +1,28 @@
+require 'pio/class_inspector'
 require 'pio/icmp/format'
+require 'pio/instance_inspector'
+require 'pio/message'
+require 'pio/ruby_dumper'
 
 module Pio
   class Icmp
     # Base class of Icmp::Request and Icmp::Reply.
-    class Message
-      private_class_method :new
+    class Message < Pio::Message
+      extend ClassInspector
+      include InstanceInspector
+
+      def self.fields
+        Icmp::Format.fields
+      end
+
+      def self.create(format)
+        allocate.tap do |message|
+          message.instance_variable_set :@format, format
+        end
+      end
 
       def initialize(user_options)
-        options = self.class.const_get(:Options).new(user_options)
-        @format = Icmp::Format.new(options.to_hash)
+        @format = Icmp::Format.new(parse_options(user_options))
       end
 
       def method_missing(method, *args)

data/lib/pio/icmp/reply.rb

@@ -1,43 +1,17 @@
 require 'pio/icmp/message'
-require 'pio/icmp/options'
-require 'pio/mac'
 
 module Pio
   class Icmp
     # ICMP Reply packet generator
     class Reply < Message
-      TYPE = 0
-      public_class_method :new
-
-      # User options for creating an ICMP Reply.
-      class Options < Pio::Icmp::Options
-        mandatory_option :source_mac
-        mandatory_option :destination_mac
-        mandatory_option :source_ip_address
-        mandatory_option :destination_ip_address
-        mandatory_option :identifier
-        mandatory_option :sequence_number
-        option :echo_data
-
-        # rubocop:disable MethodLength
-        # rubocop:disable AbcSize
-        def initialize(options)
-          validate options
-          @type = TYPE
-
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @destination_mac = Mac.new(options[:destination_mac]).freeze
-          @source_ip_address =
-            IPv4Address.new(options[:source_ip_address]).freeze
-          @destination_ip_address =
-            IPv4Address.new(options[:destination_ip_address]).freeze
-          @identifier = options[:identifier]
-          @sequence_number = options[:sequence_number]
-          @echo_data = options[:echo_data] || ''
-        end
-        # rubocop:enable AbcSize
-        # rubocop:enable MethodLength
-      end
+      option :icmp_type, value: 0
+      option :source_mac
+      option :destination_mac
+      option :source_ip_address
+      option :destination_ip_address
+      option :icmp_identifier
+      option :icmp_sequence_number
+      option :echo_data, default: ''
     end
   end
 end

data/lib/pio/icmp/request.rb

@@ -1,52 +1,17 @@
 require 'pio/icmp/message'
-require 'pio/icmp/options'
-require 'pio/mac'
 
 module Pio
   class Icmp
     # ICMP Request packet generator
     class Request < Message
-      TYPE = 8
-      public_class_method :new
-
-      # User options for creating an ICMP Request.
-      class Options < Pio::Icmp::Options
-        DEFAULT_IDENTIFIER = 0x0100
-        DEFAULT_SEQUENCE_NUMBER = 0
-
-        mandatory_option :source_mac
-        mandatory_option :destination_mac
-        mandatory_option :source_ip_address
-        mandatory_option :destination_ip_address
-        option :identifier
-        option :sequence_number
-        option :echo_data
-
-        # rubocop:disable MethodLength
-        # rubocop:disable AbcSize
-        def initialize(options)
-          validate options
-          @type = TYPE
-
-          @source_mac = Mac.new(options[:source_mac]).freeze
-          @destination_mac = Mac.new(options[:destination_mac]).freeze
-          @source_ip_address =
-            IPv4Address.new(options[:source_ip_address]).freeze
-          @destination_ip_address =
-            IPv4Address.new(options[:destination_ip_address]).freeze
-          @identifier =
-            options[:icmp_identifier] ||
-            options[:identifier] ||
-            DEFAULT_IDENTIFIER
-          @sequence_number =
-            options[:icmp_sequence_number] ||
-            options[:sequence_number] ||
-            DEFAULT_SEQUENCE_NUMBER
-          @echo_data = options[:echo_data] || ''
-        end
-        # rubocop:enable AbcSize
-        # rubocop:enable MethodLength
-      end
+      option :icmp_type, value: 8
+      option :source_mac
+      option :destination_mac
+      option :source_ip_address
+      option :destination_ip_address
+      option :icmp_identifier, default: 0
+      option :icmp_sequence_number, default: 0
+      option :echo_data, default: ''
     end
   end
 end

data/lib/pio/instance_inspector.rb

@@ -0,0 +1,14 @@
+module Pio
+  # Introduces #inspect method
+  module InstanceInspector
+    def inspect
+      "#<#{self.class.name} " +
+        field_names.map do |each|
+          next if each == :padding
+          next unless __send__("#{each}?")
+          "#{each}: #{__send__(each).inspect}"
+        end.compact.join(', ') +
+        '>'
+    end
+  end
+end

data/lib/pio/ipv4_address.rb

@@ -21,14 +21,14 @@ module Pio
     # @return [IPv4Address] self
     #   a proxy to IPAddr.
     def initialize(addr)
-      case addr
-      when Integer
-        @value = IPAddr.new(addr, Socket::AF_INET)
-      when String
-        @value = IPAddr.new(addr)
-      else
-        @value = addr.value
-      end
+      @value = case addr
+               when Integer
+                 IPAddr.new(addr, Socket::AF_INET)
+               when String
+                 IPAddr.new(addr)
+               else
+                 addr.value
+               end
     end
 
     # @return [String] the IPv4 address in its text representation.
@@ -78,14 +78,14 @@ module Pio
       @value = @value.mask(masklen)
       self
     end
-    alias_method :prefix!, :mask!
+    alias prefix! mask!
 
     # Returns the IPv4 address masked with +masklen+.
     # @return [IPv4Address]
     def mask(masklen)
       clone.mask!(masklen)
     end
-    alias_method :prefix, :mask
+    alias prefix mask
 
     # @return [bool]
     #   Returns true if the address belongs to class A.
@@ -110,7 +110,7 @@ module Pio
     def class_d?
       mask(4).to_s == '224.0.0.0'
     end
-    alias_method :multicast?, :class_d?
+    alias multicast? class_d?
 
     # @return [bool]
     #   Returns true if the address belongs to class E.

data/lib/pio/ipv4_header.rb

@@ -1,9 +1,12 @@
+require 'pio/instance_inspector'
+require 'pio/monkey_patch/bindata_string'
 require 'pio/payload'
+require 'pio/ruby_dumper'
 require 'pio/type/ip_address'
 
 module Pio
   # IP Version 4 Header Format
-  module IPv4Header
+  module IPv4
     # Internet protocol numbers for ipv4_header.ip_protocol
     module ProtocolNumber
       ICMP = 1
@@ -39,7 +42,7 @@ module Pio
         in_port: in_port,
         source_mac_address: source_mac,
         destination_mac_address: destination_mac,
-        vlan_vid: vlan_vid,
+        vlan_vid: vlan? ? vlan_vid : 0xffff,
         vlan_priority: vlan_pcp,
         ether_type: ether_type,
         tos: ip_type_of_service,
@@ -53,6 +56,10 @@ module Pio
     end
     # rubocop:enable MethodLength
 
+    def ip_header_length_in_bytes
+      ip_header_length * 4
+    end
+
     private
 
     def calculate_ip_length
@@ -82,4 +89,19 @@ module Pio
       20 - ip_header_length * 4
     end
   end
+
+  # IPv4 header generator/parser
+  class IPv4Header < BinData::Record
+    include IPv4
+    include InstanceInspector
+    include RubyDumper
+
+    ipv4_header
+
+    # rubocop:disable LineLength
+    def self.inspect
+      'IPv4Header(ip_version: bit4, ip_header_length: bit4, ip_type_of_service: uint8, ip_total_length: uint16, ip_identifier: uint16, ip_flag: bit3, ip_fragment: bit13, ip_ttl: uint8, ip_protocol: uint8, ip_header_checksum: uint16, source_ip_address: ip_address, destination_ip_address: ip_address, ip_option: string)'
+    end
+    # rubocop:enable LineLength
+  end
 end

data/lib/pio/lldp/frame.rb

@@ -11,11 +11,11 @@ module Pio
   class Lldp
     # LLDP frame
     class Frame < BinData::Record
-      include EthernetHeader
+      include Ethernet
 
       endian :big
 
-      ethernet_header ether_type: EtherType::LLDP
+      ethernet_header ether_type: Ethernet::Type::LLDP
       chassis_id_tlv :chassis_id
       port_id_tlv :port_id
       ttl_tlv :ttl, initial_value: 120

data/lib/pio/lldp/optional_tlv.rb

@@ -29,7 +29,7 @@ module Pio
       end
 
       def end_of_lldpdu?
-        tlv_type == 0
+        tlv_type.zero?
       end
 
       def chooser
@@ -52,7 +52,7 @@ module Pio
       end
 
       def end_of_lldpdu_tlv?
-        tlv_type == 0
+        tlv_type.zero?
       end
     end
   end

data/lib/pio/mac.rb

@@ -29,7 +29,7 @@ module Pio
         @value = value.to_int
         validate_value_range
       else
-        fail TypeError
+        raise TypeError
       end
     rescue ArgumentError, TypeError
       raise InvalidValueError, "Invalid MAC address: #{value.inspect}"
@@ -91,6 +91,10 @@ module Pio
       to_s.split(':').map(&:hex)
     end
 
+    def to_hex
+      to_a.map(&:to_hex).join(', ')
+    end
+
     # @!endgroup
 
     # @!group Predicates
@@ -202,12 +206,12 @@ module Pio
       when /^(?:#{octet}(:)){5}#{octet}$/, /^(?:#{doctet}(\.)){2}#{doctet}$/
         mac.gsub(Regexp.last_match[1], '').hex
       else
-        fail ArgumentError
+        raise ArgumentError
       end
     end
 
     def validate_value_range
-      fail ArgumentError unless @value >= 0 && @value <= 0xffffffffffff
+      raise ArgumentError unless @value >= 0 && @value <= 0xffffffffffff
     end
   end
 end

data/lib/pio/message.rb

@@ -0,0 +1,50 @@
+require 'active_support/core_ext/class/attribute'
+require 'pio/ruby_dumper'
+
+module Pio
+  # Base message class
+  class Message
+    include RubyDumper
+
+    class_attribute :options
+
+    def self.option(name, value: nil, default: nil)
+      self.options ||= {}
+      if value && !value.is_a?(Symbol)
+        class_eval { class_attribute name }
+        class_eval { __send__("#{name}=", value) }
+      end
+      self.options.merge! name => { value: value, default: default }
+    end
+
+    private
+
+    # rubocop:disable MethodLength
+    # rubocop:disable AbcSize
+    # rubocop:disable PerceivedComplexity
+    # rubocop:disable CyclomaticComplexity
+    def parse_options(user_options)
+      options = {}
+      self.class.options.each_pair do |key, attrs|
+        if !attrs[:value] && !attrs[:default]
+          begin
+            options[key] = user_options.fetch(key)
+          rescue
+            raise "#{key} option is a mandatory"
+          end
+        elsif attrs[:value] && attrs[:value].is_a?(Symbol)
+          options[key] = user_options.fetch(attrs[:value])
+        elsif attrs[:value]
+          options[key] = user_options[key] || attrs[:value]
+        else
+          options[key] = user_options[key] || attrs[:default]
+        end
+      end
+      options
+    end
+    # rubocop:enable MethodLength
+    # rubocop:enable AbcSize
+    # rubocop:enable PerceivedComplexity
+    # rubocop:enable CyclomaticComplexity
+  end
+end