twitchrb 1.9.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a8ec322ca201921696368ca233dde770618982deddc216f4a312d392cadc84
-  data.tar.gz: '092e46eccc58dca91227562cfbabacf8f234b17d49be1c4bc738acf0d9fc8331'
+  metadata.gz: 4a4de14d63208a337630d3530f24d90679645c2b4ad02d4f31beb96f687a6ff1
+  data.tar.gz: 2e49411b20156a55d93fa60e1dba87bf25121c228f601e10f6861e01aa9b0094
 SHA512:
-  metadata.gz: 17230eacff5f07b1e2fd5442a0f811ba0028e6d568497f4e9e0ae75f3fbff77e85a6404b338f44598741bbe5789533fc28e93a36a56248188108290d495f227c
-  data.tar.gz: 03c6b2866d43558f19e2610ad520b260622c1c03fce7b9e3575f694bc13ee6e47a2ec7a9f3c436b9ca9590bf745476633796ac8817fada01acc70acd521f4623
+  metadata.gz: 81bcbe6402c4cdf5f3cc90ac181aec22d8d46990053846f1bce3b92aead9f71462857c6b92e1b5dcbd4c34d1e635e057ce86516c856db1944252d01dc1e90b56
+  data.tar.gz: cfff782da54f1ffde515c8911febf8d251c1df677d0ba481399cfc86d2bd95c9885e0d5f6682aadbb96be98dc4cecf0ceda8aa72b073abdda842b4dc8e7ce120

data/.github/workflows/ci.yml

@@ -1,21 +1,18 @@
 name: CI
 on:
   push:
-    branches:
-      - main
   pull_request:
-    branches:
-      - main
 jobs:
   lint:
     runs-on: ubuntu-latest
+    continue-on-error: true
     steps:
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.4'
+          ruby-version: '4.0'
           bundler-cache: true
       - name: Lint code for consistent style
         run: bundle exec rubocop -f github
@@ -27,11 +24,11 @@ jobs:
       fail-fast: false
       matrix:
         ruby_version:
-          - '3.2'
           - '3.3'
           - '3.4'
+          - '4.0'
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}

data/.rubocop.yml

@@ -1,6 +1,11 @@
 # Omakase Ruby styling for Rails
 inherit_gem: { rubocop-rails-omakase: rubocop.yml }
 
+AllCops:
+  Exclude:
+    - 'test/**/*'
+  TargetRubyVersion: 4.0
+
 # Overwrite or add rules to create your own house style
 #
 # # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`

data/CHANGELOG.md

