twitchrb 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30b0eac63e649a017a1c4938b034886f1934da667145ca984f7d2898220d9c91
-  data.tar.gz: 97883516313836adc1a003649904b532c66ce5f14568981d5f82b21b807f489b
+  metadata.gz: aed73c860ea357f7be4fed291738092fc960c84db6196828ed038ffc86485778
+  data.tar.gz: 530134f555c196d49b5262a7fea0519cc8d24ef11998dc413578cb0864816c00
 SHA512:
-  metadata.gz: 5337a58e97212f82d77208f41a0af2b2b0f5b36c3652b7905c51af117e67767affe6a1388e647ed8e4f8ed307488084ee91989cc1a21494265dd5abba9055eea
-  data.tar.gz: 4a95c514a5d1addd4eebd265ba04ba79ae945913042ee4245d07a563e69bf37d365a49d31078130c425a5b545128886058211db96cc3444ff32bd56ebaa31490
+  metadata.gz: 580f55a88bbd26a32a61d1ff6bd112c11c1c4f81b260c11f0cd482fd105dcb67275c456a1798f5b19ef40627cfd85c554f2bd0adf1dd3fbc0b5a5ad4f73db3cb
+  data.tar.gz: 818cdcbceaa214f65976316ea002113706adfef09163e6fd45e3b8b517e8c5fded02dff5801978a46a13028122c563344b6b63bd20862e348e65d85758902f1f

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.2)
-      faraday (~> 1.7)
-      faraday_middleware (~> 1.1)
+    twitchrb (0.2.5)
+      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.2.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.2)
+    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

@@ -2,16 +2,14 @@
 
 **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 intereacting with the Twitch Helix API.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "twitchrb", require: "twitch"
+gem "twitchrb"
 ```
 
 ## Usage
@@ -23,43 +21,171 @@ Firstly you'll need to set a Client ID, Secret Key and an Access Token.
 An access token is required because the Helix API requires authentication.
 
 ```ruby
-@client = Twitch::Client.new(client_id: "", secret_key: "", access_token: "")
+@client = Twitch::Client.new(client_id: "", client_secret: "", 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)
+
 ```
 
 ### 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)
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/twitchrb/twitchrb.

data/lib/twitch/client.rb

@@ -116,7 +116,6 @@ module Twitch
         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/follow_count.rb

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

data/lib/twitch/objects/video.rb

@@ -1,4 +1,31 @@
 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/resources/channels.rb

@@ -2,7 +2,22 @@ module Twitch
   class ChannelsResource < Resource
     
     def get(broadcaster_id:)
-      User.new get_request("channels?broadcaster_id=#{broadcaster_id}").body.dig("data")[0]
+      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

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

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "0.2.2"
+  VERSION = "0.2.5"
 end

data/lib/twitch.rb

@@ -1,5 +1,4 @@
 require "faraday"
-require "faraday_middleware"
 require "json"
 require "twitch/version"
 
@@ -67,5 +66,6 @@ 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"
 
 end

data/lib/twitchrb.rb

@@ -0,0 +1 @@
+require "twitch"

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.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Dean Perry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-12 00:00:00.000000000 Z
+date: 2022-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,14 @@ 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'
+        version: '2.0'
 description: 
 email:
 - dean@deanpcmad.com
@@ -47,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".env.example"
 - ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -71,6 +58,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
@@ -114,12 +102,13 @@ files:
 - lib/twitch/resources/users.rb
 - lib/twitch/resources/videos.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: 
 rdoc_options: []
@@ -136,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API