youtuberb 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9723022ed2efe8846dce8650e21077bc2be1e888bb034596b87620ba1cbda433
-  data.tar.gz: ed5ecf1b108bd4b9601e4ad93836dbe070dbc16fc60a1c1bca54d79c2d34f5df
+  metadata.gz: 9fe8e6ecebef2bdb2227e76efedbb1ede0c3e18d2a7d0715ffd0830d16a0345a
+  data.tar.gz: 3a23f5aa3d670946d2f8fdec60ca0a3c93b38d4cc1056986a68d5e65e81c9aaa
 SHA512:
-  metadata.gz: 719d5673d88e53d3fd4220a28c4eb4da599127d008a2d0223913eb1fbab10b1ac748f33d88c90c6a16069a908dfc4fa9f156eb063f0bb1e182bba4785bc09de4
-  data.tar.gz: 50c1bc722fcd3e0db8d008938aa96e0cd866818246fe94a040caa039a5d37238608771cd8271326a444a9f67ab642192cc5b660a8d8ca8da6dc93e964221c57a
+  metadata.gz: bdbc338427501a21cf5536c9a566fc2d0491900eb1bd02f0c35b829ce800d275c767f19119d5311e2121584466b3927faab88cf1b4a0564ffd99470d3fdbd92d
+  data.tar.gz: 49cbe76dcc1eca7ef654e6a916650f99d98e8fc62666f26d26029d52e8d7debe6226b11087023e5a32c3fb899d37bd333ea12cbee7c0e4259bd3644f7db3b768

data/Gemfile.lock

@@ -1,22 +1,26 @@
 PATH
   remote: .
   specs:
-    youtuberb (0.2.0)
+    youtuberb (0.2.2)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.1.1)
     dotenv (2.7.6)
