ffi-pcap 0.2.0 → 0.2.1

data/lib/ffi/pcap/stat.rb

@@ -1,57 +1,27 @@
-module FFI
-module PCap
-  # As returned by pcap_stats()
-  #
-  # See pcap_stat struct in pcap.h.
-  class Stat < FFI::Struct
-    include FFI::DRY::StructHelper
-
-    dsl_layout do
-      field :ps_recv,   :uint, :desc => "number of packets received"
-      field :ps_drop,   :uint, :desc => "numer of packets dropped"
-      field :ps_ifdrop, :uint, :desc => "drops by interface (not yet supported)"
-      # bs_capt field intentionally left off (WIN32 only)
-    end
-
-    alias received ps_recv
-    alias dropped ps_drop
-    alias interface_dropped ps_ifdrop
+require 'ffi/pcap/stat_ex'
 
-  end
+module FFI
+  module PCap
+    #
+    # As returned by `pcap_stats`.
+    #
+    # See `pcap_stat` struct in `pcap.h`.
+    #
+    class Stat < FFI::Struct
 
-  # As returned by pcap_stats_ex() (MSDOS only)
-  #
-  # See pcap_stat_ex struct in pcap.h
-  class StatEx < FFI::Struct
-    include FFI::DRY::StructHelper
+      include FFI::DRY::StructHelper
 
-    dsl_layout do
-      field :rx_packets,  :ulong, :desc => "total packets received"
-      field :tx_packets,  :ulong, :desc => "total packets transmitted"
-      field :rx_bytes,    :ulong, :desc => "total bytes received"
-      field :tx_bytes,    :ulong, :desc => "total bytes transmitted"
-      field :rx_errors,   :ulong, :desc => "bad packets received"
-      field :tx_errors,   :ulong, :desc => "packet transmit problems"
-      field :rx_dropped,  :ulong, :desc => "no space in Rx buffers"
-      field :tx_dropped,  :ulong, :desc => "no space available for Tx"
-      field :multicast,   :ulong, :desc => "multicast packets received"
-      field :collisions,  :ulong
+      dsl_layout do
+        field :ps_recv,   :uint, :desc => "number of packets received"
+        field :ps_drop,   :uint, :desc => "numer of packets dropped"
+        field :ps_ifdrop, :uint, :desc => "drops by interface (not yet supported)"
+        # bs_capt field intentionally left off (WIN32 only)
+      end
 
-      # detailed rx errors
-      field :rx_length_errors, :ulong
-      field :rx_over_errors,   :ulong, :desc => "ring buff overflow"
-      field :rx_crc_errors,    :ulong, :desc => "pkt with crc error"
-      field :rx_frame_errors,  :ulong, :desc => "frame alignment errors"
-      field :rx_fifo_errors,   :ulong, :desc => "fifo overrun"
-      field :rx_missed_errors, :ulong, :desc => "missed packet"
+      alias received ps_recv
+      alias dropped ps_drop
+      alias interface_dropped ps_ifdrop
 
-      # detailed tx_errors
-      field :tx_aborted_errors,   :ulong
-      field :tx_carrier_errors,   :ulong
-      field :tx_fifo_errors,      :ulong
-      field :tx_heartbeat_errors, :ulong
-      field :tx_window_errors,    :ulong
     end
   end
 end
-end

data/lib/ffi/pcap/stat_ex.rb

@@ -0,0 +1,42 @@
+module FFI
+  module PCap
+    #
+    # As returned by `pcap_stats_ex()` (MSDOS only).
+    #
+    # See `pcap_stat_ex` struct in `pcap.h`.
+    #
+    class StatEx < FFI::Struct
+
+      include FFI::DRY::StructHelper
+
+      dsl_layout do
+        field :rx_packets,  :ulong, :desc => "total packets received"
+        field :tx_packets,  :ulong, :desc => "total packets transmitted"
+        field :rx_bytes,    :ulong, :desc => "total bytes received"
+        field :tx_bytes,    :ulong, :desc => "total bytes transmitted"
+        field :rx_errors,   :ulong, :desc => "bad packets received"
+        field :tx_errors,   :ulong, :desc => "packet transmit problems"
+        field :rx_dropped,  :ulong, :desc => "no space in Rx buffers"
+        field :tx_dropped,  :ulong, :desc => "no space available for Tx"
+        field :multicast,   :ulong, :desc => "multicast packets received"
+        field :collisions,  :ulong
+
+        # detailed rx errors
+        field :rx_length_errors, :ulong
+        field :rx_over_errors,   :ulong, :desc => "ring buff overflow"
+        field :rx_crc_errors,    :ulong, :desc => "pkt with crc error"
+        field :rx_frame_errors,  :ulong, :desc => "frame alignment errors"
+        field :rx_fifo_errors,   :ulong, :desc => "fifo overrun"
+        field :rx_missed_errors, :ulong, :desc => "missed packet"
+
+        # detailed tx_errors
+        field :tx_aborted_errors,   :ulong
+        field :tx_carrier_errors,   :ulong
+        field :tx_fifo_errors,      :ulong
+        field :tx_heartbeat_errors, :ulong
+        field :tx_window_errors,    :ulong
+      end
+
+    end
+  end
+end

