sarif-ruby 0.1.0

data/lib/sarif/web_request.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Describes an HTTP request.
+  class WebRequest
+    attr_accessor :index, :protocol, :version, :target, :method, :headers, :parameters, :body, :properties
+
+    def initialize(index: -1, protocol: nil, version: nil, target: nil, method: nil, headers: nil, parameters: nil, body: nil, properties: nil)
+      @index = index
+      @protocol = protocol
+      @version = version
+      @target = target
+      @method = method
+      @headers = headers
+      @parameters = parameters
+      @body = body
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["index"] = @index if @index && @index != -1
+      h["protocol"] = @protocol unless @protocol.nil?
+      h["version"] = @version unless @version.nil?
+      h["target"] = @target unless @target.nil?
+      h["method"] = @method unless @method.nil?
+      h["headers"] = @headers unless @headers.nil?
+      h["parameters"] = @parameters unless @parameters.nil?
+      h["body"] = @body&.to_h unless @body.nil?
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        index: h["index"] || -1,
+        protocol: h["protocol"],
+        version: h["version"],
+        target: h["target"],
+        method: h["method"],
+        headers: h["headers"],
+        parameters: h["parameters"],
+        body: ArtifactContent.from_hash(h["body"]),
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(WebRequest)
+      @index == other.index && @protocol == other.protocol && @version == other.version && @target == other.target && @method == other.method && @headers == other.headers && @parameters == other.parameters && @body == other.body && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@index, @protocol, @version, @target, @method, @headers, @parameters, @body, @properties].hash
+    end
+  end
+end

