pio 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73ce00f558de61b898267a5ad530362ace3e4c84
-  data.tar.gz: 9df827c044267c93d109c49f343e758f08795efd
+  metadata.gz: 75af6278d342dd6e8c2b0c675d1f3f7d82ab3474
+  data.tar.gz: d5e0ee260a39d472ecf3d950e849f33f2558f52d
 SHA512:
-  metadata.gz: 9baf83820618e20a64b952b43086c3fd3295b1bdf72fa45da093db3ce35da9dee338e5e512d5221616ae04acbfde492476d2c66bede1f2c4b98f6ff8e6306d54
-  data.tar.gz: 20bc42f2e58a9c25513613689d54d65ee89f70782b2839590da3e64bb928e815105cecd63e61bece1ccc16afbd2669eea98652cc49774171d33ce12abe4f8d80
+  metadata.gz: 780986656174b5c659d486c2affca51f2fd70d09bb848198cf501668670628d5fcf6a3d640af5c8a709fcbad1ab241c4fe50921350964492278267207ed0883a
+  data.tar.gz: 59b6ddea90c19e05307ab2b2f2a8be7b201f5f872fd58824aca29acc1923a1d8eccc1c8a881bf0150568c7ddeab3a029afab45725067f971f95e9be979a9a072

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: rubocop-todo.yml

data/.travis.yml

@@ -3,6 +3,7 @@ language: ruby
 script: "rake travis"
 
 rvm:
+  - 1.8.7
   - 1.9.3
   - 2.0.0
 

data/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing to Pio
+
+* Check out the latest develop to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't
+  requested it and/or contributed it.
+* Fork the project.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Squash your commits.
+* Create a pull-request.

data/Gemfile

@@ -1,32 +1,35 @@
-source "https://rubygems.org"
-
+source 'https://rubygems.org'
 
 gemspec
 
-
 group :development, :test do
-  gem "coveralls", "~> 0.7.0", :require => false
-  gem "flay", "~> 2.4.0"
-  gem "flog", "~> 4.1.2"
-  gem "fuubar", "~> 1.2.1"
-  gem "guard", "~> 1.8"
-  gem "guard-bundler", "~> 1.0.0"
-  gem "guard-rspec", "~> 3.1.0"
-  gem "json", "~> 1.8.0"
-  gem "rake", "~> 10.1.0"
-  gem "rb-fchange", "~> 0.0.6", :require => false
-  gem "rb-fsevent", "~> 0.9.3", :require => false
-  gem "rb-inotify", "~> 0.9.2", :require => false
-  gem "redcarpet", "~> 2.3.0" if RUBY_VERSION < "1.9.0"
-  gem "redcarpet", "~> 3.0.0" if RUBY_VERSION >= "1.9.0"
-  gem "reek", "~> 1.3.3"
-  gem "rspec", "~> 2.14.1"
-  gem "rspec-instafail", "~> 0.2.4"
-  gem "terminal-notifier-guard", "~> 1.5.3"
-  gem "yard", "~> 0.8.7.2"
+  gem 'coveralls', '~> 0.7.0', :require => false
+  gem 'flay', '~> 2.4.0'
+  gem 'flog', '~> 4.2.0'
+  gem 'fuubar', '~> 1.2.1'
+  gem 'guard', '~> 1.8.3' if RUBY_VERSION < '1.9.0'
+  gem 'guard', '~> 2.2.2' if RUBY_VERSION >= '1.9.0'
+  gem 'guard-bundler', '~> 1.0.0' if RUBY_VERSION < '1.9.0'
+  gem 'guard-bundler', '~> 2.0.0' if RUBY_VERSION >= '1.9.0'
+  gem 'guard-rspec', '~> 3.1.0' if RUBY_VERSION < '1.9.0'
+  gem 'guard-rspec', '~> 4.0.3' if RUBY_VERSION >= '1.9.0'
+  gem 'json', '~> 1.8.1'
+  gem 'mime-types', '~> 1.25' if RUBY_VERSION < '1.9.0'
+  gem 'mime-types', '~> 2.0' if RUBY_VERSION >= '1.9.0'
+  gem 'rake', '~> 10.1.0'
+  gem 'rb-fchange', '~> 0.0.6', :require => false
+  gem 'rb-fsevent', '~> 0.9.3', :require => false
+  gem 'rb-inotify', '~> 0.9.2', :require => false
+  gem 'redcarpet', '~> 2.3.0' if RUBY_VERSION < '1.9.0'
+  gem 'redcarpet', '~> 3.0.0' if RUBY_VERSION >= '1.9.0'
+  gem 'reek', '~> 1.3.4'
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-instafail', '~> 0.2.4'
+  gem 'rubocop', '~> 0.14.1' if RUBY_VERSION >= '1.9.0'
+  gem 'terminal-notifier-guard', '~> 1.5.3'
+  gem 'yard', '~> 0.8.7.3'
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/Guardfile

