metasploit-model 0.27.3 → 0.27.4

data/lib/metasploit/model/authority.rb

@@ -1,148 +1,141 @@
-require 'metasploit/model/search'
-require 'metasploit/model/translation'
-
-module Metasploit
-  module Model
-    # Code shared between `Mdm::Authority` and `Metasploit::Framework::Authority`.
-    module Authority
-      extend ActiveModel::Naming
-      extend ActiveSupport::Autoload
-      extend ActiveSupport::Concern
-
-      include Metasploit::Model::Translation
-
-      autoload :Bid
-      autoload :Cve
-      autoload :Msb
-      autoload :Osvdb
-      autoload :Pmasa
-      autoload :Secunia
-      autoload :UsCertVu
-      autoload :Waraxe
-      autoload :Zdi
-
-      included do
-        include ActiveModel::MassAssignmentSecurity
-        include ActiveModel::Validations
-        include Metasploit::Model::Search
-
-        #
-        # Mass Assignment Security
-        #
-
-        attr_accessible :abbreviation
-        attr_accessible :obsolete
-        attr_accessible :summary
-        attr_accessible :url
-
-        #
-        # Search Attributes
-        #
-
-        search_attribute :abbreviation, :type => :string
-
-        #
-        # Validations
-        #
-
-        validates :abbreviation,
-                  :presence => true
-      end
-
-      #
-      # Associations
-      #
-
-      # @!attribute [rw] references
-      #   {Metasploit::Model::Reference References} that use this authority's scheme for their
-      #   {Metasploit::Model::Reference#authority}.
-      #
-      #   @return [Array<Metasploit::Model::Reference>]
-
-      # @!attribute [r] module_instances
-      #   {Metasploit::Model::Module::Instance Modules} that have a reference with this authority.
-      #
-      #   @return [Array<Metasploit::Model::Module::Instance>]
-
-      # @!attribute [r] vulns
-      #   Vulnerabilities that have a reference under this authority.
-      #
-      #   @return [Array<Metasploit::Model::Vuln>]
-
-      #
-      # Attributes
-      #
-
-      # @!attribute [rw] abbreviation
-      #   Abbreviation or initialism for authority, such as CVE for 'Common Vulnerability and Exposures'.
-      #
-      #   @return [String]
-
-      # @!attribute [rw] obsolete
-      #   Whether this authority is obsolete and no longer exists on the internet.
-      #
-      #   @return [false]
-      #   @return [true] {#url} may be `nil` because authory no longer has a web site.
-
-      # @!attribute [rw] summary
-      #   An expansion of the {#abbreviation}.
-      #
-      #   @return [String, nil]
-
-      # @!attribute [rw] url
-      #   URL to the authority's home page or root URL for their {#references} database.
-      #
-      #   @return [String, nil]
-
-      #
-      # Instance Methods
-      #
-
-      # Returns the {Metasploit::Model::Reference#url URL} for a {Metasploit::Model::Reference#designation designation}.
-      #
-      # @param designation [String] {Metasploit::Model::Reference#designation}.
-      # @return [String] {Metasploit::Model::Reference#url}
-      # @return [nil] if this {Metasploit::Model::Authority} is {#obsolete}.
-      # @return [nil] if this {Metasploit::Model::Authority} does have a way to derive URLS from designations.
-      def designation_url(designation)
-        url = nil
-
-        if extension
-          url = extension.designation_url(designation)
-        end
-
-        url
-      end
-
-      # Returns module that include authority specific methods.
-      #
-      # @return [Module] if {#abbreviation} has a corresponding module under the Metasploit::Model::Authority namespace.
-      # @return [nil] otherwise.
-      def extension
-        begin
-          extension_name.constantize
-        rescue NameError
-          nil
-        end
-      end
-
-      # Returns name of module that includes authority specific methods.
-      #
-      # @return [String] unless {#abbreviation} is blank.
-      # @return [nil] if {#abbreviation} is blank.
-      def extension_name
-        extension_name = nil
-
-        unless abbreviation.blank?
-          # underscore before camelize to eliminate -'s
-          relative_model_name = abbreviation.underscore.camelize
-          # don't scope to self.class.name so that authority extension are always resolved the same in Mdm and
-          # Metasploit::Framework.
-          extension_name = "Metasploit::Model::Authority::#{relative_model_name}"
-        end
-
-        extension_name
-      end
+# Code shared between `Mdm::Authority` and `Metasploit::Framework::Authority`.
+module Metasploit::Model::Authority
+  extend ActiveModel::Naming
+  extend ActiveSupport::Autoload
+  extend ActiveSupport::Concern
+
+  include Metasploit::Model::Translation
+
+  autoload :Bid
+  autoload :Cve
+  autoload :Msb
+  autoload :Osvdb
+  autoload :Pmasa
+  autoload :Secunia
+  autoload :UsCertVu
+  autoload :Waraxe
+  autoload :Zdi
+
+  included do
+    include ActiveModel::MassAssignmentSecurity
+    include ActiveModel::Validations
+    include Metasploit::Model::Search
+
+    #
+    # Mass Assignment Security
+    #
+
+    attr_accessible :abbreviation
+    attr_accessible :obsolete
+    attr_accessible :summary
+    attr_accessible :url
+
+    #
+    # Search Attributes
+    #
+
+    search_attribute :abbreviation, :type => :string
+
+    #
+    # Validations
+    #
+
+    validates :abbreviation,
+              :presence => true
+  end
+
+  #
+  # Associations
+  #
+
+  # @!attribute [rw] references
+  #   {Metasploit::Model::Reference References} that use this authority's scheme for their
+  #   {Metasploit::Model::Reference#authority}.
+  #
+  #   @return [Array<Metasploit::Model::Reference>]
+
+  # @!attribute [r] module_instances
+  #   {Metasploit::Model::Module::Instance Modules} that have a reference with this authority.
+  #
+  #   @return [Array<Metasploit::Model::Module::Instance>]
+
+  # @!attribute [r] vulns
+  #   Vulnerabilities that have a reference under this authority.
+  #
+  #   @return [Array<Metasploit::Model::Vuln>]
+
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] abbreviation
+  #   Abbreviation or initialism for authority, such as CVE for 'Common Vulnerability and Exposures'.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] obsolete
+  #   Whether this authority is obsolete and no longer exists on the internet.
+  #
+  #   @return [false]
+  #   @return [true] {#url} may be `nil` because authory no longer has a web site.
+
+  # @!attribute [rw] summary
+  #   An expansion of the {#abbreviation}.
+  #
+  #   @return [String, nil]
+
+  # @!attribute [rw] url
+  #   URL to the authority's home page or root URL for their {#references} database.
+  #
+  #   @return [String, nil]
+
+  #
+  # Instance Methods
+  #
+
+  # Returns the {Metasploit::Model::Reference#url URL} for a {Metasploit::Model::Reference#designation designation}.
+  #
+  # @param designation [String] {Metasploit::Model::Reference#designation}.
+  # @return [String] {Metasploit::Model::Reference#url}
+  # @return [nil] if this {Metasploit::Model::Authority} is {#obsolete}.
+  # @return [nil] if this {Metasploit::Model::Authority} does have a way to derive URLS from designations.
+  def designation_url(designation)
+    url = nil
+
+    if extension
+      url = extension.designation_url(designation)
+    end
+
+    url
+  end
+
+  # Returns module that include authority specific methods.
+  #
+  # @return [Module] if {#abbreviation} has a corresponding module under the Metasploit::Model::Authority namespace.
+  # @return [nil] otherwise.
+  def extension
+    begin
+      extension_name.constantize
+    rescue NameError
+      nil
     end
   end
