pio 0.3.0 → 0.4.0

data/lib/pio/icmp.rb

@@ -1,27 +1,16 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
-require 'bindata'
+# encoding: utf-8
 
 require 'pio/icmp/frame'
-require 'pio/icmp/request'
 require 'pio/icmp/reply'
-require 'pio/util'
+require 'pio/icmp/request'
+require 'pio/message_type_selector'
 
+# Packet parser and generator library.
 module Pio
   # Icmp parser and generator.
   class Icmp
-    MESSAGE_TYPE = {
-      Request::TYPE => Request,
-      Reply::TYPE => Reply
-    }
-    class << self
-      include Util
-    end
+    extend MessageTypeSelector
+    message_type Request::TYPE => Request, Reply::TYPE => Reply
   end
+  ICMP = Icmp
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/icmp/frame.rb

@@ -1,4 +1,6 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
+require 'bindata'
 require 'pio/type/ethernet_header'
 require 'pio/type/ipv4_header'
 
@@ -14,18 +16,18 @@ module Pio
       extend Type::IPv4Header
 
       endian :big
-      ethernet_header :ether_type => 0x0800
-      ipv4_header :ip_protocol => 1,
-                  :ip_header_checksum => lambda { ip_sum },
-                  :ip_total_length => lambda { ip_packet_length }
+
+      ethernet_header ether_type: 0x0800
+      ipv4_header ip_protocol: 1,
+                  ip_header_checksum: -> { ip_sum },
+                  ip_total_length: -> { ip_packet_length }
       uint8 :icmp_type
-      uint8 :icmp_code, :initial_value => 0
-      uint16 :icmp_checksum, :value => lambda { icmp_sum }
-      uint16 :icmp_identifier, :initial_value => 0x0100
-      uint16 :icmp_sequence_number, :initial_value => 0x0001
+      uint8 :icmp_code, initial_value: 0
+      uint16 :icmp_checksum, value: -> { icmp_sum }
+      uint16 :icmp_identifier
+      uint16 :icmp_sequence_number
       string :echo_data,
-             :initial_value => 'DEADBEEF',
-             :read_length => lambda { echo_data_length }
+             read_length: -> { echo_data_length }
 
       def message_type
         icmp_type
@@ -48,16 +50,26 @@ module Pio
         ~((icmp_csum & 0xffff) + (icmp_csum >> 16)) & 0xffff
       end
 
+      def ip_sum
+        ~((ip_csum & 0xffff) + (ip_csum >> 16)) & 0xffff
+      end
+
+      def to_binary
+        if num_bytes < MINIMUM_FRAME_LENGTH
+          to_binary_s + "\000" * (MINIMUM_FRAME_LENGTH - num_bytes)
+        else
+          to_binary_s
+        end
+      end
+
+      private
+
       def icmp_csum
         icmp_2bytewise_slices.reduce(0) do |acc, each|
           acc + each
         end
       end
 
-      def ip_sum
-        ~((ip_csum & 0xffff) + (ip_csum >> 16)) & 0xffff
-      end
-
       def ip_csum
         ipv4_header_2bytewise_slices.reduce(0) do |acc, each|
           acc + each
@@ -66,22 +78,22 @@ module Pio
 
       def icmp_2bytewise_slices
         [
-         icmp_type * 0x100 + icmp_code,
-         icmp_identifier,
-         icmp_sequence_number,
-         *echo_data.unpack('n*')
+          icmp_type * 0x100 + icmp_code,
+          icmp_identifier,
+          icmp_sequence_number,
+          *echo_data.unpack('n*')
         ]
       end
 
       def ipv4_header_2bytewise_slices
         [
-         ipversion_ipheaderlength_iptypeofservice, ip_total_length,
-         ip_identifier, ipflag_ipfragment,
-         ipttl_ipproto,
-         ip_source_address_upper,
-         ip_source_address_lower,
-         ip_destination_address_upper,
-         ip_destination_address_lower
+          ipversion_ipheaderlength_iptypeofservice, ip_total_length,
+          ip_identifier, ipflag_ipfragment,
+          ipttl_ipproto,
+          ip_source_address_upper,
+          ip_source_address_lower,
+          ip_destination_address_upper,
+          ip_destination_address_lower
         ]
       end
 
@@ -112,20 +124,6 @@ module Pio
       def ipttl_ipproto
         ip_ttl << 8 | ip_protocol
       end
-
-      def to_binary
-        if num_bytes < MINIMUM_FRAME_LENGTH
-          to_binary_s + "\000" * (MINIMUM_FRAME_LENGTH - num_bytes)
-        else
-          to_binary_s
-        end
-      end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/icmp/message.rb

@@ -1,6 +1,6 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'pio/icmp/frame'
-require 'pio/message_util'
 require 'forwardable'
 
 module Pio
@@ -8,18 +8,6 @@ module Pio
     # Base class of Request, Reply, TTL Exceeded and destination unreachable.
     class Message
       extend Forwardable
-      include MessageUtil
-
-      def self.create_from(frame)
-        message = allocate
-        message.instance_variable_set :@frame, frame
-        message
-      end
-
-      def initialize(options)
-        @options = options
-        @frame = Icmp::Frame.new(option_hash)
-      end
 
       def_delegators :@frame, :destination_mac
       def_delegators :@frame, :source_mac
@@ -44,57 +32,18 @@ module Pio
       def_delegators :@frame, :echo_data
       def_delegators :@frame, :to_binary
 
-      private
-
-      # rubocop:disable MethodLength
-      def default_options
-        {
-          :ip_type_of_service => @options[:ip_type_of_service],
-          :ip_identifier => @options[:ip_identifier],
-          :ip_flag => @options[:ip_flag],
-          :ip_fragment => @options[:ip_fragment],
-          :ip_ttl => @options[:ip_ttl],
-          :icmp_type => self.class::TYPE,
-          :icmp_code => @options[:icmp_code],
-          :icmp_identifier => @options[:icmp_identifier],
-          :icmp_sequence_number => @options[:icmp_sequence_number],
-          :echo_data => @options[:echo_data]
-        }
-      end
-      # rubocop:enable MethodLength
-
-      def user_options
-        @options.merge(
-          :source_mac => @options[:source_mac],
-          :destination_mac => @options[:destination_mac],
-          :ip_source_address => @options[:ip_source_address],
-          :ip_destination_address => @options[:ip_destination_address]
-        )
+      def self.create_from(frame)
+        message = allocate
+        message.instance_variable_set :@frame, frame
+        message
       end
 
-      def mandatory_options
-        [
-         :source_mac,
-         :destination_mac,
-         :ip_source_address,
-         :ip_destination_address
-        ]
-      end
+      private_class_method :new
 
-      def option_to_klass
-        {
-          :source_mac => Mac,
-          :destination_mac => Mac,
-          :ip_source_address => IPv4Address,
-          :ip_destination_address => IPv4Address
-        }
+      def initialize(user_options)
+        options = self.class.const_get(:Options).new(user_options)
+        @frame = Icmp::Frame.new(options.to_hash)
       end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/icmp/options.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'pio/options'
+
+module Pio
+  class Icmp
+    # User options for creating an ICMP messages.
+    class Options < Pio::Options
+      DEFAULT_ECHO_DATA = ''.freeze
+
+      def to_hash
+        {
+          icmp_type: @type,
+          source_mac: @source_mac,
+          destination_mac: @destination_mac,
+          ip_source_address: @ip_source_address,
+          ip_destination_address: @ip_destination_address,
+          icmp_identifier: @identifier,
+          icmp_sequence_number: @sequence_number,
+          echo_data: @echo_data
+        }.freeze
+      end
+    end
+  end
+end

data/lib/pio/icmp/reply.rb

@@ -1,17 +1,44 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 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 :ip_source_address
+        mandatory_option :ip_destination_address
+        mandatory_option :identifier
+        mandatory_option :sequence_number
+        option :echo_data
+
+        # rubocop:disable MethodLength
+
+        def initialize(options)
+          validate options
+          @type = TYPE
+          @source_mac = Mac.new(options[:source_mac]).freeze
+          @destination_mac = Mac.new(options[:destination_mac]).freeze
+          @ip_source_address =
+            IPv4Address.new(options[:ip_source_address]).freeze
+          @ip_destination_address =
+            IPv4Address.new(options[:ip_destination_address]).freeze
+          @identifier = options[:identifier]
+          @sequence_number = options[:sequence_number]
+          @echo_data = options[:echo_data] || DEFAULT_ECHO_DATA
+        end
+
+        # rubocop:enable MethodLength
+      end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/icmp/request.rb

