gsd-database 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 866629cf009360d0e44d5698ca214cd03804b2022894d6b699e6be0f8cdb50f7
+  data.tar.gz: 54f2ac761610f238923d78fd5dc73251bb41a98f978ea9727a6b648e11f31df7
+SHA512:
+  metadata.gz: 43460dc7a2d4b01f85644250d84805b9cbbbe1325c54eb0586d39df76c8041ad1bf14a6edb1efd834f608eadaf72c83ea9357d706fae18f27484ba2078183d0b
+  data.tar.gz: e882ce401af841e30bc036c43c7ce19ae8e52f29f41782511dc0efaa009914cdd55483c0fef329ec3f26f1d3b0bc9c7d5c56c068cd64a16e1bed4aaa59b9ea01

data/lib/gsd/database.rb

@@ -0,0 +1,134 @@
+require 'git'
+require 'json'
+
+module GSD
+  class Database
+    attr_reader :work_branch, :git_repo, :git_fork, :repo_path, :git, :default_branch
+
+    def initialize(work_branch:, git_repo:, git_fork:, repo_path:)
+      @work_branch = work_branch
+      @git_repo = git_repo
+      @git_fork = git_fork
+      @repo_path = repo_path
+      # To be set by calling sync
+      @git = nil
+      @default_branch = nil
+    end
+
+    def sync!
+      if exists?
+        open_repo
+      else
+        clone_repo
+      end
+
+      @default_branch = Git.default_branch(@git_repo)
+
+      prepare_work_branch
+    end
+
+    def modify(file_path, &block)
+      raw_json_data = File.read(file_path)
+      old_gsd_entry = JSON.parse(raw_json_data)
+      new_gsd_entry = old_gsd_entry.deep_dup
+
+      yield new_gsd_entry
+
+      if new_gsd_entry != old_gsd_entry
+        indent = json_indent_value(
+          parsed_json: old_gsd_entry,
+          raw_json: raw_json_data,
+          gsd_id: new_gsd_entry['gsd']['osvSchema']['id']
+        )
+        # Sort by key and include a trailing newline
+        contents = json_string(input: new_gsd_entry.sort.to_h, indent: indent) + "\n"
+        File.write(file_path, contents)
+        add_file(file_path)
+        puts "Staged changes!"
+      else
+        puts "No changes!"
+      end
+    end
+
+    def save!
+      status = @git.status
+      staged_files = status.changed.merge(status.added)
+      commit("Sync Ruby Advisory DB\n\n#{staged_files.count} IDs have been updated.")
+    end
+
+    def push!
+      @git.push('fork', @work_branch, force: true)
+    end
+
+    def add_file(file_path)
+      @git.add(file_path)
+    end
+
+    def commit(message)
+      @git.commit(message)
+    end
+
+    private
+
+    def json_string(input:, indent:, ascii_only: false)
+      JSON.pretty_generate(input, indent: indent, ascii_only: ascii_only).gsub(/\[\s*\]/, '[]')
+    end
+
+    def exists?
+      File.directory?(@repo_path) &&
+      !(Dir.entries(@repo_path) - %w[. ..]).empty?
+    end
+
+    def open_repo
+      @git = Git.open(@repo_path)
+      fetch_remotes
+    end
+
+    def clone_repo
+      @git = Git.clone(@git_repo, @repo_path)
+      @git.add_remote('fork', @git_fork)
+      fetch_remotes
+    end
+
+    def fetch_remotes
+      @git.fetch('origin')
+      @git.fetch('fork')
+    end
+
+    def prepare_work_branch
+      @git.branch(@work_branch).checkout
+      latest_commit = @git.remote('origin').branch(@default_branch).gcommit
+      @git.reset_hard(latest_commit)
+    end
+
+    def json_indent_value(parsed_json:, raw_json:, gsd_id:)
+      two_spaces = json_string(input: parsed_json, indent: '  ')
+      four_spaces = json_string(input: parsed_json, indent: '    ')
+      two_spaces_with_newline = two_spaces + "\n"
+      four_spaces_with_newline = four_spaces + "\n"
+      two_spaces_ascii_only = json_string(input: parsed_json, indent: '  ', ascii_only: true)
+      four_spaces_ascii_only = json_string(input: parsed_json, indent: '    ', ascii_only: true)
+      variations_of_two_spaces = [two_spaces, two_spaces_with_newline, two_spaces_ascii_only]
+      variations_of_four_spaces = [four_spaces, four_spaces_with_newline, four_spaces_ascii_only]
+      if variations_of_two_spaces.include?(raw_json)
+        '  '
+      elsif variations_of_four_spaces.include?(raw_json)
+        '    '
+      else
+        puts 'Failed to auto-detect spacing, falling back to ID range assumptions'
+        # GSD is 2021 or newer, and 1000000+, assume 2 spaces
+        if gsd_id.match?(/^GSD-202[1-9]-\d{7,}$/)
+          puts 'Newer ID in the million plus range, assuming 2 spaces'
+          '  '
+        # Valid ID, but older than 2021 or sub-million range, assume 4 spaces
+        elsif gsd_id.match?(/^GSD-\d{4}-\d{4,}$/)
+          puts 'Older ID or sub-million range, assuming 4 spaces'
+          '    '
+        else
+          puts 'Invalid ID! All bets are off, defaulting to 2 spaces...'
+          '  '
+        end
+      end
+    end
+  end
+end

data/lib/gsd/version.rb

@@ -0,0 +1,9 @@
+module GSD
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].join('.')
+  end
+end

data/lib/gsd-database.rb

@@ -0,0 +1,8 @@
+module GSD
+  autoload :Database, 'gsd/database'
+  autoload :VERSION, 'gsd/version'
+
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: gsd-database
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Josh Buker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Provides an easy way to interact with the GSD Database via Ruby.
+email: crypto@joshbuker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gsd-database.rb
+- lib/gsd/database.rb
+- lib/gsd/version.rb
+homepage: https://gsd.id
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/cloudsecurityalliance/gsd-tools/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: GSD Database Ruby Interface
+test_files: []