cve_schema 0.1.0

data/lib/cve_schema/cve/na.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module CVESchema
+  class CVE
+    # The `n/a` constant.
+    NA = 'n/a'
+  end
+end

data/lib/cve_schema/cve/problem_type.rb

@@ -0,0 +1,56 @@
+require 'cve_schema/cve/description'
+
+module CVESchema
+  class CVE
+    #
+    # Represents an element within the `"problemtype_data"` JSON Array.
+    #
+    class ProblemType
+
+      # @return [Array<Description>]
+      attr_reader :description
+
+      alias descriptions description
+
+      #
+      # Initializes the problem-type object.
+      #
+      # @param [Array<Description>] description
+      #
+      def initialize(description)
+        @description = description
+      end
+
+      #
+      # Maps the parsed JSON to an Array of {Description} objects for
+      # {#initialize}.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Array<Description>]
+      #
+      # @api semipublic
+      #
+      def self.from_json(json)
+        json['description'].map(&Description.method(:load))
+       end
+
+      #
+      # Loads the problem-type object from parsed JSON.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [ProblemType]
+      #   The loaded problem-type object.
+      #
+      # @api semipublic
+      #
+      def self.load(json)
+        new(from_json(json))
+      end
+
+    end
+  end
+end

data/lib/cve_schema/cve/product.rb

@@ -0,0 +1,79 @@
+require 'cve_schema/cve/version'
+require 'cve_schema/cve/na'
+
+module CVESchema
+  class CVE
+    #
+    # Represents a product element within the `"product_data"` JSON Array.
+    #
+    class Product
+
+      # The product name.
+      #
+      # @return [String]
+      attr_reader :product_name
+
+      # The list of affected versions.
+      #
+      # @return [Array<Version>]
+      attr_reader :version
+
+      alias versions version
+
+      #
+      # Initializes the product.
+      #
+      # @param [String] product_name
+      #
+      # @param [Array<Version>] version
+      #
+      def initialize(product_name: , version: [])
+        @product_name = product_name
+        @version      = version
+      end
+
+      #
+      # Determines if the {#product_name} is `n/a`.
+      #
+      # @return [Boolean]
+      #
+      def na?
+        @product_name == NA
+      end
+
+      #
+      # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Hash{Symbol => Object}]
+      #   The mapped Symbol Hash.
+      #
+      # @api semipublic
+      #
+      def self.from_json(json)
+        {
+          product_name: json['product_name'],
+          version:      Array(json['version']['version_data']).map(&Version.method(:load))
+        }
+      end
+
+      #
+      # Loads the product object from parsed JSON.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Product]
+      #   The loaded product.
+      #
+      # @api semipublic
+      #
+      def self.load(json)
+        new(**from_json(json))
+      end
+
+    end
+  end
+end

data/lib/cve_schema/cve/reference.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module CVESchema
+  class CVE
+    #
+    # Represents a reference object within the `"reference_data"` JSON Array.
+    #
+    class Reference
+
+      # Reference URL.
+      #
+      # @return [String]
+      attr_reader :url
+
+      # Optional reference name.
+      #
+      # @return [String, nil]
+      attr_reader :name
+
+      REFSOURCES = {
+        'MISC' => :MISC
+      }
+      REFSOURCES.default_proc = proc { |hash,key| key }
+
+      # Optional reference source identifier.
+      #
+      # @return [:MISC, String, nil]
+      attr_reader :refsource
+
+      alias ref_source refsource
+
+      #
+      # Initializes the reference.
+      #
+      # @param [String] url
+      #
+      # @param [nil, String] name
+      #
+      # @param [nil, :MISC, String] refsource
+      #
+      def initialize(url: , name: nil, refsource: nil)
+        @url = url
+        @name = name
+        @refsource = refsource
+      end
+
+      #
+      # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Hash{Symbol => Object}]
+      #   The mapped Symbol Hash.
+      #
+      # @api semipublic
+      #
+      def self.from_json(json)
+        {
+          url:  json['url'],
+          name: json['name'],
+          refsource: REFSOURCES[json['refsource']]
+        }
+      end
+
+      #
+      # Loads the reference from the parsed JSON.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Reference]
+      #
+      # @api semipublic
+      #
+      def self.load(json)
+        new(**from_json(json))
+      end
+
+    end
+  end
+end

data/lib/cve_schema/cve/solution.rb

@@ -0,0 +1,14 @@
+require 'cve_schema/cve/has_lang_value'
+
+module CVESchema
+  class CVE
+    #
+    # Represents a solution object within the `"solutions"` JSON Array.
+    #
+    class Solution
+
+      include HasLangValue
+
+    end
+  end
+end

