youtuberb 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8d3b68ce9d206b19c96ccf31e5707379fcb98a989805f133df36a59c440e65
-  data.tar.gz: 0f9ef583ce567c2dcc7da4474cd9575efd54ba967a59c1e1809a7bbc78f07d5c
+  metadata.gz: 9723022ed2efe8846dce8650e21077bc2be1e888bb034596b87620ba1cbda433
+  data.tar.gz: ed5ecf1b108bd4b9601e4ad93836dbe070dbc16fc60a1c1bca54d79c2d34f5df
 SHA512:
-  metadata.gz: 6fda64e56e4ac55557fb661a3d35e952bf5f2d415848598598cae30b0a12cd5ce8ed46ee62df1107030c2102039e53544f5d58128b711191ec4556ba539a0b03
-  data.tar.gz: 86e6f3c535e6d1e40947237c5dc89f0330edf64ea4fa438dd18075fc91be5ec1cb33b3c58956507f0084e3bae7c7967d0c0e551fbeea96db5f95dcde6b5d5e7f
+  metadata.gz: 719d5673d88e53d3fd4220a28c4eb4da599127d008a2d0223913eb1fbab10b1ac748f33d88c90c6a16069a908dfc4fa9f156eb063f0bb1e182bba4785bc09de4
+  data.tar.gz: 50c1bc722fcd3e0db8d008938aa96e0cd866818246fe94a040caa039a5d37238608771cd8271326a444a9f67ab642192cc5b660a8d8ca8da6dc93e964221c57a

data/Gemfile

@@ -6,4 +6,5 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-gem "dotenv"
+gem "minitest", "~> 5.0"
+gem "dotenv"

data/Gemfile.lock

@@ -1,17 +1,20 @@
 PATH
   remote: .
   specs:
-    youtuberb (0.1.3)
+    youtuberb (0.2.0)
       faraday (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    base64 (0.1.1)
     dotenv (2.7.6)
-    faraday (2.2.0)
-      faraday-net_http (~> 2.0)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.2)
+    faraday-net_http (3.0.2)
+    minitest (5.20.0)
     rake (13.0.6)
     ruby2_keywords (0.0.5)
 
@@ -20,6 +23,7 @@ PLATFORMS
 
 DEPENDENCIES
   dotenv
+  minitest (~> 5.0)
   rake (~> 13.0)
   youtuberb!
 

data/README.md

@@ -16,10 +16,14 @@ gem 'youtuberb'
 
 ### Set Client Details
 
-Firstly you'll need to set an API Key and an Access Token. 
-An Access Token will be an OAuth2 token generated after authentication. 
+Firstly you'll need to set an API Key. A user Access Token is required to access private data.
+An Access Token will be an OAuth2 token generated after authentication.
 
 ```ruby
+# To access public data, just an API Key is required
+@client = YouTube::Client.new(api_key: "")
+
+# Or to access data for a user, an Access Token is also required
 @client = YouTube::Client.new(api_key: "", access_token: "")
 ```
 
@@ -41,15 +45,32 @@ An Access Token will be an OAuth2 token generated after authentication.
 ```ruby
 # Get a single video
 @client.videos.list(id: "abc123")
+# => #<YouTube::Video...
 
 # Get multiple videos
-@client.videos.list(id: "abc123,123abc")
+@client.videos.list(ids: ["abc123", "123abc"])
+# => #<YouTube::Collection...
 
 # Liked videos for the currently authenticated user
 @client.videos.liked
+# => #<YouTube::Collection...
 
 # Get a video owned by the current user. This retrieves extra information so will only work on videos owned by the current user.
 @client.videos.retrieve(id: "abc123")
+# => #<YouTube::Video...
+```
+
+#### Getting a list of Videos for a Channel
+
+```ruby
+# First, grab the Channel details
+channel = @client.channels.retrieve(id: "channel_id")
+
+# Then use the Playlist Items endpoint to get the Videos
+@client.playlist_items.list playlist_id: channel.contentDetails.relatedPlaylists.uploads
+
+# Or use the Search endpoint
+@client.search.list channelId: channel.id
 ```
 
 ### Playlists
@@ -69,6 +90,7 @@ An Access Token will be an OAuth2 token generated after authentication.
 @client.playlists.update(id: "playlist_id", title: "My Playlist", privacy_status: "public")
 @client.playlists.delete(id: "playlist_id")
 ```
+
 ### Playlist Items
 
 ```ruby
@@ -85,6 +107,21 @@ An Access Token will be an OAuth2 token generated after authentication.
 @client.playlist_items.delete(id: "playlist_id")
 ```
 
+### Search
+
+For a full list of parameters, see the [YouTube API Docs](https://developers.google.com/youtube/v3/docs/search/list).
+
+```ruby
+# Search YouTube for a term
+@client.search.list(q: "search term")
+
+# Restrict the search to a channel
+@client.search.list(channelId: "channel")
+
+# Search a channel for videos only and ordered by date
+@client.search.list(channelId: "channel", type: "video", order: "date")
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/youtuberb.

data/Rakefile

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+

data/lib/you_tube/client.rb

@@ -4,13 +4,10 @@ module YouTube
 
     attr_reader :api_key, :access_token, :adapter
 
-    def initialize(api_key:, access_token:, adapter: Faraday.default_adapter, stubs: nil)
+    def initialize(api_key:, access_token: nil, adapter: Faraday.default_adapter)
       @api_key = api_key
       @access_token = access_token
       @adapter = adapter
