metasploit_data_models 0.24.2 → 0.24.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69de2fe8a5805a58e1cdea1f81a91fec6f1e6c07
-  data.tar.gz: 72b931c04092bd416f05f315ef0195284f853e3f
+  metadata.gz: 4b0e76e56575cde44eaaf8cccbb83510c1cd7bb1
+  data.tar.gz: 2ebe2f14cd9c7d467ac6e62e7424eae5bc141010
 SHA512:
-  metadata.gz: 91aeed44b44b4bfddb5afa95e8f2aef188f2c32de6a37961804e6f4c15298de3aa24e3f9c9aff36f6f2a11a3cb7e60ef13889c86d3a676a8652016374c64cbcd
-  data.tar.gz: 81f0ee91a1eba059de5f20bd2105b35e8323999a6e0b7b8337d12c8d58546474c9387052e66649706c889e10958f22cef559ff63c88b1c2528c6b7e5280971ee
+  metadata.gz: 7023e69695c3caaa489b057323d2c2d3011812d1d4db05a0c65287ad7f225fa00e74be18bd492131c3870b48f50af822b6cee43333732dcd78f32c9c49464199
+  data.tar.gz: 3d62cffcc384ec9a8ab347dc7ccc94cceb95a9cc9e1260dfb797d1ce391f9a5bb6b5e6b23efcbf494ccd0ea14a75ef4070d63a6bc836a8de3577a2d787f747cb

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Next Release
+
+* Enhancements
+* Bug Fixes
+* Deprecations
+* Incompatible Changes

data/CONTRIBUTING.md

@@ -25,19 +25,18 @@ issue tracking software.
 
 ### `PRERELEASE`
 
-1. Update `PRERELEASE` to match the `SUMMARY` in the branch name.  If you branched from `master`, and [version.rb](lib/metasploit_data_models/version.rb) does not have `PRERELEASE` defined, then adding the following lines after `PATCH`: 
+1. Update `PRERELEASE` to match the `SUMMARY` in the branch name.  If you branched from `master`, and [version.rb](lib/metasploit_data_models/version.rb) does not have `PRERELEASE` defined, then adding the following lines after `PATCH`:
 ```
-# The prerelease version, scoped to the {PATCH} version number.
+# The prerelease version, scoped to the {MAJOR}, {MINOR}, and {PATCH} version number.
 PRERELEASE = '<SUMMARY>'
 ```
 2. `rake spec`
 3.  Verify the specs pass, which indicates that `PRERELEASE` was updated correctly.
 4. Commit the change `git commit -a`
 
-
 ### Your changes
 
-Make your changes or however many commits you like, commiting each with `git commit`.
+Make your changes or however many commits you like, committing each with `git commit`.
 
 ### Pre-Pull Request Testing
 
@@ -46,12 +45,12 @@ Make your changes or however many commits you like, commiting each with `git com
 
 ### Push
 
-Push your branch to your fork on gitub: `git push push TYPE/ISSUE/SUMMARY`
+Push your branch to your fork on github: `git push TYPE/ISSUE/SUMMARY`
 
 ### Pull Request
 
 * [Create new Pull Request](https://github.com/rapid7/metasploit_data_models/compare/)
-* Add a Verification Steps comment
+* Add a Verification Steps to the description comment
 
 ```
 # Verification Steps
