itch_rewards 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 532a40f260d7f2942244c1b983c20eea419c18eeea3ac601cb41f461e11eefd5
-  data.tar.gz: 5609c23072f7f006ca5a781f1c561d613942fcf1d8856c48f0c9f294d2d46e18
+  metadata.gz: ddb2708480af47359babae6481ed315edf6eef8033c6e84029f7985b442361e0
+  data.tar.gz: 676f51d7aaae87d8223f229baee10254c6754c33f0456544c3a290ec43ec2cb0
 SHA512:
-  metadata.gz: 63e1a8858b7250c27a782ba1e57bdd1af9833070c88d5e720fb371d1ef5689f4211f4cafbc62c4964e656bd88f12d497049f5e1fc7f24ac049e89d329e201d28
-  data.tar.gz: b151326787353dabd45dfef0180c088edeac0180df15703b74fb297b8b2032d2950f542c0bec49632cf51874401fa0fdc293d26c32ab59bdf83a77aa18ee9d13
+  metadata.gz: cba9856144f8ecb5da7ba77564825f0f2a5426f70f03b6221fc474142a751ae3901df4eed349461d646e00aead877df02941f91ae0df9f3fa12bf5fbf9dadeb1
+  data.tar.gz: 76667982c457234f09ce323497d528d98643a1ca81ceb4d025bd856575c7b569c8ffb458e192c2b91bbbe5057ceae29e4c996fca2cde75a39281881a409d04ae

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 .itch-cookies.yml
 itch-reward-config.yml
+.tool-versions

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    itch_rewards (0.1.2)
+    itch_rewards (0.1.4)
       dry-cli (~> 0.7.0)
-      itch_client (~> 0.2.0)
+      itch_client (~> 0.4.1)
       pastel (~> 0.8.0)
       tty-prompt (~> 0.23.1)
       tty-table (~> 0.12.0)
@@ -11,22 +11,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.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)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
     io-console (0.5.9)
     irb (1.3.5)
       reline (>= 0.1.5)
-    itch_client (0.2.0)
+    itch_client (0.4.1)
       mechanize (~> 2.8)
-    mechanize (2.8.1)
-      addressable (~> 2.7)
+    mechanize (2.8.5)
+      addressable (~> 2.8)
       domain_name (~> 0.5, >= 0.5.20190701)
       http-cookie (~> 1.0, >= 1.0.3)
       mime-types (~> 3.0)
@@ -36,18 +36,20 @@ GEM
       rubyntlm (~> 0.6, >= 0.6.3)
       webrick (~> 1.7)
       webrobots (~> 0.1.2)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    mime-types-data (3.2022.0105)
+    mini_portile2 (2.8.0)
     net-http-digest_auth (1.4.1)
     net-http-persistent (4.0.1)
       connection_pool (~> 2.2)
-    nokogiri (1.11.6-x86_64-linux)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     pastel (0.8.0)
       tty-color (~> 0.5)
-    public_suffix (4.0.6)
-    racc (1.5.2)
+    public_suffix (4.0.7)
+    racc (1.6.0)
     rake (13.0.3)
     reline (0.2.5)
       io-console (~> 0.5)
@@ -86,14 +88,15 @@ GEM
       tty-screen (~> 0.8)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
-    unicode-display_width (2.0.0)
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.1.0)
     unicode_utils (1.4.0)
     webrick (1.7.0)
     webrobots (0.1.2)
     wisper (2.0.1)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -12,12 +12,12 @@ Commandline tool to update game rewards on Itch.io, and automatically update rew
 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
+  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
@@ -47,12 +47,12 @@ You'll also be prompted to create an (optional) configuration file that can be u
 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
+--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
@@ -105,15 +105,15 @@ Description:
   Update a reward
 
 Arguments:
-  GAME_ID                           # REQUIRED Game with the reward to edit
-  REWARD_ID                         # REQUIRED Reward ID to update
+  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)
+  --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
@@ -132,8 +132,8 @@ 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
+  --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
 ```
 
 
@@ -193,7 +193,7 @@ MyGame:
   id: 123456
   reward_id: 789012
   reward_by_purchase: 0
-  reward_by_tip: 0.0
+  reward_by_tip: 1.0
   reward_offset: 0
   minimum_available: 0
 ```
@@ -229,4 +229,4 @@ 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).
+  * `{ remaining_percent_integer }`: A number between 0 and 100. As above (but with no decimal value included).

data/itch_rewards.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = ['itch-rewards']
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "itch_client", "~> 0.2.0"
+  spec.add_dependency "itch_client", "~> 0.4.1"
   spec.add_dependency "dry-cli", "~> 0.7.0"
   spec.add_dependency "tty-prompt", "~> 0.23.1"
   spec.add_dependency "tty-table", "~> 0.12.0"

data/lib/itch_rewards/cli.rb

@@ -77,6 +77,12 @@ module ItchRewards
 
         table.render(:unicode, multiline: true, padding: [0,1], resize: false, border: { style: :green })
       end
+
+      def 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
     end
 
     module Commands
@@ -97,6 +103,16 @@ module ItchRewards
         include AuthOptions
         @options = @options.reject {|opt| [:cookies, :interactive].include? opt.name }
 
+        def write_config(path, options)
+          require 'erb'
+          client = authenticated_client!(options)
+          
+          games = client.game_map.map.values
+          template = File.read(File.join(__dir__, 'templates/reward_config.yml.erb'))
+
+          File.write(path, ERB.new(template, trim_mode: '-').result(binding))
+        end
+
         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")
@@ -114,7 +130,7 @@ module ItchRewards
             result = cli.yes?("Config file #{config_path} does not exist, would you like to create it?")
 
             if result
-              Rewards.write_config(config_path, options)
+              write_config(config_path, options)
               cli.say "Config file written to #{config_path}"
             end
           else
@@ -140,31 +156,6 @@ module ItchRewards
       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, options)
-          require 'erb'
-          client = authenticated_client!(options)
-          
-          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
@@ -187,7 +178,7 @@ module ItchRewards
             client = authenticated_client!(options)
             game = options[:id] ? client.game(options[:id]) : client.game(name: options[:name])
 
-            Rewards.show_rewards(game)
+            show_rewards(game)
           end
         end
 
@@ -238,7 +229,7 @@ module ItchRewards
 
             rewards.save reward_list
             
-            Rewards.show_rewards(game)
+            show_rewards(game)
           end
         end
 
@@ -246,11 +237,18 @@ module ItchRewards
           include Helper
           include AuthOptions
 
+          def load_config(path)
+            YAML.load_file(path)
+          rescue YAML::ParseError => e
+            cli.error("Config file (#{path}) is not valid yaml")
+            exit 1
+          end
+
           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)
 
@@ -259,14 +257,14 @@ module ItchRewards
               exit 1
             end
 
-            config = Rewards.load_config(options[:config])
+            config = 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"
+              cli.warn "Dry run, results will not be saved"
             end
 
             purchases_by_game = client.purchases.history.each.group_by {|row| row['object_name'] }.to_h

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

@@ -20,7 +20,7 @@ games:
     # 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 )
+    # 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

data/lib/itch_rewards/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itch_rewards
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Billiam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-29 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: itch_client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Itch community copy automation utility