yt-andrewroth 0.25.5.1

data/lib/yt/collections/advertising_options_sets.rb

@@ -0,0 +1,34 @@
+require 'yt/collections/resources'
+require 'yt/models/advertising_options_set'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a the advertising options of a YouTube video.
+    #
+    # Resources with advertising options are: {Yt::Models::Video videos}.
+    class AdvertisingOptionsSets < Resources
+
+    private
+
+      def attributes_for_new_item(data)
+        {data: data, video_id: @parent.id, auth: @auth}
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get video advertising options.
+      # @see https://developers.google.com/youtube/partner/docs/v1/videoAdvertisingOptions/get
+      def list_params
+        super.tap do |params|
+          params[:path] = "/youtube/partner/v1/videoAdvertisingOptions/#{@parent.id}"
+          params[:params] = {on_behalf_of_content_owner: @auth.owner_name}
+        end
+      end
+
+      # @private
+      # @note AdvertisingOptionsSets overwrites +fetch_page+ since it’s a get.
+      def fetch_page(params = {})
+        response = list_request(params).run
+        {items: [response.body], token: nil}
+      end
+    end
+  end
+end

data/lib/yt/collections/annotations.rb

@@ -0,0 +1,62 @@
+require 'yt/collections/base'
+require 'yt/models/annotation'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a collection of YouTube annotations.
+    #
+    # Resources with annotations are: {Yt::Models::Video videos}.
+    # @note Since there is no (authenticable) API endpoint to retrieve
+    #   annotations, only annotations of public videos can be retrieved.
+    class Annotations < Base
+
+    private
+
+      # @return [Hash] the parameters to submit to YouTube to list annotations.
+      # @note YouTube does not provide an API endpoint to get annotations for
+      #   a video, so we use an "old-style" URL that YouTube still maintains.
+      def list_params
+        super.tap do |params|
+          params[:response_format] = :xml
+          params[:host] = 'www.youtube.com'
+          params[:path] = '/annotations_invideo'
+          params[:params] = {video_id: @parent.id}
+          params[:camelize_params] = false
+          params[:expected_response] = Net::HTTPOK
+        end
+      end
+
+      # @private
+      # @note Annotations overwrites +next_page+ since the list of annotations
+      #   is not paginated API-style, but in its own custom way.
+      def next_page
+        request = Yt::Request.new(list_params).tap do |request|
+          print "#{request.as_curl}\n" if Yt.configuration.developing?
+        end
+        response = request.run
+        @page_token = nil
+
+        document = response.body.fetch('document', {})['annotations'] || {}
+        Array.wrap document.fetch 'annotation', []
+      rescue Yt::Error => error
+        expected?(error) ? [] : raise(error)
+      end
+
+      # @private
+      # @note Annotations overwrites +total_results+ since `items_key` is
+      #   not `items` for annotations.
+      # @todo Remove this function by extracting the keys used by annotations
+      #   in a method and reusing them both in `next_page` and `total_results`.
+      def total_results
+        count
+      end
+
+      # Since there is no API endpoint, retrieving annotations of unknown
+      # videos or of private videos (to which YouTube responds with 403)
+      # should not raise an error, but simply not return any annotation.
+      def expected?(error)
+        error.is_a? Yt::Errors::Forbidden
+      end
+    end
+  end
+end

data/lib/yt/collections/assets.rb

@@ -0,0 +1,58 @@
+require 'yt/collections/base'
+require 'yt/models/asset'
+require 'yt/models/asset_snippet'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a collection of Content ID assets.
+    #
+    # Resources with assets are: {Yt::Models::ContentOwner content owners}.
+    class Assets < Base
+      def insert(attributes = {})
+        params = {on_behalf_of_content_owner: @auth.owner_name}
+        do_insert(params: params, body: attributes)
+      end
+
+    private
+
+      def new_item(data)
+        klass = (data["kind"] == "youtubePartner#assetSnippet") ? Yt::AssetSnippet : Yt::Asset
+        klass.new attributes_for_new_item(data)
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to list assets
+      #   owned by the content owner.
+      # @see https://developers.google.com/youtube/partner/docs/v1/assets/list
+      def list_params
+        super.tap do |params|
+          params[:path] = assets_path
+          params[:params] = assets_params
+        end
+      end
+
+      def assets_params
+        apply_where_params! on_behalf_of_content_owner: @auth.owner_name
+      end
+
+      # @private
+      # @todo: This is one of three places outside of base.rb where @where_params
+      #   is accessed; it should be replaced with a filter on params instead.
+      def assets_path
+        @where_params ||= {}
+        if @where_params.empty? || @where_params.key?(:id)
+          '/youtube/partner/v1/assets'
+        else
+          '/youtube/partner/v1/assetSearch'
+        end
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to add a asset.
+      # @see https://developers.google.com/youtube/partner/docs/v1/assets/insert
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/partner/v1/assets'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/authentications.rb