@@ -0,0 +1,260 @@
+# Changelog
+
+All notable changes to `twitchrb` are documented in this file.
+
+Published release notes were sourced from GitHub releases where available. Older tag-only versions and the current unreleased work were reconstructed from local git history.
+
+## [1.11.0] - 2026-08-11
+
+### Fixed
+- Fixed a `NoMethodError` crash when API responses have non-JSON bodies, such as `stream_schedule.icalendar` (which was completely broken) and HTML error pages from proxies.
+- Fixed `users.retrieve` and `games.retrieve` returning `nil` when a plural lookup (`ids`, `usernames`, `names`) matched exactly one item; plural lookups now always return a `Collection`. Singular lookups with no match now return `nil` instead of an empty object.
+- Fixed `oauth.revoke` always returning `true`; it now returns `false` when revocation fails, matching `validate`, `create`, and `refresh`.
+- Fixed `blocked_terms.create` returning a `BannedUser` instead of a `BlockedTerm`.
+- Fixed `suspicious_users.delete` crashing on 204 No Content responses; it now returns `true`.
+- Fixed query string values not being escaped in request paths. Notably, `users.update_color` silently dropped hex colors like `#9146FF`.
+- Errors are now raised for any 4xx/5xx response; previously 422, 502, and 504 slipped through unraised.
+- `Collection#total` now reports the `total` field from the API for paginated endpoints instead of the page size, and responses without a `data` key return an empty collection instead of raising.
+- Removed a leftover debug `puts` in `users.get_color`.
+- Error messages for unmapped statuses no longer duplicate the Twitch message.
+- Updated the minimum Faraday version to 2.14.3 to fix the uncontrolled recursion denial-of-service vulnerability in `NestedParamsEncoder` (CVE-2026-54297).
+
+### Changed
+- The `auto_retry_rate_limit` client option (default `true`) now works: requests that hit a 429 wait until the rate limit window resets and retry once. Previously the option was accepted but ignored.
+- All API errors now inherit from `Twitch::Error`, so they can be rescued with a single base class.
+- `eventsub_subscriptions.create` now goes through the shared request helpers, gaining request path validation and rate limit auto-retry.
+
+### Added
+- `users.get_color` accepts an array for `user_ids`, in line with other multi-id endpoints. Comma-separated strings still work.
+
+## [1.10.0] - 2026-05-16
+
+### Added
+- Added custom power-up API support.
+- Added shared chat announcement support.
+- Added shared chat session support.
+- Added suspicious user moderation APIs.
+- Added VOD clip creation and downloads.
+- Added pinned chat message support.
+
+### Changed
+- Replaced hype train events with the status API.
+- Improved EventSub subscription conflict handling.
+
+### Fixed
+- Fixed SSRF via protocol-relative request paths.
+
+## [1.9.1] - 2025-12-06
+
+### Fixed
+- Permissions fix.
+
+## [1.9.0] - 2025-12-05
+
+### Changed
+- Tag-only release with no published release notes or recorded user-facing changes beyond the version bump.
+
+## [1.8.1] - 2025-12-05
+
+### Added
+- Added support for Start Commercial.
+
+### Changed
+- Imported `Enumerable` into collections.
+
+## [1.8.0] - 2025-12-01
+
+### Added
+- Added support for Get Stream Key.
+
+## [1.7.0] - 2025-10-20
+
+### Added
+- Added support for Get Authorization By User.
+
+## [1.6.0] - 2025-09-13
+
+### Fixed
+- Fixed issues in the error generator.
+
+## [1.5.0] - 2025-09-12
+
+### Added
+- Added an explicit `ostruct` dependency.
+
+### Changed
+- Updated Faraday.
+
+## [1.4.0] - 2024-08-02
+
+### Added
+- Added a new error generator.
+
+### Changed
+- Required `ostruct` globally.
+- Refreshed CI and dependency configuration.
+
+## [1.3.0] - 2024-06-28
+
+### Added
+- Added Warn Chat User API support.
+- Added `each`, `first`, and `last` on collections.
+
+## [1.2.6] - 2024-05-27
+
+### Fixed
+- Returned `false` when token validation fails.
+
+### Changed
+- Minor README updates.
+
+## [1.2.5] - 2024-03-17
+
+### Added
+- Added Unban Requests API support.
+- Added Get User Emotes API support.
+
+## [1.2.4] - 2024-01-31
+
+### Fixed
+- Fixed users/games lookups so `ids`, `usernames`, and `names` return collections consistently.
+
+## [1.2.3] - 2024-01-27
+
+### Added
+- Added send chat messages support.
+
+## [1.2.2] - 2024-01-09
+
+### Added
+- Added `moderators.channels`.
+
+## [1.2.1] - 2024-01-02
+
+### Fixed
+- Fixed custom reward redemption updates.
+- Corrected documentation headings and repository metadata.
+
+### Changed
+- Added Ruby 3.3 to CI coverage.
+
+## [1.2.0] - 2023-10-29
+
+### Changed
+- Renamed Users `get_by_id` to `retrieve`.
+- Renamed Users `get_by_username` to `retrieve`.
+- Expanded Users `retrieve` to accept `id`, `ids`, `name`, and `names`.
+- Renamed Channels `get` to `retrieve`.
+
+### Added
+- Added Videos `retrieve`.
+- Added Games `retrieve` with support for `id`, `ids`, `name`, and `names`.
+
+## [1.1.0] - 2023-02-21
+
+### Added
+- Added support for Get Followed Channels.
+- Added support for Get Channel Followers.
+
+### Deprecated
+- Deprecated `user.follows`.
+- Deprecated `user.following?` ahead of the Twitch API removal on August 3, 2023.
+
+## [1.0.4] - 2023-01-22
+
+### Changed
+- Set the default User-Agent.
+
+## [1.0.3] - 2023-01-22
+
+### Added
+- Added support for Shoutouts.
+
+## [1.0.2] - 2022-10-02
+
+### Added
+- Added Chatters support.
+
+### Fixed
+- Fixed Charity Campaigns handling.
+
+## [1.0.1] - 2022-08-26
+
+### Added
+- Added support for the Charity Campaigns API.
+
+## [1.0.0] - 2022-07-18
+
+### Changed
+- Removed Client Secret as a required client value; only Client ID and Access Token are required.
+
+### Added
+- Added chat announcements.
+- Added raids.
+- Added chat message deletion.
+- Added user chat colours.
+- Added moderator management.
+- Added VIP management.
+- Added send whisper support.
+- Added AutoMod status.
+- Added AutoMod settings get/update support.
+- Added ban/unban user support.
+- Added blocked terms management.
+
+## [0.2.6] - 2022-04-26
+
+### Changed
+- Removed thumbnail handling that was no longer needed.
+
+## [0.2.5] - 2022-04-10
+
+### Added
+- Added channel follow count support.
+- Added subscriber counts to channels.
+- Expanded test coverage.
+
+### Changed
+- Upgraded to Faraday 2.
+- Improved project documentation.
+
+## [0.2.4] - 2021-12-31
+
+### Fixed
+- Fixed handling for resources without a thumbnail URL.
+
+## [0.2.3] - 2021-12-31
+
+### Added
+- Added `require "twitchrb"` so `require "twitch"` is no longer necessary.
+- Added generated large thumbnail and animated image URLs.
+
+### Changed
+- Improved channel return behavior.
+- Added client secret support in the client flow.
+
+## [0.2.2] - 2021-12-12
+
+### Added
+- Added `retrieve` to clips.
+
+## [0.2.1] - 2021-10-02
+
+### Changed
+- Removed the older subscriber counting approach in favor of Twitch's newer totals/points behavior.
+- Removed Travis CI configuration.
+
+## [0.2.0] - 2021-09-26
+
+### Added
+- Expanded the gem to focus on the Twitch Helix API.
+- Added badges, emotes, channels, channel editors, games, follows, blocks, videos, clips, EventSub subscriptions, banned events, banned users, moderators, moderator events, polls, predictions, stream schedule segments, search, streams, stream markers, subscriptions, tags, custom rewards, redemptions, goals, and hype train event support.
+- Added model-based resource objects and improved error reporting.
+
+### Changed
+- Replaced HTTParty with Faraday.
+- Simplified collection handling by always reading from `data`.
+
+## [0.1.1] - 2021-06-20
+
+### Added
+- Early tagged release of the Helix client.

