twitchrb 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8ee21feb703fb97c6fe0d5a3dd7da8072f70d1a959fc84f5e502aaa2ec45d68
-  data.tar.gz: 75723ca8b4285ac950ebe0e722238b72c42b3be9d0e7214d57afbaf613586b3c
+  metadata.gz: 60c3e4872fe539340033a16467e0091ff8d0dbc4bef5f0e9f3aa71f524883b80
+  data.tar.gz: 76df58744f36bea5b0e8884958bbd05ff91cfce41a072b3c46c9df26aec2a0ab
 SHA512:
-  metadata.gz: 28c24c46f1b678e8db7e56ff24a5e80f25b3c0a491a61373b57d98ccf9081ca2157adf91f8767c01aa23bcfbfd04559188ef589d5055aee38f6aef945e8ef21e
-  data.tar.gz: e6253a4bc7c31232fff212dbfddca8b86d2205c4be7bffc9da9beb5e233016a9c8bb97bfcd4147a6833521e09b01cfa2be3d3c661ceb4a33e886cbb48440c9d5
+  metadata.gz: 530d727b629c4c1a3c52f7839e27a69466d5af0653370b371ab33f03175665a8c8851b1058c87264011e1700dd6e7fd36eb9337b207714d332785f6c9e2d0285
+  data.tar.gz: 25a314a0961681b53d2fc94a2aff462bfcca32d7d2807aad3a034289ea65f3289c8dafccb2ccd9928380e9daa98ec648669b5ee1a0451c867b019102ba3d5e78

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    twitchrb (1.0.1)
+    twitchrb (1.0.3)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     dotenv (2.7.6)
-    faraday (2.5.2)
+    faraday (2.7.4)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.0)
+    faraday-net_http (3.0.2)
     minitest (5.15.0)
     rake (12.3.3)
     ruby2_keywords (0.0.5)

data/README.md

@@ -220,6 +220,17 @@ These require an application OAuth access token.
 @client.announcements.create broadcaster_id: 123, moderator_id: 123, message: "test message", color: "purple"
 ```
 
+## Create a Shoutout
+
+```ruby
+# Creates a Shoutout for a broadcaster
+# Requires moderator:manage:shoutouts
+# From: the ID of the Broadcaster creating the Shoutout
+# To: the ID of the Broadcaster the Shoutout will be for
+# moderator_id can be either the currently authenticated moderator or the broadcaster
+@client.shoutouts.create from: 123, to: 321, moderator_id: 123
+```
+
 ## Moderators
 
 ```ruby
