BMT class structure

Author: fedetaglia

bin/console

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'vrt'
+require 'bmt'
 require 'pry'
 
-# An interactive console for the VRT gem
+# An interactive console for the BMT gem
 
 Pry.start

bmt.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['[email protected]']
   spec.date          = Date.today.to_s
   spec.summary       = 'Ruby wrapper for Bugcrowd\'s Methodology Taxonomy'
-  spec.homepage      = 'https://github.com/bugcrowd/vrt-ruby'
+  spec.homepage      = 'https://github.com/bugcrowd/bmt-ruby'
   spec.license       = 'MIT'
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.5'

lib/bmt.rb

@@ -1,2 +1,72 @@
+require 'bmt/item'
+require 'bmt/methodology'
+require 'bmt/step'
+
+require 'date'
+require 'json'
+require 'pathname'
+
 module BMT
+  class VersionNotFoundError < StandardError; end
+  class MethodologyNotFoundError < StandardError; end
+  DATA_DIR = Pathname.new(__dir__).join('data')
+
+  # memoize loaded
+  @methodologies = {}
+  @methodology_keys = {}
+
+  module_function
+
+  # returns a Methodology object given a key and a version
+  def find(key, version: current_version)
+    raise VersionNotFoundError unless versions.include?(version)
+    raise MethodologyNotFoundError unless methodology_keys(version: version).include?(key)
+
+    @methodologies[version].nil? && @methodologies[version] = {}
+
+    @methodologies[version][key] ||= Methodology.new(
+      key: key,
+      version: version,
+      attributes: methodology_json(key, version: version)
+    )
+
+    @methodologies[version][key]
+  end
+
+  def current_version
+    versions.first
+  end
+
+  # returns available methodology keys for a given version
+  def methodology_keys(version: current_version)
+    @methodology_keys[version] ||=
+      DATA_DIR.join(version, 'methodologies').entries
+              .map(&:basename)
+              .map(&:to_s)
+              .select { |dirname| dirname =~ /json/ }
+              .map { |filepath| File.basename(filepath, File.extname(filepath)) }
+  end
+
+  # Infer the avialable versions of the BMT from the names of the files
+  # in the repo.
+  # The returned list is in order with the current version first.
+  def versions
+    @versions ||= json_dir_names.sort.reverse!
+  end
+
+  def methodology_json(key, version: current_version)
+    JSON.parse(methodology_pathname(key, version: version).read)
+  end
+
+  def methodology_pathname(key, version: current_version)
+    DATA_DIR.join(version, 'methodologies', "#{key}.json")
+  end
+
+  # Get names of directories matching lib/data/<major>-<minor>/
+  def json_dir_names
+    DATA_DIR.entries
+            .map(&:basename)
+            .map(&:to_s)
+            .select { |dirname| dirname =~ /^[0-9]+\.[0-9]/ }.sort
+  end
 end

lib/bmt/item.rb

@@ -0,0 +1,13 @@
+module BMT
+  class Item
+    attr_reader :key, :title, :description, :vrt_category, :step
+
+    def initialize(step:, attributes:)
+      @step = step
+      @key = attributes['key']
+      @title = attributes['title']
+      @description = attributes['description']
+      @vrt_category = attributes['vrt_category']
+    end
+  end
+end

lib/bmt/methodology.rb

@@ -0,0 +1,29 @@
+module BMT
+  class Methodology
+    attr_reader :key, :version, :title, :description, :vrt_version
+
+    def initialize(key:, version:, attributes: {})
+      @key = key
+      @version = version
+      @title = attributes.dig('metadata', 'title')
+      @release_date = attributes.dig('metadata', 'release_date')
+      @description = attributes.dig('metadata', 'description')
+      @vrt_version = attributes.dig('metadata', 'vrt_version')
+
+      @steps_data = attributes.dig('content', 'steps')
+    end
+
+    def release_date
+      Date.parse(@release_date)
+    end
+
+    def steps
+      @steps ||= @steps_data.map do |step_data|
+        Step.new(
+          methodology: self,
+          attributes: step_data
+        )
+      end
+    end
+  end
+end

lib/bmt/step.rb

@@ -0,0 +1,22 @@
+module BMT
+  class Step
+    attr_reader :key, :title, :description, :methodology
+
+    def initialize(methodology:, attributes:)
+      @methodology = methodology
+      @key = attributes['key']
+      @title = attributes['title']
+      @description = attributes['description']
+      @items_data = attributes['items']
+    end
+
+    def items
+      @items ||= @items_data.map do |item_data|
+        Item.new(
+          step: self,
+          attributes: item_data
+        )
+      end
+    end
+  end
+end

