yt 0.21.0 → 0.22.0

data/lib/yt/models/device_flow.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     class DeviceFlow < Base
       def initialize(options = {})
         @data = options[:data]

data/lib/yt/models/file_detail.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Encapsulates basic information about the video file itself,
     # including the file name, size, type, and container.
     # @see https://developers.google.com/youtube/v3/docs/videos#fileDetails

data/lib/yt/models/iterator.rb

@@ -1,5 +1,6 @@
 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

data/lib/yt/models/live_streaming_detail.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Encapsulates information about a live video broadcast.
     # The object will only be present in a video resource if the video is an
     # upcoming, live, or completed live broadcast.

data/lib/yt/models/player.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Encapsulates information about a video player.
     # @see https://developers.google.com/youtube/v3/docs/videos#player
     class Player < Base

data/lib/yt/models/playlist.rb

@@ -9,36 +9,36 @@ module Yt
     ### SNIPPET ###
 
       # @!attribute [r] title
-      # @return [String] the playlist’s title.
+      #   @return [String] the playlist’s title.
       delegate :title, to: :snippet
 
       # @!attribute [r] description
-      # @return [String] the playlist’s description.
+      #   @return [String] the playlist’s description.
       delegate :description, to: :snippet
 
-      # Returns the URL of the playlist’s thumbnail.
       # @!method thumbnail_url(size = :default)
-      # @param [Symbol, String] size The size of the playlist’s thumbnail.
-      # @return [String] if +size+ is +default+, the URL of a 120x90px image.
-      # @return [String] if +size+ is +medium+, the URL of a 320x180px image.
-      # @return [String] if +size+ is +high+, the URL of a 480x360px image.
-      # @return [nil] if the +size+ is not +default+, +medium+ or +high+.
+      #   Returns the URL of the playlist’s thumbnail.
+      #   @param [Symbol, String] size The size of the playlist’s thumbnail.
+      #   @return [String] if +size+ is +default+, the URL of a 120x90px image.
+      #   @return [String] if +size+ is +medium+, the URL of a 320x180px image.
+      #   @return [String] if +size+ is +high+, the URL of a 480x360px 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 playlist was created.
+      #   @return [Time] the date and time that the playlist was created.
       delegate :published_at, to: :snippet
 
       # @!attribute [r] channel_id
-      # @return [String] the ID of the channel that the playlist belongs to.
+      #   @return [String] the ID of the channel that the playlist belongs to.
       delegate :channel_id, to: :snippet
 
       # @!attribute [r] channel_title
-      # @return [String] the title of the channel that the playlist belongs to.
+      #   @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.
+      #   @return [Array<String>] the list of tags attached to the playlist.
       delegate :tags, to: :snippet
 
     ### ACTIONS (UPLOAD, UPDATE, DELETE) ###
@@ -152,25 +152,25 @@ module Yt
     ### ANALYTICS ###
 
       # @macro report_by_playlist_dimensions
-      has_report :views
+      has_report :views, Integer
 
       # @macro report_by_playlist_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 :average_view_duration
+      has_report :average_view_duration, Float
 
       # @macro report_by_day
-      has_report :playlist_starts
+      has_report :playlist_starts, Integer
 
       # @macro report_by_day
-      has_report :average_time_in_playlist
+      has_report :average_time_in_playlist, Float
 
       # @macro report_by_day
-      has_report :views_per_playlist_start
+      has_report :views_per_playlist_start, Float
 
     ### PRIVATE API ###
 

data/lib/yt/models/playlist_item.rb

@@ -9,36 +9,36 @@ module Yt
     ### SNIPPET ###
 
       # @!attribute [r] title
-      # @return [String] the item’s title.
+      #   @return [String] the item’s title.
       delegate :title, to: :snippet
 
       # @!attribute [r] description
-      # @return [String] the item’s description.
+      #   @return [String] the item’s description.
       delegate :description, to: :snippet
 
-      # Returns the URL of the item’s thumbnail.
       # @!method thumbnail_url(size = :default)
