Added Ronin::Wordlists::Mixin (closes #20).

Author: postmodern

lib/ronin/wordlists/mixin.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists'
+
+module Ronin
+  module Wordlists
+    #
+    # Wordlist helper methods.
+    #
+    module Mixin
+      #
+      # Downloads a new wordlist.
+      #
+      # @param [String, URI::HTTP] url
+      #   The URL of the wordlist to download.
+      #
+      # @api public
+      #
+      # @see Wordlists.download
+      #
+      def wordlists_download(url)
+        Wordlists.download(url)
+      end
+
+      alias download_wordlist wordlists_download
+
+      #
+      # Finds a wordlist.
+      #
+      # @param [String] name
+      #   The wordlist file name.
+      #
+      # @return [String, nil]
+      #   The path to the wordlist file.
+      #
+      # @api public
+      #
+      # @see Wordlists.find
+      #
+      def wordlists_find(name)
+        Wordlists.find(name)
+      end
+
+      alias find_wordlist wordlists_find
+
+      #
+      # Lists all wordlists on the system.
+      #
+      # @param [String] pattern
+      #   Optional glob pattern to search for within the wordlist directory.
+      #
+      # @return [Set<String>]
+      #   The wordlist files within the wordlist directories.
+      #
+      # @api public
+      #
+      # @see Wordlists.list
+      #
+      def wordlists_list(pattern='*')
+        Wordlists.list(pattern)
+      end
+
+      alias list_wordlists wordlists_list
+
+      #
+      # Opens a wordlist.
+      #
+      # @param [String] name
+      #   The wordlist file name.
+      #
+      # @return [Wordlist::File]
+      #   The opened wordlist file.
+      #
+      # @raise [WordlistNotFound]
+      #   No wordlist with the given name.
+      #
+      # @api public
+      #
+      # @see Wordlists.open
+      #
+      def wordlists_open(name)
+        Wordlists.open(name)
+      end
+
+      alias open_wordlist wordlists_open
+    end
+  end
+end

spec/mixin_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'ronin/wordlists/mixin'
+
+describe Ronin::Wordlists::Mixin do
+  class TestWordlistsMixin
+    include Ronin::Wordlists::Mixin
+  end
+
+  subject { TestWordlistsMixin.new }
+
+  describe "#wordlists_download" do
+    let(:url) { 'http://example.com/path/to/wordlist.txt' }
+
+    it "must call Ronin::Wordlists.download with the given URL" do
+      expect(Ronin::Wordlists).to receive(:download).with(url)
+
+      subject.wordlists_download(url)
+    end
+  end
+
+  describe "#wordlists_find" do
+    let(:name) { 'subdomains-100' }
+    let(:path) { "/path/to/#{name}.txt" }
+
+    it "must call Ronin::Wordlists.find with the given name" do
+      expect(Ronin::Wordlists).to receive(:find).with(name).and_return(path)
+
+      expect(subject.wordlists_find(name)).to eq(path)
+    end
+  end
+
+  describe "#wordlists_list" do
+    let(:wordlists) do
+      Set[
+        double('wordlist1'),
+        double('wordlist2'),
+        double('wordlist3')
+      ]
+    end
+
+    context "when given no arguments" do
+      it "must call Ronin::Wordlists.list('*')" do
+        expect(Ronin::Wordlists).to receive(:list).with('*').and_return(wordlists)
+
+        expect(subject.wordlists_list).to eq(wordlists)
+      end
+    end
+
+    context "when given a glob pattern" do
+      let(:pattern) { 'wordlist*' }
+
+      it "must call Ronin::Wordlists.list() with the glob pattern" do
+        expect(Ronin::Wordlists).to receive(:list).with(pattern).and_return(wordlists)
+
+        expect(subject.wordlists_list(pattern)).to eq(wordlists)
+      end
+    end
+  end
+
+  describe "#wordlists_open" do
+    let(:name)     { 'subdomains-100' }
+    let(:wordlist) { double('opened Wordlist') }
+
+    it "must call Ronin::Wordlists.open with the given name" do
+      expect(Ronin::Wordlists).to receive(:open).with(name).and_return(wordlist)
+
+      expect(subject.wordlists_open(name)).to eq(wordlist)
+    end
+  end
+end