ruby-feroxbuster 0.1.0

data/lib/feroxbuster/parsers/txt.rb

@@ -0,0 +1,48 @@
+require 'feroxbuster/response'
+
+module Feroxbuster
+  module Parsers
+    #
+    # Parses single-line response data.
+    #
+    # @api semipublic
+    #
+    module TXT
+      #
+      # Parses each line of plain-text.
+      #
+      # @param [IO] io
+      #   The IO stream to parse.
+      #
+      # @yield [response]
+      #   The given block will be passed each parsed response.
+      #
+      # @yieldparam [Response] response
+      #   The parsed response.
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator will be returned.
+      #
+      def self.parse(io)
+        return enum_for(__method__,io) unless block_given?
+
+        line_regexp = /^(\d{3})\s+(\w+)\s+(\d+)l\s+(\d+)w\s+(\d+)c\s+([^\s]+)/
+
+        io.each_line do |line|
+          line.chomp!
+
+          if (match = line.match(line_regexp))
+            yield Response.new(
+              status:         match[1].to_i,
+              method:         match[2],
+              line_count:     match[3].to_i,
+              word_count:     match[4].to_i,
+              content_length: match[5].to_i,
+              url:            match[6]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/feroxbuster/response.rb

@@ -0,0 +1,117 @@
+module Feroxbuster
+  #
+  # Represents response data, either parsed from `.txt` or `.json` output.
+  #
+  class Response
+
+    # The URL that was requested.
+    #
+    # @return [String]
+    attr_reader :url
+
+    # The "original" URL that was requested.
+    #
+    # @return [String]
+    attr_reader :original_url
+
+    # The path that was requested.
+    #
+    # @return [String, nil]
+    attr_reader :path
+
+    # @return [Boolean, nil]
+    attr_reader :wildcard
+
+    # The HTTP response status code.
+    #
+    # @return [Integer]
+    attr_reader :status
+
+    # The HTTP method used for the request.
+    #
+    # @return [String]
+    attr_reader :method
+
+    # The `Content-Length` of the response.
+    #
+    # @return [Integer]
+    attr_reader :content_length
+
+    # The line count of the response.
+    #
+    # @return [Integer]
+    attr_reader :line_count
+
+    # The word count of the response.
+    #
+    # @return [Integer]
+    attr_reader :word_count
+
+    # the HTTP headers of the response.
+    #
+    # @return [Hash{String => String}, nil]
+    attr_reader :headers
+
+    # @return [String, nil]
+    attr_reader :extension
+
+    #
+    # Initializes the response object.
+    #
+    # @param [String] url
+    #   The URL that was requested.
+    #
+    # @param [String] original_url
+    #   The "original" URL that was requested.
+    #
+    # @param [String, nil] path
+    #   The path that was requested.
+    #
+    # @param [Boolean, nil] wildcard
+    #
+    # @param [Integer] status
+    #   The HTTP response status code.
+    #
+    # @param [String] method
+    #   The HTTP method used for the request.
+    #
+    # @param [Integer] content_length
+    #   The `Content-Length` of the response.
+    #
+    # @param [Integer] line_count
+    #   The line count of the response.
+    #
+    # @param [Integer] word_count
+    #   The word count of the response.
+    #
+    # @param [Hash{String => String}, nil] headers
+    #   the HTTP headers of the response.
+    #
+    # @param [String, nil] extension
+    #
+    def initialize(url:            ,
+                   original_url:   nil,
+                   path:           nil,
+                   wildcard:       nil,
+                   status:         ,
+                   method:         ,
+                   content_length: ,
+                   line_count:     ,
+                   word_count:     ,
+                   headers:        nil,
+                   extension:      nil)
+      @url            = url
+      @original_url   = original_url
+      @path           = path
+      @wildcard       = wildcard
+      @status         = status
+      @method         = method
+      @content_length = content_length
+      @line_count     = line_count
+      @word_count     = word_count
+      @headers        = headers
+      @extension      = extension
+    end
+
+  end
+end

data/lib/feroxbuster/statistics.rb

@@ -0,0 +1,238 @@
+module Feroxbuster
+  #
+  # Represents the statistics data, parsed from the last line of a `.json`
+  # output file.
+  #
+  class Statistics
+
+    # @return [Integer]
+    attr_reader :timeouts
+
+    # @return [Integer]
+    attr_reader :requests
+
+    # @return [Integer]
+    attr_reader :expected_per_scan
+
+    # @return [Integer]
+    attr_reader :total_expected
+
+    # @return [Integer]
+    attr_reader :errors
+
+    # @return [Integer]
+    attr_reader :successes
+
+    # @return [Integer]
+    attr_reader :redirects
+
+    # @return [Integer]
+    attr_reader :client_errors
+
+    # @return [Integer]
+    attr_reader :server_errors
+
+    # @return [Integer]
+    attr_reader :total_scans
+
+    # @return [Integer]
+    attr_reader :initial_targets
+
+    # @return [Integer]
+    attr_reader :links_extracted
+
+    # @return [Integer]
+    attr_reader :extensions_collected
+
+    # @return [Integer]
+    attr_reader :status_200s
+
+    # @return [Integer]
+    attr_reader :status_301s
+
+    # @return [Integer]
+    attr_reader :status_302s
+
+    # @return [Integer]
+    attr_reader :status_401s
+
+    # @return [Integer]
+    attr_reader :status_403s
+
+    # @return [Integer]
+    attr_reader :status_429s
+
+    # @return [Integer]
+    attr_reader :status_500s
+
+    # @return [Integer]
+    attr_reader :status_503s
+
+    # @return [Integer]
+    attr_reader :status_504s
+
+    # @return [Integer]
+    attr_reader :status_508s
+
+    # @return [Integer]
+    attr_reader :wildcards_filtered
+
+    # @return [Integer]
+    attr_reader :responses_filtered
+
+    # @return [Integer]
+    attr_reader :resources_discovered
+
+    # @return [Integer]
+    attr_reader :url_format_errors
+
+    # @return [Integer]
+    attr_reader :redirection_errors
+
+    # @return [Integer]
+    attr_reader :connection_errors
+
+    # @return [Integer]
+    attr_reader :request_errors
+
+    # @return [Array<Float>]
+    attr_reader :directory_scan_times
+
+    # @return [Array<Float>]
+    attr_reader :total_runtime
+
+    #
+    # Initializes the statistics object.
+    #
+    # @param [Integer] timeouts
+    #
+    # @param [Integer] requests
+    #
+    # @param [Integer] expected_per_scan
+    #
+    # @param [Integer] total_expected
+    #
+    # @param [Integer] errors
+    #
+    # @param [Integer] successes
+    #
+    # @param [Integer] redirects
+    #
+    # @param [Integer] client_errors
+    #
+    # @param [Integer] server_errors
+    #
+    # @param [Integer] total_scans
+    #
+    # @param [Integer] initial_targets
+    #
+    # @param [Integer] links_extracted
+    #
+    # @param [Integer] extensions_collected
+    #
+    # @param [Integer] status_200s
+    #
+    # @param [Integer] status_301s
+    #
+    # @param [Integer] status_302s
+    #
+    # @param [Integer] status_401s
+    #
+    # @param [Integer] status_403s
+    #
+    # @param [Integer] status_429s
+    #
+    # @param [Integer] status_500s
+    #
+    # @param [Integer] status_503s
+    #
+    # @param [Integer] status_504s
+    #
+    # @param [Integer] status_508s
+    #
+    # @param [Integer] wildcards_filtered
+    #
+    # @param [Integer] responses_filtered
+    #
+    # @param [Integer] resources_discovered
+    #
+    # @param [Integer] url_format_errors
+    #
+    # @param [Integer] redirection_errors
+    #
+    # @param [Integer] connection_errors
+    #
+    # @param [Integer] request_errors
+    #
+    # @param [Array<Float>] directory_scan_times
+    #
+    # @param [Array<Float>] total_runtime
+    #
+    def initialize(timeouts: 0,
+                   requests: 0,
+                   expected_per_scan: 6,
+                   total_expected: 0,
+                   errors: 0,
+                   successes: 0,
+                   redirects: 0,
+                   client_errors: 0,
+                   server_errors: 0,
+                   total_scans: 0,
+                   initial_targets: 0,
+                   links_extracted: 0,
+                   extensions_collected: 0,
+                   status_200s: 0,
+                   status_301s: 0,
+                   status_302s: 0,
+                   status_401s: 0,
+                   status_403s: 0,
+                   status_429s: 0,
+                   status_500s: 0,
+                   status_503s: 0,
+                   status_504s: 0,
+                   status_508s: 0,
+                   wildcards_filtered: 0,
+                   responses_filtered: 0,
+                   resources_discovered: 0,
+                   url_format_errors: 0,
+                   redirection_errors: 0,
+                   connection_errors: 0,
+                   request_errors: 0,
+                   directory_scan_times: [],
+                   total_runtime: [])
+      @timeouts = timeouts
+      @requests = requests
+      @expected_per_scan = expected_per_scan
+      @total_expected = total_expected
+      @errors = errors
+      @successes = successes
+      @redirects = redirects
+      @client_errors = client_errors
+      @server_errors = server_errors
+      @total_scans = total_scans
+      @initial_targets = initial_targets
+      @links_extracted = links_extracted
+      @extensions_collected = extensions_collected
+      @status_200s = status_200s
+      @status_301s = status_301s
+      @status_302s = status_302s
+      @status_401s = status_401s
+      @status_403s = status_403s
+      @status_429s = status_429s
+      @status_500s = status_500s
+      @status_503s = status_503s
+      @status_504s = status_504s
+      @status_508s = status_508s
+      @wildcards_filtered = wildcards_filtered
+      @responses_filtered = responses_filtered
+      @resources_discovered = resources_discovered
+      @url_format_errors = url_format_errors
+      @redirection_errors = redirection_errors
+      @connection_errors = connection_errors
+      @request_errors = request_errors
+      @directory_scan_times = directory_scan_times
+      @total_runtime = total_runtime
+    end
+
+  end
+end

data/lib/feroxbuster/version.rb

@@ -0,0 +1,4 @@
+module Feroxbuster
+  # ruby-feroxbuster version
+  VERSION = '0.1.0'
+end

data/ruby-feroxbuster.gemspec

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'feroxbuster/version'
+                  Feroxbuster::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = Array(gemspec['requirements'])
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'feroxbuster/command'
+
+describe Feroxbuster::Command do
+  describe described_class::StatusCode do
+    describe "#initialize" do
+      it "must set #range to 100..599 by default" do
+        expect(subject.range).to eq(100..599)
+      end
+    end
+  end
+
+  describe described_class::TimeSpec do
+    describe "#validate" do
+      context "when given nil" do
+        let(:value) { nil }
+
+        it "must return [false, \"cannot be nil\"]" do
+          expect(subject.validate(value)).to eq(
+            [false, "cannot be nil"]
+          )
+        end
+      end
+
+      context "when given a String" do
+        context "when given an empty String" do
+          let(:value) { "" }
+
+          it "must return [false, \"does not allow an empty value\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "does not allow an empty value"]
+            )
+          end
+        end
+
+        context "when given a number" do
+          let(:value) { "10" }
+
+          it "must return [false, \"must be a number and end with 'm', 's', 'ms', or 'ns'\"]" do
+            expect(subject.validate(value)).to eq(
+              [false, "must be a number and end with 'm', 's', 'ms', or 'ns'"]
+            )
+          end
+        end
+
+        context "when given a number that ends with a unit" do
+          let(:value) { "10s" }
+
+          it "must return true" do
+            expect(subject.validate(value)).to be(true)
+          end
+
+          context "but the unit isn't recognized" do
+            let(:value) { "10x" }
+
+            it "must return [false, \"must be a number and end with 'm', 's', 'ms', or 'ns'\"]" do
+              expect(subject.validate(value)).to eq(
+                [false, "must be a number and end with 'm', 's', 'ms', or 'ns'"]
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/output.json

@@ -0,0 +1,5 @@
+{"type":"response","url":"https://github.com/test","original_url":"https://github.com","path":"/test","wildcard":false,"status":200,"method":"GET","content_length":0,"line_count":2010,"word_count":11253,"headers":{"permissions-policy":"interest-cohort=()","accept-ranges":"bytes","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","x-content-type-options":"nosniff","cache-control":"max-age=0, private, must-revalidate","expect-ct":"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"","server":"GitHub.com","x-github-request-id":"85A8:0E10:20B03E:27719A:6260B1D5","transfer-encoding":"chunked","date":"Thu, 21 Apr 2022 01:22:16 GMT","strict-transport-security":"max-age=31536000; includeSubdomains; preload","etag":"W/\"7c98cb0440eb94eddcfd360497fae419\"","x-frame-options":"deny","content-security-policy":"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/","x-xss-protection":"0","set-cookie":"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax","vary":"X-Requested-With, X-PJAX-Container, Accept-Encoding, Accept, X-Requested-With","content-type":"text/html; charset=utf-8"},"extension":""}
+{"type":"response","url":"https://github.com/dev","original_url":"https://github.com","path":"/dev","wildcard":false,"status":200,"method":"GET","content_length":0,"line_count":2067,"word_count":11308,"headers":{"date":"Thu, 21 Apr 2022 01:22:17 GMT","cache-control":"max-age=0, private, must-revalidate","content-security-policy":"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/","set-cookie":"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax","permissions-policy":"interest-cohort=()","x-frame-options":"deny","server":"GitHub.com","accept-ranges":"bytes","etag":"W/\"3ca853f280bb864544f7842cdaa124e5\"","vary":"X-Requested-With, X-PJAX-Container, Accept-Encoding, Accept, X-Requested-With","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","x-github-request-id":"85AC:2947:2319C4:29E4C8:6260B1D5","transfer-encoding":"chunked","expect-ct":"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"","x-content-type-options":"nosniff","content-type":"text/html; charset=utf-8","x-xss-protection":"0","strict-transport-security":"max-age=31536000; includeSubdomains; preload"},"extension":""}
+{"type":"response","url":"https://github.com/www","original_url":"https://github.com","path":"/www","wildcard":false,"status":200,"method":"GET","content_length":0,"line_count":1813,"word_count":10399,"headers":{"content-type":"text/html; charset=utf-8","accept-ranges":"bytes","date":"Thu, 21 Apr 2022 01:22:16 GMT","transfer-encoding":"chunked","vary":"X-Requested-With, X-PJAX-Container, Accept-Encoding, Accept, X-Requested-With","x-xss-protection":"0","x-github-request-id":"85B4:4678:28A012:2F9830:6260B1D5","content-security-policy":"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","etag":"W/\"e03d055bf6b701eb6ecf1fa7c1a137f0\"","permissions-policy":"interest-cohort=()","strict-transport-security":"max-age=31536000; includeSubdomains; preload","x-frame-options":"deny","set-cookie":"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax","expect-ct":"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"","server":"GitHub.com","cache-control":"max-age=0, private, must-revalidate","x-content-type-options":"nosniff"},"extension":""}
+{"type":"response","url":"https://github.com/","original_url":"https://github.com","path":"/","wildcard":false,"status":200,"method":"GET","content_length":0,"line_count":2596,"word_count":13002,"headers":{"cache-control":"max-age=0, private, must-revalidate","server":"GitHub.com","set-cookie":"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax","permissions-policy":"interest-cohort=()","vary":"X-PJAX, X-PJAX-Container, Accept-Language, Accept-Encoding, Accept, X-Requested-With","content-security-policy":"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com github.githubassets.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com customer-stories-feed.github.com spotlights-feed.github.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ github.githubassets.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/","x-xss-protection":"0","expect-ct":"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"","x-github-request-id":"85B2:4670:5B88C:BE8AA:6260B1D5","date":"Thu, 21 Apr 2022 01:22:22 GMT","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","x-content-type-options":"nosniff","etag":"W/\"b1bb181559a6360603ad7f0ed22c198c\"","accept-ranges":"bytes","x-frame-options":"deny","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","content-type":"text/html; charset=utf-8","content-language":"en-US"},"extension":""}
+{"type":"statistics","timeouts":0,"requests":18,"expected_per_scan":6,"total_expected":12,"errors":0,"successes":12,"redirects":0,"client_errors":6,"server_errors":0,"total_scans":2,"initial_targets":0,"links_extracted":0,"extensions_collected":0,"status_200s":12,"status_301s":0,"status_302s":0,"status_401s":0,"status_403s":0,"status_429s":0,"status_500s":0,"status_503s":0,"status_504s":0,"status_508s":0,"wildcards_filtered":0,"responses_filtered":0,"resources_discovered":4,"url_format_errors":0,"redirection_errors":0,"connection_errors":0,"request_errors":0,"directory_scan_times":[0.434531853,0.434228035],"total_runtime":[1.6527268240000001]}

data/spec/fixtures/output.txt

@@ -0,0 +1,4 @@
+200      GET     2596l    13002w        0c https://github.com/
+200      GET     2010l    11253w        0c https://github.com/test
+200      GET     1813l    10399w        0c https://github.com/www
+200      GET     2067l    11308w        0c https://github.com/dev

data/spec/output_file_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+require 'feroxbuster/output_file'
+
+describe Feroxbuster::OutputFile do
+  let(:fixtures_dir) { File.expand_path(File.join(__dir__,'fixtures')) }
+
+  describe ".infer_format" do
+    subject { described_class.infer_format(path) }
+
+    context "when the path ends in .json" do
+      let(:path) { '/path/to/file.json' }
+
+      it { expect(subject).to eq(:json) }
+    end
+
+    context "when the path ends in .txt" do
+      let(:path) { '/path/to/file.txt' }
+
+      it { expect(subject).to eq(:txt) }
+    end
+  end
+
+  describe "PARSERS" do
+    subject { described_class::PARSERS }
+
+    describe ":txt" do
+      it { expect(subject[:txt]).to eq(Feroxbuster::Parsers::TXT) }
+    end
+
+    describe ":json" do
+      it { expect(subject[:json]).to eq(Feroxbuster::Parsers::JSON) }
+    end
+  end
+
+  describe "FILE_FORMATS" do
+    subject { described_class::FILE_FORMATS }
+
+    describe ".txt" do
+      it { expect(subject['.txt']).to be(:txt) }
+    end
+
+    describe ".json" do
+      it { expect(subject['.json']).to be(:json) }
+    end
+  end
+
+  describe "#initialize" do
+    let(:path) { "/path/to/file.json" }
+
+    subject { described_class.new(path) }
+
+    it "must set #path" do
+      expect(subject.path).to eq(path)
+    end
+
+    it "must infer the format from the file's extname" do
+      expect(subject.format).to eq(:json)
+    end
+
+    it "must set #parser based on #format" do
+      expect(subject.parser).to eq(described_class::PARSERS[subject.format])
+    end
+
+    context "when given an format: keyword" do
+      let(:format) { :txt }
+
+      subject { described_class.new(path, format: format) }
+
+      it "must set #format" do
+        expect(subject.format).to be(format)
+      end
+
+      it "must set #parser based on the given format:" do
+        expect(subject.parser).to eq(described_class::PARSERS[format])
+      end
+    end
+  end
+
+  let(:path) { File.join(fixtures_dir,'output.json') }
+
+  subject { described_class.new(path) }
+
+  describe "#each" do
+    context "when a block is given" do
+      it "must yield each parsed Response object" do
+        yielded_objects = []
+
+        subject.each do |object|
+          yielded_objects << object
+        end
+
+        expect(yielded_objects).to_not be_empty
+        expect(yielded_objects[0..-2]).to all(be_kind_of(Feroxbuster::Response))
+
+        expect(yielded_objects.last).to be_kind_of(Feroxbuster::Statistics)
+      end
+    end
+
+    context "when no block is given" do
+      it "must return an Enumerator of the parsed Response objects" do
+        objects = subject.each.to_a
+
+        expect(objects).to_not be_empty
+        expect(objects[0..-2]).to all(be_kind_of(Feroxbuster::Response))
+
+        expect(objects.last).to be_kind_of(Feroxbuster::Statistics)
+      end
+    end
+  end
+
+  describe "#to_s" do
+    it "must return #path" do
+      expect(subject.to_s).to eq(path)
+    end
+  end
+end