ruby-nmap 0.4.0 → 0.4.1

data/ChangeLog.md

@@ -1,3 +1,12 @@
+### 0.4.1 / 2010-11-23
+
+* Fixed a bug in {Nmap::XML#each} where it was calling `each_up_hosts`,
+  and not {Nmap::XML#each_up_host}.
+* {Nmap::OS#each_class}, {Nmap::OS#each_match}, {Nmap::XML#each_host} and
+  {Nmap::XML#each_up_host} now return an Enumerator object if no block
+  is given.
+* Use `yield` instead of `block.call` for a slight performance improvement.
+
 ### 0.4.0 / 2010-11-17
 
 * Added new options to {Nmap::Task} based on nmap 5.21:

data/Rakefile

@@ -12,7 +12,7 @@ rescue LoadError => e
 end
 
 begin
-  gem 'rspec', '~> 2.0.0'
+  gem 'rspec', '~> 2.1.0'
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new

data/gemspec.yml

@@ -18,5 +18,5 @@ dependencies:
 
 development_dependencies:
   ore-tasks: ~> 0.3.0
-  rspec: ~> 2.0.0
+  rspec: ~> 2.1.0
   yard: ~> 0.6.0

data/lib/nmap/host.rb

@@ -4,7 +4,6 @@ require 'nmap/os'
 require 'nmap/port'
 
 require 'nokogiri'
-require 'enumerator'
 
 module Nmap
   class Host
@@ -24,10 +23,10 @@ module Nmap
     # @yieldparam [Host] host
     #   The newly created Host object.
     #
-    def initialize(node,&block)
+    def initialize(node)
       @node = node
 
-      block.call(self) if block
+      yield self if block_given?
     end
 
     #
@@ -39,7 +38,7 @@ module Nmap
     # @since 0.1.2
     #
     def start_time
-      Time.at(@node['starttime'].to_i)
+      @start_time ||= Time.at(@node['starttime'].to_i)
     end
 
     #
@@ -51,7 +50,7 @@ module Nmap
     # @since 0.1.2
     #
     def end_time
-      Time.at(@node['endtime'].to_i)
+      @end_time ||= Time.at(@node['endtime'].to_i)
     end
 
     #
@@ -61,12 +60,16 @@ module Nmap
     #   The status of the host.
     #
     def status
-      status = @node.at('status')
+      unless @status
+        status = @node.at('status')
 
-      return Status.new(
-        status['state'].to_sym,
-        status['reason']
-      )
+        @status = Status.new(
+          status['state'].to_sym,
+          status['reason']
+        )
+      end
+
+      return @status
     end
 
     #
@@ -221,9 +224,9 @@ module Nmap
     #   The OS guessing information.
     #
     def os(&block)
-      os = @node.at('os')
-
-      return OS.new(os,&block) if os
+      if (os = @node.at('os'))
+        @os = OS.new(os,&block)
+      end
     end
 
     #

data/lib/nmap/os.rb

@@ -1,8 +1,6 @@
 require 'nmap/os_class'
 require 'nmap/os_match'
 
-require 'enumerator'
-
 module Nmap
   class OS
 
@@ -20,10 +18,10 @@ module Nmap
     # @yieldparam [OS] os
     #   The newly created OS object.
     #
-    def initialize(node,&block)
+    def initialize(node)
       @node = node
 
-      block.call(self) if block
+      yield self if block_given?
     end
 
     #
@@ -35,10 +33,13 @@ module Nmap
     # @yieldparam [OSClass] class
     #   The OS class information.
     #
-    # @return [OS]
-    #   The OS information.
+    # @return [OS, Enumerator]
+    #   The OS information. If no block was given, an enumerator object
+    #   will be returned.
     #
-    def each_class(&block)
+    def each_class
+      return enum_for(:each_class) unless block_given?
+
       @node.xpath("osclass").map do |osclass|
         os_class = OSClass.new(
           osclass['type'].to_sym,
@@ -47,7 +48,7 @@ module Nmap
           osclass['accuracy'].to_i
         )
 
-        block.call(os_class) if block
+        yield os_class
       end
 
       return self
@@ -60,7 +61,7 @@ module Nmap
     #   The OS class information.
     #
     def classes
-      Enumerator.new(self,:each_class).to_a
+      enum_for(:each_class).to_a
     end
 
     #
@@ -72,17 +73,20 @@ module Nmap
     # @yieldparam [OSMatch] class
     #   The OS match information.
     #
-    # @return [OS]
-    #   The OS information.
+    # @return [OS, Enumerator]
+    #   The OS information. If no block was given, an enumerator object
+    #   will be returned.
     #
-    def each_match(&block)
+    def each_match
+      return enum_for(:each_match) unless block_given?
+
       @node.xpath("osmatch").map do |osclass|
         os_match = OSMatch.new(
           osclass['name'],
           osclass['accuracy'].to_i
         )
 
-        block.call(os_match) if block
+        yield os_match
       end
 
       return self
@@ -95,7 +99,7 @@ module Nmap
     #   The OS match information.
     #
     def matches
-      Enumerator.new(self,:each_match).to_a
+      enum_for(:each_match).to_a
     end
 
     #
@@ -105,7 +109,9 @@ module Nmap
     #   The ports used.
     #
     def ports_used
-      @node.xpath("portused/@portid").map { |port| port.inner_text.to_i }
+      @ports_used ||= @node.xpath("portused/@portid").map do |port|
+        port.inner_text.to_i
+      end
     end
 
     #
@@ -115,7 +121,7 @@ module Nmap
     #   The OS fingerprint.
     #
     def fingerprint
-      @node.at("osfingerprint/@fingerprint").inner_text
+      @fingerprint ||= @node.at("osfingerprint/@fingerprint").inner_text
     end
 
     #

data/lib/nmap/version.rb

@@ -1,4 +1,4 @@
 module Nmap
   # ruby-nmap version
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/lib/nmap/xml.rb

@@ -4,7 +4,6 @@ require 'nmap/scan'
 require 'nmap/host'
 
 require 'nokogiri'
-require 'enumerator'
 
 module Nmap
   class XML
@@ -26,11 +25,11 @@ module Nmap
     # @yieldparam [XML] xml
     #   The newly created XML object.
     #
-    def initialize(path,&block)
+    def initialize(path)
       @path = File.expand_path(path)
       @doc = Nokogiri::XML(File.new(@path))
 
-      block.call(self) if block
+      yield self if block_given?
     end
 
     #
@@ -130,12 +129,15 @@ module Nmap
     # @yieldparam [Host] host
     #   A host in the scan.
     #
-    # @return [XML]
-    #   The XML object.
+    # @return [XML, Enumerator]
+    #   The XML object. If no block was given, an enumerator object will
+    #   be returned.
     #
     def each_host(&block)
+      return enum_for(:each_host) unless block
+
       @doc.xpath('/nmaprun/host').each do |host|
-        block.call(Host.new(host)) if block
+        Host.new(host,&block)
       end
 
       return self
@@ -148,7 +150,7 @@ module Nmap
     #   The hosts in the scan.
     #
     def hosts
-      Enumerator.new(self,:each_host).to_a
+      enum_for(:each_host).to_a
     end
 
     #
@@ -160,10 +162,13 @@ module Nmap
     # @yieldparam [Host] host
     #   A host in the scan.
     #
-    # @return [XML]
-    #   The XML parser.
+    # @return [XML, Enumerator]
+    #   The XML parser. If no block was given, an enumerator object will
+    #   be returned.
     #
     def each_up_host(&block)
+      return enum_for(:each_up_host) unless block
+
       @doc.xpath("/nmaprun/host[status[@state='up']]").each do |host|
         Host.new(host,&block)
       end
@@ -178,16 +183,16 @@ module Nmap
     #   The hosts in the scan.
     #
     def up_hosts
-      Enumerator.new(self,:each_up_host).to_a
+      enum_for(:each_up_host).to_a
     end
 
     #
     # Parses the hosts that were found to be up during the scan.
     #
-    # @see each_up_hosts
+    # @see each_up_host
     #
     def each(&block)
-      each_up_hosts(&block)
+      each_up_host(&block)
     end
 
     #

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+gem 'rspec', '~> 2.1.0'
 require 'rspec'
 require 'nmap/version'
 

data/spec/xml_spec.rb

@@ -66,6 +66,10 @@ describe XML do
     @xml.hosts.length.should == 10
   end
 
+  it "should iterate over each up host" do
+    @xml.each.all? { |host| host.status.state == :up }.should == true
+  end
+
   it "should convert to a String" do
     @xml.to_s.should == Helpers::SCAN_FILE
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-17 00:00:00 -08:00
+date: 2010-11-23 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,9 +72,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
+        - 1
         - 0
-        - 0
-        version: 2.0.0
+        version: 2.1.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency