Icarus-Mod-Tools 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b87da2114c2b631fc25173b50133591414801cab6098d8c42cfa630caa00573c
+  data.tar.gz: 58c4148ca81ac3f90c8fd2b19d11089bb09c310ff362df4b054f489eeaab5a2e
+SHA512:
+  metadata.gz: 7cb7ece0dc6f41bc01786927320978ebef9e6dc15d6fc28ee4512694f04c166a5094b16b9e0def5a8b72b9f59d2182e3535319a3c11b2966b7c549105ece6b87
+  data.tar.gz: 62493cc38c36c1da82176a4d8f8f53bd26bd98ee331ae122650f355fa9165a49db9d596eef1d2df6c928db6f63a5cd958e457ff03ecf711c4bbf15b4b2dbf023

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format doc

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 160
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - Guardfile
+    - spec/**/*_spec.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+  Exclude:
+    - spec/**/*_spec.rb
+    - lib/icarus/mod/cli/*.rb # Thor command files
+
+Metrics/PerceivedComplexity:
+  Max: 15
+  Exclude:
+    - spec/**/*_spec.rb
+    - lib/icarus/mod/cli/*.rb # Thor command files
+
+Metrics/AbcSize:
+  Max: 25
+  Exclude:
+    - lib/icarus/mod/cli/*.rb # Thor command files
+
+Metrics/MethodLength:
+  Max: 50
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - lib/icarus/mod/cli/*.rb # Thor command files

data/CHANGES.md

@@ -0,0 +1,24 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## History (reverse chronological order)
+
+### v1.3.0 - 2023-02
+
+- First public release
+- Added sorting and filtering to the `list mods` command
+- Bugfixes
+
+### v1.2.0 - 2023-01 _[Unreleased]_
+
+- initial `sync mods` working functionality
+- Bugfixes
+
+### v1.1.0 - 2022-12 _[Unreleased]_
+
+- Initial alpha release
+
+### v1.0.0 - 2022-12 _[Unreleased]_
+
+- Development

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in icarus-mod-tools.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :develop do
+  gem "guard", "~> 2.18"
+  gem "guard-rspec", "~> 4.7"
+  gem "pry", "~> 0.14.1"
+  gem "rspec", "~> 3.12"
+  gem "rubocop", "~> 1.41"
+  gem "rubocop-rspec", "~> 2.16", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,170 @@
+PATH
+  remote: .
+  specs:
+    Icarus-Mod-Tools (1.3.0)
+      google-cloud-firestore (~> 2.7)
+      octokit (~> 6.0)
+      thor (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-retry (2.0.0)
+      faraday (~> 2.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    gapic-common (0.16.0)
+      faraday (>= 1.9, < 3.a)
+      faraday-retry (>= 1.0, < 3.a)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.12, < 2.a)
+      googleapis-common-protos-types (>= 1.3.1, < 2.a)
+      googleauth (~> 1.0)
+      grpc (~> 1.36)
+    google-cloud-core (1.6.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.6.0)
+      faraday (>= 0.17.3, < 3.0)
+    google-cloud-errors (1.3.0)
+    google-cloud-firestore (2.7.2)
+      concurrent-ruby (~> 1.0)
+      google-cloud-core (~> 1.5)
+      google-cloud-firestore-v1 (~> 0.0)
+      rbtree (~> 0.4.2)
+    google-cloud-firestore-v1 (0.8.0)
+      gapic-common (>= 0.10, < 2.a)
+      google-cloud-errors (~> 1.0)
+      google-cloud-location (>= 0.0, < 2.a)
+    google-cloud-location (0.2.0)
+      gapic-common (>= 0.10, < 2.a)
+      google-cloud-errors (~> 1.0)
+    google-protobuf (3.21.12-x86_64-linux)
+    googleapis-common-protos (1.4.0)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos-types (~> 1.2)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.4.0)
+      google-protobuf (~> 3.14)
+    googleauth (1.3.0)
+      faraday (>= 0.17.3, < 3.a)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (>= 0.16, < 2.a)
+    grpc (1.50.0-x86_64-linux)
+      google-protobuf (~> 3.21)
+      googleapis-common-protos-types (~> 1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    json (2.6.3)
+    jwt (2.6.0)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    multi_json (1.15.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (6.0.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    os (1.1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbtree (0.4.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    shellany (0.0.1)
+    signet (0.17.0)
+      addressable (~> 2.8)
+      faraday (>= 0.17.5, < 3.a)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    thor (1.2.1)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  Icarus-Mod-Tools!
+  guard (~> 2.18)
+  guard-rspec (~> 4.7)
+  pry (~> 0.14.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.41)
+  rubocop-rspec (~> 2.16)
+
+BUNDLED WITH
+   2.3.14

data/Guardfile

@@ -0,0 +1,18 @@
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Donovan522
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Icarus::Mod::Tools
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/icarus/mod/tools`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add icarus-mod-tools
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install icarus-mod-tools
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/donovan522/icarus-mod-tools.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ["--color", "--format", "doc"]
+end
+
+task default: %i[spec rubocop]

data/exe/imt

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "cli/base"
+
+Icarus::Mod::CLI::Base.start

data/icarus-mod-tools.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/icarus/mod/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "Icarus-Mod-Tools"
+  spec.version = Icarus::Mod::VERSION
+  spec.authors = ["Donovan Young"]
+  spec.email = ["dyoung522@gmail.com"]
+
+  spec.summary = "Various tools for Icarus Modding"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/Donovan522/icarus-mod-tools"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGES.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "lib/icarus/mod"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "google-cloud-firestore", "~> 2.7"
+  spec.add_dependency "octokit", "~> 6.0"
+  spec.add_dependency "thor", "~> 1.2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/icarus/mod/cli/add.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "firestore"
+
+module Icarus
+  module Mod
+    module CLI
+      # Sync CLI command definitions
+      class Add < SubCommandBase
+        desc "modinfo", "Adds an entry to 'meta/modinfo/list'"
+        def modinfo(item)
+          firestore = Firestore.new
+          payload = [firestore.list(:modinfo), item].flatten.compact
+
+          puts firestore.update(:modinfo, payload, merge: true) ? "Success" : "Failure"
+        end
+
+        desc "repos", "Adds an entry to 'meta/repos/list'"
+        def repos(item)
+          firestore = Firestore.new
+          payload = [firestore.list(:repositories), item].flatten.compact
+
+          puts firestore.update(:repositories, payload, merge: true) ? "Success" : "Failure"
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/cli/base.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "version"
+require "tools"
+require "thor"
+
+module Icarus
+  module Mod
+    module CLI
+      # Base class for all subcommands
+      class SubCommandBase < Thor
+        class_option :verbose,
+                     aliases: "-v",
+                     type: :boolean,
+                     repeatable: true,
+                     default: [true],
+                     desc: "Increase verbosity. May be repeated for even more verbosity."
+
+        no_commands do
+          def check_false
+            options[:verbose] = [] if options[:verbose].include?(false)
+          end
+
+          def verbose
+            check_false
+            options[:verbose]&.count || 0
+          end
+
+          def verbose?
+            check_false
+            options[:verbose]&.count&.positive?
+          end
+        end
+
+        def self.banner(command, _namespace = nil, _subcommand = false) # rubocop:disable Style/OptionalBooleanParameter
+          "#{basename} #{subcommand_prefix} #{command.usage}"
+        end
+
+        def self.subcommand_prefix
+          name.gsub(/.*::/, "").gsub(/^[A-Z]/) { |match| match[0].downcase }.gsub(/[A-Z]/) { |match| "-#{match[0].downcase}" }
+        end
+      end
+
+      # Require subcommands after the SubCommandBase class is defined
+      require "cli/sync"
+      require "cli/list"
+      require "cli/add"
+
+      # The main CLI for Icarus Mod Tools
+      class Base < Thor
+        def self.exit_on_failure?
+          true
+        end
+
+        map %w[--version -V] => :__print_version
+
+        desc "--version, -V", "print the version and exit"
+        def __print_version
+          puts "IcarusModTool (imt) v#{Icarus::Mod::VERSION}"
+        end
+
+        desc "sync", "Syncs the databases"
+        subcommand "sync", Sync
+
+        desc "list", "Lists the databases"
+        subcommand "list", List
+
+        desc "add", "Adds entries to the databases"
+        subcommand "add", Add
+      end
+    end
+  end
+end

data/lib/icarus/mod/cli/list.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "tools/modinfo"
+
+module Icarus
+  module Mod
+    module CLI
+      # Sync CLI command definitions
+      class List < SubCommandBase
+        desc "modinfo", "Displays data from 'meta/modinfo/list'"
+        def modinfo
+          puts Firestore.new.list(:modinfo)
+        end
+
+        desc "repos", "Displays data from 'meta/repos/list'"
+        def repos
+          puts Firestore.new.list(:repositories)
+        end
+
+        desc "mods", "Displays data from 'mods'"
+        method_option :sort, type: :string, default: "name", desc: "Sort by field (name, author, etc.)"
+        method_option :filter, type: :array, default: [], desc: "Filter by field (name, author, etc.)"
+        def mods
+          valid_keys = Icarus::Mod::Tools::Modinfo::HASHKEYS + [:updated_at]
+          sort_field = options[:sort].to_sym
+          filter_field = options[:filter].first.to_sym
+          filter_value = options[:filter].last.to_s
+
+          raise "Invalid filter option" unless options[:filter]&.count == 2
+
+          raise "Invalid filter field '#{filter_field}'" unless filter_field && valid_keys.include?(filter_field)
+
+          raise "Invalid sort field '#{sort_field}'" unless valid_keys.include?(sort_field)
+
+          puts "Sorted by #{sort_field}" if sort_field && verbose > 2
+          puts "Filtered by #{filter_field} = #{filter_value}" if filter_field && verbose > 2
+
+          mods = Firestore.new.list(:mods)
+
+          # Filter by field
+          mods.select! { |mod| mod.send(filter_field).downcase =~ /#{filter_value&.downcase}/ } if filter_field
+
+          if mods.empty?
+            puts "no mods found" if verbose?
+            return
+          end
+
+          header_format = "%-<name>50s %-<author>20s %-<version>10s %-<updated_at>20s"
+          header_format += " %-<id>20s %<description>s" if verbose > 1
+
+          if verbose?
+            puts format(
+              header_format,
+              name: "NAME",
+              author: "AUTHOR",
+              version: "VERSION",
+              updated_at: "LAST UPDATED",
+              id: "ID",
+              description: "DESCRIPTION"
+            )
+          end
+
+          # Sort by field, optionally subsorting by name
+          (sort_field == :name ? mods.sort_by(&:name) : mods.sort_by { |mod| [mod.send(sort_field), mod.name] }).each do |mod|
+            data_format = "%-<name>50s %-<author>20s v%-<version>10s%-<updated_at>20s"
+            data_format += " %-<id>20s %<description>s" if verbose > 1
+
+            puts format(data_format, mod.to_h.merge(id: mod.id, updated_at: mod.updated_at.strftime("%Y-%m-%d %H:%M:%S")))
+          end
+
+          puts "Total: #{mods.count}" if verbose?
+        rescue StandardError => e
+          puts e.message
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/cli/sync.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "tools/modinfo_sync"
+require "tools/mod_sync"
+
+module Icarus
+  module Mod
+    module CLI
+      # Sync CLI command definitions
+      class Sync < SubCommandBase
+        desc "modinfo", "Reads from 'meta/repos/list' and Syncs any modinfo files we find (github only for now)"
+        def modinfo
+          modinfo_sync = Icarus::Mod::Tools::ModinfoSync.new
+
+          puts "Retrieving repository Data..." if verbose?
+          repositories = modinfo_sync.repositories
+
+          raise "Unable to find any repositories!" unless repositories.any?
+
+          puts "Retrieving modinfo Array..." if verbose?
+          modinfo_array = modinfo_sync.modinfo_data(repositories, verbose: verbose > 1)&.map(&:download_url)&.compact
+
+          raise "Unable to find any modinfo.json files!" unless modinfo_array&.any?
+
+          puts "Saving to Firestore..." if verbose?
+          response = modinfo_sync.update(modinfo_array)
+          puts response ? "Success" : "Failure (may be no changes)" if verbose?
+        end
+
+        desc "mods", "Reads from 'meta/modinfo/list' and updates the 'mods' database accordingly"
+        def mods
+          modsync = Icarus::Mod::Tools::ModSync.new
+
+          puts "Retrieving modinfo Data..." if verbose?
+          modinfo_array = modsync.modinfo_array
+
+          puts "Retrieving mod Data..." if verbose?
+          mod_array = modsync.mods
+
+          puts "Updating mod Data..." if verbose?
+          modinfo_array.each do |mod|
+            verb = "Creating"
+            doc_id = modsync.find_mod(mod)
+
+            if doc_id
+              puts "Found existing mod #{mod.name} at #{doc_id}" if verbose > 2
+              mod.id = doc_id
+              verb = "Updating"
+            end
+
+            print format("#{verb} %-<name>60s", name: "'#{mod.author || "NoOne"}/#{mod.name || "Unnamed"}'") if verbose > 1
+            response = modsync.update(mod)
+            puts format("%<status>10s", status: response ? "Success" : "Failure") if verbose > 1
+          end
+
+          puts "Created/Updated #{modinfo_array.count} mods" if verbose?
+
+          delete_array = mod_array.filter { |mod| modsync.find_modinfo(mod).nil? }
+
+          return unless delete_array.any?
+
+          puts "Deleting outdated mods..." if verbose?
+          delete_array.each do |mod|
+            print format("Deleting %-<name>60s", name: "'#{mod.author || "NoOne"}/#{mod.name || "Unnamed'"}") if verbose > 1
+            response = modsync.delete(mod)
+            puts format("%<status>10s", status: response ? "Success" : "Failure") if verbose > 1
+          end
+
+          puts "Deleted #{delete_array.count} outdated mods" if verbose?
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/firestore.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "google/cloud/firestore"
+require "tools/modinfo"
+
+module Icarus
+  module Mod
+    # Helper methods for interacting with the Firestore API
+    class Firestore
+      attr_reader :client
+
+      COLLECTIONS = {
+        modinfo: "meta/modinfo",
+        repositories: "meta/repos",
+        mods: "mods"
+      }.freeze
+
+      def initialize
+        @client = Google::Cloud::Firestore.new(project_id: "projectdaedalus-fb09f", credentials: ENV.fetch("GOOGLE_APPLICATION_CREDENTIALS", nil))
+      end
+
+      def repos
+        @repos ||= list(:repositories)
+      end
+
+      def modinfo_array
+        @modinfo_array ||= list(:modinfo)
+      end
+
+      def mods
+        @mods ||= list(:mods)
+      end
+
+      def find_mod(field, value)
+        mods.find { |mod| mod.send(field) == value }
+      end
+
+      def list(type)
+        case type
+        when :modinfo
+          @client.doc(COLLECTIONS[:modinfo]).get[:list]
+        when :repositories
+          @client.doc(COLLECTIONS[:repositories]).get[:list]
+        when :mods
+          @client.col(COLLECTIONS[:mods]).get.map do |doc|
+            Icarus::Mod::Tools::Modinfo.new(doc.data, id: doc.document_id, created: doc.create_time, updated: doc.update_time)
+          end
+        else
+          raise "Invalid type: #{type}"
+        end
+      end
+
+      def update_or_create_mod(payload, merge:)
+        doc_id = payload.id || find_mod(:name, payload.name)&.id
+
+        return @client.doc("#{COLLECTIONS[:mods]}/#{doc_id}").set(payload.to_h, merge:) if doc_id
+
+        @client.col(COLLECTIONS[:mods]).add(payload.to_h)
+      end
+
+      def update(type, payload, merge: false)
+        raise "You must specify a payload to update" if payload&.empty? || payload.nil?
+
+        case type
+        when :modinfo
+          response = @client.doc(COLLECTIONS[:modinfo]).set({ list: payload }, merge:)
+        when :repositories
+          response = @client.doc(COLLECTIONS[:repositories]).set({ list: payload }, merge:)
+        when :mod
+          response = update_or_create_mod(payload, merge:)
+        else
+          raise "Invalid type: #{type}"
+        end
+
+        response.is_a?(Google::Cloud::Firestore::DocumentReference) || response.is_a?(Google::Cloud::Firestore::CommitResponse::WriteResult)
+      end
+
+      def delete(type, payload)
+        case type
+        when :mod
+          response = @client.doc("#{COLLECTIONS[:mods]}/#{payload.id}").delete
+        else
+          raise "Invalid type: #{type}"
+        end
+
+        response.is_a?(Google::Cloud::Firestore::CommitResponse::WriteResult)
+      end
+    end
+  end
+end

data/lib/icarus/mod/github.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "octokit"
+
+module Icarus
+  module Mod
+    # Helper methods for interacting with the Github API
+    class Github
+      attr_reader :client, :resources
+
+      def initialize(repo = nil)
+        self.repository = repo if repo
+        @client = Octokit::Client.new(access_token: ENV.fetch("GITHUB_TOKEN", nil))
+        @resources = []
+      end
+
+      def repository
+        raise "You must specify a repository to use" unless @repository
+
+        @repository
+      end
+
+      def repository=(repo)
+        @resources = [] # reset the resources cache
+        @repository = repo.gsub(%r{https?://.*github\.com/}, "")
+      end
+
+      # Recursively returns all resources in the repository
+      #  path: the path to search in
+      #  cache: whether to use the cached resources
+      #  recursive: whether to recursively search subdirectories
+      def all_files(path: nil, cache: true, recursive: false, &block)
+        # If we've already been called for this repository, use the cached resources
+        use_cache = @resources.any? && cache
+
+        if use_cache
+          @resources.each { |file| block.call(file) } if block_given?
+        else
+          @client.contents(repository, path:).each do |entry|
+            if entry[:type] == "dir"
+              all_files(path: entry[:path], cache: false, recursive: true, &block) if recursive
+              next # we don't need directories in our output
+            end
+
+            block.call(entry) if block_given?
+            @resources << entry # cache the file
+          end
+        end
+
+        @resources unless block_given?
+      end
+
+      def find(pattern)
+        all_files { |file| return file if file[:name] =~ /#{pattern}/i }
+      end
+
+      def get_contents(url)
+        @client.contents(url)
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/mod_sync.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "tools/sync_helpers"
+
+module Icarus
+  module Mod
+    module Tools
+      # Sync methods
+      class ModSync
+        include SyncHelpers
+
+        def initialize
+          @firestore = Firestore.new
+        end
+
+        def mods
+          @firestore.mods
+        end
+
+        def modinfo_array
+          @modinfo_array ||= @firestore.modinfo_array.map do |url|
+            retrieve_from_url(url)[:mods].map { |mod| Modinfo.new(mod) }
+          end.flatten
+        end
+
+        def find_mod(modinfo)
+          @firestore.find_mod(:name, modinfo.name)&.id
+        end
+
+        def find_modinfo(modinfo)
+          @modinfo_array.find { |mod| mod.name == modinfo.name }
+        end
+
+        def update(modinfo)
+          @firestore.update(:mod, modinfo, merge: false)
+        end
+
+        def delete(modinfo)
+          @firestore.delete(:mod, modinfo)
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/modinfo.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Icarus
+  module Mod
+    module Tools
+      # Sync methods
+      class Modinfo
+        attr_reader :data, :id, :created_at, :updated_at
+
+        HASHKEYS = %i[name author version compatibility description fileType fileURL].freeze
+
+        def initialize(data, id: nil, created: nil, updated: nil)
+          @id = id
+          @created_at = created
+          @updated_at = updated
+          read(data)
+        end
+
+        def read(data)
+          @data = data.is_a?(String) ? JSON.parse(data, symbolize_names: true) : data
+        end
+
+        def to_json(*args)
+          JSON.generate(@data, *args)
+        end
+
+        def to_h
+          @data || {}
+        end
+
+        def to_s
+          format(
+            "%-<name>30s %-<author>20s v%-<version>10s %<description>s",
+            name:, author:, version: (version || "None"), description:
+          )
+        end
+
+        def method_missing(method_name, *_args, &)
+          to_h[method_name.to_sym]&.strip
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          @data&.key?(method_name.to_sym) || super
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/modinfo_sync.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "github"
+require "tools/sync_helpers"
+
+module Icarus
+  module Mod
+    module Tools
+      # Sync methods
+      class ModinfoSync
+        include SyncHelpers
+
+        def initialize
+          @firestore = Firestore.new
+          @github = Github.new
+          @repositories = []
+        end
+
+        def repositories
+          @firestore.repos
+        end
+
+        def update(modinfo_array)
+          @firestore.update(:modinfo, modinfo_array)
+        end
+
+        def modinfo(url)
+          retrieve_from_url(url)
+        end
+
+        def modinfo_data(repositories, verbose: false)
+          repositories.map do |repo|
+            print "searching #{repo}..." if verbose
+
+            case repo
+            when /github/
+              @github.repository = repo
+              modinfo_url = @github.find("modinfo.json")
+
+              unless modinfo_url
+                puts "Skipped...no modinfo.json" if verbose
+                next
+              end
+
+              puts "Found!" if verbose
+              modinfo_url
+            else
+              puts "Skipped...repository type not supported yet" if verbose
+            end
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/sync_helpers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+
+module Icarus
+  module Mod
+    module Tools
+      # Sync helper methods
+      module SyncHelpers
+        def retrieve_from_url(url)
+          res = Net::HTTP.get_response(URI(url))
+
+          raise "HTTP Request failed (#{res.code}): #{res.message}" unless res&.code == "200"
+
+          JSON.parse(res.body, symbolize_names: true)
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "github"
+
+module Icarus
+  module Mod
+    module Tools
+      class Error < StandardError; end
+    end
+  end
+end

data/lib/icarus/mod/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Icarus
+  module Mod
+    VERSION = "1.3.0"
+  end
+end

data/sig/database/sync/sync.rbs

@@ -0,0 +1,15 @@
+# See the writing guide of rbs: https://github.com/ruby/rbs#guides
+#
+module Icarus
+  module Mod
+    class Github
+      attr_reader :client: Octokit::Client
+      attr_accessor :repo: String
+
+      def initialize: (void) -> void
+      def all_files: (String) -> Array[String]
+
+      VERSION: String
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: Icarus-Mod-Tools
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Donovan Young
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-firestore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Various tools for Icarus Modding
+email:
+- dyoung522@gmail.com
+executables:
+- imt
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGES.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- exe/imt
+- icarus-mod-tools.gemspec
+- lib/icarus/mod/cli/add.rb
+- lib/icarus/mod/cli/base.rb
+- lib/icarus/mod/cli/list.rb
+- lib/icarus/mod/cli/sync.rb
+- lib/icarus/mod/firestore.rb
+- lib/icarus/mod/github.rb
+- lib/icarus/mod/tools.rb
+- lib/icarus/mod/tools/mod_sync.rb
+- lib/icarus/mod/tools/modinfo.rb
+- lib/icarus/mod/tools/modinfo_sync.rb
+- lib/icarus/mod/tools/sync_helpers.rb
+- lib/icarus/mod/version.rb
+- sig/database/sync/sync.rbs
+homepage: https://github.com/Donovan522/icarus-mod-tools
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Donovan522/icarus-mod-tools
+  source_code_uri: https://github.com/Donovan522/icarus-mod-tools
+  changelog_uri: https://github.com/Donovan522/icarus-mod-tools/CHANGES.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- lib/icarus/mod
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Various tools for Icarus Modding
+test_files: []