ronin 0.1.1 → 0.1.2

data/lib/ronin/program/command.rb

@@ -1,203 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/program/options'
-require 'ronin/program/program'
-require 'ronin/extensions/meta'
-
-module Ronin
-  module Program
-    class Command
-
-      #
-      # Creates a new Command object. If a _block_ is given,
-      # it will be passed newly created Command object.
-      #
-      def initialize(&block)
-        @options = nil
-
-        block.call(self) if block
-      end
-
-      #
-      # Returns the name of the command.
-      #
-      def Command.command_name
-        ''
-      end
-
-      #
-      # Returns the short names of the command.
-      #
-      def Command.command_short_names
-        []
-      end
-
-      #
-      # Returns all the names of the command.
-      #
-      def self.command_names
-        [self.command_name] + self.command_short_names
-      end
-
-      #
-      # Creates a new command object and runs it with the
-      # given _args_.
-      #
-      def self.run(*args)
-        self.new.run(*args)
-      end
-
-      #
-      # Prints the help information for the command.
-      #
-      def self.help
-        self.new.help
-      end
-
-      #
-      # Returns the name of the command.
-      #
-      def command_name
-        self.class.command_name
-      end
-
-      #
-      # Returns the short names of the command.
-      #
-      def command_short_names
-        self.class.command_short_names
-      end
-
-      #
-      # Returns all the names of the command.
-      #
-      def command_names
-        self.class.command_names
-      end
-
-      #
-      # Runs the command with the given _args_. If a _block_ is
-      # given, it will be called after the specified _args_ have
-      # been parsed and the command has run.
-      #
-      def run(*args,&block)
-        arguments(*(options.parse(args)))
-
-        @options = nil
-
-        block.call if block
-        return self
-      end
-
-      #
-      # Prints the help information for the command.
-      #
-      def help
-        options.help
-        return self
-      end
-
-      #
-      # Returns the String form of the command.
-      #
-      def to_s
-        names.join(', ')
-      end
-
-      protected
-
-      #
-      # Registers the command with the specified _name_ and the given
-      # _short_names_.
-      #
-      def self.command(name,*short_names)
-        name = name.to_s
-        short_names = short_names.map { |short_name| short_name.to_s }
-
-        meta_def(:command_name) { name }
-        meta_def(:command_short_names) { short_names }
-
-        # register the command
-        Program.commands << self unless Program.commands.include?(self)
-
-        # register the command by name
-        Program.commands_by_name[name] = self
-
-        # register the command by it's short_names
-        short_names.each do |short_name|
-          Program.commands_by_name[short_name] = self
-        end
-
-        return self
-      end
-
-      #
-      # Defines the options of the command with the specified _usage_ and
-      # _block_.
-      #
-      def self.options(usage=nil,&block)
-        class_def(:options) do
-          @options ||= Options.command(:ronin,self.command_name,usage,&block)
-        end
-
-        return self
-      end
-
-      #
-      # Returns the options of the command.
-      #
-      def options
-        @options ||= Options.command(:ronin,command_name)
-      end
-
-      #
-      # See Program.error.
-      #
-      def error(message)
-        Program.error(message)
-      end
-
-      #
-      # See Program.success.
-      #
-      def success(&block)
-        Program.success(&block)
-      end
-
-      #
-      # See Program.fail.
-      #
-      def fail(*messages,&block)
-        Program.fail(*messages,&block)
-      end
-
-      #
-      # Processes the additional arguments specified by _args_.
-      #
-      def arguments(*args)
-      end
-
-    end
-  end
-end

data/lib/ronin/program/commands/add.rb

@@ -1,71 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2007 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/program/command'
-require 'ronin/cache/overlay'
-
-module Ronin
-  module Program
-    class AddCommand < Command
-
-      command :add
-
-      options('PATH [options]') do |opts|
-        opts.settings.media = nil
-        opts.settings.uri = nil
-
-        opts.options do
-          opts.on('-m','--media MEDIA','Spedify the media-type of the repository') do |media|
-            opts.settings.media = media
-          end
-
-          opts.on('-U','--uri URI','Specify the source URI of the repository') do |uri|
-            opts.settings.uri = uri
-          end
-        end
-
-        opts.arguments do
-          opts.arg('PATH','Add the repository located at the specified PATH')
-        end
-
-        opts.summary('Add a local repository located at the specified PATH to the repository cache')
-
-      end
-
-      def arguments(*args)
-        unless args.length==1
-          fail('add: only one repository path maybe specified')
-        end
-
-        path = args.first
-
-        Cache::Overlay.save_cache do
-          Cache::Overlay.add(path,options.settings.media,options.settings.uri) do |repo|
-            puts "Overlay #{repo} added."
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/ronin/program/commands/list.rb

@@ -1,79 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2007 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/program/command'
-require 'ronin/cache/overlay'
-
-module Ronin
-  module Program
-    class ListCommand < Command
-
-      command :list, :ls
-
-      options('[NAME ...] [options]') do |opts|
-        opts.options
-
-        opts.arguments do
-          opts.arg('NAME','Overlay to display')
-        end
-
-        opts.summary('Display all or the specified repositories within the repository cache')
-      end
-
-      def arguments(*args)
-        if args.empty?
-          # list all repositories by name
-          Cache::Overlay.each do |repo|
-            puts "  #{repo}"
-          end
-        else
-          # list specified repositories
-          args.each do |name|
-            repo = Cache::Overlay.get(name)
-
-            puts "[ #{repo} ]\n\n"
-
-            puts "  path: #{repo.path}" if options.settings.verbose
-            puts "  media: #{repo.media}"
-            puts "  uri: #{repo.uri}" if repo.uri
-
-            if repo.description
-              puts "  description:\n\n    #{repo.description}"
-            end
-
-            puts "\n"
-
-            if options.settings.verbose
-              puts "  extensions:\n\n"
-
-              repo.each_extension do |ext|
-                puts "    #{ext}"
-              end
-            end
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/ronin/program/options.rb

@@ -1,201 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program 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 General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-#++
-#
-
-require 'ronin/program/program'
-
-require 'optparse'
-require 'ostruct'
-
-module Ronin
-  module Program
-    class Options
-
-      # Settings used by the options
-      attr_reader :settings
-
-      #
-      # Creates a new Options object with the specified _program_ name
-      # and the given _banner_. If a _block_ is given, it will be passed
-      # the newly created Options object.
-      #
-      def initialize(program,banner=nil,&block)
-        @settings = OpenStruct.new
-        @settings.verbose = false
-
-        @help_block = proc { help }
-
-        @verbose_block = proc {
-          @settings.verbose = true
-        }
-
-        @parser = OptionParser.new do |opts|
-          if banner
-            opts.banner = "Usage: #{program} #{banner}"
-            opts.separator ''
-          end
-        end
-
-        block.call(self) if block
-      end
-
-      #
-      # Creates a new Options object for a Command with the specified
-      # _program_ name, command _name_ and the given _banner_. If a _block_
-      # is given, it will be passed the newly created Options object.
-      #
-      def Options.command(program,name,banner=nil,&block)
-        return Options.new(program,"#{name} #{banner}",&block) if banner
-        return Options.new(program,name,&block)
-      end
-
-      #
-      # Call the specified _block_ when the given option _flags_ are parsed.
-      #
-      def on(*flags,&block)
-        @parser.on(*flags,&block)
-        return self
-      end
-
-      #
-      # Calls the specified _block_ when the verbose option flag is parsed.
-      #
-      def on_verbose(&block)
-        @verbose_block = block
-        return self
-      end
-
-      #
-      # Calls the specified _block_ when the help option-flag is parsed.
-      #
-      def on_help(&block)
-        @help_block = block
-        return self
-      end
-
-      #
-      # Adds a section separator with the specified _text_.
-      #
-      def separator(text)
-        @parser.separator(text)
-        return self
-      end
-
-      #
-      # Adds an options section to the help message. If a _block_ is given
-      # it will be called before any default options are added.
-      #
-      def options(&block)
-        @parser.separator '  Options:'
-
-        block.call(self) if block
-
-        @parser.on('-v','--verbose','produce excess output',&(@verbose_block))
-        @parser.on('-h','--help','print this message',&(@help_block))
-        @parser.separator ''
-
-        return self
-      end
-
-      #
-      # Adds an the argument with the specified _name_ and _description_
-      # to the arguments section of the help message of these options.
-      #
-      def arg(name,description)
-        @parser.separator "    #{name}\t#{description}"
-        return self
-      end
-
-      #
-      # Creates an arguments section in the help message and calls the
-      # given _block_.
-      #
-      def arguments(&block)
-        if block
-          @parser.separator '  Arguments:'
-
-          block.call(self)
-
-          @parser.separator ''
-        end
-
-        return self
-      end
-
-      #
-      # Addes a summary section with the specified _lines_.
-      #
-      def summary(*lines)
-        @parser.separator '  Summary:'
-
-        lines.each { |line| @parser.separator "    #{line}" }
-
-        @parser.separator ''
-        return self
-      end
-
-      #
-      # Adds a defaults section with the specified _flags_.
-      #
-      def defaults(*flags)
-        @parser.separator '  Defaults:'
-
-        flags.each { |flag| @parser.separator "    #{flag}" }
-
-        @parser.separator ''
-        return self
-      end
-
-      #
-      # Prints the help message and exits successfully. If a _block_ is
-      # given it will be called after the help message has been print
-      # and before the Program has exited.
-      #
-      def help(&block)
-        Program.success do
-          puts @parser
-
-          block.call(self) if block
-        end
-      end
-
-      #
-      # Parses the specified _argv_ Array. If a _block_ is given it will
-      # be passed the left-over arguments. Returns the left-over arguments.
-      #
-      def parse(argv,&block)
-        args = @parser.parse(argv)
-
-        block.call(self,args) if block
-        return args
-      end
-
-      #
-      # Returns a String representation of the OptParse parser.
-      #
-      def to_s
-        @parser.to_s
-      end
-
-    end
-  end
-end