@@ -17,3 +17,8 @@ guard :rspec do
   watch(%r{^lib/pio/(.+)\.rb$})     { |m| "spec/pio/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/README.md

@@ -10,6 +10,7 @@ Pio
 
 Pio is a ruby gem to easily parse and generate network packets. It supports the following packet formats:
 
+ * ICMP
  * ARP
  * LLDP
  * (...currently there are just a few formats supported but I'm sure this list will grow)
@@ -28,41 +29,80 @@ Features Overview
    format DSL so that it is easy to read and debug by human beings.
 
 
-Example
--------
+Examples
+--------
 
 Its usage is dead simple.
 
+### ICMP
+
+To parse an ICMP frame, use the API `Pio::Icmp.read` and you can
+access each field of the parsed ICMP frame.
+
+```ruby
+require 'pio'
+icmp = Pio::Icmp.read(binary_data)
+icmp.source_mac.to_s #=> '00:26:82:eb:ea:d1'
+```
+
+Also you can use `Pio::Icmp::Request#new` or `Pio::Icmp::Reply#new` to
+generate an Icmp Request/Reply frame like below:
+
+```ruby
+require 'pio'
+
+request = Pio::Icmp::Request.new(
+  source_mac: '00:26:82:eb:ea:d1',
+  destination_mac: '00:26:82:eb:ea:d1',
+  ip_source_address: '192.168.83.3',
+  ip_destination_address: '192.168.83.254'
+)
+request.to_binary  #=> ICMP Request frame in binary format.
+
+reply = Pio::Icmp::Reply.new(
+  destination_mac: '00:26:82:eb:ea:d1',
+  source_mac: '00:00:00:00:00:01',
+  ip_source_address: '192.168.0.1',
+  ip_destination_address: '192.168.0.2',
+  # The ICMP Identifier and the ICMP Sequence number
+  # should be same as those of the request.
+  icmp_identifier: request.icmp_identifier,
+  icmp_sequence_number: request.icmp_sequence_number,
+  echo_data: request.echo_data
+)
+reply.to_binary  #=> ICMP Reply frame in binary format.
+```
+
 ### ARP
 
 To parse an ARP frame, use the API `Pio::Arp.read` and you can access
 each field of the parsed ARP frame.
 
 ```ruby
-require "pio"
+require 'pio'
 
-arp = Pio::Arp.read( binary_data )
-arp.source_mac.to_s #=> "00:26:82:eb:ea:d1"
+arp = Pio::Arp.read(binary_data)
+arp.source_mac.to_s #=> '00:26:82:eb:ea:d1'
 ```
 
 Also you can use `Pio::Arp::Request#new` or `Pio::Arp::Reply#new` to
 generate an Arp Request/Reply frame like below:
 
 ```ruby
-require "pio"
+require 'pio'
 
 request = Pio::Arp::Request.new(
-  source_mac: "00:26:82:eb:ea:d1",
-  sender_protocol_address: "192.168.83.3",
-  target_protocol_address: "192.168.83.254"
+  source_mac: '00:26:82:eb:ea:d1',
+  sender_protocol_address: '192.168.83.3',
+  target_protocol_address: '192.168.83.254'
 )
 request.to_binary  #=> Arp Request frame in binary format.
 
 reply = Pio::Arp::Reply.new(
-  source_mac: "00:26:82:eb:ea:d1",
-  destination_mac: "00:26:82:eb:ea:d1",
-  sender_protocol_address: "192.168.83.3",
-  target_protocol_address: "192.168.83.254"
+  source_mac: '00:26:82:eb:ea:d1',
+  destination_mac: '00:26:82:eb:ea:d1',
+  sender_protocol_address: '192.168.83.3',
+  target_protocol_address: '192.168.83.254'
 )
 reply.to_binary  #=> Arp Reply frame in binary format.
 ```
@@ -73,18 +113,18 @@ To parse an LLDP frame, use the API `Pio::Lldp.read` and you can
 access each field of the parsed LLDP frame.
 
 ```ruby
-require "pio"
+require 'pio'
 
-lldp = Pio::Lldp.read( binary_data )
+lldp = Pio::Lldp.read(binary_data)
 lldp.ttl #=> 120
 ```
 
 Also you can use `Pio::Lldp#new` to generate an LLDP frame like below:
 
 ```ruby
-require "pio"
+require 'pio'
 
-lldp = Pio::Lldp.new( dpid: 0x123, port_number: 12 )
+lldp = Pio::Lldp.new(dpid: 0x123, port_number: 12)
 lldp.to_binary  #=> LLDP frame in binary format.
 ```
 
@@ -113,9 +153,11 @@ Documents
  * [API document generated with YARD](http://rubydoc.info/github/trema/pio/frames/file/README.md)
 
 
-### Author
+Team
+----
 
-[Yasuhito Takamiya](https://github.com/yasuhito) ([@yasuhito](http://twitter.com/yasuhito))
+ * [Yasuhito Takamiya](https://github.com/yasuhito) ([@yasuhito](https://twitter.com/yasuhito))
+ * [Eishun Kondoh](https://github.com/shun159) ([@Eishun_Kondoh](https://twitter.com/Eishun_Kondoh))
 
 ### Contributors
 

data/Rakefile

@@ -1,101 +1,99 @@
-require "bundler/gem_tasks"
-require "coveralls/rake/task"
-require "flay"
-require "flay_task"
-require "flog"
-require "rake/tasklib"
-require "reek/rake/task"
-require "rspec/core"
-require "rspec/core/rake_task"
-require "yaml"
-require "yard"
-
-
-$ruby_source = FileList[ "lib/**/*.rb" ]
-
+require 'bundler/gem_tasks'
+require 'coveralls/rake/task'
+require 'flay'
+require 'flay_task'
+require 'flog'
+require 'rake/tasklib'
+require 'reek/rake/task'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'yaml'
+require 'yard'
+
+ruby_source = FileList['lib/**/*.rb']
 
 task :default => :travis
-task :travis => [ :spec, :quality, "coveralls:push" ]
-
-desc "Check for code quality"
-task :quality => [ :reek, :flog, :flay ]
+task :travis => [:spec, :quality, 'coveralls:push']
 
+desc 'Check for code quality'
+task :quality => [:reek, :flog, :flay]
 
 Coveralls::RakeTask.new
 
-
 RSpec::Core::RakeTask.new
 
-
-Reek::Rake::Task.new do | t |
+Reek::Rake::Task.new do |t|
   t.fail_on_error = false
   t.verbose = false
-  t.ruby_opts = [ "-rubygems" ]
-  t.reek_opts = "--quiet"
-  t.source_files = $ruby_source
+  t.ruby_opts = ['-rubygems']
+  t.reek_opts = '--quiet'
+  t.source_files = ruby_source
 end
 
-
-desc "Analyze for code complexity"
+desc 'Analyze for code complexity'
 task :flog do
-  flog = Flog.new( :continue => true )
-  flog.flog( *$ruby_source )
-  threshold = 20
+  flog = Flog.new(:continue => true)
+  flog.flog(*ruby_source)
+  threshold = 28
 
-  bad_methods = flog.totals.select do | name, score |
-    ( not ( /##{flog.no_method}$/=~ name ) ) and score > threshold
+  bad_methods = flog.totals.select do |name, score|
+    !(/##{flog.no_method}$/ =~ name) && score > threshold
   end
-  bad_methods.sort do | a, b |
-    a[ 1 ] <=> b[ 1 ]
-  end.reverse.each do | name, score |
-    puts "%8.1f: %s" % [ score, name ]
+  bad_methods.sort { |a, b| a[1] <=> b[1] }.reverse.each do |name, score|
+    printf "%8.1f: %s\n", score, name
   end
   unless bad_methods.empty?
-    $stderr.puts "#{ bad_methods.size } methods have a flog complexity > #{ threshold }"
+    $stderr.puts "#{bad_methods.size} methods have a complexity > #{threshold}"
   end
 end
 
-
-FlayTask.new do | t |
-  t.dirs = $ruby_source.collect do | each |
-    each[ /[^\/]+/ ]
+FlayTask.new do |t|
+  t.dirs = ruby_source.map do |each|
+    each[/[^\/]+/]
   end.uniq
   t.threshold = 0
-  t.verbose = $trace
+  t.verbose = true
 end
 
-
-YARD::Rake::YardocTask.new do | t |
-  t.options = [ "--no-private" ]
-  t.options << "--debug" << "--verbose" if $trace
+if RUBY_VERSION >= '1.9.0'
+  task :quality => :rubocop
+  require 'rubocop/rake_task'
+  Rubocop::RakeTask.new
 end
 
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--no-private']
+  t.options << '--debug' << '--verbose' if Rake.verbose
+end
 
 def travis_yml
-  File.join File.dirname( __FILE__ ), ".travis.yml"
+  File.join File.dirname(__FILE__), '.travis.yml'
 end
 
-
 def rubies
-  ( [ "1.8.7" ] + YAML.load_file( travis_yml )[ "rvm" ] ).uniq.sort
+  YAML.load_file(travis_yml)['rvm'].uniq.sort
 end
 
+def gemfile_lock
+  File.join File.dirname(__FILE__), 'Gemfile.lock'
+end
 
-desc "Run tests against multiple rubies"
+desc 'Run tests against multiple rubies'
 task :portability
 
-rubies.each do | each |
-  portability_task_name = "portability:#{ each }"
+rubies.each do |each|
+  portability_task_name = "portability:#{each}"
   task :portability => portability_task_name
 
-  desc "Run tests against Ruby#{ each }"
+  desc "Run tests against Ruby#{each}"
   task portability_task_name do
-    sh "rvm #{ each } exec bundle"
-    sh "rvm #{ each } exec bundle exec rake"
+    rm_f gemfile_lock
+    sh "rvm #{each} exec bundle update"
+    sh "rvm #{each} exec bundle install"
+    sh "rvm #{each} exec bundle exec rake"
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/arp/frame.rb

@@ -1,7 +1,7 @@
-require "pio/type/ethernet_header"
-require "pio/type/ip_address"
-require "pio/type/mac_address"
-
+# -*- coding: utf-8 -*-
+require 'pio/type/ethernet_header'
+require 'pio/type/ip_address'
+require 'pio/type/mac_address'
 
 module Pio
   class Arp
@@ -22,15 +22,17 @@ module Pio
       mac_address :target_hardware_address
       ip_address :target_protocol_address
 
+      def message_type
+        operation
+      end
 
       def to_binary
-        to_binary_s + "\000" * ( 64 - num_bytes )
+        to_binary_s + "\000" * (64 - num_bytes)
       end
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/arp/message.rb

@@ -1,28 +1,27 @@
-require "forwardable"
-require "pio/arp/frame"
-require "pio/ipv4_address"
-
+# -*- coding: utf-8 -*-
+require 'forwardable'
+require 'pio/arp/frame'
+require 'pio/ipv4_address'
+require 'pio/message_util'
 
 module Pio
   class Arp
     # Base class of ARP Request and Reply
     class Message
       extend Forwardable
+      include MessageUtil
 
-
-      def self.create_from frame
+      def self.create_from(frame)
         message = allocate
         message.instance_variable_set :@frame, frame
         message
       end
 
-
-      def initialize options
+      def initialize(options)
         @options = options
-        @frame = Arp::Frame.new( option_hash )
+        @frame = Arp::Frame.new(option_hash)
       end
 
-
       def_delegators :@frame, :destination_mac
       def_delegators :@frame, :source_mac
       def_delegators :@frame, :ether_type
@@ -37,20 +36,7 @@ module Pio
       def_delegators :@frame, :target_protocol_address
       def_delegators :@frame, :to_binary
 
-
-      ##########################################################################
       private
-      ##########################################################################
-
-
-      def option_hash
-        mandatory_options.inject( {} ) do | opt, each |
-          klass = option_to_klass[ each ]
-          opt_pair = { each => klass.new( user_options[ each ] ).to_a }
-          opt.merge opt_pair
-        end.merge default_options
-      end
-
 
       def option_to_klass
         {

data/lib/pio/arp/reply.rb

@@ -1,7 +1,7 @@
-require "forwardable"
-require "pio/arp/message"
-require "pio/mac"
-
+# -*- coding: utf-8 -*-
+require 'forwardable'
+require 'pio/arp/message'
+require 'pio/mac'
 
 module Pio
   class Arp
@@ -9,11 +9,7 @@ module Pio
     class Reply < Message
       OPERATION = 2
 
-
-      ##########################################################################
       private
-      ##########################################################################
-
 
       def default_options
         {
@@ -21,17 +17,13 @@ module Pio
         }
       end
 
-
       def user_options
         @options.merge(
-          {
-            :sender_hardware_address => @options[ :source_mac ],
-            :target_hardware_address => @options[ :destination_mac ]
-          }
+          :sender_hardware_address => @options[:source_mac],
+          :target_hardware_address => @options[:destination_mac]
         )
       end
 
-
       def mandatory_options
         [
           :source_mac,
@@ -46,7 +38,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/arp/request.rb

@@ -1,7 +1,7 @@
-require "pio/arp/frame"
-require "pio/arp/message"
-require "pio/mac"
-
+# -*- coding: utf-8 -*-
+require 'pio/arp/frame'
+require 'pio/arp/message'
+require 'pio/mac'
 
 module Pio
   class Arp
@@ -9,14 +9,10 @@ module Pio
     class Request < Message
       OPERATION = 1
 
-      BROADCAST_MAC_ADDRESS = Mac.new( 0xffffffffffff ).to_a
-      ALL_ZERO_MAC_ADDRESS = Mac.new( 0 ).to_a
-
+      BROADCAST_MAC_ADDRESS = Mac.new(0xffffffffffff).to_a
+      ALL_ZERO_MAC_ADDRESS = Mac.new(0).to_a
 
-      ########################################################################
       private
-      ########################################################################
-
 
       def default_options
         {
@@ -26,14 +22,10 @@ module Pio
         }
       end
 
-
       def user_options
-        @options.merge(
-          { :sender_hardware_address => @options[ :source_mac ] }
-        )
+        @options.merge :sender_hardware_address => @options[:source_mac]
       end
 
-
       def mandatory_options
         [
           :source_mac,
@@ -46,7 +38,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/arp.rb

@@ -1,29 +1,26 @@
-require "rubygems"
-require "bindata"
-
-require "pio/arp/request"
-require "pio/arp/reply"
+# -*- coding: utf-8 -*-
+require 'English'
+require 'rubygems'
+require 'bindata'
 
+require 'pio/arp/request'
+require 'pio/arp/reply'
+require 'pio/util'
 
 module Pio
   # ARP parser and generator.
-  class Arp
-    ARP_MESSAGE_TYPE = { Request::OPERATION => Request, Reply::OPERATION => Reply }
-
 
-    def self.read( raw_data )
-      begin
-        frame = Arp::Frame.read( raw_data )
-      rescue
-        raise Pio::ParseError, $!.message
-      end
-
-      ARP_MESSAGE_TYPE[ frame.operation ].create_from frame
+  class Arp
+    MESSAGE_TYPE = {
+      Request::OPERATION => Request,
+      Reply::OPERATION => Reply
+    }
+    class << self
+      include Util
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix