pwn 0.5.677 → 0.5.679

data/lib/pwn/plugins/repl.rb

@@ -1291,17 +1291,23 @@ module PWN
 
               case engine
               when :anthropic
-                response = PWN::AI::Anthropic.chat(**chat_opts)
+                # response = PWN::AI::Anthropic.chat(**chat_opts)
+                response = PWN::AI::Anthropic.chat(chat_opts)
               when :gemini
-                response = PWN::AI::Gemini.chat(**chat_opts)
+                # response = PWN::AI::Gemini.chat(**chat_opts)
+                response = PWN::AI::Gemini.chat(chat_opts)
               when :grok
-                response = PWN::AI::Grok.chat(**chat_opts)
+                # response = PWN::AI::Grok.chat(**chat_opts)
+                response = PWN::AI::Grok.chat(chat_opts)
               when :ollama
-                response = PWN::AI::Ollama.chat(**chat_opts)
+                # response = PWN::AI::Ollama.chat(**chat_opts)
+                response = PWN::AI::Ollama.chat(chat_opts)
               when :openai
-                response = PWN::AI::OpenAI.chat(**chat_opts)
+                # response = PWN::AI::OpenAI.chat(**chat_opts)
+                response = PWN::AI::OpenAI.chat(chat_opts)
               when :openwebui
-                response = PWN::AI::OpenWebUI.chat(**chat_opts)
+                # response = PWN::AI::OpenWebUI.chat(**chat_opts)
+                response = PWN::AI::OpenWebUI.chat(chat_opts)
               else
                 raise "ERROR: Unsupported AI Engine: #{engine}"
               end

data/lib/pwn/plugins/tty_spinner.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'tty-spinner'
+
+module PWN
+  module Plugins
+    # Shared TTY::Spinner lifecycle for REST / AI calls.
+    #
+    # TTY::Spinner#stop marks @done and Thread#kills the auto_spin
+    # worker but does NOT join it. The worker is typically mid-sleep
+    # on its interval, so it stays alive long enough to write another
+    # frame (cursor col 1 + glyph) over the HTTP response that the
+    # caller is about to print. Creating the spinner with clear:false
+    # (the gem default) also reprints the last glyph + newline on
+    # stop, so the spinner appears to keep running whenever a
+    # response is provided.
+    #
+    # #start uses clear:true + hide_cursor. #stop joins the worker
+    # (bounded) so the glyph is gone before the response is written.
+    module TTYSpinner
+      JOIN_SECS = 0.5
+
+      # Supported Method Parameters::
+      # spin = PWN::Plugins::TTYSpinner.start(
+      #   format: 'optional - TTY::Spinner format (defaults to :dots)',
+      #   output: 'optional - IO to draw on (defaults to $stderr)'
+      # )
+
+      public_class_method def self.start(opts = {})
+        args = {
+          format: opts[:format] || :dots,
+          clear: true,
+          hide_cursor: true
+        }
+        args[:output] = opts[:output] unless opts[:output].nil?
+
+        spin = TTY::Spinner.new(**args)
+        spin.auto_spin
+        spin
+      end
+
+      # Supported Method Parameters::
+      # PWN::Plugins::TTYSpinner.stop(
+      #   spin: 'optional - TTY::Spinner from #start (no-op if nil)'
+      # )
+
+      public_class_method def self.stop(opts = {})
+        spin = opts.is_a?(Hash) ? opts[:spin] : opts
+        return if spin.nil?
+
+        thread = spin.instance_variable_get(:@thread)
+        spin.stop unless spin.respond_to?(:done?) && spin.done?
+        thread.join(JOIN_SECS) if thread.respond_to?(:join)
+        spin
+      rescue StandardError
+        spin
+      end
+
+      # Author(s):: 0day Inc. <support@0dayinc.com>
+
+      public_class_method def self.authors
+        "AUTHOR(S):\n  0day Inc. <support@0dayinc.com>\n"
+      end
+
+      # Display usage info
+
+      public_class_method def self.help
+        puts "USAGE:
+          spin = #{self}.start
+          #{self}.stop(spin: spin)
+        "
+      end
+    end
+  end
+end

data/lib/pwn/plugins.rb

@@ -63,6 +63,7 @@ module PWN
     autoload :ThreadPool, 'pwn/plugins/thread_pool'
     autoload :Tor, 'pwn/plugins/tor'
     autoload :TransparentBrowser, 'pwn/plugins/transparent_browser'
