twitchrb 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 828f7c0543e796014befead46a15222e41a9c775ea7baa4d4cd346e674777dd8
-  data.tar.gz: 2a9a88da2bf52a0362c24d38201806545d0483a36217f14ed30f120c89664f88
+  metadata.gz: 62be7346346cf921307a581b64b68bd364342b81a93e334b4fbf1ffd8198b6c2
+  data.tar.gz: 6d4a106e899173699181fd01e0be36d2461287b6c8520d83293421a2e6a5704c
 SHA512:
-  metadata.gz: 3a0695cf7d5600a1c171f43ff1fae6ba39c2242ddd5092d7e04c1c234c03a9ca00f9f2c51036a685a6d08356bc5fb5f9cdabb2e150ecd9854962074f69df75a1
-  data.tar.gz: be4161b6cdc5f83c6169fc49733146c1c3fc210b43be9b8823fbd0f8e4b97dc42c1d722b5d8b01bf98623498b367318779f94f790b9cfc2c99cb125697310889
+  metadata.gz: aa82df2fb8d72bfd37b36abfaa51c01bc0159ff764fa2f2f7da927b04166bb4d3b5fbe1023cd3d8a0a36689d39707743d9b2c1fcffe1615de2606a739cf4685b
+  data.tar.gz: 18faf9bc25f3d9d98910434835d73c02e5f0acd3a942639ee72ae0759b07c0b8f2035d56b11486c27b50e2fbb16292ad8d99002f3a1236160ef950a4829422ef

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.2
     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.0)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    base64 (0.1.1)
     dotenv (2.7.6)
-    faraday (2.7.4)
+    faraday (2.7.11)
+      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
 
-These require an application OAuth access token.  
+These require an application OAuth access token.
 
 ```ruby
 # Retrieves a list of EventSub Subscriptions
@@ -291,7 +298,7 @@ These require an application OAuth access token.
 ## 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

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/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.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 
+description:
 email:
 - dean@deanpcmad.com
 executables: []
@@ -128,7 +128,7 @@ licenses:
 metadata:
   homepage_uri: https://deanpcmad.com
   source_code_uri: https://github.com/deanpcmad/twitchrb
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API
 test_files: []