pio 0.3.0 → 0.4.0

data/lib/pio/parse_error.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module Pio
+  # Raised when the packet data is in wrong format.
+  class ParseError < StandardError; end
+end

data/lib/pio/type/ethernet_header.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'pio/type/mac_address'
 
 module Pio
@@ -11,7 +12,7 @@ module Pio
         class_eval do
           mac_address :destination_mac
           mac_address :source_mac
-          uint16 :ether_type, :value => options[:ether_type]
+          uint16 :ether_type, value: options[:ether_type]
         end
       end
     end

data/lib/pio/type/ip_address.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'bindata'
 require 'pio/ipv4_address'
 
@@ -6,21 +7,15 @@ module Pio
   module Type
     # IP address
     class IpAddress < BinData::Primitive
-      array :octets, :type => :uint8, :initial_length => 4
+      array :octets, type: :uint8, initial_length: 4
 
       def set(value)
         self.octets = value
       end
 
       def get
-        IPv4Address.new octets.map { | each | sprintf('%d', each) }.join('.')
+        IPv4Address.new octets.map { | each | format('%d', each) }.join('.')
       end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/type/ipv4_header.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'pio/type/ip_address'
 
 module Pio
@@ -9,18 +10,18 @@ module Pio
       def ipv4_header(options)
         endian :big
         class_eval do
-          bit4 :ip_version, :initial_value => 0x4
-          bit4 :ip_header_length, :initial_value => 0x5
-          uint8 :ip_type_of_service, :initial_value => 0
+          bit4 :ip_version, initial_value: 0x4
+          bit4 :ip_header_length, initial_value: 0x5
+          uint8 :ip_type_of_service, initial_value: 0
           uint16be :ip_total_length,
-                   :initial_value => options[:ip_total_length]
-          uint16be :ip_identifier, :initial_value => 0
-          bit3 :ip_flag, :initial_value => 0
-          bit13 :ip_fragment, :initial_value => 0
-          uint8 :ip_ttl, :initial_value => 128
-          uint8 :ip_protocol, :value => options[:ip_protocol]
+                   initial_value: options[:ip_total_length]
+          uint16be :ip_identifier, initial_value: 0
+          bit3 :ip_flag, initial_value: 0
+          bit13 :ip_fragment, initial_value: 0
+          uint8 :ip_ttl, initial_value: 128
+          uint8 :ip_protocol, value: options[:ip_protocol]
           uint16be :ip_header_checksum,
-                   :initial_value => options[:ip_header_checksum]
+                   initial_value: options[:ip_header_checksum]
           ip_address :ip_source_address
           ip_address :ip_destination_address
         end
@@ -29,9 +30,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/type/mac_address.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'bindata'
 require 'pio/mac'
 
@@ -6,23 +7,17 @@ module Pio
   module Type
     # MAC address
     class MacAddress < BinData::Primitive
-      array :octets, :type => :uint8, :initial_length => 6
+      array :octets, type: :uint8, initial_length: 6
 
       def set(value)
-        self.octets = value
+        self.octets = value.to_a
       end
 
       def get
         Mac.new(octets.reduce('') do |str, each|
-                  str + sprintf('%02x', each)
+                  str + format('%02x', each)
                 end.hex)
       end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/type/udp_header.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Pio
+  module Type
+    # UDP Header Format.
+    module UdpHeader
+      def udp_header(options)
+        endian :big
+        class_eval do
+          uint16be :udp_src_port
+          uint16be :udp_dst_port
+          uint16be :udp_length, initial_value: options[:udp_length]
+          uint16be :udp_checksum, initial_value: options[:udp_checksum]
+        end
+      end
+    end
+  end
+end

data/lib/pio/version.rb

@@ -1,12 +1,7 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'.freeze
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8
-### indent-tabs-mode: nil
-### End:

data/pio.gemspec

@@ -1,8 +1,10 @@
+# encoding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pio/version'
 
-Gem::Specification.new do | gem |
+Gem::Specification.new do |gem|
   gem.name = 'pio'
   gem.version = Pio::VERSION
   gem.summary = 'Packet parser and generator.'
