yt 0.21.0 → 0.22.0

data/lib/yt/associations/has_reports.rb

@@ -13,11 +13,16 @@ module Yt
       #     Also aliased as +:to+.
 
       # @!macro [new] report_with_day
-      #   @return [Hash<Date, Float>] if grouped by day, the $1
+      #   @return [Hash<Date, $2>] if grouped by day, the $1
       #     for each day in the time-range.
       #   @example Get the $1 for each day of last week:
       #     resource.$1 since: 2.weeks.ago, until: 1.week.ago, by: :day
       #     # => {Wed, 8 May 2014 => 12.0, Thu, 9 May 2014 => 34.2, …}
+      #   @return [Hash<Symbol, $2>] if grouped by range, the $1
+      #     for the entire time-range (under the key +:total+).
+      #   @example Get the $1 for the whole last week:
+      #     resource.$1 since: 2.weeks.ago, until: 1.week.ago, by: :range
+      #     # => {Wed, 8 May 2014..Tue, 14 May 2014 => 564.0,}
       #   @macro report
 
       # @!macro [new] report_by_day
@@ -26,22 +31,22 @@ module Yt
       #   @macro report_with_day
 
       # @!macro [new] report_with_video_dimensions
-      #   @return [Hash<Symbol, Float>] if grouped by playback location, the
+      #   @return [Hash<Symbol, $2>] if grouped by playback location, the
       #     $1 for each traffic playback location.
       #   @example Get yesterday’s $1 grouped by playback location:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :playback_location
       #     # => {embedded: 53.0, watch: 467.0, …}
-      #   @return [Hash<Yt::Video, Float>] if grouped by related video, the
+      #   @return [Hash<Yt::Video, $2>] if grouped by related video, the
       #     $1 for each related video.
       #   @example Get yesterday’s $1 by related video:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :related_video
       #     # => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}
-      #   @return [Hash<Yt::Video, Float>] if grouped by device type, the
+      #   @return [Hash<Yt::Video, $2>] if grouped by device type, the
       #     $1 for each device type.
       #   @example Get yesterday’s $1 by device type:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :device_type
       #     # => {mobile: 133.0, tv: 412.0, …}
-      #   @return [Hash<Yt::Video, Float>] if grouped by traffic source, the
+      #   @return [Hash<Yt::Video, $2>] if grouped by traffic source, the
       #     $1 for each traffic source.
       #   @example Get yesterday’s $1 by traffic source:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :traffic_source
@@ -52,7 +57,7 @@ module Yt
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
       #     Accepted values are: +:day+, +:traffic_source+,
       #     +:playback_location+, +:related_video+, +:embedded_player_location+.
-      #   @return [Hash<Symbol, Float>] if grouped by embedded player location,
+      #   @return [Hash<Symbol, $2>] if grouped by embedded player location,
       #     the $1 for each embedded player location.
       #   @example Get yesterday’s $1 by embedded player location:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :embedded_player_location
@@ -60,12 +65,12 @@ module Yt
       #   @macro report_with_video_dimensions
 
       # @!macro [new] report_with_channel_dimensions
-      #   @return [Hash<Yt::Video, Float>] if grouped by video, the
+      #   @return [Hash<Yt::Video, $2>] if grouped by video, the
       #     $1 for each video.
       #   @example Get yesterday’s $1 by video:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :video
       #     # => {#<Yt::Video @id=…> => 33.0, #<Yt::Video @id=…> => 12.0, …}
-      #   @return [Hash<Yt::Video, Float>] if grouped by playlist, the
+      #   @return [Hash<Yt::Video, $2>] if grouped by playlist, the
       #     $1 for each playlist.
       #   @example Get yesterday’s $1 by playlist:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :playlist
@@ -77,7 +82,7 @@ module Yt
       #     Accepted values are: +:day+, +:traffic_source+,
       #     +:playback_location+, +:related_video+, +:video+,
       #     +:playlist+, +:embedded_player_location+.
-      #   @return [Hash<Symbol, Float>] if grouped by embedded player location,
+      #   @return [Hash<Symbol, $2>] if grouped by embedded player location,
       #     the $1 for each embedded player location.
       #   @example Get yesterday’s $1 by embedded player location:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :embedded_player_location
@@ -95,17 +100,17 @@ module Yt
       #   @option options [Symbol] :by (:gender_age_group) The dimension to
       #     show viewer percentage by.
       #     Accepted values are: +:gender+, +:age_group+, +:gender_age_group+.
