net-proto 1.0.1

data/CHANGES

@@ -0,0 +1,74 @@
+== 1.0.1 - 30-Jun-2006
+* Added rdoc to the source files.
+* Added a gemspec.
+
+== 1.0.0 - 14-Jul-2005
+* Moved project to RubyForge.
+* Minor directory layout change.
+* Minor changes to the extconf.rb file.
+* Officially bumped VERSION to 1.0.0.
+
+== 0.2.5 - 18-Apr-2005
+* The Unix versions now call setprotoent(0) and endprotoent() internally
+  before each call.
+
+== 0.2.4 - 12-Apr-2005
+* Added internal taint checking for the Proto.getprotobyname method.
+* Removed the INSTALL file.  Installation instructions are now in the README.
+* Moved the sample script into the 'examples' directory.
+* General code cleanup.
+* Minor test suite changes and additions.
+* Removed the netproto.rd and netproto.html files.  The netproto.txt file is
+  now rdoc friendly.
+
+== 0.2.3 - 13-Sep-2004
+* Replaced all instances of the deprecated STR2CSTR() function with the
+  StringValuePtr() function.  That means that, as of this release, this
+  package requires Ruby 1.8.0 or later.
+* Minor documentation corrections.
+
+== 0.2.2 - 10-Apr-2004
+* No longer returns an Array in block form.  Only the non-block form returns
+  an array.  The block form returns nil.
+* Updated the documentation, warranty information included, license changed
+  back to "Ruby's".
+* Modified extconf.rb.  It is now assumed that you have TestUnit installed.
+* Changed "tc_all.rb" to "tc_netproto.rb".
+* Changed "netproto.rd2" to "netproto.rd".
+
+== 0.2.1 - 29-Jul-2003
+* Code cleanup (-Wall warnings on Linux)
+* Removed VERSION() class method.  Use the constant instead
+* The getprotoent() method now returns an array of structs in non-block form
+* Added README file
+* Added generic test script under test/
+* Modified extconf.rb to use generic test script for those who don't have
+  TestUnit installed, instead of dynamically generating one
+* Fixed up TestUnit test suite
+
+== 0.2.0 - 26-Feb-2003
+* Added MS Windows support (except 'getprotoent()' - see docs)
+* For protocols that aren't defined, nil is now returned instead
+  of crashing (always a good thing)
+* Removed sys-uname requirement
+* Added a test suite (for those with testunit installed)
+* Some internal layout changes (doc, lib, test dirs)
+* Added a VERSION constant and class method
+* RD2 documentation now separated from source
+* Installation instructions modified
+* Lots of changes to extconf.rb
+* Changelog now CHANGES
+* Manifest now MANIFEST
+* Package name changed to lower case
+
+== 0.1.0 - 13-Aug-2002
+* Fixed bug with getprotoent_r function for Linux
+* Added a 'generic' source file that uses the non-reentrant functions for
+  those platforms that are not specifically supported.
+* Added FreeBSD support
+* Modified test script slightly
+* Added a changelog :)
+* Added a manifest
+   
+== 0.0.1 - 12-Aug-2002
+* Initial release (though written earlier)

data/MANIFEST

@@ -0,0 +1,17 @@
+CHANGES
+MANIFEST
+README
+extconf.rb
+net-proto.gemspec
+
+doc/netproto.txt
+
+examples/test_proto.rb
+
+lib/version.h
+lib/net/generic.c
+lib/net/linux.c
+lib/net/sunos.c 
+lib/net/windows.c
+
+test/tc_netproto.rb

data/README

@@ -0,0 +1,25 @@
+== Description
+The net-proto package provides the getprotobyname(), getprotobynumber() and
+the getprotoent() methods for Ruby.
+
+== Prerequisites
+Ruby 1.8.0 or later.
+
+== Installation
+ruby extconf.rb
+make
+ruby test\tc_netproto.rb (optional)
+make site-install
+
+== Notes
+The net-proto package uses reentrant code for sunos and linux.  Otherwise, the
+generic form of the functions are used (which may be reentrant by default
+anway - check the man pages on your platform).
+
+The Proto.getprotoent method is not supported on Win32 platforms.
+
+== Why should I use this?
+Ruby does define a predefined set of constants in socket.c in the general form
+of IPPROTO_XXX, Y.  However, using constants in this fashion can be unreliable
+because it's easy to define your own protocols (I set 'echo' to 7, for
+example), or to modify/delete entries in /etc/protocols.

