yt 0.25.13 → 0.32.2

data/lib/yt/models/group_info.rb

@@ -0,0 +1,16 @@
+module Yt
+  module Models
+    class GroupInfo < Base
+      attr_reader :data
+
+      def initialize(options = {})
+        @data = options[:data]['snippet'].merge options[:data]['contentDetails']
+        @auth = options[:auth]
+      end
+
+      has_attribute :title, default: ''
+      has_attribute :item_count, type: Integer
+      has_attribute :published_at, type: Time
+    end
+  end
+end

data/lib/yt/models/group_item.rb

@@ -0,0 +1,15 @@
+require 'yt/models/video'
+
+module Yt
+  module Models
+    class GroupItem < Base
+      attr_reader :auth, :data, :video
+
+      def initialize(options = {})
+        @data = options[:data]
+        @auth = options[:auth]
+        @video = options[:video] if options[:video]
+      end
+    end
+  end
+end

data/lib/yt/models/resource.rb

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 
 require 'yt/models/base'
-require 'yt/models/url'
 
 module Yt
   module Models
@@ -13,7 +12,7 @@ module Yt
 
       # @!attribute [r] id
       #   @return [String] the ID that YouTube uses to identify each resource.
-      has_one :id
+      attr_reader :id
 
     ### STATUS ###
 
@@ -43,8 +42,7 @@ module Yt
 
       # @private
       def initialize(options = {})
-        @url = URL.new(options[:url]) if options[:url]
-        @id = options[:id] || (@url.id if @url)
+        @id = options[:id]
         @auth = options[:auth]
         @snippet = Snippet.new(data: options[:snippet]) if options[:snippet]
         @status = Status.new(data: options[:status]) if options[:status]
@@ -52,12 +50,7 @@ module Yt
 
       # @private
       def kind
-        @url ? @url.kind.to_s : self.class.to_s.demodulize.underscore
-      end
-
-      # @private
-      def username
-        @url.username if @url
+        self.class.to_s.demodulize.underscore
       end
 
       # @private

data/lib/yt/models/revocation.rb

@@ -0,0 +1,12 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    # @private
+    class Revocation < Base
+      def initialize(options = {})
+        @data = options[:data]
+      end
+    end
+  end
+end

data/lib/yt/models/right_owner.rb

@@ -1,5 +1,3 @@
-require 'yt/models/description'
-
 module Yt
   module Models
     # Encapsulates information about the various types of owners of an asset.

data/lib/yt/models/snippet.rb

@@ -1,4 +1,4 @@
-require 'yt/models/description'
+require 'yt/models/comment'
 
 module Yt
   module Models
@@ -8,6 +8,8 @@ module Yt
     # @see https://developers.google.com/youtube/v3/docs/videos#resource
     # @see https://developers.google.com/youtube/v3/docs/playlists#resource
     # @see https://developers.google.com/youtube/v3/docs/playlistItems#resource
+    # @see https://developers.google.com/youtube/v3/docs/commentThreads#resource
+    # @see https://developers.google.com/youtube/v3/docs/comments#resource
     class Snippet < Base
       attr_reader :data
 
@@ -17,7 +19,7 @@ module Yt
       end
 
       has_attribute :title, default: ''
-      has_attribute(:description, default: '') {|text| Description.new text}
+      has_attribute :description, default: ''
       has_attribute :published_at, type: Time
       has_attribute :channel_id
       has_attribute :channel_title
@@ -28,11 +30,30 @@ module Yt
       has_attribute :position, type: Integer
       has_attribute :resource_id, default: {}
       has_attribute :thumbnails, default: {}
+      has_attribute :video_id
+      has_attribute :total_reply_count, type: Integer
+      has_attribute :author_display_name
+      has_attribute :text_display
+      has_attribute :parent_id
+      has_attribute :like_count, type: Integer
+      has_attribute :updated_at, type: Time
 
       def thumbnail_url(size = :default)
         thumbnails.fetch(size.to_s, {})['url']
       end
 
+      def public?
+        @public ||= data.fetch 'isPublic', false
+      end
+
+      def can_reply?
+        @can_reply ||= data.fetch 'canReply', false
+      end
+
+      def top_level_comment
+        @top_level_comment ||= Yt::Comment.new data['topLevelComment'].symbolize_keys
+      end
+
       # Returns whether YouTube API includes all attributes in this snippet.
       # For instance, YouTube API only returns tags and categoryId on
       # Videos#list, not on Videos#search. And returns position on
@@ -47,4 +68,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/video.rb

@@ -37,6 +37,11 @@ module Yt
       #   @return [String] the title of the channel that the video belongs to.
       delegate :channel_title, to: :snippet
 
+      # @return [<String>] the URL of the channel that the video belongs to.
+      def channel_url
+        "https://www.youtube.com/channel/#{channel_id}"
+      end
+
       # @!attribute [r] live_broadcast_content
       #   @return [String] the type of live broadcast that the video contains.
       #     Possible values are: +'live'+, +'none'+, +'upcoming'+.
@@ -226,6 +231,10 @@ module Yt
       #   @return [Integer] the duration of the video (in seconds).
       delegate :duration, to: :content_detail
 
+      # @!attribute [r] duration
+      #   @return [String] the length of the video as an ISO 8601 time, HH:MM:SS.
+      delegate :length, to: :content_detail
+
       # @return [Boolean] whether the video is available in 3D.
       def stereoscopic?
         content_detail.dimension == '3d'
@@ -369,6 +378,9 @@ module Yt
       delegate :concurrent_viewers, to: :live_streaming_detail
 
     ### ASSOCIATIONS ###
+      # @!attribute [r] comments
+      #   @return [Yt::Collections::Comments] the video’s comments.
+      has_many :comment_threads
 
       # @!attribute [r] annotations
       #   @return [Yt::Collections::Annotations] the video’s annotations.
@@ -376,6 +388,13 @@ module Yt
 
       has_many :resumable_sessions
 
+      # @!attribute [r] channel
+      #   @return [Yt::Models::Claim, nil] the first claim on the video by
+      #     the content owner of the video, if eagerly loaded.
+      def claim
+        @claim
+      end
+
     ### ANALYTICS ###
 
       # @macro reports
@@ -383,9 +402,6 @@ module Yt
       # @macro report_by_video_dimensions
       has_report :views, Integer
 
-      # @macro report_by_day
-      has_report :uniques, Integer
-
       # @macro report_by_video_dimensions
       has_report :estimated_minutes_watched, Integer
 
@@ -414,12 +430,6 @@ module Yt
       # @macro report_by_day_and_country
       has_report :subscribers_lost, Integer
 
-      # @macro report_by_day_and_country
-      has_report :favorites_added, Integer
-
-      # @macro report_by_day_and_country
-      has_report :favorites_removed, Integer
-
       # @macro report_by_day_and_country
       has_report :videos_added_to_playlists, Integer
 
@@ -441,11 +451,29 @@ module Yt
       # @macro report_by_day_and_state
       has_report :annotation_close_rate, Float
 
+      # @macro report_by_day_and_state
+      has_report :card_impressions, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_clicks, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_click_rate, Float
+
+      # @macro report_by_day_and_state
+      has_report :card_teaser_impressions, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_teaser_clicks, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_teaser_click_rate, Float
+
       # @macro report_by_day_and_country
-      has_report :earnings, Float
+      has_report :estimated_revenue, Float
 
       # @macro report_by_day_and_country
-      has_report :impressions, Integer
+      has_report :ad_impressions, Integer
 
       # @macro report_by_day_and_country
       has_report :monetized_playbacks, Integer
@@ -576,6 +604,9 @@ module Yt
         if options[:player]
           @player = Player.new data: options[:player]
         end
+        if options[:claim]
+          @claim = options[:claim]
+        end
       end
 
       # @private

data/lib/yt/models/video_group.rb

@@ -0,0 +1,186 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube Analytics video-groups.
+    # @see https://developers.google.com/youtube/analytics/v1/reference/groups
+    class VideoGroup < Base
+      # @private
+      attr_reader :id, :auth
+
+    ### GROUP INFO ###
+
+      has_one :group_info
+
+      # @!attribute [r] title
+      #   @return [String] the title of the group.
+      delegate :title, to: :group_info
+
+      # @!attribute [r] item_count
+      #   @return [Integer] the number of resources in the group.
+      delegate :item_count, to: :group_info
+
+      # @!attribute [r] published_at
+      #   @return [Time] the date and time when the group was created.
+      delegate :published_at, to: :group_info
+
+    ### ASSOCIATIONS ###
+
+      # @!attribute [r] group_items
+      #   @return [Yt::Collections::GroupItems] the group’s items.
+      has_many :group_items
+
+    ### ANALYTICS ###
+
+      # @macro reports
+
+      # @macro report_by_video_dimensions
+      has_report :views, Integer
+
+      # @macro report_by_video_dimensions
+      has_report :estimated_minutes_watched, Integer
+
+      # @macro report_by_gender_and_age_group
+      has_report :viewer_percentage, Float
+
+      # @macro report_by_day_and_country
+      has_report :comments, Integer
+
+      # @macro report_by_day_and_country
+      has_report :likes, Integer
+
+      # @macro report_by_day_and_country
+      has_report :dislikes, Integer
+
+      # @macro report_by_day_and_country
+      has_report :shares, Integer
+
+      # @note This is not the total number of subscribers gained by the video’s
+      #   channel, but the subscribers gained *from* the video’s page.
+      # @macro report_by_day_and_country
+      has_report :subscribers_gained, Integer
+
+      # @note This is not the total number of subscribers lost by the video’s
+      #   channel, but the subscribers lost *from* the video’s page.
+      # @macro report_by_day_and_country
+      has_report :subscribers_lost, Integer
+
+      # @macro report_by_day_and_country
+      has_report :videos_added_to_playlists, Integer
+
+      # @macro report_by_day_and_country
+      has_report :videos_removed_from_playlists, Integer
+
+      # @macro report_by_day_and_state
+      has_report :average_view_duration, Integer
+
+      # @macro report_by_day_and_state
+      has_report :average_view_percentage, Float
+
+      # @macro report_by_day_and_state
+      has_report :annotation_clicks, Integer
+
+      # @macro report_by_day_and_state
+      has_report :annotation_click_through_rate, Float
+
+      # @macro report_by_day_and_state
+      has_report :annotation_close_rate, Float
+
+      # @macro report_by_day_and_state
+      has_report :card_impressions, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_clicks, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_click_rate, Float
+
+      # @macro report_by_day_and_state
+      has_report :card_teaser_impressions, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_teaser_clicks, Integer
+
+      # @macro report_by_day_and_state
+      has_report :card_teaser_click_rate, Float
+
+      # @macro report_by_day_and_country
+      has_report :estimated_revenue, Float
+
+      # @macro report_by_day_and_country
+      has_report :ad_impressions, Integer
+
+      # @macro report_by_day_and_country
+      has_report :monetized_playbacks, Integer
+
+      # @macro report_by_day_and_country
+      has_report :playback_based_cpm, Float
+
+    ### PRIVATE API ###
+
+      # @private
+      def initialize(options = {})
+        @id = options[:id]
+        @auth = options[:auth]
+        @group_info = options[:group_info] if options[:group_info]
+      end
+
+      # @private
+      # Tells `has_reports` to retrieve group reports from the Analytics API.
+      def reports_params
+        {}.tap do |params|
+          if auth.owner_name
+            params[:ids] = "contentOwner==#{auth.owner_name}"
+          else
+            params[:ids] = "channel==mine"
+          end
+          params[:filters] = "group==#{id}"
+        end
+      end
+
+      def all_video_ids
+        resource_ids = group_items.map{|item| item.data['resource']['id']}.uniq
+        case group_info.data["itemType"]
+        when "youtube#video"
+          resource_ids
+        when "youtube#channel"
+          resource_ids.flat_map do |channel_id|
+            Yt::Channel.new(id: channel_id, auth: @auth).videos.map(&:id)
+          end
+        else
+          []
+        end
+      end
+
+      def videos
+        all_video_ids.each_slice(50).flat_map do |video_ids|
+          conditions = {id: video_ids.join(',')}
+          conditions[:part] = 'snippet,status,statistics,contentDetails'
+          Collections::Videos.new(auth: @auth).where(conditions).map(&:itself)
+        end
+      end
+
+      def all_channel_ids
+        resource_ids = group_items.map {|item| item.data['resource']['id']}.uniq
+        case group_info.data['itemType']
+        when "youtube#video"
+          resource_ids.flat_map do |video_id|
+            Yt::Video.new(id: video_id, auth: @auth).channel_id
+          end.uniq
+        when "youtube#channel"
+          resource_ids
+        else
+          []
+        end
+      end
+
+      def channels
+        all_channel_ids.each_slice(50).flat_map do |channel_ids|
+          conditions = {id: channel_ids.join(',')}
+          conditions[:part] = 'snippet'
+          Collections::Channels.new(auth: @auth).where(conditions).map(&:itself)
+        end
+      end
+    end
+  end
+end