itch_client 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e207ec3ac07a0a26dd3315a9e0cf1a9e0e6440559b07dffbc2f673aaac24231
-  data.tar.gz: f2165aebc46c8486531bf679d03efbd2c0c5104b6854369031f69375088b9cf4
+  metadata.gz: e78c3d091abc57746fe57324e61e6328fa7194e8b50c3fde4d89426cbff9c9c4
+  data.tar.gz: 3b2a35f25b8dc886330a3d5b7211accc8f52d75c316fe5b827e23a0f6bf20e8c
 SHA512:
-  metadata.gz: feb4a98fcfd03fee02025981aa54a242cec85d4122fb74eede970d3b189c580c0898b5fea59c795e63beefb36aaf6bd5714ca8fb56406f5ed2c7812c9bdf452f
-  data.tar.gz: 48b5f07013f2e6b8435d8dafb0c708ff3b97f93d4fa4273f30024a838299c2b5c9532f669b6d6025c94b425bcdf99faaada80fcf30856c38c427e6b32cda0e33
+  metadata.gz: d6aec1b9bf214ec8db6584eba3503273dfaf8b7c629c7db6214b5acfcf20b3be605b1d9bf3a125652bd919e2e9d5e55f7576967b0ae3e29986168690e686f7cf
+  data.tar.gz: dacd4cfc500a02169a96eb984ae283bb972057f618f2b239e1a5daf45bd17d405235831fbfaaa63aa37339966c706f689a4ad2ac0091d9d6f5b21affab688dc6

data/.gitignore

@@ -10,3 +10,6 @@
 # rspec failure tracking
 .rspec_status
 .env
+cookies.yml
+*.gem
+.tool-versions

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## [Unreleased]
+## [0.4.0] - 2022-04-03
+
+- Added review list
+
+## [0.3.0] - 2021-10-13
+
+- Added bundle list
+
+## [0.2.0] - 2021-05-27
+
+- Improved error responses
 
 ## [0.1.0] - 2021-05-22
 

data/Gemfile

@@ -12,3 +12,5 @@ gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.7"
 
 gem "irb", "~> 1.3"
+
+gem "pry"

data/Gemfile.lock

@@ -1,26 +1,27 @@
 PATH
   remote: .
   specs:
-    itch_client (0.2.0)
+    itch_client (0.4.1)
       mechanize (~> 2.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    coderay (1.1.3)
     connection_pool (2.2.5)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
-    io-console (0.5.9)
-    irb (1.3.5)
-      reline (>= 0.1.5)
-    mechanize (2.8.1)
-      addressable (~> 2.7)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    mechanize (2.8.4)
+      addressable (~> 2.8)
       domain_name (~> 0.5, >= 0.5.20190701)
       http-cookie (~> 1.0, >= 1.0.3)
       mime-types (~> 3.0)
@@ -30,64 +31,72 @@ GEM
       rubyntlm (~> 0.6, >= 0.6.3)
       webrick (~> 1.7)
       webrobots (~> 0.1.2)
-    mime-types (3.3.1)
+    method_source (1.0.0)
+    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.5-x86_64-linux)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.22.1)
+    parser (3.1.1.0)
       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)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.7)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    reline (0.3.1)
       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)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.15.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
+      rubocop-ast (>= 1.16.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)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
     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)
+    unf_ext (0.0.8.1)
+    unicode-display_width (2.1.0)
     webrick (1.7.0)
     webrobots (0.1.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
   irb (~> 1.3)
   itch_client!
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)

data/README.md

@@ -171,6 +171,27 @@ client.game(12345).css
 client.game(12345).css = "body { background-color: green; }"
 ```
 
+### Reviews
+
+Fetch current reviews
+
+```ruby
+reviews = client.game(12345).reviews.list
+#=>
+[
+  #<Itch::Review:0x0000557aa98c7930
+  @id="123456789",
+  @user_name="Billiam",
+  @user_id="billiam",
+  @date=<DateTime: 2022-04-03T10:02:00+00:00>,
+  @stars=4,
+  @review=[
+    "I really like this game",
+    "So much that I've added a second paragraph"
+  ],
+]
+```
+
 ### Rewards
 
 Fetch reward CSV data
@@ -253,6 +274,24 @@ end
 client.game(12345).rewards.save(filtered_rewards)
 ```
 
+## Bundles
+
+Fetch current bundles
+
+```ruby
+client.bundles.list
+
+#=>
+[
+  #<Itch::Bundle:0x0000557aa98c7930
+  @id="123",
+  @earnings=BigDecimal(123.00),
+  @price=BigDecimal(10.00),
+  @purchases=10,
+  @title="My Bundle!"
+]
+```
+
 ## 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.

data/itch_client.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }

data/lib/itch/bundle.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "simple_inspect"
+
+module Itch
+  # Data container for single bundle
+  class Bundle
+    include SimpleInspect
+
+    attr_accessor :id, :title, :games, :purchases, :price, :earnings
+
+    def initialize(id, title, purchases, price, earnings)
+      @id = id
+      @title = title
+      @purchases = purchases
+      @price = price
+      @earnings = earnings
+    end
+
+    def url
+      format(Itch::URL::BUNDLE, id: @id)
+    end
+  end
+end

