twitchrb 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 828f7c0543e796014befead46a15222e41a9c775ea7baa4d4cd346e674777dd8
-  data.tar.gz: 2a9a88da2bf52a0362c24d38201806545d0483a36217f14ed30f120c89664f88
+  metadata.gz: 15c7d6175a906c3469b5d3ac691f66ef8f86d0682959a648b69cb0d35f39523f
+  data.tar.gz: 8a505c88b94833d36805006b7a8ab1e6cb54e76ecb05cb99ffb81cca5c7bd491
 SHA512:
-  metadata.gz: 3a0695cf7d5600a1c171f43ff1fae6ba39c2242ddd5092d7e04c1c234c03a9ca00f9f2c51036a685a6d08356bc5fb5f9cdabb2e150ecd9854962074f69df75a1
-  data.tar.gz: be4161b6cdc5f83c6169fc49733146c1c3fc210b43be9b8823fbd0f8e4b97dc42c1d722b5d8b01bf98623498b367318779f94f790b9cfc2c99cb125697310889
+  metadata.gz: 197a13bac91e7f1ff361bf021cff8f2c15a7d9b6f1812a393908fffd9cf0df34cf71863521c8ca85253dfeeab4ac9c81388ced713a047babfcc449fc1d906672
+  data.tar.gz: 992d0eb6c70cde046b94b42d2c969c3530ebbc9dfc3b14cf288b0d804280fc4af03347361fc311889aa268049bdf1e7fdec2c8121f924492850dd6eb365a994d

data/.github/FUNDING.yml

@@ -1,3 +1,4 @@
 # These are supported funding model platforms
 
+github: deanpcmad
 ko_fi: deanpcmad

data/.github/workflows/ci.yml

@@ -7,12 +7,12 @@ jobs:
       fail-fast: false
       matrix:
         ruby_version:
-          - 2.6
-          - 2.7
-          - 3.0
-          - 3.1
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    twitchrb (1.1.0)
+    twitchrb (1.2.1)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    base64 (0.2.0)
     dotenv (2.7.6)
-    faraday (2.7.4)
+    faraday (2.8.1)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)

data/README.md

@@ -26,23 +26,23 @@ An access token is required because the Helix API requires authentication.
 
 ```ruby
 # Retrieves a user by their ID
-@client.users.get_by_id(user_id: 141981764)
+@client.users.retrieve(id: 141981764)
+
+# Retrieves multiple users by their IDs
+# Requires an array of IDs
+@client.users.retrieve(ids: [141981764, 72938118])
 
 # Retrieves a user by their username
-@client.users.get_by_username(username: "twitchdev")
+@client.users.retrieve(username: "twitchdev")
+
+# Retrieves multiple users by their usernames
+# Requires an array of IDs
+@client.users.retrieve(usernames: ["twitchdev", "deanpcmad"])
 
 # Update the currently authenticated user's description
 # Required scope: user:edit
 @client.users.update(description: "New Description")
 
-# Deprecated. Please look at using channels.followed or channels.followers
-# Shows users who follow or are following a user ID
-@client.users.follows(from_id: 141981764)
-@client.users.follows(to_id: 141981764)
-
-# A quick method for seeing if a user is following a channel
-@client.users.following?(from_id: 141981764, to_id: 141981764)
-
 # Returns Blocked users for a broadcaster
 # Required scope: user:read:blocked_users
 @client.users.blocks(broadcaster_id: 141981764)
@@ -74,7 +74,7 @@ An access token is required because the Helix API requires authentication.
 
 ```ruby
 # Retrieve a channel by their ID
-@client.channels.get(broadcaster_id: 141981764)
+@client.channels.retrieve(id: 141981764)
 
 # Retrieve a list of broadcasters a specified user follows
 # user_id must match the currently authenticated user
@@ -82,7 +82,8 @@ An access token is required because the Helix API requires authentication.
 @client.channels.followed user_id: 123123
 
 # Retrieve a list of users that follow a specified broadcaster
-# broadcaster_id must match the currently authenticated user
+# broadcaster_id must match the currently authenticated user or
+# a moderator of the specified broadcaster
 # Required scope: moderator:read:followers
 @client.channels.followers broadcaster_id: 123123
 