-
-      # Test stubs for requests
-      @stubs = stubs
     end
 
     def channels
@@ -29,6 +26,10 @@ module YouTube
       PlaylistItemsResource.new(self)
     end
 
+    def search
+      SearchResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :Bearer, access_token

data/lib/you_tube/collection.rb

@@ -7,7 +7,7 @@ module YouTube
 
       new(
         data: body["items"].map { |attrs| type.new(attrs) },
-        total: body["pageInfo"]["totalResults"],
+        total: body["items"].count,
         next_page_token: body["nextPageToken"],
         prev_page_token: body["prevPageToken"],
         # cursor: body.dig("pagination", "cursor")

data/lib/you_tube/objects/search_result.rb

@@ -0,0 +1,30 @@
+module YouTube
+  class SearchResult < Object
+
+    def initialize(options = {})
+      super options
+
+      if options["id"]
+        self.video_id    = options["id"]["videoId"] || nil
+        self.playlist_id = options["id"]["playlistId"] || nil
+      end
+
+      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
+    end
+
+  end
+end

data/lib/you_tube/objects/video.rb

@@ -9,7 +9,7 @@ module YouTube
         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"]
@@ -25,6 +25,12 @@ module YouTube
         self.blocked = !options["contentDetails"]["regionRestriction"].nil?
       end
 
+      if options["liveStreamingDetails"]
+        self.live_stream = options["liveStreamingDetails"]["actualStartTime"].present?
+      else
+        self.live_stream = false
+      end
+
       if options["status"]
         self.upload_status  = options["status"]["uploadStatus"]
         self.privacy_status = options["status"]["privacyStatus"]

data/lib/you_tube/resources/channels.rb

@@ -1,7 +1,7 @@
 module YouTube
   class ChannelsResource < Resource
 
-    PARTS = "id,snippet,status,statistics"
+    PARTS = "id,snippet,status,statistics,contentDetails"
 
     # Retrieve the channel of the currently authenticated user
     def mine
@@ -9,12 +9,13 @@ module YouTube
       return nil if response.body["pageInfo"]["totalResults"] == 0
       Channel.new(response.body["items"][0])
     end
-    
+
     # Retrieve a Channel by its ID or Username
     def retrieve(id: nil, username: nil)
       attrs = {}
       attrs[:id] = id if id
       attrs[:forUsername] = username if username
+      raise ArgumentError, "Must provide either an ID or Username" if attrs.empty?
 
       response = get_request "channels", params: attrs.merge({part: PARTS})
       return nil if response.body["pageInfo"]["totalResults"] == 0

data/lib/you_tube/resources/search.rb

@@ -0,0 +1,10 @@
+module YouTube
+  class SearchResource < Resource
+
+    def list(**params)
+      response = get_request "search", params: {part: "id,snippet"}.merge(params)
+      Collection.from_response(response, type: SearchResult)
+    end
+
+  end
+end

data/lib/you_tube/resources/videos.rb

@@ -1,13 +1,27 @@
 module YouTube
   class VideosResource < Resource
 
-    PARTS = "id,contentDetails,snippet,statistics,status"
-    AUTH_PARTS = "id,contentDetails,fileDetails,processingDetails,snippet,statistics,status,suggestions"
-    
+    PARTS = "id,snippet,contentDetails,liveStreamingDetails,statistics,status"
+    AUTH_PARTS = "id,snippet,contentDetails,fileDetails,processingDetails,statistics,status,suggestions"
+
     # Retrieves Videos by ID. Can be comma separated to retrieve multiple.
-    def list(id:)
-      response = get_request "videos", params: {id: id, part: PARTS}
-      Collection.from_response(response, type: Video)
+    def list(id: nil, ids: nil)
+      raise "Either id or ids is required" unless !id.nil? || !ids.nil?
+
+      if id
+        response = get_request("videos", params: {id: id, part: PARTS})
+      elsif ids
+        response = get_request("videos", params: {id: ids.join(","), part: PARTS})
+      end
+
+      body = response.body["items"]
+      if body.count == 1
+        Video.new body[0]
+      elsif body.count > 1
+        Collection.from_response(response, type: Video)
+      else
+        return nil
+      end
     end
 
     # Retrieves liked Videos for the currently authenticated user

data/lib/you_tube/version.rb

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

data/lib/you_tube.rb

@@ -15,10 +15,12 @@ module YouTube
   autoload :VideosResource, "you_tube/resources/videos"
   autoload :PlaylistsResource, "you_tube/resources/playlists"
   autoload :PlaylistItemsResource, "you_tube/resources/playlist_items"
+  autoload :SearchResource, "you_tube/resources/search"
 
   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"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: youtuberb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Dean Perry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-10 00:00:00.000000000 Z
+date: 2023-11-01 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: []
@@ -47,11 +47,13 @@ files:
 - lib/you_tube/objects/channel.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/playlist_items.rb
 - lib/you_tube/resources/playlists.rb
+- lib/you_tube/resources/search.rb
 - lib/you_tube/resources/videos.rb
 - lib/you_tube/version.rb
 - lib/youtuberb.rb
@@ -62,7 +64,7 @@ licenses:
 metadata:
   homepage_uri: https://deanpcmad.com
   source_code_uri: https://github.com/deanpcmad/youtuberb
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -77,8 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A Ruby library for interacting with the YouTube API
 test_files: []