twitchrb 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df6403caadd7a32c52d8c3c17f9cbf4347cc3b830d5d02bdb2328b82770271d
-  data.tar.gz: ddefb273c7f21aa359da843dd50e9c1caedb6ace5c3a65bbead6809e50830149
+  metadata.gz: 828f7c0543e796014befead46a15222e41a9c775ea7baa4d4cd346e674777dd8
+  data.tar.gz: 2a9a88da2bf52a0362c24d38201806545d0483a36217f14ed30f120c89664f88
 SHA512:
-  metadata.gz: e8e9852558b0b8888ba5a805bea1fa48d02c80680385f48a763da6800780f3ebf4bcc2a160e30cbe1025c83a20b87d957f358a4e930394c3ab27a40a1ce8a30e
-  data.tar.gz: 236dc69a027f34684c88bf527a7f0dd2a77bad46699b2e7cfbe25512014bd009e4fe4a0181b3874a6c141135d21118e12f0dfbf16d030491349829a84a726b14
+  metadata.gz: 3a0695cf7d5600a1c171f43ff1fae6ba39c2242ddd5092d7e04c1c234c03a9ca00f9f2c51036a685a6d08356bc5fb5f9cdabb2e150ecd9854962074f69df75a1
+  data.tar.gz: be4161b6cdc5f83c6169fc49733146c1c3fc210b43be9b8823fbd0f8e4b97dc42c1d722b5d8b01bf98623498b367318779f94f790b9cfc2c99cb125697310889

data/Gemfile.lock

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

data/README.md

@@ -35,6 +35,7 @@ An access token is required because the Helix API requires authentication.
 # 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)
@@ -75,6 +76,16 @@ An access token is required because the Helix API requires authentication.
 # Retrieve a channel by their ID
 @client.channels.get(broadcaster_id: 141981764)
 
+# Retrieve a list of broadcasters a specified user follows
+# user_id must match the currently authenticated user
+# Required scope: user:read:follows
+@client.channels.followed user_id: 123123
+
+# Retrieve a list of users that follow a specified broadcaster
+# broadcaster_id must match the currently authenticated user
+# Required scope: moderator:read:followers
+@client.channels.followers broadcaster_id: 123123
+
 # Retrieve the number of Followers a broadcaster has
 @client.channels.follows_count(broadcaster_id: 141981764)
 

data/lib/twitch/resources/channels.rb

@@ -5,9 +5,25 @@ module Twitch
       Channel.new get_request("channels?broadcaster_id=#{broadcaster_id}").body.dig("data")[0]
     end
 
+    # Retrieve a list of broadcasters a specified user follows
+    # Required scope: user:read:follows
+    # user_id must match the authenticated user
+    def followed(user_id:, **params)
+      response = get_request("channels/followed", params: params.merge(user_id: user_id))
+      Collection.from_response(response, type: User)
+    end
+
+    # Retrieve a list of users that follow a specified broadcaster
+    # Required scope: moderator:read:followers
+    # broadcaster_id must match the authenticated user
+    def followers(broadcaster_id:, **params)
+      response = get_request("channels/followers", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: User)
+    end
+
     # Grabs the number of Followers a broadcaster has
     def follows_count(broadcaster_id:)
-      response = get_request("users/follows", params: {to_id: broadcaster_id})
+      response = get_request("channels/followers", params: {broadcaster_id: broadcaster_id})
 
       FollowCount.new(count: response.body["total"])
     end

data/lib/twitch/resources/users.rb

@@ -35,7 +35,10 @@ module Twitch
       put_request("chat/color?user_id=#{user_id}&color=#{color}", body: {})
     end
 
+    # 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)
@@ -60,6 +63,8 @@ module Twitch
 
     # A quick method to see if a user is following a channel
     def following?(from_id:, to_id:)
+      warn "`users.following?` is deprecated. Use `channels.followers` or `channels.following` instead."
+
       response = get_request("users/follows", params: {from_id: from_id, to_id: to_id})
 
       if response.body["data"].empty?

data/lib/twitch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-02-21 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.5
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API