+    autoload :TTYSpinner, 'pwn/plugins/tty_spinner'
     autoload :TwitterAPI, 'pwn/plugins/twitter_api'
     autoload :URIScheme, 'pwn/plugins/uri_scheme'
     autoload :Vault, 'pwn/plugins/vault'

data/lib/pwn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PWN
-  VERSION = '0.5.677'
+  VERSION = '0.5.679'
 end

data/spec/lib/pwn/ai/agent/registry_spec.rb

@@ -12,4 +12,10 @@ describe PWN::AI::Agent::Registry do
     help_response = PWN::AI::Agent::Registry
     expect(help_response).to respond_to :help
   end
+
+  it 'DEFAULT_PREFERENCE is memory_recall, sessions_view, pwn_eval, shell, mistakes_record, mistakes_resolve, learning_note_outcome, memory_remember' do
+    expect(described_class::DEFAULT_PREFERENCE).to eq(
+      %w[memory_recall sessions_view pwn_eval shell mistakes_record mistakes_resolve learning_note_outcome memory_remember]
+    )
+  end
 end

data/spec/lib/pwn/ai/grok_spec.rb

@@ -38,4 +38,11 @@ describe PWN::AI::Grok do
     expect(src).to include('x-grok-conv-id')
     expect(src).to include('enabled?(engine: :grok)')
   end
+
+  it 'grok_rest_call stops the spinner via TTYSpinner (joins worker after response)' do
+    src = File.read(described_class.method(:chat_with_tools).source_location.first)
+    expect(src).to include('PWN::Plugins::TTYSpinner.start')
+    expect(src).to include('PWN::Plugins::TTYSpinner.stop(spin: spin)')
+    expect(src).not_to match(/spin\.stop if spinner/)
+  end
 end

data/spec/lib/pwn/plugins/tty_spinner_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PWN::Plugins::TTYSpinner do
+  it 'should display information for authors' do
+    expect(described_class).to respond_to :authors
+  end
+
+  it 'should display information for existing help method' do
+    expect(described_class).to respond_to :help
+  end
+
+  # StringIO is never a TTY so TTY::Spinner#write is a no-op, but the
+  # auto_spin worker thread still starts. That is enough to prove #stop
+  # actually joins the worker (the bug: ensure spin.stop left it sleeping
+  # so a following response could still be overwritten).
+  def run_rest_like(opts = {})
+    provide_response = opts.fetch(:provide_response, true)
+    spinner = true
+    spin = described_class.start(output: StringIO.new) if spinner
+    response = nil
+    begin
+      sleep 0.15
+      response = provide_response ? 'HTTP_RESPONSE' : nil
+      response
+    ensure
+      described_class.stop(spin: spin)
+    end
+  end
+
+  it 'joins the auto_spin thread when a response is provided' do
+    before = Thread.list.size
+    result = run_rest_like(provide_response: true)
+    expect(result).to eq('HTTP_RESPONSE')
+    sleep 0.05
+    expect(Thread.list.size).to eq(before)
+  end
+
+  it 'joins the auto_spin thread when no response is provided' do
+    before = Thread.list.size
+    result = run_rest_like(provide_response: false)
+    expect(result).to be_nil
+    sleep 0.05
+    expect(Thread.list.size).to eq(before)
+  end
+
+  it 'is a no-op when spin is nil' do
+    expect { described_class.stop(spin: nil) }.not_to raise_error
+  end
+
+  it 'marks the spinner done and dead after stop' do
+    spin = described_class.start(output: StringIO.new)
+    thread = spin.instance_variable_get(:@thread)
+    expect(thread).not_to be_nil
+    described_class.stop(spin: spin)
+    expect(spin.done?).to be true
+    expect(spin.spinning?).to be false
+    expect(thread.status).to eq(false).or(be_nil)
+  end
+end

data/third_party/pwn_rdoc.jsonl

