ronin 1.5.1 → 2.0.0.beta1

data/lib/ronin/model/has_unique_name.rb

@@ -1,127 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model/has_name'
-
-module Ronin
-  module Model
-    #
-    # Adds a unique `name` property to a model.
-    #
-    module HasUniqueName
-      #
-      # Adds the unique `name` property and {HasName::ClassMethods} to the
-      # model.
-      #
-      # @param [Class] base
-      #   The model.
-      #
-      # @api semipublic
-      #
-      def self.included(base)
-        base.send :include, Model,
-                            InstanceMethods
-
-        base.send :extend,  HasName::ClassMethods,
-                            HasUniqueName::ClassMethods
-
-        base.module_eval do
-          # The name of the model
-          property :name, String, :required => true, :unique => true
-        end
-      end
-
-      #
-      # Class methods that will be added when {HasUniqueName} is included.
-      #
-      module ClassMethods
-        #
-        # Parses a unique name.
-        #
-        # @param [String] name
-        #   The name to parse.
-        #
-        # @return [Model]
-        #   A new or previously saved resource.
-        #
-        # @since 1.4.0
-        #
-        # @api public
-        #
-        def parse(name)
-          first_or_new(:name => name.strip)
-        end
-
-        #
-        # Searches for models with the unique name.
-        #
-        # @param [String, Symbol, Integer] key
-        #   The unique name or index to search for.
-        #
-        # @return [Model, nil]
-        #   The matching model.
-        #
-        # @since 1.0.0
-        #   
-        # @api public
-        #
-        def [](key)
-          case key
-          when String, Symbol then first(:name => key.to_s)
-          else                     super(key)
-          end
-        end
-      end
-
-      #
-      # Instance methods that will be added when {HasUniqueName} is
-      # included.
-      #
-      module InstanceMethods
-        #
-        # Converts the named resource into a String.
-        #
-        # @return [String]
-        #   The name of the resource.
-        #
-        # @since 1.0.0
-        #
-        # @api public
-        #
-        def to_s
-          self.name.to_s
-        end
-
-        #
-        # Inspects the resource with the unique name.
-        #
-        # @return [String]
-        #   The inspected resource.
-        #
-        # @since 1.0.0
-        #
-        # @api public
-        #
-        def inspect
-          "#<#{self.class}: #{self.name}>"
-        end
-      end
-    end
-  end
-end

data/lib/ronin/model/has_version.rb

@@ -1,77 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model'
-
-module Ronin
-  module Model
-    #
-    # Adds a `version` property to a model.
-    #
-    module HasVersion
-      #
-      # Adds the `version` property and {ClassMethods} to the model.
-      #
-      # @param [Class] base
-      #   The model.
-      #
-      # @api semipublic
-      #
-      def self.included(base)
-        base.send :include, Model
-        base.send :extend, ClassMethods
-
-        base.module_eval do
-          # The version of the model
-          property :version, String, :default => '0.1', :index => true
-        end
-      end
-
-      #
-      # Class methods that are added when {HasVersion} is included into a
-      # model.
-      #
-      module ClassMethods
-        #
-        # Finds all models with a specific version.
-        #
-        # @param [String] version
-        #   The specific version to search for.
-        #
-        # @return [Array]
-        #   The models with the specific version.
-        #
-        # @api public
-        #
-        def revision(version)
-          all(:version => version.to_s)
-        end
-
-        #
-        # Finds latest version of the model.
-        #
-        # @api public
-        #
-        def latest
-          first(:order => [:version.desc])
-        end
-      end
-    end
-  end
-end

data/lib/ronin/model/importable.rb

