pio 0.30.0 → 0.30.1

data/lib/pio/open_flow13/packet_out.rb

@@ -1,6 +1,7 @@
+require 'active_support/core_ext/object/try'
 require 'pio/open_flow'
+require 'pio/open_flow/buffer_id'
 require 'pio/open_flow13/actions'
-require 'pio/open_flow13/buffer_id'
 
 module Pio
   module OpenFlow13
@@ -14,7 +15,7 @@ module Pio
         uint32 :in_port
 
         def get
-          (in_port == CONTROLLER) ? :controller : in_port
+          in_port == CONTROLLER ? :controller : in_port
         end
 
         def set(value)
@@ -22,24 +23,24 @@ module Pio
         end
       end
 
-      open_flow_header(version: 4,
-                       message_type: 13,
-                       message_length: lambda do
+      open_flow_header(version: 4, type: 13,
+                       length: lambda do
                          24 + actions_length + raw_data.length
                        end)
       buffer_id :buffer_id
       in_port :in_port
       uint16 :actions_length, initial_value: -> { actions.binary.length }
       string :padding, length: 6
-      actions :actions, length: :actions_length
-      string :raw_data, read_length: -> { message_length - 24 - actions_length }
+      actions13 :actions, length: :actions_length
+      string :raw_data, read_length: -> { length - 24 - actions_length }
 
       def data
         @data ||= Pio::Parser.read(raw_data)
       end
 
       def method_missing(method, *args)
-        data.__send__(method, *args).snapshot
+        bindata_value = data.__send__(method, *args)
+        bindata_value.try(:snapshot) || bindata_value
       end
     end
   end

data/lib/pio/open_flow13/set_ip_ttl.rb

@@ -0,0 +1,16 @@
+require 'pio/open_flow/action'
+
+module Pio
+  module OpenFlow13
+    # Sets IP TTL
+    class SetIpTtl < OpenFlow::Action
+      action_header action_type: 23, action_length: 8
+      uint8 :ttl
+      string :padding, length: 3
+
+      def initialize(ttl)
+        super(ttl: ttl)
+      end
+    end
+  end
+end

data/lib/pio/open_flow13/stats_request.rb

@@ -12,7 +12,7 @@ module Pio
                  :table,
                  :port,
                  :queue,
-                 :vendor]
+                 :vendor].freeze
 
         endian :big
 
@@ -27,9 +27,7 @@ module Pio
         end
       end
 
-      open_flow_header version: 4,
-                       message_type: 16,
-                       message_length: 12
+      open_flow_header version: 4, type: 16, length: 12
       stats_type :stats_type
       uint16 :stats_flags
     end

data/lib/pio/open_flow13/write_metadata.rb

@@ -1,52 +1,54 @@
 require 'forwardable'
+require 'pio/open_flow/action'
 
-# Base module.
 module Pio
-  # Write metadata
-  class WriteMetadata
-    # OpenFlow 1.3.4 OFPIT_WRITE_METADATA instruction format
-    class Format < BinData::Record
-      endian :big
-
-      uint16 :instruction_type, value: 2
-      uint16 :instruction_length, value: 24
-      uint32 :padding
-      uint64 :metadata
-      uint64 :metadata_mask
-    end
+  module OpenFlow13
+    # Write metadata
+    class WriteMetadata < OpenFlow::Action
+      # OpenFlow 1.3.4 OFPIT_WRITE_METADATA instruction format
+      class Format < BinData::Record
+        endian :big
+
+        uint16 :instruction_type, value: 2
+        uint16 :instruction_length, value: 24
+        uint32 :padding
+        uint64 :metadata
+        uint64 :metadata_mask
+      end
 
-    def self.read(raw_data)
-      allocate.tap do |write_metadata|
-        write_metadata.instance_variable_set :@format, Format.read(raw_data)
+      def self.read(raw_data)
+        allocate.tap do |write_metadata|
+          write_metadata.instance_variable_set :@format, Format.read(raw_data)
+        end
       end
-    end
 
