yt 0.33.3 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8fb2f8f84d6a6ce2ec3b7cf3afae4152820f6ef62a1229f4b512bc87a913efd
-  data.tar.gz: 46d4c3b5a3a5e01bd1366f4679cb2c4e1db08e667d64a6b003e01f8f91cde5c3
+  metadata.gz: 33ad5cd77351556b82e952d8475b978539d34cb7b82731f60b91dc000fd675ce
+  data.tar.gz: 373db01c5faa0076ea61b9e30f81f7959505ea423026dcc2aba227f8f6aacc13
 SHA512:
-  metadata.gz: 9021e2cd657badc5446c118a82f7e392d75a513c42f5f1f9664d2dd3ce1da5274b9edb8e89fca67189f0011ab447c13edd102ccc1677d2f5ee5e567accc23d54
-  data.tar.gz: 59b673686f5c0faf8c21e155110fa3371f5d5cc2b020bf27189c1e2e50b9b05f4a51860186887e8444c6d1da33b057d260ae7f1d696eb97717b362174abe479d
+  metadata.gz: 0cb261d97cba17e75a42c49420784917bea7a9f6c257f08f928463db81f34784fce53c844d5744c6e72001bb4a600b94cef6592fd2e8ebc368118c5bcec1cb5b
+  data.tar.gz: 8af926d7f3341c7f3ffdd1b6a71554470fcd13d6fa7710e666eacf2e9968c76efedb5cdbf603ab792c0f076497fafa8e64364cb2a8355ad6b4475218950069b6

data/CHANGELOG.md

@@ -6,6 +6,23 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.34.0 - 2024-08-25
+
+* Ruby 2.1+ required https://github.com/nullscreen/yt/pull/425
+* [IMPROVEMENT] Use new oauth2 endpoints https://github.com/nullscreen/yt/pull/422
+* [REMOVAL] Remove `Playlist#tags` as 'snippet.tags[]' deprecated https://github.com/nullscreen/yt/pull/421
+* [FEATURE] Add captions associated with a video https://github.com/nullscreen/yt/pull/419
+* [BUGFIX] Remove dependency on the deprecated open-uri in Ruby 3 https://github.com/nullscreen/yt/pull/412 (thank you @kalemi19)
+
+**Breaking change**
+
+If your code runs on version of Ruby 2.1 or earlier, it will not be supported.
+Please make sure to upgrade Ruby version to later than 2.1 before upgrade Yt.
+
+## 0.33.4 - 2021-01-15
+
+* [REMOVAL] remove retry for quota errors
+
 ## 0.33.3 - 2020-11-17
 
 * [BUGFIX] require the `URL` model when requiring `yt`

data/README.md

@@ -43,7 +43,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.32.0'
+    gem 'yt', '~> 0.34.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -56,7 +56,7 @@ Available resources
 Yt::Account
 -----------
 
-Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/accounts.html) for the list of methods available for `Yt::Account`.
+Check [nullscreen.github.io/yt](http://nullscreen.github.io/yt/accounts.html) for the list of methods available for `Yt::Account`.
 
 
 Yt::ContentOwner
@@ -109,22 +109,22 @@ content_owner.assets.first.custom_id #=> "MoKNJFOIRroc"
 Yt::Channel
 -----------
 
-Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/channels.html) for the list of methods available for `Yt::Channel`.
+Check [nullscreen.github.io/yt](http://nullscreen.github.io/yt/channels.html) for the list of methods available for `Yt::Channel`.
 
 Yt::Video
 ---------
 
-Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/videos.html) for the list of methods available for `Yt::Video`.
+Check [nullscreen.github.io/yt](http://nullscreen.github.io/yt/videos.html) for the list of methods available for `Yt::Video`.
 
 Yt::Playlist
 ------------
 
-Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/playlists.html) for the list of methods available for `Yt::Playlist`.
+Check [nullscreen.github.io/yt](http://nullscreen.github.io/yt/playlists.html) for the list of methods available for `Yt::Playlist`.
 
 Yt::PlaylistItem
 ----------------
 
-Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/playlist_items.html) for the list of methods available for `Yt::PlaylistItem`.
+Check [nullscreen.github.io/yt](http://nullscreen.github.io/yt/playlist_items.html) for the list of methods available for `Yt::PlaylistItem`.
 
 Yt::CommentThread
 ----------------
@@ -217,7 +217,7 @@ videos.where(id: 'jNQXAC9IVRw,invalid').map(&:title) #=> ["Fullscreen Creator Pl
 Yt::Annotation
 --------------
 
-Check [fullscreen.github.io/yt](http://fullscreen.github.io/yt/annotations.html) for the list of methods available for `Yt::Annotation`.
+Check [nullscreen.github.io/yt](http://nullscreen.github.io/yt/annotations.html) for the list of methods available for `Yt::Annotation`.
 
 
 Yt::MatchPolicy

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "yt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/lib/yt/actions/list.rb

@@ -1,5 +1,4 @@
 require 'yt/request'
-require 'yt/models/iterator'
 require 'yt/errors/no_items'
 require 'yt/config'
 
@@ -17,7 +16,7 @@ module Yt
 
       def list
         @last_index, @page_token = 0, nil
-        Yt::Iterator.new(-> {total_results}) do |items|
+        Enumerator.new(-> {total_results}) do |items|
           while next_item = find_next
             items << next_item
           end

data/lib/yt/associations/has_authentication.rb

@@ -32,6 +32,7 @@ module Yt
         @force = options[:force]
         @scopes = options[:scopes]
         @authentication = options[:authentication]
+        @state = options[:state]
       end
 
       def auth
@@ -48,7 +49,7 @@ module Yt
 
       def authentication_url
         host = 'accounts.google.com'
-        path = '/o/oauth2/auth'
+        path = '/o/oauth2/v2/auth'
         query = authentication_url_params.to_param
         URI::HTTPS.build(host: host, path: path, query: query).to_s
       end
@@ -190,6 +191,7 @@ module Yt
           params[:access_type] = :offline
           params[:approval_prompt] = @force ? :force : :auto
           # params[:include_granted_scopes] = true
+          params[:state] = @state if @state
         end
       end
 
@@ -243,4 +245,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/collections/authentications.rb

@@ -16,8 +16,8 @@ module Yt
 
       def list_params
         super.tap do |params|
-          params[:host] = 'accounts.google.com'
-          params[:path] = '/o/oauth2/token'
+          params[:host] = 'oauth2.googleapis.com'
+          params[:path] = '/token'
           params[:request_format] = :form
           params[:method] = :post
           params[:auth] = nil

data/lib/yt/collections/captions.rb

@@ -0,0 +1,30 @@
+require 'yt/collections/base'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a collection of video captions.
+    class Captions < Resources
+
+      private
+
+      def attributes_for_new_item(data)
+        {id: data['id'], snippet: data['snippet'], auth: @auth}
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:path] = "/youtube/v3/captions"
+          params[:params] = captions_params
+        end
+      end
+
+      def captions_params
+        {}.tap do |params|
+          params[:part] = 'snippet'
+          params[:video_id] = @parent.id if @parent
+          apply_where_params! params
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/device_flows.rb

@@ -15,9 +15,10 @@ module Yt
 
       def list_params
         super.tap do |params|
-          params[:path] = '/o/oauth2/device/code'
+          params[:host] = 'oauth2.googleapis.com'
+          params[:path] = '/device/code'
         end
       end
     end
   end
-end
+end

data/lib/yt/collections/revocations.rb

@@ -15,10 +15,10 @@ module Yt
 
       def list_params
         super.tap do |params|
-          params[:host] = 'accounts.google.com'
-          params[:path] = '/o/oauth2/revoke'
-          params[:request_format] = nil
-          params[:method] = :get
+          params[:host] = 'oauth2.googleapis.com'
+          params[:path] = '/revoke'
+          params[:request_format] = :form
+          params[:method] = :post
           params[:auth] = nil
           params[:body] = nil
           params[:camelize_body] = false

data/lib/yt/collections/user_infos.rb

@@ -13,7 +13,7 @@ module Yt
       # @see https://developers.google.com/+/api/latest/people/getOpenIdConnect
       def list_params
         super.tap do |params|
-          params[:path] = '/oauth2/v2/userinfo'
+          params[:path] = '/oauth2/v3/userinfo'
           params[:expected_response] = Net::HTTPOK
         end
       end
@@ -33,4 +33,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/account.rb

@@ -1,4 +1,3 @@
-require 'open-uri'
 require 'yt/models/base'
 
 module Yt
@@ -67,13 +66,19 @@ module Yt
       # @option params [String] :description The video’s description.
       # @option params [Array<String>] :tags The video’s tags.
       # @option params [String] :privacy_status The video’s privacy status.
+      # @option params [Boolean] :self_declared_made_for_kids The video’s made for kids self-declaration.
       # @return [Yt::Models::Video] the newly uploaded video.
       def upload_video(path_or_url, params = {})
-        file = open path_or_url, 'rb'
+        file = URI.open(path_or_url)
         session = resumable_sessions.insert file.size, upload_body(params)
 
         session.update(body: file) do |data|
-          Yt::Video.new id: data['id'], snippet: data['snippet'], status: data['privacyStatus'], auth: self
+          Yt::Video.new(
+            id: data['id'],
+            snippet: data['snippet'],
+            status: data['status'],
+            auth: self
+          )
         end
       end
 
@@ -217,8 +222,12 @@ module Yt
           snippet[:categoryId] = snippet.delete(:category_id) if snippet[:category_id]
           body[:snippet] = snippet if snippet.any?
 
-          status = params[:privacy_status]
-          body[:status] = {privacyStatus: status} if status
+          privacy_status = params[:privacy_status]
+          self_declared_made_for_kids = params[:self_declared_made_for_kids]
+
+          body[:status] = {}
+          body[:status][:privacyStatus] = privacy_status if privacy_status
+          body[:status][:selfDeclaredMadeForKids] = self_declared_made_for_kids unless self_declared_made_for_kids.nil?
         end
       end
 

data/lib/yt/models/caption.rb

@@ -0,0 +1,19 @@
+require 'yt/models/resource'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube video captions.
+    # @see https://developers.google.com/youtube/v3/docs/captions
+    class Caption < Resource
+
+      # @return [String] the ID used to identify the caption.
+      has_attribute :id
+
+      delegate :video_id, to: :snippet
+      delegate :last_updated, to: :snippet
+      delegate :language, to: :snippet
+      delegate :name, to: :snippet
+      delegate :status, to: :snippet
+    end
+  end
+end

data/lib/yt/models/channel.rb

@@ -29,6 +29,25 @@ module Yt
       #   @return [Time] the date and time that the channel was created.
       delegate :published_at, to: :snippet
 
+    ### STATUS ###
+
+      # @!attribute [r] made_for_kids?
+      #   @return [Boolean, nil] This value indicates whether the channel is
+      #     designated as child-directed, and it contains the current "made for
+      #     kids" status of the channel.
+      def made_for_kids?
+        status.made_for_kids
+      end
+
+      # @!attribute [r] self_declared_made_for_kids?
+      #   @return [Boolean, nil] In a channels.update request, this property
+      #     allows the channel owner to designate the channel as
+      #     child-directed. The property value is only returned if the channel
+      #     owner authorized the API request.
+      def self_declared_made_for_kids?
+        status.self_declared_made_for_kids
+      end
+
     ### SUBSCRIPTION ###
 
       has_one :subscription

data/lib/yt/models/content_owner.rb

@@ -54,7 +54,7 @@ module Yt
       # @option params [String] :content_type The type of content being uploaded.
       # @return [Yt::Models::Reference] the newly uploaded reference.
       def upload_reference_file(path_or_url, params = {})
-        file = open path_or_url, 'rb'
+        file = URI.open(path_or_url)
         session = resumable_sessions.insert file.size, params
 
         session.update(body: file) do |data|

data/lib/yt/models/playlist.rb

@@ -37,10 +37,6 @@ module Yt
       #   @return [String] the title of the channel that the playlist belongs to.
       delegate :channel_title, to: :snippet
 
-      # @!attribute [r] tags
-      #   @return [Array<String>] the list of tags attached to the playlist.
-      delegate :tags, to: :snippet
-
     ### STATISTICS ###
 
       has_one :content_detail

data/lib/yt/models/snippet.rb

@@ -38,6 +38,11 @@ module Yt
       has_attribute :like_count, type: Integer
       has_attribute :updated_at, type: Time
 
+      has_attribute :last_updated, type: Time
+      has_attribute :language
+      has_attribute :name
+      has_attribute :status
+
       def thumbnail_url(size = :default)
         thumbnails.fetch(size.to_s, {})['url']
       end

data/lib/yt/models/statistics_set.rb

@@ -17,7 +17,12 @@ module Yt
       has_attribute :view_count, type: Integer
       has_attribute :comment_count, type: Integer
       has_attribute :like_count, type: Integer
+
+      # statistics.dislikeCount property included in an API response
+      # only if the API request was authenticated by the video owner
+      # as of December 13, 2021
       has_attribute :dislike_count, type: Integer
+
       has_attribute :favorite_count, type: Integer
       has_attribute :video_count, type: Integer
       has_attribute :subscriber_count, type: Integer

data/lib/yt/models/status.rb

@@ -27,6 +27,8 @@ module Yt
       has_attribute :embeddable
       has_attribute :public_stats_viewable
       has_attribute :publish_at, type: Time
+      has_attribute :made_for_kids
+      has_attribute :self_declared_made_for_kids
     end
   end
-end
+end

data/lib/yt/models/video.rb

@@ -223,6 +223,21 @@ module Yt
         status.embeddable
       end
 
+      #   @return [Boolean, nil] This value indicates whether the video is
+      #     designated as child-directed, and it contains the current "made for
+      #     kids" status of the video.
+      def made_for_kids?
+        status.made_for_kids
+      end
+
+      #   @return [Boolean, nil] In a videos.insert or videos.update request,
+      #     this property allows the channel owner to designate the video as
+      #     being child-directed. In a videos.list request, the property value
+      #     is only returned if the channel owner authorized the API request.
+      def self_declared_made_for_kids?
+        status.self_declared_made_for_kids
+      end
+
     ### CONTENT DETAILS ###
 
       has_one :content_detail
@@ -518,6 +533,10 @@ module Yt
       #     player that will play the video.
       delegate :embed_html, to: :player
 
+    ### CAPTION ###
+
+      has_many :captions
+
     ### ACTIONS (UPLOAD, UPDATE, DELETE) ###
 
       # Uploads a thumbnail
@@ -527,7 +546,7 @@ module Yt
       # @raise [Yt::Errors::RequestError] if path_or_url is not a valid path
       #   or URL.
       def upload_thumbnail(path_or_url)
-        file = open(path_or_url, 'rb') rescue StringIO.new
+        file = URI.open(path_or_url) rescue StringIO.new
         session = resumable_sessions.insert file.size
 
         session.update(body: file) do |data|
@@ -667,7 +686,7 @@ module Yt
         snippet_keys = [:title, :description, :tags, :category_id]
         snippet = {keys: snippet_keys, sanitize_brackets: true}
         status_keys = [:privacy_status, :embeddable, :license,
-          :public_stats_viewable, :publish_at]
+          :public_stats_viewable, :publish_at, :self_declared_made_for_kids]
         {snippet: snippet, status: {keys: status_keys}}
       end
 

data/lib/yt/request.rb

@@ -197,8 +197,7 @@ module Yt
     #   for a couple of seconds might solve the connection issues.
     def run_again?
       refresh_token_and_retry? && sleep_and_retry?(1) ||
-      server_error? && sleep_and_retry?(3) ||
-      exceeded_quota? && sleep_and_retry?(3)
+      server_error? && sleep_and_retry?(3)
     end
 
     # Returns the list of server errors worth retrying the request once.

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.33.3'
+  VERSION = '0.34.0'
 end

data/lib/yt.rb

@@ -14,6 +14,7 @@ require 'yt/models/video_group'
 require 'yt/models/comment_thread'
 require 'yt/models/ownership'
 require 'yt/models/advertising_options_set'
+require 'yt/models/caption'
 
 # An object-oriented Ruby client for YouTube.
 # Helps creating applications that need to interact with YouTube objects.

data/yt.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://github.com/Fullscreen/yt"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.1'
 
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -22,14 +22,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport' # '3 (Ruby 1.9) or 4 (Ruby 2)'
+  spec.add_dependency 'activesupport'
 
   # For development / Code coverage / Documentation
-  spec.add_development_dependency 'bundler' #, '~> 1.0'
-  spec.add_development_dependency 'rspec' #, '~> 2.0'
-  spec.add_development_dependency 'rake' #, '~> 10.0'
-  spec.add_development_dependency 'yard' #, '~> 0.8.0'
-  spec.add_development_dependency 'coveralls' #, '~> 0.7.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  # spec.add_development_dependency 'yard'
+  # spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yt
 version: !ruby/object:Gem::Version
-  version: 0.33.3
+  version: 0.34.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,34 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +112,7 @@ description: Youtube V3 API client.
 email:
 - claudio@fullscreen.net
 executables:
+- console
 - yt
 extensions: []
 extra_rdoc_files: []
@@ -154,6 +127,7 @@ files:
 - README.md
 - Rakefile
 - YOUTUBE_IT.md
+- bin/console
 - bin/yt
 - gemfiles/Gemfile.activesupport-3.x
 - gemfiles/Gemfile.activesupport-4.x
@@ -179,6 +153,7 @@ files:
 - lib/yt/collections/base.rb
 - lib/yt/collections/bulk_report_jobs.rb
 - lib/yt/collections/bulk_reports.rb
+- lib/yt/collections/captions.rb
 - lib/yt/collections/channels.rb
 - lib/yt/collections/claim_histories.rb
 - lib/yt/collections/claims.rb
@@ -232,6 +207,7 @@ files:
 - lib/yt/models/base.rb
 - lib/yt/models/bulk_report.rb
 - lib/yt/models/bulk_report_job.rb
+- lib/yt/models/caption.rb
 - lib/yt/models/channel.rb
 - lib/yt/models/claim.rb
 - lib/yt/models/claim_event.rb
@@ -247,7 +223,6 @@ files:
 - lib/yt/models/group_info.rb
 - lib/yt/models/group_item.rb
 - lib/yt/models/id.rb
-- lib/yt/models/iterator.rb
 - lib/yt/models/live_streaming_detail.rb
 - lib/yt/models/match_policy.rb
 - lib/yt/models/ownership.rb
@@ -287,14 +262,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Yt makes it easy to interact with Youtube V3 API by providing a modular,

data/lib/yt/models/iterator.rb

@@ -1,16 +0,0 @@
-module Yt
-  module Models
-    # @private
-    # If we dropped support for Ruby 1.9.3, then we could simply use Enumerator
-    # which takes a `size` parameter in Ruby >= 2.
-    class Iterator < Enumerator
-      def initialize(size=nil, &block)
-        RUBY_VERSION < '2' ? super(&block) : super(size, &block)
-      end
-
-      def size
-        RUBY_VERSION < '2' ? count : super
-      end
-    end
-  end
-end