-      #   @return [Hash<Symbol, Float>] if grouped by gender, the
+      #   @return [Hash<Symbol, $2>] if grouped by gender, the
       #     viewer percentage by gender.
       #   @example Get yesterday’s viewer percentage by gender:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :gender
       #     # => {female: 53.0, male: 47.0}
-      #   @return [Hash<String, Float>] if grouped by age group, the
+      #   @return [Hash<String, $2>] if grouped by age group, the
       #     viewer percentage by age group.
       #   @example Get yesterday’s $1 grouped by age group:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago, by: :age_group
       #     # => {"18-24" => 4.54, "35-24" => 12.31, "45-34" => 8.92, …}
-      #   @return [Hash<Symbol, [Hash<String, Float>]>] if grouped by gender
+      #   @return [Hash<Symbol, [Hash<String, $2>]>] if grouped by gender
       #     and age group, the viewer percentage by gender/age group.
       #   @example Get yesterday’s $1 by gender and age group:
       #     resource.$1 from: 1.day.ago, to: 1.day.ago
@@ -115,16 +120,17 @@ module Yt
       # Defines two public instance methods to access the reports of a
       # resource for a specific metric.
       # @param [Symbol] metric the metric to access the reports of.
-      # @example Adds +earnings+ and +earnings_on+ on a Channel resource.
+      # @param [Class] type The class to cast the returned values to.
+      # @example Adds +comments+ and +comments_on+ on a Channel resource.
       #   class Channel < Resource
-      #     has_report :earnings
+      #     has_report :comments, Integer
       #   end
-      def has_report(metric)
+      def has_report(metric, type)
         require 'yt/collections/reports'
 
         define_metric_on_method metric
         define_metric_method metric
-        define_range_metric_method metric
+        define_range_metric_method metric, type
         define_all_metric_method metric
       end
 
@@ -157,11 +163,11 @@ module Yt
         end
       end
 
-      def define_range_metric_method(metric)
+      def define_range_metric_method(metric, type)
         define_method "range_#{metric}" do |date_range, dimension|
           ivar = instance_variable_get "@range_#{metric}_#{dimension}"
           instance_variable_set "@range_#{metric}_#{dimension}", ivar || {}
-          instance_variable_get("@range_#{metric}_#{dimension}")[date_range] ||= send("all_#{metric}").within date_range, dimension
+          instance_variable_get("@range_#{metric}_#{dimension}")[date_range] ||= send("all_#{metric}").within date_range, dimension, type
         end
         private "range_#{metric}"
       end

data/lib/yt/collections/authentications.rb

@@ -3,6 +3,7 @@ require 'yt/models/authentication'
 
 module Yt
   module Collections
+    # @private
     class Authentications < Base
       attr_accessor :auth_params
 

data/lib/yt/collections/content_details.rb

@@ -3,6 +3,7 @@ require 'yt/models/content_detail'
 
 module Yt
   module Collections
+    # @private
     class ContentDetails < Base
 
     private

data/lib/yt/collections/content_owner_details.rb

@@ -3,6 +3,7 @@ require 'yt/models/content_owner_detail'
 
 module Yt
   module Collections
+    # @private
     class ContentOwnerDetails < Base
 
     private

data/lib/yt/collections/file_details.rb

@@ -3,6 +3,7 @@ require 'yt/models/file_detail'
 
 module Yt
   module Collections
+    # @private
     class FileDetails < Base
 
     private

data/lib/yt/collections/ids.rb

@@ -3,6 +3,7 @@ require 'yt/models/id'
 
 module Yt
   module Collections
+    # @private
     class Ids < Base
 
     private

data/lib/yt/collections/live_streaming_details.rb

@@ -3,6 +3,7 @@ require 'yt/models/live_streaming_detail'
 
 module Yt
   module Collections
+    # @private
     class LiveStreamingDetails < Base
 
     private

data/lib/yt/collections/players.rb

@@ -3,6 +3,7 @@ require 'yt/models/player'
 
 module Yt
   module Collections
+    # @private
     class Players < Base
 
     private

data/lib/yt/collections/ratings.rb

@@ -3,6 +3,7 @@ require 'yt/models/rating'
 
 module Yt
   module Collections
+    # @private
     class Ratings < Base
 
     private

data/lib/yt/collections/reports.rb

@@ -2,18 +2,20 @@ require 'yt/collections/base'
 
 module Yt
   module Collections
+    # @private
     class Reports < Base