data/doc/netproto.txt

@@ -0,0 +1,82 @@
+== Description
+   Net::Proto - An interface for the 'getproto' family of functions.
+	
+== Synopsis
+   require "net/proto"
+   include Net
+
+   Proto.getprotobyname("tcp") # -> 6
+   Proto.getprotobynumber(1)   # -> "icmp"
+
+   # Block form
+   Proto.getprotoent{ |p|
+      puts p.name
+      puts p.aliases
+      puts p.proto
+   }
+   	
+   # Non-block form
+   a = Proto.getprotoent
+   	
+== Constants
+VERSION
+	The current version number of this package, returned as a String.
+	
+== Class Methods
+Proto.getprotobyname(name)
+   Given a protocol string, returns the corresponding number, or nil if not
+   found.
+    
+Proto.getprotobynumber(num)
+   Given a protocol number, returns the corresponding string, or nil if not
+   found.
+    
+Proto.getprotoent
+Proto.getprotoent{ |struct| ... }
+   In block form, yields each entry from /etc/protocols as a struct of type
+   Proto::ProtoStruct.  In non-block form, returns an array of
+   Proto::ProtoStruct objects.
+	
+	The fields are 'name' (a String), 'aliases' (an Array of String's,
+	though often only one element), and 'proto' (a Fixnum).
+
+   This method is NOT supported on MS Windows.
+    
+== Notes
+   This module uses the reentrant (i.e. thread safe) functions on those
+   platforms that support them.  In some cases, e.g. FreeBSD and HP-UX, the
+   standard function names are reentrant by default (i.e. there is no '_r'
+   version, or it's not needed), so you will not see specific .c files for
+   all platforms.
+
+   The 'setprotoent()' and 'endprotoent()' functions are not implemented as
+   separate method calls.  Rather, these are called internally by the various
+   methods, except on Windows, which does not support them.
+
+   The 'getprotoent()' method is not supported on the Win32 platform.  It's
+   not part of the API as of Windows XP.
+   
+== Known Bugs
+   None that I'm aware of.  Please log any bug reports on the project page
+   at http://ruby-netutils.sf.net.
+	
+== Future Plans
+   Use the asynchronous calls (WSAAsyncGetProtoByName and
+   WSAAsyncGetProtoByNumber) on Win32 systems.
+	
+== Copyright
+	(C) 2003-2005 Daniel J. Berger
+	All rights reserved.
+	
+== Warranty
+	This package is provided "as is" and without any express or
+	implied warranties, including, without limitation, the implied
+	warranties of merchantability and fitness for a particular purpose.
+	
+== License
+	Ruby's
+	
+== Author
+	Daniel J. Berger
+	djberg96 at yahoo dot com
+	rubyhacker1/imperator on IRC (Freenode)

data/extconf.rb

@@ -0,0 +1,30 @@
+################################
+# extconf.rb file for net-proto
+################################
+require "mkmf"
+require "ftools"
+
+##################################################
+# Use the appropriate .c file, based on platform
+##################################################
+c_file = nil
+
+case RUBY_PLATFORM
+   when /win32|windows|mingw|cygwin/i
+      c_file = "lib/net/windows.c"
+   when /sunos|solaris/i
+      c_file = "lib/net/sunos.c"
+      have_library("socket")
+   when /linux/i
+      c_file = "lib/net/linux.c"
+   else
+      c_file = "lib/net/generic.c"
+end
+
+File.delete("proto.c") if File.exists?("proto.c")
+File.delete("version.h") if File.exists?("version.h")
+
+File.copy(c_file, "proto.c")
+File.copy("lib/version.h",".")
+
+create_makefile("net/proto")

data/lib/net/sunos.c

@@ -0,0 +1,136 @@
+/*******************************************************
+ * proto.c (sunos.c)
+ *******************************************************/
+#include "ruby.h"
+#include "version.h"
+#include <netdb.h>
+#include <string.h>
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+#define BUF_SIZE 8192
+
+VALUE sProto;
+
+/*
+ * call-seq:
+ *    Proto.getprotobyname(name)
+ *
+ * Given a protocol string, returns the corresponding number, or nil if not
+ * found.
+*/
+static VALUE np_getprotobyname(VALUE klass, VALUE rbProtoName){
+   struct protoent p;
+   char buffer[BUF_SIZE];
+   VALUE rbProtoNum = Qnil;
+   
+   SafeStringValue(rbProtoName);
+
+   setprotoent(0);
+   
+   if(getprotobyname_r(StringValuePtr(rbProtoName),&p,buffer,BUF_SIZE) != NULL)
+		rbProtoNum = INT2FIX(p.p_proto);
+
+   endprotoent();
+
+	return rbProtoNum;
+}
+
+/*
+ * call-seq:
+ *    Proto.getprotobynumber(num)
+ *
+ * Given a protocol number, returns the corresponding string, or nil if not
+ * found.
+ */
+static VALUE np_getprotobynumber(VALUE klass, VALUE rbProtoNum){
+   struct protoent p;
+   char buffer[BUF_SIZE];
+   VALUE rbProtoName = Qnil;
+
+   setprotoent(0);
+   
+   if(getprotobynumber_r(NUM2INT(rbProtoNum),&p,buffer,BUF_SIZE) != NULL)
+      rbProtoName = rb_str_new2(p.p_name);
+
+   endprotoent();
+
+	return rbProtoName;
+}
+
+/*
+ * call-seq:
+ *    Proto.getprotoent
+ *    Proto.getprotoent{ |struct| ... }
+ *
+ * In block form, yields each entry from /etc/protocols as a struct of type
+ * Proto::ProtoStruct.  In non-block form, returns an array of
+ * Proto::ProtoStruct objects.
+	
+ * The fields are 'name' (a String), 'aliases' (an Array of String's,
+ * though often only one element), and 'proto' (a Fixnum).
+*/
+static VALUE np_getprotoent(){
+   struct protoent p;
+   char buffer[BUF_SIZE];
+   VALUE rbAliasArray = Qnil;
+   VALUE rbArray = Qnil;
+   VALUE rbStruct = Qnil;
+   
+   if(!rb_block_given_p())
+   	rbArray = rb_ary_new();
+
+   setprotoent(0);
+
+   while(getprotoent_r(&p, buffer, BUF_SIZE)){
+      rbAliasArray = rb_ary_new();
+      
+      while(*p.p_aliases){
+         rb_ary_push(rbAliasArray ,rb_str_new2(*p.p_aliases));
+         (void)p.p_aliases++;
+      }
+      
+      rbStruct = rb_struct_new(sProto,
+      	rb_str_new2(p.p_name),
+      	rbAliasArray,
+      	INT2FIX(p.p_proto)
+      );
+
+      if(rb_block_given_p()){
+         rb_yield(rbStruct);
+      }
+      else{
+         rb_ary_push(rbArray, rbStruct);
+      }
+   }
+
+   endprotoent();
+
+	return rbArray; /* nil unless a block is given */
+}
+
+void Init_proto()
+{
+   /* Module and class definitions */
+   VALUE mNet, cProto;
+   mNet = rb_define_module("Net");
+   cProto = rb_define_class_under(mNet,"Proto",rb_cObject);
+
+   /* Structure definitions */
+   sProto = rb_struct_define("ProtoStruct","name","aliases","proto",0);
+
+   /* Class methods */
+   rb_define_singleton_method(cProto,"getprotobyname",np_getprotobyname,1);
+   rb_define_singleton_method(cProto,"getprotobynumber",np_getprotobynumber,1);
+   rb_define_singleton_method(cProto,"getprotoent",np_getprotoent,0);
+
+   /* Constants */
+   rb_define_const(cProto,"VERSION",rb_str_new2(NET_PROTO_VERSION));
+}
+
+#ifdef __cplusplus
+}
+#endif

