postmodern/cvelist.rb

require 'cvelist/exceptions'
require 'cve_schema/cve'
require 'multi_json'

module CVEList
  #
  # @see https://rubydoc.info/gems/cve_schema/CVESchema/CVE/frames
  #
  class CVE < CVESchema::CVE

    # The path to the CVE JSON.
    #
    # @return [String]
    attr_reader :path

    #
    # Initializes the CVE.
    #
    # @param [String] path
    #   The path to the CVE JSON.
    #
    def initialize(path, **kwargs)
      super(**kwargs)

      @path = path
    end

    #
    # Parses the given JSON.
    #
    # @param [String] json
    #   The raw JSON.
    #
    # @return [Hash{String => Object}]
    #   The parsed JSON.
    #
    # @raise [InvalidJSON]
    #   Could not parse the JSON in the given file.
    #
    # @api semipublic
    #
    def self.parse(json)
      MultiJson.load(json)
    rescue MultiJson::ParseError => error
      raise(InvalidJSON,error.message)
    end

    #
    # Parses the JSON in the given file.
    #
    # @param [String] file
    #   The path to the file.
    #
    # @return [Hash{String => Object}]
    #   The parsed JSON.
    #
    # @raise [InvalidJSON]
    #   Could not parse the JSON in the given file.
    #
    # @api semipublic
    #
    def self.read(file)
      parse(File.read(file))
    end

    #
    # Loads the CVE JSON from the given file.
    #
    # @param [String] file
    #   The path to the file.
    #
    # @return [CVE]
    #   The loaded CVE object.
    #
    # @raise [InvalidJSON, MissingJSONKey, UnknownJSONValue]
    #   Failed to load the CVE JSON.
    #
    def self.load(file)
      new(file, **from_json(read(file)))
    end

  end
end