twitchrb 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5da5d24c0516dd123d3c603f728f1afb89dd388d8850bc39f6a46a62c7497b2f
-  data.tar.gz: 4c664108c26f55cceeb5d8c5524fc79fe15a14c16d9114abb3ad481e20afc028
+  metadata.gz: 4921296177c80efd1a41535907c5e2e1ce41a6c6695e319f968a2d9bc5012e34
+  data.tar.gz: 4ad72356f24394069cbf9a2845038db485d75fc9a273446665a18ad59b15274a
 SHA512:
-  metadata.gz: 2fc664b3ae6a78bb1fbf61d65a04cbd8c6a97dd79cd47d418c007e000e6a568fcded0fa0246fb5907197684942c5549f26b6a8f287289cf0200a47f11dd2ea1e
-  data.tar.gz: e04d75f5c8f88392316fc652391998f842c6cd23f9e1484246f876c786ae828b2195dab346506445f945941aaf728c82034eccf596319c47f1f21c2b2484255a
+  metadata.gz: b39f99a455e2d7b02d4c537b55e52576f2a5f232e488a90d3e48480621bec11ab92c9994c9119bacd402f3852654944103a7a1eb0b67e1d1d299e22471c3a9c0
+  data.tar.gz: 2cd4c7b9c6582e9d337343b2dd81f9c8c14b81954dbe6795496115602e6cdd78e2809c8d5f0a004cdcb27602b271a96d68778a85720a31292db999c00f663839

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - 2.6
+          - 2.7
+          - 3.0
+          - 3.1
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler: default
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake test

data/Gemfile.lock

@@ -1,37 +1,18 @@
 PATH
   remote: .
   specs:
-    twitchrb (0.2.4)
-      faraday (~> 1.7)
-      faraday_middleware (~> 1.1)
+    twitchrb (1.0.0)
+      faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     dotenv (2.7.6)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
-    minitest (5.14.1)
-    multipart-post (2.1.1)
+    faraday-net_http (2.0.3)
+    minitest (5.15.0)
     rake (12.3.3)
     ruby2_keywords (0.0.5)
 
@@ -45,4 +26,4 @@ DEPENDENCIES
   twitchrb!
 
 BUNDLED WITH
-   2.1.4
+   2.3.5

data/README.md

@@ -1,10 +1,6 @@
 # TwitchRB
 
-**This library is a work in progress**
-
-TwitchRB is a Ruby library for intereacting with the Twitch API.
-
-It only supports the Helix API as v5 is deprecated.
+TwitchRB is a Ruby library for interacting with the Twitch Helix API.
 
 ## Installation
 
@@ -18,48 +14,355 @@ gem "twitchrb"
 
 ### Set Client Details
 
