ronin-db-activerecord 0.1.0 → 0.1.2

data/db/migrate/{0032_create_ronin_http_requests_table.rb → 0029_create_ronin_http_requests_table.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
@@ -19,6 +20,9 @@
 # along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+#
+# Creates the `ronin_http_requests` table.
+#
 class CreateRoninHttpRequestsTable < ActiveRecord::Migration[7.0]
 
   def change
@@ -28,9 +32,7 @@ class CreateRoninHttpRequestsTable < ActiveRecord::Migration[7.0]
       t.string :path, null: false
       t.text :body
 
-      t.references :response, foreign_key: {
-                                to_table: :ronin_http_responses
-                              }
+      t.references :response, foreign_key: {to_table: :ronin_http_responses}
 
       t.datetime :created_at, null: false
 

data/db/migrate/{0028_create_ronin_http_query_params_table.rb → 0030_create_ronin_http_query_params_table.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
@@ -19,6 +20,9 @@
 # along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+#
+# Creates the `ronin_http_query_params` table.
+#
 class CreateRoninHttpQueryParamsTable < ActiveRecord::Migration[7.0]
 
   def change

data/db/migrate/{0029_create_ronin_http_header_names_table.rb → 0031_create_ronin_http_header_names_table.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
@@ -19,6 +20,9 @@
 # along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+#
+# Creates the `ronin_http_header_names` table.
+#
 class CreateRoninHttpHeaderNamesTable < ActiveRecord::Migration[7.0]
 
   def change

data/db/migrate/{0030_create_ronin_http_request_headers_table.rb → 0032_create_ronin_http_request_headers_table.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
@@ -19,6 +20,9 @@
 # along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+#
+# Creates the `ronin_http_request_headers` table.
+#
 class CreateRoninHttpRequestHeadersTable < ActiveRecord::Migration[7.0]
 
   def change

data/db/migrate/{0031_create_ronin_http_response_headers_table.rb → 0033_create_ronin_http_response_headers_table.rb}

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
@@ -19,6 +20,9 @@
 # along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+#
+# Creates the `ronin_http_response_headers` table.
+#
 class CreateRoninHttpResponseHeadersTable < ActiveRecord::Migration[7.0]
 
   def change

data/db/migrate/0034_create_ronin_service_credentials_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
@@ -19,6 +20,9 @@
 # along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+#
+# Creates the `ronin_service_credentials` table.
+#
 class CreateRoninServiceCredentialsTable < ActiveRecord::Migration[7.0]
 
   def change

data/db/migrate/0035_create_ronin_web_credentials_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # ronin-db-activerecord - ActiveRecord backend for the Ronin Database.
 #
@@ -19,6 +20,9 @@
 # along with ronin-db-activerecord.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+#
+# Creates the `ronin_web_credentials` table.
+#
 class CreateRoninWebCredentialsTable < ActiveRecord::Migration[7.0]
 
   def change

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ronin-db-activerecord
-version: 0.1.0
+version: 0.1.2
 summary: ActiveRecord backend for the Ronin Database
 description:
   ronin-db-activerecord contains ActiveRecord models and migrations for the

data/lib/ronin/db/address.rb

@@ -58,7 +58,7 @@ module Ronin
       #   Tracks when the IP Address was first created
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       #
       # Looks up the address.
@@ -69,6 +69,8 @@ module Ronin
       # @return [Address, nil]
       #   The found address.
       #
+      # @api public
+      #
       def self.lookup(address)
         find_by(address: address)
       end
@@ -80,7 +82,7 @@ module Ronin
       #   The address to parse.
       #
       # @return [Address]
-      #   The parsed address.
+      #   The imported address.
       #
       # @api public
       #

data/lib/ronin/db/advisory.rb

@@ -56,9 +56,9 @@ module Ronin
       attribute :year, :integer
       validates :year, allow_nil:  true,
                        comparison: {
-                                     greater_than: 1990,
-                                     less_than_or_equal_to: Date.today.year
-                                   }
+                         greater_than: 1990,
+                         less_than_or_equal_to: Date.today.year
+                       }
 
       # @!attribute [rw] identifier
       #   The advisory identifier
@@ -84,7 +84,7 @@ module Ronin
         #   The ID does not appear to be a valid security ID.
         #
         def self.parse(string)
-          if (match = string.match(/\A([A-Z]+)-(\d{4})[:-]([0-9][0-9-]+)\z/))
+          if    (match = string.match(/\A([A-Z]+)-(\d{4})[:-]([0-9][0-9-]+)\z/))
             {
               id:         match[0],
               prefix:     match[1],

data/lib/ronin/db/asn.rb

@@ -82,13 +82,13 @@ module Ronin
       # @!attribute [rw] country_code
       #   The country code of the ASN.
       #
-      #   @return [String]
+      #   @return [String, nil]
       attribute :country_code, :string
 
       # @!attribute [rw] name
       #   The organization the ASN is currently assigned to.
       #
-      #   @return [String]
+      #   @return [String, nil]
       attribute :name, :string
 
       #
@@ -142,7 +142,7 @@ module Ronin
       #
       # Searches for all ASNs with the matching name.
       #
-      # @param [String] name 
+      # @param [String] name
       #   The name to search for.
       #
       # @return [Array<ASN>]
@@ -159,11 +159,11 @@ module Ronin
       # @return [ASN, nil]
       #
       def self.containing_ip(ip)
-        ip = IPAddr.new(ip) unless ip.kind_of?(IPAddr)
+        ip      = IPAddr.new(ip) unless ip.kind_of?(IPAddr)
         ip_hton = ip.hton
 
         range_start_hton = self.arel_table[:range_start_hton]
-        range_end_hton  = self.arel_table[:range_end_hton]
+        range_end_hton   = self.arel_table[:range_end_hton]
 
         where(range_start_hton.lteq(ip_hton).and(range_end_hton.gteq(ip_hton))).first
       end

data/lib/ronin/db/email_address.rb

@@ -84,7 +84,7 @@ module Ronin
       #   Tracks when the email address was created at.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       #
       # Searches for email addresses associated with the given host name(s).

data/lib/ronin/db/host_name.rb

@@ -60,7 +60,7 @@ module Ronin
       #   When the host name was first created.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       # @!attribute [rw] host_name_ip_addresses
       #   The IP Address associations.

data/lib/ronin/db/host_name_ip_address.rb

@@ -58,7 +58,7 @@ module Ronin
       #   Tracks when a IP Address is associated with a host name
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
     end
   end

data/lib/ronin/db/http_query_param_name.rb

@@ -57,7 +57,7 @@ module Ronin
       #   When the HTTP query param name was first created.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       #
       # Converts the HTTP query param name to a String.

data/lib/ronin/db/http_request.rb

@@ -113,7 +113,7 @@ module Ronin
       #   When the HTTP request was created.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
     end
   end

data/lib/ronin/db/http_response.rb

@@ -74,7 +74,7 @@ module Ronin
       #   When the HTTP response was created.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       # @!attribute [rw] request
       #   The associated HTTP request that the response was returned for.

data/lib/ronin/db/ip_address.rb

@@ -262,6 +262,7 @@ module Ronin
                       begin
                         IPAddr.new(self.address)
                       rescue IPAddr::InvalidAddressError
+                        nil
                       end
                     end
       end
@@ -345,7 +346,6 @@ require 'ronin/db/host_name_ip_address'
 require 'ronin/db/host_name'
 require 'ronin/db/open_port'
 require 'ronin/db/port'
-require 'ronin/db/host_name'
 require 'ronin/db/os_guess'
 require 'ronin/db/os'
 require 'ronin/db/asn'

data/lib/ronin/db/ip_address_mac_address.rb

@@ -55,7 +55,7 @@ module Ronin
       #   Tracks when an IP Address becomes associated with a MAC Address.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
     end
   end

data/lib/ronin/db/mac_address.rb

@@ -34,12 +34,12 @@ module Ronin
       #   The MAC address.
       #
       #   @return [String]
-      attribute :address, :string # length: 17..17,
+      attribute :address, :string
       validates :address, presence:   true,
                           uniqueness: true,
                           length: {maximum: 17},
                           format: {
-                            with: /[0-9a-fA-F]{2}(?::[0-9a-fA-F]{2}){5}/,
+                            with: /\A[0-9a-fA-F]{2}(?::[0-9a-fA-F]{2}){5}\z/,
                             message: 'Must be a valid MAC address'
                           }
 
@@ -78,8 +78,8 @@ module Ronin
       # @api public
       #
       def to_i
-        self.address.split(':').inject(0) do |bits,char|
-          bits = ((bits << 8) | char.hex)
+        self.address.split(':').reduce(0) do |bits,char|
+          ((bits << 8) | char.hex)
         end
       end
 

data/lib/ronin/db/migrations.rb

@@ -25,6 +25,9 @@ require 'active_record/migration'
 
 module Ronin
   module DB
+    #
+    # Handles migrating the database.
+    #
     module Migrations
       #
       # The current migration version of the database.
@@ -56,7 +59,7 @@ module Ronin
         context.migrate(target_version)
       end
 
-      # 
+      #
       # Explicitly migrates up the database to the target version.
       #
       # @param [Integer, nil] target_version
@@ -68,9 +71,9 @@ module Ronin
         context.up(target_version,&block)
       end
 
-      # 
+      #
       # Explicitly migrates down the database to the target version.
-      # 
+      #
       # @param [Integer, nil] target_version
       #   The desired target version.
       #
@@ -80,7 +83,7 @@ module Ronin
         context.down(target_version,&block)
       end
 
-      # 
+      #
       # Rollbacks the last number of migrations.
       #
       # @param [Integer] steps
@@ -92,7 +95,7 @@ module Ronin
         context.rollback(steps)
       end
 
-      # 
+      #
       # Applies the next number of migrations.
       #
       # @param [Integer] steps
@@ -104,8 +107,6 @@ module Ronin
         context.foreward(steps)
       end
 
-      private
-
       # Path to the `db/migrate/` directory in `ronin-db-activerecord`.
       DIR = File.expand_path('../../../db/migrate',__dir__)
 
@@ -129,8 +130,10 @@ module Ronin
       #
       # @return [MigrationContext]
       #
+      # @api private
+      #
       def self.context
-        @migrations ||= MigrationContext.new
+        @context ||= MigrationContext.new
       end
     end
   end

data/lib/ronin/db/model/has_unique_name.rb

@@ -44,11 +44,9 @@ module Ronin
         # @api semipublic
         #
         def self.included(base)
-          base.send :include, Model,
-                              HasName::InstanceMethods
+          base.send :include, Model, HasName::InstanceMethods
 
-          base.send :extend,  HasName::ClassMethods,
-                              HasUniqueName::ClassMethods
+          base.send :extend, HasName::ClassMethods, HasUniqueName::ClassMethods
 
           base.module_eval do
             # The name of the model

data/lib/ronin/db/model/importable.rb

@@ -37,6 +37,9 @@ module Ronin
           model.extend ClassMethods
         end
 
+        #
+        # Class-methods which will be added to the model.
+        #
         module ClassMethods
           #
           # Looks up a record with the given value.

data/lib/ronin/db/model/last_scanned_at.rb

@@ -21,6 +21,9 @@
 module Ronin
   module DB
     module Model
+      #
+      # Mixin which adds a `last_scanned_at` attribute to a model.
+      #
       module LastScannedAt
         #
         # @!attribute [rw] last_scanned_at
@@ -39,7 +42,7 @@ module Ronin
         #
         def self.included(model)
           model.class_eval do
-            attribute :last_scanned_at, :time
+            attribute :last_scanned_at, :datetime
           end
         end
       end

data/lib/ronin/db/model.rb

@@ -20,6 +20,9 @@
 
 module Ronin
   module DB
+    #
+    # Mixin for all `ronin-db-activerecord` models.
+    #
     module Model
       #
       # Sets the models `table_name_prefix` to `ronin_`.

data/lib/ronin/db/models.rb

@@ -56,6 +56,9 @@ require 'ronin/db/vulnerability'
 
 module Ronin
   module DB
+    #
+    # Manages all models defined in `ronin-db-activerecord`.
+    #
     module Models
       ALL = [
         Address,

data/lib/ronin/db/open_port.rb

@@ -74,7 +74,7 @@ module Ronin
       #   Define the created_at timestamp
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       # @!attribute [rw] service_credentials
       #   Credentials used by the service running on the port

data/lib/ronin/db/organization.rb

@@ -43,7 +43,7 @@ module Ronin
       #   Tracks when the organization was first created
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
     end
   end

data/lib/ronin/db/os.rb

@@ -51,14 +51,14 @@ module Ronin
       #
       #   @return [String]
       attribute :version, :string
-      validates :version, presence: true,
+      validates :version, presence:   true,
                           uniqueness: {scope: :name}
 
       # @!attribute [rw] os_guesses
       #   Any OS guesses for the Operating System.
       #
       #   @return [Array<OSGuess>]
-      has_many :os_guesses, dependent: :destroy,
+      has_many :os_guesses, dependent:  :destroy,
                             class_name: 'OSGuess'
 
       # @!attribute [rw] ip_addresses

data/lib/ronin/db/os_guess.rb

@@ -57,7 +57,7 @@ module Ronin
       #   Tracks when an OS guess is made against an IP Address.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
     end
   end

data/lib/ronin/db/password.rb

@@ -109,13 +109,13 @@ module Ronin
       #
       # @example
       #   pass = Password.new(plain_text: 'secret')
-      #   
+      #
       #   pass.digest(:sha1)
       #   # => "e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4"
-      #   
+      #
       #   pass.digest(:sha1, prepend_salt: "A\x90\x00")
       #   # => "e2817656a48c49f24839ccf9295b389d8f985904"
-      #   
+      #
       #   pass.digest(:sha1, append_salt: "BBBB")
       #   # => "aa6ca21e446d425fc044bbb26e950a788444a5b8"
       #

data/lib/ronin/db/software.rb

@@ -49,14 +49,14 @@ module Ronin
       #
       #   @return [String]
       attribute :version, :string
-      validates :version, presence: true,
+      validates :version, presence:   true,
                           uniqueness: {scope: :name}
 
       # @!attribute [rw] vendor
       #   The vendor of the software
       #
       #   @return [SoftwareVendor, nil]
-      belongs_to :vendor, optional: true,
+      belongs_to :vendor, optional:   true,
                           class_name: 'SoftwareVendor'
 
       # @!attribute [rw] open_ports

data/lib/ronin/db/url.rb

@@ -87,7 +87,7 @@ module Ronin
 
       # @!attribute [rw] fragment
       #   The fragment of the URL.
-      #   
+      #
       #   @return [String, nil]
       attribute :fragment, :string
 
@@ -95,7 +95,7 @@ module Ronin
       #   Defines the created_at timestamp
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       # @!attribute [rw] query_params
       #   The query params of the URL.
@@ -362,33 +362,30 @@ module Ronin
                         number:   uri.port
                       )
                     end
+        path      = normalized_path(uri)
+        query     = uri.query
+        fragment  = uri.fragment
 
-        path     = normalized_path(uri)
-        query    = uri.query
-        fragment = uri.fragment
-
-        query_params = []
-        
-        if uri.respond_to?(:query_params)
-          # find or create the URL query params
-          uri.query_params.each do |name,value|
-            query_params << URLQueryParam.new(
-              name:  URLQueryParamName.find_or_create_by(name: name),
-              value: value
-            )
-          end
-        end
-
-        # find or create the URL
+        # try to query a pre-existing URI then fallback to creating the URL
+        # with query params.
         return find_or_create_by(
           scheme:       scheme,
           host_name:    host_name,
           port:         port,
           path:         path,
           query:        query,
-          fragment:     fragment,
-          query_params: query_params
-        )
+          fragment:     fragment
+        ) do |new_url|
+          if uri.respond_to?(:query_params)
+            # find or create the URL query params
+            uri.query_params.each do |name,value|
+              new_url.query_params << URLQueryParam.new(
+                name:  URLQueryParamName.find_or_create_by(name: name),
+                value: value
+              )
+            end
+          end
+        end
       end
 
       #
@@ -430,9 +427,11 @@ module Ronin
         scheme = if self.scheme
                    self.scheme.name
                  end
+
         host = if self.host_name
                  self.host_name.name
                end
+
         port = if self.port
                  self.port.number
                end
@@ -460,8 +459,6 @@ module Ronin
         self.to_uri.to_s
       end
 
-      protected
-
       #
       # Normalizes the path of a URI.
       #

data/lib/ronin/db/url_query_param_name.rb

@@ -57,7 +57,7 @@ module Ronin
       #   When the URL query param name was first created.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       #
       # Converts the URL query param name to a String.

data/lib/ronin/db/url_scheme.rb

@@ -34,7 +34,7 @@ module Ronin
       include Model::HasUniqueName
 
       self.table_name = 'ronin_url_schemes'
-      
+
       # @!attribute [rw] id
       #   The primary key of the URL scheme.
       #

data/lib/ronin/db/user_name.rb

@@ -48,7 +48,7 @@ module Ronin
       #   Tracks when the user-name was created.
       #
       #   @return [Time]
-      attribute :created_at, :time
+      attribute :created_at, :datetime
 
       # @!attribute [rw] credentials
       #   Any credentials belonging to the user.