-      DIMENSIONS = Hash.new({name: 'day', parse: ->(day) {Date.iso8601 day} }).tap do |hash|
-        hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: ->(type) {TRAFFIC_SOURCES.key type} }
-        hash[:playback_location] = {name: 'insightPlaybackLocationType', parse: ->(type) {PLAYBACK_LOCATIONS.key type} }
-        hash[:embedded_player_location] = {name: 'insightPlaybackLocationDetail', parse: ->(url) {url} }
-        hash[:related_video] = {name: 'insightTrafficSourceDetail', parse: ->(video_id) { Yt::Video.new id: video_id, auth: @auth } }
-        hash[:video] = {name: 'video', parse: ->(video_id) { Yt::Video.new id: video_id, auth: @auth } }
-        hash[:playlist] = {name: 'playlist', parse: ->(playlist_id) { Yt::Playlist.new id: playlist_id, auth: @auth } }
-        hash[:device_type] = {name: 'deviceType', parse: ->(type) { type.downcase.to_sym } }
-        hash[:gender_age_group] = {name: 'gender,ageGroup', parse: ->(gender) { gender.downcase.to_sym }}
-        hash[:gender] = {name: 'gender', parse: ->(gender) { gender.downcase.to_sym } }
-        hash[:age_group] = {name: 'ageGroup', parse: ->(age_group) { age_group[3..-1] } }
+      DIMENSIONS = Hash.new({name: 'day', parse: ->(day, *values) {[Date.iso8601(day), values.last]} }).tap do |hash|
+        hash[:range] = {parse: ->(*values) { [:total, values.last]} }
+        hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: ->(source, value) {[TRAFFIC_SOURCES.key(source), value]} }
+        hash[:playback_location] = {name: 'insightPlaybackLocationType', parse: ->(location, value) {[PLAYBACK_LOCATIONS.key(location), value]} }
+        hash[:embedded_player_location] = {name: 'insightPlaybackLocationDetail', parse: ->(url, value) {[url, value]} }
+        hash[:related_video] = {name: 'insightTrafficSourceDetail', parse: ->(video_id, value) { [Yt::Video.new(id: video_id, auth: @auth), value] } }
+        hash[:video] = {name: 'video', parse: ->(video_id, value) { [Yt::Video.new(id: video_id, auth: @auth), value] } }
+        hash[:playlist] = {name: 'playlist', parse: ->(playlist_id, value) { [Yt::Playlist.new(id: playlist_id, auth: @auth), value] } }
+        hash[:device_type] = {name: 'deviceType', parse: ->(type, value) { [type.downcase.to_sym, value] } }
+        hash[:gender_age_group] = {name: 'gender,ageGroup', parse: ->(gender, *values) { [gender.downcase.to_sym, *values] }}
+        hash[:gender] = {name: 'gender', parse: ->(gender, value) { [gender.downcase.to_sym, value] } }
+        hash[:age_group] = {name: 'ageGroup', parse: ->(age_group, value) { [age_group[3..-1], value] } }
       end
 
       # @see https://developers.google.com/youtube/analytics/v1/dimsmets/dims#Traffic_Source_Dimensions
@@ -46,7 +48,7 @@ module Yt
 
       attr_writer :metric
 
-      def within(days_range, dimension, try_again = true)
+      def within(days_range, dimension, type, try_again = true)
         @days_range = days_range
         @dimension = dimension
         if dimension == :gender_age_group # array of array
@@ -54,7 +56,7 @@ module Yt
             each{|gender, age_group, value| hash[gender][age_group[3..-1]] = value}
           end
         else
-          Hash[*flat_map{|value| [value.first, value.last]}]
+          Hash[*flat_map{|value| [value.first, type_cast(value.last, type)]}]
         end
       # NOTE: Once in a while, YouTube responds with 400 Error and the message
       # "Invalid query. Query did not conform to the expectations."; in this
@@ -63,13 +65,20 @@ module Yt
       # same query is a workaround that works and can hardly cause any damage.
       # Similarly, once in while YouTube responds with a random 503 error.
       rescue Yt::Error => e
-        try_again && rescue?(e) ? sleep(3) && within(days_range, dimension, false) : raise
+        try_again && rescue?(e) ? sleep(3) && within(days_range, dimension, type, false) : raise
       end
 
     private
 
+      def type_cast(value, type)
+        case [type]
+          when [Integer] then value.to_i if value
+          when [Float] then value.to_f if value
+        end
+      end
+
       def new_item(data)