-      # @param [Symbol, String] size The size of the item’s thumbnail.
-      # @return [String] if +size+ is +default+, the URL of a 120x90px image.
-      # @return [String] if +size+ is +medium+, the URL of a 320x180px image.
-      # @return [String] if +size+ is +high+, the URL of a 480x360px image.
-      # @return [nil] if the +size+ is not +default+, +medium+ or +high+.
+      #   Returns the URL of the item’s thumbnail.
+      #   @param [Symbol, String] size The size of the item’s thumbnail.
+      #   @return [String] if +size+ is +default+, the URL of a 120x90px image.
+      #   @return [String] if +size+ is +medium+, the URL of a 320x180px image.
+      #   @return [String] if +size+ is +high+, the URL of a 480x360px image.
+      #   @return [nil] if the +size+ is not +default+, +medium+ or +high+.
       delegate :thumbnail_url, to: :snippet
 
       # @!attribute [r] published_at
-      # @return [Time] the time that the item was added to the playlist.
+      #   @return [Time] the time that the item was added to the playlist.
       delegate :published_at, to: :snippet
 
       # @!attribute [r] channel_id
-      # @return [String] the ID of the channel that the item belongs to.
+      #   @return [String] the ID of the channel that the item belongs to.
       delegate :channel_id, to: :snippet
 
       # @!attribute [r] channel_title
-      # @return [String] the title of the channel that the item belongs to.
+      #   @return [String] the title of the channel that the item belongs to.
       delegate :channel_title, to: :snippet
 
       # @!attribute [r] playlist_id
-      # @return [String] the ID of the playlist that the item is in.
+      #   @return [String] the ID of the playlist that the item is in.
       delegate :playlist_id, to: :snippet
 
       # @return [String] the ID of the video referred by the item.

data/lib/yt/models/rating.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Provides methods to modify the rating of a video on YouTube.
     # @see https://developers.google.com/youtube/v3/docs/videos/rate
     # @see https://developers.google.com/youtube/v3/docs/videos/getRating

data/lib/yt/models/resource.rb

@@ -6,6 +6,7 @@ require 'yt/models/url'
 module Yt
   module Models
     class Resource < Base
+      # @private
       attr_reader :auth
 
     ### ID ###
@@ -18,8 +19,9 @@ module Yt
 
       has_one :status
 
-      # @return [String] the privacy status of the resource. Possible values
-      #   are: +'private'+, +'public'+, +'unlisted'+.
+      # @!attribute [r] privacy_status
+      #   @return [String] the privacy status of the resource. Possible values
+      #     are: +'private'+, +'public'+, +'unlisted'+.
       delegate :privacy_status, to: :status
 
       # @return [Boolean] whether the resource is public.
@@ -39,6 +41,7 @@ module Yt
 
       has_one :snippet
 
+      # @private
       def initialize(options = {})
         @url = URL.new(options[:url]) if options[:url]
         @id = options[:id] || (@url.id if @url)
@@ -47,14 +50,17 @@ module Yt
         @status = Status.new(data: options[:status]) if options[:status]
       end
 
+      # @private
       def kind
         @url ? @url.kind.to_s : self.class.to_s.demodulize.underscore
       end
 
+      # @private
       def username
         @url.username if @url
       end
 
+      # @private
       def update(attributes = {})
         underscore_keys! attributes
         body = build_update_body attributes

data/lib/yt/models/resumable_session.rb

@@ -3,6 +3,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Provides methods to upload videos with the resumable upload protocol.
     # @see https://developers.google.com/youtube/v3/guides/using_resumable_upload_protocol
     class ResumableSession < Base

data/lib/yt/models/snippet.rb

@@ -2,6 +2,7 @@ require 'yt/models/description'
 
 module Yt
   module Models
+    # @private
     # Provides methods to interact with the snippet of YouTube resources.
     # @see https://developers.google.com/youtube/v3/docs/channels#resource
     # @see https://developers.google.com/youtube/v3/docs/videos#resource

data/lib/yt/models/statistics_set.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Encapsulates statistics about the resource, such as the number of times
     # the resource has been viewed or liked.
     # @see https://developers.google.com/youtube/v3/docs/videos#resource