-end
+
+  # Returns name of module that includes authority specific methods.
+  #
+  # @return [String] unless {#abbreviation} is blank.
+  # @return [nil] if {#abbreviation} is blank.
+  def extension_name
+    extension_name = nil
+
+    unless abbreviation.blank?
+      # underscore before camelize to eliminate -'s
+      relative_model_name = abbreviation.underscore.camelize
+      # don't scope to self.class.name so that authority extension are always resolved the same in Mdm and
+      # Metasploit::Framework.
+      extension_name = "Metasploit::Model::Authority::#{relative_model_name}"
+    end
+
+    extension_name
+  end
+end

data/lib/metasploit/model/authority/bid.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # BugTraq ID authority-specific code.
 module Metasploit::Model::Authority::Bid
   # Returns URL to {Metasploit::Model::Reference#designation BugTraq ID's} page on SecurityFocus' site.

data/lib/metasploit/model/authority/cve.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # Common Vulnerabilities and Exposures authority-specific code.
 module Metasploit::Model::Authority::Cve
   # Returns URL to {Metasploit::Model::Reference#designation the CVE ID's} page on CVE Details.

data/lib/metasploit/model/authority/msb.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # Microsoft Security Bulletin authority-specific code.
 module Metasploit::Model::Authority::Msb
   # Returns URL to {Metasploit::Model::Reference#designation the security bulletin's} page on Technet.