@@ -1,65 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-module Ronin
-  module Model
-    #
-    # Uses the `extract` method to extract and save resources from the
-    # contents of text-files.
-    #
-    # @since 1.3.0
-    #
-    module Importable
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-        #
-        # Extracts and imports resources from the given file.
-        #
-        # @param [String] path
-        #   The path of the file.
-        #
-        # @yield [resource]
-        #   The given block will be passed every imported resource.
-        #
-        # @yieldparam [Model] resource
-        #   A successfully imported resource.
-        #
-        # @return [Array<Model>]
-        #   If no block is given, an Array of imported resources is returned.
-        #
-        # @api public
-        #
-        def import(path)
-          return enum_for(__method__,path).to_a unless block_given?
-
-          File.open(path) do |file|
-            file.each_line do |line|
-              extract(line) do |resource|
-                yield(resource) if resource.save
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ronin/model/model.rb

@@ -1,165 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model/types'
-
-require 'dm-core'
-require 'dm-types'
-require 'dm-migrations'
-require 'dm-validations'
-require 'dm-aggregates'
-require 'dm-serializer'
-require 'dm-timestamps'
-
-module Ronin
-  #
-  # Modifies a class so that it can represent a DataMapper model in the
-  # {Database}.
-  #
-  module Model
-    include Model::Types
-
-    #
-    # Sets up a class as a DataMapper model that can be used with the
-    # {Database}. Also adds {ClassMethods} to the new model.
-    #
-    # @param [Class] base
-    #   The class that will be setup as a DataMapper model.
-    #
-    def self.included(base)
-      unless base < DataMapper::Resource
-        base.send :include, DataMapper::Resource
-      end
-
-      # include DataMapper plugins
-      base.send :include, DataMapper::Migrations,
-                          DataMapper::Serialize,
-                          DataMapper::Timestamps
-
-      # include Model types / methods
-      base.send :include, Model::Types
-      base.send :include, InstanceMethods
-      base.send :extend,  ClassMethods
-    end
-
-    #
-    # Class methods that are added when {Model} is included into a class.
-    #
-    module ClassMethods
-      #
-      # The default name to use when defining relationships with the
-      # model.
-      #
-      # @return [Symbol]
-      #   The name to use in relationships.
-      #
-      # @since 1.0.0
-      #
-      # @api semipublic
-      #
-      def relationship_name
-        DataMapper::Inflector.pluralize(
-          DataMapper::Inflector.underscore(self.name.split('::').last)
-        ).to_sym
-      end
-
-      #
-      # Loads and initialize the resources.
-      #
-      # @api private
-      #
-      def load(records,query)
-        resources = super(records,query)
-        resources.each { |resource| resource.send :initialize }
-
-        return resources
-      end
-    end
-
-    #
-    # Instance methods that are added when {Model} is included into a class.
-    #
-    module InstanceMethods
-      #
-      # Formats the attributes of the model into human readable names
-      # and values.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [Array<Symbol>] :exclude ([])
-      #   A list of attribute names to exclude.
-      #
-      # @yield [name, value]
-      #   If a block is given, it will be passed the name and humanized
-      #   value of each attribute.
-      #
-      # @yieldparam [String] name
-      #   The humanized name of the attribute.
-      #
-      # @yieldparam [String] value
-      #   The human readable value of the attribute.
-      #
-      # @return [Hash{String => String}]
-      #   A hash of the humanly readable names and values of the attributes.
-      #
-      # @api semipublic
-      #
-      def humanize_attributes(options={})
-        exclude = [:id, :type]
-
-        if options[:exclude]
-          exclude += options[:exclude]
-        end
-
-        formatter = lambda { |value|
-          case value
-          when Array
-            value.map(&formatter).join(', ')
-          when Symbol
-            DataMapper::Inflector.humanize(value)
-          else
-            value.to_s
-          end
-        }
-
-        formatted = {}
-
-        self.attributes.each do |name,value|
-          next if (value.nil? || (value.respond_to?(:empty?) && value.empty?))
-
-          unless (exclude.include?(name) || value.nil?)
-            name = name.to_s
-
-            unless name[-3..-1] == '_id'
-              name = DataMapper::Inflector.humanize(name)
-              value = formatter.call(value)
-
-              yield name, value if block_given?
-
-              formatted[name] = value
-            end
-          end
-        end
-
-        return formatted
-      end
-    end
-  end
-end