@@ -1,17 +1,53 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 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 :ip_source_address
+        mandatory_option :ip_destination_address
+        option :identifier
+        option :sequence_number
+        option :echo_data
+
+        # rubocop:disable MethodLength
+
+        def initialize(options)
+          validate options
+          @type = TYPE
+          @source_mac = Mac.new(options[:source_mac]).freeze
+          @destination_mac = Mac.new(options[:destination_mac]).freeze
+          @ip_source_address =
+            IPv4Address.new(options[:ip_source_address]).freeze
+          @ip_destination_address =
+            IPv4Address.new(options[:ip_destination_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] || DEFAULT_ECHO_DATA
+        end
+
+        # rubocop:enable MethodLength
+      end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/ipv4_address.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'forwardable'
 require 'ipaddr'
 
@@ -55,13 +56,15 @@ module Pio
     #
     def_delegator :value, :to_range
 
+    def_delegator :value, :==
+
     #
     # @return [Number] prefix length of IPv4 address.
     #
     def prefixlen
       netmask = to_range.first.to_i ^ to_range.last.to_i
       if netmask > 0
-        32 - sprintf('%b', netmask).length
+        32 - format('%b', netmask).length
       else
         32
       end
@@ -154,9 +157,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp.rb

@@ -1,67 +1,16 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'English'
 require 'forwardable'
 require 'pio/lldp/frame'
+require 'pio/lldp/options'
 
+# Packet parser and generator library.
 module Pio
   # LLDP frame parser and generator.
   class Lldp
-    # User options for creating an LLDP frame.
-    class Options
-      def initialize(options)
-        @options = options
-        fail TypeError, "Invalid DPID: #{ dpid.inspect }" unless dpid
-        unless port_id
-          fail TypeError, "Invalid port number: #{ port_id.inspect }"
-        end
-      end
-
-      def to_hash
-        {
-          :destination_mac => Mac.new(destination_mac).to_a,
-          :source_mac => Mac.new(source_mac).to_a,
-          :chassis_id => dpid,
-          :port_id => port_id
-        }
-      end
-
-      private
-
-      def dpid
-        @options[:dpid]
-      end
-
-      def port_id
-        @options[:port_number]
-      end
-
-      def destination_mac
-        @options[:destination_mac] || '01:80:c2:00:00:0e'
-      end
-
-      def source_mac
-        @options[:source_mac] || '01:02:03:04:05:06'
-      end
-    end
-
     extend Forwardable
 
-    def self.read(raw_data)
-      begin
-        frame = Frame.read(raw_data)
-      rescue
-        raise Pio::ParseError, $ERROR_INFO.message
-      end
-
-      lldp = allocate
-      lldp.instance_variable_set :@frame, frame
-      lldp
-    end
-
-    def initialize(options)
-      @frame = Frame.new(Options.new(options).to_hash)
-    end
-
     def_delegator :@frame, :destination_mac
     def_delegator :@frame, :source_mac
     def_delegator :@frame, :ether_type
@@ -79,14 +28,25 @@ module Pio
     def_delegator :@frame, :management_address
     def_delegator :@frame, :organizationally_specific
 
+    def self.read(raw_data)
+      begin
+        frame = Frame.read(raw_data)
+      rescue
+        raise Pio::ParseError, $ERROR_INFO.message
+      end
+
+      lldp = allocate
+      lldp.instance_variable_set :@frame, frame
+      lldp
+    end
+
+    def initialize(options)
+      @frame = Frame.new(Options.new(options).to_hash)
+    end
+
     def to_binary
-      @frame.to_binary_s + "\000" * ( 64 - @frame.num_bytes)
+      @frame.to_binary_s + "\000" * (64 - @frame.num_bytes)
     end
   end
+  LLDP = Lldp
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End: