yt 0.11.6 → 0.12.0

data/lib/yt/models/base.rb

@@ -2,6 +2,7 @@ require 'yt/actions/delete'
 require 'yt/actions/update'
 require 'yt/actions/patch'
 
+require 'yt/associations/has_attribute'
 require 'yt/associations/has_authentication'
 require 'yt/associations/has_many'
 require 'yt/associations/has_one'
@@ -17,6 +18,7 @@ module Yt
       include Actions::Update
       include Actions::Patch
 
+      include Associations::HasAttribute
       extend Associations::HasReports
       extend Associations::HasViewerPercentages
       extend Associations::HasOne

data/lib/yt/models/channel.rb

@@ -5,10 +5,6 @@ module Yt
     # A channel resource contains information about a YouTube channel.
     # @see https://developers.google.com/youtube/v3/docs/channels
     class Channel < Resource
-      # @!attribute [r] subscriptions
-      #   @return [Yt::Collections::Subscriptions] the channel’s subscriptions.
-      has_many :subscriptions
-
       # @!attribute [r] videos
       #   @return [Yt::Collections::Videos] the channel’s videos.
       has_many :videos
@@ -53,6 +49,20 @@ module Yt
       has_one :content_owner_detail
       delegate :content_owner, :linked_at, to: :content_owner_detail
 
+      # @!attribute [r] subscribed_channels
+      #   @return [Yt::Collections::SubscribedChannels] the channels that the channel is subscribed to.
+      #   @raise [Yt::Errors::Forbidden] if the owner of the channel has
+      #     explicitly select the option to keep all subscriptions private.
+      has_many :subscribed_channels
+
+      # @!attribute [r] subscription
+      #   @return [Yt::Models::Subscription] the channel’s subscription by auth.
+      #   @raise [Yt::Errors::NoItems] if {Resource#auth auth} is not
+      #     subscribed to the channel.
+      #   @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
+      #     return an authenticated account.
+      has_one :subscription
+
       # Returns whether the authenticated account is subscribed to the channel.
       #
       # This method requires {Resource#auth auth} to return an
@@ -61,55 +71,64 @@ module Yt
       # @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
       #   return an authenticated account.
       def subscribed?
-        subscriptions.any?{|s| s.exists?}
+        sleep [(@subscriptions_updated_at || Time.now) - Time.now, 0].max
+        subscription.exists?
+      rescue Errors::NoItems
+        false
       end
 
-      # Subscribes the authenticated account to the channel.
-      # Does not raise an error if the account was already subscribed.
+      # Unsubscribes the authenticated account from the channel.
+      # Raises an error if the account was not subscribed.
       #
       # This method requires {Resource#auth auth} to return an
       # authenticated instance of {Yt::Account}.
+      # @raise [Yt::Errors::RequestError] if {Resource#auth auth} was not
+      #   subscribed to the channel.
       # @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
       #   return an authenticated account.
-      def subscribe
-        subscriptions.insert ignore_errors: true
+      def unsubscribe!
+        subscription.delete.tap{ throttle_subscriptions }
       end
 
-      # Subscribes the authenticated account to the channel.
-      # Raises an error if the account was already subscribed.
+      # Unsubscribes the authenticated account from the channel.
+      # Does not raise an error if the account was not subscribed.
       #
       # This method requires {Resource#auth auth} to return an
       # authenticated instance of {Yt::Account}.
-      # @raise [Yt::Errors::RequestError] if {Resource#auth auth} was already
-      #   subscribed to the channel.
       # @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
       #   return an authenticated account.
-      def subscribe!
-        subscriptions.insert
+      def unsubscribe
+        unsubscribe! if subscribed?
       end
 
-      # Unsubscribes the authenticated account from the channel.
-      # Does not raise an error if the account was not subscribed.
+      # Subscribes the authenticated account to the channel.
+      # Raises an error if the account was already subscribed.
       #
       # This method requires {Resource#auth auth} to return an
       # authenticated instance of {Yt::Account}.
+      # @raise [Yt::Errors::RequestError] if {Resource#auth auth} was already
+      #   subscribed to the channel.
       # @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
       #   return an authenticated account.
-      def unsubscribe
-        subscriptions.delete_all({}, ignore_errors: true)
+      def subscribe!
+        subscriptions.insert.tap do |subscription|
+          throttle_subscriptions
+          @subscription = subscription
+        end
       end
 
-      # Unsubscribes the authenticated account from the channel.
-      # Raises an error if the account was not subscribed.
+      # Subscribes the authenticated account to the channel.
+      # Does not raise an error if the account was already subscribed.
       #
       # This method requires {Resource#auth auth} to return an
       # authenticated instance of {Yt::Account}.
-      # @raise [Yt::Errors::RequestError] if {Resource#auth auth} was not
-      #   subscribed to the channel.
       # @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
       #   return an authenticated account.
-      def unsubscribe!
-        subscriptions.delete_all
+      def subscribe
+        subscriptions.insert(ignore_errors: true).tap do |subscription|
+          throttle_subscriptions
+          @subscription = subscription
+        end
       end
 
       def create_playlist(params = {})
@@ -150,6 +169,15 @@ module Yt
       def content_owner_details_params
         {on_behalf_of_content_owner: auth.owner_name || auth.id}
       end
+
+      # @private
+      # @note Google API must have some caching layer by which if we try to
+      # delete a subscription that we just created, we encounter an error.
+      # To overcome this, if we have just updated the subscription, we must
+      # wait some time before requesting it again.
+      def throttle_subscriptions(seconds = 10)
+        @subscriptions_updated_at = Time.now + seconds
+      end
     end
   end
 end

data/lib/yt/models/claim.rb

@@ -24,21 +24,15 @@ module Yt
 
       # @return [String] the ID that YouTube assigns and uses to uniquely
       #   identify the claim.
-      def id
-        @id ||= @data['id']
-      end
+      has_attribute :id
 
       # @return [String] the unique YouTube asset ID that identifies the asset
       #   associated with the claim.
-      def asset_id
-        @asset_id ||= @data["assetId"]
-      end
+      has_attribute :asset_id
 
       # @return [String] the unique YouTube video ID that identifies the video
       #   associated with the claim.
-      def video_id
-        @video_id ||= @data["videoId"]
-      end
+      has_attribute :video_id
 
 # Status
 
@@ -50,9 +44,7 @@ module Yt
       # @note When updating a claim, you can update its status from active to
       #   inactive to effectively release the claim, but the API does not
       #   support other updates to a claim’s status.
-      def status
-        @status ||= @data["status"]
-      end
+      has_attribute :status
 
       # @return [Boolean] whether the claim is active.
       def active?
@@ -101,9 +93,7 @@ module Yt
       # @return [String] whether the claim covers the audio, video, or
       #   audiovisual portion of the claimed content. Valid values are: audio,
       #   audiovisual, video.
-      def content_type
-        @content_type ||= @data["contentType"]
-      end
+      has_attribute :content_type
 
       # @return [Boolean] whether the covers the audio of the content.
       def audio?
@@ -121,13 +111,11 @@ module Yt
       end
 
       # @return [Time] the date and time that the claim was created.
-      def created_at
-        @created_at ||= Time.parse @data["timeCreated"]
-      end
+      has_attribute :created_at, type: Time, from: :time_created
 
       # @return [Boolean] whether a third party created the claim.
-      def third_party?
-        @third_party_claim ||= @data['thirdPartyClaim'] == true
+      has_attribute :third_party?, from: :third_party_claim do |value|
+        value == true
       end
 
       # Return whether the video should be blocked where not explicitly owned.
@@ -141,16 +129,16 @@ module Yt
       #   though it will not be monetized in those countries. However, if you
       #   set this property to true, then the video will be monetized in the
       #   United States and Canada and blocked in all other countries.
-      def block_outside_ownership?
-        @block_outside_ownership ||= @data["blockOutsideOwnership"]
-      end
+      has_attribute :block_outside_ownership?, from: :block_outside_ownership
 
       # @return [String] The unique ID that YouTube uses to identify the
       #   reference that generated the match.
-      def match_reference_id
-        @match_reference_id ||= @data.fetch('matchInfo', {})['referenceId']
+      has_attribute :match_reference_id, from: :match_info do |match_info|
+        (match_info || {})['referenceId']
       end
 
+    private
+
       # @see https://developers.google.com/youtube/partner/docs/v1/claims/update
       def patch_params
         super.tap do |params|

data/lib/yt/models/content_detail.rb

@@ -12,30 +12,28 @@ module Yt
       end
 
       # @return [Integer] the duration of the video (in seconds).
-      def duration
-        @duration ||= to_seconds @data.fetch('duration', 0)
+      has_attribute :duration, default: 0 do |value|
+        to_seconds value
       end
 
       # @return [Boolean] whether the video is available in 3D.
-      def stereoscopic?
-        @stereoscopic ||= @data['dimension'] == '3d'
+      has_attribute :stereoscopic?, from: :dimension do |dimension|
+        dimension == '3d'
       end
 
       # @return [Boolean] whether the video is available in high definition.
-      def hd?
-        @hd ||= @data['definition'] == 'hd'
+      has_attribute :hd?, from: :definition do |definition|
+        definition == 'hd'
       end
 
       # @return [Boolean] whether captions are available for the video.
-      def captioned?
-        @hd ||= @data['caption'] == 'true'
+      has_attribute :captioned?, from: :caption do |caption|
+        caption == 'true'
       end
 
       # @return [Boolean] whether the video represents licensed content, which
       #   means that the content has been claimed by a YouTube content partner.
-      def licensed?
-        @licensed ||= @data.fetch 'licensedContent', false
-      end
+      has_attribute :licensed?, default: false, from: :licensed_content
 
     private
 

data/lib/yt/models/content_owner_detail.rb

@@ -21,9 +21,7 @@ module Yt
       #   permissions to administer the channel.
       # @raise [Yt::Errors::Forbidden] if {Resource#auth auth} does not
       #   return an authenticated content owner.
-      def content_owner
-        @content_owner ||= @data['contentOwner']
-      end
+      has_attribute :content_owner
 
       # Returns the date and time of when the channel was linked to the content
       # owner.
@@ -37,11 +35,7 @@ module Yt
       #   permissions to administer the channel.
       # @raise [Yt::Errors::Forbidden] if {Resource#auth auth} does not
       #   return an authenticated content owner.
-      def linked_at
-        @linked_at ||= if @data['timeLinked']
-          Time.parse @data['timeLinked']
-        end
-      end
+      has_attribute :linked_at, type: Time, from: :time_linked
     end
   end
 end

data/lib/yt/models/device_flow.rb

@@ -7,17 +7,9 @@ module Yt
         @data = options[:data]
       end
 
-      def device_code
-        @device_code ||= @data['device_code']
-      end
-
-      def user_code
-        @user_code ||= @data['user_code']
-      end
-
-      def verification_url
-        @verification_url ||= @data['verification_url']
-      end
+      has_attribute :device_code, camelize: false
+      has_attribute :user_code, camelize: false
+      has_attribute :verification_url, camelize: false
     end
   end
 end

data/lib/yt/models/live_streaming_detail.rb

@@ -15,47 +15,27 @@ module Yt
       # @return [Time] if the broadcast has begun, the time that the broadcast
       #   actually started.
       # @return [nil] if the broadcast has not begun.
-      def actual_start_time
-        @actual_start_time ||= if @data['actualStartTime']
-          Time.parse @data['actualStartTime']
-        end
-      end
+      has_attribute :actual_start_time, type: Time
 
       # @return [Time] if the broadcast is over, the time that the broadcast
       #   actually ended.
       # @return [nil] if the broadcast is not over.
-      def actual_end_time
-        @actual_end_time ||= if @data['actualEndTime']
-          Time.parse @data['actualEndTime']
-        end
-      end
+      has_attribute :actual_end_time, type: Time
 
       # @return [Time] the time that the broadcast is scheduled to begin.