data/Gemfile

@@ -6,6 +6,8 @@ gemspec
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "dotenv"
-gem "vcr"
+gem "webmock"
 gem "rubocop-rails-omakase", require: false
 gem "activesupport", ">= 4.2.0", "< 8.0"
+gem "irb"
+gem "cgi"

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    twitchrb (1.9.1)
-      faraday (~> 2.11)
+    twitchrb (1.10.0)
+      faraday (>= 2.14.3, < 3)
       ostruct (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.2.2)
+    activesupport (7.2.3.1)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -17,62 +17,91 @@ GEM
       drb
       i18n (>= 1.6, < 2)
       logger (>= 1.4.2)
-      minitest (>= 5.1)
+      minitest (>= 5.1, < 6)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     base64 (0.3.0)
-    benchmark (0.4.1)
-    bigdecimal (3.3.1)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.4)
-    dotenv (3.1.8)
+    benchmark (0.5.0)
+    bigdecimal (4.1.2)
+    cgi (0.5.1)
+    concurrent-ruby (1.3.8)
+    connection_pool (3.0.2)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    date (3.5.1)
+    dotenv (3.2.0)
     drb (2.2.3)
-    faraday (2.14.0)
+    erb (6.0.4)
+    faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.4.1)
-      net-http (>= 0.5.0)
-    i18n (1.14.7)
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    hashdiff (1.2.1)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    json (2.15.1)
+    io-console (0.8.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.21.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    minitest (5.26.0)
-    net-http (0.6.0)
-      uri
+    minitest (5.27.0)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
     ostruct (0.6.3)
-    parallel (1.27.0)
-    parser (3.3.9.0)
+    parallel (2.1.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
-    prism (1.6.0)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    psych (5.3.1)
+      date
+      stringio
+    public_suffix (7.0.5)
     racc (1.8.1)
-    rack (3.2.3)
+    rack (3.2.6)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.11.3)
-    rubocop (1.81.1)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rubocop (1.86.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.47.1, < 2.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.47.1)
+    rubocop-ast (1.49.1)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
+      prism (~> 1.7)
     rubocop-performance (1.26.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
-    rubocop-rails (2.33.4)
+    rubocop-rails (2.35.0)
       activesupport (>= 4.2.0)
       lint_roller (~> 1.1)
       rack (>= 1.1)
@@ -84,26 +113,32 @@ GEM
       rubocop-rails (>= 2.30)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
+    stringio (3.2.0)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
-    unicode-emoji (4.1.0)
-    uri (1.0.4)
-    vcr (6.3.1)
-      base64
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    webmock (3.26.2)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activesupport (>= 4.2.0, < 8.0)
+  cgi
   dotenv
+  irb
   minitest (~> 5.0)
   rake (~> 12.0)
   rubocop-rails-omakase
   twitchrb!
-  vcr
+  webmock
 
 BUNDLED WITH
-   2.5.17
+  4.0.11