-        [instance_exec(data.first, &DIMENSIONS[@dimension][:parse]), *data[1..-1]]
+        instance_exec *data, &DIMENSIONS[@dimension][:parse]
       end
 
       # @see https://developers.google.com/youtube/analytics/v1/content_owner_reports
@@ -86,7 +95,7 @@ module Yt
           params['start-date'] = @days_range.begin
           params['end-date'] = @days_range.end
           params['metrics'] = @metric.to_s.camelize(:lower)
-          params['dimensions'] = DIMENSIONS[@dimension][:name]
+          params['dimensions'] = DIMENSIONS[@dimension][:name] unless @dimension == :range
           params['max-results'] = 10 if @dimension == :video
           params['max-results'] = 200 if @dimension == :playlist
           params['max-results'] = 25 if @dimension == :embedded_player_location

data/lib/yt/collections/resources.rb

@@ -3,6 +3,7 @@ require 'yt/collections/base'
 
 module Yt
   module Collections
+    # @private
     class Resources < Base
       def delete_all(params = {})
         do_delete_all params

data/lib/yt/collections/resumable_sessions.rb

@@ -3,6 +3,7 @@ require 'yt/models/resumable_session'
 
 module Yt
   module Collections
+    # @private
     # Provides methods to upload videos with the resumable upload protocol.
     #
     # Resources with resumable sessions are: {Yt::Models::Account accounts}.

data/lib/yt/collections/snippets.rb

@@ -3,6 +3,7 @@ require 'yt/models/snippet'
 
 module Yt
   module Collections
+    # @private
     class Snippets < Base
 
     private

data/lib/yt/collections/statistics_sets.rb

@@ -3,6 +3,7 @@ require 'yt/models/statistics_set'
 
 module Yt
   module Collections
+    # @private
     class StatisticsSets < Base
 
     private

data/lib/yt/collections/statuses.rb

@@ -3,6 +3,7 @@ require 'yt/models/status'
 
 module Yt
   module Collections
+    # @private
     class Statuses < Base
 
     private

data/lib/yt/collections/subscriptions.rb

@@ -3,6 +3,7 @@ require 'yt/models/subscription'
 
 module Yt
   module Collections
+    # @private
     class Subscriptions < Base
 
       def insert(options = {})

data/lib/yt/collections/user_infos.rb

@@ -3,6 +3,7 @@ require 'yt/models/user_info'
 
 module Yt
   module Collections
+    # @private
     class UserInfos < Base
 
     private

data/lib/yt/models/account.rb

@@ -12,11 +12,11 @@ module Yt
       has_one :user_info
 
       # @!attribute [r] id
-      # @return [String] the (Google+) account’s ID.
+      #   @return [String] the (Google+) account’s ID.
       delegate :id, to: :user_info
 
       # @!attribute [r] email
-      # @return [String] the account’s email address.
+      #   @return [String] the account’s email address.
       delegate :email, to: :user_info
 
       # @return [Boolean] whether the email address is verified.
@@ -25,15 +25,15 @@ module Yt
       end
 
       # @!attribute [r] name
-      # @return [String] the account’s full name.
+      #   @return [String] the account’s full name.
       delegate :name, to: :user_info
 
       # @!attribute [r] given_name
-      # @return [String] the user’s given (first) name.
+      #   @return [String] the user’s given (first) name.
       delegate :given_name, to: :user_info
 
       # @!attribute [r] family_name
-      # @return [String] the user’s family (last) name.
+      #   @return [String] the user’s family (last) name.
       delegate :family_name, to: :user_info
 
       # @return [String] the URL of the account’s (Google +) profile page.
@@ -97,27 +97,29 @@ module Yt
         playlists.insert params
       end
 
-      # Deletes the account’s playlists matching all the given attributes.
-      # @return [Array<Boolean>] whether each playlist matching the given
-      #   attributes was deleted.
-      # @param [Hash] attributes the attributes to match the playlists by.
-      # @option attributes [<String, Regexp>] :title The playlist’s title.
-      #   Pass a String for perfect match or a Regexp for advanced match.
-      # @option attributes [<String, Regexp>] :description The playlist’s
-      #   description. Pass a String (perfect match) or a Regexp (advanced).
-      # @option attributes [Array<String>] :tags The playlist’s tags.
-      #   All tags must match exactly.
-      # @option attributes [String] :privacy_status The playlist’s privacy
-      #   status.
+      # @!method delete_playlists(attributes = {})
+      #   Deletes the account’s playlists matching all the given attributes.
+      #   @return [Array<Boolean>] whether each playlist matching the given
+      #     attributes was deleted.
+      #   @param [Hash] attributes the attributes to match the playlists by.
+      #   @option attributes [<String, Regexp>] :title The playlist’s title.
+      #     Pass a String for perfect match or a Regexp for advanced match.
+      #   @option attributes [<String, Regexp>] :description The playlist’s
+      #     description. Pass a String (perfect match) or a Regexp (advanced).
+      #   @option attributes [Array<String>] :tags The playlist’s tags.
+      #     All tags must match exactly.
+      #   @option attributes [String] :privacy_status The playlist’s privacy
+      #     status.
       delegate :delete_playlists, to: :channel
 
     ### CONTENT OWNERS ###
 
       # @!attribute [r] content_owners
-      # @return [Yt::Collections::ContentOwners] the content owners that
-      #   the account can manage.
+      #   @return [Yt::Collections::ContentOwners] the content owners that
+      #     the account can manage.
       has_many :content_owners
 
+      # The name of the content owner managing the account.
       # @return [String] name of the CMS account, if the account is partnered.
       # @return [nil] if the account is not a partnered content owner.
       attr_reader :owner_name
@@ -125,16 +127,16 @@ module Yt
     ### ASSOCIATIONS ###
 
       # @!attribute [r] channel
-      # @return [Yt::Model::Channel] the YouTube channel of the account.
+      #   @return [Yt::Models::Channel] the YouTube channel of the account.
       has_one :channel
 
       # @!attribute [r] playlists
-      # @return [Yt::Collections::Playlists] the playlists owned by the account.
+      #   @return [Yt::Collections::Playlists] the playlists owned by the account.
       delegate :playlists, to: :channel
 
       # @!attribute [r] subscribed_channels
-      # @return [Yt::Collections::SubscribedChannels] the channels that the
-      #   account is subscribed to.
+      #   @return [Yt::Collections::SubscribedChannels] the channels that the
+      #     account is subscribed to.
       delegate :subscribed_channels, to: :channel
 
       # @!attribute [r] videos
@@ -142,12 +144,12 @@ module Yt
       has_many :videos
 
       # @!attribute [r] subscribers
-      # @return [Yt::Collections::Subscribers] the channels subscribed to
-      #   the account’s channel.
+      #   @return [Yt::Collections::Subscribers] the channels subscribed to
+      #     the account’s channel.
       has_many :subscribers
 
-      # @private
       # @!attribute [r] resumable_sessions
+      #   @private
       #   @return [Yt::Collections::ResumableSessions] the sessions used to
       #     upload videos using the resumable upload protocol.
       has_many :resumable_sessions

data/lib/yt/models/base.rb

@@ -12,6 +12,7 @@ require 'yt/errors/request_error'
 
 module Yt
   module Models
+    # @private
     class Base
       include Actions::Delete
       include Actions::Update

data/lib/yt/models/channel.rb

@@ -9,24 +9,24 @@ module Yt
     ### SNIPPET ###
 
       # @!attribute [r] title
-      # @return [String] the channel’s title.
+      #   @return [String] the channel’s title.
       delegate :title, to: :snippet
 
       # @!attribute [r] description
-      # @return [String] the channel’s description.
+      #   @return [String] the channel’s description.
       delegate :description, to: :snippet
 
-      # Returns the URL of the channel’s thumbnail.
       # @!method thumbnail_url(size = :default)
-      # @param [Symbol, String] size The size of the channel’s thumbnail.
-      # @return [String] if +size+ is +default+, the URL of a 88x88px image.
-      # @return [String] if +size+ is +medium+, the URL of a 240x240px image.
-      # @return [String] if +size+ is +high+, the URL of a 800x800px image.
-      # @return [nil] if the +size+ is not +default+, +medium+ or +high+.
+      #   Returns the URL of the channel’s thumbnail.
+      #   @param [Symbol, String] size The size of the channel’s thumbnail.
+      #   @return [String] if +size+ is +default+, the URL of a 88x88px image.
+      #   @return [String] if +size+ is +medium+, the URL of a 240x240px image.
+      #   @return [String] if +size+ is +high+, the URL of a 800x800px image.
+      #   @return [nil] if the +size+ is not +default+, +medium+ or +high+.
       delegate :thumbnail_url, to: :snippet
 
       # @!attribute [r] published_at
-      # @return [Time] the date and time that the channel was created.
+      #   @return [Time] the date and time that the channel was created.
       delegate :published_at, to: :snippet
 
     ### SUBSCRIPTION ###
