gamerom 0.1.0

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "gamerom"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gamerom

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "gamerom"
+
+Gamerom::Cli.start(ARGV)

data/gamerom.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/gamerom/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gamerom"
+  spec.version       = Gamerom::VERSION
+  spec.authors       = ["Lucas Mundim"]
+  spec.email         = ["lucas.mundim@gmail.com"]
+
+  spec.summary       = "The Video Game ROM downloader"
+  spec.description   = "A command-line installer for game ROMs from many repositories."
+  spec.homepage      = "https://github.com/lucasmundim/gamerom"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "mechanize", "~> 2.8.0"
+  spec.add_runtime_dependency "nokogiri", "~> 1.11.3"
+  spec.add_runtime_dependency "rest-client", "~> 2.1.0"
+  spec.add_runtime_dependency "thor", "~> 1.1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gamerom.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "gamerom/config"
+require_relative "gamerom/game"
+require_relative "gamerom/repo"
+require_relative "gamerom/cli"
+require_relative "gamerom/version"
+
+module Gamerom
+  class Error < StandardError; end
+end

data/lib/gamerom/cli.rb

@@ -0,0 +1,322 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Gamerom
+  class Cli < Thor
+    class_option :verbose, :aliases => ['-v'], :type => :boolean, default: false, desc: "Show verbose backtrace"
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'config', 'Show config'
+    def config
+      cfg = {
+        ROM_ROOT: Gamerom::ROM_ROOT,
+        CACHE_DIR: Gamerom::CACHE_DIR,
+        GAME_DIR: Gamerom::GAME_DIR,
+        LOG_DIR: Gamerom::LOG_DIR,
+      }
+      pp cfg
+    end
+
+    desc 'info GAME_IDENTIFIER', 'Info for game GAME_IDENTIFIER (id/name)'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    def info(game_identifier)
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      puts "showing info for game #{game_identifier} on #{options[:platform]} platform on #{options[:repo]} repo..."
+      game = repo.find(options[:platform], game_identifier)
+      if game.nil?
+        shell.say "Game #{game_identifier} not found", :red
+      end
+      puts game
+      puts game.filename if game.installed?
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'install GAME_IDENTIFIER', 'Install game GAME_IDENTIFIER (id/name)'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    def install(game_identifier)
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      game = repo.find(options[:platform], game_identifier)
+      if game.nil?
+        shell.say "Game #{game_identifier} not found", :red
+        return
+      end
+      puts "installing game #{game.id} - #{game.name} - #{game.region} on #{options[:platform]} platform on #{options[:repo]} repo..."
+      if game.installed?
+        shell.say "Game already installed", :yellow
+        return
+      end
+      game.install
+      shell.say "Game installed", :green
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'install_all', 'Install all games'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    def install_all
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      games = repo.games options[:platform], region: options[:region]
+      games.each do |game|
+        install(game.id) unless game.installed?
+      end
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'list', 'List available games'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    def list
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      puts "listing available games for #{options[:platform]} platform on #{options[:repo]} repo..."
+      games = repo.games options[:platform], region: options[:region]
+      print_game_table(games)
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'platforms', 'List available platforms'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    def platforms
+      puts "listing available platforms for #{options[:repo]} repo..."
+      platforms = { platforms: Repo.new(options[:repo]).platforms }
+      puts platforms.to_yaml
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'recover', 'Try to recover state from already downloaded roms'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    def recover
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      puts "recovering state of roms for #{options[:platform]} platform on #{options[:repo]} repo..."
+      games = repo.games options[:platform]
+      games_not_found = []
+      games.each do |game|
+        filename = nil
+        basename = "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{game[:region]}/#{game[:name]}"
+        ['zip', '7z', 'rar'].each do |ext|
+          if File.exists? "#{basename}.#{ext}"
+            filename = "#{basename}.#{ext}"
+          end
+        end
+
+        if filename
+          game.update_state File.basename(filename)
+          puts "Found game #{game[:name]}"
+        else
+          games_not_found << game[:name]
+        end
+      end
+      if games_not_found.count > 0
+        puts "Games not found:"
+        puts games_not_found
+      end
+    rescue => e
+      puts e.message
+      exit 1
+    end
+
+    desc 'regions', 'List available regions'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    def regions
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      puts "listing available regions for #{options[:platform]} platform on #{options[:repo]} repo..."
+      puts repo.regions options[:platform]
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'repo', 'List available repo'
+    def repo
+      puts "listing available repo..."
+      puts Repo.list
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'search KEYWORD', 'Search games by KEYWORD'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    def search(keyword)
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      puts "searching available games for #{options[:platform]} platform on #{options[:repo]} repo..."
+      games = repo.games options[:platform], region: options[:region], keyword: keyword
+      print_game_table(games)
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'stats', 'Show platform stats'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    def stats
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      puts "stats for #{options[:platform]} platform on #{options[:repo]} repo..."
+      games = repo.games options[:platform]
+      total = games.count
+      installed = games.select { |game| game.installed? }.count
+      size = 0
+      if File.exists? "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}"
+        size = `du -hs "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/"|awk '{ print $1 }'`
+      end
+      puts "  All: #{installed}/#{total} - size: #{size}"
+      repo.regions(options[:platform]).each do |region|
+        games = repo.games(options[:platform], region: region)
+        total = games.count
+        installed = games.select { |game| game.installed? }.count
+        size = 0
+        if File.exists? "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{region}"
+          size = `du -hs "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{region}/"|awk '{ print $1 }'`
+        end
+        puts "  #{region}: #{installed}/#{total} - size: #{size}"
+      end
+      puts
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'stats_all', 'Show stats for all platforms'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    def stats_all
+      repo = Repo.new(options[:repo])
+      repo.platforms.keys.each do |platform|
+        a = Gamerom::Cli.new
+        a.options = { platform: platform, repo: options[:repo] }
+        a.stats
+      end
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'uninstall GAME_IDENTIFIER', 'Uninstall game GAME_IDENTIFIER (id/name)'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    def uninstall(game_identifier)
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      game = repo.find(options[:platform], game_identifier)
+      if game.nil?
+        shell.say "Game #{game_identifier} not found", :red
+        return
+      end
+      puts "uninstalling game #{game.id} - #{game.name} - #{game.region} on #{options[:platform]} platform..."
+      if !game.installed?
+        shell.say "Game is not installed", :yellow
+        return
+      end
+      game.uninstall
+      shell.say "Game uninstalled", :green
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'uninstall_all', 'Uninstall all games'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    def uninstall_all
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      games = repo.games options[:platform], region: options[:region]
+      games.each do |game|
+        uninstall(game.id) if game.installed?
+      end
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'update_all_databases', 'Update all local databases'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    def update_all_databases
+      repo = Repo.new(options[:repo])
+      repo.platforms.keys.each do |platform|
+        a = Gamerom::Cli.new
+        a.options = { platform: platform, repo: options[:repo] }
+        a.update_database
+      end
+      shell.say 'All game databases updated', :green
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'update_database', 'Update local database'
+    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    def update_database
+      repo = Repo.new(options[:repo])
+      validate_platform repo, options[:platform]
+      puts "updating #{options[:platform]} platform on #{options[:repo]} repo..."
+      repo.update_database options[:platform]
+      shell.say "Game database updated for platform #{options[:platform]} on #{options[:repo]} repo", :green
+    rescue => e
+      render_error e, options
+      exit 1
+    end
+
+    desc 'version', 'Print program version'
+    def version
+      puts Gamerom::VERSION
+    end
+
+    private
+    def print_game_table(games)
+      results = []
+
+      games.each do |game|
+        results << [
+          game.id,
+          game.name,
+          game.region,
+          game.installed? ? shell.set_color('installed', :green) : '-',
+        ]
+      end
+      results.sort_by! { |columns| columns[1] }
+      results.unshift ['ID', 'NAME', 'REGION', 'INSTALLED']
+      shell.print_table(results)
+    end
+
+    def render_error exception, options
+      shell.say exception.message, :red
+      shell.say exception.full_message.force_encoding('utf-8'), :red if options[:verbose]
+    end
+
+    def validate_platform(repo, platform)
+      raise "Expected '--platform' to be one of #{repo.platforms.keys.join(', ')}; got #{platform}" if !repo.platforms.keys.include? options[:platform]
+    end
+  end
+end