@@ -500,13 +500,15 @@
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Reflect.on Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Reflect.on`: Supported Method Parameters\n\nresponse = PWN::AI::Agent::Reflect.on(\n\nrequest: 'required - String - What you want the AI to reflect on',\nsystem_role_content: 'optional - context to set up the model behavior for reflection',\nengine: 'optional - override engine for THIS reflection only (Symbol/String); defaults to PWN::Env[:ai][:reflect_engine] || :active',\nmodel: 'optional - override model on the reflection engine for THIS call only; defaults to PWN::Env[:ai][:reflect_model]',\nspinner: 'optional - Boolean - Display spinner during operation (default: false)',\nsuppress_pii_warning: 'optional - Boolean - Suppress PII Warnings (default: false)'\n\n)\n"}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Reflect.with_engine Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Reflect.with_engine`: "}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.all Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.all`: Supported Method Parameters\n\nentries = PWN::AI::Agent::Registry.all\n"}]}
+{"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.apply_preference Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.apply_preference`: Supported Method Parameters\n\nsorted = PWN::AI::Agent::Registry.apply_preference(\n\nitems: 'required - Array of Entry objects or OpenAI tool hashes',\norder: 'optional - forwarded to preference_order only when the key is set',\npreference: 'optional - alias of :order; same key-present rule'\n\n)\n\nStable sort: preferred names first, original index as the tie-break so equal-preference items keep their incoming order. Empty preference (explicit [] / nil) leaves items unsorted.\n"}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.authors Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.authors`: Author(s)\n\n0day Inc. <support@0dayinc.com>\n"}]}
-{"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.definitions Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.definitions`: Supported Method Parameters\n\ntools = PWN::AI::Agent::Registry.definitions(\n\nenabled: 'optional - Array of toolset names to include; nil = all whose check passes',\nrelevance: 'optional - user request; when set AND :tool_router is enabled, slim to CORE + top-K keyword matches',\ntop_k: 'optional - keyword-ranked tools to keep beyond CORE (default 10)'\n\n)\n"}]}
+{"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.definitions Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.definitions`: Supported Method Parameters\n\ntools = PWN::AI::Agent::Registry.definitions(\n\nenabled: 'optional - Array of toolset names to include; nil = all whose check passes',\nrelevance: 'optional - user request; when set AND :tool_router is enabled, slim to CORE + top-K keyword matches',\ntop_k: 'optional - keyword-ranked tools to keep beyond CORE (default 10)',\norder: 'optional - preference list forwarded only when this key is present',\npreference: 'optional - alias of :order; same key-present rule'\n\n)\n"}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.discover Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.discover`: Supported Method Parameters\n\nnames = PWN::AI::Agent::Registry.discover(\n\nforce: 'optional - re-require tool files even if already discovered (default false)'\n\n)\n"}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.help Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.help`: "}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.lookup Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.lookup`: Supported Method Parameters\n\nentry = PWN::AI::Agent::Registry.lookup(\n\nname: 'required - registered tool name'\n\n)\n"}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.metrics_rates Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.metrics_rates`: "}]}
-{"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.rank Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.rank`: Supported Method Parameters\n\nranked = PWN::AI::Agent::Registry.rank(\n\nquery: 'required - user request text',\nentries: 'optional - Entry pool to rank (default .all)'\n\n)\n\nC1 advantage-weighted router: score = α·keyword_sim + β·(tool rolling success_rate − global rate) + γ·UCB1(tool). Untried tools get an exploration bonus; tools that outperform the fleet get an exploitation bonus. Thompson sampling is available via Metrics.thompson for stochastic routing.\n"}]}
+{"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.preference_order Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.preference_order`: Supported Method Parameters\n\norder = PWN::AI::Agent::Registry.preference_order(\n\norder: 'optional - Array of tool names; explicit nil/[] disables',\npreference: 'optional - alias of :order. Explicit key disables Env/DEFAULT fallback'\n\n)\n"}]}
+{"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.rank Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.rank`: Supported Method Parameters\n\nranked = PWN::AI::Agent::Registry.rank(\n\nquery: 'required - user request text',\nentries: 'optional - Entry pool to rank (default .all)',\norder: 'optional - preference list forwarded to preference_order'\n\n)\n\nC1 advantage-weighted router: score = α·keyword_sim + β·(tool rolling success_rate − global rate) + γ·UCB1(tool). Untried tools get an exploration bonus; tools that outperform the fleet get an exploitation bonus. Thompson sampling is available via Metrics.thompson for stochastic routing.\n"}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.register Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.register`: Supported Method Parameters\n\nPWN::AI::Agent::Registry.register(\n\nname: 'required - tool name exposed to the model',\ntoolset: 'required - grouping for enable/disable (terminal, file, pwn, memory…)',\nschema: 'required - OpenAI function schema {name:, description:, parameters:}',\nhandler: 'required - ->(args_hash) { ... } returning a JSON-serialisable object',\ncheck: 'optional - -> { bool } gate; tool only advertised when truthy',\nmax_chars: 'optional - cap on serialised result (default 24_000)'\n\n)\n"}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.router_enabled? Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.router_enabled?`: "}]}
 {"messages":[{"role":"user","content":"PWN::AI::Agent::Registry.safe_check Usage"},{"role":"assistant","content":"`PWN::AI::Agent::Registry.safe_check`: "}]}