data/lib/version.h

@@ -0,0 +1,2 @@
+/* version.h - there can be only one */
+#define NET_PROTO_VERSION "1.0.1"

data/test/tc_netproto.rb

@@ -0,0 +1,94 @@
+############################################
+# tc_netproto.rb
+#
+# Test suite for net-proto - all platforms.
+############################################
+base = File.basename(Dir.pwd)
+
+if base == "test" || base =~ /net-proto.*/
+   require "ftools"
+   Dir.chdir("..") if base == "test"
+   Dir.mkdir("net") unless File.exists?("net")
+   	  	
+   extension = ".so"
+   extension = ".sl" if RUBY_PLATFORM =~ /hpux/i
+   extension = ".bundle" if RUBY_PLATFORM =~ /darwin|powerpc/i
+	
+   proto_file = "proto" + extension
+
+   if File.exist?(proto_file)
+      File.copy(proto_file,"net")
+   else
+      puts "No proto#{extenstion} file found."
+      puts "Please run extconf.rb and make first."
+      exit!
+   end
+	$LOAD_PATH.unshift(Dir.pwd)
+   Dir.chdir("test") rescue nil
+end
+
+require "net/proto"
+require "test/unit"
+include Net
+
+class TC_Net_Proto < Test::Unit::TestCase
+   # These were the protocols listed in my
+   # own /etc/protocols file on Solaris 9.
+   def setup
+      @protocols = %w/
+         ip icmp igmp ggp ipip tcp cbt egp igp pup udp mux hmp
+         xns-idp rdp idpr idpr-cmtp sdrp idrp rsvp gre
+         mobile ospf pim ipcomp vrrp sctp hopopt ipv6
+         ipv6-route ipv6-frag esp ah ipv6-icmp ipv6-nonxt ipv6-opts
+      /
+   end
+	
+   def test_version
+      assert_equal("1.0.1", Proto::VERSION)
+   end
+
+   def test_getprotobynumber
+      assert_respond_to(Proto, :getprotobynumber)
+      assert_raises(TypeError){ Proto.getprotobynumber("foo") }
+      assert_raises(TypeError){ Proto.getprotobynumber(nil) }
+      assert_equal(nil, Proto.getprotobynumber(9999999))
+      assert_equal("tcp", Proto.getprotobynumber(6))
+      assert_nothing_raised{
+         0.upto(132){ |n| Proto.getprotobynumber(n) }
+      }
+   end
+
+   def test_getprotobyname
+      assert_respond_to(Proto, :getprotobyname)
+      assert_raises(TypeError){ Proto.getprotobyname(1) }
+      assert_raises(TypeError){ Proto.getprotobyname(nil) }       	
+      assert_equal(nil, Proto.getprotobyname("foo"))
+      assert_equal(6, Proto.getprotobyname("tcp"))
+      @protocols.each{ |prot|
+         assert_nothing_raised{ Proto.getprotobyname(prot) }
+      }
+   end
+
+   def test_getprotoent
+      if File::ALT_SEPARATOR
+         msg = "The getprotoent() function is not supported on this "
+         msg += "platform - test skipped"
+         STDERR.puts msg
+      else
+    	 assert_respond_to(Proto, :getprotoent)    
+         p = Proto.getprotoent.first
+         assert_kind_of(Struct::ProtoStruct, p)
+         assert_equal(%w/name aliases proto/,p.members)
+         assert_kind_of(String, p.name, "Bad type for name")
+         assert_kind_of(Array, p.aliases, "Bad type for aliases")
+         assert_kind_of(Integer, p.proto, "Bad type for proto")
+         p.aliases.each{ |a|
+            assert_kind_of(String, a, "Bad type for aliases member")
+         }
+      end
+   end
+	
+   def teardown
+      @protocols = nil
+   end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: net-proto
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+date: 2006-06-30 00:00:00 -06:00
+summary: The net-proto package provides the getprotobyname(), getprotobynumber() and the getprotoent() methods for Ruby.
+require_paths: 
+- lib
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/projects/sysutils
+rubyforge_project: sysutils
+description: The net-proto package provides the getprotobyname(), getprotobynumber() and the getprotoent() methods for Ruby.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Daniel J. Berger
+files: 
+- doc/netproto.txt
+- test/tc_netproto.rb
+- CHANGES
+- MANIFEST
+- README
+- extconf.rb
+- lib/version.h
+- lib/net/sunos.c
+test_files: 
+- test/tc_netproto.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+executables: []
+
+extensions: 
+- extconf.rb
+requirements: []
+
+dependencies: []
+