-    faraday (2.7.11)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday (2.14.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    json (2.16.0)
+    logger (1.7.0)
     minitest (5.20.0)
+    net-http (0.8.0)
+      uri (>= 0.11.1)
     rake (13.0.6)
-    ruby2_keywords (0.0.5)
+    uri (1.1.1)
 
 PLATFORMS
   x86_64-linux

data/README.md

@@ -38,6 +38,13 @@ An Access Token will be an OAuth2 token generated after authentication.
 
 # Get a Channel by username
 @client.channels.retrieve(username: "username")
+
+# Get a Channel by it's handle
+@client.channels.retrieve(handle: "@username")
+
+# Retrieve a list of videos for a Channel
+# Returns a collection of SearchResult's because YouTube don't have a direct API to view all videos on a Channel
+@client.channels.videos(id: "channel_id")
 ```
 
 ### Videos
@@ -122,6 +129,16 @@ For a full list of parameters, see the [YouTube API Docs](https://developers.goo
 @client.search.list(channelId: "channel", type: "video", order: "date")
 ```
 
+### Live Broadcasts
+
+```ruby
+# Live Broadcasts for the currently authenticated user
+@client.live_broadcasts.list
+
+# Live Broadcasts by status
+@client.live_broadcasts.list status: "active"
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/youtuberb.

data/lib/you_tube/client.rb

@@ -30,6 +30,10 @@ module YouTube
       SearchResource.new(self)
     end
 
+    def live_broadcasts
+      LiveBroadcastsResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :Bearer, access_token

data/lib/you_tube/collection.rb

@@ -10,7 +10,6 @@ module YouTube
         total: body["items"].count,
         next_page_token: body["nextPageToken"],
         prev_page_token: body["prevPageToken"],
-        # cursor: body.dig("pagination", "cursor")
       )
     end
 
@@ -20,5 +19,17 @@ module YouTube
       @next_page_token = next_page_token
       @prev_page_token = prev_page_token
     end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    def first
+      data.first
+    end
+
+    def last
+      data.last
+    end
   end
 end

data/lib/you_tube/objects/live_broadcast.rb

@@ -0,0 +1,30 @@
+module YouTube
+  class LiveBroadcast < Object
+
+    def initialize(options = {})
+      super options
+
+      if options["snippet"]
+        self.title        = options["snippet"]["title"]
+        self.description  = options["snippet"]["description"]
+        self.published_at = options["snippet"]["publishedAt"]
+        self.channel_id   = options["snippet"]["channelId"]
+
+        if options["snippet"]["thumbnails"]
+          thumb = options["snippet"]["thumbnails"]
+          self.thumbnail_default  = thumb["default"]["url"]   if thumb["default"]
+          self.thumbnail_medium   = thumb["medium"]["url"]    if thumb["medium"]
+          self.thumbnail_high     = thumb["high"]["url"]      if thumb["high"]
+          self.thumbnail_standard = thumb["standard"]["url"]  if thumb["standard"]
+          self.thumbnail_maxres   = thumb["maxres"]["url"]    if thumb["maxres"]
+        end
+      end
+
+      if options["status"]
+        self.upload_status  = options["status"]["uploadStatus"]
+        self.privacy_status = options["status"]["privacyStatus"]
+      end
+    end
+
+  end
+end

data/lib/you_tube/objects/video.rb

@@ -23,6 +23,7 @@ module YouTube
       # Is a Video is blocked in any countries?
       if options["contentDetails"]
         self.blocked = !options["contentDetails"]["regionRestriction"].nil?
+        self.age_restricted = !options["contentDetails"]["contentRating"].nil? && options["contentDetails"]["contentRating"]["ytRating"] == "ytAgeRestricted"
       end
 
       if options["liveStreamingDetails"]

data/lib/you_tube/resources/channels.rb

@@ -10,17 +10,23 @@ module YouTube
       Channel.new(response.body["items"][0])
     end
 
-    # Retrieve a Channel by its ID or Username
-    def retrieve(id: nil, username: nil)
+    # Retrieve a Channel by its ID, Username or Handle (@username)
+    def retrieve(id: nil, username: nil, handle: nil)
       attrs = {}
       attrs[:id] = id if id
       attrs[:forUsername] = username if username
-      raise ArgumentError, "Must provide either an ID or Username" if attrs.empty?
+      attrs[:forHandle] = handle if handle
+      raise ArgumentError, "Must provide either an ID, Username or Handle" if attrs.empty?
 
       response = get_request "channels", params: attrs.merge({part: PARTS})
       return nil if response.body["pageInfo"]["totalResults"] == 0
       Channel.new(response.body["items"][0])
     end
 
+    def videos(id:, **options)
+      response = get_request "search", params: {channelId: id, part: "id,snippet"}.merge(options)
+      Collection.from_response(response, type: SearchResult)
+    end
+
   end
 end

data/lib/you_tube/resources/live_broadcasts.rb

@@ -0,0 +1,26 @@
+module YouTube
+  class LiveBroadcastsResource < Resource
+
+    PARTS = "id,snippet,contentDetails,status"
+
+    # Retrieves Live Broadcasts by ID or for the currently authenticated user
+    def list(status: nil)
+      if status
+        response = get_request("liveBroadcasts", params: {broadcastStatus: status, part: PARTS})
+      else
+        response = get_request("liveBroadcasts", params: {mine: true, part: PARTS})
+      end
+
+      Collection.from_response(response, type: LiveBroadcast)
+    end
+
+    # Retrieves a Video by the ID. This retrieves extra information so will only work
+    # on videos for an authenticated user
+    def retrieve(id:)
+      response = get_request "liveBroadcasts", params: {id: id, part: PARTS}
+      return nil if response.body["items"].count == 0
+      LiveBroadcast.new(response.body["items"][0])
+    end
+
+  end
+end

data/lib/you_tube/version.rb

@@ -1,3 +1,3 @@
 module YouTube
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/you_tube.rb

@@ -16,11 +16,13 @@ module YouTube
   autoload :PlaylistsResource, "you_tube/resources/playlists"
   autoload :PlaylistItemsResource, "you_tube/resources/playlist_items"
   autoload :SearchResource, "you_tube/resources/search"
+  autoload :LiveBroadcastsResource, "you_tube/resources/live_broadcasts"
 
   autoload :Channel, "you_tube/objects/channel"
   autoload :Video, "you_tube/objects/video"
   autoload :Playlist, "you_tube/objects/playlist"
   autoload :PlaylistItem, "you_tube/objects/playlist_item"
   autoload :SearchResult, "you_tube/objects/search_result"
+  autoload :LiveBroadcast, "you_tube/objects/live_broadcast"
 
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: youtuberb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Dean Perry
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description:
 email:
 - dean@deanpcmad.com
 executables: []
@@ -45,12 +43,14 @@ files:
 - lib/you_tube/error.rb
 - lib/you_tube/object.rb
 - lib/you_tube/objects/channel.rb
+- lib/you_tube/objects/live_broadcast.rb
 - lib/you_tube/objects/playlist.rb
 - lib/you_tube/objects/playlist_item.rb
 - lib/you_tube/objects/search_result.rb
 - lib/you_tube/objects/video.rb
 - lib/you_tube/resource.rb
 - lib/you_tube/resources/channels.rb
+- lib/you_tube/resources/live_broadcasts.rb
 - lib/you_tube/resources/playlist_items.rb
 - lib/you_tube/resources/playlists.rb
 - lib/you_tube/resources/search.rb
@@ -64,7 +64,6 @@ licenses:
 metadata:
   homepage_uri: https://deanpcmad.com
   source_code_uri: https://github.com/deanpcmad/youtuberb
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Ruby library for interacting with the YouTube API
 test_files: []