-    extend Forwardable
+      extend Forwardable
 
-    def_delegators :@format, :instruction_type
-    def_delegators :@format, :instruction_length
-    def_delegators :@format, :metadata
-    def_delegators :@format, :metadata_mask
-    def_delegators :@format, :to_binary_s
+      def_delegators :@format, :instruction_type
+      def_delegators :@format, :instruction_length
+      def_delegators :@format, :metadata
+      def_delegators :@format, :metadata_mask
+      def_delegators :@format, :to_binary_s
 
-    def initialize(user_options)
-      @options = user_options
-      @format = Format.new(options)
-    end
+      def initialize(user_options)
+        @options = user_options
+        @format = Format.new(options)
+      end
 
-    def options
-      {
-        metadata: metadata_option,
-        metadata_mask: metadata_mask_option
-      }
-    end
+      def options
+        {
+          metadata: metadata_option,
+          metadata_mask: metadata_mask_option
+        }
+      end
 
-    def metadata_option
-      @options[:metadata]
-    end
+      def metadata_option
+        @options[:metadata]
+      end
 
-    def metadata_mask_option
-      @options[:metadata_mask]
+      def metadata_mask_option
+        @options[:metadata_mask]
+      end
     end
   end
 end

data/lib/pio/options.rb

@@ -14,6 +14,11 @@ module Pio
       const_get(:OPTIONS) << name
     end
 
+    def initialize(options)
+      validate options
+      @options = options
+    end
+
     private
 
     def validate(user_options)
@@ -42,7 +47,7 @@ module Pio
     def check_unknown(user_options)
       valid_options = mandatory_options + options
       user_options.keys.each do |each|
-        fail "Unknown option: #{each}." unless valid_options.include?(each)
+        raise "Unknown option: #{each}." unless valid_options.include?(each)
       end
     end
 
@@ -54,10 +59,10 @@ module Pio
 
     def check_existence(user_options, key)
       value = user_options.fetch(key) do |missing_key|
-        fail ArgumentError, "The #{missing_key} option should be passed."
+        raise ArgumentError, "The #{missing_key} option should be passed."
       end
       return if value
-      fail(ArgumentError, "The #{key} option shouldn't be #{value.inspect}.")
+      raise(ArgumentError, "The #{key} option shouldn't be #{value.inspect}.")
     end
   end
 end

data/lib/pio/parser.rb

@@ -1,27 +1,18 @@
+require 'pio/ethernet_frame'
 require 'pio/ethernet_header'
 require 'pio/ipv4_header'
 
 module Pio
   # Raw data parser.
   class Parser
-    # Ethernet header parser
-    class EthernetFrame < BinData::Record
-      endian :big
-
-      mac_address :destination_mac
-      mac_address :source_mac
-      uint16 :ether_type
-      rest :rest
-    end
-
     # IPv4 packet parser
     class IPv4Packet < BinData::Record
-      include EthernetHeader
-      include IPv4Header
+      include Ethernet
+      include IPv4
 
       endian :big
 
-      ethernet_header ether_type: EtherType::IPV4
+      ethernet_header ether_type: Ethernet::Type::IPV4
       ipv4_header
 
       uint16 :transport_source_port
@@ -33,11 +24,11 @@ module Pio
     def self.read(raw_data)
       ethernet_frame = EthernetFrame.read(raw_data)
       case ethernet_frame.ether_type
-      when EthernetHeader::EtherType::IPV4, EthernetHeader::EtherType::VLAN
+      when Ethernet::Type::IPV4, Ethernet::Type::VLAN
         IPv4Packet.read raw_data
-      when EthernetHeader::EtherType::ARP
+      when Ethernet::Type::ARP
         Pio::Arp.read raw_data
-      when EthernetHeader::EtherType::LLDP
+      when Ethernet::Type::LLDP
         Pio::Lldp.read raw_data
       else
         ethernet_frame

data/lib/pio/ruby_dumper.rb

