yt 0.11.6 → 0.12.0

data/lib/yt/models/playlist_item.rb

@@ -16,6 +16,19 @@ module Yt
       def exists?
         !@id.nil?
       end
+
+    private
+
+      def resource_id
+        {kind: 'youtube#video', videoId: video_id}
+      end
+
+      # @see https://developers.google.com/youtube/v3/docs/playlistItems/update
+      def update_parts
+        keys = [:position, :playlist_id, :resource_id]
+        snippet = {keys: keys, required: true}
+        {snippet: snippet}
+      end
     end
   end
 end

data/lib/yt/models/policy.rb

@@ -14,31 +14,27 @@ module Yt
 
       # @return [String] the ID that YouTube assigns and uses to uniquely
       #   identify the policy.
-      def id
-        @id ||= @data['id']
-      end
+      has_attribute :id
 
       # @return [String] the policy’s name.
-      def name
-        @name ||= @data['name']
-      end
+      has_attribute :name
 
       # @return [String] the policy’s description.
-      def description
-        @name ||= @data['description']
-      end
+      has_attribute :description
 
       # @return [String] the time the policy was updated.
-      def updated_at
-        @updated_at ||= Time.parse @data['timeUpdated']
+      has_attribute :updated_at, type: Time, from: :time_updated
+
+      # @deprecated Use {#updated_at} instead.
+      def time_updated
+        updated_at
       end
-      alias time_updated updated_at
 
       # @return [Array<PolicyRule>] a list of rules that specify the action
       #   that YouTube should take and may optionally specify the conditions
       #   under which that action is enforced.
-      def rules
-        @rules ||= @data['rules'].map{|rule| PolicyRule.new data: rule}
+      has_attribute :rules do |rules|
+        rules.map{|rule| PolicyRule.new data: rule}
       end
     end
   end

data/lib/yt/models/policy_rule.rb

@@ -6,7 +6,7 @@ module Yt
     # Rules that specify the action that YouTube should take and may optionally
     # specify the conditions under which that action is enforced.
     # @see https://developers.google.com/youtube/partner/docs/v1/policies
-    class PolicyRule
+    class PolicyRule < Base
       def initialize(options = {})
         @data = options[:data]
       end
@@ -18,16 +18,12 @@ module Yt
       # YouTube. Valid values for this property are: block, monetize, takedown,
       # track.
       # @return [String] the policy that YouTube should enforce.
-      def action
-        @action ||= @data['action']
-      end
+      has_attribute :action
 
       # @return [Array] A list of additional actions that YouTube should take
       #   if the conditions in the rule are met. Valid values for this property
       #   are: review.
-      def subaction
-        @subaction ||= @data['subaction']
-      end
+      has_attribute :subaction
 
       # Return the list of territories where the policy applies.
       # Each territory is an ISO 3166 two-letter country code.
@@ -58,7 +54,7 @@ module Yt
       # @example videos that match the reference for 20 to 30 seconds:
       #   match_duration #= [{low: 20.0, high: 30.0}]
       def match_duration
-        @match_duration ||= match_duration_list.map{|r| low_and_high r}
+        match_duration_list.map{|r| low_and_high r}
       end
 
       # @return [Array<Hash<Symbol, Float>>] the intervals of percentages the
@@ -68,7 +64,7 @@ module Yt
       # @example videos that match the reference for 40%~50% of their duration:
       #   match_percent #= [{low: 40.0, high: 50.0}]
       def match_percent
-        @match_percent ||= match_percent_list.map{|r| low_and_high r}
+        match_percent_list.map{|r| low_and_high r}
       end
 
       # @return [Array<Hash<Symbol, Float>>] the intervals of duration that the
@@ -78,7 +74,7 @@ module Yt
       # @example references that are between 20 and 30 seconds:
       #   reference_duration #= [{low: 20.0, high: 30.0}]
       def reference_duration
-        @reference_duration ||= reference_duration_list.map{|r| low_and_high r}
+        reference_duration_list.map{|r| low_and_high r}
       end
 
       # @return [Array<Hash<Symbol, Float>>] the intervals of percentages the
@@ -88,41 +84,39 @@ module Yt
       # @example videos that match either 0%~10% or 40%~50% of a reference:
       #   reference_percent #= [{low: 0.0, high: 10.0}, {low: 40.0, high: 50.0}]
       def reference_percent
-        @reference_percent ||= reference_percent_list.map{|r| low_and_high r}
+        reference_percent_list.map{|r| low_and_high r}
       end
 
     private
 
-      def conditions
-        @conditions ||= @data.fetch 'conditions', {}
-      end
+      has_attribute :conditions, default: {}
 
       def territories_object
-        @territories_object ||= conditions.fetch 'requiredTerritories', {}
+        conditions.fetch 'requiredTerritories', {}
       end
 
       def territories_type
-        @territories_type ||= territories_object['type']
+        territories_object['type']
       end
 
       def territories
-        @territories ||= territories_object['territories']
+        territories_object['territories']
       end
 
       def match_duration_list
-        @match_duration_list ||= conditions.fetch 'matchDuration', []
+        conditions.fetch 'matchDuration', []
       end
 
       def match_percent_list
-        @match_percent_list ||= conditions.fetch 'matchPercent', []
+        conditions.fetch 'matchPercent', []
       end
 
       def reference_duration_list
-        @reference_duration_list ||= conditions.fetch 'referenceDuration', []
+        conditions.fetch 'referenceDuration', []
       end
 
       def reference_percent_list
-        @reference_percent_list ||= conditions.fetch 'referencePercent', []
+        conditions.fetch 'referencePercent', []
       end
 
       def low_and_high(range)

data/lib/yt/models/reference.rb

@@ -26,52 +26,38 @@ module Yt
 
       # @return [String] the ID that YouTube assigns and uses to uniquely
       #   identify the reference.
-      def id
-        @id ||= @data['id']
-      end
+      has_attribute :id
 
       # @return [String] the ID that uniquely identifies the asset that the
       #   reference is associated with.
-      def asset_id
-        @asset_id ||= @data["assetId"]
-      end
+      has_attribute :asset_id
 
       # @return [Float] The length of the reference in seconds
-      def length
-        @length ||= @data["length"]
-      end
+      has_attribute :length
 
       # @return [String] the ID of the source video. This field is only present
       #   if the reference was created by associating an asset with an existing
       #   YouTube video that was uploaded to a YouTube channel linked to your
       #   CMS account.
-      def video_id
-        @video_id ||= @data["videoId"]
-      end
+      has_attribute :video_id
 
       # @return [String] the claim ID that represents the resulting association
       #   between the asset and the video. This field is only present if the
       #   reference was created by associating an asset with an existing
       #   YouTube video that was uploaded to a YouTube channel linked to your
       #   CMS account.
-      def claim_id
-        @claim_id ||= @data["claimId"]
-      end
+      has_attribute :claim_id
 
       # @return [boolean] whether or not the reference content is included in
       #   YouTube's AudioSwap program. Set this field's value to true to
       #   indicate that  the reference content should be included in YouTube's
       #   AudioSwap program.
-      def audioswap_enabled?
-        @audioswap_enabled ||= @data["audioswapEnabled"]
-      end
+      has_attribute :audioswap_enabled?, from: :audioswap_enabled
 
       # @return [boolean] should the reference be used to generate claims. Set
       #   this value to true to indicate that the reference should not be used
       #   to generate claims. This field is only used on AudioSwap references.
-      def ignore_fp_match?
-        @ignore_fp_match ||= @data["ignoreFpMatch"]
-      end
+      has_attribute :ignore_fp_match?, from: :ignore_fp_match
 
       # @return [Boolean] the urgent status of the reference file.
       #   Set this value to true to indicate that YouTube should prioritize
@@ -81,23 +67,17 @@ module Yt
       #   videos that require time-sensitive processing.
       #   The sooner YouTube completes Content ID processing for a video, the
       #   sooner YouTube can match user-uploaded videos to that video.
-      def urgent?
-        @urgent ||= @data["urgent"]
-      end
+      has_attribute :urgent?, from: :urgent
 
       # @return [String] An explanation of how a reference entered its current
       #   state. This value is only present if the reference’s status is either
       #   inactive or deleted.