@@ -62,11 +61,12 @@ Push your branch to your fork on gitub: `git push push TYPE/ISSUE/SUMMARY`
 - [ ] `rake spec`
 - [ ] VERIFY no failures
 ```
+
 You should also include at least one scenario to manually check the changes outside of specs.
 
 * Add a Post-merge Steps comment
 
-The 'Post-merge Steps' are a reminder to the reviewer of the Pull Request of how to update the [`PRERELEASE`](lib/metasploit_data_models/version.rb) so that [version_spec.rb](spec/lib/metasploit_data_models/version_spec.rb) passes on the target branch after the merge.
+The 'Post-merge Steps' are a reminder to the reviewer of the Pull Request of how to update the [`PRERELEASE`](lib/metasploit_data_models/version.rb) so that [version_spec.rb](spec/lib/metasploit_data_models/version.rb_spec.rb) passes on the target branch after the merge.
 
 DESTINATION is the name of the destination branch into which the merge is being made.  SOURCE_SUMMARY is the SUMMARY from TYPE/ISSUE/SUMMARY branch name for the SOURCE branch that is being made.
 
@@ -106,7 +106,7 @@ Perform these steps prior to pushing to DESTINATION or the build will be broke o
 - [ ] Change `PRERELEASE` from `SOURCE_SUMMARY` to `DESTINATION_SUMMARY` to match the branch (DESTINATION) summary (DESTINATION_SUMMARY)
 
 ## Gem build
-- [ ] gem build *.gemspec
+- [ ] gem build metasploit_data_models.gemspec
 - [ ] VERIFY the prerelease suffix has change on the gem.
 
 ## RSpec
@@ -118,47 +118,5 @@ Perform these steps prior to pushing to DESTINATION or the build will be broke o
 - [ ] `git push origin DESTINATION`
 ```
 
