twitchrb 1.2.3 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efe6dbb90fcec7a7f5ce13ca4b812349bfa16ff95140b30ba344b2b352d5176c
-  data.tar.gz: 7e954ca5c0f4462e35d9950af57d43da72871ac708398dc97561912a8ae535c9
+  metadata.gz: 5b1b5b00194116bc482bebd6b536a95906bd7f0bda470ab0518fbf6c0818b0ff
+  data.tar.gz: 584c1cf4d98be59ea654d2bed1e142d6fc6a9c7de476c3fe0cd260818aa5be6a
 SHA512:
-  metadata.gz: 9438a27de32ba91ea58e3a95ab705e0138d5274ba61274c1c190d1b88d1e2003d3171fcfdbaecdb230434b05db384ec200e8b49c90f7ced6096d2c2ef4967c49
-  data.tar.gz: 20c286d14a3dfa432deec04f62864bf70282e124d346b2594f769021db3bca4c768319614a7689b9756b33bd224507f8f503fd7e7e5e302a9f7ef37dc1b1f24c
+  metadata.gz: 6a4065eac3b0e609537672668ecf33d48ca9d045ccb7cfceaad614a52637e7bad133234a55a1fe5011063751297ca500e74bb97c827c48023ba62bf573fbc568
+  data.tar.gz: 43f822492d36433f9cd3854c8cbf63bd7aa6607bd27a75363ff4dc73b7a041e26302d485422cd9aa543dc7cf46af38ca9c4fe9de1995d9998ed68e8b02a861bf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twitchrb (1.2.3)
+    twitchrb (1.2.5)
       faraday (~> 2.0)
 
 GEM

data/README.md

@@ -22,6 +22,34 @@ An access token is required because the Helix API requires authentication.
 @client = Twitch::Client.new(client_id: "", access_token: "")
 ```
 
+### OAuth
+
+This library includes the ability to create, refresh and revoke OAuth tokens.
+
+```ruby
+# Firstly, set the client details
+@oauth = Twitch::OAuth.new(client_id: "", client_secret: "")
+
+# Create a Token
+# grant_type can be either "authorization_code" or "client_credentials"
+# scope is a space-delimited list of scopes. This is optional depending on the grant_type
+@oauth.create(grant_type: "", scope: "")
+
+# Refresh a Token
+@oauth.refresh(refresh_token: "")
+
+# Device Code Grant Flow
+# scopes is required and is a space-delimited list of scopes
+# https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/#device-code-grant-flow
+@oauth.device(scopes: "bits:read channel:read:subscriptions")
+
+# Validate an Access Token
+@oauth.validate(access_token: "")
+
+# Revoke a Token
+@oauth.revoke(token: "")
+```
+
 ### Users
 
 ```ruby
@@ -68,6 +96,12 @@ An access token is required because the Helix API requires authentication.
 # Current allowed colours: blue, blue_violet, cadet_blue, chocolate, coral, dodger_blue, firebrick, golden_rod, green, hot_pink, orange_red, red, sea_green, spring_green, yellow_green
 # For Turbo and Prime users, a hex colour code is allowed.
 @client.users.update_color(user_id: 123, color: "blue")
+
+# Get Emotes a User has
+# Required scope: user:read:emotes
+@client.users.emotes(user_id: 123)
+@client.users.emotes(user_id: 123, broadcaster_id: 321)
+@client.users.emotes(user_id: 123, after: "abc123")
 ```
 
 ### Channels
@@ -464,6 +498,20 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.custom_reward_redemptions.update broadcaster_id: 123, reward_id: 321, redemption_id: 123, status: "FULFILLED"
 ```
 
+### Unban Requests
+
+```ruby
+# Retrieves a list of Unban Requests for a broadcaster
+# Required scope: moderator:read:unban_requests or moderator:manage:unban_requests
+# moderator_id must match the currently authenticated user
+@client.unban_requests.list broadcaster_id: 123, moderator_id: 123, status: "pending"
+
+# Resolve an Unban Request
+# Required scope: moderator:manage:unban_requests
+# moderator_id must match the currently authenticated user
+@client.unban_requests.resolve broadcaster_id: 123, moderator_id: 123, id: "abc123", status: "approved"
+```
+
 
 ## Contributing
 

data/bin/console

@@ -13,7 +13,11 @@ require 'dotenv/load'
 # require "pry"
 # Pry.start
 
+@oauth = Twitch::OAuth.new(client_id: ENV["TWITCH_CLIENT_ID"], client_secret: ENV["TWITCH_CLIENT_SECRET"])
+
 @client = Twitch::Client.new(client_id: ENV["TWITCH_CLIENT_ID"], access_token: ENV["TWITCH_ACCESS_TOKEN"])
 
+@clientapp = Twitch::Client.new(client_id: ENV["TWITCH_CLIENT_ID"], access_token: ENV["TWITCH_APP_ACCESS_TOKEN"])
+
 require "irb"
 IRB.start(__FILE__)

data/lib/twitch/client.rb

@@ -42,7 +42,11 @@ module Twitch
     end
 
     def eventsub_subscriptions
-      EventSubSubscriptionsResource.new(self)
+      EventsubSubscriptionsResource.new(self)
+    end
+
+    def eventsub_conduits
+      EventsubConduitsResource.new(self)
     end
 
     def banned_events
@@ -149,12 +153,14 @@ module Twitch
       ShoutoutsResource.new(self)
     end
 
+    def unban_requests
+      UnbanRequestsResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :Bearer, access_token
 
-        conn.options.params_encoder = Faraday::FlatParamsEncoder
-
         conn.headers = {
           "User-Agent" => "twitchrb/v#{VERSION} (github.com/deanpcmad/twitchrb)",
           "Client-ID": client_id

data/lib/twitch/oauth.rb

@@ -0,0 +1,61 @@
+module Twitch
+  class OAuth
+
+    attr_reader :client_id, :client_secret
+
+    def initialize(client_id:, client_secret:)
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    def create(grant_type:, scope: nil)
+      send_request(url: "https://id.twitch.tv/oauth2/token", body: {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: grant_type,
+        scope: scope
+      })
+    end
+
+    def refresh(refresh_token:)
+      send_request(url: "https://id.twitch.tv/oauth2/token", body: {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: "refresh_token",
+        refresh_token: refresh_token
+      })
+    end
+
+    def device(scopes:)
+      send_request(url: "https://id.twitch.tv/oauth2/device", body: {client_id: client_id, scope: scopes})
+    end
+
+    def validate(token:)
+      response = Faraday.get("https://id.twitch.tv/oauth2/validate", nil, {"Authorization" => "OAuth #{token}"})
+
+      JSON.parse(response.body, object_class: OpenStruct)
+    end
+
+    def revoke(token:)
+      response = Faraday.post("https://id.twitch.tv/oauth2/revoke", {
+        client_id: client_id,
+        token: token
+      })
+
+      JSON.parse(response.body, object_class: OpenStruct) if response.status != 200
+
+      return true
+    end
+
+    private
+
+    def send_request(url:, body:)
+      response = Faraday.post(url, body)
+
+      return false if response.status != 200
+
+      JSON.parse(response.body, object_class: OpenStruct)
+    end
+
+  end
+end

data/lib/twitch/objects/eventsub_conduit.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class EventsubConduit < Object
+  end
+end

data/lib/twitch/objects/eventsub_conduit_shard.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class EventsubConduitShard < Object
+  end
+end

data/lib/twitch/objects/eventsub_subscription.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class EventsubSubscription < Object
+  end
+end

data/lib/twitch/objects/unban_request.rb

@@ -0,0 +1,4 @@
+module Twitch
+  class UnbanRequest < Object
+  end
+end

data/lib/twitch/resources/{event_sub_subscriptions.rb → event_sub_conduit.rb}

@@ -1,13 +1,13 @@
 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:)
-      attributes = {type: type, version: version, condition: condition, transport: transport}
+    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?