data/lib/yt/models/status.rb

@@ -2,6 +2,7 @@ require 'yt/models/timestamp'
 
 module Yt
   module Models
+    # @private
     # Contains information about the status of a resource. The details of the
     # status are different for the different types of resources.
     #
@@ -26,12 +27,6 @@ module Yt
       has_attribute :embeddable
       has_attribute :public_stats_viewable
       has_attribute :publish_at, type: Time
-
-    private
-
-      def video?
-        upload_status.present?
-      end
     end
   end
 end

data/lib/yt/models/subscription.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Provides methods to interact with YouTube subscriptions.
     # @see https://developers.google.com/youtube/v3/docs/subscriptions
     class Subscription < Base

data/lib/yt/models/timestamp.rb

@@ -1,5 +1,6 @@
 module Yt
   module Models
+    # @private
     # Extend Time to have .to_json return the format needed to submit
     # timestamp to YouTube API.
     # Only needed while we support ActiveSupport 3.

data/lib/yt/models/url.rb

@@ -1,5 +1,6 @@
 module Yt
   module Models
+    # @private
     class URL
       attr_reader :kind
 

data/lib/yt/models/user_info.rb

@@ -2,6 +2,7 @@ require 'yt/models/base'
 
 module Yt
   module Models
+    # @private
     # Provides methods to retrieve an account’s user profile.
     # @see https://developers.google.com/+/api/latest/people/getOpenIdConnect
     class UserInfo < Base

data/lib/yt/models/video.rb

@@ -9,37 +9,37 @@ module Yt
     ### SNIPPET ###
 
       # @!attribute [r] title
-      # @return [String] the video’s title.
+      #   @return [String] the video’s title.
       delegate :title, to: :snippet
 
       # @!attribute [r] description
-      # @return [String] the video’s description.
+      #   @return [String] the video’s description.
       delegate :description, to: :snippet
 
-      # Returns the URL of the video’s thumbnail.
       # @!method thumbnail_url(size = :default)
-      # @param [Symbol, String] size The size of the video’s thumbnail.
-      # @return [String] if +size+ is +default+, the URL of a 120x90px image.
-      # @return [String] if +size+ is +medium+, the URL of a 320x180px image.
-      # @return [String] if +size+ is +high+, the URL of a 480x360px image.
-      # @return [nil] if the +size+ is not +default+, +medium+ or +high+.
+      #   Returns the URL of the video’s thumbnail.
+      #   @param [Symbol, String] size The size of the video’s thumbnail.
+      #   @return [String] if +size+ is +default+, the URL of a 120x90px image.
+      #   @return [String] if +size+ is +medium+, the URL of a 320x180px image.
+      #   @return [String] if +size+ is +high+, the URL of a 480x360px 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 video was published.
+      #   @return [Time] the date and time that the video was published.
       delegate :published_at, to: :snippet
 
       # @!attribute [r] channel_id
-      # @return [String] the ID of the channel that the video belongs to.
+      #   @return [String] the ID of the channel that the video belongs to.
       delegate :channel_id, to: :snippet
 
       # @!attribute [r] channel_title
-      # @return [String] the title of the channel that the video belongs to.
+      #   @return [String] the title of the channel that the video belongs to.
       delegate :channel_title, to: :snippet
 
       # @!attribute [r] live_broadcast_content
-      # @return [String] the type of live broadcast that the video contains.
-      #   Possible values are: +'live'+, +'none'+, +'upcoming'+.
+      #   @return [String] the type of live broadcast that the video contains.
+      #     Possible values are: +'live'+, +'none'+, +'upcoming'+.
       delegate :live_broadcast_content, to: :snippet
 
       # @return [Array<String>] the list of tags attached to the video.
@@ -187,8 +187,8 @@ module Yt
       end
 
       # @!attribute [r] license
-      # @return [String] the video’s license. Possible values are:
-      #   +'creativeCommon'+, +'youtube'+.
+      #   @return [String] the video’s license. Possible values are:
+      #     +'creativeCommon'+, +'youtube'+.
       delegate :license, to: :status
 
       # @return [Boolean] whether the video uses the Standard YouTube license.
@@ -223,7 +223,7 @@ module Yt
       has_one :content_detail
 
       # @!attribute [r] duration
-      # @return [Integer] the duration of the video (in seconds).
+      #   @return [Integer] the duration of the video (in seconds).
       delegate :duration, to: :content_detail
 
       # @return [Boolean] whether the video is available in 3D.
@@ -252,16 +252,16 @@ module Yt
       has_one :file_detail
 
       # @!attribute [r] file_size
-      # @return [Integer] the size of the uploaded file (in bytes).
+      #   @return [Integer] the size of the uploaded file (in bytes).
       delegate :file_size, to: :file_detail
 
       # @!attribute [r] file_type
-      # @return [String] the type of file uploaded. May be one of:
-      #   archive, audio, document, image, other, project, video.
+      #   @return [String] the type of file uploaded. May be one of:
+      #     archive, audio, document, image, other, project, video.
       delegate :file_type, to: :file_detail
 
       # @!attribute [r] container
-      # @return [String] the video container of the uploaded file. (e.g. 'mov').
+      #   @return [String] the video container of the uploaded file. (e.g. 'mov').
       delegate :container, to: :file_detail
 
 
@@ -317,49 +317,49 @@ module Yt
       has_one :advertising_options_set
 
       # @!attribute [r] ad_formats
-      # @return [Array<String>] the list of ad formats that the video is
-      #   allowed to show. Possible values are: +'long'+, +'overlay'+,
-      #   +'standard_instream'+, +'third_party'+, +'trueview_inslate'+,
-      #   +'trueview_instream'+.
+      #   @return [Array<String>] the list of ad formats that the video is
+      #     allowed to show. Possible values are: +'long'+, +'overlay'+,
+      #     +'standard_instream'+, +'third_party'+, +'trueview_inslate'+,
+      #     +'trueview_instream'+.
       delegate :ad_formats, to: :advertising_options_set
 
     ### LIVE STREAMING DETAILS ###
 
       has_one :live_streaming_detail
 
-      # The time when a live broadcast started.
       # @!attribute [r] actual_start_time
-      # @return [Time] if the broadcast has begun, the time it actually started.
-      # @return [nil] if the broadcast has not begun or video is not live.
+      #   The time when a live broadcast started.
+      #   @return [Time] if the broadcast has begun, the time it actually started.
+      #   @return [nil] if the broadcast has not begun or video is not live.
       delegate :actual_start_time, to: :live_streaming_detail
 
-      # The time when a live broadcast ended.
       # @!attribute [r] actual_end_time
-      # @return [Time] if the broadcast is over, the time it actually ended.
-      # @return [nil] if the broadcast is not over or video is not live.
+      #   The time when a live broadcast ended.
+      #   @return [Time] if the broadcast is over, the time it actually ended.
+      #   @return [nil] if the broadcast is not over or video is not live.
       delegate :actual_end_time, to: :live_streaming_detail
 
-      # The time when a live broadcast is scheduled to start.
       # @!attribute [r] scheduled_start_time
-      # @return [Time] the time that the broadcast is scheduled to begin.
-      # @return [nil] if video is not live.
+      #   The time when a live broadcast is scheduled to start.
+      #   @return [Time] the time that the broadcast is scheduled to begin.
+      #   @return [nil] if video is not live.
       delegate :scheduled_start_time, to: :live_streaming_detail
 
-      # The time when a live broadcast is scheduled to end.
       # @!attribute [r] scheduled_end_time
-      # @return [Time] if the broadcast is scheduled to end, the time it is
-      #   scheduled to end.
-      # @return [nil] if the broadcast is scheduled to continue indefinitely
-      #   or the video is not live.
+      #   The time when a live broadcast is scheduled to end.
+      #   @return [Time] if the broadcast is scheduled to end, the time it is
+      #     scheduled to end.
+      #   @return [nil] if the broadcast is scheduled to continue indefinitely
+      #     or the video is not live.
       delegate :scheduled_end_time, to: :live_streaming_detail
 
