twitchrb 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62be7346346cf921307a581b64b68bd364342b81a93e334b4fbf1ffd8198b6c2
-  data.tar.gz: 6d4a106e899173699181fd01e0be36d2461287b6c8520d83293421a2e6a5704c
+  metadata.gz: 15c7d6175a906c3469b5d3ac691f66ef8f86d0682959a648b69cb0d35f39523f
+  data.tar.gz: 8a505c88b94833d36805006b7a8ab1e6cb54e76ecb05cb99ffb81cca5c7bd491
 SHA512:
-  metadata.gz: aa82df2fb8d72bfd37b36abfaa51c01bc0159ff764fa2f2f7da927b04166bb4d3b5fbe1023cd3d8a0a36689d39707743d9b2c1fcffe1615de2606a739cf4685b
-  data.tar.gz: 18faf9bc25f3d9d98910434835d73c02e5f0acd3a942639ee72ae0759b07c0b8f2035d56b11486c27b50e2fbb16292ad8d99002f3a1236160ef950a4829422ef
+  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,10 +7,10 @@ jobs:
       fail-fast: false
       matrix:
         ruby_version:
-          - 2.7
-          - 3.0
-          - 3.1
-          - 3.2
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
     steps:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    twitchrb (1.2.0)
+    twitchrb (1.2.1)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.1.1)
+    base64 (0.2.0)
     dotenv (2.7.6)
-    faraday (2.7.11)
+    faraday (2.8.1)
       base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)

data/README.md

@@ -174,7 +174,7 @@ attributes = {title: "My new title"}
 @client.games.retrieve(names: ["Battlefield 4", "Battlefield 2042"])
 ```
 
-## EventSub Subscriptions
+### EventSub Subscriptions
 
 These require an application OAuth access token.
 
@@ -198,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
@@ -206,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
@@ -228,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
@@ -238,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
@@ -249,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
@@ -272,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
@@ -295,7 +295,7 @@ These require an application OAuth access token.
 @client.vips.delete broadcaster_id: 123, user_id: 321
 ```
 
-## Raids
+### Raids
 
 ```ruby
 # Starts a raid
@@ -317,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
@@ -326,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
@@ -360,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
@@ -369,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
@@ -392,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
@@ -401,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
@@ -410,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/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/version.rb

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

metadata

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