itch_rewards 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 199cd42ce4dbbe3f220a6bcc486278eef1702e6e696ec690c30ee25d5bea73a7
+  data.tar.gz: 3d4830e0ec9ff9f8011478077af6fa11a27b9e153583a09f76f4f3c72cb74011
+SHA512:
+  metadata.gz: 49644f0519d13cdd27f74185a735664404933c2d93ec3b51ca25ec2d9529526209e655db47743f34e83ed927a1bcf21ed453661d57eedf9e4fcb23226c083a33
+  data.tar.gz: c431a320c9c5ec599f0bdab00eba1cbef4e57c2ce6f38e0edb3a0a48d39e62940ff50705f4c3d41b48318f0ced2f596048ddbe483087994cfd966dd7f0152b42

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.itch-cookies.yml
+itch-reward-config.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "irb", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    itch_rewards (0.1.0)
+      dry-cli (~> 0.7.0)
+      itch_client (~> 0.2.0)
+      pastel (~> 0.8.0)
+      tty-prompt (~> 0.23.1)
+      tty-table (~> 0.12.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    connection_pool (2.2.5)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dry-cli (0.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    io-console (0.5.9)
+    irb (1.3.5)
+      reline (>= 0.1.5)
+    itch_client (0.2.0)
+      mechanize (~> 2.8)
+    mechanize (2.8.1)
+      addressable (~> 2.7)
+      domain_name (~> 0.5, >= 0.5.20190701)
+      http-cookie (~> 1.0, >= 1.0.3)
+      mime-types (~> 3.0)
+      net-http-digest_auth (~> 1.4, >= 1.4.1)
+      net-http-persistent (>= 2.5.2, < 5.0.dev)
+      nokogiri (~> 1.11, >= 1.11.2)
+      rubyntlm (~> 0.6, >= 0.6.3)
+      webrick (~> 1.7)
+      webrobots (~> 0.1.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    net-http-digest_auth (1.4.1)
+    net-http-persistent (4.0.1)
+      connection_pool (~> 2.2)
+    nokogiri (1.11.6-x86_64-linux)
+      racc (~> 1.4)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rake (13.0.3)
+    reline (0.2.5)
+      io-console (~> 0.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubyntlm (0.6.3)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
+    unicode_utils (1.4.0)
+    webrick (1.7.0)
+    webrobots (0.1.2)
+    wisper (2.0.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  irb (~> 1.3)
+  itch_rewards!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Billiam
+
+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,209 @@
+# itch-rewards
+
+Commandline tool to update game rewards on Itch.io, and automatically update reward counts and descriptions based on sales.
+
+## Installation
+
+    $ gem install itch_rewards
+
+## Usage
+
+```shell
+Usage: itch-rewards COMMAND [options]
+
+Commands:
+  itch-rewards list                                        # List all rewards for a game
+  itch-rewards list-games                                  # List all games
+  itch-rewards recalculate                                 # Update reward quantity and description from configuration file
+  itch-rewards setup                                       # Save cookies for itch.io and create reward config example file
+  itch-rewards update GAME_ID REWARD_ID                    # Update a reward
+  itch-rewards version                                     # Print version
+```
+
+### Authenticating
+
+First, enable two-factor authentication for your itch.io account, if you haven't already. This prevents captcha prompts during login, which `itch-rewards` doesn't handle.
+
+Then, run:
+
+```shell
+$ itch-rewards setup
+```
+
+You'll be prompted for your username, password, two-factor code, and a path to save a cookie file. Your credentials will not be saved, but the cookie will be used for subsequent logins (until the cookie expires).
+
+You can use `itch-rewards` for multiple accounts by specifying a different cookie file path for each account:
+
+```shell
+$ itch-rewards setup --cookie-path my_first_account.yml
+# ...
+$ itch-rewards setup --cookie-path my_second_account.yml
+# ...
+$ itch-rewards list-games --cookie-path my_first_account.yml
+```
+
+You'll also be prompted to create an (optional) configuration file that can be used when automatically updating itch reward quantities and descriptions.
+
+While logging in via cookies is easier (and required for non-interactive login, ex: for cron tasks), all commands also accept the following options.
+
+```shell
+--username=VALUE, -u VALUE        # Itch username
+--password=VALUE, -p VALUE        # Itch password
+--cookie-path=VALUE               # Path to cookies file for future logins, default: ".itch-cookies.yml"
+--[no-]cookies                    # Enable cookie storage, default: true
+--[no-]interactive                # Enable interactive prompts, default: true
+--help, -h                        # Print help
+```
+
+### List games
+
+Return a list of game names and IDs. Useful for other commands that use game ID, or when creating a [reward configuration file](#configuration_file).
+
+
+```shell
+Usage:
+  itch-rewards list-games
+
+Description:
+  List all games
+```
+
+
+### List rewards
+
+Show reward information for a single game.
+
+Accepts either a game name, or game ID.
+```shell
+Usage:
+  itch-rewards list
+
+Description:
+  List all rewards for a game
+
+Options:
+  --id=VALUE                        # Game ID
+  --name=VALUE                      # Game name
+
+Examples:
+  itch-rewards list --id 123456     # List rewards for game with ID 123456
+  itch-rewards list --name MyGame   # List rewards for game with name MyGame
+```
+
+### Update a reward
+
+Update a single reward for a game. Quantity, title, description, price and archive status can be changed.
+
+```shell
+Command:
+  itch-rewards update
+
+Usage:
+  itch-rewards update GAME_ID REWARD_ID
+
+Description:
+  Update a reward
+
+Arguments:
+  GAME_ID                           # REQUIRED Game with the reward to edit
+  REWARD_ID                         # REQUIRED Reward ID to update
+
+Options:
+  --quantity=VALUE                  # Reward quantity (total, including redeemed)
+  --title=VALUE                     # Reward title
+  --[no-]archived                   # Reward archived status
+  --description=VALUE               # Reward description
+  --price=VALUE                     # Reward price without currency (ex: 15.99)
+
+Examples:
+  itch-rewards update 123456 78910 --quantity 5            # Set the reward count to 5 for reward ID 78910 in game ID 123456
+  itch-rewards update 123456 78910 --price 5.00 --archived # Set reward price to 5.00 and archive it
+```
+
+### Automated reward updates
+
+If you wish to update a reward description, or available quantity based on purchases or tips.
+
+```shell
+Usage:
+  itch-rewards recalculate
+
+Description:
+  Update reward quantity and description from configuration file
+
+Options:
+  --config=VALUE                    # Path to config file, default: "itch-reward-config.yml"
+  --[no-]save                       # Saves changes when enabled. Otherwise, dry-run and show result, default: false
+```
+
+#### Example reward scenarios
+
+> I want every purchase to add one community copy
+
+```yml
+MyGame:
+  id: 123456
+  reward_id: 789012
+  reward_by_purchase: 1
+  reward_by_tip: 0.0
+  reward_offset: 0
+  minimum_available: 0
+```
+
+
+> I want every two purchases to add one community copy
+```yml
+MyGame:
+  id: 123456
+  reward_id: 789012
+  reward_by_purchase: 0.5
+  reward_by_tip: 0.0
+  reward_offset: 0
+  minimum_available: 0
+```
+
+> I want tips over the purchase price to add proportional community copies
+
+
+```yml
+MyGame:
+  id: 123456
+  reward_id: 789012
+  reward_by_purchase: 0
+  reward_by_tip: 0.0
+  reward_offset: 0
+  minimum_available: 0
+```
+
+For example: a $5 tip, on a $10 game will contribute 0.5 copies to the reward pool when `reward_by_tip` is `1`.
+
+The formula for this is: `(tip_amount / game_price) * reward_by_tip`
+
+
+> I want five community copies to always be available
+
+```yml
+MyGame:
+  id: 123456
+  reward_id: 789012
+  reward_by_purchase: 0
+  reward_by_tip: 0.0
+  reward_offset: 0
+  minimum_available: 5
+```
+
+#### Updating reward description
+
+If present, the `reward_description_template` configuration value can be used to change the description of your reward with information about the reward itself.
+
+For instance: 
+
+```yml
+reward_description_template: <p>Rewards added: { amount }</p>
+```
+
+The above will change the reward description to "Rewards added: 10".
+The following placehoder values are available:
+  * `{ amount }`: The total number of reward copies in the pool, including redeemed rewards.
+  * `{ remaining_percent }`: A number between 0.0 and 100.0, indicating the percentage until the next reward
+  * `{ remaining_percent_integer }`: A number between 0 and 100. As above (but with no decimal value included).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "itch_rewards"
+
+# 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"
+
+def reload!
+  root_dir = File.expand_path("..", __dir__)
+  reload_dirs = %w[lib]
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  puts "Reloaded"
+end
+
+IRB.start(__FILE__)

data/bin/itch-rewards

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "itch_rewards/cli"

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/itch_rewards.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/itch_rewards/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "itch_rewards"
+  spec.version       = ItchRewards::VERSION
+  spec.authors       = ["Billiam"]
+  spec.email         = ["billiamthesecond@gmail.com"]
+
+  spec.summary       = "Itch community copy automation utility"
+  spec.description   = "Automatically update available rewards based on purchases"
+  spec.homepage      = "https://github.com/Billiam/itch-community-rewards"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  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        = "bin"
+  spec.executables   = ['itch-rewards']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "itch_client", "~> 0.2.0"
+  spec.add_dependency "dry-cli", "~> 0.7.0"
+  spec.add_dependency "tty-prompt", "~> 0.23.1"
+  spec.add_dependency "tty-table", "~> 0.12.0"
+  spec.add_dependency "pastel", "~> 0.8.0"
+end

data/lib/itch_rewards.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "itch_rewards/version"
+
+module ItchRewards
+  class Error < StandardError; end
+end

data/lib/itch_rewards/cli.rb

@@ -0,0 +1,359 @@
+require "dry/cli"
+require "tty-prompt"
+require "tty-table"
+require "itch_client"
+require "bigdecimal"
+require "pastel"
+
+module ItchRewards
+  class CLI
+    module AuthOptions
+      def self.included(base)
+        base.class_eval do
+          option :username, desc: "Itch username", aliases: ["u"]
+          option :password, desc: "Itch password", aliases: ["p"]
+          option :cookie_path, desc: "Path to cookies file for future logins", default: ".itch-cookies.yml"
+          option :cookies, desc: "Enable cookie storage", type: :boolean, default: true
+          option :interactive, type: :boolean, desc: "Enable interactive prompts", default: true
+        end
+      end
+    end
+
+    module Helper
+      def cli
+        @cli ||= begin
+          TTY::Prompt.new
+        end
+      end
+
+      def color
+        @pastel ||= Pastel.new
+      end
+
+      def authenticated_client(options)
+        @authenticated_client ||= begin
+          interactive = options[:interactive]
+
+          username = options[:username] || -> { interactive ? cli.ask("Itch.io username:", required: true) : (cli.error("Username required but not provided"); exit 1) }
+          password = options[:password] || -> { interactive ? cli.mask("Itch.io password:", required: true) :  (cli.error("Password required but not provided"); exit 1) }
+          totp = -> { interactive ? cli.mask("Enter your 2FA code", required: true) : (cli.error("Cannot enter totp code in non-interactive mode"); exit 1) }
+
+          cookie_path = options[:cookies] ? options[:cookie_path] : nil
+          
+          client = Itch.new(username: username, password: password, cookie_path: cookie_path)
+          client.totp = totp
+          
+          client.login && client
+        rescue Itch::AuthError => e
+          cli.error(e.message)
+          nil
+        end
+      end
+
+      def authenticated_client!(options)
+        authenticated_client(options) || exit(1)
+      end
+
+      def objects_to_table(objects)
+        objects = Array(objects)
+        return nil if objects.none?
+        if objects.first.is_a? Hash
+          headers = objects.first.keys.sort          
+          data = objects.map {|v| v.values_at(*headers) }
+          headers = headers.map(&:upcase)
+        else
+          fields = objects.first.instance_variables.sort
+          data = objects.map do |object|
+            fields.map {|k| object.instance_variable_get(k) }
+          end
+          headers = fields.map {|f| f.to_s[1..].upcase }
+        end
+
+        TTY::Table.new(headers, data)
+      end
+
+      def render_table(table)
+        return "No data" unless table
+
+        table.render(:unicode, multiline: true, padding: [0,1], resize: false, border: { style: :green })
+      end
+    end
+
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Dry::CLI::Command
+        include Helper
+
+        desc "Print version"
+
+        def call(*)
+          cli.say "ItchRewards #{ItchRewards::VERSION} (ItchClient #{Itch::VERSION})"
+        end
+      end
+
+      class Setup < Dry::CLI::Command
+        include Helper
+        include AuthOptions
+        @options = @options.reject {|opt| [:cookies, :interactive].include? opt.name }
+
+        desc "Save cookies for itch.io and create reward config example file"
+        def call(**options)
+          options[:cookies] ||= cli.ask("Where would you like to store your login cookies?  ", default: ".itch-cookies.yml")
+          if authenticated_client(options)
+            cli.say "Saved cookies to #{options[:cookie_path]}"
+          else
+            cli.say "Login failed, cookies not saved"
+          end
+
+          config_path = "itch-reward-config.yml"
+
+          if !File.exist? config_path
+            result = cli.yes?("Config file #{config_path} does not exist, would you like to create it?")
+
+            if result
+              write_config(config_path)
+              cli.say "Config file written to #{config_path}"
+            end
+          else
+            cli.warn "Config file #{config_path} already exists, skipping..."
+          end
+        end
+      end
+
+      module Games
+        class List < Dry::CLI::Command
+          include AuthOptions
+          include Helper
+  
+          desc "List all games"
+          def call(**options)
+            client = authenticated_client!(options)
+            table = objects_to_table(client.game_map.map.values)
+            
+            cli.say "Games"
+            cli.say render_table(table)
+          end
+        end
+      end
+
+      module Rewards
+        extend self
+        include Helper
+        def self.show_rewards(game)
+          cli.say "Rewards for #{game.name} (id: #{game.id})"
+          table = objects_to_table(game.rewards.list)
+          cli.say render_table(table)
+        end
+
+        def self.write_config(path)
+          require 'erb'
+          client = authenticated_client!
+          
+          games = client.game_map.map.values
+          template = File.read(File.join(__dir__, 'templates/reward_config.yml.erb'))
+
+          File.write(options[:config], ERB.new(template, trim_mode: '-').result(binding))
+        end
+
+        def self.load_config(path)
+          YAML.load_file(path)
+        rescue YAML::ParseError => e
+          cli.error("Config file (#{path}) is not valid yaml")
+          exit 1
+        end
+
+        class List < Dry::CLI::Command
+          include AuthOptions
+          include Helper
+  
+          desc "List all rewards for a game"
+
+          option :id, type: :string, desc: "Game ID"
+          option :name, type: :string, desc: "Game name"
+
+          example [
+            "--id 123456     # List rewards for game with ID 123456",
+            "--name MyGame   # List rewards for game with name MyGame"
+          ]
+          def call(**options)
+            if options[:id].nil? && options[:name].nil?
+              cli.error "Game ID or game name argument is required"
+              exit 1
+            end
+
+            client = authenticated_client!(options)
+            game = options[:id] ? client.game(options[:id]) : client.game(name: options[:name])
+
+            Rewards.show_rewards(game)
+          end
+        end
+
+        class Update < Dry::CLI::Command
+          include AuthOptions
+          include Helper
+  
+          desc "Update a reward"
+
+          example [
+            "123456 78910 --quantity 5            # Set the reward count to 5 for reward ID 78910 in game ID 123456",
+            "123456 78910 --price 5.00 --archived # Set reward price to 5.00 and archive it"
+          ]
+          
+          argument :game_id, required: true, desc: "Game with the reward to edit"
+          argument :reward_id, type: :integer, required: true, desc: "Reward ID to update"
+
+          option :quantity, desc: "Reward quantity (total, including redeemed)"
+          option :title, type: :string, desc: "Reward title"
+          option :archived, type: :boolean, desc: "Reward archived status"
+          option :description, type: :string, desc: "Reward description"
+          option :price, type: :string, desc: "Reward price without currency (ex: 15.99)"
+          
+          def call(game_id:, reward_id:, **options)
+            client = authenticated_client!(options)
+            game = client.game(game_id)
+            rewards = game.rewards
+          
+            reward_id = reward_id.to_i
+            reward_list = rewards.list
+
+            reward = reward_list.find {|reward| reward.id == reward_id }
+
+            unless reward
+              cli.error "Could not find reward with id: #{reward_id} for game #{game.name} (#{game.id})"
+              exit 1
+            end
+            
+            unless options[:archived].nil?
+              reward.archived = options[:archived]
+            end
+
+            %i(amount description price title).each do |field|
+              if options[field]
+                reward.public_send("#{field}=", options[field])
+              end
+            end
+
+            rewards.save reward_list
+            
+            Rewards.show_rewards(game)
+          end
+        end
+
+        class Automate < Dry::CLI::Command
+          include Helper
+          include AuthOptions
+
+          desc "Update reward quantity and description from configuration file"
+
+          option :config, required: true, desc: "Path to config file", default: "itch-reward-config.yml"
+          option :save, type: :boolean, desc: "Saves changes when enabled. Otherwise, dry-run and show result", default: false
+    
+          def call(**options)
+            client = authenticated_client!(options)
+
+            if !File.exist? options[:config]
+              cli.error("Config file #{options[:config]} does not exist")
+              exit 1
+            end
+
+            config = Rewards.load_config(options[:config])
+            unless config["games"].is_a? Hash
+              cli.error("No games configured for rewards updates in config file")
+              exit 1
+            end
+            
+            unless options[:save]
+              cli.warn "Dry run, results will not not saved"
+            end
+
+            purchases_by_game = client.purchases.history.each.group_by {|row| row['object_name'] }.to_h
+
+            config["games"].each do |name, data|
+              name = name.chomp
+
+              next unless data["reward_by_tip"] > 0 || data["reward_by_purchase"] > 0 || data["minimum_available"] > 0
+              game = client.game(data["id"])
+              rewards = game.rewards.list
+            
+              reward = rewards.find {|r| r.id == data["reward_id"]}
+              unless reward
+                cli.warn "Could not find reward #{data["reward_id"]} for game #{name}, skipping..."
+                next
+              end
+
+              tip_modifier = data["reward_by_tip"].to_f
+              purchase_modifier = data["reward_by_purchase"].to_f
+              minimum = data["minimum_available"].to_i
+              template = data["reward_description_template"]
+
+              new_description = reward.description              
+              new_amount = Array(purchases_by_game[name]).inject(data["reward_offset"]) do |sum, purchase|
+                price = purchase["product_price"].to_i
+                tip = (purchase["tip"].to_f * 100).to_i
+
+                next sum unless price > 0
+                
+                sum += (tip.fdiv(price)) * tip_modifier
+                sum += purchase_modifier
+
+                sum
+              end
+              new_amount = [new_amount, reward.claimed + minimum].max if minimum > 0
+
+              if template && !template.empty?
+                new_description = template.gsub(/{ *(quantity|remaining_percent|remaining_percent_integer) *}/, "{\\1}")
+                  .gsub(/{ *(quantity|remaining_percent|remaining_percent_integer) *}/,
+                    "{quantity}" => new_amount.floor,
+                    "{remaining_percent}" => ((new_amount % 1) * 100).floor(1),
+                    "{remaining_percent_integer}" => ((new_amount % 1) * 100).floor
+                  )
+              end
+              
+              if new_amount.to_i != reward.amount
+                cli.say "Changing #{name} reward #{reward.id} quantity from #{color.green.bold(reward.amount.to_s)} to #{color.yellow.bold(new_amount.to_i)}"
+              end
+                          
+              if new_description != reward.description
+                cli.say "Changing #{name} reward #{reward.id} description to:\n#{color.yellow.bold(new_description)}"
+              end
+
+              if options[:save]
+                reward.description = new_description
+                reward.amount = new_amount.to_i
+
+                game.rewards.save rewards
+              end
+            end
+          end
+        end
+      end
+
+      register "version", Version, aliases: ["v", "-v", "--version"]
+      register "setup", Setup
+      register "list", Rewards::List
+      register "list-games", Games::List
+      register "update", Rewards::Update
+      register "recalculate", Rewards::Automate
+    end
+  end
+
+  class App < Dry::CLI
+    def usage_prefix
+      err.puts "Usage: #{ProgramName.call()} COMMAND [options]\n\n"
+    end
+
+    def usage_suffix
+      err.puts "\nGlobal options:\n  -h            # Show help for command"
+    end
+
+    def usage(result)
+      usage_prefix
+      err.puts Usage.call(result)
+      usage_suffix
+      exit(1)
+    end
+  end
+end
+
+ItchRewards::App.new(ItchRewards::CLI::Commands).call

data/lib/itch_rewards/templates/reward_config.yml.erb

@@ -0,0 +1,46 @@
+---
+games:
+<% if games.any? -%>
+<% game = games.first -%>
+  # Game name, must match exactly
+  <%= game[:name] %>:
+
+    # Game ID
+    id: <%= game[:id] %>
+
+    # ID of reward to update
+    reward_id:
+
+    # Increase reward quantity by this value for each paid purchase
+    # ex: with reward_by_purchase set to 2, every purchase will add 2 reward copies
+    reward_by_purchase: 0
+
+    # Increase reward quantity by tip value, as a percentage of game price
+    # ex: with rewards_by_tip set to 1, a $10 tip on a $5 game (total price: $15) would add 2 reward copies
+    # ex: with rewards_by_tip set to 0.5, a $10 tip on a $5 game would add 1 reward copy
+    reward_by_tip: 0.0
+
+    # Add a flat value to reward quantity available (ex: for adding initial reward copies )
+    reward_offset: 0
+
+    # Minimum reward quantity available, regardless of other settings
+    # Ensures that there are at least this many rewards available
+    minimum_available: 0
+
+    # Can be used to update the reward description with reward information, like: 
+    #    total number of reward copies ({quantity}),
+    #    or percentage until next copy ({remaining_percent} for a number between 0.0 and 100.0)
+    #    or ({remaining_percent_integer} for a whole number between 0 and 100, rounded down)
+    # Ex: Please enjoy this community copy! <b>{ quantity }</b> copies added so far, { remaining_percent }% of the way to next reward! 
+    reward_description_template:
+  <% games[1..].each do |game| %>
+  <%= game[:name] %>:
+    id: <%= game[:id] %>
+    reward_id:
+    reward_by_purchase: 0
+    reward_by_tip: 0.0
+    reward_offset: 0
+    minimum_available: 0
+    reward_description_template:
+  <% end %>
+<% end %>

data/lib/itch_rewards/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ItchRewards
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: itch_rewards
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Billiam
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: itch_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Automatically update available rewards based on purchases
+email:
+- billiamthesecond@gmail.com
+executables:
+- itch-rewards
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/itch-rewards
+- bin/setup
+- itch_rewards.gemspec
+- lib/itch_rewards.rb
+- lib/itch_rewards/cli.rb
+- lib/itch_rewards/templates/reward_config.yml.erb
+- lib/itch_rewards/version.rb
+homepage: https://github.com/Billiam/itch-community-rewards
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Billiam/itch-community-rewards
+  source_code_uri: https://github.com/Billiam/itch-community-rewards
+  changelog_uri: https://github.com/Billiam/itch-community-rewards/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Itch community copy automation utility
+test_files: []