data/lib/cve_schema/cve/source.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module CVESchema
+  class CVE
+    #
+    # Represents the `"source"` JSON object.
+    #
+    class Source
+
+      # @return [Array<String>, nil]
+      attr_reader :defect
+
+      DISCOVERY = {
+        'INTERNAL' => :INTERNAL,
+        'EXTERNAL' => :EXTERNAL,
+        'USER'     => :USER,
+        'UNKNOWN'  => :UNKNOWN
+      }
+
+      # @return [:INTERNAL, :EXTERNAL, :USER, :UNKNOWN]
+      attr_reader :discovery
+
+      # @return [String, nil]
+      attr_reader :advisory
+
+      #
+      # Initializes the source object.
+      #
+      # @param [Array<String>, nil] defect
+      #
+      # @param [:INTERNAL, :EXTERNAL, :USER, :UNKNOWN] discovery
+      #
+      # @param [String, nil] advisory
+      #
+      def initialize(discovery: , defect: nil, advisory: nil)
+        @defect    = defect
+        @discovery = discovery
+        @advisory  = advisory
+      end
+
+      #
+      # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Hash{Symbol => Object}]
+      #   The mapped Symbol Hash.
+      #
+      def self.from_json(json)
+        {
+          defect:    json['defect'],
+          discovery: DISCOVERY[json['discovery']],
+          advisory:  json['advisory']
+        }
+      end
+
+      #
+      # Loads the source from the parsed JSON.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Source]
+      #   The loaded source object.
+      #
+      # @api semipublic
+      #
+      def self.load(json)
+        new(**from_json(json))
+      end
+
+    end
+  end
+end

data/lib/cve_schema/cve/timeline.rb

@@ -0,0 +1,65 @@
+require 'cve_schema/cve/timestamp'
+require 'cve_schema/cve/has_lang_value'
+
+module CVESchema
+  class CVE
+    #
+    # Represents a timeline entry in the `"timeline"` JSON Array.
+    #
+    class Timeline
+
+      include HasLangValue
+
+      # The time of the timeline event.
+      #
+      # @return [DateTime]
+      attr_reader :time
+
+      #
+      # Initializes the timeline object.
+      #
+      # @param [DateTime] time
+      #
+      def initialize(time: , **kargs)
+        super(**kargs)
+
+        @time = time
+      end
+
+      #
+      # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Hash{Symbol => Object}]
+      #   The mapped Symbol Hash.
+      #
+      # @api semipublic
+      #
+      def self.from_json(json)
+        {
+          lang: json['lang'],
+          time: Timestamp.parse(json['time']),
+          value: json['value']
+        }
+      end
+
+      #
+      # Loads the timeline object from the parsed JSON.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Timeline]
+      #   The loaded timeline object.
+      #
+      # @api semipublic
+      #
+      def self.load(json)
+        new(**from_json(json))
+      end
+
+    end
+  end
+end

data/lib/cve_schema/cve/timestamp.rb

@@ -0,0 +1,25 @@
+require 'cve_schema/exceptions'
+require 'time'
+
+module CVESchema
+  class CVE
+    module Timestamp
+      #
+      # Parses a CVE timestamp (ISO 8601).
+      #
+      # @param [String] timestamp
+      #   The raw timestamp String.
+      #
+      # @return [DateTime]
+      #   The parsed ISO 8601 timestamp.
+      #
+      # @see https://github.com/CVEProject/cve-schema/blob/master/schema/v4.0/DRAFT-JSON-file-format-v4.md#timestamps
+      #
+      def self.parse(timestamp)
+        DateTime.iso8601(timestamp)
+      rescue Date::Error
+        raise InvalidJSON.new("invalid ISO-8601 timestamp: #{timestamp.inspect}")
+      end
+    end
+  end
+end

data/lib/cve_schema/cve/vendor.rb

@@ -0,0 +1,83 @@
+require 'cve_schema/cve/product'
+require 'cve_schema/cve/na'
+
+module CVESchema
+  class CVE
+    #
+    # Represents an element within the `"vendor_data"` JSON Array.
+    #
+    class Vendor
+
+      # @return [String]
+      attr_reader :vendor_name
+
+      # @return [Array<Product>]
+      attr_reader :product
+
+      #
+      # Initializes the vendor object.
+      #
+      # @param [String] vendor_name
+      #
+      # @param [Array<Product>] product
+      #
+      def initialize(vendor_name: , product: )
+        @vendor_name = vendor_name
+        @product     = product
+      end
+
+      #
+      # Determines if the {#vendor_name} is `n/a`.
+      #
+      # @return [Boolean]
+      #
+      def na?
+        @vendor_name == NA
+      end
+
+      #
+      # Converts the vendor object to a String.
+      #
+      # @return [String]
+      #   The vendor name
+      #
+      def to_s
+        @vendor_name
+      end
+
+      #
+      # Maps the parsed JSON to a Symbol Hash for {#initialize}.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Hash{Symbol => Object}]
+      #   The mapped Symbol Hash.
+      #
+      # @api semipublic
+      #
+      def self.from_json(json)
+        {
+          vendor_name: json['vendor_name'],
+          product:     json['product']['product_data'].map(&Product.method(:load))
+        }
+      end
+
+      #
+      # Loads the vendor object from the parsed JSON.
+      #
+      # @param [Hash{String => Object}] json
+      #   The parsed JSON.
+      #
+      # @return [Vendor]
+      #   The loaded vendor object.
+      #
+      # @api semipublic
+      #
+      def self.load(json)
+        new(**from_json(json))
+      end
+
+    end
+  end
+end