-      # The number of current viewers of a live broadcast.
       # @!attribute [r] concurrent_viewers
-      # @return [Integer] if the broadcast has current viewers and the
-      #   broadcast owner has not hidden the viewcount for the video, the
-      #   number of viewers currently watching the broadcast.
-      # @return [nil] if the broadcast has ended or the broadcast owner has
-      #   hidden the viewcount for the video or the video is not live.
+      #   The number of current viewers of a live broadcast.
+      #   @return [Integer] if the broadcast has current viewers and the
+      #     broadcast owner has not hidden the viewcount for the video, the
+      #     number of viewers currently watching the broadcast.
+      #   @return [nil] if the broadcast has ended or the broadcast owner has
+      #     hidden the viewcount for the video or the video is not live.
       delegate :concurrent_viewers, to: :live_streaming_detail
 
     ### ASSOCIATIONS ###
@@ -373,88 +373,88 @@ module Yt
     ### ANALYTICS ###
 
       # @macro report_by_video_dimensions
-      has_report :views
+      has_report :views, Integer
 
       # @macro report_by_video_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
 
       # @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
-      has_report :subscribers_gained
+      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
-      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 video has been viewed.
+      #   @return [Integer] the number of times the video has been viewed.
       delegate :view_count, to: :statistics_set
 
       # @!attribute [r] like_count
-      # @return [Integer] the number of users who liked the video.
+      #   @return [Integer] the number of users who liked the video.
       delegate :like_count, to: :statistics_set
 
       # @!attribute [r] dislike_count
-      # @return [Integer] the number of users who disliked the video.
+      #   @return [Integer] the number of users who disliked the video.
       delegate :dislike_count, to: :statistics_set
 
       # @!attribute [r] favorite_count
-      # @return [Integer] the number of users who marked the video as favorite.
+      #   @return [Integer] the number of users who marked the video as favorite.
       delegate :favorite_count, to: :statistics_set
 
       # @!attribute [r] comment_count
-      # @return [Integer] the number of comments for the video.
+      #   @return [Integer] the number of comments for the video.
       delegate :comment_count, to: :statistics_set
 
     ### PLAYER ###
@@ -462,8 +462,8 @@ module Yt
       has_one :player
 
       # @!attribute [r] embed_html
-      # @return [String] the HTML code of an <iframe> tag that embeds a
-      #   player that will play the video.
+      #   @return [String] the HTML code of an <iframe> tag that embeds a
+      #     player that will play the video.
       delegate :embed_html, to: :player
 
     ### ACTIONS (UPLOAD, UPDATE, DELETE) ###

data/lib/yt/models/video_category.rb

@@ -2,6 +2,7 @@ require 'yt/models/resource'
 
 module Yt
   module Models
+    # @private
     # Provides methods to interact with YouTube video categories.
     # @see https://developers.google.com/youtube/v3/docs/videoCategories
     class VideoCategory < Resource

data/lib/yt/request.rb

@@ -11,6 +11,7 @@ require 'yt/errors/server_error'
 require 'yt/errors/unauthorized'
 
 module Yt
+  # @private
   # A wrapper around Net::HTTP to send HTTP requests to any web API and
   # return their result or raise an error if the result is unexpected.
   # The basic way to use Request is by calling +run+ on an instance.

data/lib/yt/version.rb

@@ -1,3 +1,3 @@
 module Yt
-  VERSION = '0.21.0'
+  VERSION = '0.22.0'
 end

data/spec/collections/reports_spec.rb

@@ -9,7 +9,7 @@ describe Yt::Collections::Reports do
   let(:msg) { {response_body: {error: {errors: [error]}}}.to_json }
 
   describe '#within' do
-    let(:result) { reports.within Range.new(5.days.ago, 4.days.ago), :day }
+    let(:result) { reports.within Range.new(5.days.ago, 4.days.ago), :day, Float }
     context 'given the request raises error 400 with "Invalid Query" message' do
       let(:reason) { 'badRequest' }
       let(:message) { 'Invalid query. Query did not conform to the expectations' }