twitchrb 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a745f6e1fdd82794a6bc9b3aeb7e4f374efa7e50b8751f357fd23aa48ef7912
-  data.tar.gz: 7f08650f12bfb36269f359653ecfa23011f8d595ab6c84a2d284f87157ea5b17
+  metadata.gz: e7327c8f6f44058116d61066e6d7eee668c60850de7772b56c041d6fb03d2272
+  data.tar.gz: abac199ef5acc9ab8717f1438d9d883c5c24c7858194b88c2692a2ed625b61e0
 SHA512:
-  metadata.gz: 566698cf2d321eadd523abf2777ff808fbce5f6d896b0a7e7db65af24f5643b38bc21be87a846f507b51d551f4f34f0ddfe2b85ab3d608585ac5914c7b4cecdf
-  data.tar.gz: d7ee4125e0cfb8f523a9b4bf3ada19f477fdd8d5865ac8801246864eb99ad5118481814ac8f5d44d1f8922bb578848d8033228156c91f2d83ce768e1171d7d37
+  metadata.gz: 83fb8d523ae645817738457fd9377c56d9f6d022dec7e64df8c454177485649964715bb924b12525022a99ca9ca3552d34b5e6becfb1b1c3c0811a7818eefe0f
+  data.tar.gz: 82752078c2845fb4eeabbd5cff02d393ae693997d25ef454455fbe2371e5259c962b93d9779b4dddd70b3e0d4225d9a0b63a93156e75ac1dadbedb8958b78a94

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: monthly

data/.github/workflows/ci.yml

@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3'
+          ruby-version: '3.4'
           bundler-cache: true
       - name: Lint code for consistent style
         run: bundle exec rubocop -f github
@@ -27,11 +27,11 @@ jobs:
       fail-fast: false
       matrix:
         ruby_version:
-          - '3.1'
           - '3.2'
           - '3.3'
+          - '3.4'
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}

data/.rubocop.yml

@@ -6,3 +6,6 @@ inherit_gem: { rubocop-rails-omakase: rubocop.yml }
 # # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
 # Layout/SpaceInsideArrayLiteralBrackets:
 #   Enabled: false
+
+Rails/RefuteMethods:
+  Enabled: false

data/Gemfile

@@ -8,3 +8,4 @@ gem "minitest", "~> 5.0"
 gem "dotenv"
 gem "vcr"
 gem "rubocop-rails-omakase", require: false
+gem "activesupport", ">= 4.2.0", "< 8.0"

data/Gemfile.lock

@@ -1,95 +1,103 @@
 PATH
   remote: .
   specs:
