twitchrb 1.11.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a4de14d63208a337630d3530f24d90679645c2b4ad02d4f31beb96f687a6ff1
-  data.tar.gz: 2e49411b20156a55d93fa60e1dba87bf25121c228f601e10f6861e01aa9b0094
+  metadata.gz: 8228b593acef6a0efdcdd04dbacf8ce080f810703398f75d641fb0e3a2df560d
+  data.tar.gz: 96d303d92f782fd156b30f4a0d4d8219e90511d90d78d16ff1ef289f2d731328
 SHA512:
-  metadata.gz: 81bcbe6402c4cdf5f3cc90ac181aec22d8d46990053846f1bce3b92aead9f71462857c6b92e1b5dcbd4c34d1e635e057ce86516c856db1944252d01dc1e90b56
-  data.tar.gz: cfff782da54f1ffde515c8911febf8d251c1df677d0ba481399cfc86d2bd95c9885e0d5f6682aadbb96be98dc4cecf0ceda8aa72b073abdda842b4dc8e7ce120
+  metadata.gz: 44755a65de44e98a714c4a762b544059ca70a942c723e741f7570a1a23de6488005e3e22700a5df2262514ac03bd748da225968951481096ebd93f24bc246c1a
+  data.tar.gz: 6057bade63a8527544adf8f201c1f71eb794e96d0b50fc29c2755fb54454809d4c4265574b4f7c6985a0f28cd33206b867f0352c47f885d83b0c906cb0d7028b

data/CHANGELOG.md

@@ -4,6 +4,103 @@ 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.
 