@@ -14,18 +16,18 @@ Gem::Specification.new do | gem |
   gem.email = ['yasuhito@gmail.com']
   gem.homepage = 'http://github.com/trema/pio'
 
-  gem.files = `git ls-files`.split("\n")
+  gem.files = %w(CONTRIBUTING.md LICENSE Rakefile pio.gemspec)
+  gem.files += Dir.glob('lib/**/*.rb')
+  gem.files += Dir.glob('bin/**/*')
+  gem.files += Dir.glob('spec/**/*')
+  gem.files += Dir.glob('examples/**/*')
 
   gem.require_paths = ['lib']
 
   gem.extra_rdoc_files = ['README.md']
-  gem.test_files = `git ls-files -- {spec,features}/*`.split("\n")
+  gem.test_files = Dir.glob('spec/**/*')
 
-  gem.add_dependency 'bindata', '~> 1.6.0'
+  gem.required_ruby_version = '>= 1.9.3'
+  gem.add_dependency 'bindata', '~> 2.0.0'
+  gem.add_development_dependency 'bundler', '~> 1.6.0'
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/spec/pio/arp/reply/options_spec.rb

@@ -0,0 +1,145 @@
+# encoding: utf-8
+
+require 'pio'
+
+describe Pio::Arp::Reply::Options, '.new' do
+  Given(:mandatory_options) do
+    {
+      source_mac: 0x00169d1d9cc4,
+      destination_mac: 0x002682ebead1,
+      sender_protocol_address: 0xc0a85303,
+      target_protocol_address: 0xc0a853fe
+    }
+  end
+
+  context 'with all mandatory options' do
+    Given(:options) do
+      Pio::Arp::Reply::Options.new(mandatory_options)
+    end
+
+    describe '#to_hash' do
+      When(:result) { options.to_hash }
+
+      Then { result[:source_mac] == Pio::Mac.new(0x00169d1d9cc4) }
+      Then { result[:destination_mac] == Pio::Mac.new(0x002682ebead1) }
+      Then do
+        result[:sender_protocol_address] == Pio::IPv4Address.new(0xc0a85303)
+      end
+      Then do
+        result[:target_protocol_address] == Pio::IPv4Address.new(0xc0a853fe)
+      end
+    end
+  end
+
+  context 'when source_mac is not passed' do
+    Given(:user_options) do
+      mandatory_options.delete(:source_mac)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result ==
+        Failure(ArgumentError, 'The source_mac option should be passed.')
+    end
+  end
+
+  context 'with source_mac = nil' do
+    Given(:user_options) do
+      mandatory_options.update(source_mac: nil)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result ==
+        Failure(ArgumentError, "The source_mac option shouldn't be nil.")
+    end
+  end
+
+  context 'when destination_mac is not passed' do
+    Given(:user_options) do
+      mandatory_options.delete(:destination_mac)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result ==
+        Failure(ArgumentError, 'The destination_mac option should be passed.')
+    end
+  end
+
+  context 'with destination_mac = nil' do
+    Given(:user_options) do
+      mandatory_options.update(destination_mac: nil)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result ==
+        Failure(ArgumentError, "The destination_mac option shouldn't be nil.")
+    end
+  end
+
+  context 'when sender_protocol_address is not passed' do
+    Given(:user_options) do
+      mandatory_options.delete(:sender_protocol_address)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result == Failure(ArgumentError,
+                        'The sender_protocol_address option should be passed.')
+    end
+  end
+
+  context 'with sender_protocol_address = nil' do
+    Given(:user_options) do
+      mandatory_options.update(sender_protocol_address: nil)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result == Failure(ArgumentError,
+                        "The sender_protocol_address option shouldn't be nil.")
+    end
+  end
+
+  context 'when target_protocol_address is not passed' do
+    Given(:user_options) do
+      mandatory_options.delete(:target_protocol_address)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result == Failure(ArgumentError,
+                        'The target_protocol_address option should be passed.')
+    end
+  end
+
+  context 'with target_protocol_address = nil' do
+    Given(:user_options) do
+      mandatory_options.update(target_protocol_address: nil)
+      mandatory_options
+    end
+
+    When(:result) { Pio::Arp::Reply::Options.new(user_options) }
+
+    Then do
+      result == Failure(ArgumentError,
+                        "The target_protocol_address option shouldn't be nil.")
+    end
+  end
+end