@@ -2096,6 +2098,10 @@
 {"messages":[{"role":"user","content":"PWN::Plugins::Spider.authors Usage"},{"role":"assistant","content":"`PWN::Plugins::Spider.authors`: Author(s)\n\n0day Inc. <support@0dayinc.com>\n"}]}
 {"messages":[{"role":"user","content":"PWN::Plugins::Spider.crawl Usage"},{"role":"assistant","content":"`PWN::Plugins::Spider.crawl`: Supported Method Parameters\n\nPWN::Plugins::Spider.crawl(\n\ntarget_fqdn: 'required - target fqdn to spider',\nresults_path: 'required - path to save spider results',\nproxy: 'optional - proxy to spider through e.g. http://127.0.0.1:8080'\n\n)\n"}]}
 {"messages":[{"role":"user","content":"PWN::Plugins::Spider.help Usage"},{"role":"assistant","content":"`PWN::Plugins::Spider.help`: "}]}
+{"messages":[{"role":"user","content":"PWN::Plugins::TTYSpinner.authors Usage"},{"role":"assistant","content":"`PWN::Plugins::TTYSpinner.authors`: Author(s)\n\n0day Inc. <support@0dayinc.com>\n"}]}
+{"messages":[{"role":"user","content":"PWN::Plugins::TTYSpinner.help Usage"},{"role":"assistant","content":"`PWN::Plugins::TTYSpinner.help`: "}]}
+{"messages":[{"role":"user","content":"PWN::Plugins::TTYSpinner.start Usage"},{"role":"assistant","content":"`PWN::Plugins::TTYSpinner.start`: Supported Method Parameters\n\nspin = PWN::Plugins::TTYSpinner.start(\n\nformat: 'optional - TTY::Spinner format (defaults to :dots)',\noutput: 'optional - IO to draw on (defaults to $stderr)'\n\n)\n"}]}
+{"messages":[{"role":"user","content":"PWN::Plugins::TTYSpinner.stop Usage"},{"role":"assistant","content":"`PWN::Plugins::TTYSpinner.stop`: Supported Method Parameters\n\nPWN::Plugins::TTYSpinner.stop(\n\nspin: 'optional - TTY::Spinner from #start (no-op if nil)'\n\n)\n"}]}
 {"messages":[{"role":"user","content":"PWN::Plugins::ThreadPool.authors Usage"},{"role":"assistant","content":"`PWN::Plugins::ThreadPool.authors`: Author(s)\n\n0day Inc. <support@0dayinc.com>\n"}]}
 {"messages":[{"role":"user","content":"PWN::Plugins::ThreadPool.fill Usage"},{"role":"assistant","content":"`PWN::Plugins::ThreadPool.fill`: Supported Method Parameters\n\nPWN::Plugins::ThreadPool.fill(\n\nenumerable_array: 'required array for proper thread pool assignment',\nmax_threads: 'optional number of threads in the thread pool (defaults to 9)',\ndetach: 'optional boolean to detach threads (defaults to false)'\n\n)\n\nExample: arr = [1, 2, 3, 4, 5, 6, 7, 8, 9] mutex = Mutex.new PWN::Plugins::ThreadPool.fill(enumerable_array: arr, max_threads: 9) do |integer|\n\nmutex.synchronize do\n  puts integer\nend\n\n\nend\n"}]}
 {"messages":[{"role":"user","content":"PWN::Plugins::ThreadPool.help Usage"},{"role":"assistant","content":"`PWN::Plugins::ThreadPool.help`: "}]}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwn
 version: !ruby/object:Gem::Version
-  version: 0.5.677
+  version: 0.5.679
 platform: ruby
 authors:
 - 0day Inc.
@@ -2082,6 +2082,7 @@ files:
 - lib/pwn/plugins/thread_pool.rb
 - lib/pwn/plugins/tor.rb
 - lib/pwn/plugins/transparent_browser.rb
+- lib/pwn/plugins/tty_spinner.rb
 - lib/pwn/plugins/twitter_api.rb
 - lib/pwn/plugins/uri_scheme.rb
 - lib/pwn/plugins/vault.rb
@@ -2554,6 +2555,7 @@ files:
 - spec/lib/pwn/plugins/thread_pool_spec.rb
 - spec/lib/pwn/plugins/tor_spec.rb
 - spec/lib/pwn/plugins/transparent_browser_spec.rb
+- spec/lib/pwn/plugins/tty_spinner_spec.rb
 - spec/lib/pwn/plugins/twitter_api_spec.rb
 - spec/lib/pwn/plugins/uri_scheme_spec.rb
 - spec/lib/pwn/plugins/vault_spec.rb