data/lib/itch/bundles.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+
+require_relative "simple_inspect"
+require_relative "bundle"
+require_relative "request"
+require_relative "require_auth"
+
+module Itch
+  # Fetch bundles
+  class Bundles
+    include RequireAuth
+    include SimpleInspect
+    include Request
+
+    def initialize(agent)
+      @agent = agent
+    end
+
+    def list
+      page = with_login do
+        @agent.get(bundles_url)
+      end
+
+      page.css(".bundle_list table > tr").map do |row|
+        parse_row(row)
+      end
+    end
+
+    def parse_row(row)
+      id = row.at_xpath("td[2]/a/@href").value.match(%r{^/b/(\d+)/})[1]
+      vals = row.css("td").map(&:text)
+      price = BigDecimal(vals[5].gsub(/[^\d.-]/, ""))
+      earnings = BigDecimal(vals[6].gsub(/[\D-]/, ""))
+
+      Bundle.new(id, vals[1], vals[4].to_i, price, earnings)
+    end
+
+    def bundles_url
+      Itch::URL::BUNDLES
+    end
+  end
+end

data/lib/itch/client.rb

@@ -4,6 +4,7 @@ require "forwardable"
 require "mechanize"
 
 require_relative "auth"
+require_relative "bundles"
 require_relative "game"
 require_relative "game_map"
 require_relative "purchases"
@@ -35,6 +36,10 @@ module Itch
       @purchases ||= Purchases.new(@agent)
     end
 
+    def bundles
+      @bundles ||= Bundles.new(@agent)
+    end
+
     def game_map
       @game_map ||= GameMap.new(@agent)
     end

data/lib/itch/game.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "reviews"
 require_relative "rewards"
 require_relative "reward"
 require_relative "require_auth"
@@ -48,6 +49,10 @@ module Itch
       Rewards.new(@agent, @id)
     end
 
+    def reviews
+      Reviews.new(@agent, @id)
+    end
+
     def reward(id)
       rewards.find { |reward| reward.id == id }
     end

data/lib/itch/review.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "simple_inspect"
+
+module Itch
+  # Data container for single review
+  class Review
+    include SimpleInspect
+
+    attr_reader :id, :user_name, :user_id, :stars, :date, :review
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(user_name:, user_id:, stars:, date:, review:, id: nil)
+      @id = id
+      @user_name = user_name
+      @user_id = user_id
+      @stars = stars
+      @date = date
+      @review = review
+    end
+    # rubocop:enable Metrics/ParameterLists
+  end
+end

data/lib/itch/reviews.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "require_auth"
+require_relative "simple_inspect"
+require_relative "review"
+require_relative "request"
+
+module Itch
+  # Fetch reviews
+  class Reviews
+    include SimpleInspect
+    include RequireAuth
+    include Request
+
+    def initialize(agent, game_id)
+      @agent = agent
+      @game_id = game_id
+    end
+
+    def list
+      all_reviews = []
+
+      page_number = 1
+      loop do
+        page_reviews = parse_page_reviews(page_number)
+
+        break if page_reviews.empty?
+
+        all_reviews += page_reviews
+        page_number += 1
+        sleep 0.5
+      end
+
+      all_reviews
+    end
+
+    protected
+
+    def parse_page_reviews(page_number)
+      page = with_login do
+        @agent.get(review_url(page_number))
+      end
+
+      raise Error, "Could not find game id #{@game_id} rewards" unless page.code == "200"
+
+      page.css(".content_column .rating").map do |row|
+        parse_row row
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def parse_row(row)
+      id = row.at_css("button[data-lightbox_url]")["data-lightbox_url"].split("/").last
+      stars = row.css(".star_picker .icon-star").length
+      header = row.at_css(".row_header")
+      date = DateTime.parse header.at_css("abbr")["title"].strip
+
+      user_link = header.at_css(".user_link")
+      user_name = user_link.search("./text()").text.strip
+      user_id = user_link["href"].split("/").last
+
+      text = row.css(".blurb p").map(&:text)
+
+      Review.new(
+        id: id,
+        user_name: user_name,
+        user_id: user_id,
+        stars: stars,
+        date: date,
+        review: text
+      )
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+    def review_url(page = 1)
+      format(Itch::URL::REVIEWS, id: @game_id, page: page)
+    end
+  end
+end

data/lib/itch/rewards.rb

@@ -15,7 +15,7 @@ module Itch
     include RequireAuth
     include Request
 
-    REWARD_DATA = /GameEdit\.EditRewards\(.*?(?:"rewards":(\[.*\]),)?"reward_noun":"(.*(?<!\\))"}\)/.freeze
+    REWARD_DATA = /GameEdit\.EditRewards\(.*?(?:"rewards":(\[.*?\]),)?"reward_noun":"(.*?)(?<!\\)"/.freeze
 
     def initialize(agent, game_id)
       @agent = agent
@@ -106,9 +106,9 @@ module Itch
         input.name.match(/^rewards\[(\d+)\]\[id\]/)
       end.value
 
-      attributes = %w[title description amount price].map do |name|
+      attributes = %w[title description amount price].to_h do |name|
         [name.to_sym, row.css_at(".reward_#{name}_input").value]
-      end.to_h
+      end
       attributes[:claimed] = row.css_at(".claimed_count").text
 
       Reward.new(@agent, @game_id, id, attributes)

data/lib/itch/version.rb

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

data/lib/itch_client.rb

@@ -28,11 +28,14 @@ module Itch
 
   module URL
     DASHBOARD = "https://itch.io/dashboard"
+    BUNDLES = "https://itch.io/dashboard/bundles"
+    BUNDLE = "https://itch.io/bundle/%<id>d"
     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"
+    REVIEWS = "https://itch.io/game/ratings/%<id>d?page=%<page>d"
     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/"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itch_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Billiam
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -45,12 +45,16 @@ files:
 - bin/setup
 - itch_client.gemspec
 - lib/itch/auth.rb
+- lib/itch/bundle.rb
+- lib/itch/bundles.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/review.rb
+- lib/itch/reviews.rb
 - lib/itch/reward.rb
 - lib/itch/rewards.rb
 - lib/itch/simple_inspect.rb
@@ -63,6 +67,7 @@ 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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -78,7 +83,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.io screen scraping utility