ronin 1.3.0 → 1.4.0.rc1

data/lib/ronin/ui/cli/script_command.rb

@@ -21,6 +21,8 @@ require 'ronin/ui/cli/model_command'
 require 'ronin/ui/console'
 require 'ronin/script'
 
+require 'parameters/options'
+
 module Ronin
   module UI
     module CLI
@@ -29,17 +31,79 @@ module Ronin
       #
       class ScriptCommand < ModelCommand
 
-        query_option :named, :type => :string, :aliases => '-n'
-        query_option :describing, :type => :string, :aliases => '-d'
-        query_option :revision, :type => :string, :aliases => '-V'
-        query_option :licensed_under, :type => :string, :aliases => '-L'
+        usage '[options] --'
+
+        query_option :named, :type  => String,
+                             :flag  => '-n',
+                             :usage => 'NAME'
+
+        query_option :describing, :type  => String,
+                                  :flag  => '-d',
+                                  :usage => 'DESC'
+
+        query_option :revision, :type  => String,
+                                :flag  => '-V',
+                                :usage => 'REV'
+
+        query_option :licensed_under, :type  => String,
+                                      :flag  => '-L',
+                                      :usage => 'LICENSE'
+
+        option :file, :type  => String,
+                      :flag  => '-f',
+                      :usage => 'FILE'
+
+        option :console, :type => true
 
-        class_option :file, :type => :string, :aliases => '-f'
-        class_option :params, :type => :hash,
-                              :default => {},
-                              :banner => 'NAME:VALUE ...',
-                              :aliases => '-p'
-        class_option :console, :type => :boolean, :default => false
+        argument :param_options, :type        => Array,
+                                 :default     => [],
+                                 :description => 'Additional options'
+
+        #
+        # Initializes the Script command.
+        #
+        # @param [Hash{Symbol => Object}] options
+        #   Options for the script command.
+        #
+        # @api semipublic
+        #
+        def initialize(options={})
+          super(options)
+
+          @script_options = []
+        end
+
+        #
+        # Starts the script command.
+        #
+        # @param [Array<String>] argv
+        #   Command-line arguments for the script command.
+        #
+        # @since 1.4.0
+        #
+        # @api semipublic
+        #
+        def start(argv=ARGV)
+          # collect the script options, upto the -- separator
+          @script_options = argv[0,argv.index('--') || argv.length]
+
+          super(argv)
+        end
+
+        #
+        # Sets up the script command, loads the script and parses additional
+        # options for the script.
+        #
+        # @since 1.4.0
+        #
+        # @api semipublic
+        #
+        def setup
+          super
+
+          load!
+          param_option_parser.parse(@param_options)
+        end
 
         #
         # Loads the script, sets its parameters and runs the script.
@@ -49,15 +113,12 @@ module Ronin
         # @api semipublic
         #
         def execute
-          script = load_script
-          script.params = options[:params]
-
-          if options.console?
+          if @console
             print_info "Starting the console with @script set ..."
 
-            UI::Console.start(:script => script)
+            UI::Console.start(:script => @script)
           else
-            script.run
+            @script.run
           end
         end
 
@@ -79,12 +140,12 @@ module Ronin
         #
         # @api semipublic
         #
-        def self.script_class(script)
-          unless script.included_modules.include?(Script)
+        def self.script_class(script=nil)
+          if (script && !script.included_modules.include?(Script))
             raise(ArgumentError,"#{script} does not include Ronin::Script")
           end
 
-          model(script)
+          return model(script)
         end
 
         #
@@ -101,11 +162,52 @@ module Ronin
         #
         # @api semipublic
         #
