yt-andrewroth 0.25.5.1

data/lib/yt/models/claim.rb

@@ -0,0 +1,156 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube ContentID claims.
+    # @see https://developers.google.com/youtube/partner/docs/v1/claims
+    class Claim < Base
+      attr_reader :auth
+
+      def initialize(options = {})
+        @data = options[:data]
+        @id = options[:id]
+        @auth = options[:auth]
+      end
+
+      # @!attribute [r] claim_history
+      #   @return [Yt::Collections::ClaimHistories] the claim's history.
+      has_one :claim_history
+
+      # Soft-deletes the claim.
+      # @note YouTube API does not provide a +delete+ method for the Asset
+      #   resource, but only an +update+ method. Updating the +status+ of a
+      #   Asset to "inactive" can be considered a soft-deletion.
+      # @return [Boolean] whether the claim is inactive.
+      def delete
+        body = {status: :inactive}
+        do_patch(body: body) {|data| @data = data}
+        inactive?
+      end
+
+      # @return [String] the ID that YouTube assigns and uses to uniquely
+      #   identify the claim.
+      has_attribute :id
+
+      # @return [String] the unique YouTube asset ID that identifies the asset
+      #   associated with the claim.
+      has_attribute :asset_id
+
+      # @return [String] the unique YouTube video ID that identifies the video
+      #   associated with the claim.
+      has_attribute :video_id
+
+# Status
+
+      # Returns the claim’s status.
+      # @return [String] the claim’s status. Possible values are: +'active'+,
+      #   +'appealed'+, +'disputed'+, +'inactive'+, +'pending'+, +'potential'+,
+      #   +'takedown'+, +'unknown'+.
+      # @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.
+      has_attribute :status
+
+      # @return [Boolean] whether the claim is active.
+      def active?
+        status == 'active'
+      end
+
+      # @return [Boolean] whether the claim is appealed.
+      def appealed?
+        status == 'appealed'
+      end
+
+      # @return [Boolean] whether the claim is disputed.
+      def disputed?
+        status == 'disputed'
+      end
+
+      # @return [Boolean] whether the claim is inactive.
+      def inactive?
+        status == 'inactive'
+      end
+
+      # @return [Boolean] whether the claim is pending.
+      def pending?
+        status == 'pending'
+      end
+
+      # @return [Boolean] whether the claim is potential.
+      def potential?
+        status == 'potential'
+      end
+
+      # @return [Boolean] whether the claim is takedown.
+      def takedown?
+        status == 'takedown'
+      end
+
+      # @return [Boolean] whether the claim status is unknown.
+      def has_unknown_status?
+        status == 'unknown'
+      end
+
+# Content Type
+
+      # Returns the audiovisual portion of the claimed content.
+      # @return [String] the audiovisual portion of the claimed content.
+      #   Possible values are: +'audio'+, +'audiovisual'+, +'video'+.
+      has_attribute :content_type
+
+      # @return [Boolean] whether the claim covers only the audio.
+      def audio?
+        content_type == 'audio'
+      end
+
+      # @return [Boolean] whether the claim covers only the video.
+      def video?
+        content_type == 'video'
+      end
+
+      # @return [Boolean] whether the claim covers both audio and video.
+      def audiovisual?
+        content_type == 'audiovisual'
+      end
+
+      # @return [Time] the date and time that the claim was created.
+      has_attribute :created_at, type: Time, from: :time_created
+
+      # @return [Boolean] whether a third party created the claim.
+      has_attribute :third_party?, from: :third_party_claim do |value|
+        value == true
+      end
+
+      # Return whether the video should be blocked where not explicitly owned.
+      # @return [Boolean] whether the claimed video should be blocked anywhere
+      #   it is not explicitly owned. For example, if you upload a video for an
+      #   asset that you own in the United States and Canada, and you claim the
+      #   video with a usage policy to monetize the video everywhere. Since the
+      #   policy is only applied in countries where you own the asset, YouTube
+      #   will actually monetize the video in the United States and Canada.
+      #   By default, the video will still be viewable in other countries even
+      #   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.
+      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.
+      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|
+          params[:expected_response] = Net::HTTPOK
+          params[:path] = "/youtube/partner/v1/claims/#{id}"
+          params[:params] = {on_behalf_of_content_owner: @auth.owner_name}
+        end
+      end
+    end
+  end
+end

data/lib/yt/models/claim_event.rb