@@ -0,0 +1,47 @@
+require 'yt/collections/base'
+require 'yt/models/authentication'
+
+module Yt
+  module Collections
+    # @private
+    class Authentications < Base
+      attr_accessor :auth_params
+
+    private
+
+      def attributes_for_new_item(data)
+        data['refresh_token'] ||= auth_params[:refresh_token]
+        data
+      end
+
+      def list_params
+        super.tap do |params|
+          params[:host] = 'accounts.google.com'
+          params[:path] = '/o/oauth2/token'
+          params[:request_format] = :form
+          params[:method] = :post
+          params[:auth] = nil
+          params[:body] = auth_params
+          params[:camelize_body] = false
+        end
+      end
+
+      def more_pages?
+        auth_params.values.all?
+      end
+
+      def next_page
+        request = Yt::Request.new(list_params).tap do |request|
+          print "#{request.as_curl}\n" if Yt.configuration.developing?
+        end
+        Array.wrap request.run.body
+      rescue Yt::Error => error
+        expected?(error) ? [] : raise(error)
+      end
+
+      def expected?(error)
+        error.kind == 'invalid_grant'
+      end
+    end
+  end
+end

data/lib/yt/collections/base.rb

@@ -0,0 +1,62 @@
+require 'yt/actions/delete_all'
+require 'yt/actions/insert'
+require 'yt/actions/list'
+require 'yt/errors/request_error'
+
+module Yt
+  module Collections
+    class Base
+      include Actions::DeleteAll
+      include Actions::Insert
+      include Actions::List
+
+      def initialize(options = {})
+        @parent = options[:parent]
+        @auth = options[:auth]
+      end
+
+      def self.of(parent)
+        new parent: parent, auth: parent.auth
+      end
+
+      # Adds requirements to the collection in order to limit the result of
+      # List methods to only items that match the requirements.
+      #
+      # Under the hood, all the requirements are passed to the YouTube API
+      # as query parameters, after transforming the keys to camel-case.
+      #
+      # To know which requirements are available for each collection, check
+      # the documentation of the corresponding YouTube API endpoint.
+      # For instance the list of valid requirements to filter a list of videos
+      # are at https://developers.google.com/youtube/v3/docs/search/list
+      #
+      # @example Return the first video of a channel (no requirements):
+      #   video.channels.first
+      # @example Return the first long video of a channel by video count:
+      #   video.channels.where(order: 'viewCount', video_duration: 'long').first
+      def where(requirements = {})
+        self.tap do
+          @items = []
+          @where_params = requirements
+        end
+      end
+
+      def includes(*relationships)
+        self.tap do
+          @items = []
+          @included_relationships = relationships
+        end
+      end
+
+    private
+
+      def apply_where_params!(params = {})
+        params.merge!(@where_params ||= {})
+      end
+
+      def included_relationships
+        @included_relationships || []
+      end
+    end
+  end
+end

data/lib/yt/collections/channels.rb

@@ -0,0 +1,31 @@
+require 'yt/collections/resources'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a collection of YouTube channels.
+    #
+    # Resources with channels are: {Yt::Models::Account accounts}.
+    class Channels < Resources
+
+    private
+
+      def attributes_for_new_item(data)
+        super(data).tap do |attributes|
+          attributes[:statistics] = data['statistics']
+        end
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to list channels.
+      # @see https://developers.google.com/youtube/v3/docs/channels/list
+      def list_params
+        super.tap{|params| params[:params] = channels_params}
+      end
+
+      def channels_params
+        params = resources_params
+        params.merge! mine: true if @parent
+        apply_where_params! params
+      end
+    end
+  end
+end

data/lib/yt/collections/claim_histories.rb

