Icarus-Mod-Tools 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28209aff7606ef684d02fae74f71d498986d7d2f9d1628a84bc32dd2670c6515
-  data.tar.gz: 26264df40cf51c3f13255262669b4615387f90010a3fec39be407c3cf3c1719b
+  metadata.gz: 454c2e99f2453a91be33c028cc37cdd9316527aa45aac5f991f289a1e66c7d59
+  data.tar.gz: fdd4d5721b78a638f61be06585bb51679472e17ce8085ea4960340aa0f0ddab4
 SHA512:
-  metadata.gz: 32b1496f4423e4ad71231b4311061c2baf8f4d053ebbfb3f8461871b1482b589fb4f15defe272da98794157b7ca14b92f9af45c271dedccad5a2dd806078762d
-  data.tar.gz: bc14687a8e9c9217e486c48f89b63094250119e0d9494027873a56c97daa00b73b2f39315b25cdd413ea2d92cbdfc1da8355276834ea86e4389dbe1af8cab4b8
+  metadata.gz: 22ca382cfd35209e8ee6cdf883bdbd51098a7e159c5dfb5bf3f5afdc1a89656989338bf5a3bd1e3df9e4911deef342b4260b63aa4b18c42bd68afff0eddcd511
+  data.tar.gz: 99fa6667462a2f5d6e509bb918da9f76bebcde5bf89c41acc9809a1b726251aa189cd37a7d841585534280b4fbfa37c6ad29f8044dcd1a84f871590c53523d78

data/.rubocop.yml