data/lib/twitch/resources/eventsub_conduits.rb

@@ -0,0 +1,36 @@
+module Twitch
+  class EventsubConduitsResource < Resource
+
+    def list(**params)
+      response = get_request("eventsub/conduits", params: params)
+      Collection.from_response(response, type: EventsubConduit)
+    end
+
+    def create(shard_count:)
+      response = post_request("eventsub/conduits", body: {shard_count: shard_count})
+
+      EventsubConduit.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    def update(id:, shard_count:)
+      response = patch_request("eventsub/conduits", body: {id: id, shard_count: shard_count})
+
+      EventsubConduit.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    def delete(id:)
+      delete_request("eventsub/conduits", params: {id: id})
+    end
+
+    def shards(id:, **params)
+      response = get_request("eventsub/conduits/shards", params: {conduit_id: id}.merge(params))
+      Collection.from_response(response, type: EventsubConduitShard)
+    end
+
+    def update_shards(id:, shards:)
+      response = patch_request("eventsub/conduits/shards", body: {conduit_id: id, shards: shards})
+      Collection.from_response(response, type: EventsubConduitShard)
+    end
+
+  end
+end

data/lib/twitch/resources/eventsub_subscriptions.rb

@@ -0,0 +1,21 @@
+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

data/lib/twitch/resources/games.rb

@@ -15,9 +15,9 @@ module Twitch
       end
 
       body = response.body.dig("data")
-      if body.count == 1
+      if id || name && body.count == 1
         Game.new body[0]
-      elsif body.count > 1
+      elsif ids || names && body.count > 1
         Collection.from_response(response, type: Game)
       else
         return nil

data/lib/twitch/resources/unban_requests.rb

@@ -0,0 +1,18 @@
+module Twitch
+  class UnbanRequestsResource < Resource
+
+    def list(broadcaster_id:, moderator_id:, status:, **params)
+      attrs = {broadcaster_id: broadcaster_id, moderator_id: moderator_id, status: status}
+      response = get_request("moderation/unban_requests", params: attrs.merge(params))
+      Collection.from_response(response, type: UnbanRequest)
+    end
+
+    def resolve(broadcaster_id:, moderator_id:, id:, status:, **params)
+      attrs = {broadcaster_id: broadcaster_id, moderator_id: moderator_id, unban_request_id: id, status: status}
+      response = patch_request("moderation/unban_requests", body: attrs.merge(params))
+      UnbanRequest.new(response.body.dig("data")[0])
+
+    end
+
+  end
+end

data/lib/twitch/resources/users.rb

@@ -15,9 +15,9 @@ module Twitch
       end
 
       body = response.body.dig("data")
-      if body.count == 1
+      if id || username && body.count == 1
         User.new body[0]
-      elsif body.count > 1
+      elsif ids || usernames && body.count > 1
         Collection.from_response(response, type: User)
       else
         return nil
@@ -89,5 +89,11 @@ module Twitch
       end
     end
 
+    def emotes(user_id:, **params)
+      attrs = {user_id: user_id}
+      response = get_request("chat/emotes/user", params: attrs.merge(params))
+      Collection.from_response(response, type: Emote)
+    end
+
   end
 end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "1.2.3"
+  VERSION = "1.2.5"
 end

data/lib/twitch.rb

@@ -10,6 +10,8 @@ module Twitch
   autoload :Resource, "twitch/resource"
   autoload :Object, "twitch/object"
 
+  autoload :OAuth, "twitch/oauth"
+
 
   autoload :UsersResource, "twitch/resources/users"
   autoload :ChannelsResource, "twitch/resources/channels"
@@ -18,7 +20,8 @@ module Twitch
   autoload :GamesResource, "twitch/resources/games"
   autoload :VideosResource, "twitch/resources/videos"
   autoload :ClipsResource, "twitch/resources/clips"
-  autoload :EventSubSubscriptionsResource, "twitch/resources/event_sub_subscriptions"
+  autoload :EventsubSubscriptionsResource, "twitch/resources/eventsub_subscriptions"
+  autoload :EventsubConduitsResource, "twitch/resources/eventsub_conduits"
   autoload :BannedEventsResource, "twitch/resources/banned_events"
   autoload :BannedUsersResource, "twitch/resources/banned_users"
   autoload :ModeratorsResource, "twitch/resources/moderators"
@@ -45,6 +48,7 @@ module Twitch
   autoload :CharityCampaignsResource, "twitch/resources/charity_campaigns"
   autoload :ChattersResource, "twitch/resources/chatters"
   autoload :ShoutoutsResource, "twitch/resources/shoutouts"
+  autoload :UnbanRequestsResource, "twitch/resources/unban_requests"
 
 
   autoload :User, "twitch/objects/user"
@@ -58,7 +62,9 @@ module Twitch
   autoload :Game, "twitch/objects/game"
   autoload :Video, "twitch/objects/video"
   autoload :Clip, "twitch/objects/clip"
-  autoload :EventSubSubscription, "twitch/objects/event_sub_subscription"
+  autoload :EventsubSubscription, "twitch/objects/eventsub_subscription"
+  autoload :EventsubConduit, "twitch/objects/eventsub_conduit"
+  autoload :EventsubConduitShard, "twitch/objects/eventsub_conduit_shard"
   autoload :BannedEvent, "twitch/objects/banned_event"
   autoload :BannedUser, "twitch/objects/banned_user"
   autoload :Moderator, "twitch/objects/moderator"
@@ -86,5 +92,6 @@ module Twitch
   autoload :CharityCampaign, "twitch/objects/charity_campaign"
   autoload :Chatter, "twitch/objects/chatter"
   autoload :ChatMessage, "twitch/objects/chat_message"
+  autoload :UnbanRequest, "twitch/objects/unban_request"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.5
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,6 +46,7 @@ files:
 - lib/twitch/client.rb
 - lib/twitch/collection.rb
 - lib/twitch/error.rb
+- lib/twitch/oauth.rb
 - lib/twitch/object.rb
 - lib/twitch/objects/automod_setting.rb
 - lib/twitch/objects/automod_status.rb
@@ -63,7 +64,9 @@ files:
 - lib/twitch/objects/custom_reward.rb
 - lib/twitch/objects/custom_reward_redemption.rb
 - lib/twitch/objects/emote.rb
-- lib/twitch/objects/event_sub_subscription.rb
+- lib/twitch/objects/eventsub_conduit.rb
+- lib/twitch/objects/eventsub_conduit_shard.rb
+- lib/twitch/objects/eventsub_subscription.rb
 - lib/twitch/objects/follow_count.rb
 - lib/twitch/objects/followed_user.rb
 - lib/twitch/objects/game.rb
@@ -81,6 +84,7 @@ files:
 - lib/twitch/objects/subscription.rb
 - lib/twitch/objects/subscription_count.rb
 - lib/twitch/objects/tag.rb
+- lib/twitch/objects/unban_request.rb
 - lib/twitch/objects/user.rb
 - lib/twitch/objects/user_color.rb
 - lib/twitch/objects/video.rb
@@ -100,7 +104,9 @@ files:
 - lib/twitch/resources/custom_reward_redemptions.rb
 - lib/twitch/resources/custom_rewards.rb
 - lib/twitch/resources/emotes.rb
-- lib/twitch/resources/event_sub_subscriptions.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
 - lib/twitch/resources/goals.rb
 - lib/twitch/resources/hype_train_events.rb
@@ -116,6 +122,7 @@ files:
 - lib/twitch/resources/streams.rb
 - lib/twitch/resources/subscriptions.rb
 - lib/twitch/resources/tags.rb
+- lib/twitch/resources/unban_requests.rb
 - lib/twitch/resources/users.rb
 - lib/twitch/resources/videos.rb
 - lib/twitch/resources/vips.rb

data/lib/twitch/objects/event_sub_subscription.rb

@@ -1,4 +0,0 @@
-module Twitch
-  class EventSubSubscription < Object
-  end
-end