data/lib/sarif/web_response.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Sarif
+  # Describes the response to an HTTP request.
+  class WebResponse
+    attr_accessor :index, :protocol, :version, :status_code, :reason_phrase, :headers, :body, :no_response_received, :properties
+
+    def initialize(index: -1, protocol: nil, version: nil, status_code: nil, reason_phrase: nil, headers: nil, body: nil, no_response_received: false, properties: nil)
+      @index = index
+      @protocol = protocol
+      @version = version
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+      @body = body
+      @no_response_received = no_response_received
+      @properties = properties
+    end
+
+    def to_h
+      h = {}
+      h["index"] = @index if @index && @index != -1
+      h["protocol"] = @protocol unless @protocol.nil?
+      h["version"] = @version unless @version.nil?
+      h["statusCode"] = @status_code unless @status_code.nil?
+      h["reasonPhrase"] = @reason_phrase unless @reason_phrase.nil?
+      h["headers"] = @headers unless @headers.nil?
+      h["body"] = @body&.to_h unless @body.nil?
+      h["noResponseReceived"] = @no_response_received if @no_response_received
+      h["properties"] = @properties unless @properties.nil?
+      h
+    end
+
+    def to_json(pretty: false)
+      pretty ? JSON.pretty_generate(to_h) : JSON.generate(to_h)
+    end
+
+    def self.from_hash(h)
+      return nil if h.nil?
+      new(
+        index: h["index"] || -1,
+        protocol: h["protocol"],
+        version: h["version"],
+        status_code: h["statusCode"],
+        reason_phrase: h["reasonPhrase"],
+        headers: h["headers"],
+        body: ArtifactContent.from_hash(h["body"]),
+        no_response_received: h.key?("noResponseReceived") ? h["noResponseReceived"] : false,
+        properties: h["properties"]
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a?(WebResponse)
+      @index == other.index && @protocol == other.protocol && @version == other.version && @status_code == other.status_code && @reason_phrase == other.reason_phrase && @headers == other.headers && @body == other.body && @no_response_received == other.no_response_received && @properties == other.properties
+    end
+
+    alias eql? ==
+
+    def hash
+      [@index, @protocol, @version, @status_code, @reason_phrase, @headers, @body, @no_response_received, @properties].hash
+    end
+  end
+end

data/lib/sarif.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "sarif/version"
+
+# Generated classes
+require_relative "sarif/address"
+require_relative "sarif/artifact"
+require_relative "sarif/artifact_change"
+require_relative "sarif/artifact_content"
+require_relative "sarif/artifact_location"
+require_relative "sarif/attachment"
+require_relative "sarif/code_flow"
+require_relative "sarif/configuration_override"
+require_relative "sarif/conversion"
+require_relative "sarif/edge"
+require_relative "sarif/edge_traversal"
+require_relative "sarif/exception"
+require_relative "sarif/external_properties"
+require_relative "sarif/external_property_file_reference"
+require_relative "sarif/external_property_file_references"
+require_relative "sarif/fix"
+require_relative "sarif/graph"
+require_relative "sarif/graph_traversal"
+require_relative "sarif/invocation"
+require_relative "sarif/location"
+require_relative "sarif/location_relationship"
+require_relative "sarif/log"
+require_relative "sarif/logical_location"
+require_relative "sarif/message"
+require_relative "sarif/multiformat_message_string"
+require_relative "sarif/node"
+require_relative "sarif/notification"
+require_relative "sarif/physical_location"
+require_relative "sarif/property_bag"
+require_relative "sarif/rectangle"
+require_relative "sarif/region"
+require_relative "sarif/replacement"
+require_relative "sarif/reporting_configuration"
+require_relative "sarif/reporting_descriptor"
+require_relative "sarif/reporting_descriptor_reference"
+require_relative "sarif/reporting_descriptor_relationship"
+require_relative "sarif/result"
+require_relative "sarif/result_provenance"
+require_relative "sarif/run"
+require_relative "sarif/run_automation_details"
+require_relative "sarif/special_locations"
+require_relative "sarif/stack"
+require_relative "sarif/stack_frame"
+require_relative "sarif/suppression"
+require_relative "sarif/thread_flow"
+require_relative "sarif/thread_flow_location"
+require_relative "sarif/tool"
+require_relative "sarif/tool_component"
+require_relative "sarif/tool_component_reference"
+require_relative "sarif/translation_metadata"
+require_relative "sarif/version_control_details"
+require_relative "sarif/web_request"
+require_relative "sarif/web_response"
+
+module Sarif
+  class Error < StandardError; end
+  class ParseError < Error; end
+  class ValidationError < Error
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+      super("SARIF validation failed: #{errors.first["error"]}")
+    end
+  end
+
+  SCHEMA_PATH = File.expand_path("sarif/schema/sarif-schema-2.1.0.json", __dir__)
+
+  def self.load(path)
+    parse(File.read(path))
+  rescue Errno::ENOENT
+    raise Error, "File not found: #{path}"
+  end
+
+  def self.parse(json_string)
+    data = JSON.parse(json_string)
+    Log.from_hash(data)
+  rescue JSON::ParserError => e
+    raise ParseError, "Invalid JSON: #{e.message}"
+  rescue ArgumentError => e
+    raise ParseError, "Invalid SARIF structure: #{e.message}"
+  end
+
+  def self.dump(log, path_or_io, pretty: false)
+    json = log.to_json(pretty: pretty)
+    if path_or_io.respond_to?(:write)
+      path_or_io.write(json)
+    else
+      File.write(path_or_io, json)
+    end
+    json
+  end
+
+  def self.schema
+    @schema ||= begin
+      require "json_schemer"
+      JSONSchemer.schema(Pathname.new(SCHEMA_PATH))
+    end
+  end
+
+  def self.validate(log)
+    schema.validate(log.to_h).to_a
+  end
+
+  def self.valid?(log)
+    validate(log).empty?
+  end
+
+  def self.validate!(log)
+    errors = validate(log)
+    raise ValidationError, errors unless errors.empty?
+    true
+  end
+end

data/sig/sarif.rbs

@@ -0,0 +1,4 @@
+module Sarif
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sarif-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Nesbitt
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby library for creating, reading, and manipulating SARIF 2.1.0 files.
+  SARIF is an OASIS standard format for the output of static analysis tools.
+email:
+- andrewnez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/sarif.rb
+- lib/sarif/address.rb
+- lib/sarif/artifact.rb
+- lib/sarif/artifact_change.rb
+- lib/sarif/artifact_content.rb
+- lib/sarif/artifact_location.rb
+- lib/sarif/attachment.rb
+- lib/sarif/code_flow.rb
+- lib/sarif/configuration_override.rb
+- lib/sarif/conversion.rb
+- lib/sarif/edge.rb
+- lib/sarif/edge_traversal.rb
+- lib/sarif/exception.rb
+- lib/sarif/external_properties.rb
+- lib/sarif/external_property_file_reference.rb
+- lib/sarif/external_property_file_references.rb
+- lib/sarif/fix.rb
+- lib/sarif/graph.rb
+- lib/sarif/graph_traversal.rb
+- lib/sarif/invocation.rb
+- lib/sarif/location.rb
+- lib/sarif/location_relationship.rb
+- lib/sarif/log.rb
+- lib/sarif/logical_location.rb
+- lib/sarif/message.rb
+- lib/sarif/multiformat_message_string.rb
+- lib/sarif/node.rb
+- lib/sarif/notification.rb
+- lib/sarif/physical_location.rb
+- lib/sarif/property_bag.rb
+- lib/sarif/rectangle.rb
+- lib/sarif/region.rb
+- lib/sarif/replacement.rb
+- lib/sarif/reporting_configuration.rb
+- lib/sarif/reporting_descriptor.rb
+- lib/sarif/reporting_descriptor_reference.rb
+- lib/sarif/reporting_descriptor_relationship.rb
+- lib/sarif/result.rb
+- lib/sarif/result_provenance.rb
+- lib/sarif/run.rb
+- lib/sarif/run_automation_details.rb
+- lib/sarif/schema/sarif-schema-2.1.0.json
+- lib/sarif/special_locations.rb
+- lib/sarif/stack.rb
+- lib/sarif/stack_frame.rb
+- lib/sarif/suppression.rb
+- lib/sarif/thread_flow.rb
+- lib/sarif/thread_flow_location.rb
+- lib/sarif/tool.rb
+- lib/sarif/tool_component.rb
+- lib/sarif/tool_component_reference.rb
+- lib/sarif/translation_metadata.rb
+- lib/sarif/version.rb
+- lib/sarif/version_control_details.rb
+- lib/sarif/web_request.rb
+- lib/sarif/web_response.rb
+- sig/sarif.rbs
+homepage: https://github.com/andrew/sarif
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andrew/sarif
+  source_code_uri: https://github.com/andrew/sarif
+  changelog_uri: https://github.com/andrew/sarif/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.1
+specification_version: 4
+summary: Ruby SDK for SARIF (Static Analysis Results Interchange Format)
+test_files: []