datalink-socket 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,52 +2,51 @@
 
 To receive and send ethernet frames using ruby.
 
-* Datalink::Socket class
-* Ethernet::Socket class < Datalink::Socket
-* Ethernet::Frame class
-* Arp class
+* A Socket class
+* A Frame class
+* A Arp class
 
 == Arp
 
-> Arp.methods false
+ > Arp.methods false
  => [:new_request, :new_reply]
 
-> Arp.new_request :hw_src=> '00:50:56:c0:00:01', 
+ > Arp.new_request :hw_src=> '00:50:56:c0:00:01', 
                   :proto_src=> '192.168.1.10', 
                   :proto_tgt=> '192.168.1.13'
  => ARP, Request who-has 192.168.1.13 tell 192.168.1.10 
 
 == Frame
 
+ > s = Ethernet::Socket.new 'en1'
  > data, _ = s.recv
- => 
  > frame = Ethernet::Frame.new data
- => #<Ethernet::Frame:0x00000100c94b08 ... >
  > frame.src
- => 00:24:b2:51:a8:8e 
+  => 00:24:b2:51:a8:8e 
  > frame.dst
- => 00:1f:5b:ce:bd:6a 
+  => 00:1f:5b:ce:bd:6a 
  > frame.ether_type
- => 2048 
- > frame.payload.unpack('H*')
- => ["45200034d5ae400035061ad .... 08195fba"]
-
+  => 2048 
+ > frame.payload.unpack('H*')[0]
+  =>  "45200034d5ae400035061ad .... 08195fba"
 
 == Receiving
 
-require 'ethernet'
-s = Ethernet::Socket.new "en1"
-s.open
-s.recv
-
+ require 'ethernet'
+ s = Ethernet::Socket.new "en1"
+ s.open
+ s.recv
 
 == Sending
 
-request = Arp.new_request :hw_src=> '00:50:56:c0:00:01', 
-                  :proto_src=> '192.168.1.10', 
-                  :proto_tgt=> '192.168.1.13'
 
-s.send request
+ request = Arp.new_request :hw_src=> '00:50:56:c0:00:01', 
+                           :proto_src=> '192.168.1.10', 
+                           :proto_tgt=> '192.168.1.13'
+
+ # send method checks if the arg passed 'respond_to? :encode'
+ # and sends its encoded representation when it does.
+ s.send request
 
 = Installation
 

data/lib/arp.rb

@@ -1,3 +1,6 @@
+#
+# Copyright (c) 2011 Jean-Michel Esnault. Released under the same license as Ruby
+# 
 require 'ethernet'
 require 'ipaddr'
 
@@ -34,12 +37,8 @@ class Arp
   end
 
   def parse(s)
-    # p s.unpack('H*')
-    # p s.size
     s.slice!(0,14) if s.size>32
     htype, ptype, hlen, plen, opcode = s.unpack('nnccn')
-    # p htype
-    # p ptype
     hw_src, proto_src, hw_tgt, proto_tgt = s[8..-1].unpack("a#{hlen}a#{plen}"*2)
     raise RuntimeError, "Unsupported Hardware Type" unless htype == 1 && ptype == 0x0800
     @hw_src = HwSrc.new(hw_src)

data/lib/dl_socket_darwin.rb

@@ -1,3 +1,7 @@
+#
+# Copyright (c) 2011 Jean-Michel Esnault. Released under the same license as Ruby
+# 
+
 module Datalink
 
   BIOCGBLEN      =   0x40044266

data/lib/dl_socket_linux.rb

@@ -1,5 +1,8 @@
-require 'socket'
+#
+# Copyright (c) 2011 Jean-Michel Esnault. Released under the same license as Ruby
+# 
 
+require 'socket'
 module Datalink
   class Socket < ::Socket
 

data/lib/ethernet.rb

@@ -1,14 +1,28 @@
+#
+# Copyright (c) 2011 Jean-Michel Esnault. Released under the same license as Ruby
+# 
+
 require 'ruby-ext'
 require 'dl_socket'
 require 'rubygems'
+#--
 # require 'oui'
+#++
 
 module Ethernet
   class Socket < Datalink::Socket
-    def recv(*args)
-      eth_frame = super
-      eth_type = eth_frame.slice(12,2).unpack('n')[0]
-      [eth_frame, eth_type]
+    case `uname`.chomp.downcase
+    when 'darwin'
+      def recv(*args)
+        eth_frame = super
+        eth_type = eth_frame.slice(12,2).unpack('n')[0]
+        [eth_frame, eth_type]
+      end
+    when 'linux'
+      def recv(*args)
+        eth_frame, eth_type, _ = super
+        [eth_frame, eth_type]
+      end
     end
   end
   
@@ -66,6 +80,7 @@ module Ethernet
       end
     end
 
+    #--
     # def to_s_oui
     #   comp_id = Ethernet::OUI.company_id_from_arr(@mac[0..2])
     #   if comp_id == 'Unknown'
@@ -77,6 +92,7 @@ module Ethernet
     #     s.join('_')
     #   end
     # end
+    #++
 
     def encode
       @mac.pack('C*')

data/lib/ruby-ext.rb

@@ -1,3 +1,6 @@
+#
+# Copyright (c) 2011 Jean-Michel Esnault. Released under the same license as Ruby
+# 
 
 class Object
   def to_shex(*args)

data/test/ethernet_test.rb

@@ -1,5 +1,4 @@
 require "test/unit"
-
 require "ethernet"
 
 class TestEthernetIeAddress < Test::Unit::TestCase
@@ -23,6 +22,7 @@ class TestEthernetIeAddress < Test::Unit::TestCase
     assert_equal Ethernet::Address, Ethernet::Address.new(['010203040506'].pack('H*')).class
     assert_equal '010203040506', Ethernet::Address.new(['010203040506'].pack('H*')).to_shex
   end
+  #--
   # def test_to_s_oui
   #   assert_equal 'Apple_d8:93:a4',   Ethernet::Address.new('00:1f:f3:d8:93:a4').to_s_oui
   #   assert_equal 'Dell_01:3e:3d',    Ethernet::Address.new('00:21:9b:01:3e:3d').to_s_oui
@@ -30,6 +30,7 @@ class TestEthernetIeAddress < Test::Unit::TestCase
   #   assert_equal 'Intel_40:b8:8f',   Ethernet::Address.new('0:2:b3:40:b8:8f').to_s_oui
   #   assert_equal 'Cisco_fd:4f:6c',   Ethernet::Address.new('00b0.64fd.4f6c').to_s_oui
   # end
+  #++
 end
 
 class TestEthernetType < Test::Unit::TestCase

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jean-Michel Esnault
@@ -24,8 +24,8 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
 - README.rdoc
 - lib/arp.rb
@@ -34,8 +34,6 @@ files:
 - lib/dl_socket_linux.rb
 - lib/ethernet.rb
 - lib/ruby-ext.rb
-- test/arp_test.rb
-- test/ethernet_test.rb
 has_rdoc: true
 homepage: http://github.com/jesnault/dl
 licenses: []
@@ -49,7 +47,6 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -59,7 +56,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 6
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -69,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Datalink Socket