@@ -47,3 +47,6 @@ RSpec/MultipleMemoizedHelpers:
 Style/Documentation:
   Exclude:
     - lib/icarus/mod/cli/*.rb # Thor command files
+
+Style/OpenStructUse:
+  Enabled: false

data/CHANGES.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 
 ## History (reverse chronological order)
 
+### v1.4 - 2023-03
+
+**BREAKING CHANGES!**
+
+You'll need to move your ENV variables to a config file. See the README for more details.
+
+- Read configuration from `~/.imtconfig.json`
+- bugfixes
+
 ### v1.3 - 2023-02
 
 - First public release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (1.3.5)
+    Icarus-Mod-Tools (1.4.0)
       google-cloud-firestore (~> 2.7)
       octokit (~> 6.0)
       thor (~> 1.2)

data/README.md

@@ -2,22 +2,49 @@
 
 a CLI tool for managing the Icarus Mods Database
 
-## Installation
+## Requirements
 
-`gem install icarus-mod-tools`
+To use this app, you'll need to obtain the following:
 
-To use this app, you'll need to obtain and create the following ENV environment variables:
-
-```sh
-export GITHUB_TOKEN=your_github_token
-export GOOGLE_APPLICATION_CREDENTIALS="path/to/your/Google-keyfile"
-```
+- A Github ACCESS_TOKEN (doesn't need access to any repos, this is used purely to make API calls)
+- A Google Cloud Platform credentials `keyfile.json`
+- Ruby 3.1 (or greater)
 
 If you aren't sure how to obtain these credentials, please see:
 
 - [Google Cloud Platform](https://cloud.google.com/docs/authentication/getting-started)
 - [GitHub](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
 
+I _highly_ recommend using WSL2 on Windows, or a Linux distro on your machine. This app has not been tested on Windows.
+
+## Installation
+
+`gem install Icarus-Mod-Tools`
+
+## Configuration
+
+Create a file called `.imtconfig.json` in your home directory with the following, replacing the CAPITALIZED values with the values provided by the above links:
+
+```json
+{
+  "firebase": {
+    "credentials": {
+      "copy your Google Cloud Platform keyfile.json here and remove this line": null
+    },
+    "collections": {
+      "modinfo": "meta/modinfo",
+      "repositories": "meta/repos",
+      "mods": "mods"
+    }
+  },
+  "github": {
+    "token": "YOUR-GITHUB-TOKEN"
+  }
+}
+```
+
+_Hint: Copy the contents of your Google Cloud Platform `keyfile.json` into the `credentials` section of the above file._
+
 ## Usage
 
 imt [options] [command]

data/exe/imt

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

data/imtconfig.sample.json

@@ -0,0 +1,24 @@
+{
+  "firebase": {
+    "credentials": {
+      "type": "service_account",
+      "project_id": "projectdaedalus-fb09f",
+      "private_key_id": "YOUR-PRIVATE-KEY-ID",
+      "private_key": "YOUR-PRIVATE-KEY",
+      "client_email": "YOUR-CLIENT-EMAIL",
+      "client_id": "YOUR-CLIENT-ID",
+      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+      "token_uri": "https://oauth2.googleapis.com/token",
+      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+      "client_x509_cert_url": "YOUR-x509-CERT-URL"
+    },
+    "collections": {
+      "modinfo": "meta/modinfo",
+      "repositories": "meta/repos",
+      "mods": "mods"
+    }
+  },
+  "github": {
+    "token": "YOUR-GITHUB-TOKEN"
+  }
+}

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

@@ -6,7 +6,7 @@ module Icarus
   module Mod
     module CLI
       # Sync CLI command definitions
-      class Add < SubCommandBase
+      class Add < SubcommandBase
         desc "modinfo", "Adds an entry to 'meta/modinfo/list'"
         def modinfo(item)
           firestore = Firestore.new

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

@@ -7,66 +7,19 @@ 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
+      # The Base CLI class for Icarus Mod Tools. This is inherited by all subcommands.
+      class Base < Thor
+        class_option :config,
+                     aliases: "-C", type: :string, default: File.join(Dir.home, "/.imtconfig.json"),
+                     desc: "Path to the config file"
 
-      # Require subcommands after the SubCommandBase class is defined
-      require "cli/sync"
-      require "cli/list"
-      require "cli/add"
+        class_option :version,
+                     aliases: "-V", type: :boolean,
+                     desc: "Print the version and exit"
 
-      # 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

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "cli/base"
+require "cli/subcommand_base"
+require "cli/sync"
+require "cli/list"
+require "cli/add"
+
+module Icarus
+  module Mod
+    module CLI
+      # The main CLI Command class for Icarus Mod Tools
+      class Command < Base
+        def initialize(*args)
+          super
+
+          if options[:version]
+            puts "IcarusModTool (imt) v#{Icarus::Mod::VERSION}"
+            exit 0
+          end
+
+          unless File.exist?(options[:config])
+            warn "Could not find or read Config from '#{options[:config]}' - please create it or specify a different path with -C"
+            exit 1
+          end
+
+          Icarus::Mod::Config.read(options[:config])
+        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

@@ -7,15 +7,19 @@ module Icarus
   module Mod
     module CLI
       # Sync CLI command definitions
-      class List < SubCommandBase
+      class List < SubcommandBase
         desc "modinfo", "Displays data from 'meta/modinfo/list'"
         def modinfo
-          puts Firestore.new.list(:modinfo)
+          modinfos = Firestore.new.list(:modinfo)
+          puts modinfos
+          puts "Total: #{modinfos.count}" if verbose > 1
         end
 
         desc "repos", "Displays data from 'meta/repos/list'"
         def repos
-          puts Firestore.new.list(:repositories)
+          repos = Firestore.new.list(:repositories)
+          puts repos
+          puts "Total: #{repos.count}" if verbose > 1
         end
 
         desc "mods", "Displays data from 'mods'"

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "cli/base"
+
+module Icarus
+  module Mod
+    module CLI
+      # Base class for all subcommands
+      class SubcommandBase < Base
+        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
+
+        # rubocop:disable Style/OptionalBooleanParameter
+        def self.banner(command, _namespace = nil, _subcommand = false)
+          "#{basename} #{subcommand_prefix} #{command.usage}"
+        end
+        # rubocop:enable Style/OptionalBooleanParameter
+
+        def self.subcommand_prefix
+          name.gsub(/.*::/, "").gsub(/^[A-Z]/) { |match| match[0].downcase }.gsub(/[A-Z]/) { |match| "-#{match[0].downcase}" }
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module Icarus
   module Mod
     module CLI
       # Sync CLI command definitions
-      class Sync < SubCommandBase
+      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

data/lib/icarus/mod/config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Icarus
+  module Mod
+    # Reads the configuration file
+    class Config
+      class << self
+        def config
+          return @config if @config
+
+          read
+        end
+
+        def read(config_file = self.config_file)
+          @config = JSON.parse(File.read(config_file), object_class: OpenStruct)
+        end
+
+        def firebase
+          @config.firebase
+        end
+
+        def github
+          @config.github
+        end
+
+        private
+
+        def config_file
+          @config_file ||= File.join(Dir.home, "/.imtconfig.json")
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/firestore.rb

@@ -7,16 +7,11 @@ 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
+      attr_reader :client, :collections
 
       def initialize
-        @client = Google::Cloud::Firestore.new(project_id: "projectdaedalus-fb09f", credentials: ENV.fetch("GOOGLE_APPLICATION_CREDENTIALS", nil))
+        @client = Google::Cloud::Firestore.new(credentials: Config.firebase.credentials.to_h)
+        @collections = Config.firebase.collections
       end
 
       def repos
@@ -31,18 +26,18 @@ module Icarus
         @mods ||= list(:mods)
       end
 
-      def find_mod(field, value)
-        mods.find { |mod| mod.send(field) == value }
+      def find_mod(name:, author:)
+        mods.find { |mod| mod.name == name && mod.author == author }
       end
 
       def list(type)
         case type
         when :modinfo
-          @client.doc(COLLECTIONS[:modinfo]).get[:list]
+          @client.doc(collections.modinfo).get[:list]
         when :repositories
-          @client.doc(COLLECTIONS[:repositories]).get[:list]
+          @client.doc(collections.repositories).get[:list]
         when :mods
-          @client.col(COLLECTIONS[:mods]).get.map do |doc|
+          @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
@@ -51,11 +46,11 @@ module Icarus
       end
 
       def update_or_create_mod(payload, merge:)
-        doc_id = payload.id || find_mod(:name, payload.name)&.id
+        doc_id = payload.id || find_mod(name: payload.name, author: payload.author)&.id
 
-        return @client.doc("#{COLLECTIONS[:mods]}/#{doc_id}").set(payload.to_h, merge:) if doc_id
+        return @client.doc("#{collections.mods}/#{doc_id}").set(payload.to_h, merge:) if doc_id
 
-        @client.col(COLLECTIONS[:mods]).add(payload.to_h)
+        @client.col(collections.mods).add(payload.to_h)
       end
 
       def update(type, payload, merge: false)
@@ -64,9 +59,9 @@ module Icarus
         case type
         when :modinfo
           update_array = (modinfo_array + [payload]).flatten.uniq
-          response = @client.doc(COLLECTIONS[:modinfo]).set({ list: update_array }, merge:) if update_array.any?
+          response = @client.doc(collections.modinfo).set({ list: update_array }, merge:) if update_array.any?
         when :repositories
-          response = @client.doc(COLLECTIONS[:repositories]).set({ list: payload }, merge:)
+          response = @client.doc(collections.repositories).set({ list: payload }, merge:)
         when :mod
           response = update_or_create_mod(payload, merge:)
         else
@@ -79,7 +74,7 @@ module Icarus
       def delete(type, payload)
         case type
         when :mod
-          response = @client.doc("#{COLLECTIONS[:mods]}/#{payload.id}").delete
+          response = @client.doc("#{collections.mods}/#{payload.id}").delete
         else
           raise "Invalid type: #{type}"
         end

data/lib/icarus/mod/github.rb

@@ -10,7 +10,7 @@ module Icarus
 
       def initialize(repo = nil)
         self.repository = repo if repo
-        @client = Octokit::Client.new(access_token: ENV.fetch("GITHUB_TOKEN", nil))
+        @client = Octokit::Client.new(access_token: Config.github.token)
         @resources = []
       end
 

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

@@ -28,7 +28,7 @@ module Icarus
         end
 
         def find_mod(modinfo)
-          @firestore.find_mod(:name, modinfo.name)&.id
+          @firestore.find_mod(name: modinfo.name, author: modinfo.author)&.id
         end
 
         def find_modinfo(modinfo)

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

@@ -20,6 +20,12 @@ module Icarus
           @data = data.is_a?(String) ? JSON.parse(data, symbolize_names: true) : data
         end
 
+        # rubocop:disable Naming/MethodName
+        def fileType
+          @data[:fileType] || "pak"
+        end
+        # rubocop:enable Naming/MethodName
+
         def to_json(*args)
           JSON.generate(@data, *args)
         end
@@ -28,13 +34,6 @@ module Icarus
           @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

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

@@ -7,14 +7,14 @@ require "json"
 module Icarus
   module Mod
     module Tools
+      class RequestFailed < StandardError; end
+
       # Sync helper methods
       module SyncHelpers
-        class RequestFailed < StandardError; end
-
         def retrieve_from_url(url)
           res = Net::HTTP.get_response(URI(url))
 
-          raise RequestFailed, "HTTP Request failed for #{url} (#{res.code}): #{res.message}" unless res&.code == "200"
+          raise Icarus::Mod::Tools::RequestFailed, "HTTP Request failed for #{url} (#{res.code}): #{res.message}" unless res&.code == "200"
 
           JSON.parse(res.body, symbolize_names: true)
         end

data/lib/icarus/mod/tools.rb

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

data/lib/icarus/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Icarus
   module Mod
-    VERSION = "1.3.5"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Donovan Young
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore
@@ -71,10 +71,14 @@ files:
 - Rakefile
 - exe/imt
 - icarus-mod-tools.gemspec
+- imtconfig.sample.json
 - lib/icarus/mod/cli/add.rb
 - lib/icarus/mod/cli/base.rb
+- lib/icarus/mod/cli/command.rb
 - lib/icarus/mod/cli/list.rb
+- lib/icarus/mod/cli/subcommand_base.rb
 - lib/icarus/mod/cli/sync.rb
+- lib/icarus/mod/config.rb
 - lib/icarus/mod/firestore.rb
 - lib/icarus/mod/github.rb
 - lib/icarus/mod/tools.rb