@@ -0,0 +1,34 @@
+require 'yt/collections/resources'
+require 'yt/models/claim'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a the claim history options of a YouTube claim.
+    #
+    # Resources with claim history are: {Yt::Models::Claim claims}.
+    class ClaimHistories < Resources
+
+    private
+
+      def attributes_for_new_item(data)
+        {data: data, id: @parent.id, auth: @auth}
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get claim history.
+      # @see https://developers.google.com/youtube/partner/docs/v1/claimHistory/get
+      def list_params
+        super.tap do |params|
+          params[:path] = "/youtube/partner/v1/claimHistory/#{@parent.id}"
+          params[:params] = {on_behalf_of_content_owner: @auth.owner_name}
+        end
+      end
+
+      # @private
+      # @note ClaimHistories overwrites +fetch_page+ since it’s a get.
+      def fetch_page(params = {})
+        response = list_request(params).run
+        {items: [response.body], token: nil}
+      end
+    end
+  end
+end

data/lib/yt/collections/claims.rb

@@ -0,0 +1,56 @@
+require 'yt/collections/base'
+require 'yt/models/claim'
+
+module Yt
+  module Collections
+    # Provides methods to interact with a collection of Content ID claims.
+    #
+    # Resources with claims are: {Yt::Models::ContentOwner content owners}.
+    class Claims < Base
+      def insert(attributes = {})
+        underscore_keys! attributes
+        body = attributes.slice :asset_id, :video_id, :content_type, :policy
+        body[:policy] = {id: attributes[:policy_id]} if attributes[:policy_id]
+        params = attributes.slice(:is_manual_claim).merge({on_behalf_of_content_owner: @auth.owner_name})
+        do_insert(params: params, body: body)
+      end
+
+    private
+
+      # @return [Hash] the parameters to submit to YouTube to list claims
+      #   administered by the content owner.
+      # @see https://developers.google.com/youtube/partner/docs/v1/claims/list
+      # @see https://developers.google.com/youtube/partner/docs/v1/claimSearch/list
+      def list_params
+        super.tap do |params|
+          params[:path] = claims_path
+          params[:params] = claims_params
+        end
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to add a claim.
+      # @see https://developers.google.com/youtube/partner/docs/v1/claims/insert
+      def insert_params
+        super.tap do |params|
+          params[:path] = '/youtube/partner/v1/claims'
+        end
+      end
+
+      def claims_params
+        apply_where_params! on_behalf_of_content_owner: @parent.owner_name
+      end
+
+      # @private
+      # @todo: This is one of three places outside of base.rb where @where_params
+      #   is accessed; it should be replaced with a filter on params instead.
+      def claims_path
+        @where_params ||= {}
+        if @where_params.empty? || @where_params.key?(:id)
+          '/youtube/partner/v1/claims'
+        else
+          '/youtube/partner/v1/claimSearch'
+        end
+      end
+    end
+  end
+end

data/lib/yt/collections/content_details.rb

@@ -0,0 +1,30 @@
+require 'yt/collections/base'
+require 'yt/models/content_detail'
+
+module Yt
+  module Collections
+    # @private
+    class ContentDetails < Base
+
+    private
+
+      def attributes_for_new_item(data)
+        {data: data['contentDetails']}
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get the
+      #   content detail of a resource, for instance a video.
+      # @see https://developers.google.com/youtube/v3/docs/videos#resource
+      def list_params
+        super.tap do |params|
+          params[:params] = content_details_params
+          params[:path] = '/youtube/v3/videos'
+        end
+      end
+
+      def content_details_params
+        {max_results: 50, part: 'contentDetails', id: @parent.id}
+      end
+    end
+  end
+end

data/lib/yt/collections/content_owner_details.rb

@@ -0,0 +1,34 @@
+require 'yt/collections/base'
+require 'yt/models/content_owner_detail'
+
+module Yt
+  module Collections
+    # @private
+    class ContentOwnerDetails < Base
+
+    private
+
+      def attributes_for_new_item(data)
+        {data: data['contentOwnerDetails']}
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get the
+      #   content owner detail of a channel.
+      # @see https://developers.google.com/youtube/v3/docs/channels#contentOwnerDetails
+      def list_params
+        super.tap do |params|
+          params[:params] = content_owner_details_params
+          params[:path] = '/youtube/v3/channels'
+        end
+      end
+
+      def content_owner_details_params
+        @parent.content_owner_details_params.tap do |params|
+          params[:max_results] = 50
+          params[:part] = 'contentOwnerDetails'
+          params[:id] = @parent.id
+        end
+      end
+    end
+  end
+end