-        def load_script
-          if options[:file]
-            self.class.model.load_from(options[:file])
-          else
-            query.load_first
+        def load!
+          @script = if @file
+                      self.class.model.load_from(@file)
+                    else
+                      query.load_first
+                    end
+
+          unless @script
+            print_error "Could not find or load the #{self.class.script_class.short_name}"
+            exit -1
+          end
+        end
+
+        #
+        # Creates an OptionParser based on the parameters of one or more
+        # objects.
+        #
+        # @param [Array<Parameters>] objects
+        #   The objects that have parameters.
+        #
+        # @yield [opts]
+        #   If a block is given, it will be passed the newly created
+        #   OptionParser.
+        #
+        # @yieldparam [OptionParser] opts
+        #   The newly created OptionParser for the parameters.
+        #
+        # @return [OptionParser]
+        #   The configured OptionParser for the parameters.
+        #
+        # @since 1.4.0
+        #
+        # @api semipublic
+        #
+        def param_option_parser
+          OptionParser.new do |opts|
+            opts.banner = "usage: #{self.class.command_name} #{@script_options.join(' ')} -- [script_options]"
+            
+            opts.separator ''
+            opts.separator "#{self.class.script_class.short_name} Options:"
+
+            @script.each_param do |param|
+              Parameters::Options.define(opts,param)
+            end
+
+            yield opts if block_given?
           end
         end
 

data/lib/ronin/ui/console/commands.rb

@@ -41,6 +41,9 @@ module Ronin
           end
         end
 