data/spec/pio/arp/reply_spec.rb

@@ -1,137 +1,101 @@
-# -*- coding: utf-8 -*-
-require 'pio/arp/reply'
+# encoding: utf-8
 
-describe Pio::Arp::Reply do
-  context '.new' do
-    subject do
+require 'pio'
+
+describe Pio::ARP::Reply do
+  Then { Pio::ARP::Reply == Pio::Arp::Reply }
+end
+
+describe Pio::Arp::Reply, '.new' do
+  ARP_REPLY_DUMP =
+    [
+      0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1, # destination mac address
+      0x00, 0x16, 0x9d, 0x1d, 0x9c, 0xc4, # source mac address
+      0x08, 0x06,                         # ethernet type
+      0x00, 0x01,                         # arp hardware type
+      0x08, 0x00,                         # arp protocol type
+      0x06,                               # hardware address size
+      0x04,                               # protocol address size
+      0x00, 0x02,                         # operational code
+      0x00, 0x16, 0x9d, 0x1d, 0x9c, 0xc4, # sender hardware address
+      0xc0, 0xa8, 0x53, 0xfe,             # sender protocol address
+      0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1, # target hardware address
+      0xc0, 0xa8, 0x53, 0x03,             # target protocol address
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # padding
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+      0x00, 0x00, 0x00, 0x00
+    ].pack('C*')
+
+  context 'with String MAC and IP address' do
+    Given(:arp_reply) do
       Pio::Arp::Reply.new(
-        :source_mac => source_mac,
-        :destination_mac => destination_mac,
-        :sender_protocol_address => sender_protocol_address,
-        :target_protocol_address => target_protocol_address
+        source_mac: '00:16:9d:1d:9c:c4',
+        destination_mac: '00:26:82:eb:ea:d1',
+        sender_protocol_address: '192.168.83.254',
+        target_protocol_address: '192.168.83.3'
       )
     end
 
-    let(:arp_reply_dump) do
-      [
-       0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1, # destination mac address
-       0x00, 0x16, 0x9d, 0x1d, 0x9c, 0xc4, # source mac address
-       0x08, 0x06,                         # ethernet type
-       0x00, 0x01,                         # arp hardware type
-       0x08, 0x00,                         # arp protocol type
-       0x06,                               # hardware address size
-       0x04,                               # protocol address size
-       0x00, 0x02,                         # operational code
-       0x00, 0x16, 0x9d, 0x1d, 0x9c, 0xc4, # sender hardware address
-       0xc0, 0xa8, 0x53, 0xfe,             # sender protocol address
-       0x00, 0x26, 0x82, 0xeb, 0xea, 0xd1, # target hardware address
-       0xc0, 0xa8, 0x53, 0x03,             # target protocol address
-       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # padding
-       0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-       0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
-       0x00, 0x00, 0x00, 0x00,
-      ].pack('C*')
-    end
-
-    context 'with Integer MAC and IP address' do
-      let(:source_mac) { 0x00169d1d9cc4 }
-      let(:destination_mac) { 0x002682ebead1 }
-      let(:sender_protocol_address) { 0xc0a853fe }
-      let(:target_protocol_address) { 0xc0a85303 }
-
-      context '#to_binary' do
-        it 'returns an Arp Reply binary String' do
-          expect(subject.to_binary).to eq arp_reply_dump
-        end
+    describe '#to_binary' do
+      When(:result) { arp_reply.to_binary }
 
-        it 'returns a valid ether frame with size = 64' do
-          expect(subject.to_binary.size).to eq 64
-        end
-      end
+      Then { result == ARP_REPLY_DUMP }
+      And { result.size == 64 }
     end
+  end
 