@@ -0,0 +1,69 @@
+module Pio
+  # defines to_ruby method
+  module RubyDumper
+    # Returns a Ruby code representation of this packet, such that
+    # it can be eval'ed and sent later.
+    #
+    # rubocop:disable AbcSize
+    # rubocop:disable MethodLength
+    # rubocop:disable CyclomaticComplexity
+    # rubocop:disable PerceivedComplexity
+    def to_ruby
+      pack_template = ''
+      bytes = ''
+      bit = false
+      bit_names = []
+      total_bit_length = 0
+      field_names.each do |each|
+        next unless __send__("#{each}?")
+        if /Bit(\d+)$/ =~ __send__(each).class.to_s
+          bit_length = Regexp.last_match(1).to_i
+          total_bit_length += bit_length
+          if bit
+            bit_names << each
+            bytes << format("_%0#{bit_length}b", __send__(each))
+          else
+            bit_names = [each]
+            bytes << format("  0b%0#{bit_length}b", __send__(each))
+          end
+          bit = true
+        else
+          if bit
+            bytes << ", # #{bit_names.join(', ')}\n"
+            if total_bit_length == 8
+              pack_template << 'C'
+            elsif total_bit_length == 16
+              pack_template << 'n'
+            else
+              raise
+            end
+            total_bit_length = 0
+            bit_names = []
+            bit = false
+          end
+          list = (@format || self).__send__(each).to_bytes
+          next if list.empty?
+          bytes << "  #{list}, # #{each}\n"
+          pack_template << 'C' * (list.count(',') + 1)
+        end
+      end.compact
+
+      template = ''
+      until pack_template.empty?
+        if /^(.)(\1+)/ =~ pack_template
+          pack_template.sub!(/^(.)(\1+)/, '')
+          template <<
+            "#{Regexp.last_match(1)}#{Regexp.last_match(2).length + 1}"
+        else
+          pack_template.sub!(/^(.)/, '')
+          template << Regexp.last_match(1)
+        end
+      end
+      "[\n#{bytes}].pack('#{template}')"
+    end
+    # rubocop:enable AbcSize
+    # rubocop:enable MethodLength
+    # rubocop:enable CyclomaticComplexity
+    # rubocop:enable PerceivedComplexity
+  end
+end

data/lib/pio/type/ether_type.rb

@@ -0,0 +1,31 @@
+require 'bindata'
+
+module Pio
+  module Type
+    # Ether type
+    class EtherType < BinData::Primitive
+      endian :big
+
+      uint16 :ether_type
+
+      def set(value)
+        self.ether_type = value
+      end
+
+      def get
+        ether_type
+      end
+
+      # This method smells of :reek:UncommunicativeVariableName
+      def to_bytes
+        byte1 = format('%02x', (self & 0xff00) >> 8)
+        byte2 = format('%02x', self & 0xff)
+        "0x#{byte1}, 0x#{byte2}"
+      end
+
+      def inspect
+        Kernel.format '0x%04x', self
+      end
+    end
+  end
+end

data/lib/pio/type/ip_address.rb

@@ -26,6 +26,14 @@ module Pio
       def ==(other)
         get == other
       end
+
+      def to_bytes
+        octets.map(&:to_hex).join(', ')
+      end
+
+      def inspect
+        %("#{get}")
+      end
     end
   end
 end

data/lib/pio/type/mac_address.rb

@@ -1,5 +1,7 @@
 require 'bindata'
 require 'pio/mac'
+require 'pio/monkey_patch/integer'
+require 'pio/monkey_patch/uint'
 
 module Pio
   module Type
@@ -16,6 +18,14 @@ module Pio
                   str + format('%02x', each)
                 end.hex)
       end
+
+      def to_bytes
+        octets.map(&:to_hex).join(', ')
+      end
+
+      def inspect
+        %("#{get}")
+      end
     end
   end
 end

data/lib/pio/udp.rb

@@ -6,12 +6,12 @@ require 'pio/udp_header'
 module Pio
   # UDP packet format
   class Udp < BinData::Record
