feat: add new --exclude-status option

docs/_advanced/configuration.md

@@ -54,6 +54,9 @@ format: "plain"
 # Whether to display HTTP status codes in the output
 show_status: "false"
 
+# Whether to exclude HTTP status codes from the output
+exclude_status: ""
+
 # Whether to include the path in the output
 include_path: "false"
 

docs/_includes/usage.md

@@ -19,6 +19,7 @@ FLAGS:
     --set-pvalue-json VALUE          Specifies the value of the identified parameter for JSON data
     --set-pvalue-path VALUE          Specifies the value of the identified parameter for path parameters
     --show-status                    Display HTTP status codes for discovered endpoints
+    --exclude-status                 Exclude specific HTTP status code
     --include-path                   Include file path in the plain result
     --no-color                       Disable color output
     --no-log                         Displaying only the results

src/completions.cr

@@ -15,6 +15,7 @@ def generate_zsh_completion_script
         '--set-pvalue-json[Specifies the value of the identified parameter for JSON data]:value:' \\
         '--set-pvalue-path[Specifies the value of the identified parameter for path parameters]:value:' \\
         '--show-status[Display HTTP status codes for discovered endpoints]' \\
+        '--exclude-status[Exclude specific HTTP status codes from the results]:status:' \\
         '--include-path[Include file path in the plain result]' \\
         '--no-color[Disable color output]' \\
         '--no-log[Displaying only the results]' \\
@@ -60,6 +61,7 @@ def generate_bash_completion_script
                 --set-pvalue-json
                 --set-pvalue-path
                 --show-status
+                --exclude-status
                 --include-path
                 --no-color
                 --no-log

src/config_initializer.cr

@@ -47,7 +47,7 @@ class ConfigInitializer
       symbolized_hash = parsed_yaml.transform_keys(&.to_s)
 
       # Transform specific keys from "yes"/"no" to true/false for old version noir config
-      ["color", "debug", "show_status", "include_path", "nolog", "send_req", "all_taggers"].each do |key|
+      ["color", "debug", "show_status", "exclude_status", "include_path", "nolog", "send_req", "all_taggers"].each do |key|
         if !symbolized_hash.has_key?(key)
           symbolized_hash[key] = default_options[key]
         elsif symbolized_hash[key] == "yes"
@@ -99,6 +99,7 @@ class ConfigInitializer
       "exclude_techs"     => YAML::Any.new(""),
       "format"            => YAML::Any.new("plain"),
       "show_status"       => YAML::Any.new(false),
+      "exclude_status"    => YAML::Any.new(""),
       "include_path"      => YAML::Any.new(false),
       "nolog"             => YAML::Any.new(false),
       "output"            => YAML::Any.new(""),

src/models/noir.cr

@@ -86,7 +86,7 @@ class NoirRunner
     add_path_parameters
 
     # Set status code
-    if any_to_bool(@options["show_status"]) == true
+    if any_to_bool(@options["show_status"]) == true || any_to_bool(@options["exclude_status"]) != ""
       update_status_codes
     end
 
@@ -271,6 +271,19 @@ class NoirRunner
     @logger.info "Updating status codes."
     final = [] of Endpoint
 
+    exclude_status = [] of Int32
+    @options["exclude_status"].to_s.split(",").each do |code|
+      if code.size > 0
+        begin
+          exclude_status << code.strip.to_i
+        rescue
+          @logger.error "Invalid --exclude-status option: '#{code}'"
+          @logger.error "Please use comma separated numbers."
+          exit(1)
+        end
+      end
+    end
+
     @endpoints.each do |endpoint|
       begin
         if endpoint.params.size > 0
@@ -296,7 +309,9 @@ class NoirRunner
             read_timeout: 5.second
           )
           endpoint.details.status_code = response.status_code
-          final << endpoint
+          unless exclude_status.includes?(response.status_code)
+            final << endpoint
+          end
         else
           response = Crest::Request.execute(
             method: get_symbol(endpoint.method),
@@ -307,7 +322,9 @@ class NoirRunner
             read_timeout: 5.second
           )
           endpoint.details.status_code = response.status_code
-          final << endpoint
+          unless exclude_status.includes?(response.status_code)
+            final << endpoint
+          end
         end
       rescue e
         @logger.error "Failed to get status code for #{endpoint.url} (#{e.message})."

src/noir.cr

@@ -31,6 +31,14 @@ if noir_options["show_status"] == true && noir_options["url"] == ""
   exit(1)
 end
 
+# Check URL
+if noir_options["exclude_status"] != "" && noir_options["url"] == ""
+  STDERR.puts "ERROR: --exclude-status requires -u or --url flag.".colorize(:yellow)
+  STDERR.puts "Please use -u or --url to set the URL."
+  STDERR.puts "If you need help, use -h or --help."
+  exit(1)
+end
+
 # Run Noir
 app = NoirRunner.new noir_options
 start_time = Time.monotonic

src/options.cr

@@ -58,13 +58,16 @@ def run_options_parser
       noir_options["show_status"] = YAML::Any.new(true)
     end
 
+    parser.on "--exclude-status 404,500", "Exclude specific HTTP status codes" { |var| noir_options["exclude_status"] = YAML::Any.new(var) }
+
     parser.on "--include-path", "Include file path in the plain result" do
       noir_options["include_path"] = YAML::Any.new(true)
     end
 
     parser.on "--no-color", "Disable color output" do
       noir_options["color"] = YAML::Any.new(false)
     end
+
     parser.on "--no-log", "Displaying only the results" do
       noir_options["nolog"] = YAML::Any.new(true)
     end

src/output_builder/common.cr

@@ -76,7 +76,7 @@ class OutputBuilderCommon < OutputBuilder
         end
       end
 
-      if any_to_bool(@options["show_status"]) == true
+      if any_to_bool(@options["show_status"]) == true || @options["exclude_status"] != ""
         r_status = endpoint.details.status_code.to_s.colorize(:light_yellow).toggle(@is_color)
         r_buffer += "\n  ○ status: #{r_status}"
       end