ronin-db-activerecord

Description

ronin-db-activerecord contains ActiveRecord models and migrations for the Ronin Database. Provides database models storing and querying network data, advisory data, credentials, and OSINT data.

Features

Can be used both as a standalone library or in a web app.
Provides common ActiveRecord models:
Has 98% documentation coverage.
Has 99% test coverage.

Examples

Create a database:

require 'ronin/db/migrations'

ActiveRecord::Base.establish_connection(
  adapter: 'sqlite3',
  database: 'path/to/db.sqlite3'
)

Ronin::DB::Migrations.up

Connect to the database:

ActiveRecord::Base.establish_connection(
  adapter: 'sqlite3',
  database: 'path/to/db.sqlite3'
)

require 'ronin/db/models'
Ronin::DB::Models.connect

Requirements

Ruby >= 3.0.0
activerecord ~> 7.0

Install

$ gem install ronin-db-activerecord

Gemfile

gem 'ronin-db-activerecord', '~> 0.1'

gemspec

gem.add_dependency 'ronin-db-activerecord', '~> 0.1'

Development

Fork It!
Clone It!
cd ronin-db-activerecord/
bundle install
git checkout -b my_feature
Code It!
bundle exec rake spec
git push origin my_feature

If you want to test your changes locally, run rake db:console to start a local database console.

License

ronin-db-activerecord is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ronin-db-activerecord 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with ronin-db-activerecord. If not, see https://www.gnu.org/licenses/.