data/lib/ffi/pcap/time_val.rb

@@ -1,48 +1,62 @@
 module FFI
-module PCap
-  class TimeVal < FFI::Struct
-    include FFI::DRY::StructHelper
+  module PCap
+    class TimeVal < FFI::Struct
 
-    dsl_layout do
-      field :tv_sec, :time_t
-      field :tv_usec, :suseconds_t
-    end
+      include FFI::DRY::StructHelper
 
-    def initialize(*args)
-      if args.size == 1 and (t=args[0]).kind_of?(Time)
-        self.time = t
-      else
-        super(*args)
+      dsl_layout do
+        field :tv_sec, :time_t
+        field :tv_usec, :suseconds_t
       end
-    end
 
-    alias sec tv_sec
-    alias usec tv_usec
+      #
+      # Initializes the new {TimeVal}.
+      #
+      # @param [Time, FFI::Pointer] timeval
+      #   A Time object or a pointer to another {TimeVal}.
+      #
+      def initialize(timeval=nil)
+        case timeval
+        when Time
+          super()
 
-    # Returns the time value as a ruby Time object.
-    #
-    # @return [Time]
-    #   A ruby time object derived from this TimeVal.
-    def time
-      Time.at(self.tv_sec, self.tv_usec)
-    end
+          self.time = timeval
+        when Pointer then super(timeval)
+        else              super()
+        end
+      end
 
-    alias to_time time
-
-    # Sets the time value from a ruby Time object
-    #
-    # @param [Time] t
-    #   A ruby time object from which to set the time.
-    #
-    # @return [Time]
-    #   Returns the same Time object supplied per convention.
-    #
-    def time=(t)
-      self.tv_sec = t.tv_sec
-      self.tv_usec = t.tv_usec
-      return t
-    end
+      alias sec tv_sec
+      alias usec tv_usec
+
+      #
+      # Returns the time value as a ruby Time object.
+      #
+      # @return [Time]
+      #   A ruby time object derived from this TimeVal.
+      #
+      def time
+        Time.at(self.tv_sec, self.tv_usec)
+      end
 
+      alias to_time time
+
+      #
+      # Sets the time value from a ruby Time object
+      #
+      # @param [Time] new_time
+      #   A ruby time object from which to set the time.
+      #
+      # @return [Time]
+      #   Returns the same Time object supplied per convention.
+      #
+      def time=(new_time)
+        self.tv_sec  = new_time.tv_sec
+        self.tv_usec = new_time.tv_usec
+
+        return new_time
+      end
+
+    end
   end
 end
-end

data/lib/ffi/pcap/typedefs.rb

@@ -1,27 +1,23 @@
 module FFI
-module PCap
-  typedef :pointer, :FILE
+  module PCap
+    extend FFI::Library
 
-  typedef :int,  :bpf_int32
-  typedef :uint, :bpf_uint32
+    typedef :pointer, :FILE
 
-  enum :pcap_direction_t, [
-    :pcap_d_inout,
-    :pcap_d_in,
-    :pcap_d_out
-  ]
+    typedef :int,  :bpf_int32
+    typedef :uint, :bpf_uint32
 
-  # For Win32-only pcap_setmode()
-  enum :pcap_w32_modes_enum, [ :capt, :stat, :mon ] 
+    enum :pcap_direction_t, [
+      :pcap_d_inout,
+      :pcap_d_in,
+      :pcap_d_out
+    ]
 
-  typedef :pointer, :pcap_t
-  typedef :pointer, :pcap_dumper_t
-  typedef :pointer, :pcap_addr_t
+    # For Win32-only pcap_setmode()
+    enum :pcap_w32_modes_enum, [ :capt, :stat, :mon ] 
 
-  # add some of the more temperamental FFI types if needed
-  [ [:long, :time_t],
-    [:uint32, :suseconds_t],
-  ].each {|t, d| begin; find_type(d); rescue TypeError; typedef t,d; end }
-
-end
+    typedef :pointer, :pcap_t
+    typedef :pointer, :pcap_dumper_t
+    typedef :pointer, :pcap_addr_t
+  end
 end

data/spec/data_link_spec.rb

@@ -1,65 +1,69 @@
 require 'spec_helper'
 
 describe DataLink do
-  before(:all) do
-    @datalink = DataLink.new(0)
-  end
+  subject { described_class.new(0) }
 
   it "should map datalink names to datalink layer type values" do
-    DataLink.name_to_val(:en10mb).should == 1
+    described_class.name_to_val(:en10mb).should == 1
   end
 
   it "should map datalink layer type values to datalink names" do
-    DataLink.val_to_name(1).should == "EN10MB"
+    described_class.val_to_name(1).should == "EN10MB"
   end
 
   it "should be initialized from a pcap datalink value" do
-    @datalink.name.should == 'NULL'
+    subject.name.should == 'NULL'
   end
 
-  it "should support initialization from a pcap datalink name symbol" do
-    @datalink = DataLink.new(:null)
-    DataLink.should === @datalink
+  it "should have a description" do
+    subject.description.should_not be_empty
   end
 
-  it "should support initialization from a pcap datalink name string" do
-    dl = DataLink.new('en10mb')
-    DataLink.should === dl
-  end
+  describe "#initialize" do
+    it "should support initialization from a pcap datalink name Symbol" do
+      link = described_class.new(:null)
 
-  it "should allow equality comparison against numeric values" do
-    (@datalink == 0).should == true
-    (@datalink == 1).should == false
-  end
+      link.name.should == 'NULL'
+    end
 
-  it "should allow equality comparison against String names" do
-    (@datalink == "null").should == true
-    (@datalink == "en10mb").should == false
+    it "should support initialization from a pcap datalink name String" do
+      link = described_class.new('en10mb')
+      
+      link.name.should == 'EN10MB'
+    end
   end
 
-  it "should allow equality comparison against Symbol names" do
-    (@datalink == :null).should == true
-    (@datalink == :en10mb).should == false
-  end
+  describe "#==" do
+    it "should allow equality comparison against numeric values" do
+      (subject == 0).should == true
+      (subject == 1).should == false
+    end
 
-  it "should allow comparison against another DataLink" do
-    (@datalink == DataLink.new(0)).should == true
-    (@datalink == DataLink.new(1)).should == false
-  end
+    it "should allow equality comparison against String names" do
+      (subject == "null").should == true
+      (subject == "en10mb").should == false
+    end
 
-  it "should still compare correctly against any other object" do
-    (@datalink == Object.new).should == false
-  end
+    it "should allow equality comparison against Symbol names" do
+      (subject == :null).should == true
+      (subject == :en10mb).should == false
+    end
 
-  it "should have a description" do
-    @datalink.description.should_not be_empty
+    it "should allow comparison against another described_class" do
+      (subject == described_class.new(0)).should == true
+      (subject == described_class.new(1)).should == false
+    end
+
+    it "should still compare correctly against any other object" do
+      (subject == Object.new).should == false
+    end
   end
 
   it "should convert to an Integer for the DLT value" do
-    @datalink.to_i.should == 0
+    subject.to_i.should == 0
   end
 
   it "should convert to a String for the DLT name" do
-    @datalink.to_s.should == 'NULL'
+    subject.to_s.should == 'NULL'
   end
 end

data/spec/dead_spec.rb

@@ -26,9 +26,5 @@ describe Dead do
 
       @pcap.close
     end
-
-
   end
-
 end
-

data/spec/error_buffer_spec.rb

@@ -1,17 +1,15 @@
 require 'spec_helper'
 
 describe ErrorBuffer do
-  before(:all) do
-    @errbuf = ErrorBuffer.create
-  end
-
-  it "should have a size of 256" do
-    @errbuf.size.should == 256
+  it "should have a default size of 256" do
+    subject.size.should == 256
   end
 
   it "should return an error message with to_s" do
-    @errbuf.to_s.should be_empty
-    FFI::PCap.pcap_open_offline("/this/file/wont/exist/#{rand(0xFFFF)}", @errbuf )
-    @errbuf.to_s.should_not be_empty
+    subject.to_s.should be_empty
+
+    PCap.pcap_open_offline("/this/file/wont/exist",subject)
+
+    subject.to_s.should_not be_empty
   end
 end

data/spec/file_header_spec.rb

@@ -1,28 +1,31 @@
 require 'spec_helper'
 
 describe FileHeader do
-  before(:all) do
-    @file_header = FileHeader.new( :raw => File.read(PCAP_TESTFILE) )
+  let(:pcap_file) do
+    File.open(PCAP_TESTFILE,'rb') do |file|
+      file.read
+    end
   end
 
+  subject { described_class.new(:raw => pcap_file) }
+
   it "should parse a pcap file correctly" do
-    @file_header.magic.should == 0xa1b2c3d4
-    @file_header.version_major.should == 2
-    @file_header.version_minor.should == 4
-    @file_header.thiszone.should == 0
-    @file_header.sigfigs.should == 0
-    @file_header.snaplen.should == 96
-    @file_header.linktype.should == 1
+    subject.magic.should == 0xa1b2c3d4
+    subject.version_major.should == 2
+    subject.version_minor.should == 4
+    subject.thiszone.should == 0
+    subject.sigfigs.should == 0
+    subject.snaplen.should == 96
+    subject.linktype.should == 1
   end
 
   it "should return a file format version string" do
-    String.should === @file_header.version
-    @file_header.version.should == "2.4"
+    subject.version.should == "2.4"
   end
 
   it "should return a DataLink for the linktype using datalink()" do
-    DataLink.should === @file_header.datalink
-    (@file_header.datalink == :en10mb).should == true
-  end
+    subject.datalink.should be_kind_of(DataLink)
 
+    (subject.datalink == :en10mb).should == true
+  end
 end