@@ -372,6 +383,15 @@ messages = [{msg_id: "abc1", msg_text: "is this allowed?"}, {msg_id: "abc2", msg
 @client.charity_campaigns.list broadcaster_id: 123
 ```
 
+## Chatters
+
+```ruby
+# Gets the list of users that are connected to the specified broadcaster’s chat session
+# Required scope: moderator:read:chatters
+# broadcaster_id must match the currently authenticated user
+@client.chatters.list broadcaster_id: 123, moderator_id: 123
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/twitchrb/twitchrb.

data/lib/twitch/client.rb

@@ -141,6 +141,14 @@ module Twitch
       CharityCampaignsResource.new(self)
     end
 
+    def chatters
+      ChattersResource.new(self)
+    end
+
+    def shoutouts
+      ShoutoutsResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :Bearer, access_token

data/lib/twitch/objects/chatter.rb

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

data/lib/twitch/resources/announcements.rb

@@ -2,6 +2,7 @@ module Twitch
   class AnnouncementsResource < Resource
     
     # Moderator ID must match the user in the OAuth token
+    # Required scope: moderator:manage:announcements
     def create(broadcaster_id:, moderator_id:, message:, color: nil)
       attrs = {message: message, color: color}
 

data/lib/twitch/resources/charity_campaigns.rb

@@ -4,8 +4,12 @@ module Twitch
     # Required scope: channel:read:charity
     # Broadcaster ID must match the user in the OAuth token
     def list(broadcaster_id:)
-      response = get_request("charity/campaigns?broadcaster_id=#{broadcaster_id}")
-      Collection.from_response(response, type: CharityCampaign)
+      response = get_request("charity/campaigns?broadcaster_id=#{broadcaster_id}")     
+      if response.body.dig("data")[0]
+        CharityCampaign.new(response.body.dig("data")[0])
+      else
+        nil
+      end
     end
 
   end

data/lib/twitch/resources/chatters.rb

@@ -0,0 +1,15 @@
+module Twitch
+  class ChattersResource < Resource
+    
+    # Gets a list of users that are connected to the specified broadcaster's chat session
+    # Moderator ID must match the user in the OAuth token
+    # Required scope: moderator:read:chatters
+    def list(broadcaster_id:, moderator_id:, **params)
+      attrs = {broadcaster_id: broadcaster_id, moderator_id: moderator_id}
+      response = get_request("chat/chatters", params: attrs.merge(params))
+
+      Collection.from_response(response, type: Chatter)
+    end
+
+  end
+end

data/lib/twitch/resources/shoutouts.rb

@@ -0,0 +1,13 @@
+module Twitch
+  class ShoutoutsResource < Resource
+    
+    # Moderator ID must match the user in the OAuth token
+    # From: the ID of the Broadcaster creating the Shoutout
+    # To: the ID of the Broadcaster the Shoutout will be for
+    # Required scope: moderator:manage:shoutouts
+    def create(from:, to:, moderator_id:)
+      post_request("chat/shoutouts?from_broadcaster_id=#{from}&to_broadcaster_id=#{to}&moderator_id=#{moderator_id}", body: nil)
+    end
+
+  end
+end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

data/lib/twitch.rb

@@ -43,6 +43,8 @@ module Twitch
   autoload :AutomodResource, "twitch/resources/automod"
   autoload :BlockedTermsResource, "twitch/resources/blocked_terms"
   autoload :CharityCampaignsResource, "twitch/resources/charity_campaigns"
+  autoload :ChattersResource, "twitch/resources/chatters"
+  autoload :ShoutoutsResource, "twitch/resources/shoutouts"
 
 
   autoload :User, "twitch/objects/user"
@@ -81,6 +83,7 @@ module Twitch
   autoload :AutomodStatus, "twitch/objects/automod_status"
   autoload :AutomodSetting, "twitch/objects/automod_setting"
   autoload :BlockedTerm, "twitch/objects/blocked_term"
-  autoload :CHarityCampaign, "twitch/objects/charity_campaign"
+  autoload :CharityCampaign, "twitch/objects/charity_campaign"
+  autoload :Chatter, "twitch/objects/chatter"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -57,6 +57,7 @@ files:
 - lib/twitch/objects/channel.rb
 - lib/twitch/objects/channel_editor.rb
 - lib/twitch/objects/charity_campaign.rb
+- lib/twitch/objects/chatter.rb
 - lib/twitch/objects/clip.rb
 - lib/twitch/objects/custom_reward.rb
 - lib/twitch/objects/custom_reward_redemption.rb
@@ -93,6 +94,7 @@ files:
 - lib/twitch/resources/channels.rb
 - lib/twitch/resources/charity_campaigns.rb
 - lib/twitch/resources/chat_messages.rb
+- lib/twitch/resources/chatters.rb
 - lib/twitch/resources/clips.rb
 - lib/twitch/resources/custom_reward_redemptions.rb
 - lib/twitch/resources/custom_rewards.rb
@@ -107,6 +109,7 @@ files:
 - lib/twitch/resources/predictions.rb
 - lib/twitch/resources/raids.rb
 - lib/twitch/resources/search.rb
+- lib/twitch/resources/shoutouts.rb
 - lib/twitch/resources/stream_markers.rb
 - lib/twitch/resources/stream_schedule.rb
 - lib/twitch/resources/streams.rb
@@ -140,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.3
 signing_key: 
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API