-      def scheduled_start_time
-        @scheduled_start_time ||= if @data['scheduledStartTime']
-          Time.parse @data['scheduledStartTime']
-        end
-      end
+      has_attribute :scheduled_start_time, type: Time
 
       # @return [Time] if the broadcast is scheduled to end, the time that the
       #   broadcast is scheduled to end.
       # @return [nil] if the broadcast is scheduled to continue indefinitely.
-      def scheduled_end_time
-        @scheduled_end_time ||= if @data['scheduledEndTime']
-          Time.parse @data['scheduledEndTime']
-        end
-      end
+      has_attribute :scheduled_end_time, type: Time
 
       # @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.
-      def concurrent_viewers
-        @concurrent_viewers ||= if @data['concurrentViewers']
-          @data['concurrentViewers'].to_i
-        end
-      end
+      has_attribute :concurrent_viewers, type: Integer
     end
   end
 end

data/lib/yt/models/ownership.rb

@@ -29,26 +29,26 @@ module Yt
       #   General  asset ownership is used for all types of assets and is the
       #   only type  of ownership data that can be provided for assets that are
       #   not compositions.
-      def general_owners
-        @general_owners ||= as_owners @data['general']
+      has_attribute :general_owners, from: :general do |data|
+        as_owners data
       end
 
       # @return [Array<RightOwner>] a list that identifies owners of the
       #   performance rights for a composition asset.
-      def performance_owners
-        @performance_owners ||= as_owners @data['performance']
+      has_attribute :performance_owners, from: :performance do |data|
+        as_owners data
       end
 
       # @return [Array<RightOwner>] a list that identifies owners of the
       #   synchronization rights for a composition asset.
-      def synchronization_owners
-        @synchronization_owners ||= as_owners @data['synchronization']
+      has_attribute :synchronization_owners, from: :synchronization do |data|
+        as_owners data
       end
 
       # @return [Array<RightOwner>] a list that identifies owners of the
       #   mechanical rights for a composition asset.
-      def mechanical_owners
-        @mechanical_owners ||= as_owners @data['mechanical']
+      has_attribute :mechanical_owners, from: :mechanical do |data|
+        as_owners data
       end
 
     private

data/lib/yt/models/playlist.rb

@@ -35,20 +35,22 @@ module Yt
       # @raise [Yt::Errors::Unauthorized] if {Resource#auth auth} does not
       #   return an account with permissions to update the playlist.
       # @return [Yt::PlaylistItem] the item added to the playlist.
-      def add_video(video_id)
-        playlist_items.insert video_params(video_id), ignore_errors: true
+      def add_video(video_id, attributes = {})
+        playlist_item_params = playlist_item_params(video_id, attributes)
+        playlist_items.insert playlist_item_params, ignore_errors: true
       end
 
-      def add_video!(video_id)
-        playlist_items.insert video_params(video_id)
+      def add_video!(video_id, attributes = {})
+        playlist_item_params = playlist_item_params(video_id, attributes)
+        playlist_items.insert playlist_item_params
       end
 
-      def add_videos(video_ids = [])
-        video_ids.map{|video_id| add_video video_id}
+      def add_videos(video_ids = [], attributes = {})
+        video_ids.map{|video_id| add_video video_id, attributes}
       end
 
-      def add_videos!(video_ids = [])
-        video_ids.map{|video_id| add_video! video_id}
+      def add_videos!(video_ids = [], attributes = {})
+        video_ids.map{|video_id| add_video! video_id, attributes}
       end
 
       def delete_playlist_items(attrs = {})
@@ -67,8 +69,10 @@ module Yt
 
       # @todo: extend camelize to also camelize the nested hashes, so we
       #   don’t have to write videoId
-      def video_params(video_id)
-        {resource_id: {kind: 'youtube#video', videoId: video_id}}
+      def playlist_item_params(video_id, params = {})
+        params.dup.tap do |params|
+          params[:resource_id] ||= {kind: 'youtube#video', videoId: video_id}
+        end
       end
     end
   end