+## [2.1.0] - 2026-09-27
+
+Completes the 2.0 cleanup: response objects no longer depend on OpenStruct.
+
+### Changed
+
+- Response objects no longer use `OpenStruct`, and the `ostruct` dependency has been removed. `Twitch::Object` now
+  stores attributes in a hash and reads them through dot notation or hash access (`object[:id]`). Building objects is
+  much faster and uses less memory. Missing attributes still return `nil`.
+- Nested objects are now `Twitch::Object`s rather than `OpenStruct`s, and so are the responses from `Twitch::OAuth`.
+  Code that checks for `OpenStruct` or calls `OpenStruct`-only methods needs updating.
+- The packaged gem now only contains `lib/`, the README, LICENSE and CHANGELOG, instead of every file in the repo.
+
+### Added
+
+- `key?` on response objects, to check whether an attribute is present.
+
+## [2.0.0] - 2026-09-23
+
+This release adds every remaining Helix endpoint, automatic pagination, automatic token refresh, and EventSub
+webhook verification, and fixes many requests that didn't match the Twitch API reference. It contains breaking
+changes, listed below.
+
+### Upgrading from 1.x
+
+- **Ruby 3.3 or newer is required.**
+- **Methods for endpoints Twitch has shut down were removed:**
+  - `hype_train_events.list` → use `hype_train_status.retrieve(broadcaster_id:)`.
+  - `users.follows` and `users.following?` → use `channels.followers(broadcaster_id:, user_id:)` to check whether a
+    user follows a channel, or `channels.followed(user_id:)` to list the channels a user follows.
+  - `tags.list`, `tags.stream`, and `tags.replace` → channel tags are returned by `channels.retrieve` and set with
+    `channels.update(broadcaster_id:, tags: [...])`.
+  - `banned_events.list` and `moderator_events.list` → no API replacement; use the `channel.ban`, `channel.unban`,
+    and `channel.moderate` EventSub subscriptions.
+- **`oauth.create`, `oauth.refresh`, and `oauth.device` raise errors instead of returning `false`.** Replace checks
+  like `if token = oauth.refresh(...)` with a `rescue`:
+
+  ```ruby
+  begin
+    token = oauth.refresh(refresh_token: refresh_token)
+  rescue Twitch::Error => e
+    e.twitch_error_message #=> "Invalid refresh token"
+  end
+  ```
+
+  `oauth.validate` and `oauth.revoke` still return `false`.
+- **Missing required arguments raise `ArgumentError`** instead of `RuntimeError`. Update any `rescue RuntimeError`.
+- **`to_h` on response objects now converts nested objects to hashes too.** If you called methods on nested values
+  from `to_h` (e.g. `object.to_h[:current].id`), use hash access instead (`object.to_h[:current][:id]`), or call the
+  method on the object itself (`object.current.id`).
+
+### Changed
+- Missing required arguments (e.g. calling `clips.list` without `broadcaster_id`, `game_id` or `id`) now raise `ArgumentError` instead of `RuntimeError`.
+- **Breaking:** `oauth.create`, `oauth.refresh`, and `oauth.device` now raise errors (e.g. `Twitch::Errors::BadRequestError`, with Twitch's message in `twitch_error_message`) instead of returning `false`. `oauth.validate` and `oauth.revoke` still return `false`.
+- The minimum supported Ruby version is now 3.3 (previously declared as 2.3, though the gem already required 3.1+). This matches the versions tested in CI.
+
+### Added
+- `subscriptions.subscribed?(broadcaster_id:, user_id:)`, which returns `true` or `false` instead of raising when the user isn't subscribed.
+- Automatic token refresh: pass `refresh_token:` (and `client_secret:`, unless your app is a public client) to `Twitch::Client.new`, and requests that fail because the access token expired are retried once with a refreshed token. `on_token_refresh:` is called with the new token so you can store it, and `client.refresh_access_token!` refreshes manually.
+- Automatic pagination: collections from paginated endpoints now have `next_page?`, `next_page`, `each_page`, and `auto_paginate`, which lazily iterates over every item across pages (e.g. `auto_paginate.first(250)` only fetches the pages it needs).
+- `Twitch::EventsubWebhook` to verify and parse EventSub webhook requests. It checks the HMAC signature in constant time, rejects messages older than 10 minutes, and gives access to the message type, challenge, subscription, and event.
+- `oauth.exchange_code(code:, redirect_uri:)` for the authorization code grant flow, and `oauth.device_token(device_code:, scopes:)` to finish the device code grant flow. Previously neither flow could be completed.
+- `oauth.create` sends extra keyword arguments (such as `code` and `redirect_uri`) with the request, and `scope`/`scopes` accept arrays.
+- `Twitch::OAuth.new` no longer requires a `client_secret`, for public clients using the device code flow.
+- `ads.schedule` and `ads.snooze` (Get Ad Schedule, Snooze Next Ad).
+- `analytics.extensions` and `analytics.games`.
+- `bits.leaderboard` and `bits.cheermotes`.
+- `charity_campaigns.donations`.
+- `chat_settings.retrieve` and `chat_settings.update`.
+- `shield_mode.retrieve` and `shield_mode.update`.
+- `content_classification_labels.list`.
+- `teams.retrieve` and `teams.channel`.
+- `drops_entitlements.list` and `drops_entitlements.update`.
+- `users.extensions`, `users.active_extensions`, and `users.update_extensions`.
+- An `extensions` resource covering the Extensions API: `retrieve`, `released`, `live_channels`, `configuration`, `set_configuration`, `set_required_configuration`, `send_pubsub_message`, `send_chat_message`, `secrets`, `create_secret`, `bits_products`, `update_bits_product`, and `transactions`.
+- A `guest_star` resource covering the Guest Star beta API.
+
+### Removed
+- Removed methods for endpoints Twitch has shut down, which could only return errors:
+  - `hype_train_events.list`, which forwarded to `hype_train_status.retrieve` with a deprecation warning since 1.10.0.
+  - `banned_events.list` and `moderator_events.list` (Get Banned Events / Get Moderator Events).
+  - `users.follows` and `users.following?` (`GET /users/follows`). Use `channels.followers` or `channels.followed` instead.
+  - `tags.list`, `tags.stream`, and `tags.replace` (the old Twitch-defined stream tags). Channel tags are now read with `channels.retrieve` and set with `channels.update(tags: [...])`.
+- Removed the now-unused `Twitch::BannedEvent`, `Twitch::ModeratorEvent`, `Twitch::FollowedUser`, `Twitch::HypeTrainEvent`, and `Twitch::Tag` classes.
+
+### Fixed
+- Fixed multi-value query params (e.g. `users.retrieve(ids:)`, `games.retrieve(names:)`, `streams.list(user_id: [...])`, `clips.downloads(clip_ids:)`) being sent as `id[]=1&id[]=2`. They are now sent as repeated keys (`id=1&id=2`), which is the format Helix expects.
+- Fixed write endpoints sending query string parameters in the JSON body instead of the query string, contrary to the Twitch API reference. Affects `channels.update`, `custom_rewards.create`/`update`, `automod.check_status`/`check_status_multiple`/`update_settings`, `banned_users.create`, `blocked_terms.create`, `unban_requests.resolve`, `moderators.create`, `vips.create`, `raids.create`, `whispers.create`, `stream_schedule.update`/`create_segment`/`update_segment`, `users.update`, and `users.block_user` (whose `source_context` and `reason` options were being sent in the body).
+- Fixed `clips.list` and `videos.list` rejecting calls that only pass `id`, which both endpoints accept.
+- Fixed `eventsub_conduits.update_shards` discarding the `errors` Twitch returns for shards that failed to update. They are now available as `result.errors`, and `Collection#errors` is available for any endpoint that reports partial failures.
+- `eventsub_conduits.update_shards` now sends lists of more than 100 shards in batches of 100, the most Twitch accepts per request.
+- Fixed `oauth.device` sending `scope` instead of `scopes`, which Twitch requires.
+- Fixed `to_h` and `to_json` on response objects leaving nested objects as `OpenStruct`s, which serialized as strings like `"#<OpenStruct ...>"`. Nested objects and arrays are now converted to plain hashes, and `as_json` is defined for Rails.
+- `Collection#cursor` now works for endpoints that return `pagination` as a bare string (such as Get Extension Live Channels) instead of raising.
+- `banned_users.create` no longer sends `"duration": null` for permanent bans.
+- Helix and OAuth requests now have default timeouts (30s read, 10s open) instead of waiting indefinitely. Configure with the `timeout:` and `open_timeout:` options on `Twitch::Client.new` and `Twitch::OAuth.new`.
+
 ## [1.11.0] - 2026-08-11
 
 ### Fixed

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Dean Perry
+Copyright (c) 2020-2026 Dean Perry
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal