yt 0.25.13 → 0.32.2

data/lib/yt/errors/forbidden.rb

@@ -3,11 +3,9 @@ require 'yt/errors/request_error'
 module Yt
   module Errors
     class Forbidden < RequestError
-      private
-
       def explanation
         'A request to YouTube API was considered forbidden by the server'
       end
     end
   end
-end
+end

data/lib/yt/errors/no_items.rb

@@ -3,11 +3,9 @@ require 'yt/errors/request_error'
 module Yt
   module Errors
     class NoItems < RequestError
-      private
-
       def explanation
         'A request to YouTube API returned no items but some were expected'
       end
     end
   end
-end
+end

data/lib/yt/errors/request_error.rb

@@ -19,6 +19,10 @@ module Yt
         response_body.fetch 'error', {}
       end
 
+      def description
+        response_body.fetch 'error_description', {}
+      end
+
       def reasons
         case kind
           when Hash then kind.fetch('errors', []).map{|e| e['reason']}
@@ -26,12 +30,15 @@ module Yt
         end
       end
 
-    private
-
       def explanation
         'A request to YouTube API failed'
       end
 
+      def response_body
+        json['response_body'].is_a?(Hash) ? json['response_body'] : {}
+      end
+
+    private
 
       def details
         <<-MSG.gsub(/^ {8}/, '')
@@ -56,10 +63,6 @@ module Yt
       def more_details
       end
 
-      def response_body
-        json['response_body'].is_a?(Hash) ? json['response_body'] : {}
-      end
-
       def request_curl
         json['request_curl']
       end
@@ -71,4 +74,4 @@ module Yt
   end
 
   Error = Errors::RequestError
-end
+end

data/lib/yt/errors/server_error.rb

@@ -3,11 +3,9 @@ require 'yt/errors/request_error'
 module Yt
   module Errors
     class ServerError < RequestError
-      private
-
       def explanation
         'A request to YouTube API caused an unexpected server error'
       end
     end
   end
-end
+end

data/lib/yt/errors/unauthorized.rb

@@ -4,12 +4,12 @@ require 'yt/config'
 module Yt
   module Errors
     class Unauthorized < RequestError
-      private
-
       def explanation
         'A request to YouTube API was sent without a valid authentication'
       end
 
+    private
+
       def more_details
         if [Yt.configuration.client_id, Yt.configuration.api_key].none?
           <<-MSG.gsub(/^ {10}/, '')
@@ -47,4 +47,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/account.rb

@@ -160,6 +160,11 @@ module Yt
       #     upload videos using the resumable upload protocol.
       has_many :resumable_sessions
 
+      # @!attribute [r] video_groups
+      #   @return [Yt::Collections::VideoGroups] the video-groups created by the
+      #     account.
+      has_many :video_groups
+
     ### PRIVATE API ###
 
       has_authentication
@@ -180,6 +185,13 @@ module Yt
         {for_mine: true}
       end
 
+      # @private
+      # Tells `has_many :video_groups` that content_owner.groups should return
+      # all the video-groups *owned by* the account
+      def video_groups_params
+        {mine: true}
+      end
+
       # @private
       # Tells `has_many :resumable_sessions` what path to hit to upload a file.
       def upload_path

data/lib/yt/models/advertising_options_set.rb

@@ -19,9 +19,9 @@ module Yt
         true
       end
 
-      def ad_formats
-        @data['adFormats']
-      end
+      has_attribute :ad_formats
+      has_attribute :ad_breaks
+      has_attribute :tp_ad_server_video_id
 
     private
 
@@ -35,4 +35,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/bulk_report.rb

@@ -0,0 +1,23 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube Analytics bulk reports.
+    # @see https://developers.google.com/youtube/reporting/v1/reference/rest/v1/jobs.reports
+    class BulkReport < Base
+      # @private
+      attr_reader :auth
+
+      has_attribute :id
+      has_attribute :start_time, type: Time
+      has_attribute :end_time, type: Time
+      has_attribute :download_url
+
+      # @private
+      def initialize(options = {})
+        @data = options.fetch(:data, {})
+        @auth = options[:auth]
+      end
+    end
+  end
+end

data/lib/yt/models/bulk_report_job.rb

@@ -0,0 +1,23 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube Analytics bulk report jobs.
+    # @see https://developers.google.com/youtube/reporting/v1/reference/rest/v1/jobs
+    class BulkReportJob < Base
+      # @private
+      attr_reader :id, :auth, :report_type_id
+
+      # @private
+      def initialize(options = {})
+        @id = options[:id]
+        @auth = options[:auth]
+        @report_type_id = options[:report_type_id]
+      end
+
+      # @!attribute [r] bulk_reports
+      #   @return [Yt::Collections::BulkReports] the bulk reports of this job.
+      has_many :bulk_reports
+    end
+  end
+end

data/lib/yt/models/channel.rb

@@ -114,9 +114,6 @@ module Yt
       # @macro report_by_channel_dimensions
       has_report :views, Integer
 
-      # @macro report_by_day
-      has_report :uniques, Integer
-
       # @macro report_by_channel_dimensions
       has_report :estimated_minutes_watched, Integer
 
@@ -141,12 +138,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
 
@@ -168,11 +159,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
@@ -305,4 +314,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/claim.rb

@@ -5,12 +5,13 @@ module Yt
     # Provides methods to interact with YouTube ContentID claims.
     # @see https://developers.google.com/youtube/partner/docs/v1/claims
     class Claim < Base
-      attr_reader :auth
+      attr_reader :auth, :data
 
       def initialize(options = {})
         @data = options[:data]
         @id = options[:id]
         @auth = options[:auth]
+        @asset = options[:asset] if options[:asset]
       end
 
       # @!attribute [r] claim_history
@@ -113,6 +114,16 @@ module Yt
         content_type == 'audiovisual'
       end
 
+      # @return [String] the source of the claim
+      def source
+        @data.fetch('origin', {})['source']
+      end
+
+      # @return [Yt::Models::Asset] the asset of the claim
+      def asset
+        @asset
+      end
+
       # @return [Time] the date and time that the claim was created.
       has_attribute :created_at, type: Time, from: :time_created
 
@@ -153,4 +164,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/models/comment.rb

@@ -0,0 +1,37 @@
+require 'yt/models/resource'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube comment.
+    # @see https://developers.google.com/youtube/v3/docs/comments
+    class Comment < Resource
+
+    ### SNIPPET ###
+
+      # @!attribute [r] video_id
+      #   @return [String] the ID of the video that the comment refers to.
+      delegate :video_id, to: :snippet
+
+      # @!attribute [r] author_display_name
+      #   @return [String] the display name of the user who posted the comment.
+      delegate :author_display_name, to: :snippet
+
+      # @!attribute [r] text_display
+      #   @return [String] the comment's text.
+      delegate :text_display, to: :snippet
+
+      # @!attribute [r] parent_id
+      #   @return [String] the unique ID of the parent comment. This property is only
+      #   set if the comment was submitted as a reply to another comment.
+      delegate :parent_id, to: :snippet
+
+      # @!attribute [r] like_count
+      #   @return [Integer] the total number of likes (positive ratings) the comment has received.
+      delegate :like_count, to: :snippet
+
+      # @!attribute [r] updated_at
+      #   @return [Time] the date and time when the comment was last updated.
+      delegate :updated_at, to: :snippet
+    end
+  end
+end

data/lib/yt/models/comment_thread.rb

@@ -0,0 +1,50 @@
+require 'yt/models/resource'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube comment thread.
+    # @see https://developers.google.com/youtube/v3/docs/commentThreads
+    class CommentThread < Resource
+
+    ### SNIPPET ###
+
+      # @!attribute [r] video_id
+      #   @return [String] the ID of the video that the comment thread referto, if
+      #   any. If this property is not present or does not have a value, then the
+      #   thread applies to the channel and not to a specific video.
+      delegate :video_id, to: :snippet
+
+      # @!attribute [r] total_reply_count
+      #   @return [String] The total number of replies that have been submitted 
+      #   in response to the top level comment.
+      delegate :total_reply_count, to: :snippet
+
+      # @return [Boolean] whether the thread, including all of its comments and
+      # comment replies, is visible to all YouTube users.
+      delegate :public?, to: :snippet
+
+      # @return [Boolean] whether the current viewer can reply to the thread.
+      delegate :can_reply?, to: :snippet
+
+      # @!attribute [r] top_level_comment
+      #   @return [Yt::TopLevelComment] the top level comment object.
+      delegate :top_level_comment, to: :snippet
+
+      # @!attribute [r] text_display
+      #   @return [String] the top level comment's display text.
+      delegate :text_display, to: :top_level_comment
+
+      # @!attribute [r] author_display_name
+      #   @return [String] the top level comment's author name.
+      delegate :author_display_name, to: :top_level_comment
+
+      # @!attribute [r] like_count
+      #   @return [String] the top level comment's likes count.
+      delegate :like_count, to: :top_level_comment
+
+      # @!attribute [r] updated_at
+      #   @return [String] the top level comment's last updated time.
+      delegate :updated_at, to: :top_level_comment
+    end
+  end
+end

data/lib/yt/models/content_detail.rb

@@ -29,6 +29,12 @@ module Yt
         content_rating['ytRating']
       end
 
+      # @return [<String>] the length of the video as an ISO 8601 time, HH:MM:SS.
+      def length
+        hh, mm, ss = duration / 3600, duration / 60 % 60, duration % 60
+        [hh, mm, ss].map{|t| t.to_s.rjust(2,'0')}.join(':')
+      end
+
     private
 
       # @return [Integer] the duration of the resource as reported by YouTube.

data/lib/yt/models/content_owner.rb

@@ -27,9 +27,23 @@ module Yt
       #   @return [Yt::Collections::Policies] the policies saved by the content owner.
       has_many :policies
 
+      # @return [String] The display name of the content owner.
+      attr_reader :display_name
+
+      # @!attribute [r] video_groups
+      #   @return [Yt::Collections::VideoGroups] the video-groups managed by the
+      #     content owner.
+      has_many :video_groups
+
+      # @!attribute [r] bulk_report_jobs
+      #   @return [Yt::Collections::BulkReportJobs] the bulk reporting jobs managed by the
+      #     content owner.
+      has_many :bulk_report_jobs
+
       def initialize(options = {})
         super options
         @owner_name = options[:owner_name]
+        @display_name = options[:display_name]
       end
 
       def create_reference(params = {})
@@ -43,6 +57,22 @@ module Yt
       def create_claim(params = {})
         claims.insert params
       end
+
+    ### PRIVATE API ###
+
+      # @private
+      # Tells `has_many :videos` that account.videos should return all the
+      # videos *on behalf of* the content owner (public, private, unlisted).
+      def videos_params
+        {for_content_owner: true, on_behalf_of_content_owner: @owner_name}
+      end
+
+      # @private
+      # Tells `has_many :video_groups` that content_owner.video_groups should
+      # return all the video-groups *on behalf of* the content owner
+      def video_groups_params
+        {on_behalf_of_content_owner: @owner_name}
+      end
     end
   end
-end
+end