-      def status_reason
-        @status_reason ||= @data["statusReason"]
-      end
+      has_attribute :status_reason
 
       # @return [String] The ID that uniquely identifies the reference that
       #   this reference duplicates. This field is only present if the
       #   reference’s status is duplicate_on_hold.
-      def duplicate_leader
-        @duplicate_leader ||= @data["duplicateLeader"]
-      end
+      has_attribute :duplicate_leader
 
 # Status
 
@@ -108,10 +88,8 @@ module Yt
       # @return [String] the reference’s status. Valid values are: activating,
       #   active, checking, computing_fingerprint, deleted, duplicate_on_hold,
       #   inactive, live_streaming_processing, and urgent_reference_processing.
-      def status
-        @status ||= @data["status"]
-      end
-
+      has_attribute :status
+      
       # @return [Boolean] whether the reference is pending.
       def activating?
         status == 'activating'
@@ -167,9 +145,7 @@ module Yt
       # @return [String] whether the reference 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 reference covers the audio of the
       #   content.

data/lib/yt/models/right_owner.rb

@@ -4,7 +4,7 @@ module Yt
   module Models
     # Encapsulates information about the various types of owners of an asset.
     # @see https://developers.google.com/youtube/partner/docs/v1/ownership#resource
-    class RightOwner
+    class RightOwner < Base
       def initialize(options = {})
         @data = options[:data]
       end
@@ -15,22 +15,16 @@ module Yt
       #   values are 100, which indicates that the owner completely owns the
       #   asset in the specified territories, and 0, which indicates that you
       #   are removing ownership of the asset in the specified territories.
-      def ratio
-        @ratio ||= @data['ratio'].to_f
-      end
+      has_attribute :ratio, type: Float
 
       # @return [String] the name of the asset’s owner or rights administrator.
-      def owner
-        @owner ||= @data['owner']
-      end
+      has_attribute :owner
 
       # @return [String] if the asset is a composition asset and the asset
       #   owner is not known to have a formal relationship established with
       #   YouTube, the name of the asset’s publisher or rights administrator.
       # @return [nil] otherwise.
-      def publisher
-        @publisher ||= @data['publisher']
-      end
+      has_attribute :publisher
 
       # Return the list of territories where the owner owns the asset.
       # Each territory is an ISO 3166 two-letter country code.
@@ -57,13 +51,8 @@ module Yt
 
     private
 
-      def type
-        @type ||= @data['type']
-      end
-
-      def territories
-        @territories ||= @data.fetch 'territories', []
-      end
+      has_attribute :type
+      has_attribute :territories, default: []
     end
   end
 end

data/lib/yt/models/snippet.rb

@@ -11,7 +11,7 @@ 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
-    class Snippet
+    class Snippet < Base
       def initialize(options = {})
         @data = options[:data]
         @auth = options[:auth]
@@ -23,9 +23,7 @@ module Yt
       # @return [String] if the resource is a video, the video’s title. Has a
       #   maximum of 100 characters and may contain all valid UTF-8 characters
       #   except < and >.
-      def title
-        @title ||= @data.fetch 'title', ''
-      end
+      has_attribute :title, default: ''
 
       # @return [Yt::Models::Description] if the resource is a channel, the
       #   channel’s description. Has a maximum of 1000 characters.
@@ -36,8 +34,8 @@ module Yt
       # @return [Yt::Models::Description] if the resource is a video, the
       #   video’s description. Has a maximum of 5000 bytes and may contain all
       #   valid UTF-8 characters except < and >.
-      def description
-        @description ||= Description.new @data.fetch('description', '')
+      has_attribute :description, default: '' do |description_text|
+        Description.new description_text
       end
 
       # @return [Time] if the resource is a channel, the date and time that the
@@ -48,9 +46,7 @@ module Yt
       #   that the item was added to the playlist.
       # @return [Time] if the resource is a video, the date and time that the
       #   video was published.
-      def published_at
-        @published_at ||= Time.parse @data['publishedAt']
-      end
+      has_attribute :published_at, type: Time
 
       # @param [Symbol, String] size The size of the thumbnail to retrieve.
       # @return [String] if the resource is a channel and +size+ is +default+,