data/lib/metasploit/model/authority/osvdb.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # Open Sourced Vulnerability Database authority-specific code.
 module Metasploit::Model::Authority::Osvdb
   # Returns URL to {Metasploit::Model::Reference#designation OSVDB ID's} page.

data/lib/metasploit/model/authority/pmasa.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # phpMyAdmin Security Announcement authority-specific code.
 module Metasploit::Model::Authority::Pmasa
   # Returns URL to {Metasploit::Model::Reference#designation phpMyAdmin Security Advisory's} page on phpMyAdmin's site.

data/lib/metasploit/model/authority/secunia.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # Secunia authority-specific code.
 module Metasploit::Model::Authority::Secunia
   # Returns URL to {Metasploit::Model::Reference#designation Secunia Advisory ID's} page on Secunia.

data/lib/metasploit/model/authority/us_cert_vu.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # United States Computer Emergency Readiness Team Vulnerability Notes Database authority-specific code.
 module Metasploit::Model::Authority::UsCertVu
   # Returns URL to {Metasploit::Model::Reference#designation Vul ID's} page on US CERT Notes Database.

data/lib/metasploit/model/authority/waraxe.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # Waraxe authority-specific code.
 module Metasploit::Model::Authority::Waraxe
   #

data/lib/metasploit/model/authority/zdi.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/authority'
-
 # Zero Day Initiative authority-specific code.
 module Metasploit::Model::Authority::Zdi
   # Returns URL to {Metasploit::Model::Reference#designation the ZDI ID's} page on ZDI.

data/lib/metasploit/model/base.rb

@@ -1,5 +1,3 @@
-require 'metasploit/model/translation'
-
 # Superclass for all Metasploit::Models.  Just adds a default {#initialize} to make models mimic behavior of
 # ActiveRecord::Base subclasses.
 class Metasploit::Model::Base

data/lib/metasploit/model/derivation.rb

@@ -1,113 +1,109 @@
-module Metasploit
-  module Model
-    # Allow to declare that attributes should be derived, which will set the attribute equal to derived_<attribute> if
-    # the attribute is `nil` before validation.  Optionally, it can be checked if the attribute matches the
-    # derived_<attribute> in a validation.
-    #
-    #
-    # @example Full setup
-    #   class Person < ActiveRecord::Base
-    #     include Metasploit::Model::Derivation
-    #
-    #     #
-    #     # Attributes
-    #     #
-    #
-    #     # @!attributes [rw] first_name
-    #     #   First Name.
-    #     #
-    #     #   @return [String]
-    #
-    #     # @!attribute [rw] full_name
-    #     #   Full name. (Includes first and last name).
-    #     #
-    #     #   @return [String]
-    #
-    #     # @!attribute [rw] last_name
-    #     #   Last name.
-    #     #
-    #     #   @return [String]
-    #
-    #     #
-    #     # Derivations
-    #     #
-    #
-    #     derives :full_name
-    #
-    #     #
-    #     # Methods
-    #     #
-    #
-    #     # Derives {#full_name} from {#first_name} and {#last_name}.
-    #     #
-    #     # @return [String] "<first_name> <last_name>"
-    #     def derive_full_name
-    #       "#{first_name} #{last_name}"
-    #     end
-    #   end
-    module Derivation
-      extend ActiveSupport::Autoload
-      extend ActiveSupport::Concern
+# Allow to declare that attributes should be derived, which will set the attribute equal to derived_<attribute> if
+# the attribute is `nil` before validation.  Optionally, it can be checked if the attribute matches the
+# derived_<attribute> in a validation.
+#
+#
+# @example Full setup
+#   class Person < ActiveRecord::Base
+#     include Metasploit::Model::Derivation
+#
+#     #
+#     # Attributes
+#     #
+#
+#     # @!attributes [rw] first_name
+#     #   First Name.
+#     #
+#     #   @return [String]
+#
+#     # @!attribute [rw] full_name
+#     #   Full name. (Includes first and last name).
+#     #
+#     #   @return [String]
+#
+#     # @!attribute [rw] last_name
+#     #   Last name.
+#     #
+#     #   @return [String]
+#
+#     #
+#     # Derivations
+#     #
+#
+#     derives :full_name
+#
+#     #
+#     # Methods
+#     #
+#
+#     # Derives {#full_name} from {#first_name} and {#last_name}.
+#     #
+#     # @return [String] "<first_name> <last_name>"
+#     def derive_full_name
+#       "#{first_name} #{last_name}"
+#     end
+#   end
+module Metasploit::Model::Derivation
+  extend ActiveSupport::Autoload
+  extend ActiveSupport::Concern
 
-      autoload :FullName
+  autoload :FullName
 
-      included do
-        include ActiveModel::Validations
-        include ActiveModel::Validations::Callbacks
+  included do
+    include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
 
-        before_validation :derive
-      end
-
-      # Defines class methods include {#derives}, which can be used to declare derived attributes after mixing in
-      # {Metasploit::Model::Derivation}.
-      module ClassMethods
-        # Declares that the attribute should be derived using the derived_<attribute> method if it is `nil` before
-        # validation.
-        #
-        # @param attribute [Symbol] the name of the attribute.
-        # @param options [Hash{Symbol => Boolean}]
-        # @option options [Boolean] :validate (false) If `true`, validates `attribute` using {DerivationValidator}.  If
-        #   `false`, does no validation on `attribute`.
-        # @return [void]
-        def derives(attribute, options={})
-          options.assert_valid_keys(:validate)
+    before_validation :derive
+  end
 
-          validate = options.fetch(:validate, false)
-          validate_by_derived_attribute[attribute] = validate
+  # Defines class methods include {#derives}, which can be used to declare derived attributes after mixing in
+  # {Metasploit::Model::Derivation}.
+  module ClassMethods
+    # Declares that the attribute should be derived using the derived_<attribute> method if it is `nil` before
+    # validation.
+    #
+    # @param attribute [Symbol] the name of the attribute.
+    # @param options [Hash{Symbol => Boolean}]
+    # @option options [Boolean] :validate (false) If `true`, validates `attribute` using {DerivationValidator}.  If
+    #   `false`, does no validation on `attribute`.
+    # @return [void]
+    def derives(attribute, options={})
+      options.assert_valid_keys(:validate)
 
-          if validate
-            validates attribute, :derivation => true
-          end
-        end
+      validate = options.fetch(:validate, false)
+      validate_by_derived_attribute[attribute] = validate
 
-        # Maps a derived attribute (declared with {#derives}) to whether the attribute should validate as a derivation.
-        #
-        # @return [Hash{Symbol => Boolean}]
-        def validate_by_derived_attribute
-          @validate_by_derived_attribute ||= {}
-        end
+      if validate
+        validates attribute, :derivation => true
       end
+    end
+
+    # Maps a derived attribute (declared with {#derives}) to whether the attribute should validate as a derivation.
+    #
+    # @return [Hash{Symbol => Boolean}]
+    def validate_by_derived_attribute
+      @validate_by_derived_attribute ||= {}
+    end
+  end
 
-      #
-      # Instance Methods
-      #
+  #
+  # Instance Methods
+  #
 
-      private
+  private
 
-      # Derives each attribute in {ClassMethods#validate_by_derived_attribute} if the attribute is `nil`.
-      #
-      # @return [void]
-      def derive
-        self.class.validate_by_derived_attribute.each_key do |attribute|
-          value = send(attribute)
+  # Derives each attribute in {ClassMethods#validate_by_derived_attribute} if the attribute is `nil`.
+  #
+  # @return [void]
+  def derive
+    self.class.validate_by_derived_attribute.each_key do |attribute|
+      value = send(attribute)
 
-          # explicitly check for `nil` in case attribute is Boolean
-          if value.nil?
-            derived_value = send("derived_#{attribute}")
-            send("#{attribute}=", derived_value)
-          end
-        end
+      # explicitly check for `nil` in case attribute is Boolean
+      if value.nil?
+        derived_value = send("derived_#{attribute}")
+        send("#{attribute}=", derived_value)
       end
     end
   end
-end
+end