data/lib/ronin/model/types/description.rb

@@ -1,60 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'dm-core'
-
-module Ronin
-  module Model
-    module Types
-      #
-      # The Description property type is similar to the `Text` type,
-      # but automatically strips all leading and tailing white-space
-      # from every line.
-      #
-      class Description < DataMapper::Property::Text
-
-        #
-        # Type-casts the description.
-        #
-        # @param [Object] value
-        #   The text of the description.
-        #
-        # @return [String, nil]
-        #   The type-casted description.
-        #
-        # @since 1.0.0
-        #
-        # @api private
-        #
-        def typecast(value)
-          return nil if value.nil?
-
-          sanitized_lines = []
-
-          value.to_s.each_line do |line|
-            sanitized_lines << line.strip
-          end
-
-          return sanitized_lines.join("\n").strip
-        end
-
-      end
-    end
-  end
-end

data/lib/ronin/model/types.rb

@@ -1,20 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model/types/description'

data/lib/ronin/model.rb

@@ -1,20 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model/model'

data/lib/ronin/open_port.rb

@@ -1,112 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model'
-
-require 'dm-timestamps'
-
-module Ronin
-  #
-  # Represents a open port at a specified IP address.
-  #
-  class OpenPort
-
-    include Model
-
-    # The primary key of the open port
-    property :id, Serial
-
-    # The IP Address that was scanned
-    belongs_to :ip_address, :model => 'IPAddress'
-
-    # The port
-    belongs_to :port
-
-    # The service detected on the port
-    belongs_to :service, :required => false
-
-    # any credentials used by the service running on the port
-    has 0..n, :service_credentials
-
-    # When the open-port was last scanned
-    property :last_scanned_at, Time
-
-    # Define the created_at timestamp
-    timestamps :created_at
-
-    #
-    # The IP Address of the open port.
-    #
-    # @return [String]
-    #   The IP Address.
-    #
-    # @since 1.0.0
-    #
-    # @api public
-    #
-    def address
-      self.ip_address.address
-    end
-
-    #
-    # The port number.
-    #
-    # @return [Integer]
-    #   The port number.
-    #
-    # @since 1.0.0
-    #
-    # @api public
-    #
-    def number
-      self.port.number
-    end
-
-    #
-    # Converts the open port to an integer.
-    #
-    # @return [Integer]
-    #   The port number.
-    #
-    # @since 1.0.0
-    #
-    # @api public
-    #
-    def to_i
-      self.port.to_i
-    end
-
-    #
-    # Converts the open port to a string.
-    #
-    # @return [String]
-    #   The information of the open port.
-    #
-    # @since 1.0.0
-    #
-    # @api public
-    #
-    def to_s
-      if self.service then "#{self.port} (#{self.service})"
-      else                 "#{self.port}"
-      end
-    end
-
-  end
-end

data/lib/ronin/organization.rb

@@ -1,46 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
-#
-# Ronin 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 3 of the License, or
-# (at your option) any later version.
-#
-# Ronin 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 Ronin.  If not, see <https://www.gnu.org/licenses/>.
-#
-
-require 'ronin/model'
-require 'ronin/model/has_unique_name'
-require 'ronin/model/has_description'
-
-require 'dm-timestamps'
-
-module Ronin
-  #
-  # Represents an Organization which owns {Address}es.
-  #
-  class Organization
-
-    include Model
-    include Model::HasUniqueName
-    include Model::HasDescription
-
-    # Primary key of the organization
-    property :id, Serial
-
-    # The addresses that belong to the organization
-    has 1..n, :addresses
-
-    # Tracks when the organization was first created
-    timestamps :created_at
-
-  end
-end