-* Add a 'Release Steps' comment
-
-The 'Release Steps' are a reminder to the reviewer of the Pull Request of how to release the gem.
-
-```
-# Release
-
-Complete these steps on DESTINATION
-
-## Version
-
-### Compatible changes
-
-If the change are compatible with the previous branch's API, then increment [`PATCH`](lib/metasploit_data_models/version.rb).
-
-### Incompatible changes
-
-If your changes are incompatible with the previous branch's API, then increment
-[`MINOR`](lib/metasploit_data_models/version.rb) and reset [`PATCH`](lib/metasploit_data_models/version.rb) to `0`.
-
-- [ ] Following the rules for [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html), update
-[`MINOR`](lib/metasploit_data_models/version.rb) and [`PATCH`](lib/metasploit_data_models/version.rb) and commit the changes.
-
-## JRuby
-- [ ] `rvm use jruby@metasploit_data_models`
-- [ ] `rm Gemfile.lock`
-- [ ] `bundle install`
-- [ ] `rake release`
-
-## MRI Ruby
-- [ ] `rvm use ruby-2.1@metasploit_data_models`
-- [ ] `rm Gemfile.lock`
-- [ ] `bundle install`
-- [ ] `rake release`
-```
-
-### Downstream dependencies
-
-When releasing new versions, the following projects may need to be updated:
-
-* [metasploit-credential](https://github.com/rapid7/metasploit-credential)
-* [metasploit-framework](https://github.com/rapid7/metasploit-framework)
-* [metasploit-pro-ui](https://github.com/rapid7/pro/tree/master/ui)
-* [metasploit-pro-engine](https://github.com/rapid7/pro/tree/master/engine)
+To update the [CHANGELOG.md](CHANGELOG.md) with the merged changes or release the merged code see
+[RELEASING.md](RELEASING.md)

data/RELEASING.md

@@ -0,0 +1,88 @@
+# Releasing
+
+These steps can be added to the Pull Request description's task list to remind the reviewer of how to release the
+gem.
+
+```
+# Release
+
+Complete these steps on DESTINATION
+
+## [CHANGELOG.md](CHANGELOG.md)
+
+### Terminology
+
+* "Enhancements" are widdening the API, such as by adding new classes or methods.
+* "Bug Fixes" are fixes to the implementation that do not affect the public API.  If the public API is affected then
+  the change should be listed as both a "Bug Fix" and either an "Enhancement" or "Incompatible Change" depending on how
+  the bug was fixed.
+* "Deprecations" are changes to the implementation that cause deprecation warnings to be issued for APIs which will be
+  removed in a future major release.  "Deprecations" are usually accompanied by an Enhancement that creates a new API
+  that is meant to be used in favor of the deprecated API.
+* "Incompatbile Changes" are the removal of classes or methods or new required arguments or setup that shrink the API.
+  It is best practice to make a "Deprecation" for the API prior to its removal.
+
+### Task List
+
+- [ ] Generate the list of changes since the last release: `git log v<LAST_MAJOR>.<LAST_MINOR>.<LAST_PATCH>..HEAD`
+- [ ] For each commit in the release, find the corresponding PR by search for the commit on Github.
+- [ ] For each PR, determine whether it is an Enhancement, Bug Fix, Deprecation, and/or Incompatible Change.  A PR can
+      be in more than one category, in which case it should be listed in each category it belongs, but with a category
+      specific description of the change.
+- [ ] Add an item to each category's list in the following format: `[#<PR>](https://github.com/rapid7/metasploit_data_models/pull/<PR>) <consumer summary> - [@<github_user>](https://github.com/<github_user>)`
+      `consumer_summary` should be a summary of the Enhancement, Bug Fix, Deprecation, or Incompatible Change from a
+      downstream consumer's of the library's perspective.  `github_user` should be Github handle of the author of the
+      PR.
+- [ ] If you added any Deprecations or Incompatible Changes, then adding upgrading information to
+      [UPGRADING.md](UPGRADING.md)
+
+## `VERSION`
+
+The entries in the [CHANGELOG.md](CHANGELOG.md) can be used to help determine how the `VERSION` should be bumped.
+
+### Compatible changes
+
+If the [CHANGELOG.md](CHANGELOG.md) contains only Enhancements, Bug Fixes, and/or Deprecations for the Next Release then
+increment [`PATCH`](lib/metasploit_data_models/version.rb).
+
+### Incompatible changes
+
+If the [CHANGELOG.md](CHANGELOG.md) contains any Incompatible Changes for the Next Release, then you can either (1)
+decide to remain pre-1.0.0 or (2) advance to 1.0.0.
+
+1. To remain pre-1..0.0, then increment [`MINOR`](lib/metasploit_data_models/version.rb) and reset
+   [`PATCH`](lib/metasploit_data_models/version.rb) to `0`.
+2. To advance to 1.0.0, increment [`MAJOR`](lib/metasploit_data_models/version.rb) and reset
+   [`MINOR`](lib/metasploit_data_models/version.rb and [`PATCH`](lib/metasploit_data_models/version.rb) to `0`.
+
+## Setup [CHANGELOG.md](CHANGELOG.md) for next release
+
+- [ ] Change `Next Release` section name at the top of [CHANGELOG.md](CHANGELOG.md) to match the current `VERSION`.
+- [ ] Add a new `Next Release` section above the `VERSION`'s section you just renamed:
+<pre>
+# Next Release
+
+* Enhancements
+* Bug Fixes
+* Deprecations
+* Incompatible Changes
+</pre>
+
+## Release to rubygems.org
+
+## jruby
+- [ ] `rvm use jruby@metasploit_data_models`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+
+## ruby-2.1
+- [ ] `rvm use ruby-2.1@metasploit_data_models`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+```
+
+### Downstream dependencies
+
+There are currently no known downstream dependencies

data/UPGRADING.md

@@ -0,0 +1 @@
+No Deprecations or Incompatible Changes have been introduced at this time

data/lib/metasploit_data_models/version.rb

@@ -1,18 +1,29 @@
 module MetasploitDataModels
   # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
   module Version
+    #
+    # CONSTANTS
+    #
+
     # The major version number.
     MAJOR = 0
     # The minor version number, scoped to the {MAJOR} version number.
     MINOR = 24
-    # The patch number, scoped to the {MAJOR} and {MINOR} version numbers.
-    PATCH = 2
+    # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
+    PATCH = 3
+
+    #
+    # Module Methods
+    #
 
-    # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the `PRERELEASE` in the
+    # The full version string, including the {MetasploitDataModels::Version::MAJOR},
+    # {MetasploitDataModels::Version::MINOR}, {MetasploitDataModels::Version::PATCH}, and optionally, the
+    # `MetasploitDataModels::Version::PRERELEASE` in the
     # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
     #
-    # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}-PRERELEASE' on any branch
-    #   other than master.
+    # @return [String] '{MetasploitDataModels::Version::MAJOR}.{MetasploitDataModels::Version::MINOR}.{MetasploitDataModels::Version::PATCH}'
+    #   on master. '{MetasploitDataModels::Version::MAJOR}.{MetasploitDataModels::Version::MINOR}.{MetasploitDataModels::Version::PATCH}-PRERELEASE'
+    #   on any branch other than master.
     def self.full
       version = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
@@ -23,19 +34,22 @@ module MetasploitDataModels
       version
     end
 
-    # The full gem version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+    # The full gem version string, including the {MetasploitDataModels::Version::MAJOR},
+    # {MetasploitDataModels::Version::MINOR}, {MetasploitDataModels::Version::PATCH}, and optionally, the
+    # `MetasploitDataModels::Version::PRERELEASE` in the
     # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
     #
-    # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
-    #   other than master.
+    # @return [String] '{MetasploitDataModels::Version::MAJOR}.{MetasploitDataModels::Version::MINOR}.{MetasploitDataModels::Version::PATCH}'
+    #   on master.  '{MetasploitDataModels::Version::MAJOR}.{MetasploitDataModels::Version::MINOR}.{MetasploitDataModels::Version::PATCH}.PRERELEASE'
+    #   on any branch other than master.
     def self.gem
       full.gsub('-', '.pre.')
     end
   end
 
-  # @see Version.gem
+  # (see Version.gem)
   GEM_VERSION = Version.gem
 
-  # @see Version.full
+  # (see Version.full)
   VERSION = Version.full
 end

data/metasploit_data_models.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.1'
 
   # ---- Dependencies ----
+  s.add_development_dependency 'metasploit-version', '~> 0.1.3'
   # documentation
   s.add_development_dependency 'metasploit-yard', '~> 1.0'
   s.add_development_dependency 'yard-activerecord', '~> 0.0.14'

data/spec/lib/metasploit_data_models/version_spec.rb

@@ -1,139 +1,3 @@
 RSpec.describe MetasploitDataModels::Version do
-  context 'CONSTANTS' do
-    context 'MAJOR' do
-      subject(:major) do
-        described_class::MAJOR
-      end
-
-      it 'is 0 because the API is not locked yet' do
-        expect(major).to eq(0)
-      end
-    end
-
-    context 'MINOR' do
-      subject(:minor) do
-        described_class::MINOR
-      end
-
-      it { is_expected.to be_a Integer }
-    end
-
-    context 'PATCH' do
-      subject(:patch) do
-        described_class::PATCH
-      end
-
-      it { is_expected.to be_a Integer }
-    end
-
-    pull_request = ENV['TRAVIS_PULL_REQUEST']
-
-    # a pull request cannot check PRERELEASE because it will be tested in the target branch, but the source itself
-    # is from the source branch and so has the source branch PRERELEASE.
-    #
-    # PRERELEASE can only be set appropriately for a merge by merging to the target branch and then updating PRERELEASE
-    # on the target branch before committing and/or pushing to github and travis-ci.
-    if pull_request.nil? || pull_request == 'false'
-      context 'PREPRELEASE' do
-        subject(:prerelease) do
-          described_class::PRERELEASE
-        end
-
-        branch = ENV['TRAVIS_BRANCH']
-
-        if branch.blank?
-          branch = `git rev-parse --abbrev-ref HEAD`.strip
-        end
-
-        if branch == 'master'
-          it 'does not have a PRERELEASE' do
-            expect(defined? described_class::PRERELEASE).to be_nil
-          end
-        else
-          branch_regex = /\A(?<type>bug|chore|feature|staging)(\/(?<story>[^\/]+))?\/(?<prerelease>[^\/]+)\z/
-          match = branch.match(branch_regex)
-
-          if match
-            it 'matches the branch relative name' do
-              expect(prerelease).to eq(match[:prerelease])
-            end
-          else
-            tag_regex = /\Av(?<major>\d+).(?<minor>\d+).(?<patch>\d+)(\.pre\.(?<prerelease>.*))?\z/
-            # travis-ci sets TRAVIS_BRANCH to the tag name for tag builds
-            match = branch.match(tag_regex)
-
-            if match
-              tag_prerelease = match[:prerelease]
-
-              if tag_prerelease
-                it 'matches the tag prerelease converted from a gem version to a VERSION' do
-                  expect(prerelease).to eq(tag_prerelease.gsub('.pre.', '-'))
-                end
-              else
-                it 'does not have a PRERELEASE' do
-                  expect(defined? described_class::PRERELEASE).to be_nil
-                end
-              end
-            else
-              it 'has a abbreviated reference that can be parsed for prerelease' do
-                fail "Do not know how to parse #{branch.inspect} for PRERELEASE"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-
-  context 'full' do
-    subject(:full) do
-      described_class.full
-    end
-
-    #
-    # lets
-    #
-
-    let(:major) do
-      1
-    end
-
-    let(:minor) do
-      2
-    end
-
-    let(:patch) do
-      3
-    end
-
-    before(:each) do
-      stub_const("#{described_class}::MAJOR", major)
-      stub_const("#{described_class}::MINOR", minor)
-      stub_const("#{described_class}::PATCH", patch)
-    end
-
-    context 'with PRERELEASE' do
-      let(:prerelease) do
-        'prerelease'
-      end
-
-      before(:each) do
-        stub_const("#{described_class}::PRERELEASE", prerelease)
-      end
-
-      it 'is <major>.<minor>.<patch>-<prerelease>' do
-        expect(full).to eq("#{major}.#{minor}.#{patch}-#{prerelease}")
-      end
-    end
-
-    context 'without PRERELEASE' do
-      before(:each) do
-        hide_const("#{described_class}::PRERELEASE")
-      end
-
-      it 'is <major>.<minor>.<patch>' do
-        expect(full).to eq("#{major}.#{minor}.#{patch}")
-      end
-    end
-  end
-end
+  it_should_behave_like 'Metasploit::Version Version Module'
+end

data/spec/lib/metasploit_data_models_spec.rb

@@ -0,0 +1,4 @@
+RSpec.describe MetasploitDataModels do
+  it_should_behave_like 'Metasploit::Version GEM_VERSION constant'
+  it_should_behave_like 'Metasploit::Version VERSION constant'
+end

data/spec/spec_helper.rb

@@ -29,14 +29,22 @@ Rails.backtrace_cleaner.remove_silencers!
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 
-engines = [
-    Metasploit::Concern::Engine,
-    Metasploit::Model::Engine,
-    MetasploitDataModels::Engine
+# Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+gem_specification = Gem::Specification.find_all_by_name('metasploit-version').first
+
+Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+  require f
+end
+
+roots = [
+    gem_specification.gem_dir,
+    Metasploit::Concern::Engine.root,
+    Metasploit::Model::Engine.root,
+    MetasploitDataModels::Engine.root
 ]
 
-engines.each do |engine|
-  support_glob = engine.root.join('spec', 'support', '**', '*.rb')
+roots.each do |root|
+  support_glob = File.join(root, 'spec', 'support', '**', '*.rb')
 
   Dir.glob(support_glob) do |path|
     require path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metasploit_data_models
 version: !ruby/object:Gem::Version
-  version: 0.24.2
+  version: 0.24.3
 platform: ruby
 authors:
 - Samuel Huckins
@@ -13,6 +13,20 @@ bindir: bin
 cert_chain: []
 date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: metasploit-version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: metasploit-yard
   requirement: !ruby/object:Gem::Requirement
@@ -247,11 +261,14 @@ files:
 - ".simplecov"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
+- UPGRADING.md
 - app/models/mdm/api_key.rb
 - app/models/mdm/client.rb
 - app/models/mdm/cred.rb
@@ -648,6 +665,7 @@ files:
 - spec/lib/metasploit_data_models/match/child_spec.rb
 - spec/lib/metasploit_data_models/match/parent_spec.rb
 - spec/lib/metasploit_data_models/version_spec.rb
+- spec/lib/metasploit_data_models_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers/match_regex_exactly.rb
 - spec/support/shared/contexts/rex/text.rb
@@ -853,6 +871,7 @@ test_files:
 - spec/lib/metasploit_data_models/match/child_spec.rb
 - spec/lib/metasploit_data_models/match/parent_spec.rb
 - spec/lib/metasploit_data_models/version_spec.rb
+- spec/lib/metasploit_data_models_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers/match_regex_exactly.rb
 - spec/support/shared/contexts/rex/text.rb