ronin-core 0.1.3 → 0.2.0.rc1

data/lib/ronin/core/output_formats/output_format.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core 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-core 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-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Core
+    module OutputFormats
+      #
+      # Base class for all output formats.
+      #
+      # @api semipublic
+      #
+      # @since 0.2.0
+      #
+      class OutputFormat
+
+        #
+        # Writes a value to the output format.
+        #
+        # @param [Object] value
+        #   The output value object to write.
+        #
+        # @return [self]
+        #
+        # @abstract
+        #
+        def <<(value)
+          raise(NotImplementedError,"#{self.class}#<< was not implemented")
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/core/output_formats/txt.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core 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-core 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-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/output_formats/output_file'
+
+module Ronin
+  module Core
+    module OutputFormats
+      #
+      # Represents a plain-text list of discovered values.
+      #
+      # @api semipublic
+      #
+      # @since 0.2.0
+      #
+      class TXT < OutputFile
+
+        #
+        # Appends a value to the list output stream.
+        #
+        # @param [#to_s] value
+        #   The value to append.
+        #
+        # @return [self]
+        #
+        def <<(value)
+          @io.puts(value.to_s)
+          @io.flush
+          return self
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/core/output_formats.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core 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-core 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-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/output_formats/txt'
+require 'ronin/core/output_formats/csv'
+require 'ronin/core/output_formats/json'
+require 'ronin/core/output_formats/ndjson'
+
+module Ronin
+  module Core
+    #
+    # Contains common output file formats, such as {TXT txt}, {CSV csv},
+    # {JSON json}, and {NDJSON ndjson}.
+    #
+    module OutputFormats
+      #
+      # Adds {ClassMethods} to the other `OutputFormats` module which is
+      # including {Ronin::Core::OutputFormats}.
+      #
+      # @param [Module] output_formats
+      #   The other `OutputFormats` module which is including {OutputFormats}.
+      #
+      def self.included(output_formats)
+        output_formats.extend ClassMethods
+      end
+
+      #
+      # Class methods which are added to another `OutputFormats` module
+      # when {Ronin::Core::OutputFormats} is included.
+      #
+      module ClassMethods
+        #
+        # Output formats grouped by name.
+        #
+        # @return [Hash{Symbol => Class<OutputFormat>}]
+        #
+        def formats
+          @formats ||= {}
+        end
+
+        #
+        # Output formats grouped by file extension.
+        #
+        # @return [Hash{String => Class<OutputFormat>}]
+        #
+        def file_exts
+          @file_exts ||= {}
+        end
+
+        #
+        # Registers a new output format.
+        #
+        def register(name,ext,output_format)
+          formats[name]  = output_format
+          file_exts[ext] = output_format
+        end
+
+        #
+        # Infers the output format from the output file path.
+        #
+        # @param [String] path
+        #   The output file path to infer the output format from.
+        #
+        # @return [Class<OutputFormat>, Class<TXT>]
+        #   The inferred output format for the given path, or {TXT} if the
+        #   output format could not be inferred.
+        #
+        def infer_from(path)
+          file_exts.fetch(File.extname(path),TXT)
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/params/exceptions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/mixin.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/param.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/boolean.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/enum.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/float.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/integer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/numeric.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/regexp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/type.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types/uri.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params/types.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/params.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/core/system.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core 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-core 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-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'uri'
+require 'fileutils'
+
+module Ronin
+  module Core
+    #
+    # Utility methods for interacting with the system.
+    #
+    # @api semipublic
+    #
+    # @since 0.2.0
+    #
+    module System
+      #
+      # The detected Operating System type.
+      #
+      # @return [:linux, :macos, :freebsd, :openbsd, :netbsd, :windows, nil]
+      #
+      def self.os
+        @os ||= if    RUBY_PLATFORM.include?('linux')   then :linux
+                elsif RUBY_PLATFORM.include?('darwin')  then :macos
+                elsif RUBY_PLATFORM.include?('freebsd') then :freebsd
+                elsif RUBY_PLATFORM.include?('openbsd') then :openbsd
+                elsif RUBY_PLATFORM.include?('netbsd')  then :netbsd
+                elsif Gem.win_platform?                 then :windows
+                end
+      end
+
+      #
+      # The list of `bin/` directories containing executables.
+      #
+      # @return [Array<String>]
+      #
+      def self.paths
+        @paths ||= if ENV['PATH']
+                     ENV['PATH'].split(File::PATH_SEPARATOR)
+                   else
+                     []
+                   end
+      end
+
+      #
+      # Determines if a command is installed.
+      #
+      # @param [String] command
+      #   The command name to search for.
+      #
+      # @return [Boolean]
+      #   Indicates whether the command was found or not.
+      #
+      def self.installed?(command)
+        paths.any? do |bin_dir|
+          File.executable?(File.join(bin_dir,command))
+        end
+      end
+
+      #
+      # The detected download command.
+      #
+      # @return ['curl', 'wget', nil]
+      #
+      # @api private
+      #
+      def self.downloader
+        @downloader ||= if os == :macos then :curl
+                        else
+                          if    installed?('wget') then :wget
+                          elsif installed?('curl') then :curl
+                          end
+                        end
+      end
+
+      #
+      # Exception class that indicates a download failed.
+      #
+      class DownloadFailed < RuntimeError
+      end
+
+      #
+      # Downloads a file using either `curl` or `wget`.
+      #
+      # @param [URI::HTTP, String] url
+      #   The URL to download.
+      #
+      # @param [String] dest
+      #   The destination file or directory to download into.
+      #
+      # @return [String]
+      #   The path to the downloaded file.
+      #
+      # @raise [DownloadFailed]
+      #   The download failed or `curl`/`wget` could not be found on the system.
+      #
+      def self.download(url,dest)
+        uri = URI(url)
+        url = url.to_s
+
+        if File.directory?(dest)
+          dest = File.join(dest,File.basename(uri.path))
+        end
+
+        FileUtils.mkdir_p(File.dirname(dest))
+
+        partial_dest = "#{dest}.part"
+
+        case downloader
+        when :wget
+          unless system('wget','-c','-O',partial_dest,url)
+            raise(DownloadFailed,"wget command failed: wget -c -O #{partial_dest} #{url}")
+          end
+        when :curl
+          unless system('curl','-f','-L','-C','-','-o',partial_dest,url)
+            raise(DownloadFailed,"curl command failed: curl -f -L -C - -o #{partial_dest} #{url}")
+          end
+        when nil
+          raise(DownloadFailed,"could not find 'curl' or 'wget' on the system")
+        else
+          raise(NotImplementedError,"downloader not supported: #{downloader.inspect}")
+        end
+
+        FileUtils.mv(partial_dest,dest)
+        return dest
+      end
+    end
+  end
+end

