itch_client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e207ec3ac07a0a26dd3315a9e0cf1a9e0e6440559b07dffbc2f673aaac24231
+  data.tar.gz: f2165aebc46c8486531bf679d03efbd2c0c5104b6854369031f69375088b9cf4
+SHA512:
+  metadata.gz: feb4a98fcfd03fee02025981aa54a242cec85d4122fb74eede970d3b189c580c0898b5fea59c795e63beefb36aaf6bd5714ca8fb56406f5ed2c7812c9bdf452f
+  data.tar.gz: 48b5f07013f2e6b8435d8dafb0c708ff3b97f93d4fa4273f30024a838299c2b5c9532f669b6d6025c94b425bcdf99faaada80fcf30856c38c427e6b32cda0e33

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,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in itch.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "irb", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    itch_client (0.2.0)
+      mechanize (~> 2.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    connection_pool (2.2.5)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    io-console (0.5.9)
+    irb (1.3.5)
+      reline (>= 0.1.5)
+    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.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    reline (0.2.5)
+      io-console (~> 0.5)
+    rexml (3.2.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)
+    rubocop (1.15.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    rubyntlm (0.6.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
+    webrick (1.7.0)
+    webrobots (0.1.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  irb (~> 1.3)
+  itch_client!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+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,268 @@
+# Itch Client
+
+An itch.io screenscraping and automation utility.
+
+Originally written to help automate community copy rewards based on purchases and tips.
+
+## Features
+
+* Log in and save cookies
+* Fetch and parse purchase CSV data, optionally by date
+* Fetch and parse reward redemption CSV data
+* Fetch reward data
+* Add/update/delete rewards
+* Fetch and update game theme and custom CSS data
+
+## How fragile is it?
+
+Very fragile. Enjoy it while it lasts!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'itch_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install itch_client
+
+## Usage
+
+### Authentication
+
+The itch client requires a username and password. It doesn't handle captchas, so ironically, 2fa must be enabled.
+
+```ruby
+client = Itch.new(username: ENV['itch_username'], password: ENV['itch_password'], cookie_path: "./cookies.yml")
+client.totp = -> { puts "Enter your 2fa code: \n"; gets.chomp }
+client.logged_in?
+#=> false
+client.login
+client.logged_in?
+#=> true
+```
+
+After logging in, a cookie file will be saved at the `cookie_path` location if provided, and it won't be necessary to log in again until the cookie expires.
+
+## Purchases
+
+Fetch purchases csv data
+
+```ruby
+data = client.purchases.history
+#=> #<CSV io_type:Hash encoding:ASCII-8BIT lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"" headers:true>
+data.each do |row|
+  row.to_h
+#=> {
+#  "id"=>"123456",
+#  "object_name"=>"MyGame",
+#  "amount"=>"3.00",
+#  "source"=>"paypal",
+#  "created_at"=>"2016-01-07 23:41:31 UTC",
+#  "email"=>"email@example.com",
+#  "full_name"=>nil,
+#  "donation"=>"false",
+#  "on_sale"=>"false",
+#  "country_code"=>"CA",
+#  "ip"=>"0.0.0.0",
+#  "product_price"=>"0",
+#  "tax_added"=>"0.00",
+#  "tip"=>"3.00",
+#  "marketplace_fee"=>"0.30",
+#  "source_fee"=>"0.40",
+#  "payout"=>"payout_paid",
+#  "amount_delivered"=>"2.00",
+#  "currency"=>"USD",
+#  "source_id"=>"PAYID-ABCDEFGHIJKLMNOP",
+#  "billing_name"=>nil,
+#  "billing_street_1"=>nil,
+#  "billing_street_2"=>nil,
+#  "billing_city"=>nil,
+#  "billing_state"=>nil,
+#  "billing_zip"=>nil,
+#  "billing_country"=>nil
+# }
+end
+```
+
+Fetch one year of purchases
+
+```ruby
+client.purchases.history_by_year(2021)
+```
+
+Fetch one month of purchases
+
+```ruby
+client.purchases.history_by_month(5, 2019)
+```
+
+## Games
+
+Find game by ID
+
+```ruby
+client.game(12345)
+```
+
+Find game by name
+
+```ruby
+client.game(name: 'MyItchGame')
+client.id
+# => 12345
+```
+
+### Game theme
+
+Fetch game theme information
+
+```ruby
+client.game(12345).theme
+#=> {
+#  "link_color"=>"#00ff00",
+#  "screenshots_loc"=>"hidden",
+#  "button_color"=>"#00ff00",
+#  "banner_position"=>"align_center",
+#  "background_repeat"=>"repeat-x",
+#  "default_screenshots_loc"=>"sidebar",
+#  "background_position"=>"align_right",
+#  "header_font_family"=>"serif",
+#  "background_image"=>
+#   {"url"=>"https://itch.io/dashboard/upload-image?upload_id=54321",
+#    "thumb_url"=>"https://img.itch.zone/aBcDeFgHiJkLmNoPqRsTuVwXyZ/original/aBcDe.png",
+#    "id"=>6027863},
+#  "font_size"=>"large",
+#  "bg_color"=>"#00ff00",
+#  "header_text_color"=>"#00ff00",
+#  "css"=>"body { color: blue; }",
+#  "bg2_color"=>"#00ff00",
+#  "banner_image"=>
+#   {"url"=>"https://itch.io/dashboard/upload-image?upload_id=12345",
+#    "thumb_url"=>"https://img.itch.zone/aBcDeFgHiJkLmNoPqRsTuVwXyZ/original/aBcDe.png",
+#    "id"=>12345678},
+#  "text_color"=>"#00ff00",
+#  "font_family"=>"pixel"
+# }
+```
+
+Update game theme information
+
+```ruby
+game = client.game(12345)
+new_theme = game.theme
+new_theme['button_color'] = "#cccccc"
+new_theme['css'] = "body { background-color: orange; }"
+game.theme = new_theme
+```
+
+CSS Shortcuts
+
+```ruby
+client.game(12345).css
+#=> body { background-color: orange; }
+client.game(12345).css = "body { background-color: green; }"
+```
+
+### Rewards
+
+Fetch reward CSV data
+
+```ruby
+client.game(12345).rewards.history
+#=> #<CSV io_type:Hash encoding:ASCII-8BIT lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"" headers:true>
+data.each do |row|
+  row.to_h
+#=> 
+# {
+#   "reward"=>"Free Community Copy",
+#   "date"=>"2021-05-21 06:56:34 UTC",
+#   "contact"=>nil,
+#   "fulfilled"=>"false",
+#   "shortcode"=>"VKDC-W4DD"
+# }
+end
+```
+
+#### Fetch current rewards
+
+```ruby
+client.game(12345).rewards.list
+#=>
+[
+  #<Itch::Reward:0x0000557aa98c7930
+  @amount=1,
+  @archived=false,
+  @claimed=0,
+  @description="<p>Hello. This is a reward description</p>",
+  @id=123456789,
+  @price="$5.00",
+  @title="My Reward">,
+]
+```
+
+#### Modify a reward
+
+Note: All rewards must be saved at once as follows, even if only one is being modified
+
+```ruby
+rewards = client.game(12345).rewards.list
+rewards.first.amount
+#=> 10
+rewards.first.amount = 15
+#=> 15
+client.game(12345).rewards.save(rewards)
+```
+
+#### Add a reward
+
+```ruby
+rewards = client.game(12345).rewards.list
+new_reward = Itch::Reward.new(
+  title: "My New Reward",
+  description: "<p>Full content of reward description</p>",
+  amount: 10,
+  price: "$10.00"
+)
+rewards << new_reward
+client.game(12345).rewards.save(rewards)
+```
+
+#### Archive a reward
+
+```ruby
+rewards = client.game(12345).rewards.list
+rewards.first.archived = true
+client.game(12345).rewards.save(rewards)
+```
+
+#### Remove rewards
+
+```ruby
+rewards = client.game(12345).rewards.list
+filtered_rewards = rewards.select do |reward|
+  reward.amount > 5
+end
+client.game(12345).rewards.save(filtered_rewards)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/Billiam/itch-client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,25 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "itch_client"
+
+# 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/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/itch_client.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/itch/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "itch_client"
+  spec.version       = Itch::VERSION
+  spec.authors       = ["Billiam"]
+  spec.email         = ["billiamthesecond@gmail.com"]
+
+  spec.summary       = "Itch.io screen scraping utility"
+  spec.homepage      = "https://github.com/Billiam/itch-client"
+  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"
+
+  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.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "mechanize", "~> 2.8"
+end

data/lib/itch/auth.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative "simple_inspect"
+
+module Itch
+  # Authentication flow handler
+  class Auth
+    include SimpleInspect
+
+    attr_writer :username, :password, :totp
+
+    def initialize(agent, username: nil, password: nil, cookie_path: nil)
+      @agent = agent
+      @cookie_path = cookie_path
+      @username = username
+      @password = password
+      @totp = -> {}
+    end
+
+    def logged_in?
+      @agent.get(Itch::URL::DASHBOARD).uri.to_s == Itch::URL::DASHBOARD
+    end
+
+    def login
+      page = @agent.get(Itch::URL::LOGIN)
+      return unless page.code == "200"
+      raise AuthError, "Email and password are required for login" if @username.nil? || @password.nil?
+
+      page = submit_login(page) if page_is_login?(page)
+      submit_2fa(page) if page_is_2fa?(page)
+
+      save_cookies
+
+      logged_in?
+    end
+
+    def page_is_login?(page)
+      page.uri.to_s == Itch::URL::LOGIN
+    end
+
+    def page_is_2fa?(page)
+      page.uri.to_s.start_with?(Itch::URL::TOTP_FRAGMENT)
+    end
+
+    protected
+
+    def exclude_inspection
+      super + [:@password]
+    end
+
+    def save_cookies
+      @agent.cookie_jar.save(@cookie_path) if @cookie_path
+    end
+
+    def submit_2fa(page)
+      form = page.form_with(action: page.uri.to_s)
+      form.code = totp_code
+      page = form.submit
+
+      if page_is_2fa?(page)
+        # 2fa failed
+        errors = page.css(".form_errors li").map(&:text)
+        raise AuthError, "#{errors.size} error#{errors.size == 1 ? "" : "s"} prevented 2fa validation", errors
+      end
+
+      page
+    end
+
+    def totp_code
+      code = @totp.call
+      raise AuthError, "TOTP code is required" if code.nil? || code.empty?
+
+      code.chomp
+    end
+
+    def password
+      return @password.call if @password.respond_to? :call
+
+      @password
+    end
+
+    def username
+      return @username.call if @username.respond_to? :call
+
+      @username
+    end
+
+    def submit_login(page)
+      form = page.form_with(action: Itch::URL::LOGIN)
+
+      form.username = username
+      form.password = password
+
+      page = form.submit
+
+      if page_is_login?(page)
+        # Login failed
+        errors = page.css(".form_errors li").map(&:text)
+        raise AuthError.new("#{errors.size} error#{errors.size == 1 ? "" : "s"} prevented login", errors: errors)
+      end
+
+      page
+    end
+  end
+end

data/lib/itch/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "mechanize"
+
+require_relative "auth"
+require_relative "game"
+require_relative "game_map"
+require_relative "purchases"
+require_relative "simple_inspect"
+
+module Itch
+  # The primary client interface
+  #
+  # The top level client delegates to child modules for specific app areas
+  # like game and purchases pages
+  class Client
+    extend Forwardable
+    include SimpleInspect
+
+    def_delegators :@auth, :logged_in?, :login, :totp=, :username=, :password=
+
+    def initialize(username: nil, password: nil, cookie_path: nil)
+      @agent = Mechanize.new
+      @auth = Auth.new(@agent, username: username, password: password, cookie_path: cookie_path)
+
+      @agent.cookie_jar.load(cookie_path) if cookie_path && File.readable?(cookie_path)
+    end
+
+    def game(id = nil, name: nil)
+      Game.new(@agent, game_map, id, name: name)
+    end
+
+    def purchases
+      @purchases ||= Purchases.new(@agent)
+    end
+
+    def game_map
+      @game_map ||= GameMap.new(@agent)
+    end
+  end
+end

data/lib/itch/game.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative "rewards"
+require_relative "reward"
+require_relative "require_auth"
+require_relative "simple_inspect"
+
+module Itch
+  # Represents a single game and sub-resources
+  class Game
+    include RequireAuth
+    include SimpleInspect
+
+    attr_reader :id, :name, :page_url
+
+    THEME_DATA = /GameEdit\.ThemeEditor\((.*)\),\$\('#game_appearance_editor_widget_/.freeze
+
+    def initialize(agent, map, id = nil, name: nil)
+      raise Error, "Game ID or name is required" if id.nil? && name.nil?
+
+      @agent = agent
+      @map = map
+
+      load_game_info(id, name)
+    end
+
+    def theme
+      JSON.parse(theme_data)["theme"]
+    rescue StandardError
+      {}
+    end
+
+    def css
+      theme["css"]
+    end
+
+    def theme=(theme_data)
+      @agent.post edit_theme_url, theme_post_data(theme_data)
+    end
+
+    def css=(css_data)
+      new_theme = theme
+      new_theme["css"] = css_data
+      self.theme = new_theme
+    end
+
+    def rewards
+      Rewards.new(@agent, @id)
+    end
+
+    def reward(id)
+      rewards.find { |reward| reward.id == id }
+    end
+
+    protected
+
+    def load_game_info(id, name)
+      if id
+        data = @map.find!(id)
+      elsif name
+        data = @map.find_by_name!(name)
+      else
+        raise Error, "Name or ID is required when initializing Itch::Game"
+      end
+
+      @id = data[:id]
+      @page_url = data[:url]
+      @name = data[:name]
+    end
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def theme_post_data(new_theme)
+      filtered_theme = new_theme.reject do |k, _v|
+        %w[background_image background_repeat background_position banner_image banner_position].include?(k)
+      end
+
+      post_data = filtered_theme.transform_keys do |k|
+        "layout[#{k}]"
+      end.merge({ "csrf_token" => theme_csrf_token })
+
+      if new_theme["background_image"]
+        post_data["layout[background_image][image_id]"] = new_theme["background_image"]["id"]
+        post_data["layout[background_image][repeat]"] = new_theme["background_repeat"]
+        post_data["layout[background_image][position]"] = new_theme["background_position"]
+      end
+
+      if new_theme["banner_image"]
+        post_data["layout[banner_image][id]"] = new_theme["banner_image"]["id"]
+        post_data["layout[banner_image][position]"] = new_theme["banner_position"]
+      end
+
+      post_data["header_font_family"] ||= "_default"
+
+      post_data
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    def theme_csrf_token
+      page = with_login { game_page }
+
+      page.at_css("meta[name='csrf_token']")["value"]
+    end
+
+    def theme_data
+      page = with_login { game_page }
+
+      script = page.css("script").find do |node|
+        node.text =~ THEME_DATA
+      end.text
+
+      THEME_DATA.match(script)[1]
+    end
+
+    def edit_url
+      format(Itch::URL::EDIT_GAME, id: @id)
+    end
+
+    def edit_theme_url
+      "#{@page_url}/edit"
+    end
+
+    def form
+      edit_page.form_with(action: edit_url)
+    end
+
+    def game_page
+      @agent.get @page_url
+    end
+
+    def edit_page
+      with_login do
+        @agent.get edit_url
+      end
+    end
+  end
+end

data/lib/itch/game_map.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "csv"
+
+require_relative "simple_inspect"
+require_relative "require_auth"
+
+module Itch
+  # Map game names to itch ids
+  #
+  # Could be handled via API, but would require user API keys or oauth
+  class GameMap
+    include SimpleInspect
+    include RequireAuth
+
+    def initialize(agent)
+      @agent = agent
+    end
+
+    def map
+      @map ||= begin
+        page = with_login do
+          @agent.get(Itch::URL::DASHBOARD)
+        end
+
+        parse_dashboard page
+      end
+    end
+
+    def find_by_name(name)
+      map[name]
+    end
+
+    def find_by_name!(name)
+      result = find_by_name(name)
+      raise Error, "Cannot find game with name #{name}" unless result
+
+      result
+    end
+
+    def find!(id)
+      result = find(id)
+      raise Error, "Cannot find game with id #{id}" unless result
+
+      result
+    end
+
+    def find(id)
+      id = id.to_s
+      map.values.find do |value|
+        value[:id] == id
+      end
+    end
+
+    protected
+
+    def parse_dashboard(page)
+      page.css(".game_row").map do |row|
+        title = row.at_css(".game_title .game_link")
+        name = title.text
+        url = title["href"]
+        edit_url = row.at_xpath('.//a[text()="Edit"]/@href').value
+
+        id = edit_url.match(%r{/game/edit/(\d+)})[1]
+        [name, { id: id, url: url, name: name }] if id && name
+      end.compact.to_h
+    end
+  end
+end

data/lib/itch/purchases.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "csv"
+require_relative "require_auth"
+require_relative "simple_inspect"
+require_relative "request"
+
+module Itch
+  # Return purchase history and history by date
+  class Purchases
+    include RequireAuth
+    include SimpleInspect
+    include Request
+
+    def initialize(agent)
+      @agent = agent
+    end
+
+    def history_by_month(month, year)
+      fetch_csv format(Itch::URL::MONTH_PURCHASES_CSV, month: month, year: year)
+    end
+
+    def history_by_year(year)
+      fetch_csv format(Itch::URL::YEAR_PURCHASES_CSV, year: year)
+    end
+
+    def history
+      fetch_csv Itch::URL::PURCHASES_CSV
+    end
+
+    protected
+
+    def fetch_csv(url)
+      page = with_login do
+        @agent.get(url)
+      end
+
+      validate_response(page, action: "fetching purchase CSV", content_type: "text/csv")
+
+      CSV.new(page.content, headers: true)
+    end
+  end
+end

data/lib/itch/request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Itch
+  # Mix in for request validation and response parsing
+  module Request
+    # rubocop:disable all
+    def validate_response(page, action: "making request", content_type: "text/html")
+      response_type = page.response["content-type"]
+      return if page.code == "200" && response_type == content_type
+
+      unless response_type == "application/json"
+        raise Error, "Unexpected error occurred while #{action}: Response code #{page.code}"
+      end
+
+      error_data = nil
+      begin
+        data = JSON.parse(page.content)
+        if data["errors"]
+          error_data = data["errors"].respond_to?(:join) ? "\n#{data["errors"].join("\n")}" : data["errors"]
+        end
+      rescue StandardError
+        raise Error, "Error parsing response while #{action}"
+      end
+
+      raise Error, "Unexpected error occurred while #{action}: #{error_data}"
+    end
+    # rubocop:enable all
+  end
+end

data/lib/itch/require_auth.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Itch
+  # Mixin to raise exceptions when a request redirects to login page
+  module RequireAuth
+    def require_auth(page)
+      raise AuthError, "User is not logged in" if page.uri.to_s == Itch::URL::LOGIN
+
+      page
+    end
+
+    def with_login
+      require_auth yield
+    end
+  end
+end

data/lib/itch/reward.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "csv"
+
+require_relative "simple_inspect"
+
+module Itch
+  # Data container for single reward
+  class Reward
+    include SimpleInspect
+
+    attr_accessor :amount, :archived, :claimed, :description, :id, :price, :title
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(amount:, description:, price:, title:, archived: false, claimed: 0, id: nil)
+      @id = id
+      @description = description
+      @title = title
+      @amount = amount
+      @price = price
+      @claimed = claimed
+      @archived = archived
+    end
+    # rubocop:enable Metrics/ParameterLists
+  end
+end

data/lib/itch/rewards.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "csv"
+require "json"
+
+require_relative "require_auth"
+require_relative "simple_inspect"
+require_relative "reward"
+require_relative "request"
+
+module Itch
+  # Fetch rewards and history
+  class Rewards
+    include SimpleInspect
+    include RequireAuth
+    include Request
+
+    REWARD_DATA = /GameEdit\.EditRewards\(.*?(?:"rewards":(\[.*\]),)?"reward_noun":"(.*(?<!\\))"}\)/.freeze
+
+    def initialize(agent, game_id)
+      @agent = agent
+      @game_id = game_id
+    end
+
+    def history
+      page = with_login do
+        @agent.get(csv_url)
+      end
+
+      validate_response(page, action: "fetching reward CSV", content_type: "text/csv")
+
+      CSV.new(page.content, headers: true)
+    end
+
+    def list
+      rewards, _noun = fetch_rewards_data
+
+      return [] unless rewards
+
+      build_rewards(rewards)
+    end
+
+    def save(rewards)
+      _rewards, noun = fetch_rewards_data
+
+      post_data = build_post_data(rewards, noun)
+
+      result = @agent.post rewards_url, post_data
+
+      validate_response(result, action: "updating rewards")
+
+      list
+    end
+
+    protected
+
+    # rubocop:disable Metrics/MethodLength
+    def build_post_data(rewards, noun)
+      rewards.map.with_index do |reward, index|
+        {
+          "rewards[#{index}][title]" => reward.title,
+          "rewards[#{index}][description]" => reward.description,
+          "rewards[#{index}][price]" => reward.price,
+          "rewards[#{index}][amount]" => reward.amount
+        }.tap do |data|
+          data["rewards[#{index}][archived]"] = "on" if reward.archived
+
+          data["rewards[#{index}][id]"] = reward.id if reward.id
+        end
+      end.inject({ "reward_noun" => noun }, &:merge)
+    end
+
+    def build_rewards(data)
+      JSON.parse(data).map do |reward|
+        Reward.new(
+          id: reward["id"],
+          description: reward["description"],
+          title: reward["title"],
+          amount: reward["amount"],
+          price: reward["price"],
+          claimed: reward["claimed_count"],
+          archived: reward["archived"]
+        )
+      rescue StandardError
+        []
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def fetch_rewards_data
+      page = with_login do
+        @agent.get(rewards_url)
+      end
+
+      raise Error, "Could not find game id #{@game_id} rewards" unless page.code == "200"
+
+      script = page.css("script").find do |node|
+        node.text =~ REWARD_DATA
+      end.text
+
+      REWARD_DATA.match(script)[1..]
+    end
+
+    def parse_row(row)
+      id = row.css('input[type="hidden"]').find do |input|
+        input.name.match(/^rewards\[(\d+)\]\[id\]/)
+      end.value
+
+      attributes = %w[title description amount price].map do |name|
+        [name.to_sym, row.css_at(".reward_#{name}_input").value]
+      end.to_h
+      attributes[:claimed] = row.css_at(".claimed_count").text
+
+      Reward.new(@agent, @game_id, id, attributes)
+    end
+
+    def rewards_url
+      format(Itch::URL::REWARDS, id: @game_id)
+    end
+
+    def csv_url
+      format(Itch::URL::REWARD_CSV, id: @game_id)
+    end
+  end
+end

data/lib/itch/simple_inspect.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Limit output of agent variable
+module SimpleInspect
+  def inspect
+    attrs = pretty_print_instance_variables
+    values = [
+      "#{self.class}##{object_id}",
+      *attrs.map { |k| "#{k}: #{instance_variable_get(k)}" }
+    ]
+
+    "<#{values.join(" ")}>"
+  end
+
+  def pretty_print_instance_variables
+    instance_variables.sort.reject { |i| exclude_inspection.include? i }
+  end
+
+  def exclude_inspection
+    [:agent]
+  end
+end

data/lib/itch/version.rb

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

data/lib/itch_client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "itch/version"
+require_relative "itch/client"
+
+# Top level interface class, delegates to Itch::Client
+module Itch
+  class Error < StandardError; end
+
+  # Authentication errors, includes individual error messages
+  # in errors key
+  class AuthError < Error
+    attr_reader :errors
+
+    def initialize(message, errors: [])
+      super(message)
+      @errors = errors
+    end
+
+    def message
+      m = super
+
+      return "#{m}\n\n#{errors.join("\n")}" if errors.any?
+
+      m
+    end
+  end
+
+  module URL
+    DASHBOARD = "https://itch.io/dashboard"
+    EDIT_GAME = "https://itch.io/game/edit/%<id>d"
+    GAME = "https://%<username>s.itch.io/%<slug>s"
+    LOGIN = "https://itch.io/login"
+    MONTH_PURCHASES_CSV = "https://itch.io/export-purchases/by-date/%<month>d-%<year>d"
+    PURCHASES_CSV = "https://itch.io/export-purchases/all"
+    REWARD_CSV = "https://itch.io/game/rewards/%<id>d/claimed?format=csv"
+    REWARDS = "https://itch.io/game/rewards/%<id>d"
+    TOTP_FRAGMENT = "https://itch.io/totp/verify/"
+    YEAR_PURCHASES_CSV = "https://itch.io/export-purchases/by-date/%<year>d"
+  end
+
+  def self.new(**kwargs)
+    Client.new(**kwargs)
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: itch_client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Billiam
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description:
+email:
+- billiamthesecond@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- itch_client.gemspec
+- lib/itch/auth.rb
+- lib/itch/client.rb
+- lib/itch/game.rb
+- lib/itch/game_map.rb
+- lib/itch/purchases.rb
+- lib/itch/request.rb
+- lib/itch/require_auth.rb
+- lib/itch/reward.rb
+- lib/itch/rewards.rb
+- lib/itch/simple_inspect.rb
+- lib/itch/version.rb
+- lib/itch_client.rb
+homepage: https://github.com/Billiam/itch-client
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Billiam/itch-client
+  source_code_uri: https://github.com/Billiam/itch-client
+  changelog_uri: https://github.com/Billiam/itch-client/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.io screen scraping utility
+test_files: []