+        # Prefixes that denote a command, instead of Ruby code.
+        PREFIXES = Set['!', '.']
+
         # Blacklist of known commands that conflict with Ruby keywords.
         BLACKLIST = Set[
           '[', 'ap', 'begin', 'case', 'class', 'def', 'fail', 'false',
@@ -56,7 +59,7 @@ module Ronin
         #   The input from the console.
         #
         def loop_eval(input)
-          if input[0,1] == '!'
+          if PREFIXES.include?(input[0,1])
             command = input[1..-1]
             name, arguments = command.split(' ')
 

data/lib/ronin/ui/console/console.rb

@@ -88,7 +88,7 @@ module Ronin
       end
 
       #
-      # Enables or disables the printing of one-lin errors.
+      # Enables or disables the printing of one-line errors.
       #
       # @param [Boolean] mode
       #   The new Console short-errors setting.

data/lib/ronin/ui/console/context.rb

@@ -64,7 +64,7 @@ module Ronin
           #
           def instance_variables=(variables)
             variables.each do |name,value|
-              instance_variable_set("@#{name}".to_sym,value)
+              instance_variable_set(:"@#{name}",value)
             end
           end
 

data/lib/ronin/url.rb

@@ -23,7 +23,6 @@ require 'ronin/url_scheme'
 require 'ronin/url_query_param'
 require 'ronin/host_name'
 require 'ronin/tcp_port'
-require 'ronin/web_credential'
 
 require 'dm-timestamps'
 require 'uri/generic'
@@ -223,11 +222,11 @@ module Ronin
     # @return [Array<URL>]
     #   The URLs with the given query param.
     #
-    # @since 1.0.0
+    # @since 1.4.0
     #
     # @api public
     #
-    def self.query_param(name)
+    def self.with_query_param(name)
       all('query_params.name.name' => name)
     end
 
@@ -240,14 +239,34 @@ module Ronin
     # @return [Array<URL>]
     #   The URLs with the given query param value.
     #
-    # @since 1.0.0
+    # @since 1.4.0
     #
     # @api public
     #
-    def self.query_value(value)
+    def self.with_query_value(value)
       all('query_params.value' => value)
     end
 
+    #
+    # @deprecated
+    #   Deprecated as of 1.4.0 and will be removed in 2.0.0.
+    #
+    # @see with_query_param
+    #
+    def self.query_param(name)
+      with_query_param(name)
+    end
+
+    #
+    # @deprecated
+    #   Deprecated as of 1.4.0 and will be removed in 2.0.0.
+    #
+    # @see with_query_value
+    #
+    def self.query_value(value)
+      with_query_value(name)
+    end
+
     #
     # Searches for a URL.
     #

data/lib/ronin/url_query_param.rb

@@ -17,7 +17,6 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/url_query_param_name'
 require 'ronin/model'
 
 require 'uri/query_params'

data/lib/ronin/version.rb

@@ -19,5 +19,5 @@
 
 module Ronin
   # Ronin version 
-  VERSION = '1.3.0'
+  VERSION = '1.4.0.rc1'
 end

data/lib/ronin/web_credential.rb

@@ -18,8 +18,6 @@
 #
 
 require 'ronin/credential'
-require 'ronin/email_address'
-require 'ronin/url'
 
 module Ronin
   #
@@ -27,9 +25,6 @@ module Ronin
   #
   class WebCredential < Credential
 
-    # The optional email address the credential is associated with.
-    belongs_to :email_address, :required => false
-
     # The URL the credential can be used with.
     belongs_to :url, :required => false,
                      :model => 'URL'

data/spec/email_address_spec.rb

@@ -49,6 +49,23 @@ describe EmailAddress do
     end
   end
 
+  describe "from" do
+    it "should accept Strings" do
+      email_address = described_class.from(email)
+
+      email_address.user_name.name.should == user
+      email_address.host_name.address.should == host
+    end
+
+    it "should accept URI::MailTo objects" do
+      uri = URI("mailto:#{email}")
+      email_address = described_class.from(uri)
+
+      email_address.user_name.name.should == user
+      email_address.host_name.address.should == host
+    end
+  end
+
   it "should provide the user-name" do
     subject.user.should == user
   end

data/spec/installation_spec.rb

@@ -10,24 +10,29 @@ describe Installation do
     subject.libraries.should include('ronin')
   end
 
+  let(:directory) { 'lib/ronin/ui/cli/commands' }
+  let(:files) {
+    %w[
+      campaigns.rb
+      console.rb
+      creds.rb
+      database.rb
+      emails.rb
+      exec.rb
+      help.rb
+      hosts.rb
+      install.rb
+      ips.rb
+      repos.rb
+      update.rb
+      urls.rb
+      uninstall.rb
+    ]
+  }
+
   describe "each_file" do
-    let(:directory) { 'lib/ronin/ui/cli/commands' }
-    let(:pattern) { File.join(directory,'*.rb') }
-    let(:expected) {
-      %w[
-        campaigns.rb
-        console.rb
-        creds.rb
-        database.rb
-        emails.rb
-        exec.rb
-        help.rb
-        hosts.rb
-        ips.rb
-        repos.rb
-        urls.rb
-      ].map { |name| File.join(directory,name) }
-    }
+    let(:pattern)  { File.join(directory,'*.rb') }
+    let(:expected) { files.map { |name| File.join(directory,name) } }
 
     it "should enumerate over the files which match a glob pattern" do
       subject.each_file(pattern).to_a.should =~ expected
@@ -41,23 +46,8 @@ describe Installation do
   end
 
   describe "each_file_in" do
-    let(:directory) { 'lib/ronin/ui/cli/commands' }
-    let(:ext) { :rb }
-    let(:expected) {
-      %w[
-        campaigns.rb
-        console.rb
-        creds.rb
-        database.rb
-        emails.rb
-        exec.rb
-        help.rb
-        hosts.rb
-        ips.rb
-        repos.rb
-        urls.rb
-      ]
-    }
+    let(:ext)      { :rb }
+    let(:expected) { files }
 
     it "should enumerate over the files which match a glob pattern" do
       subject.each_file_in(directory,ext).to_a.should =~ expected

data/spec/model/has_authors_spec.rb

@@ -1,4 +1,4 @@
-require 'model/spec_helper'
+require 'spec_helper'
 require 'model/models/authored_model'
 
 require 'ronin/model/has_authors'

data/spec/model/has_description_spec.rb

@@ -1,4 +1,4 @@
-require 'model/spec_helper'
+require 'spec_helper'
 require 'model/models/described_model'
 
 require 'ronin/model/has_description'

data/spec/model/has_license_spec.rb

@@ -1,4 +1,4 @@
-require 'model/spec_helper'
+require 'spec_helper'
 require 'model/models/licensed_model'
 
 require 'ronin/model/has_license'

data/spec/model/has_name_spec.rb

@@ -1,4 +1,4 @@
-require 'model/spec_helper'
+require 'spec_helper'
 require 'model/models/named_model'
 
 require 'ronin/model/has_name'