@@ -67,8 +63,7 @@ module Yt
       #    Video and +size+ is +high+, the URL of an 480x360px image.
       # @return [nil] if the +size+ is not +default+, +medium+ or +high+.
       def thumbnail_url(size = :default)
-        @thumbnails ||= @data.fetch 'thumbnails', {}
-        @thumbnails.fetch(size.to_s, {})['url']
+        thumbnails.fetch(size.to_s, {})['url']
       end
 
       # @return [String] if the resource is a playlist, the ID that YouTube
@@ -78,9 +73,7 @@ module Yt
       # @return [String] if the resource is a video, the ID that YouTube uses
       #   to uniquely identify the channel that the video was uploaded to.
       # @return [nil] if the resource is a channel.
-      def channel_id
-        @channel_id ||= @data['channelId']
-      end
+      has_attribute :channel_id
 
       # @return [String] if the resource is a playlist, the title of the
       #   channel that the playlist belongs to.
@@ -89,9 +82,7 @@ module Yt
       # @return [String] if the resource is a video, the title of the channel
       #   that the video was uploaded to.
       # @return [nil] if the resource is a channel.
-      def channel_title
-        @channel_title ||= @data['channelTitle']
-      end
+      has_attribute :channel_title
 
       # @return [Array<Yt::Models::Tag>] if the resource is a channel, an
       #   empty array.
@@ -101,9 +92,7 @@ module Yt
       #   an empty array.
       # @return [Array<Yt::Models::Tag>] if the resource is a video, the list
       #   of keyword tags associated with the video.
-      def tags
-        @tags ||= @data.fetch 'tags', []
-      end
+      has_attribute :tags, default: []
 
       # @return [String] if the resource is a video, the YouTube video
       #   category associated with the video.
@@ -111,9 +100,7 @@ module Yt
       # @return [nil] if the resource is a playlist.
       # @return [nil] if the resource is a playlist item.
       # @see https://developers.google.com/youtube/v3/docs/videoCategories/list
-      def category_id
-        @category_id ||= @data['categoryId']
-      end
+      has_attribute :category_id
 
       BROADCAST_TYPES = %q(live none upcoming)
 
@@ -122,18 +109,14 @@ module Yt
       # @return [nil] if the resource is a channel.
       # @return [nil] if the resource is a playlist.
       # @return [nil] if the resource is a playlist item.
-      def live_broadcast_content
-        @live_broadcast_content ||= @data['liveBroadcastContent']
-      end
+      has_attribute :live_broadcast_content
 
       # @return [String] if the resource is a playlist item, the ID that
       #   YouTube uses to uniquely identify the playlist that the item is in.
       # @return [nil] if the resource is a channel.
       # @return [nil] if the resource is a playlist.
       # @return [nil] if the resource is a video.
-      def playlist_id
-        @playlist_id ||= @data['playlistId']
-      end
+      has_attribute :playlist_id
 
       # @return [Integer] if the resource is a playlist item, the order in
       #   which the item appears in a playlist. The value is zero-based, so the
@@ -141,9 +124,7 @@ module Yt
       # @return [nil] if the resource is a channel.
       # @return [nil] if the resource is a playlist.
       # @return [nil] if the resource is a video.
-      def position
-        @position ||= @data['position'].to_i
-      end
+      has_attribute :position, type: Integer
 
       # @return [String] if the resource is a playlist item, the ID of the
       #   video the playlist item represents in the playlist.
@@ -151,7 +132,7 @@ module Yt
       # @return [nil] if the resource is a playlist.
       # @return [nil] if the resource is a video.
       def video_id
-        @video_id ||= @data.fetch('resourceId', {})['videoId']
+        resource_id['videoId']
       end
 
       # @return [Yt::Models::Video] the video the playlist item represents in
@@ -174,6 +155,11 @@ module Yt
       def includes_tags
         @includes_tags ||= @data.fetch :includes_tags, true
       end
+
+    private
+
+      has_attribute :thumbnails, default: {}
+      has_attribute :resource_id, default: {}
     end
   end
 end