spec/bmt/item_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BMT::Item do
+  let(:step) { methodology.steps.first }
+  let(:methodology) { BMT.find(methodology_key) }
+  let(:methodology_json) { BMT.methodology_json(methodology_key) }
+  let(:attributes) { methodology_json.dig('content', 'steps', 0, 'items', 0) }
+  let(:methodology_key) { 'outback-animal-testing' }
+
+  describe '#new' do
+    subject do
+      described_class.new(
+        step: step,
+        attributes: attributes
+      )
+    end
+
+    it 'initialize an item' do
+      expect(subject).to be_a(described_class)
+
+      expect(subject.key).to eq('marsupial')
+      expect(subject.title).to be_a(String)
+      expect(subject.description).to be_a(String)
+      expect(subject.vrt_category).to be_a(String)
+      expect(subject.step).to eq(step)
+    end
+  end
+end

spec/bmt/methodology_spec.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BMT::Methodology do
+  describe '#new' do
+    subject do
+      described_class.new(key: methodology_key,
+                          version: version,
+                          attributes: methodology_json)
+    end
+
+    context 'with valid args' do
+      let(:methodology_key) { 'outback-animal-testing' }
+      let(:version) { '2.1' }
+      let(:methodology_json) { BMT.methodology_json(methodology_key) }
+
+      it 'initialize a methodology' do
+        expect(subject).to be_a(described_class)
+
+        expect(subject.key).to eq('outback-animal-testing')
+        expect(subject.title).to eq('The Outback Animal Checklist')
+        expect(subject.description).to be_a(String)
+      end
+    end
+  end
+
+  describe '#steps' do
+    subject do
+      described_class.new(key: methodology_key,
+                          version: version,
+                          attributes: methodology_json).steps
+    end
+
+    let(:methodology_key) { 'outback-animal-testing' }
+    let(:version) { '2.1' }
+    let(:methodology_json) { BMT.methodology_json(methodology_key) }
+
+    it 'returns a list of BMT Steps' do
+      expect(subject.first).to be_a(BMT::Step)
+
+      expect(subject).to match_array(
+        [
+          an_object_having_attributes(
+            key: 'koala',
+            title: 'Check that you have a Koala',
+            description: an_instance_of(String),
+            items: match_array(
+              [
+                an_object_having_attributes(
+                  key: 'marsupial',
+                  title: an_instance_of(String),
+                  description: an_instance_of(String),
+                  vrt_category: an_instance_of(String)
+                ),
+                an_object_having_attributes(
+                  key: 'diet',
+                  title: an_instance_of(String),
+                  description: an_instance_of(String)
+                ),
+                an_object_having_attributes(
+                  key: 'behavior',
+                  title: an_instance_of(String),
+                  description: an_instance_of(String)
+                )
+              ]
+            )
+          ),
+          an_object_having_attributes(
+            key: 'kangaroo',
+            title: 'Ensure you have a kangaroo',
+            description: an_instance_of(String),
+            items: match_array(
+              [
+                an_object_having_attributes(
+                  key: 'marsupial',
+                  title: an_instance_of(String),
+                  description: an_instance_of(String)
+                ),
+                an_object_having_attributes(
+                  key: 'tail',
+                  title: an_instance_of(String),
+                  description: an_instance_of(String)
+                ),
+                an_object_having_attributes(
+                  key: 'jump',
+                  title: an_instance_of(String),
+                  description: an_instance_of(String)
+                )
+              ]
+            )
+          )
+        ]
+      )
+    end
+  end
+end

spec/bmt/step_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BMT::Step do
+  let(:methodology) { BMT.find(methodology_key) }
+  let(:methodology_json) { BMT.methodology_json(methodology_key) }
+  let(:attributes) { methodology_json.dig('content', 'steps', 0) }
+  let(:methodology_key) { 'outback-animal-testing' }
+
+  describe '#new' do
+    subject do
+      described_class.new(
+        methodology: methodology,
+        attributes: attributes
+      )
+    end
+
+    it 'initialize a step' do
+      expect(subject).to be_a(described_class)
+
+      expect(subject.key).to eq('koala')
+      expect(subject.title).to be_a(String)
+      expect(subject.description).to be_a(String)
+      expect(subject.methodology).to eq(methodology)
+    end
+  end
+
+  describe '#items' do
+    subject do
+      described_class.new(
+        methodology: methodology,
+        attributes: attributes
+      ).items
+    end
+
+    it 'returns a list of BMT Items' do
+      expect(subject.first).to be_a(BMT::Item)
+
+      expect(subject).to match_array(
+        [
+          an_object_having_attributes(key: 'marsupial'),
+          an_object_having_attributes(key: 'diet'),
+          an_object_having_attributes(key: 'behavior')
+        ]
+      )
+    end
+  end
+end