net-proto 1.1.0 → 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83b848fce79a24c404a269ecfaf838c8999e000a
+  data.tar.gz: 33fada4059a1ac04b305e0d04b621d777cc4e5e9
+SHA512:
+  metadata.gz: fd37187da1d51e62cf87fb54dab95ab6a5dc718aa397f25b9fb7e2e7898926d00ef38445bfa71619606ddee887610bbb89fb103b7f39fcc989fddb3ef8e5b270
+  data.tar.gz: d36e65afe0656f492d34ada92d6833aa18da0c36ec3846b26bb1cef8172c64a82dadda712d6c282d86c811013e597bb7745e9cb5a1ecc500ec23f06dab869968

data/CHANGES

@@ -1,3 +1,7 @@
+== 1.1.1 - 9-Oct-2014
+* Implemented getprotoent on Windows using pure Ruby.
+* Miscellaneous minor updates to the Rakefile, gemspec and docs.
+
 == 1.1.0 - 18-Jan-2012
 * Switched to FFI instead of C backend. Now works with JRuby, too.
 * Added the generic get_protocol instance method that accepts either a

data/README

@@ -26,10 +26,6 @@ Net::Proto.getprotoent do |ent|
   p ent
 end
 
-== MS Windows
-The Proto.getprotoent method is not supported on MS Windows because the
-underlying function isn't supported by the MS Windows API.
-
 == Why should I use this?
 Ruby has 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

data/Rakefile

@@ -8,13 +8,18 @@ namespace 'gem' do
   desc 'Create the net-proto gem'
   task :create => :clean do
     spec = eval(IO.read('net-proto.gemspec'))
-    Gem::Builder.new(spec).build
+    if Gem::VERSION.to_f < 2.0
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
   end
 
   desc 'Install the net-proto gem'
   task :install => [:create] do
     file = Dir["net-proto*.gem"].last
-    sh "gem install #{file}"
+    sh "gem install -l #{file}"
   end
 end
 

data/doc/netproto.txt

@@ -39,8 +39,6 @@ Proto.getprotoent{ |struct| ... }
 	
    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
@@ -52,11 +50,12 @@ Proto.getprotoent{ |struct| ... }
    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 MS Windows platform.
-   It's not part of the API as of Windows XP.
+   The 'getprotoent()' method on Windows is using Ruby to read directly from
+   your %SystemRoot%\system32\drivers\etc\protocol file. If you do not have
+   read access to that file, the method will fail.
    
 == Known Bugs
-  None that I'm aware of.  Please log any bug reports on the project page
+  None that I'm aware of. Please log any bug reports on the project page
   at https://github.com/djberg96/net-proto.
 	
 == Future Plans
@@ -64,7 +63,7 @@ Proto.getprotoent{ |struct| ... }
   WSAAsyncGetProtoByNumber) on MS Windows systems.
 	
 == Copyright
-  (C) 2003-2012 Daniel J. Berger
+  (C) 2003-2014 Daniel J. Berger
   All rights reserved.
 	
 == Warranty

data/lib/net/proto.rb

@@ -1,10 +1,12 @@
 require 'rbconfig'
 
 case RbConfig::CONFIG['host_os']
-when /linux/i
-  require 'linux/net/proto'
-when /sunos|solaris/i
-  require 'sunos/net/proto'
-else
-  require 'generic/net/proto'
+  when /linux/i
+    require 'linux/net/proto'
+  when /sunos|solaris/i
+    require 'sunos/net/proto'
+  when /mingw|cygwin|win32|windows|mswin/i
+    require 'windows/net/proto'
+  else
+    require 'generic/net/proto'
 end

data/lib/net/proto/common.rb

@@ -5,7 +5,7 @@ module Net
     extend FFI::Library
 
     # The version of the net-proto library
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
 
     private_class_method :new
 

data/lib/windows/net/proto.rb