data/lib/gamerom/config.rb

@@ -0,0 +1,19 @@
+# 'frozen_string_literal' => true
+
+require 'fileutils'
+require 'logger'
+require 'rest-client'
+require 'mechanize'
+
+module Gamerom
+  ROM_ROOT = ENV['ROM_ROOT'] || File.expand_path("~/.gamerom")
+  CACHE_DIR = ENV['CACHE_DIR'] || "#{ROM_ROOT}/cache"
+  GAME_DIR = ENV['GAME_DIR'] || "#{ROM_ROOT}/games"
+  LOG_DIR = ENV['LOG_DIR'] || "#{ROM_ROOT}/logs"
+  STATE_DIR = ENV['STATE_DIR'] || "#{ROM_ROOT}/state"
+end
+
+FileUtils.mkdir_p(Gamerom::LOG_DIR)
+logger = Logger.new("#{Gamerom::LOG_DIR}/requests.log")
+RestClient.log = logger
+Mechanize.log = logger

data/lib/gamerom/game.rb

@@ -0,0 +1,49 @@
+# 'frozen_string_literal' => true
+
+require 'fileutils'
+require 'ostruct'
+
+module Gamerom
+  class Game < OpenStruct
+    def filename
+      "#{self.filepath}/#{File.read(self.state_filename)}"
+    end
+
+    def filepath
+      "#{Gamerom::GAME_DIR}/#{self.repo.name}/#{self.platform}/#{self.region}"
+    end
+
+    def install
+      self.repo.install self do |filename|
+        self.update_state filename
+      end
+    end
+
+    def installed?
+      File.exists? self.state_filename
+    end
+
+    def state_filename
+      "#{Gamerom::STATE_DIR}/#{self.repo.name}/#{self.platform}/#{self.region}/#{self.id}"
+    end
+
+    def to_s
+      "#{self.id} - #{self.name} - #{self.region}#{self.installed? ? " (#{shell.set_color 'installed', :green})" : ''}"
+    end
+
+    def uninstall
+      FileUtils.rm_rf self.filename
+      FileUtils.rm_rf self.state_filename
+    end
+
+    def update_state filename
+      FileUtils.mkdir_p("#{Gamerom::STATE_DIR}/#{self.repo.name}/#{self.platform}/#{self.region}")
+      File.write(self.state_filename, filename)
+    end
+
+    private
+    def shell
+      @shell ||= Thor::Shell::Color.new
+    end
+  end
+end