-    include EthernetHeader
-    include IPv4Header
+    include Ethernet
+    include IPv4
     include UdpHeader
 
     endian :big
-    ethernet_header ether_type: EtherType::IPV4
+    ethernet_header ether_type: Ethernet::Type::IPV4
     ipv4_header ip_protocol: ProtocolNumber::UDP
     udp_header
     rest :udp_payload

data/lib/pio/udp_header.rb

@@ -11,7 +11,7 @@ module Pio
       ip_address :source_ip_address
       ip_address :destination_ip_address
       uint8 :padding
-      uint8 :ip_protocol, value: IPv4Header::ProtocolNumber::UDP
+      uint8 :ip_protocol, value: IPv4::ProtocolNumber::UDP
       uint16 :udp_length
     end
 

data/lib/pio/version.rb

@@ -1,5 +1,5 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = '0.30.0'.freeze
+  VERSION = '0.30.1'.freeze
 end

data/pio.gemspec

@@ -8,57 +8,24 @@ Gem::Specification.new do |gem|
   gem.summary = 'Packet parser and generator.'
   gem.description = 'Pure ruby packet parser and generator.'
 
-  gem.license = 'GPL3'
+  gem.licenses = %w(GPLv2 MIT)
 
   gem.authors = ['Yasuhito Takamiya']
   gem.email = ['yasuhito@gmail.com']
   gem.homepage = 'http://github.com/trema/pio'
 
-  gem.files = %w(CONTRIBUTING.md LICENSE Rakefile pio.gemspec)
+  gem.files = %w(CONTRIBUTING.md 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 = %w(README.md CHANGELOG.md LICENSE CONTRIBUTING.md)
+  gem.extra_rdoc_files = %w(README.md CHANGELOG.md CONTRIBUTING.md)
   gem.test_files = Dir.glob('spec/**/*')
   gem.test_files += Dir.glob('features/**/*')
 
-  gem.required_ruby_version = '>= 2.0.0'
+  gem.required_ruby_version = '>= 2.2.2'
 
   gem.add_dependency 'bindata', '~> 2.1.0'
-  gem.add_dependency 'activesupport', '~> 4.2', '>= 4.2.4'
-
-  gem.add_development_dependency 'bundler', '~> 1.10.6'
-  gem.add_development_dependency 'pry', '~> 0.10.3'
-  gem.add_development_dependency 'rake'
-
-  # Guard
-  gem.add_development_dependency 'guard', '~> 2.13.0'
-  gem.add_development_dependency 'guard-bundler', '~> 2.1.0'
-  gem.add_development_dependency 'guard-cucumber', '~> 1.6.0'
-  gem.add_development_dependency 'guard-rspec', '~> 4.6.4'
-  gem.add_development_dependency 'guard-rubocop', '~> 1.2.0'
-  gem.add_development_dependency 'rb-fchange', '~> 0.0.6'
-  gem.add_development_dependency 'rb-fsevent', '~> 0.9.6'
-  gem.add_development_dependency 'rb-inotify', '~> 0.9.5'
-  gem.add_development_dependency 'terminal-notifier-guard', '~> 1.6.4'
-
-  # Docs
-  gem.add_development_dependency 'inch', '~> 0.7.0'
-  gem.add_development_dependency 'relish', '~> 0.7.1'
-  gem.add_development_dependency 'yard', '~> 0.8.7.6'
-
-  # Test
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.8'
-  gem.add_development_dependency 'coveralls', '~> 0.8.3'
-  gem.add_development_dependency 'cucumber', '~> 2.1.0'
-  gem.add_development_dependency 'flay', '~> 2.6.1'
-  gem.add_development_dependency 'flog', '~> 4.3.2'
-  gem.add_development_dependency 'reek', '~> 3.6.0'
-  gem.add_development_dependency 'rspec', '~> 3.3.0'
-  gem.add_development_dependency 'rspec-given', '~> 3.7.1'
-  gem.add_development_dependency 'rubocop', '~> 0.34.2'
+  gem.add_dependency 'activesupport', '~> 5.0.2'
 end