@@ -0,0 +1,123 @@
+require 'net/proto/common'
+
+# The Net module serves as a namespace only.
+module Net
+  # The Proto class serves as the base class for the various protocol methods.
+  class Proto
+    extend FFI::Library
+
+    ffi_lib FFI::Library::LIBC
+    ffi_lib 'ws2_32'
+    ffi_convention :stdcall
+
+    private
+
+    # These should exist on every platform.
+    attach_function :getprotobyname_c, :getprotobyname, [:string], :pointer
+    attach_function :getprotobynumber_c, :getprotobynumber, [:int], :pointer
+
+    private_class_method :getprotobyname_c
+    private_class_method :getprotobynumber_c
+
+    public
+
+    # If given a protocol string, returns the corresponding number. If
+    # given a protocol number, returns the corresponding string.
+    #
+    # Returns nil if not found in either case.
+    #
+    # Examples:
+    #
+    #   Net::Proto.get_protocol('tcp') # => 6
+    #   Net::Proto.get_protocol(1)     # => 'icmp'
+    #
+    def self.get_protocol(arg)
+      if arg.is_a?(String)
+        getprotobyname(arg)
+      else
+        getprotobynumber(arg)
+      end
+    end
+
+    # Given a protocol string, returns the corresponding number, or nil if
+    # not found.
+    #
+    # Examples:
+    #
+    #    Net::Proto.getprotobyname('tcp')   # => 6
+    #    Net::Proto.getprotobyname('bogus') # => nil
+    #
+    def self.getprotobyname(protocol)
+      raise TypeError unless protocol.is_a?(String)
+
+      begin
+        ptr = getprotobyname_c(protocol)
+        struct = ProtocolStruct.new(ptr) unless ptr.null?
+      ensure
+        endprotoent() if respond_to?(:endprotoent, true)
+      end
+
+      ptr.null? ? nil : struct[:p_proto]
+    end
+
+    # Given a protocol number, returns the corresponding string, or nil if
+    # not found.
+    #
+    # Examples:
+    #
+    #   Net::Proto.getprotobynumber(6)   # => 'tcp'
+    #   Net::Proto.getprotobynumber(999) # => nil
+    #
+    def self.getprotobynumber(protocol)
+      raise TypeError unless protocol.is_a?(Integer)
+
+      begin
+        ptr = getprotobynumber_c(protocol)
+        struct = ProtocolStruct.new(ptr) unless ptr.null?
+      ensure
+        endprotoent() if respond_to?(:endprotoent, true)
+      end
+
+      ptr.null? ? nil: struct[:p_name]
+    end
+
+    # In block form, yields each entry from /etc/protocol as a struct of type
+    # Proto::ProtoStruct. In non-block form, returns an array of structs.
+    #
+    # The fields are 'name' (a string), 'aliases' (an array of strings,
+    # though often only one element), and 'proto' (a number).
+    #
+    # Example:
+    #
+    #   Net::Proto.getprotoent.each{ |prot|
+    #      p prot.name
+    #      p prot.aliases
+    #      p prot.proto
+    #   }
+    #
+    # Note that on Windows this code reads directly out of a %SystemRoot%
+    # subfolder using pure Ruby, so you will need read access or this method
+    # will fail.
+    #
+    def self.getprotoent
+      structs = block_given? ? nil : []
+      file = ENV['SystemRoot'] + '/system32/drivers/etc/protocol'
+
+      IO.foreach(file) do |line|
+        next if line.lstrip[0] == '#' # Skip comments
+        next if line.lstrip.size == 0 # Skip blank lines
+        line = line.split
+
+        ruby_struct = ProtoStruct.new(line[0], line[2].split(','), line[1].to_i).freeze
+
+        if block_given?
+          yield ruby_struct
+        else
+          structs << ruby_struct
+        end
+      end
+
+      structs
+    end
+  end
+end

data/net-proto.gemspec

@@ -2,21 +2,20 @@ require 'rubygems'
 
 Gem::Specification.new do |gem|
   gem.name       = 'net-proto'
-  gem.version    = '1.1.0'
+  gem.version    = '1.1.1'
   gem.author     = 'Daniel J. Berger'
   gem.license    = 'Artistic 2.0'
   gem.email      = 'djberg96@gmail.com'
-  gem.homepage   = 'http://www.rubyforge.org/projects/sysutils'
-  gem.platform   = Gem::Platform::RUBY
+  gem.homepage   = 'https://github.com/djberg96/net-proto'
   gem.summary    = 'A Ruby interface for determining protocol information'
   gem.test_file  = 'test/test_net_proto.rb'
   gem.files      = Dir['**/*'].reject{ |f| f.include?('git') }
 
-  gem.rubyforge_project = 'sysutils'
   gem.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST', 'doc/netproto.txt']
 
   gem.add_dependency('ffi', '>= 1.0.0')
   gem.add_development_dependency('test-unit', '>= 2.2.0')