@@ -107,18 +108,19 @@ attributes = {title: "My new title"}
 
 ```ruby
 # Retrieves a list of videos
-# Available parameters: id, user_id or game_id
-@client.videos.list(id: 12345)
+# Available parameters: user_id or game_id
 @client.videos.list(user_id: 12345)
 @client.videos.list(game_id: 12345)
+
+# Retrieves a video by its ID
+@client.videos.retrieve(id: 12345)
 ```
 
 ### Clips
 
 ```ruby
 # Retrieves a list of clips
-# Available parameters: id, broadcaster_id or game_id
-@client.clips.list(id: 12345)
+# Available parameters: broadcaster_id or game_id
 @client.clips.list(user_id: 12345)
 @client.clips.list(game_id: 12345)
 
@@ -157,19 +159,24 @@ attributes = {title: "My new title"}
 ### Games
 
 ```ruby
-# Retrieves a game by its ID
-@client.games.get_by_id(game_id: 123)
+# Retrieves a game by ID
+@client.games.retrieve(id: 514974)
+
+# Retrieves multiple games by IDs
+# Requires an array of IDs
+@client.games.retrieve(ids: [66402, 514974])
 
-# Retrieves a game by its Name
-@client.games.get_by_id(name: "Battlefield 4")
+# Retrieves a game by name
+@client.games.retrieve(name: "Battlefield 4")
 
-# Retrieves a list of top games
-@client.games.top
+# Retrieves multiple games by names
+# Requires an array of IDs
+@client.games.retrieve(names: ["Battlefield 4", "Battlefield 2042"])
 ```
 
-## EventSub Subscriptions
+### EventSub Subscriptions
 
-These require an application OAuth access token.  
+These require an application OAuth access token.
 
 ```ruby
 # Retrieves a list of EventSub Subscriptions
@@ -191,7 +198,7 @@ These require an application OAuth access token.
 @client.eventsub_subscriptions.delete(id: "abc12-abc12-abc12")
 ```
 
-## Banned Events
+### Banned Events
 
 ```ruby
 # Retrieves all ban and un-ban events for a channel
@@ -199,7 +206,7 @@ These require an application OAuth access token.
 @client.banned_events.list(broadcaster_id: 123)
 ```
 
-## Banned Users
+### Banned Users
 
 ```ruby
 # Retrieves all banned and timed-out users for a channel
@@ -221,7 +228,7 @@ These require an application OAuth access token.
 @client.banned_users.delete broadcaster_id: 123, moderator_id: 321, user_id: 112233
 ```
 
-## Send Chat Announcement
+### Send Chat Announcement
 
 ```ruby
 # Sends an announcement to the broadcaster's chat room
@@ -231,7 +238,7 @@ These require an application OAuth access token.
 @client.announcements.create broadcaster_id: 123, moderator_id: 123, message: "test message", color: "purple"
 ```
 
-## Create a Shoutout
+### Create a Shoutout
 
 ```ruby
 # Creates a Shoutout for a broadcaster
@@ -242,7 +249,7 @@ These require an application OAuth access token.
 @client.shoutouts.create from: 123, to: 321, moderator_id: 123
 ```
 
-## Moderators
+### Moderators
 
 ```ruby
 # List all moderators for a broadcaster
@@ -265,7 +272,7 @@ These require an application OAuth access token.
 @client.moderators.delete broadcaster_id: 123, user_id: 321
 ```
 
-## VIPs
+### VIPs
 
 ```ruby
 # List all VIPs for a broadcaster
@@ -288,10 +295,10 @@ These require an application OAuth access token.
 @client.vips.delete broadcaster_id: 123, user_id: 321
 ```
 
-## Raids
+### Raids
 
 ```ruby
-# Starts a raid 
+# Starts a raid
 # Requires channel:manage:raids
 # from_broadcaster_id must be the authenticated user
 @client.raids.create from_broadcaster_id: 123, to_broadcaster_id: 321
@@ -310,7 +317,7 @@ These require an application OAuth access token.
 @client.chat_messages.delete broadcaster_id: 123, moderator_id: 123, message_id: "abc123-abc123"
 ```
 
-## Whispers
+### Whispers
 
 ```ruby
 # Send a Whisper
@@ -319,7 +326,7 @@ These require an application OAuth access token.
 @client.whispers.create from_user_id: 123, to_user_id: 321, message: "this is a test"
 ```
 
-## AutoMod
+### AutoMod
 
 ```ruby
 # Check if a message meets the channel's AutoMod requirements
@@ -353,7 +360,7 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.automod.update_settings broadcaster_id: 123, moderator_id: 321, swearing: 1
 ```
 
-## Creator Goals
+### Creator Goals
 
 ```ruby
 # List all active creator goals
@@ -362,7 +369,7 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.goals.list broadcaster_id: 123
 ```
 
-## Blocked Terms
+### Blocked Terms
 
 ```ruby
 # List all blocked terms
