ronin 0.1.2 → 0.1.3

data/lib/ronin/{object_context.rb → objectify/objectify.rb}

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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
@@ -21,37 +21,39 @@
 #++
 #
 
-require 'ronin/exceptions/unknown_object_context'
-require 'ronin/exceptions/object_context_not_found'
+require 'ronin/objectify/exceptions/unknown_object_context'
+require 'ronin/objectify/exceptions/object_context_not_found'
 require 'ronin/extensions/meta'
-require 'ronin/context'
 require 'ronin/model'
 
+require 'contextify'
 require 'parameters'
 
 module Ronin
-  module ObjectContext
+  module Objectify
     include DataMapper::Types
 
     def self.included(base)
-      base.class_eval do
-        include Context
+      base.module_eval do
+        include Contextify
         include Parameters
-        include Model
+        include Ronin::Model
 
-        # The Path to the object context
-        property :object_path, String, :key => true
+        # Path to the object context
+        property :object_path, String
 
-        # The modification timestamp of the object context
+        # Modification timestamp of the object context
         property :object_timestamp, EpochTime
 
         metaclass_def(:objectify) do |name|
-          ObjectContext.object_contexts[name] = self
+          name = name.to_s
 
-          contextify name
+          self.contextify name
 
-          meta_def(:load_object) do |path,*args|
-            ObjectContext.load_object(context_name,path,*args)
+          Objectify.object_contexts[name] = self
+
+          meta_def(:load_object) do |path,*attributes|
+            Objectify.load_object(self.context_name,path,*attributes)
           end
 
           meta_def(:cache) do |path,*args|
@@ -70,10 +72,10 @@ module Ronin
           end
 
           meta_def(:search) do |*attribs|
-            all(*attribs).map { |obj| obj.object }
+            all(*attribs).map { |obj| obj.load_object }
           end
 