@@ -0,0 +1,67 @@
+require 'yt/models/base'
+
+module Yt
+  module Models
+    class ClaimEvent < Base
+      def initialize(options = {})
+        @data = options[:data]
+      end
+
+      REASONS = %w(asset_transfer_request audio_muted audio_replaced audioswap_removed
+        channel_transferred channel_whitelisted closed_audio_claim_on_visual_reference
+        closed_audio_revshare closed_by_admin closed_cover_revshare
+        closed_invalid_reference_segment closed_manually closed_partner_exclusion
+        closed_private_video closed_reference_conflict copyrighted_content_matched
+        counter_received dispute_resolution duplicate invalid_claim muting_audio
+        ownership_removed partner_deactivated pending_activation pending_adsense
+        pending_fingerprint pending_for_review reference_removed released replaced
+        review_expired revshare_disabled risk_of_error song_erased
+        suspended_monetization_on_channel video_classifier_rejecion video_content_modified
+        video_removed video_taken_down)
+
+      # @return [Time] the date and time when the event occurred.
+      has_attribute :time, type: Time
+
+      # @return [String] the reason an event occurred.
+      has_attribute :reason
+
+      # @return [String] the event's type.
+      has_attribute :type
+
+      # @return [String] the source type which triggered the event.
+      has_attribute :source_type, from: :source do |source|
+        (source || {})['type']
+      end
+
+      # @return [String] the ID of the content owner that initiated
+      #   the event.
+      has_attribute :source_content_owner_id, from: :source do |source|
+        (source || {})['contentOwnerId']
+      end
+
+      # @return [String] the email address of the user who initiated
+      #   the event.
+      has_attribute :source_user_email, from: :source do |source|
+        (source || {})['userEmail']
+      end
+
+      # @return [String] the reason that explains why a
+      #   dispute_create event occurred.
+      has_attribute :dispute_reason, from: :type_details do |type_details|
+        (type_details || {})['disputeReason']
+      end
+
+      # @return [String] a free-text explanation of the reason that a claim
+      #   was disputed. This property is returned for dispute_create events.
+      has_attribute :dispute_notes, from: :type_details do |type_details|
+        (type_details || {})['disputeNotes']
+      end
+
+      # @return [String] the event status that resulted from a claim_update
+      #   event.
+      has_attribute :update_status, from: :type_details do |type_details|
+        (type_details || {})['updateStatus']
+      end
+    end
+  end
+end

data/lib/yt/models/claim_history.rb

@@ -0,0 +1,29 @@
+require 'yt/models/base'
+require 'yt/models/claim_event'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube ContentID claims.
+    # @see https://developers.google.com/youtube/partner/docs/v1/claims
+    class ClaimHistory < Base
+      def initialize(options = {})
+        @data = options[:data]
+        @id = options[:id]
+        @auth = options[:auth]
+      end
+
+      # @return [String] the ID that YouTube assigns and uses to uniquely
+      #   identify the claim.
+      has_attribute :id
+
+      # @return [String] the unique YouTube channel ID of the channel to
+      #   which the claimed video was uploaded.
+      has_attribute :uploader_channel_id
+
+      # @return [Array<String>] the list of events associated with the claim.
+      has_attribute :events, from: :event do |event_info|
+        event_info.map{|event| ClaimEvent.new data: event}
+      end
+    end
+  end
+end

data/lib/yt/models/configuration.rb

@@ -0,0 +1,70 @@
+module Yt
+  module Models
+    # Provides an object to store global configuration settings.
+    #
+    # This class is typically not used directly, but by calling
+    # {Yt::Config#configure Yt.configure}, which creates and updates a single
+    # instance of {Yt::Models::Configuration}.
+    #
+    # @example Set the API client id/secret for a web-client YouTube app:
+    #   Yt.configure do |config|
+    #     config.client_id = 'ABCDEFGHIJ1234567890'
+    #     config.client_secret = 'ABCDEFGHIJ1234567890'
+    #   end
+    #
+    # @see Yt::Config for more examples.
+    #
+    # An alternative way to set global configuration settings is by storing
+    # them in the following environment variables:
+    #
+    # * +YT_CLIENT_ID+ to store the Client ID for web/device apps
+    # * +YT_CLIENT_SECRET+ to store the Client Secret for web/device apps
+    # * +YT_API_KEY+ to store the API key for server/browser apps
+    # * +YT_LOG_LEVEL+ to store the verbosity level of the logs
+    #
+    # In case both methods are used together,
+    # {Yt::Config#configure Yt.configure} takes precedence.
+    #
+    # @example Set the API client id/secret for a web-client YouTube app:
+    #   ENV['YT_CLIENT_ID'] = 'ABCDEFGHIJ1234567890'
+    #   ENV['YT_CLIENT_SECRET'] = 'ABCDEFGHIJ1234567890'
+    #
+    class Configuration
+      # @return [String] the Client ID for web/device YouTube applications.
+      # @see https://console.developers.google.com Google Developers Console
+      attr_accessor :client_id
+
+      # @return [String] the Client Secret for web/device YouTube applications.
+      # @see https://console.developers.google.com Google Developers Console
+      attr_accessor :client_secret
+
+      # @return [String] the API key for server/browser YouTube applications.
+      # @see https://console.developers.google.com Google Developers Console
+      attr_accessor :api_key
+
+      # @return [String] the level of output to print for debugging purposes.
+      attr_accessor :log_level
+
+      # Initialize the global configuration settings, using the values of
+      # the specified following environment variables by default.
+      def initialize
+        @client_id = ENV['YT_CLIENT_ID']
+        @client_secret = ENV['YT_CLIENT_SECRET']
+        @api_key = ENV['YT_API_KEY']
+        @log_level = ENV['YT_LOG_LEVEL']
+      end
+
+      # @return [Boolean] whether the logging output is extra-verbose.
+      #   Useful when developing (e.g., to print the curl of every request).
+      def developing?
+        log_level.to_s.in? %w(devel)
+      end
+
+      # @return [Boolean] whether the logging output is verbose.
+      #   Useful when debugging (e.g., to print the curl of failing requests).
+      def debugging?
+        log_level.to_s.in? %w(devel debug)
+      end
+    end
+  end
+end