-Firstly you'll need to set a Client ID, Secret Key and an Access Token.
+Firstly you'll need to set a Client ID and an Access Token.
 
 An access token is required because the Helix API requires authentication.
 
 ```ruby
-@client = Twitch::Client.new(client_id: "", client_secret: "", access_token: "")
+@client = Twitch::Client.new(client_id: "", access_token: "")
 ```
 
 ### Users
 
 ```ruby
+# Retrieves a user by their ID
 @client.users.get_by_id(user_id: 141981764)
+
+# Retrieves a user by their username
 @client.users.get_by_username(username: "twitchdev")
+
+# Update the currently authenticated user's description
+# Required scope: user:edit
+@client.users.update(description: "New Description")
+
+# 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)
+
+# Blocks a user
+# Required scope: user:manage:blocked_users
+@client.users.block_user(target_user_id: 141981764)
+
+# Unblocks a user
+# Required scope: user:manage:blocked_users
+@client.users.unblock_user(target_user_id: 141981764)
+
+# Get a User's Chat Color
+@client.users.get_color(user_id: 123)
+
+# Or get multiple users' chat colors
+# Returns a collection
+@client.users.get_color(user_ids: "123,321")
+
+# Update a User's Chat Color
+# Requires user:manage:chat_color
+# user_id must be the currently authenticated user
+# 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")
 ```
 
 ### Channels
 
 ```ruby
+# Retrieve a channel by their ID
 @client.channels.get(broadcaster_id: 141981764)
+
+# Retrieve the number of Followers a broadcaster has
+@client.channels.follows_count(broadcaster_id: 141981764)
+
+# Retrieve the number of Subscribers and Subscriber Points a broadcaster has
+# Required scope: channel:read:subscriptions
+@client.channels.subscribers_count(broadcaster_id: 141981764)
+
+# Update the currently authenticated channel details
+# Required scope: channel:manage:broadcast
+# Parameters which are allowed: game_id, title, broadcaster_language, delay
+attributes = {title: "My new title"}
+@client.channels.update(broadcaster_id: 141981764, attributes)
+
+# Retrieves editors for a channel
+@client.channels.editors(broadcaster_id: 141981764)
 ```
 
 ### Videos
 
 ```ruby
-@client.videos.get(user_id: 141981764)
+# Retrieves a list of videos
+# Available parameters: id, user_id or game_id
+@client.videos.list(id: 12345)
+@client.videos.list(user_id: 12345)
+@client.videos.list(game_id: 12345)
+```
+
+### Clips
+
+```ruby
+# Retrieves a list of clips
+# Available parameters: id, broadcaster_id or game_id
+@client.clips.list(id: 12345)
+@client.clips.list(user_id: 12345)
+@client.clips.list(game_id: 12345)
+
+# Retrieves a clip by its ID.
+# Clip IDs are alphanumeric. e.g. AwkwardHelplessSalamanderSwiftRage
+@client.clips.retrieve(id: "AwkwardHelplessSalamanderSwiftRage")
+
+# Create a clip of a given Channel
+# Required scope: clips:edit
+@client.clips.create(broadcaster_id: 1234)
 ```
 
 ### Emotes
 
 ```ruby
+# Retrieve all global emotes
 @client.emotes.global
+
+# Retrieve emotes for a channel
 @client.emotes.channel(broadcaster_id: 141981764)
+
+# Retrieve emotes for an emote set
 @client.emotes.sets(emote_set_id: 301590448)
 ```
 
 ### Badges
 
 ```ruby
+# Retrieve all global badges
 @client.badges.global
+
+# Retrieve badges for a channel
 @client.badges.channel(broadcaster_id: 141981764)
 ```
 
+### Games
+
+```ruby
+# Retrieves a game by its ID
+@client.games.get_by_id(game_id: 123)
+
+# Retrieves a game by its Name
+@client.games.get_by_id(name: "Battlefield 4")
+
+# Retrieves a list of top games
+@client.games.top
+```
+
+## EventSub Subscriptions
+
+These require an application OAuth access token.  
+
+```ruby
+# Retrieves a list of EventSub Subscriptions
+# Available parameters: status, type, after
+@client.eventsub_subscriptions.list
+@client.eventsub_subscriptions.list(status: "enabled")
+@client.eventsub_subscriptions.list(type: "channel.follow")
+
+# Create an EventSub Subscription
+@client.eventsub_subscriptions.create(
+  type: "channel.follow",
+  version: 1,
+  condition: {broadcaster_user_id: 123},
+  transport: {method: "webhook", callback: "webhook_url", secret: "secret"}
+)
+
+# Delete an EventSub Subscription
+# IDs are UUIDs
+@client.eventsub_subscriptions.delete(id: "abc12-abc12-abc12")
+```
+
+## Banned Events
+
+```ruby
+# Retrieves all ban and un-ban events for a channel
+# Available parameters: user_id
+@client.banned_events.list(broadcaster_id: 123)
+```
+
+## Banned Users
+
+```ruby
+# Retrieves all banned and timed-out users for a channel
+# Available parameters: user_id
+@client.banned_users.list(broadcaster_id: 123)
+```
+
+```ruby
+# Ban/Timeout a user from a broadcaster's channel
+# Required scope: moderator:manage:banned_users
+# A reason is required
+# To time a user out, a duration is required. If no duration is set, the user will be banned.
+@client.banned_users.create broadcaster_id: 123, moderator_id: 321, user_id: 112233, reason: "testing", duration: 60
+```
+
+```ruby
+# Unban/untimeout a user from a broadcaster's channel
+# Required scope: moderator:manage:banned_users
+@client.banned_users.delete broadcaster_id: 123, moderator_id: 321, user_id: 112233
+```
+
+## Send Chat Announcement
+
+```ruby
+# Sends an announcement to the broadcaster's chat room
+# Requires moderator:manage:announcements
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+# color can be either blue, green, orange, purple, primary. If left blank, primary is default
+@client.announcements.create broadcaster_id: 123, moderator_id: 123, message: "test message", color: "purple"
+```
+
+## Moderators
+
+```ruby
+# List all moderators for a broadcaster
+# Required scope: moderation:read
+# broadcaster_id must be the currently authenticated user
+@client.moderators.list broadcaster_id: 123
+```
+
+```ruby
+# Add a Moderator
+# Required scope: channel:manage:moderators
+# broadcaster_id must be the currently authenticated user
+@client.moderators.create broadcaster_id: 123, user_id: 321
+```
+
+```ruby
+# Remove a Moderator
+# Required scope: channel:manage:moderators
+# broadcaster_id must be the currently authenticated user
+@client.moderators.delete broadcaster_id: 123, user_id: 321
+```
+
+## VIPs
+
+```ruby
+# List all VIPs for a broadcaster
+# Required scope: channel:read:vips or channel:manage:vips
+# broadcaster_id must be the currently authenticated user
+@client.vips.list broadcaster_id: 123
+```
+
+```ruby
+# Add a VIP
+# Required scope: channel:manage:vips
+# broadcaster_id must be the currently authenticated user
+@client.vips.create broadcaster_id: 123, user_id: 321
+```
+
+```ruby
+# Remove a VIP
+# Required scope: channel:manage:vips
+# broadcaster_id must be the currently authenticated user
+@client.vips.delete broadcaster_id: 123, user_id: 321
+```
+
+## Raids
+
+```ruby
+# 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
+```
+
+```ruby
+# Requires channel:manage:raids
+# broadcaster_id must be the authenticated user
+@client.raids.delete broadcaster_id: 123
+```
+
+```ruby
+# Removes a single chat message from the broadcaster's chat room
+# Requires moderator:manage:chat_messages
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+@client.chat_messages.delete broadcaster_id: 123, moderator_id: 123, message_id: "abc123-abc123"
+```
+
+## Whispers
+
+```ruby
+# Send a Whisper
+# Required scope: user:manage:whispers
+# from_user_id must be the currently authenticated user's ID and have a verified phone number
+@client.whispers.create from_user_id: 123, to_user_id: 321, message: "this is a test"
+```
+
+## AutoMod
+
+```ruby
+# Check if a message meets the channel's AutoMod requirements
+# Required scope: moderation:read
+# id is a developer-generated identifier for mapping messages to results.
+@client.automod.check_status_multiple broadcaster_id: 123, id: "abc123", text: "Is this message allowed?"
+
+#> #<Twitch::AutomodStatus msg_id="abc123", is_permitted=true>
+```
+
+```ruby
+# Check if multiple messages meet the channel's AutoMod requirements
+# messages must be an array of hashes and must include msg_id and msg_text
+# Returns a collection
+messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg_text: "What about this?"}]
+@client.automod.check_status_multiple broadcaster_id: 123, messages: messages
+```
+
+```ruby
+# Get AutoMod settings
+# Required scope: moderator:read:automod_settings
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+@client.automod.settings broadcaster_id: 123, moderator_id: 321
+```
+
+```ruby
+# Update AutoMod settings
+# Required scope: moderator:manage:automod_settings
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+# As this is a PUT method, it overwrites all options so all fields you want set should be supplied
+@client.automod.update_settings broadcaster_id: 123, moderator_id: 321, swearing: 1
+```
+
+## Creator Goals
+
+```ruby
+# List all active creator goals
+# Required scope: channel:read:goals
+# broadcaster_id must match the currently authenticated user
+@client.goals.list broadcaster_id: 123
+```
+
+## Blocked Terms
+
+```ruby
+# List all blocked terms
+# Required scope: moderator:read:blocked_terms
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+@client.blocked_terms.list broadcaster_id: 123, moderator_id: 321
+```
+
+```ruby
+# Create a blocked term
+# Required scope: moderator:manage:blocked_terms
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+@client.blocked_terms.create broadcaster_id: 123, moderator_id: 321, text: "term to block"
+```
+
+```ruby
+# Delete a blocked term
+# Required scope: moderator:manage:blocked_terms
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+@client.blocked_terms.delete broadcaster_id: 123, moderator_id: 321, id: "abc12-12abc"
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/twitchrb/twitchrb.

data/bin/console

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

data/lib/twitch/client.rb

@@ -2,11 +2,10 @@ module Twitch
   class Client
     BASE_URL = "https://api.twitch.tv/helix"
 
-    attr_reader :client_id, :client_secret, :access_token, :adapter
+    attr_reader :client_id, :access_token, :adapter
 
-    def initialize(client_id:, client_secret:, access_token:, adapter: Faraday.default_adapter, stubs: nil)
+    def initialize(client_id:, access_token:, adapter: Faraday.default_adapter, stubs: nil)
       @client_id = client_id
-      @client_secret = client_secret
       @access_token = access_token
       @adapter = adapter
 
@@ -110,13 +109,40 @@ module Twitch
       HypeTrainEventsResource.new(self)
     end
 
+    def announcements
+      AnnouncementsResource.new(self)
+    end
+
+    def raids
+      RaidsResource.new(self)
+    end
+
+    def chat_messages
+      ChatMessagesResource.new(self)
+    end
+
+    def vips
+      VipsResource.new(self)
+    end
+
+    def whispers
+      WhispersResource.new(self)
+    end
+
+    def automod
+      AutomodResource.new(self)
+    end
+
+    def blocked_terms
+      BlockedTermsResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :Bearer, access_token
         conn.headers = { "Client-ID": client_id }
         conn.request :json
 
-        conn.response :dates
         conn.response :json, content_type: "application/json"
 
         conn.adapter adapter, @stubs

data/lib/twitch/objects/automod_setting.rb

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

data/lib/twitch/objects/automod_status.rb

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

data/lib/twitch/objects/blocked_term.rb

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

data/lib/twitch/objects/follow_count.rb

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

data/lib/twitch/objects/raid.rb

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

data/lib/twitch/objects/user_color.rb

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

data/lib/twitch/objects/video.rb

@@ -1,31 +1,4 @@
 module Twitch
   class Video < Object
-
-    def initialize(options = {})
-      super options
-
-      self.thumbnail_url_large = generate_thumbnail_url_large
-      self.animated_url = generate_animated_url
-    end
-
-
-    # Generates the Large Thumbnail image URL
-    def generate_thumbnail_url_large
-      return "" if thumbnail_url.empty?
-
-      thumbnail_url.gsub("%{width}", "640").gsub("%{height}", "360")
-    end
-  
-    # Generates a Storyboard/Animated image URL
-    def generate_animated_url
-      return "" if thumbnail_url.empty?
-      
-      thumb = thumbnail_url.dup
-      thumb.gsub!("https://static-cdn.jtvnw.net/cf_vods/", "").gsub!("/thumb/thumb0-%{width}x%{height}.jpg", "storyboards/#{id}-strip-0.jpg")
-      split = thumb.split("/")
-  
-      "https://#{split[0]}.cloudfront.net/#{split[1..].join("/")}"
-    end
-
   end
 end

data/lib/twitch/objects/vip.rb

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

data/lib/twitch/resource.rb

@@ -40,6 +40,8 @@ module Twitch
         raise Error, "Error 404: No results were found for your request. '#{response.body["error"]}'"
       when 409
         raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+      when 422
+        raise Error, "Error 422: Unprocessable Entity. '#{response.body["message"]}"
       when 429
         raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
       when 500

data/lib/twitch/resources/announcements.rb

@@ -0,0 +1,12 @@
+module Twitch
+  class AnnouncementsResource < Resource
+    
+    # Moderator ID must match the user in the OAuth token
+    def create(broadcaster_id:, moderator_id:, message:, color: nil)
+      attrs = {message: message, color: color}
+
+      post_request("chat/announcements?broadcaster_id=#{broadcaster_id}&moderator_id=#{moderator_id}", body: attrs)
+    end
+
+  end
+end

data/lib/twitch/resources/automod.rb

@@ -0,0 +1,37 @@
+module Twitch
+  class AutomodResource < Resource
+
+    # Checks if a supplied message meets the channel's AutoMod requirements
+    # Required scope: moderation:read
+    def check_status(broadcaster_id:, id:, text:)
+      attrs = {broadcaster_id: broadcaster_id, data: [{msg_id: id, msg_text: text}]}
+      response = post_request("moderation/enforcements/status", body: attrs)
+      AutomodStatus.new response.body.dig("data")[0]
+    end
+
+    # Checks if multiple supplied messages meet the channel's AutoMod requirements
+    # Required scope: moderation:read
+    def check_status_multiple(broadcaster_id:, messages:)
+      attrs = {broadcaster_id: broadcaster_id, data: messages}
+      response = post_request("moderation/enforcements/status", body: attrs)
+      Collection.from_response(response, type: AutomodStatus)
+    end
+
+    def manage_message(user_id:, msg_id:, action:)
+      attrs = {user_id: user_id, msg_id: msg_id, action: action}
+      post_request("moderation/automod/message", body: attrs)
+    end
+
+    def settings(broadcaster_id:, moderator_id:)
+      response = get_request("moderation/automod/settings?broadcaster_id=#{broadcaster_id}&moderator_id=#{moderator_id}")
+      AutomodSetting.new response.body.dig("data")[0]
+    end
+
+    def update_settings(broadcaster_id:, moderator_id:, **params)
+      attrs = {broadcaster_id: broadcaster_id, moderator_id: moderator_id}
+      response = put_request("moderation/automod/settings", body: attrs.merge(params))
+      AutomodSetting.new response.body.dig("data")[0]
+    end
+   
+  end
+end

data/lib/twitch/resources/banned_users.rb

@@ -7,5 +7,19 @@ module Twitch
       Collection.from_response(response, type: BannedUser)
     end
 
+    # Required scope: moderator:manage:banned_users
+    # moderator_id must match the currently authenticated user. Can be either the broadcaster ID or moderator ID
+    def create(broadcaster_id:, moderator_id:, user_id:, reason:, duration: nil)
+      attrs = {broadcaster_id: broadcaster_id, moderator_id: moderator_id, data: {user_id: user_id, reason: reason, duration: duration}}
+      response = post_request("moderation/bans", body: attrs)
+      BannedUser.new response.body.dig("data")[0]
+    end
+
+    # Required scope: moderator:manage:banned_users
+    # moderator_id must match the currently authenticated user. Can be either the broadcaster ID or moderator ID
+    def delete(broadcaster_id:, moderator_id:, user_id:)
+      delete_request("moderation/bans?broadcaster_id=#{broadcaster_id}&moderator_id=#{moderator_id}&user_id=#{user_id}")
+    end
+
   end
 end

data/lib/twitch/resources/blocked_terms.rb

@@ -0,0 +1,27 @@
+module Twitch
+  class BlockedTermsResource < Resource
+    
+    # Required scope: moderator:read:blocked_terms
+    # moderator_id must match the currently authenticated user. Can be either the broadcaster ID or moderator ID
+    def list(broadcaster_id:, moderator_id:, **params)
+      attrs = {broadcaster_id: broadcaster_id, moderator_id: moderator_id}
+      response = get_request("moderation/blocked_terms", params: attrs.merge(params))
+      Collection.from_response(response, type: BlockedTerm)
+    end
+
+    # Required scope: moderator:manage:blocked_terms
+    # moderator_id must match the currently authenticated user. Can be either the broadcaster ID or moderator ID
+    def create(broadcaster_id:, moderator_id:, text:)
+      attrs = {broadcaster_id: broadcaster_id, moderator_id: moderator_id, text: text}
+      response = post_request("moderation/blocked_terms", body: attrs)
+      BannedUser.new response.body.dig("data")[0]
+    end
+
+    # Required scope: moderator:manage:blocked_terms
+    # moderator_id must match the currently authenticated user. Can be either the broadcaster ID or moderator ID
+    def delete(broadcaster_id:, moderator_id:, id:)
+      delete_request("moderation/blocked_terms?broadcaster_id=#{broadcaster_id}&moderator_id=#{moderator_id}&id=#{id}")
+    end
+
+  end
+end

data/lib/twitch/resources/channels.rb

@@ -5,6 +5,21 @@ module Twitch
       Channel.new get_request("channels?broadcaster_id=#{broadcaster_id}").body.dig("data")[0]
     end
 
+    # Grabs the number of Followers a broadcaster has
+    def follows_count(broadcaster_id:)
+      response = get_request("users/follows", params: {to_id: broadcaster_id})
+
+      FollowCount.new(count: response.body["total"])
+    end
+
+    # Grabs the number of Subscribers and Subscriber Points a broadcaster has
+    # Required scope: channel:read:subscriptions
+    def subscribers_count(broadcaster_id:)
+      response = get_request("subscriptions", params: {broadcaster_id: broadcaster_id})
+
+      SubscriptionCount.new(count: response.body["total"], points: response.body["points"])
+    end
+
     # Requires scope: channel:manage:broadcast
     def update(broadcaster_id:, **attributes)
       patch_request("channels", body: attributes.merge(broadcaster_id: broadcaster_id))

data/lib/twitch/resources/chat_messages.rb

@@ -0,0 +1,10 @@
+module Twitch
+  class ChatMessagesResource < Resource
+    
+    # moderator_id must match the user in the OAuth token
+    def delete(broadcaster_id:, moderator_id:, message_id:)
+      delete_request("moderation/chat?broadcaster_id=#{broadcaster_id}&moderator_id=#{moderator_id}&message_id=#{message_id}")
+    end
+
+  end
+end

data/lib/twitch/resources/moderators.rb

@@ -7,5 +7,13 @@ module Twitch
       Collection.from_response(response, type: Moderator)
     end
 
+    def create(broadcaster_id:, user_id:)
+      post_request("moderation/moderators", body: {broadcaster_id: broadcaster_id, user_id: user_id})
+    end
+
+    def delete(broadcaster_id:, user_id:)
+      delete_request("moderation/moderators?broadcaster_id=#{broadcaster_id}&user_id=#{user_id}")
+    end
+
   end
 end

data/lib/twitch/resources/raids.rb

@@ -0,0 +1,19 @@
+module Twitch
+  class RaidsResource < Resource
+    
+    # from_broadcaster_id must match the user in the OAuth token
+    def create(from_broadcaster_id:, to_broadcaster_id:)
+      attrs = {from_broadcaster_id: from_broadcaster_id, to_broadcaster_id: to_broadcaster_id}
+
+      response = post_request("raids", body: attrs)
+
+      Raid.new(response.body.dig("data")[0]) if response.success?
+    end
+
+    # broadcaster_id must match the user in the OAuth token
+    def delete(broadcaster_id:)
+      delete_request("raids?broadcaster_id=#{broadcaster_id}")
+    end
+
+  end
+end

data/lib/twitch/resources/users.rb

@@ -2,11 +2,11 @@ module Twitch
   class UsersResource < Resource
     
     def get_by_id(user_id:)
-      User.new get_request("users/?id=#{user_id}").body.dig("data")[0]
+      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]
+      User.new get_request("users?login=#{username}").body.dig("data")[0]
     end
 
     # Updates the current users description
@@ -16,6 +16,25 @@ module Twitch
       User.new response.body.dig("data")[0]
     end
 
+    def get_color(user_id: nil, user_ids: nil)
+      if user_ids != nil
+        users = user_ids.split(",").map{|i| "user_id=#{i.strip}"}.join("&")
+        puts "chat/color?#{users}"
+        response = get_request("chat/color?#{users}")
+        Collection.from_response(response, type: UserColor)
+      else
+        response = get_request("chat/color?user_id=#{user_id}")
+        UserColor.new response.body.dig("data")[0]
+      end
+    end
+
+    # Update a user's color
+    # Required scope: user:manage:chat_color
+    # user_id must be the currently authenticated user
+    def update_color(user_id:, color:)
+      put_request("chat/color?user_id=#{user_id}&color=#{color}", body: {})
+    end
+
     def follows(**params)
       raise "from_id or to_id is required" unless !params[:from_id].nil? || !params[:to_id].nil?
 

data/lib/twitch/resources/vips.rb

@@ -0,0 +1,19 @@
+module Twitch
+  class VipsResource < Resource
+    
+    # Broadcaster ID must match the user in the OAuth token
+    def list(broadcaster_id:, **params)
+      response = get_request("channels/vips", params: params.merge(broadcaster_id: broadcaster_id))
+      Collection.from_response(response, type: Vip)
+    end
+
+    def create(broadcaster_id:, user_id:)
+      post_request("channels/vips", body: {broadcaster_id: broadcaster_id, user_id: user_id})
+    end
+
+    def delete(broadcaster_id:, user_id:)
+      delete_request("channels/vips?broadcaster_id=#{broadcaster_id}&user_id=#{user_id}")
+    end
+
+  end
+end

data/lib/twitch/resources/whispers.rb

@@ -0,0 +1,9 @@
+module Twitch
+  class WhispersResource < Resource
+    
+    def create(from_user_id:, to_user_id:, message:)
+      post_request("whispers", body: {from_user_id: from_user_id, to_user_id: to_user_id, message: message})
+    end
+
+  end
+end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "0.2.4"
+  VERSION = "1.0.0"
 end

data/lib/twitch.rb

@@ -1,5 +1,4 @@
 require "faraday"
-require "faraday_middleware"
 require "json"
 require "twitch/version"
 
@@ -36,6 +35,13 @@ module Twitch
   autoload :CustomRewardRedemptionsResource, "twitch/resources/custom_reward_redemptions"
   autoload :GoalsResource, "twitch/resources/goals"
   autoload :HypeTrainEventsResource, "twitch/resources/hype_train_events"
+  autoload :AnnouncementsResource, "twitch/resources/announcements"
+  autoload :RaidsResource, "twitch/resources/raids"
+  autoload :ChatMessagesResource, "twitch/resources/chat_messages"
+  autoload :VipsResource, "twitch/resources/vips"
+  autoload :WhispersResource, "twitch/resources/whispers"
+  autoload :AutomodResource, "twitch/resources/automod"
+  autoload :BlockedTermsResource, "twitch/resources/blocked_terms"
 
 
   autoload :User, "twitch/objects/user"
@@ -67,5 +73,12 @@ module Twitch
   autoload :CustomRewardRedemption, "twitch/objects/custom_reward_redemption"
   autoload :Goal, "twitch/objects/goal"
   autoload :HypeTrainEvent, "twitch/objects/hype_train_event"
+  autoload :FollowCount, "twitch/objects/follow_count"
+  autoload :Raid, "twitch/objects/raid"
+  autoload :UserColor, "twitch/objects/user_color"
+  autoload :Vip, "twitch/objects/vip"
+  autoload :AutomodStatus, "twitch/objects/automod_status"
+  autoload :AutomodSetting, "twitch/objects/automod_setting"
+  autoload :BlockedTerm, "twitch/objects/blocked_term"
 
 end

data/twitchrb.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["dean@deanpcmad.com"]
 
   spec.summary       = "A Ruby library for interacting with the Twitch Helix API"
-  spec.homepage      = "https://twitchrb.com"
+  spec.homepage      = "https://deanpcmad.com"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
@@ -24,6 +24,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 1.7"
-  spec.add_dependency "faraday_middleware", "~> 1.1"
+  spec.add_dependency "faraday", "~> 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-31 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,29 +16,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-description: 
+        version: '2.0'
+description:
 email:
 - dean@deanpcmad.com
 executables: []
@@ -47,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -60,9 +47,12 @@ files:
 - lib/twitch/collection.rb
 - lib/twitch/error.rb
 - lib/twitch/object.rb
+- lib/twitch/objects/automod_setting.rb
+- lib/twitch/objects/automod_status.rb
 - lib/twitch/objects/badge.rb
 - lib/twitch/objects/banned_event.rb
 - lib/twitch/objects/banned_user.rb
+- lib/twitch/objects/blocked_term.rb
 - lib/twitch/objects/blocked_user.rb
 - lib/twitch/objects/channel.rb
 - lib/twitch/objects/channel_editor.rb
@@ -71,6 +61,7 @@ files:
 - lib/twitch/objects/custom_reward_redemption.rb
 - lib/twitch/objects/emote.rb
 - lib/twitch/objects/event_sub_subscription.rb
+- lib/twitch/objects/follow_count.rb
 - lib/twitch/objects/followed_user.rb
 - lib/twitch/objects/game.rb
 - lib/twitch/objects/goal.rb
@@ -79,6 +70,7 @@ files:
 - lib/twitch/objects/moderator_event.rb
 - lib/twitch/objects/poll.rb
 - lib/twitch/objects/prediction.rb
+- lib/twitch/objects/raid.rb
 - lib/twitch/objects/search_result.rb
 - lib/twitch/objects/stream.rb
 - lib/twitch/objects/stream_marker.rb
@@ -87,12 +79,18 @@ files:
 - lib/twitch/objects/subscription_count.rb
 - lib/twitch/objects/tag.rb
 - lib/twitch/objects/user.rb
+- lib/twitch/objects/user_color.rb
 - lib/twitch/objects/video.rb
+- lib/twitch/objects/vip.rb
 - lib/twitch/resource.rb
+- lib/twitch/resources/announcements.rb
+- lib/twitch/resources/automod.rb
 - lib/twitch/resources/badges.rb
 - lib/twitch/resources/banned_events.rb
 - lib/twitch/resources/banned_users.rb
+- lib/twitch/resources/blocked_terms.rb
 - lib/twitch/resources/channels.rb
+- lib/twitch/resources/chat_messages.rb
 - lib/twitch/resources/clips.rb
 - lib/twitch/resources/custom_reward_redemptions.rb
 - lib/twitch/resources/custom_rewards.rb
@@ -105,6 +103,7 @@ files:
 - lib/twitch/resources/moderators.rb
 - lib/twitch/resources/polls.rb
 - lib/twitch/resources/predictions.rb
+- lib/twitch/resources/raids.rb
 - lib/twitch/resources/search.rb
 - lib/twitch/resources/stream_markers.rb
 - lib/twitch/resources/stream_schedule.rb
@@ -113,16 +112,18 @@ files:
 - lib/twitch/resources/tags.rb
 - lib/twitch/resources/users.rb
 - lib/twitch/resources/videos.rb
+- lib/twitch/resources/vips.rb
+- lib/twitch/resources/whispers.rb
 - lib/twitch/version.rb
 - lib/twitchrb.rb
 - twitchrb.gemspec
-homepage: https://twitchrb.com
+homepage: https://deanpcmad.com
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://twitchrb.com
+  homepage_uri: https://deanpcmad.com
   source_code_uri: https://github.com/deanpcmad/twitchrb
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API
 test_files: []