-          # define Repo-level object loader method
+          # define Ronin-level object loader method
           Ronin.module_eval %{
             def ronin_load_#{name}(path,*args,&block)
               new_obj = #{self}.load_object(path,*args)
@@ -89,7 +91,7 @@ module Ronin
     #
     # Returns the Hash of all defined object-contexts.
     #
-    def ObjectContext.object_contexts
+    def Objectify.object_contexts
       @@ronin_object_contexts ||= {}
     end
 
@@ -97,23 +99,24 @@ module Ronin
     # Returns +true+ if there is an object-context defined with the
     # specified _name_, returns +false+ otherwise.
     #
-    def ObjectContext.is_object_context?(name)
-      ObjectContext.object_contexts.has_key?(name.to_sym)
+    def Objectify.is_object_context?(name)
+      Objectify.object_contexts.has_key?(name.to_sym)
     end
 
     #
     # Loads the object context of the specified _name_ and from the
-    # specified _path_ with the given _args_. If no object contexts were
-    # defined with the specified _name_, an UnknownObjectContext
+    # specified _path_ with the given _attributes_. If no object contexts
+    # were defined with the specified _name_, an UnknownObjectContext
     # exception will be raised.
     #
-    #   ObjectContext.load_object(:note,'/path/to/my_notes.rb') # => Note
+    #   Objectify.load_object(:note,'/path/to/my_notes.rb')
+    #   # => #<Note:...>
     #
-    def ObjectContext.load_object(name,path,*args,&block)
-      name = name.to_sym
+    def Objectify.load_object(name,path,*attributes,&block)
+      name = name.to_s
 
-      unless ObjectContext.is_object_context?(name)
-        raise(UnknownObjectContext,"unknown object context '#{name}'",caller)
+      unless Objectify.is_object_context?(name)
+        raise(UnknownObjectContext,"unknown object context #{name.dump}",caller)
       end
 
       path = File.expand_path(path)
@@ -122,7 +125,7 @@ module Ronin
         raise(ObjectContextNotFound,"object context #{path.dump} does not exist",caller)
       end
 
-      new_obj = Context.load_context(name,path,*args)
+      new_obj = Contextify.load_context(name,path,*attributes)
       new_obj.object_path = path
 
       block.call(new_obj) if block
@@ -134,16 +137,16 @@ module Ronin
     # +Array+ of loaded object contexts. If a _block_ is given, it will
     # be passed each loaded object context.
     #
-    #   Context.load_contexts('/path/to/misc_contexts.rb') # => [...]
+    #   Objectify.load_contexts('/path/to/misc_contexts.rb') # => [...]
     #
-    def ObjectContext.load_objects(path,&block)
+    def Objectify.load_objects(path,&block)
       path = File.expand_path(path)
 
       unless File.file?(path)
         raise(ObjectContextNotFound,"object context #{path.dump} does not exist",caller)
       end
 
-      return Context.load_contexts(path) do |new_obj|
+      return Contextify.load_contexts(path) do |new_obj|
         new_obj.object_path = path
 
         block.call(new_obj) if block
@@ -153,8 +156,8 @@ module Ronin
     #
     # Cache all objects loaded from the specified _path_.
     #
-    def ObjectContext.cache_objects(path)
-      ObjectContext.load_objects(path).each do |obj|
+    def Objectify.cache_objects(path)
+      Objectify.load_objects(path).each do |obj|
         obj.cache
       end
 
@@ -165,11 +168,11 @@ module Ronin
     # Cache all objects loaded from the paths within the specified
     # _directory_.
     #
-    def ObjectContext.cache_objects_in(directory)
+    def Objectify.cache_objects_in(directory)
       directory = File.expand_path(directory)
       paths = Dir[File.join(directory,'**','*.rb')]
 
-      paths.each { |path| ObjectContext.cache_objects(path) }
+      paths.each { |path| Objectify.cache_objects(path) }
       return nil
     end
 
@@ -178,11 +181,11 @@ module Ronin
     # the specified _directory_. Also cache objects which have yet to
     # be cached.
     #
-    def ObjectContext.mirror_objects_in(directory)
+    def Objectify.mirror_objects_in(directory)
       directory = File.expand_path(directory)
       new_paths = Dir[File.join(directory,'**','*.rb')]
 
-      ObjectContext.object_contexts.each_value do |base|
+      Objectify.object_contexts.each_value do |base|
         objects = base.all(:object_path.like => "#{directory}%")
         new_paths -= objects.map { |obj| obj.object_path }
 
@@ -191,17 +194,17 @@ module Ronin
       end
 
       # cache the remaining new paths
-      new_paths.each { |path| ObjectContext.cache_objects(path) }
+      new_paths.each { |path| Objectify.cache_objects(path) }
       return nil
     end
 
     #
     # Deletes all cached objects that existed in the specified _directory_.
     #
-    def ObjectContext.expunge_objects_from(directory)
+    def Objectify.expunge_objects_from(directory)
       directory = File.expand_path(directory)
 
-      ObjectContext.object_contexts.each_value do |base|
+      Objectify.object_contexts.each_value do |base|
         base.all(:object_path.like => "#{directory}%").destroy!
       end
 
@@ -209,11 +212,17 @@ module Ronin
     end
 
     #
-    # Returns a new object loaded from the file pointed to by the
-    # +object_path+ property.
+    # Loads a new object from the file pointed to by the +object_path+
+    # property.
     #
-    def object
-      self.class.load_object(self.object_path)
+    def load_object
+      primary_keys = {}
+
+      key_properties.each do |prop|
+        primary_keys[prop.name] = attribute_get(prop.name)
+      end
+
+      new_obj = self.class.load_object(self.object_path,primary_keys)
     end
 
     #
@@ -267,7 +276,7 @@ module Ronin
         else
           if (!(dirty?) && stale?)
             destroy
-            return object.cache
+            return load_object.cache
           end
         end
       end

data/lib/ronin/path.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/platform.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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
@@ -23,12 +23,14 @@
 
 require 'ronin/model'
 require 'ronin/extensions/meta'
+require 'ronin/extensions/string'
 
 module Ronin
   class Platform
 
     include Model
 
+    # Primary key
     property :id, Serial
 
     # Name of the Operating System

data/lib/ronin/product.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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
@@ -30,6 +30,7 @@ module Ronin
 
     include Model
 
+    # Primary key
     property :id, Serial
 
     # Name

data/lib/ronin/ronin.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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
@@ -21,22 +21,22 @@
 #++
 #
 
-require 'ronin/object_context'
-require 'ronin/console'
+require 'ronin/objectify'
+require 'ronin/ui/console'
 
 module Ronin
   #
-  # See ObjectContext.load_objects.
+  # See Objectify.load_objects.
   #
-  def Ronin.ronin_load_objects(path)
-    ObjectContext.load_objects(path)
+  def Ronin.load_objects(path)
+    Objectify.load_objects(path)
   end
 
   #
-  # See ObjectContext.load_object.
+  # See Objectify.load_object.
   #
-  def Ronin.ronin_load_object(type,path)
-    ObjectContext.load_object(type,path)
+  def Ronin.load_object(type,path)
+    Objectify.load_object(type,path)
   end
 
   #
@@ -44,6 +44,6 @@ module Ronin
   # it will be ran within the console.
   #
   def Ronin.console(script=nil,&block)
-    Console.start(script,&block)
+    UI::Console.start(script,&block)
   end
 end

data/lib/ronin/rpc.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/call.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/client.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/console.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/exceptions.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/exceptions/not_implemented.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/exceptions/response_missing.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/response.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/service.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/rpc/shell.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/sessions.rb

@@ -3,7 +3,7 @@
 # Ronin - A Ruby platform designed for information security and data
 # exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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

data/lib/ronin/sessions/esmtp.rb

@@ -3,7 +3,7 @@
 # Ronin - A ruby development platform designed for information security
 # and data exploration tasks.
 #
-# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2009 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
@@ -30,8 +30,8 @@ module Ronin
       include Session
 
       setup_session do
-        parameter :esmtp_host, :description => 'ESMTP host'
-        parameter :esmtp_port, :description => 'ESMTP port'
+        parameter :host, :description => 'ESMTP host'
+        parameter :port, :description => 'ESMTP port'
 
         parameter :esmtp_login, :description => 'ESMTP login'
         parameter :esmtp_user, :description => 'ESMTP user'
@@ -45,16 +45,14 @@ module Ronin
       end
 
       def esmtp_connect(options={},&block)
-        unless @esmtp_host
-          raise(ParamNotFound,"Missing parameter #{describe_param(:esmtp_host).dump}",caller)
-        end
+        require_params :host
 
-        options[:port] ||= @esmtp_port
+        options[:port] ||= @port
         options[:login] ||= @esmtp_login
         options[:user] ||= @esmtp_user
         options[:password] ||= @esmtp_password
 
-        return ::Net.esmtp_connect(@esmtp_host,options,&block)
+        return ::Net.esmtp_connect(@host,options,&block)
       end
 
       def esmtp_session(options={},&block)