data/lib/yt/models/content_detail.rb

@@ -0,0 +1,65 @@
+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
+    class ContentDetail < Base
+      attr_reader :data
+
+      def initialize(options = {})
+        @data = options[:data]
+      end
+
+      # @return [Integer] the duration of the video (in seconds).
+      has_attribute :duration, default: 0 do |value|
+        to_seconds value
+      end
+
+      has_attribute :dimension
+      has_attribute :definition
+      has_attribute :caption
+      has_attribute :licensed_content
+      has_attribute :content_rating, default: {}
+
+      def youtube_rating
+        content_rating['ytRating']
+      end
+
+    private
+
+      # @return [Integer] the duration of the resource as reported by YouTube.
+      # @see https://developers.google.com/youtube/v3/docs/videos
+      #
+      # According to YouTube documentation, the value is an ISO 8601 duration
+      # in the format PT#M#S, in which the letters PT indicate that the value
+      # specifies a period of time, and the letters M and S refer to length in
+      # minutes and seconds, respectively. The # characters preceding the M and
+      # S letters are both integers that specify the number of minutes (or
+      # seconds) of the video. For example, a value of PT15M51S indicates that
+      # the video is 15 minutes and 51 seconds long.
+      #
+      # The ISO 8601 duration standard, though, is not +always+ respected by
+      # the results returned by YouTube API. For instance: video 2XwmldWC_Ls
+      # reports a duration of 'P1W2DT6H21M32S', which is to be interpreted as
+      # 1 week, 2 days, 6 hours, 21 minutes, 32 seconds. Mixing weeks with
+      # other time units is not strictly part of ISO 8601; in this context,
+      # weeks will be interpreted as "the duration of 7 days". Similarly, a
+      # day will be interpreted as "the duration of 24 hours".
+      # Video tPEE9ZwTmy0 reports a duration of 'PT2S'. Skipping time units
+      # such as minutes is not part of the standard either; in this context,
+      # it will be interpreted as "0 minutes and 2 seconds".
+      def to_seconds(iso8601_duration)
+        match = iso8601_duration.match %r{^P(?:|(?<weeks>\d*?)W)(?:|(?<days>\d*?)D)(?:|T(?:|(?<hours>\d*?)H)(?:|(?<min>\d*?)M)(?:|(?<sec>\d*?)S))$}
+        weeks = (match[:weeks] || '0').to_i
+        days = (match[:days] || '0').to_i
+        hours = (match[:hours] || '0').to_i
+        minutes = (match[:min] || '0').to_i
+        seconds = (match[:sec]).to_i
+        (((((weeks * 7) + days) * 24 + hours) * 60) + minutes) * 60 + seconds
+      end
+    end
+  end
+end

data/lib/yt/models/content_owner.rb

@@ -0,0 +1,48 @@
+require 'yt/models/account'
+
+module Yt
+  module Models
+    # Provides methods to interact with YouTube CMS accounts.
+    # @see https://cms.youtube.com
+    # @see https://developers.google.com/youtube/analytics/v1/content_owner_reports
+    class ContentOwner < Account
+
+      # @!attribute [r] partnered_channels
+      #   @return [Yt::Collections::PartneredChannels] the channels managed by the CMS account.
+      has_many :partnered_channels
+
+      # @!attribute [r] claims
+      #   @return [Yt::Collections::Claims] the claims administered by the content owner.
+      has_many :claims
+
+      # @!attribute [r] assets
+      #   @return [Yt::Collection::Assets] the assets administered by the content owner.
+      has_many :assets
+
+      # @!attribute [r] references
+      #   @return [Yt::Collections::References] the references administered by the content owner.
+      has_many :references
+
+      # @!attribute [r] policies
+      #   @return [Yt::Collections::Policies] the policies saved by the content owner.
+      has_many :policies
+
+      def initialize(options = {})
+        super options
+        @owner_name = options[:owner_name]
+      end
+
+      def create_reference(params = {})
+        references.insert params
+      end
+
+      def create_asset(params = {})
+        assets.insert params
+      end
+
+      def create_claim(params = {})
+        claims.insert params
+      end
+    end
+  end
+end

data/lib/yt/models/content_owner_detail.rb

@@ -0,0 +1,18 @@
+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
+    class ContentOwnerDetail < Base
+      def initialize(options = {})
+        @data = options[:data] || {}
+      end
+
+      has_attribute :content_owner
+      has_attribute :time_linked, type: Time
+    end
+  end
+end