yt 0.25.13 → 0.32.2

data/YOUTUBE_IT.md

@@ -141,7 +141,7 @@ client = YouTubeIt::Client.new
 client.videos_by(:query => "penguin",  :author => "liz")
 # with yt: the 'author' filter was removed from YouTube API V3, so the
 # request must be done using the channel of the requested author
-channel = Yt::Channel.new url: 'youtube.com/liz'
+channel = Yt::Channel.new id: 'UCxxxxxxxxx'
 channel.videos.where(q: 'penguin')
 ```
 
@@ -176,7 +176,7 @@ client = YouTubeIt::Client.new
 client.videos_by(:user => 'liz')
 # with yt: the 'author' filter was removed from YouTube API V3, so the
 # request must be done using the channel of the requested author
-channel = Yt::Channel.new url: 'youtube.com/liz'
+channel = Yt::Channel.new id: 'UCxxxxxxxxx'
 channel.videos.where(q: 'penguin')
 ```
 
@@ -188,7 +188,7 @@ client = YouTubeIt::Client.new
 client.videos_by(:favorites, :user => 'liz')
 # with yt: note that only *old* channels have a "Favorites" playlist, since
 # "Favorites" has been deprecated by YouTube in favor of "Liked Videos".
-channel = Yt::Channel.new url: 'youtube.com/liz'
+channel = Yt::Channel.new id: 'UCxxxxxxxxx'
 channel.related_playlists.find{|p| p.title == 'Favorites'}
 ```
 

data/lib/yt.rb

@@ -1,5 +1,6 @@
 require 'yt/config'
 require 'yt/version'
+require 'yt/constants/geography'
 require 'yt/models/account'
 require 'yt/models/channel'
 require 'yt/models/claim'
@@ -9,13 +10,15 @@ require 'yt/models/match_policy'
 require 'yt/models/playlist'
 require 'yt/models/playlist_item'
 require 'yt/models/video'
+require 'yt/models/video_group'
+require 'yt/models/comment_thread'
 require 'yt/models/ownership'
 require 'yt/models/advertising_options_set'
 
 # An object-oriented Ruby client for YouTube.
 # Helps creating applications that need to interact with YouTube objects.
 # Inclused methods to access YouTube Data API V3 resources (channels, videos,
-# ...), YouTube Analytics API V2 resources (metrics, earnings, ...), and
+# ...), YouTube Analytics API V2 resources (metrics, estimated_revenue, ...), and
 # objects not available through the API (annotations).
 module Yt
-end
+end

data/lib/yt/actions/list.rb

@@ -6,7 +6,7 @@ require 'yt/config'
 module Yt
   module Actions
     module List
-      delegate :any?, :count, :each, :each_cons, :each_slice, :find, :first,
+      delegate :any?, :count, :each, :each_cons, :each_slice, :find, :first, :take,
         :flat_map, :map, :select, :size, to: :list
 
       def first!
@@ -47,7 +47,7 @@ module Yt
       def find_next
         @items ||= []
         if @items[@last_index].nil? && more_pages?
-          more_items = next_page.map{|data| new_item data}
+          more_items = next_page.map{|data| new_item data}.compact
           @items.concat more_items
         end
         @items[(@last_index +=1) -1]
@@ -136,4 +136,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/associations/has_authentication.rb

@@ -9,6 +9,7 @@ module Yt
       def has_authentication
         require 'yt/collections/authentications'
         require 'yt/collections/device_flows'
+        require 'yt/collections/revocations'
         require 'yt/errors/missing_auth'
         require 'yt/errors/no_items'
         require 'yt/errors/unauthorized'
@@ -57,7 +58,31 @@ module Yt
       def refreshed_access_token?
         old_access_token = authentication.access_token
         @authentication = @access_token = @refreshed_authentications = nil
-        old_access_token != authentication.access_token
+
+        if old_access_token != authentication.access_token
+          access_token_was_refreshed
+          true
+        else
+          false
+        end
+      end
+
+      # Revoke access given to the application.
+      # Returns true if the access was correctly revoked.
+      # @see https://developers.google.com/identity/protocols/OAuth2WebServer#tokenrevoke
+      def revoke_access
+        revocations.first!
+        @authentication = @access_token = @refreshed_authentications = nil
+        true
+      rescue Errors::RequestError => e
+        raise unless e.reasons.include? 'invalid_token'
+        false
+      end
+
+      # Invoked when the access token is refreshed.
+      def access_token_was_refreshed
+        # Apps using Yt can override this method to handle this event, for
+        # instance to store the newly generated access token in the database.
       end
 
     private
@@ -103,6 +128,7 @@ module Yt
         error_message = case
           when @redirect_uri && @scopes then missing_authorization_code_message
           when @scopes then pending_device_code_message
+          else {}
         end
         raise Errors::MissingAuth, error_message
       end
@@ -149,6 +175,12 @@ module Yt
         end
       end
 
+      def revocations
+        @revocations ||= Collections::Revocations.of(self).tap do |auth|
+          auth.auth_params = {token: @refresh_token || @access_token}
+        end
+      end
+
       def authentication_url_params
         {}.tap do |params|
           params[:client_id] = client_id

data/lib/yt/associations/has_reports.rb

@@ -206,18 +206,17 @@ module Yt
       #   @macro report
       #   @macro report_with_country_and_state
 
-      # Defines two public instance methods to access the reports of a
+      # Defines a public instance methods to access the reports of a
       # resource for a specific metric.
       # @param [Symbol] metric the metric to access the reports of.
       # @param [Class] type The class to cast the returned values to.
-      # @example Adds +comments+ and +comments_on+ on a Channel resource.
+      # @example Adds +comments+ on a Channel resource.
       #   class Channel < Resource
       #     has_report :comments, Integer
       #   end
       def has_report(metric, type)
         require 'yt/collections/reports'
 
-        define_metric_on_method metric
         define_metric_method metric
         define_reports_method metric, type
         define_range_metric_method metric
@@ -226,12 +225,6 @@ module Yt
 
     private
 
-      def define_metric_on_method(metric)
-        define_method "#{metric}_on" do |date|
-          send(metric, from: date, to: date, by: :day).values.first
-        end
-      end
-
       def define_reports_method(metric, type)
         (@metrics ||= {})[metric] = type
         define_method :reports do |options = {}|
@@ -242,6 +235,7 @@ module Yt
           state = location[:state] if location.is_a?(Hash)
           dimension = options[:by] || (metric == :viewer_percentage ? :gender_age_group : :range)
           videos = options[:videos]
+          historical = options[:historical].to_s if [true, false].include?(options[:historical])
           if dimension == :month
             from = from.to_date.beginning_of_month
             to = to.to_date.beginning_of_month
@@ -250,9 +244,9 @@ module Yt
 
           only = options.fetch :only, []
           reports = Collections::Reports.of(self).tap do |reports|
-            reports.metrics =  self.class.instance_variable_get(:@metrics).select{|k, v| k.in? only}
+            reports.metrics = self.class.instance_variable_get(:@metrics).select{|k, v| k.in? only}
           end
-          reports.within date_range, country, state, dimension, videos
+          reports.within date_range, country, state, dimension, videos, historical
         end unless defined?(reports)
       end
 
@@ -265,6 +259,7 @@ module Yt
           state = location[:state] if location.is_a?(Hash)
           dimension = options[:by] || (metric == :viewer_percentage ? :gender_age_group : :range)
           videos = options[:videos]
+          historical = options[:historical].to_s if [true, false].include?(options[:historical])
           if dimension == :month
             from = from.to_date.beginning_of_month
             to = to.to_date.beginning_of_month
@@ -276,10 +271,10 @@ module Yt
           results = case dimension
           when :day
             Hash[*range.flat_map do |date|
-              [date, instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[date] ||= send("range_#{metric}", range, dimension, country, state, videos)[date]]
+              [date, instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[date] ||= send("range_#{metric}", range, dimension, country, state, videos, historical)[date]]
             end]
           else
-            instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[range] ||= send("range_#{metric}", range, dimension, country, state, videos)
+            instance_variable_get("@#{metric}_#{dimension}_#{country}_#{state}")[range] ||= send("range_#{metric}", range, dimension, country, state, videos, historical)
           end
           lookup_class = case options[:by]
             when :video, :related_video then Yt::Collections::Videos
@@ -296,25 +291,25 @@ module Yt
       end
 
       def define_range_metric_method(metric)
-        define_method "range_#{metric}" do |date_range, dimension, country, state, videos|
+        define_method "range_#{metric}" do |date_range, dimension, country, state, videos, historical|
           ivar = instance_variable_get "@range_#{metric}_#{dimension}_#{country}_#{state}"
           instance_variable_set "@range_#{metric}_#{dimension}_#{country}_#{state}", ivar || {}
-          instance_variable_get("@range_#{metric}_#{dimension}_#{country}_#{state}")[date_range] ||= send("all_#{metric}").within date_range, country, state, dimension, videos
+          instance_variable_get("@range_#{metric}_#{dimension}_#{country}_#{state}")[date_range] ||= send("all_#{metric}").within date_range, country, state, dimension, videos, historical
         end
         private "range_#{metric}"
       end
 
       def define_all_metric_method(metric, type)
         define_method "all_#{metric}" do
-          # @note Asking for the "earnings" metric of a day in which a channel
+          # @note Asking for the "estimated_revenue" metric of a day in which a channel
           # made 0 USD returns the wrong "nil". But adding to the request the
           # "estimatedMinutesWatched" metric returns the correct value 0.
           metrics = {metric => type}
-          metrics[:estimated_minutes_watched] = Integer if metric == :earnings
+          metrics[:estimated_minutes_watched] = Integer if metric == :estimated_revenue
           Collections::Reports.of(self).tap{|reports| reports.metrics = metrics}
         end
         private "all_#{metric}"
       end
     end
   end
-end
+end

data/lib/yt/collections/assets.rb

@@ -39,7 +39,7 @@ module Yt
       #   is accessed; it should be replaced with a filter on params instead.
       def assets_path
         @where_params ||= {}
-        if @where_params.empty? || @where_params.key?(:id)
+        if @where_params.key?(:id)
           '/youtube/partner/v1/assets'
         else
           '/youtube/partner/v1/assetSearch'
@@ -55,4 +55,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/collections/authentications.rb

@@ -40,8 +40,15 @@ module Yt
       end
 
       def expected?(error)
-        error.kind == 'invalid_grant'
+        error.kind == 'invalid_grant' &&
+          invalid_code_errors.exclude?(error.description)
+      end
+
+    private
+
+      def invalid_code_errors
+        ["Code was already redeemed.", "Invalid code."]
       end
     end
   end
-end
+end

data/lib/yt/collections/base.rb

@@ -31,9 +31,9 @@ module Yt
       # are at https://developers.google.com/youtube/v3/docs/search/list
       #
       # @example Return the first video of a channel (no requirements):
-      #   video.channels.first
+      #   channel.videos.first
       # @example Return the first long video of a channel by video count:
-      #   video.channels.where(order: 'viewCount', video_duration: 'long').first
+      #   channel.videos.where(order: 'viewCount', video_duration: 'long').first
       def where(requirements = {})
         self.tap do
           @items = []
@@ -59,4 +59,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/collections/bulk_report_jobs.rb

@@ -0,0 +1,28 @@
+require 'yt/collections/base'
+require 'yt/models/bulk_report_job'
+
+module Yt
+  module Collections
+    # @private
+    class BulkReportJobs < Base
+
+    private
+
+      def attributes_for_new_item(data)
+        {id: data['id'], auth: @auth, report_type_id: data['reportTypeId']}
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:host] = 'youtubereporting.googleapis.com'
+          params[:path] = "/v1/jobs"
+          params[:params] = {on_behalf_of_content_owner: @parent.owner_name}
+        end
+      end
+
+      def items_key
+        'jobs'
+      end
+    end
+  end
+end

data/lib/yt/collections/bulk_reports.rb

@@ -0,0 +1,24 @@
+require 'yt/collections/base'
+require 'yt/models/bulk_report'
+
+module Yt
+  module Collections
+    # @private
+    class BulkReports < Base
+
+    private
+
+      def list_params
+        super.tap do |params|
+          params[:host] = 'youtubereporting.googleapis.com'
+          params[:path] = "/v1/jobs/#{@parent.id}/reports"
+          params[:params] = {on_behalf_of_content_owner: @parent.auth.owner_name}
+        end
+      end
+
+      def items_key
+        'reports'
+      end
+    end
+  end
+end

data/lib/yt/collections/claims.rb

@@ -17,6 +17,27 @@ module Yt
 
     private
 
+      def attributes_for_new_item(data)
+        {}.tap do |attributes|
+          attributes[:id] = data['id']
+          attributes[:auth] = @auth
+          attributes[:data] = data
+          attributes[:asset] = data['asset']
+        end
+      end
+
+      def eager_load_items_from(items)
+        if included_relationships.include? :asset
+          asset_ids = items.map{|a| a.values_at 'videoId', 'assetId'}.to_h.values
+          conditions = { id: asset_ids.join(','), fetch_metadata: 'effective' }
+          assets = @parent.assets.where conditions
+          items.each do |item|
+            item['asset'] = assets.find { |a| a.id == item['assetId'] }
+          end
+        end
+        super
+      end
+
       # @return [Hash] the parameters to submit to YouTube to list claims
       #   administered by the content owner.
       # @see https://developers.google.com/youtube/partner/docs/v1/claims/list
@@ -53,4 +74,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/collections/comment_threads.rb

@@ -0,0 +1,41 @@
+require 'yt/collections/base'
+require 'yt/models/video'
+require 'yt/models/channel'
+
+module Yt
+  module Collections
+    # @private
+    class CommentThreads < Base
+
+    private
+
+      def attributes_for_new_item(data)
+        {}.tap do |attributes|
+          attributes[:id] = data['id']
+          attributes[:snippet] = data['snippet']
+          attributes[:auth] = @auth
+        end
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get the resource.
+      # @see https://developers.google.com/youtube/v3/docs/commentThreads#resource
+      def list_params
+        super.tap do |params|
+          params[:path] = "/youtube/v3/commentThreads"
+          params[:params] = comments_params
+        end
+      end
+
+      def comments_params
+        apply_where_params!({max_results: 100, part: 'snippet'}).tap do |params|
+          case @parent
+          when Yt::Video
+            params[:videoId] = @parent.id
+          when Yt::Channel
+            params[:channelId] = @parent.id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/content_owners.rb

@@ -11,7 +11,7 @@ module Yt
     private
 
       def attributes_for_new_item(data)
-        {owner_name: data['id'], authentication: @auth.authentication}
+        {owner_name: data['id'], display_name: data['displayName'], authentication: @auth.authentication}
       end
 
       # @return [Hash] the parameters to submit to YouTube to list content

data/lib/yt/collections/group_infos.rb

@@ -0,0 +1,27 @@
+require 'yt/collections/base'
+require 'yt/models/snippet'
+
+module Yt
+  module Collections
+    # @private
+    class GroupInfos < Base
+
+    private
+
+      def attributes_for_new_item(data)
+        {data: data, auth: @auth}
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:host] = 'youtubeanalytics.googleapis.com'
+          params[:path] = "/v2/groups"
+          params[:params] = {id: @parent.id}
+          if @auth.owner_name
+            params[:params][:on_behalf_of_content_owner] = @auth.owner_name
+          end
+        end
+      end
+    end
+  end
+end