pio 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75af6278d342dd6e8c2b0c675d1f3f7d82ab3474
-  data.tar.gz: d5e0ee260a39d472ecf3d950e849f33f2558f52d
+  metadata.gz: 46ff2e5ea71119c5c3f334e9714aad64c6394416
+  data.tar.gz: f8d3b344b34473f4ff12992e86ee02db5e97f750
 SHA512:
-  metadata.gz: 780986656174b5c659d486c2affca51f2fd70d09bb848198cf501668670628d5fcf6a3d640af5c8a709fcbad1ab241c4fe50921350964492278267207ed0883a
-  data.tar.gz: 59b6ddea90c19e05307ab2b2f2a8be7b201f5f872fd58824aca29acc1923a1d8eccc1c8a881bf0150568c7ddeab3a029afab45725067f971f95e9be979a9a072
+  metadata.gz: d12b409112666b903cd16280299613440986d86d199e6cf1eff4d1631ba6580c792bc539fac1f4c19017014a6999b2bdb05e4a501b9b4a10ec9332d0f4759afd
+  data.tar.gz: c44a02181e9b75710884acf48773d1f0a287c07d13e96c9f86a25552a4e22682eced7409f32f061836dc7f0a838e4dffa9e42bf41f0a10e0dfc38d706426418e

data/CONTRIBUTING.md

@@ -1,12 +1,46 @@
-# 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.
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by fixing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/trema/pio/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake default`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/README.md

@@ -1,36 +1,33 @@
-Pio
-===
-[![Gem Version](https://badge.fury.io/rb/pio.png)](http://badge.fury.io/rb/pio)
-[![Build Status](https://travis-ci.org/trema/pio.png?branch=develop)](https://travis-ci.org/trema/pio)
-[![Code Climate](https://codeclimate.com/github/trema/pio.png)](https://codeclimate.com/github/trema/pio)
-[![Coverage Status](https://coveralls.io/repos/trema/pio/badge.png?branch=develop)](https://coveralls.io/r/trema/pio)
-[![Dependency Status](https://gemnasium.com/trema/pio.png)](https://gemnasium.com/trema/pio)
+# Pio
 
-<a href="http://www.flickr.com/photos/mongogushi/4226014070/" title="pio pencil by mongo gushi, on Flickr"><img src="http://farm5.staticflickr.com/4022/4226014070_cdeb7c1e5d_n.jpg" width="320" height="290" alt="pio pencil"></a>
-
-Pio is a ruby gem to easily parse and generate network packets. It supports the following packet formats:
+<a href='https://rubygems.org/gems/pio'><img src='http://img.shields.io/gem/v/pio.svg' alt='Gem Version' /></a>
+<a href='https://travis-ci.org/trema/pio'><img src='http://img.shields.io/travis/trema/pio/develop.svg' alt='Build Status' /></a>
+<a href='https://codeclimate.com/github/trema/pio'><img src='http://img.shields.io/codeclimate/github/trema/pio.svg' alt='Code Climate' /></a>
+<a href='https://coveralls.io/r/trema/pio?branch=develop'><img src='http://img.shields.io/coveralls/trema/pio/develop.svg' alt='Coverage Status' /></a>
+<a href='https://gemnasium.com/trema/pio'><img src='https://gemnasium.com/trema/pio.svg' alt='Dependency Status' /></a>
+<a href="http://inch-pages.github.io/github/trema/pio"><img src="http://inch-pages.github.io/github/trema/pio.svg" alt="Inline docs"></a>
 
- * ICMP
- * ARP
- * LLDP
- * (...currently there are just a few formats supported but I'm sure this list will grow)
+<a href="http://www.flickr.com/photos/mongogushi/4226014070/" title="pio pencil by mongo gushi, on Flickr"><img src="http://farm5.staticflickr.com/4022/4226014070_cdeb7c1e5d_n.jpg" width="320" height="290" alt="pio pencil"></a>
 
+Pio is a ruby gem to easily parse and generate network packets. It
+supports the following packet formats:
 
-Features Overview
------------------
+-   ICMP
+-   ARP
+-   LLDP
+-   DHCP
+-   (&#x2026;currently there are just a few formats supported but I'm sure this list will grow)
 
- * Pure Ruby. No additional dependency on other external tools
-   to parse/generate packets.
- * Multi-Platform. Runs on major operating systems (recent Windows,
-   Linux, and MacOSX), and supports all major version of Ruby (1.8.7,
-   1.9.3, 2.0.0).
- * Clean Code. Pio is built on
-   [BinData](https://github.com/dmendel/bindata)'s declarative binary
-   format DSL so that it is easy to read and debug by human beings.
+## Features Overview
 
+-   Pure Ruby. No additional dependency on other external tools to
+    parse/generate packets.
+-   Multi-Platform. Runs on major operating systems (recent Windows,
+    Linux, and MacOSX).
+-   Clean Code. Pio is built on [BinData](https://github.com/dmendel/bindata)'s declarative binary format DSL
+    so that it is easy to read and debug by human beings.
 
-Examples
---------
+## Examples
 
 Its usage is dead simple.
 
@@ -39,141 +36,159 @@ Its usage is dead simple.
 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'
-```
+    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.
-```
+    require 'pio'
+
+    request = Pio::Icmp::Request.new(
+      source_mac: '00:16:9d:1d:9c:c4',
+      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(
+      source_mac: '00:26:82:eb:ea:d1',
+      destination_mac: '00:16:9d:1d:9c:c4',
+      ip_source_address: '192.168.83.254',
+      ip_destination_address: '192.168.83.3',
+      # The ICMP Identifier and the ICMP Sequence number
+      # should be same as those of the request.
+      identifier: request.icmp_identifier,
+      sequence_number: request.icmp_sequence_number
+    )
+    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'
-
-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'
-)
-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'
-)
-reply.to_binary  #=> Arp Reply frame in binary format.
-```
+    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'
+    )
+    request.to_binary  # => Arp Request frame in binary format.
+
+    reply = Pio::Arp::Reply.new(
+      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'
+    )
+    reply.to_binary  # => Arp Reply frame in binary format.
 
 ### LLDP
 
 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.ttl #=> 120
-```
+    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.to_binary  #=> LLDP frame in binary format.
-```
+    lldp = Pio::Lldp.new(dpid: 0x123, port_number: 12)
+    lldp.to_binary  # => LLDP frame in binary format.
 
+### DHCP
 
-Installation
-------------
+To parse a DHCP frame, use the API `Pio::Dhcp.read` and you can access
+each field of the parsed DHCP frame.
 
-The simplest way to install Pio is to use [Bundler](http://gembundler.com/).
+    require 'pio'
 
-Add Pio to your `Gemfile`:
+    dhcp = Pio::Dhcp.read(binary_data)
+    dhcp.destination_mac.to_s  # => 'ff:ff:ff:ff:ff:ff'
 
-```ruby
-gem 'pio'
-```
+Also you can use `Pio::Dhcp::Discover#new`,
+`Pio::Dhcp::Offer#new`, `Pio::Dhcp::Request#new` and
+`Pio::Dhcp::Ack#new` to generate a DHCP frame like below:
 
-and install it by running Bundler:
+    require 'pio'
 
-```bash
-$ bundle
-```
+    discover = Pio::Dhcp::Discover.new(source_mac: '24:db:ac:41:e5:5b')
+    discover.to_binary  # => DHCP Discover frame in binary format
 
+    offer = Pio::Dhcp::Offer.new(
+      source_mac: '00:26:82:eb:ea:d1',
+      destination_mac: '24:db:ac:41:e5:5b',
+      ip_source_address: '192.168.0.100',
+      ip_destination_address: '192.168.0.1',
+      transaction_id: discover.transaction_id
+    )
+    offer.to_binary  # => DHCP Offer frame in binary format
 
-Documents
----------
+    request = Pio::Dhcp::Request.new(
+      source_mac: '24:db:ac:41:e5:5b',
+      server_identifier: '192.168.0.100',
+      requested_ip_address: '192.168.0.1',
+      transaction_id: offer.transaction_id
+    )
+    request.to_binary  # => DHCP Request frame in binary format
 
- * [API document generated with YARD](http://rubydoc.info/github/trema/pio/frames/file/README.md)
+    ack = Pio::Dhcp::Ack.new(
+      source_mac: '00:26:82:eb:ea:d1',
+      destination_mac: '24:db:ac:41:e5:5b',
+      ip_source_address: '192.168.0.100',
+      ip_destination_address: '192.168.0.1',
+      transaction_id: request.transaction_id
+    )
+    ack.to_binary  # => DHCP Ack frame in binary format
 
+## Installation
 
-Team
-----
+The simplest way to install Pio is to use [Bundler](http://gembundler.com/).
 
- * [Yasuhito Takamiya](https://github.com/yasuhito) ([@yasuhito](https://twitter.com/yasuhito))
- * [Eishun Kondoh](https://github.com/shun159) ([@Eishun_Kondoh](https://twitter.com/Eishun_Kondoh))
+Add Pio to your `Gemfile`:
 
-### Contributors
+    gem 'pio'
+
+and install it by running Bundler:
 
-[https://github.com/trema/pio/contributors](https://github.com/trema/pio/contributors)
+    prompt> bundle
 
+## Documents
 
-Alternatives
-------------
+-   [API document generated with YARD](http://rubydoc.info/github/trema/pio/frames/file/README.md)
+
+## Team
+
+-   [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
 
- * PacketFu: https://github.com/todb/packetfu
- * Racket: http://spoofed.org/files/racket/
+<https://github.com/trema/pio/contributors>
 
+## Alternatives
 
-License
--------
+-   PacketFu: <https://github.com/todb/packetfu>
+-   Racket: <http://spoofed.org/files/racket/>
 
-Trema is released under the GNU General Public License version 3.0:
+## License
 
-* http://www.gnu.org/licenses/gpl.html
+Pio is released under the GNU General Public License version 3.0:
+-   <http://www.gnu.org/licenses/gpl.html>

data/Rakefile

@@ -1,101 +1,16 @@
+# encoding: utf-8
+
 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']
+# rubocop:disable HashSyntax
 
 task :default => :travis
+
 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|
-  t.fail_on_error = false
-  t.verbose = false
-  t.ruby_opts = ['-rubygems']
-  t.reek_opts = '--quiet'
-  t.source_files = ruby_source
-end
-
-desc 'Analyze for code complexity'
-task :flog do
-  flog = Flog.new(:continue => true)
-  flog.flog(*ruby_source)
-  threshold = 28
-
-  bad_methods = flog.totals.select do |name, score|
-    !(/##{flog.no_method}$/ =~ name) && score > threshold
-  end
-  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 complexity > #{threshold}"
-  end
-end
-
-FlayTask.new do |t|
-  t.dirs = ruby_source.map do |each|
-    each[/[^\/]+/]
-  end.uniq
-  t.threshold = 0
-  t.verbose = true
-end
-
-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'
-end
-
-def rubies
-  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'
-task :portability
-
-rubies.each do |each|
-  portability_task_name = "portability:#{each}"
-  task :portability => portability_task_name
+task :quality => [:reek, :flog, :flay, :rubocop]
 
-  desc "Run tests against Ruby#{each}"
-  task portability_task_name do
-    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
+# rubocop:enable HashSyntax
 
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:
+Dir.glob('tasks/*.rake').each { |each| import each }