@@ -385,7 +392,7 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.blocked_terms.delete broadcaster_id: 123, moderator_id: 321, id: "abc12-12abc"
 ```
 
-## Charity Campaigns
+### Charity Campaigns
 
 ```ruby
 # Gets information about the charity campaign that a broadcaster is running
@@ -394,7 +401,7 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.charity_campaigns.list broadcaster_id: 123
 ```
 
-## Chatters
+### Chatters
 
 ```ruby
 # Gets the list of users that are connected to the specified broadcaster’s chat session
@@ -403,9 +410,49 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.chatters.list broadcaster_id: 123, moderator_id: 123
 ```
 
+### Channel Points Custom Rewards
+
+```ruby
+# Gets a list of custom rewards for a specific channel
+# Required scope: channel:read:redemptions
+# broadcaster_id must match the currently authenticated user
+@client.custom_rewards.list broadcaster_id: 123
+
+# Create a custom reward
+# Required scope: channel:manage:redemptions
+# broadcaster_id must match the currently authenticated user
+@client.custom_rewards.create broadcaster_id: 123, title: "New Reward", cost: 1000
+
+# Update a custom reward
+# Required scope: channel:manage:redemptions
+# broadcaster_id must match the currently authenticated user
+@client.custom_rewards.update broadcaster_id: 123, reward_id: 321, title: "Updated Reward"
+
+# Delete a custom reward
+# Required scope: channel:manage:redemptions
+# broadcaster_id must match the currently authenticated user
+@client.custom_rewards.delete broadcaster_id: 123, reward_id: 321
+```
+
+### Channel Points Custom Reward Redemptions
+
+```ruby
+# Gets a list of custom reward redemptions for a specific channel
+# Required scope: channel:read:redemptions
+# broadcaster_id must match the currently authenticated user
+@client.custom_reward_redemptions.list broadcaster_id: 123, reward_id: 321, status: "UNFULFILLED"
+
+# Update a custom reward redemption status
+# Required scope: channel:manage:redemptions
+# broadcaster_id must match the currently authenticated user
+# Status can be FULFILLED or CANCELED
+@client.custom_reward_redemptions.update broadcaster_id: 123, reward_id: 321, redemption_id: 123, status: "FULFILLED"
+```
+
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/twitchrb/twitchrb.
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/twitchrb.
 
 ## License
 

data/lib/twitch/client.rb

@@ -36,7 +36,7 @@ module Twitch
     def videos
       VideosResource.new(self)
     end
-    
+
     def clips
       ClipsResource.new(self)
     end
@@ -152,12 +152,14 @@ module Twitch
     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
         }
-        
+
         conn.request :json
 
         conn.response :json, content_type: "application/json"

data/lib/twitch/resources/channels.rb

@@ -1,8 +1,8 @@
 module Twitch
   class ChannelsResource < Resource
-    
-    def get(broadcaster_id:)
-      Channel.new get_request("channels?broadcaster_id=#{broadcaster_id}").body.dig("data")[0]
+
+    def retrieve(id:)
+      Channel.new get_request("channels?broadcaster_id=#{id}").body.dig("data")[0]
     end
 
     # Retrieve a list of broadcasters a specified user follows

data/lib/twitch/resources/clips.rb

@@ -1,21 +1,21 @@
 module Twitch
   class ClipsResource < Resource
-    
+
     def list(**params)
-      raise "id, broadcaster_id or game_id is required" unless !params[:id].nil? || !params[:broadcaster_id].nil? || !params[:game_id].nil?
+      raise "broadcaster_id or game_id is required" unless !params[:broadcaster_id].nil? || !params[:game_id].nil?
 
       response = get_request("clips", params: params)
       Collection.from_response(response, type: Clip)
     end
 
     def retrieve(id:)
-      Clip.new get_request("clips?id=#{id}").body.dig("data")[0]
+      Clip.new get_request("clips", params: {id: id}).body.dig("data")[0]
     end
 
     # Required scope: clips:edit
     def create(broadcaster_id:, **attributes)
       response = post_request("clips", body: attributes.merge(broadcaster_id: broadcaster_id))
-      
+
       Clip.new(response.body.dig("data")[0]) if response.success?
     end
 

data/lib/twitch/resources/custom_reward_redemptions.rb

@@ -1,6 +1,6 @@
 module Twitch
   class CustomRewardRedemptionsResource < Resource
-    
+
     # Required scope: channel:read:redemptions
     # Broadcaster ID must match the user in the OAuth token
     def list(broadcaster_id:, reward_id:, status:, **params)
@@ -9,14 +9,15 @@ module Twitch
       Collection.from_response(response, type: CustomRewardRedemption)
     end
 
-    # Currently disabled as getting this error and can't work out why
-    # Twitch::Error (Error 400: Your request was malformed. 'The parameter "id" was malformed: the value must be greater than or equal to 1')
-    # def update(broadcaster_id:, reward_id:, redemption_id:, status:)
-    #   attributes = {broadcaster_id: broadcaster_id, reward_id: reward_id, id: redemption_id, status: status.upcase}
-    #   response = patch_request("channel_points/custom_rewards/redemptions", body: attributes)
+    # Required scope: channel:manage:redemptions
+    # Broadcaster ID must match the user in the OAuth token
+    def update(broadcaster_id:, reward_id:, redemption_id:, status:)
+      attributes = {status: status.upcase}
+      url = "channel_points/custom_rewards/redemptions?broadcaster_id=#{broadcaster_id}&reward_id=#{reward_id}&id=#{redemption_id}&status=#{status.upcase}"
+      response = patch_request(url, body: attributes)
 
-    #   CustomRewardRedemption.new(response.body.dig("data")[0]) if response.success?
-    # end
+      CustomRewardRedemption.new(response.body.dig("data")[0]) if response.success?
+    end
 
   end
 end

data/lib/twitch/resources/games.rb

@@ -1,14 +1,27 @@
 module Twitch
   class GamesResource < Resource
 
-    def get_by_id(game_id:)
-      response = get_request("games?id=#{game_id}")
-      Collection.from_response(response, type: Game)
-    end
+    def retrieve(id: nil, ids: nil, name: nil, names: nil)
+      raise "Either id, ids, name or names is required" unless !id.nil? || !ids.nil? || !name.nil? || !names.nil?
 
-    def get_by_name(name:)
-      response = get_request("games?name=#{name}")
-      Collection.from_response(response, type: Game)
+      if id
+        response = get_request("games", params: {id: id})
+      elsif ids
+        response = get_request("games", params: {id: ids})
+      elsif names
+        response = get_request("games", params: {name: names})
+      else
+        response = get_request("games", params: {name: name})
+      end
+
+      body = response.body.dig("data")
+      if body.count == 1
+        Game.new body[0]
+      elsif body.count > 1
+        Collection.from_response(response, type: Game)
+      else
+        return nil
+      end
     end
 
     def top(**params)

data/lib/twitch/resources/users.rb

@@ -1,12 +1,27 @@
 module Twitch
   class UsersResource < Resource
-    
-    def get_by_id(user_id:)
-      User.new get_request("users?id=#{user_id}").body.dig("data")[0]
-    end
 
-    def get_by_username(username:)
-      User.new get_request("users?login=#{username}").body.dig("data")[0]
+    def retrieve(id: nil, ids: nil, username: nil, usernames: nil)
+      raise "Either id, ids, username or usernames is required" unless !id.nil? || !ids.nil? || !username.nil? || !usernames.nil?
+
+      if id
+        response = get_request("users", params: {id: id})
+      elsif ids
+        response = get_request("users", params: {id: ids})
+      elsif usernames
+        response = get_request("users", params: {login: usernames})
+      else
+        response = get_request("users", params: {login: username})
+      end
+
+      body = response.body.dig("data")
+      if body.count == 1
+        User.new body[0]
+      elsif body.count > 1
+        Collection.from_response(response, type: User)
+      else
+        return nil
+      end
     end
 
     # Updates the current users description
@@ -38,7 +53,7 @@ module Twitch
     # Deprecated.
     def follows(**params)
       warn "`users.follows` is deprecated. Use `channels.followers` or `channels.following` instead."
-      
+
       raise "from_id or to_id is required" unless !params[:from_id].nil? || !params[:to_id].nil?
 
       response = get_request("users/follows", params: params)

data/lib/twitch/resources/videos.rb

@@ -1,17 +1,24 @@
 module Twitch
   class VideosResource < Resource
-    
+
     def list(**params)
-      raise "id, user_id or game_id is required" unless !params[:id].nil? || !params[:user_id].nil? || !params[:game_id].nil?
+      raise "user_id or game_id is required" unless !params[:user_id].nil? || !params[:game_id].nil?
 
       response = get_request("videos", params: params)
       Collection.from_response(response, type: Video)
     end
 
+    def retrieve(id:)
+      response = get_request("videos", params: {id: id})
+      if response.body
+        Video.new response.body["data"].first
+      end
+    end
+
     # Required scope: channel:manage:videos
-    # def delete(video_id:)
-    #   delete_request("videos?id=#{video_id}")
-    # end
+    def delete(video_id:)
+      delete_request("videos?id=#{video_id}")
+    end
 
   end
 end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API