@@ -104,80 +104,80 @@ module Yt
     ### ANALYTICS ###
 
       # @macro report_by_channel_dimensions
-      has_report :views
+      has_report :views, Integer
 
       # @macro report_by_channel_dimensions
-      has_report :estimated_minutes_watched
+      has_report :estimated_minutes_watched, Float
 
       # @macro report_by_gender_and_age_group
-      has_report :viewer_percentage
+      has_report :viewer_percentage, Float
 
       # @macro report_by_day
-      has_report :comments
+      has_report :comments, Integer
 
       # @macro report_by_day
-      has_report :likes
+      has_report :likes, Integer
 
       # @macro report_by_day
-      has_report :dislikes
+      has_report :dislikes, Integer
 
       # @macro report_by_day
-      has_report :shares
+      has_report :shares, Integer
 
       # @macro report_by_day
-      has_report :subscribers_gained
+      has_report :subscribers_gained, Integer
 
       # @macro report_by_day
-      has_report :subscribers_lost
+      has_report :subscribers_lost, Integer
 
       # @macro report_by_day
-      has_report :favorites_added
+      has_report :favorites_added, Integer
 
       # @macro report_by_day
-      has_report :favorites_removed
+      has_report :favorites_removed, Integer
 
       # @macro report_by_day
-      has_report :average_view_duration
+      has_report :average_view_duration, Float
 
       # @macro report_by_day
-      has_report :average_view_percentage
+      has_report :average_view_percentage, Float
 
       # @macro report_by_day
-      has_report :annotation_clicks
+      has_report :annotation_clicks, Integer
 
       # @macro report_by_day
-      has_report :annotation_click_through_rate
+      has_report :annotation_click_through_rate, Float
 
       # @macro report_by_day
-      has_report :annotation_close_rate
+      has_report :annotation_close_rate, Float
 
       # @macro report_by_day
-      has_report :earnings
+      has_report :earnings, Float
 
       # @macro report_by_day
-      has_report :impressions
+      has_report :impressions, Integer
 
       # @macro report_by_day
-      has_report :monetized_playbacks
+      has_report :monetized_playbacks, Integer
 
     ### STATISTICS ###
 
       has_one :statistics_set
 
       # @!attribute [r] view_count
-      # @return [Integer] the number of times the channel has been viewed.
+      #   @return [Integer] the number of times the channel has been viewed.
       delegate :view_count, to: :statistics_set
 
       # @!attribute [r] comment_count
-      # @return [Integer] the number of comments for the channel.
+      #   @return [Integer] the number of comments for the channel.
       delegate :comment_count, to: :statistics_set
 
       # @!attribute [r] video_count
-      # @return [Integer] the number of videos uploaded to the channel.
+      #   @return [Integer] the number of videos uploaded to the channel.
       delegate :video_count, to: :statistics_set
 
       # @!attribute [r] subscriber_count
-      # @return [Integer] the number of subscriber the channel has.
+      #   @return [Integer] the number of subscriber the channel has.
       delegate :subscriber_count, to: :statistics_set
 
       # @return [Boolean] whether the number of subscribers is publicly visible.
@@ -189,13 +189,13 @@ module Yt
 
       has_one :content_owner_detail
 
-      # The name of the content owner linked to the channel.
       # @!attribute [r] content_owner
-      # @return [String] if the channel is partnered, its content owner’s name.
-      # @return [nil] if the channel is not partnered or if {Resource#auth auth}
-      #   is a content owner without permissions to administer the channel.
-      # @raise [Yt::Errors::Forbidden] if {Resource#auth auth} does not
-      #   return an authenticated content owner.
+      #   The name of the content owner linked to the channel.
+      #   @return [String] if the channel is partnered, its content owner’s name.
+      #   @return [nil] if the channel is not partnered or if {Resource#auth auth}
+      #     is a content owner without permissions to administer the channel.
+      #   @raise [Yt::Errors::Forbidden] if {Resource#auth auth} does not
+      #     return an authenticated content owner.
       delegate :content_owner, to: :content_owner_detail
 
       # Returns the time the channel was partnered to a content owner.

data/lib/yt/models/content_detail.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Encapsulates information about the video content, including the length
     # of the video and an indication of whether captions are available.
     # @see https://developers.google.com/youtube/v3/docs/videos#resource

data/lib/yt/models/content_owner_detail.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Encapsulates channel data that is relevant for YouTube Partners linked
     # with the channel.
     # @see https://developers.google.com/youtube/v3/docs/channels#contentOwnerDetails