data/lib/ronin/core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-core is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -19,6 +19,6 @@
 module Ronin
   module Core
     # ronin-core version
-    VERSION = '0.1.3'
+    VERSION = '0.2.0.rc1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-core
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0.rc1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reline
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: irb
   requirement: !ruby/object:Gem::Requirement
@@ -93,14 +93,17 @@ files:
 - examples/test_shell.rb
 - gemspec.yml
 - lib/ronin/core/class_registry.rb
+- lib/ronin/core/cli/banner.rb
 - lib/ronin/core/cli/command.rb
 - lib/ronin/core/cli/command_shell.rb
 - lib/ronin/core/cli/command_shell/command.rb
+- lib/ronin/core/cli/completion_command.rb
 - lib/ronin/core/cli/generator.rb
 - lib/ronin/core/cli/generator/options/author.rb
 - lib/ronin/core/cli/generator/options/description.rb
 - lib/ronin/core/cli/generator/options/reference.rb
 - lib/ronin/core/cli/generator/options/summary.rb
+- lib/ronin/core/cli/help/banner.rb
 - lib/ronin/core/cli/logging.rb
 - lib/ronin/core/cli/options/param.rb
 - lib/ronin/core/cli/options/values/arches.rb
@@ -120,6 +123,14 @@ files:
 - lib/ronin/core/metadata/references.rb
 - lib/ronin/core/metadata/summary.rb
 - lib/ronin/core/metadata/version.rb
+- lib/ronin/core/output_formats.rb
+- lib/ronin/core/output_formats/csv.rb
+- lib/ronin/core/output_formats/json.rb
+- lib/ronin/core/output_formats/ndjson.rb
+- lib/ronin/core/output_formats/output_dir.rb
+- lib/ronin/core/output_formats/output_file.rb
+- lib/ronin/core/output_formats/output_format.rb
+- lib/ronin/core/output_formats/txt.rb
 - lib/ronin/core/params.rb
 - lib/ronin/core/params/exceptions.rb
 - lib/ronin/core/params/mixin.rb
@@ -134,6 +145,7 @@ files:
 - lib/ronin/core/params/types/string.rb
 - lib/ronin/core/params/types/type.rb
 - lib/ronin/core/params/types/uri.rb
+- lib/ronin/core/system.rb
 - lib/ronin/core/version.rb
 - ronin-core.gemspec
 homepage: https://ronin-rb.dev/