ronin-wordlists 0.1.0.rc1

data/man/ronin-wordlists.1.md

@@ -0,0 +1,64 @@
+# ronin-wordlists 1 "2023-01-01" Ronin Wordlists "User Manuals"
+
+## SYNOPSIS
+
+`ronin-wordlists` [*options*] [*COMMAND*]
+
+## DESCRIPTION
+
+Command suite that manages wordlists.
+
+## ARGUMENTS
+
+*COMMAND*
+: The `ronin-wordlists` command to execute.
+
+## OPTIONS
+
+`-h`, `--help`
+: Prints help information.
+
+## COMMANDS
+
+`search`
+: Lists wordlists available for download or installation.
+
+`completion`
+: Manages the shell completion rules for `ronin-wordlists`.
+
+`download`
+: Downloads a wordlist.
+
+`list`, `ls`
+: Lists downloaded wordlists.
+
+`purge`
+: Deletes all downloaded wordlists.
+
+`remove`, `rm`
+: Deletes a downloaded wordlist.
+
+`update`, `up`
+: Updates one or all downloaded wordlists.
+
+## FILES
+
+`~/.cache/ronin-wordlists`
+: Default installation directory for wordlists.
+
+## ENVIRONMENT
+
+*HOME*
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-wordlists` cache directory within the home directory.
+
+*XDG_CACHE_HOME*
+: Specifies the cache directory to use. Defaults to `$HOME/.cache`.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-wordlists-search](ronin-wordlists-search.1.md) [ronin-wordlists-completion](ronin-wordlists-completion.1.md) [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md) [ronin-wordlists-purge](ronin-wordlists-purge.1.md)

data/ronin-wordlists.gemspec

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+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 'ronin/wordlists/version'
+                  Ronin::Wordlists::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 = ->(patterns) { gem.files & Dir[*patterns] }
+
+  gem.files  = `git ls-files`.split($/)
+  gem.files  = glob[gemspec['files']] if gemspec['files']
+  gem.files += Array(gemspec['generated_files'])
+  # exclude test files from the packages gem
+  gem.files -= glob[gemspec['test_files'] || 'spec/{**/}*']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.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              = 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 = ->(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/scripts/setup

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+#
+# Prints a log message.
+#
+function log()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[32m>>>\x1b[0m \x1b[1m$1\x1b[0m"
+	else
+		echo ">>> $1"
+	fi
+}
+
+#
+# Prints a warn message.
+#
+function warn()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[33m***\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "*** $1" >&2
+	fi
+}
+
+#
+# Prints an error message.
+#
+function error()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[31m!!!\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "!!! $1" >&2
+	fi
+}
+
+#
+# Prints an error message and exists with -1.
+#
+function fail()
+{
+	error "$@"
+	exit -1
+}
+
+# default to installing gems into vendor/bundle
+if [[ ! -f .bundle/config ]]; then
+	bundle config set --local path vendor/bundle >/dev/null || \
+	  fail "Failed to run 'bundle config'"
+fi
+
+log "Installing gems ..."
+bundle install || fail "Failed to run 'bundle install'!"
+
+log "Setting up the project ..."
+bundle exec rake setup || "Failed to run 'rake setup'!"

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: ronin-wordlists
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc1
+platform: ruby
+authors:
+- Postmodern
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wordlist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: ronin-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0.rc1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  ronin-wordlists is a library and tool for managing wordlists. ronin-wordlists
+  can install and update wordlists, and contains a curated list of popular
+  wordlists and their download URLs.
+email: postmodern.mod3@gmail.com
+executables:
+- ronin-wordlists
+extensions: []
+extra_rdoc_files:
+- COPYING.txt
+- ChangeLog.md
+- README.md
+files:
+- ".document"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- COPYING.txt
+- ChangeLog.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/ronin-wordlists
+- data/completions/ronin-wordlists
+- data/completions/ronin-wordlists.yml
+- data/wordlists.yml
+- gemspec.yml
+- lib/ronin/wordlists.rb
+- lib/ronin/wordlists/cache_dir.rb
+- lib/ronin/wordlists/cli.rb
+- lib/ronin/wordlists/cli/command.rb
+- lib/ronin/wordlists/cli/commands/completion.rb
+- lib/ronin/wordlists/cli/commands/download.rb
+- lib/ronin/wordlists/cli/commands/list.rb
+- lib/ronin/wordlists/cli/commands/purge.rb
+- lib/ronin/wordlists/cli/commands/remove.rb
+- lib/ronin/wordlists/cli/commands/search.rb
+- lib/ronin/wordlists/cli/commands/update.rb
+- lib/ronin/wordlists/cli/wordlist_dir_option.rb
+- lib/ronin/wordlists/cli/wordlist_index.rb
+- lib/ronin/wordlists/cli/wordlist_option.rb
+- lib/ronin/wordlists/exceptions.rb
+- lib/ronin/wordlists/mixin.rb
+- lib/ronin/wordlists/root.rb
+- lib/ronin/wordlists/search_paths.rb
+- lib/ronin/wordlists/version.rb
+- lib/ronin/wordlists/wordlist_dir.rb
+- lib/ronin/wordlists/wordlist_file.rb
+- lib/ronin/wordlists/wordlist_metadata.rb
+- lib/ronin/wordlists/wordlist_repo.rb
+- man/ronin-wordlists-completion.1
+- man/ronin-wordlists-completion.1.md
+- man/ronin-wordlists-download.1
+- man/ronin-wordlists-download.1.md
+- man/ronin-wordlists-list.1
+- man/ronin-wordlists-list.1.md
+- man/ronin-wordlists-purge.1
+- man/ronin-wordlists-purge.1.md
+- man/ronin-wordlists-remove.1
+- man/ronin-wordlists-remove.1.md
+- man/ronin-wordlists-search.1
+- man/ronin-wordlists-search.1.md
+- man/ronin-wordlists-update.1
+- man/ronin-wordlists-update.1.md
+- man/ronin-wordlists.1
+- man/ronin-wordlists.1.md
+- ronin-wordlists.gemspec
+- scripts/setup
+homepage: https://ronin-rb.dev/
+licenses:
+- LGPL-3.0
+metadata:
+  documentation_uri: https://ronin-rb.dev/docs/ronin-wordlists
+  source_code_uri: https://github.com/ronin-rb/ronin-wordlists
+  bug_tracker_uri: https://github.com/ronin-rb/ronin-wordlists/issues
+  changelog_uri: https://github.com/ronin-rb/ronin-wordlists/blob/main/ChangeLog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: A library and tool for managing wordlists.
+test_files: []