+  gem.add_development_dependency('rake')
 
   gem.description = <<-EOF
     The net-proto library provides an interface for get protocol information

data/test/test_net_proto.rb

@@ -4,10 +4,8 @@
 # Test suite for net-proto - all platforms. This test suite should be run
 # via the 'rake test' task.
 ###########################################################################
-require 'rubygems'
-gem 'test-unit'
 require 'net/proto'
-require 'test/unit'
+require 'test-unit'
 
 class TC_Net_Proto < Test::Unit::TestCase
 
@@ -19,8 +17,6 @@ class TC_Net_Proto < Test::Unit::TestCase
       mobile ospf pim ipcomp vrrp sctp hopopt ipv6
       ipv6-route ipv6-frag esp ah ipv6-icmp ipv6-nonxt ipv6-opts
     /
-
-    @@windows = File::ALT_SEPARATOR
   end
 
   def setup
@@ -28,7 +24,7 @@ class TC_Net_Proto < Test::Unit::TestCase
   end
 
   test "version number is set to expected value" do
-    assert_equal('1.1.0', Net::Proto::VERSION)
+    assert_equal('1.1.1', Net::Proto::VERSION)
   end
 
   test "get_protocol method basic functionality" do
@@ -91,35 +87,30 @@ class TC_Net_Proto < Test::Unit::TestCase
   end
 
   test "getprotoent basic functionality" do
-    omit_if(@@windows, 'getprotoent tests skipped on MS Windows')
     assert_respond_to(Net::Proto, :getprotoent)
     assert_nothing_raised{ Net::Proto.getprotoent }
     assert_kind_of(Array, Net::Proto.getprotoent)
   end
 
   test "getprotoent method returns the expected results" do
-    omit_if(@@windows, 'getprotoent tests skipped on MS Windows')
     assert_kind_of(Struct::ProtoStruct, Net::Proto.getprotoent.first)
     assert_nil(Net::Proto.getprotoent{})
   end
 
   test "struct returned by getprotoent method contains the expected data" do
-    omit_if(@@windows, 'getprotoent tests skipped on MS Windows')
     @protoent = Net::Proto.getprotoent.first
-    assert_equal(['name', 'aliases', 'proto'], @protoent.members)
+    assert_equal([:name, :aliases, :proto], @protoent.members)
     assert_kind_of(String, @protoent.name)
     assert_kind_of(Array, @protoent.aliases)
     assert_kind_of(Integer, @protoent.proto)
   end
 
   test "all members of the aliases struct member are strings" do
-    omit_if(@@windows, 'getprotoent tests on MS Windows')
     @protoent = Net::Proto.getprotoent.first
     assert_true(@protoent.aliases.all?{ |e| e.is_a?(String) })
   end
 
   test "struct returned by getprotoent method is frozen" do
-    omit_if(@@windows, 'getprotoent tests skipped on MS Windows')
     @protoent = Net::Proto.getprotoent.first
     assert_true(@protoent.frozen?)
   end

metadata

@@ -1,111 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: net-proto
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.1.1
 platform: ruby
-authors: 
+authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ffi
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
   name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 2
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: "    The net-proto library provides an interface for get protocol information\n    by name or by number. It can also iterate over the list of protocol\n    entries defined on your system.\n"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      The net-proto library provides an interface for get protocol information
+      by name or by number. It can also iterate over the list of protocol
+      entries defined on your system.
 email: djberg96@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGES
 - README
 - MANIFEST
 - doc/netproto.txt
-files: 
+files:
 - CHANGES
+- MANIFEST
+- README
+- Rakefile
 - doc/netproto.txt
 - examples/example_net_proto.rb
 - lib/generic/net/proto.rb
 - lib/linux/net/proto.rb
-- lib/net/proto/common.rb
 - lib/net/proto.rb
+- lib/net/proto/common.rb
 - lib/sunos/net/proto.rb
-- MANIFEST
+- lib/windows/net/proto.rb
 - net-proto.gemspec
-- Rakefile
-- README
 - test/test_net_proto.rb
-homepage: http://www.rubyforge.org/projects/sysutils
-licenses: 
+homepage: https://github.com/djberg96/net-proto
+licenses:
 - Artistic 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: sysutils
-rubygems_version: 1.8.10
+rubyforge_project: 
+rubygems_version: 2.4.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby interface for determining protocol information
-test_files: 
+test_files:
 - test/test_net_proto.rb