-    context 'with String MAC and Integer IP address' do
-      let(:source_mac) { '00:16:9d:1d:9c:c4' }
-      let(:destination_mac) { '00:26:82:eb:ea:d1' }
-      let(:sender_protocol_address) { 0xc0a853fe }
-      let(:target_protocol_address) { 0xc0a85303 }
-
-      context '#to_binary' do
-        it 'returns an Arp Reply binary String' do
-          expect(subject.to_binary).to eq arp_reply_dump
-        end
-
-        it 'returns a valid ether frame with size = 64' do
-          expect(subject.to_binary.size).to eq 64
-        end
-      end
+  context 'with Integer MAC address and IP address' do
+    Given(:arp_reply) do
+      Pio::Arp::Reply.new(
+        source_mac: 0x00169d1d9cc4,
+        destination_mac: 0x002682ebead1,
+        sender_protocol_address: 0xc0a853fe,
+        target_protocol_address: 0xc0a85303
+      )
     end
 
-    context 'when Integer MAC and String IP address' do
-      let(:source_mac) { 0x00169d1d9cc4 }
-      let(:destination_mac) { 0x002682ebead1 }
-      let(:sender_protocol_address) { '192.168.83.254' }
-      let(:target_protocol_address) { '192.168.83.3' }
+    describe '#to_binary' do
+      When(:result) { arp_reply.to_binary }
 
-      context '#to_binary' do
-        it 'returns an Arp Reply binary String' do
-          expect(subject.to_binary).to eq arp_reply_dump
-        end
-
-        it 'returns a valid ether frame with size = 64' do
-          expect(subject.to_binary.size).to eq 64
-        end
-      end
+      Then { result == ARP_REPLY_DUMP }
+      And { result.size == 64 }
     end
+  end
 
-    context 'when :source_mac is not set' do
-      let(:source_mac) { nil }
-      let(:destination_mac) { 0x002682ebead1 }
-      let(:sender_protocol_address) { '192.168.83.3' }
-      let(:target_protocol_address) { '192.168.83.254' }
-
-      it 'raises an invalid MAC address error' do
-        expect { subject }.to raise_error('Invalid MAC address: nil')
-      end
+  context 'with String MAC and Integer IP address' do
+    Given(:arp_reply) do
+      Pio::Arp::Reply.new(
+        source_mac: '00:16:9d:1d:9c:c4',
+        destination_mac: '00:26:82:eb:ea:d1',
+        sender_protocol_address: 0xc0a853fe,
+        target_protocol_address: 0xc0a85303
+      )
     end
 
-    context 'when :destination_mac is not set' do
-      let(:source_mac) { 0x00169d1d9cc4 }
-      let(:destination_mac) { nil }
-      let(:sender_protocol_address) { '192.168.83.3' }
-      let(:target_protocol_address) { '192.168.83.254' }
+    describe '#to_binary' do
+      When(:result) { arp_reply.to_binary }
 
-      it 'raises an invalid MAC address error' do
-        expect { subject }.to raise_error('Invalid MAC address: nil')
-      end
+      Then { result == ARP_REPLY_DUMP }
+      And { result.size == 64 }
     end
+  end
 
-    context 'when :sender_protocol_address is not set' do
-      let(:source_mac) { 0x00169d1d9cc4 }
-      let(:destination_mac) { 0x002682ebead1 }
-      let(:sender_protocol_address) { nil }
-      let(:target_protocol_address) { '192.168.83.254' }
-
-      it 'raises an invalid IPv4 address error' do
-        expect { subject }.to raise_error('Invalid IPv4 address: nil')
-      end
+  context 'with Integer MAC and String IP address' do
+    Given(:arp_reply) do
+      Pio::Arp::Reply.new(
+        source_mac: 0x00169d1d9cc4,
+        destination_mac: 0x002682ebead1,
+        sender_protocol_address: '192.168.83.254',
+        target_protocol_address: '192.168.83.3'
+      )
     end
 
-    context 'when :target_protocol_address is not set' do
-      let(:source_mac) { 0x00169d1d9cc4 }
-      let(:destination_mac) { 0x002682ebead1 }
-      let(:sender_protocol_address) { '192.168.83.3' }
-      let(:target_protocol_address) { nil }
+    describe '#to_binary' do
+      When(:result) { arp_reply.to_binary }
 
-      it 'raises an invalid IPv4 address error' do
-        expect { subject }.to raise_error('Invalid IPv4 address: nil')
-      end
+      Then { result == ARP_REPLY_DUMP }
+      And { result.size == 64 }
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End: