pio 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42e4ddeb113721d1515042c5b21242f7f5f49f76
+  data.tar.gz: 4d135571f99d94db9e3b0f534e8154669da4360d
+SHA512:
+  metadata.gz: bae38aa9d987cfd6965b4657222e8713dc4e019d655bcc4fc2b81c1bdee8fa03d5b9795324b8915290e56d78ae4b8b93584d071b0cc65ab921b64da47b7cb61c
+  data.tar.gz: 0ff3e93fc9a7159807c3ed2bb01fb8ff045e948e34ee32a1956b6856fa9ec24c8734b2287bffd5fe77d66194e29c5e5d85f63db329495cfa480af23971e3bf9f

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+script: "rake travis"
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+branches:
+  only:
+    - master
+    - develop

data/Gemfile

@@ -1,27 +1,28 @@
 source "https://rubygems.org"
 
 
-gem "bindata"
+gemspec
 
 
 group :development do
-  gem "cucumber", "~> 1.3.3"
-  gem "flay", "~> 2.3.1"
+  gem "coveralls", "~> 0.6.7", :require => false
+  gem "flay", "~> 2.4.0"
   gem "flog", "~> 4.1.1"
-  gem "guard", "~> 1.8.1"
+  gem "guard", "~> 1.8.2"
   gem "guard-bundler", "~> 1.0.0"
   gem "guard-rspec", "~> 3.0.2"
+  gem "json", "~> 1.8.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.0", :require => false
+  gem "rb-inotify", "~> 0.9.1", :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.1"
+  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.6.2"
+  gem "yard", "~> 0.8.7"
 end
 
 

data/README.md

@@ -1,4 +1,99 @@
-pio
+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)
 
-Packet parser and generator
+<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:
+
+ * [LLDP](http://en.wikipedia.org/wiki/Link_Layer_Discovery_Protocol)
+ * (...currently there are just a few formats supported but I'm sure this list will grow)
+
+
+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), 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.
+ 
+
+Example
+-------
+
+Its usage is dead simple: to parse an LLDP frame for example, use the
+API `Pio::Lldp.read` and you can access each field of the parsed LLDP
+frame.
+
+```ruby
+require "pio"
+
+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"
+
+lldp = Pio::Lldp.new( 0x123, 12 )  # dpid and port_number
+lldp.to_binary  #=> LLDP frame in binary format.
+```
+
+
+Installation
+------------
+
+The simplest way to install Pio is to use [Bundler](http://gembundler.com/).
+
+Add Pio to your `Gemfile`:
+
+```ruby
+gem 'pio'
+```
+
+and install it by running Bundler:
+
+```bash
+$ bundle
+```
+
+
+Documents
+---------
+
+ * [API document generated with YARD](http://rubydoc.info/github/trema/pio/frames/file/README.md)
+
+
+### Author
+
+[Yasuhito Takamiya](https://github.com/yasuhito) ([@yasuhito](http://twitter.com/yasuhito))
+
+### Contributors
+
+[https://github.com/trema/pio/contributors](https://github.com/trema/pio/contributors)
+
+
+Alternatives
+------------
+
+ * PacketFu: https://github.com/todb/packetfu
+ * Racket: http://spoofed.org/files/racket/
+
+
+License
+-------
+
+Trema is released under the GNU General Public License version 3.0:
+
+* http://www.gnu.org/licenses/gpl.html

data/Rakefile

@@ -17,22 +17,29 @@
 
 
 require "bundler/gem_tasks"
+require "coveralls/rake/task"
 require "flay"
-require "rake/tasklib"
 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" ]
 task :quality => [ :reek, :flog, :flay ]
 
 
+Coveralls::RakeTask.new
+
+
 RSpec::Core::RakeTask.new do | task |
   task.rspec_opts = "--format documentation --color"
 end
@@ -51,7 +58,7 @@ desc "Analyze for code complexity"
 task :flog do
   flog = Flog.new( :continue => true )
   flog.flog( *$ruby_source )
-  threshold = 10
+  threshold = 20
 
   bad_methods = flog.totals.select do | name, score |
     ( not ( /##{flog.no_method}$/=~ name ) ) and score > threshold
@@ -82,6 +89,31 @@ YARD::Rake::YardocTask.new do | t |
 end
 
 
+def travis_yml
+  File.join File.dirname( __FILE__ ), ".travis.yml"
+end
+
+
+def rubies
+  ( [ "1.8.7" ] + YAML.load_file( travis_yml )[ "rvm" ] ).uniq.sort
+end
+
+
+desc "Run tests against multiple rubies"
+task :portability
+
+rubies.each do | each |
+  portability_task_name = "portability:#{ each }"
+  task :portability => portability_task_name
+
+  desc "Run tests against Ruby#{ each }"
+  task portability_task_name do
+    sh "rvm #{ each } exec bundle"
+    sh "rvm #{ each } exec bundle exec rake"
+  end
+end
+
+
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/version.rb

@@ -19,7 +19,7 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end
 
 

data/pio.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do | gem |
 
   gem.extra_rdoc_files = [ "README.md" ]
   gem.test_files = `git ls-files -- {spec,features}/*`.split( "\n" )
+
+  gem.add_dependency "bindata", "~> 1.6.0"
 end
 
 

data/spec/pio/lldp/mac-address_spec.rb

@@ -7,7 +7,7 @@ module Pio
     describe MacAddress do
       subject { MacAddress.new( "01:80:c2:00:00:0e" ) }
 
-      its( :to_binary_s ) { should eq "\001\200\302\000\000\016" }
+      its( :to_binary_s ) { should eq [ 0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e ].pack( "C6" ) }
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 require "rubygems"
 
+require "simplecov"
+SimpleCov.start
+
 require "rspec"
 require "rspec/autorun"
 
@@ -11,6 +14,12 @@ Dir[ "#{ File.dirname( __FILE__ ) }/support/**/*.rb" ].each do | each |
 end
 
 
+if ENV[ "TRAVIS" ]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

metadata

@@ -1,34 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pio
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Yasuhito Takamiya
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-07-31 00:00:00 Z
-dependencies: []
-
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 description: Pure ruby packet parser and generator.
-email: 
+email:
 - yasuhito@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -59,38 +64,37 @@ files:
 - spec/pio/lldp_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/trema/pio
-licenses: 
+licenses:
 - GPL3
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Packet parser and generator.
-test_files: []
-
+test_files:
+- spec/pio/lldp/chassis-id-tlv_spec.rb
+- spec/pio/lldp/end-of-lldpdu-value_spec.rb
+- spec/pio/lldp/frame_spec.rb
+- spec/pio/lldp/mac-address_spec.rb
+- spec/pio/lldp/optional-tlv_spec.rb
+- spec/pio/lldp/port-id-tlv_spec.rb
+- spec/pio/lldp/ttl-tlv_spec.rb
+- spec/pio/lldp_spec.rb
+- spec/spec_helper.rb
 has_rdoc: