https://github.com/rapid7/metasploit-model

Common code, such as validators and mixins, that are shared between ActiveModels in metasploit-framework and ActiveRecords in metasploit_data_models
https://github.com/rapid7/metasploit-model

Last synced: over 1 year ago
JSON representation

Common code, such as validators and mixins, that are shared between ActiveModels in metasploit-framework and ActiveRecords in metasploit_data_models

• Host: GitHub
• URL: https://github.com/rapid7/metasploit-model
• Owner: rapid7
• License: bsd-3-clause
• Created: 2013-07-03T21:27:20.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2025-04-01T12:39:38.000Z (over 1 year ago)
• Last Synced: 2025-04-13T02:17:12.245Z (over 1 year ago)
• Language: Ruby
• Size: 2.04 MB
• Stars: 13
• Watchers: 77
• Forks: 20
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Metasploit::Model [![Build Status](https://github.com/rapid7/metasploit-model/actions/workflows/verify.yml/badge.svg)](https://github.com/rapid7/metasploit-model/actions/workflows/verify.yml)[![Code Climate](https://codeclimate.com/github/rapid7/metasploit-model.png)](https://codeclimate.com/github/rapid7/metasploit-model)[![Dependency Status](https://gemnasium.com/rapid7/metasploit-model.svg)](https://gemnasium.com/rapid7/metasploit-model)[![Gem Version](https://badge.fury.io/rb/metasploit-model.svg)](http://badge.fury.io/rb/metasploit-model)[![Inline docs](http://inch-ci.org/github/rapid7/metasploit-model.svg?branch=master)](http://inch-ci.org/github/rapid7/metasploit-model)[![PullReview stats](https://www.pullreview.com/github/rapid7/metasploit-model/badges/master.svg)](https://www.pullreview.com/github/rapid7/metasploit-model/reviews/master)

## Versioning

`Metasploit::Model` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch should set `Metasploit::Model::Version::PRERELEASE` to the branch SUMMARY, while master should have no `PRERELEASE` and the `PRERELEASE` section of `Metasploit::Model::VERSION` does not exist.

## Installation

Add this line to your application's Gemfile:

    gem 'metasploit-model'

And then execute:

    $ bundle

    

**This gem's `Rails::Engine` is not required automatically.** You'll need to also add the following to your `config/application.rb`:

    require 'metasploit/model/engine'

Or install it yourself as:

    $ gem install metasploit-model

## Running tests

Copy the database configuration and modify as appropriate:

```

cp spec/dummy/config/database.yml.github_actions spec/dummy/config/database.yml

```

Set up the database:

```

bundle exec rake db:test:prepare

bundle exec rake db:migrate RAILS_ENV=test

```

Run the test suite:

```

bundle exec rspec

```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)