-    twitchrb (1.4.0)
-      faraday (~> 2.0)
+    twitchrb (1.6.0)
+      faraday (~> 2.11)
+      ostruct (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.4)
+    activesupport (7.2.2.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    concurrent-ruby (1.3.3)
-    connection_pool (2.4.1)
-    dotenv (3.1.2)
-    drb (2.2.1)
-    faraday (2.10.1)
-      faraday-net_http (>= 2.0, < 3.2)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    dotenv (3.1.8)
+    drb (2.2.3)
+    faraday (2.13.4)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
       logger
-    faraday-net_http (3.1.1)
-      net-http
-    i18n (1.14.5)
+    faraday-net_http (3.4.1)
+      net-http (>= 0.5.0)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    logger (1.6.0)
-    minitest (5.24.1)
-    mutex_m (0.2.0)
-    net-http (0.4.1)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    net-http (0.6.0)
       uri
-    parallel (1.25.1)
-    parser (3.3.4.0)
+    ostruct (0.6.3)
+    parallel (1.27.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
+    prism (1.5.0)
     racc (1.8.1)
-    rack (3.1.7)
+    rack (3.2.1)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.9.2)
-    rexml (3.3.4)
-      strscan
-    rubocop (1.65.1)
+    regexp_parser (2.11.2)
+    rubocop (1.80.2)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    rubocop-minitest (0.35.1)
-      rubocop (>= 1.61, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-performance (1.21.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.25.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.26.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rails (2.33.3)
       activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails-omakase (1.0.0)
-      rubocop
-      rubocop-minitest
-      rubocop-performance
-      rubocop-rails
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rails-omakase (1.1.0)
+      rubocop (>= 1.72)
+      rubocop-performance (>= 1.24)
+      rubocop-rails (>= 2.30)
     ruby-progressbar (1.13.0)
-    strscan (3.1.0)
+    securerandom (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-    uri (0.13.0)
-    vcr (6.2.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.0.3)
+    vcr (6.3.1)
+      base64
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (>= 4.2.0, < 8.0)
   dotenv
   minitest (~> 5.0)
   rake (~> 12.0)

data/README.md

@@ -1,5 +1,9 @@
 # TwitchRB
 
+[![CI](https://github.com/deanpcmad/twitchrb/actions/workflows/ci.yml/badge.svg)](https://github.com/deanpcmad/twitchrb/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/twitchrb.svg)](https://badge.fury.io/rb/twitchrb)
+[![Downloads](https://img.shields.io/gem/dt/twitchrb.svg)](https://rubygems.org/gems/twitchrb)
+
 TwitchRB is the easiest and most complete Ruby library for the [Twitch Helix API](https://dev.twitch.tv/docs/api).
 
 ## Installation
@@ -275,6 +279,44 @@ These require an application OAuth access token.
 @client.eventsub_subscriptions.delete(id: "abc12-abc12-abc12")
 ```
 
+### EventSub Conduits
+
+Conduits provide a way to receive events over multiple transports. These require an application OAuth access token.
+
+```ruby
+# List all conduits for your application
+@client.eventsub_conduits.list
+
+# Create a conduit with a specified number of shards
+# shard_count must be between 1 and 100
+@client.eventsub_conduits.create(shard_count: 10)
+
+# Update a conduit's shard count
+@client.eventsub_conduits.update(id: "abc123-def456", shard_count: 20)
+
+# Delete a conduit
+@client.eventsub_conduits.delete(id: "abc123-def456")
+
+# List shards for a conduit
+# Optional parameters: status, after
+@client.eventsub_conduits.shards(id: "abc123-def456")
+@client.eventsub_conduits.shards(id: "abc123-def456", status: "enabled")
+
+# Update shards for a conduit
+# shards is an array of shard objects with id and transport properties
+shards = [
+  {
+    id: "0",
+    transport: {
+      method: "webhook",
+      callback: "https://example.com/webhooks/callback",
+      secret: "your-secret"
+    }
+  }
+]
+@client.eventsub_conduits.update_shards(id: "abc123-def456", shards: shards)
+```
+
 ### Banned Events
 
 ```ruby
@@ -564,6 +606,180 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.warnings.create broadcaster_id: 123, moderator_id: 123, user_id: 321, reason: "dont do that"
 ```
 
+### Streams
+
+```ruby
+# List live streams
+# Available parameters: user_id, user_login, game_id, type, language, first, before, after
+@client.streams.list
+@client.streams.list(game_id: "509658")
+@client.streams.list(user_login: "twitchdev")
+
+# Get followed streams for a user
+# Required scope: user:read:follows
+# user_id must match the currently authenticated user
+@client.streams.followed(user_id: 123)
+```
+
+### Polls
+
+```ruby
+# List polls for a broadcaster
+# broadcaster_id must match the currently authenticated user
+@client.polls.list(broadcaster_id: 123)
+
+# Create a poll
+# broadcaster_id must match the currently authenticated user
+# duration is in seconds (15-1800)
+choices = [
+  { title: "Choice 1" },
+  { title: "Choice 2" }
+]
+@client.polls.create(broadcaster_id: 123, title: "What should I play?", choices: choices, duration: 300)
+
+# End a poll
+# broadcaster_id must match the currently authenticated user
+# status can be "TERMINATED" or "ARCHIVED"
+@client.polls.end(broadcaster_id: 123, id: "poll-id", status: "terminated")
+```
+
+### Predictions
+
+```ruby
+# List predictions for a broadcaster
+# broadcaster_id must match the currently authenticated user
+@client.predictions.list(broadcaster_id: 123)
+
+# Create a prediction
+# broadcaster_id must match the currently authenticated user
+# duration is in seconds (30-1800)
+outcomes = [
+  { title: "Outcome 1" },
+  { title: "Outcome 2" }
+]
+@client.predictions.create(broadcaster_id: 123, title: "Will I win?", outcomes: outcomes, duration: 600)
+
+# End a prediction
+# broadcaster_id must match the currently authenticated user
+# status can be "RESOLVED", "CANCELED", or "LOCKED"
+# winning_outcome_id is required when status is "RESOLVED"
+@client.predictions.end(broadcaster_id: 123, id: "prediction-id", status: "resolved", winning_outcome_id: "outcome-id")
+```
+
+### Subscriptions
+
+```ruby
+# Get all subscriptions for a broadcaster
+# Required scope: channel:read:subscriptions
+# broadcaster_id must match the currently authenticated user
+@client.subscriptions.list(broadcaster_id: 123)
+
+# Check if a user is subscribed to a broadcaster
+# Required scope: user:read:subscriptions
+# user_id must match the currently authenticated user
+@client.subscriptions.is_subscribed(broadcaster_id: 123, user_id: 456)
+
+# Get subscription counts and points for a broadcaster
+# Required scope: channel:read:subscriptions
+# broadcaster_id must match the currently authenticated user
+@client.subscriptions.counts(broadcaster_id: 123)
+```
+
+### Search
+
+```ruby
+# Search for categories/games
+@client.search.categories(query: "Just Chatting")
+
+# Search for channels
+@client.search.channels(query: "twitchdev")
+```
+
+### Stream Schedule
+
+```ruby
+# Get stream schedule for a broadcaster
+# broadcaster_id must match the currently authenticated user
+@client.stream_schedule.list(broadcaster_id: 123)
+
+# Get iCalendar format of stream schedule
+# broadcaster_id must match the currently authenticated user
+@client.stream_schedule.icalendar(broadcaster_id: 123)
+
+# Update stream schedule settings
+# broadcaster_id must match the currently authenticated user
+@client.stream_schedule.update(broadcaster_id: 123, is_vacation_enabled: true)
+
+# Create a schedule segment
+# broadcaster_id must match the currently authenticated user
+@client.stream_schedule.create_segment(
+  broadcaster_id: 123,
+  start_time: "2023-08-01T16:00:00Z",
+  timezone: "America/New_York",
+  duration: "240",
+  is_recurring: false,
+  category_id: "509658",
+  title: "Special Stream"
+)
+
+# Update a schedule segment
+# broadcaster_id must match the currently authenticated user
+@client.stream_schedule.update_segment(broadcaster_id: 123, id: "segment-id", title: "Updated Title")
+
+# Delete a schedule segment
+# broadcaster_id must match the currently authenticated user
+@client.stream_schedule.delete_segment(broadcaster_id: 123, id: "segment-id")
+```
+
+### Stream Markers
+
+```ruby
+# Create a stream marker
+# Required scope: channel:manage:broadcast
+# user_id must match the currently authenticated user
+@client.stream_markers.create(user_id: 123, description: "Important moment")
+
+# Get stream markers for a user or video
+# Required scope: user:read:broadcast
+# user_id must match the currently authenticated user
+@client.stream_markers.list(user_id: 123)
+@client.stream_markers.list(video_id: "video-id")
+```
+
+### Tags
+
+```ruby
+# Get all stream tags
+@client.tags.list
+
+# Get stream tags for a specific broadcaster
+@client.tags.stream(broadcaster_id: 123)
+
+# Replace stream tags for a broadcaster
+# Required scope: channel:manage:broadcast
+# broadcaster_id must match the currently authenticated user
+tag_ids = ["tag-id-1", "tag-id-2"]
+@client.tags.replace(broadcaster_id: 123, tag_ids: tag_ids)
+```
+
+### Hype Train Events
+
+```ruby
+# Get hype train events for a broadcaster
+# Required scope: channel:read:hype_train
+# broadcaster_id must match the currently authenticated user
+@client.hype_train_events.list(broadcaster_id: 123)
+```
+
+### Moderator Events
+
+```ruby
+# Get moderator events for a broadcaster
+# Required scope: moderation:read
+# broadcaster_id must match the currently authenticated user
+@client.moderator_events.list(broadcaster_id: 123)
+```
+
 
 ## Contributing
 

data/lib/twitch/error_generator.rb

@@ -14,12 +14,27 @@ module Twitch
     private
 
     def set_twitch_error_values
-      @twitch_error_code = @response_body.dig("error")
-      @twitch_error_message = @response_body.dig("message")
+      parsed_body = parse_response_body
+      @twitch_error_code = parsed_body.dig("error")
+      @twitch_error_message = parsed_body.dig("message")
+    end
+
+    def parse_response_body
+      case @response_body
+      when Hash
+        @response_body
+      when String
+        JSON.parse(@response_body)
+      else
+        {}
+      end
+    rescue JSON::ParserError
+      {}
     end
 
     def error_message
-      @twitch_error_message || @response_body.dig("error")
+      parsed_body = parse_response_body
+      @twitch_error_message || parsed_body.dig("error")
     rescue NoMethodError
       "An unknown error occurred."
     end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "1.4.0"
+  VERSION = "1.6.0"
 end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4"

data/twitchrb.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = [ "lib" ]
 
-  spec.add_dependency "faraday", "~> 2.0"
+  spec.add_dependency "faraday", "~> 2.11"
+  spec.add_dependency "ostruct", "~> 0.6.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,15 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-description:
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 email:
 - dean@deanpcmad.com
 executables: []
@@ -33,6 +45,7 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".github/FUNDING.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -107,7 +120,6 @@ files:
 - lib/twitch/resources/custom_reward_redemptions.rb
 - lib/twitch/resources/custom_rewards.rb
 - lib/twitch/resources/emotes.rb
-- lib/twitch/resources/event_sub_conduit.rb
 - lib/twitch/resources/eventsub_conduits.rb
 - lib/twitch/resources/eventsub_subscriptions.rb
 - lib/twitch/resources/games.rb
@@ -133,6 +145,7 @@ files:
 - lib/twitch/resources/whispers.rb
 - lib/twitch/version.rb
 - lib/twitchrb.rb
+- mise.toml
 - twitchrb.gemspec
 homepage: https://deanpcmad.com
 licenses:
@@ -140,7 +153,6 @@ licenses:
 metadata:
   homepage_uri: https://deanpcmad.com
   source_code_uri: https://github.com/deanpcmad/twitchrb
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API
 test_files: []

data/lib/twitch/resources/event_sub_conduit.rb

@@ -1,19 +0,0 @@
-module Twitch
-  class EventSubSubscriptionsResource < Resource
-    def list(**params)
-      response = get_request("eventsub/subscriptions", params: params)
-      Collection.from_response(response, type: EventSubSubscription)
-    end
-
-    def create(type:, version:, condition:, transport:, **params)
-      attributes = { type: type, version: version, condition: condition, transport: transport }.merge(params)
-      response = post_request("eventsub/subscriptions", body: attributes)
-
-      EventSubSubscription.new(response.body.dig("data")[0]) if response.success?
-    end
-
-    def delete(id:)
-      delete_request("eventsub/subscriptions", params: { id: id })
-    end
-  end
-end