Added InputFile (closes #41).

Author: postmodern

lib/ronin/recon/input_file.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+#
+# ronin-recon - A micro-framework and tool for performing reconnaissance.
+#
+# Copyright (c) 2023 Hal Brodigan ([email protected])
+#
+# ronin-recon is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-recon is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-recon.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/recon/value/parser'
+
+module Ronin
+  module Recon
+    #
+    # Represents an input file of values to recon.
+    #
+    class InputFile
+
+      # The path to the input file.
+      #
+      # @return [String]
+      attr_reader :path
+
+      #
+      # Initializes the input file.
+      #
+      # @param [String] path
+      #   The input file path.
+      #
+      def initialize(path)
+        @path = path
+      end
+
+      #
+      # Opens the input file.
+      #
+      # @param [String] path
+      #   The input file path.
+      #
+      # @see #initialize
+      #
+      def self.open(path)
+        new(path)
+      end
+
+      #
+      # Enumerates over every value in the input file.
+      #
+      # @yield [value]
+      #   If a block is given, it will be passed each parsed value.
+      #
+      # @yieldparam [Values::Domain, Values::Host, Values::IP, Values::IPRange, Values::Website] value
+      #   A parsed value from the input file.
+      #
+      # @return [Enumerator]
+      #   If no block is given, then an Enumerator will be returned.
+      #
+      def each
+        return enum_for unless block_given?
+
+        File.open(@path) do |file|
+          file.each_line(chomp: true) do |line|
+            yield Value.parse(line)
+          end
+        end
+      end
+
+    end
+  end
+end

spec/fixtures/input_file.txt

@@ -0,0 +1,6 @@
+1.2.3.4
+1.2.3.4/24
+example.com
+www.example.com
+*.example.com
+https://example.com

spec/input_file_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'ronin/recon/input_file'
+
+describe Ronin::Recon::InputFile do
+  let(:fixtures_dir) { File.join(__dir__,'fixtures') }
+  let(:path)         { File.join(fixtures_dir,'input_file.txt') }
+
+  subject { described_class.new(path) }
+
+  describe "#initialize" do
+    it "must set #path" do
+      expect(subject.path).to eq(path)
+    end
+  end
+
+  describe ".open" do
+    subject { described_class.open(path) }
+
+    it "must create a new InputFile with the given path" do
+      expect(subject).to be_kind_of(described_class)
+      expect(subject.path).to eq(path)
+    end
+  end
+
+  describe "#each" do
+    context "when given a block" do
+      it "must parse each line of the input file and yield each value" do
+        expect { |b|
+          subject.each(&b)
+        }.to yield_successive_args(
+          Ronin::Recon::Values::IP.new('1.2.3.4'),
+          Ronin::Recon::Values::IPRange.new('1.2.3.4/24'),
+          Ronin::Recon::Values::Domain.new('example.com'),
+          Ronin::Recon::Values::Host.new('www.example.com'),
+          Ronin::Recon::Values::Wildcard.new('*.example.com'),
+          Ronin::Recon::Values::Website.parse('https://example.com')
+        )
+      end
+    end
+
+    context "when no block is given" do
+      it "must an Enumerator object for the method" do
+        expect(subject.each.to_a).to eq(
+          [
+            Ronin::Recon::Values::IP.new('1.2.3.4'),
+            Ronin::Recon::Values::IPRange.new('1.2.3.4/24'),
+            Ronin::Recon::Values::Domain.new('example.com'),
+            Ronin::Recon::Values::Host.new('www.example.com'),
+            Ronin::Recon::Values::Wildcard.new('*.example.com'),
+            Ronin::Recon::Values::Website.parse('https://example.com')
+          ]
+        )
+      end
+    end
+  end
+end