yt 0.32.3 → 0.33.1

data/lib/yt/collections/content_owners.rb

@@ -25,8 +25,12 @@ module Yt
       end
 
       def content_owners_params
-        {fetch_mine: true}
+        if @where_params.blank?
+          {fetch_mine: true}
+        else
+          apply_where_params! on_behalf_of_content_owner: @parent.owner_name
+        end
       end
     end
   end
-end
+end

data/lib/yt/collections/playlist_items.rb

@@ -48,6 +48,15 @@ module Yt
       def insert_parts
         {snippet: {keys: [:playlist_id, :resource_id, :position]}}
       end
+
+      # For inserting a playlist item with content owner auth.
+      # @see https://developers.google.com/youtube/v3/docs/playlistItems/insert
+      def insert_params
+        params = super
+        params[:params] ||= {}
+        params[:params].merge! @auth.insert_playlist_item_params
+        params
+      end
     end
   end
-end
+end

data/lib/yt/collections/reports.rb

@@ -6,7 +6,6 @@ module Yt
     class Reports < Base
       DIMENSIONS = Hash.new({name: 'day', parse: ->(day, *values) { @metrics.keys.zip(values.map{|v| {Date.iso8601(day) => v}}).to_h} }).tap do |hash|
         hash[:month] = {name: 'month', parse: ->(month, *values) { @metrics.keys.zip(values.map{|v| {Range.new(Date.strptime(month, '%Y-%m').beginning_of_month, Date.strptime(month, '%Y-%m').end_of_month) => v} }).to_h} }
-        hash[:week] = {name: '7DayTotals', parse: ->(last_day_of_week, *values) { @metrics.keys.zip(values.map{|v| {Range.new(Date.strptime(last_day_of_week) - 6, Date.strptime(last_day_of_week)) => v} }).to_h} }
         hash[:range] = {parse: ->(*values) { @metrics.keys.zip(values.map{|v| {total: v}}).to_h } }
         hash[:traffic_source] = {name: 'insightTrafficSourceType', parse: ->(source, *values) { @metrics.keys.zip(values.map{|v| {TRAFFIC_SOURCES.key(source) => v}}).to_h} }
         hash[:playback_location] = {name: 'insightPlaybackLocationType', parse: ->(location, *values) { @metrics.keys.zip(values.map{|v| {PLAYBACK_LOCATIONS.key(location) => v}}).to_h} }
@@ -140,11 +139,6 @@ module Yt
           end
           if dimension == :month
             hash = hash.transform_values{|h| h.sort_by{|range, v| range.first}.to_h}
-          elsif dimension == :week
-            hash = hash.transform_values do |h|
-              h.select{|range, v| range.last.wday == days_range.last.wday}.
-              sort_by{|range, v| range.first}.to_h
-            end
           elsif dimension == :day
             hash = hash.transform_values{|h| h.sort_by{|day, v| day}.to_h}
           elsif dimension.in? [:traffic_source, :country, :state, :playback_location, :device_type, :operating_system, :subscribed_status]
@@ -159,11 +153,15 @@ module Yt
       # same query is a workaround that works and can hardly cause any damage.
       # Similarly, once in while YouTube responds with a random 503 error.
       rescue Yt::Error => e
-        (max_retries > 0) && rescue?(e) ? sleep(3) && within(days_range, country, state, dimension, videos, historical, max_retries - 1) : raise
+        (max_retries > 0) && rescue?(e) ? sleep(retry_time) && within(days_range, country, state, dimension, videos, historical, max_retries - 1) : raise
       end
 
     private
 
+      def retry_time
+        3
+      end
+
       def type_cast(value, type)
         case [type]
           when [Integer] then value.to_i if value

data/lib/yt/collections/snippets.rb

@@ -24,4 +24,4 @@ module Yt
       end
     end
   end
-end
+end

data/lib/yt/config.rb

@@ -0,0 +1,54 @@
+require 'yt/models/configuration'
+
+module Yt
+  # Provides methods to read and write global configuration settings.
+  #
+  # A typical usage is to set the API keys retrieved from the
+  # {http://console.developers.google.com Google Developers Console}.
+  #
+  # @example Set the API key for a server-only YouTube app:
+  #   Yt.configure do |config|
+  #     config.api_key = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # @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
+  #
+  # Note that Yt.configure has precedence over values through with
+  # environment variables (see {Yt::Models::Configuration}).
+  #
+  module Config
+    # Yields the global configuration to the given block.
+    #
+    # @example
+    #   Yt.configure do |config|
+    #     config.api_key = 'ABCDEFGHIJ1234567890'
+    #   end
+    #
+    # @yield [Yt::Models::Configuration] The global configuration.
+    def configure
+      yield configuration if block_given?
+    end
+
+    # Returns the global {Yt::Models::Configuration} object.
+    #
+    # While this method _can_ be used to read and write configuration settings,
+    # it is easier to use {Yt::Config#configure} Yt.configure}.
+    #
+    # @example
+    #     Yt.configuration.api_key = 'ABCDEFGHIJ1234567890'
+    #
+    # @return [Yt::Models::Configuration] The global configuration.
+    def configuration
+      @configuration ||= Yt::Configuration.new
+    end
+  end
+
+  # @note Config is the only module auto-loaded in the Yt module,
+  #       in order to have a syntax as easy as Yt.configure
+
+  extend Config
+end

data/lib/yt/models/account.rb

@@ -65,7 +65,7 @@ module Yt
       # @param [Hash] params the metadata to add to the uploaded video.
       # @option params [String] :title The video’s title.
       # @option params [String] :description The video’s description.
-      # @option params [Array<String>] :title The video’s tags.
+      # @option params [Array<String>] :tags The video’s tags.
       # @option params [String] :privacy_status The video’s privacy status.
       # @return [Yt::Models::Video] the newly uploaded video.
       def upload_video(path_or_url, params = {})
@@ -192,6 +192,10 @@ module Yt
         {mine: true}
       end
 
+      def playlist_items_params
+        {}
+      end
+
       # @private
       # Tells `has_many :resumable_sessions` what path to hit to upload a file.
       def upload_path
@@ -223,6 +227,22 @@ module Yt
       def upload_content_type
         'video/*'
       end
+
+      def update_video_params
+        {}
+      end
+
+      def update_playlist_params
+        {}
+      end
+
+      def upload_thumbnail_params
+        {}
+      end
+
+      def insert_playlist_item_params
+        {}
+      end
     end
   end
 end

data/lib/yt/models/asset.rb

@@ -12,11 +12,12 @@ module Yt
         @data = options.fetch(:data, {})
         @id = options[:id]
         @auth = options[:auth]
+        @params = options[:params]
       end
 
       def update(attributes = {})
         underscore_keys! attributes
-        do_patch body: attributes
+        do_update body: attributes
         true
       end
 
@@ -34,6 +35,10 @@ module Yt
         @metadata_effective ||= Yt::Models::AssetMetadata.new data: @data.fetch('metadataEffective', {})
       end
 
+      def ownership_effective
+        @ownership_effective ||= Yt::Models::Ownership.new data: @data.fetch('ownershipEffective', {})
+      end
+
       # Soft-deletes the asset.
       # @note YouTube API does not provide a +delete+ method for the Asset
       #   resource, but only an +update+ method. Updating the +status+ of a
@@ -64,11 +69,11 @@ module Yt
       #   +'show'+, +'sound_recording'+, +'video_game'+, +'web'+.
       has_attribute :type
 
-      # @return [Array<Yt::Models::Tag>] the list of asset labels associated
+      # @return [Array<String>] the list of asset labels associated
       #   with the asset. You can apply a label to multiple assets to group
       #   them. You can use the labels as search filters to perform bulk updates,
       #   to download reports, or to filter YouTube Analytics.
-      has_attribute :label
+      has_attribute :label, default: []
 
 # Status
 
@@ -106,6 +111,24 @@ module Yt
           params[:params] = {on_behalf_of_content_owner: @auth.owner_name}
         end
       end
+
+      # @see https://developers.google.com/youtube/partner/docs/v1/assets/update
+      def update_params
+        super.tap do |params|
+          params[:expected_response] = Net::HTTPOK
+          params[:path] = "/youtube/partner/v1/assets/#{@id}"
+          params[:params] = {on_behalf_of_content_owner: @auth.owner_name}
+        end
+      end
+
+      # @return [Hash] the parameters to submit to YouTube to get an asset.
+      # @see https://developers.google.com/youtube/partner/docs/v1/assets/get
+      def get_params
+        super.tap do |params|
+          params[:path] = "/youtube/partner/v1/assets/#{@id}"
+          params[:params] = {on_behalf_of_content_owner: @auth.owner_name}.merge! @params
+        end
+      end
     end
   end
-end
+end

data/lib/yt/models/asset_metadata.rb

@@ -23,7 +23,7 @@ module Yt
       end
 
       # @return [String] A description of the asset. The description may be
-      #   displayed on YouTube or in CMS. 
+      #   displayed on YouTube or in CMS.
       def notes
         @data['notes']
       end

data/lib/yt/models/base.rb

@@ -1,6 +1,7 @@
 require 'yt/actions/delete'
 require 'yt/actions/update'
 require 'yt/actions/patch'
+require 'yt/actions/get'
 
 require 'yt/associations/has_attribute'
 require 'yt/associations/has_authentication'
@@ -17,6 +18,7 @@ module Yt
       include Actions::Delete
       include Actions::Update
       include Actions::Patch
+      include Actions::Get
 
       include Associations::HasAttribute
       extend Associations::HasReports

data/lib/yt/models/channel.rb

@@ -197,10 +197,6 @@ module Yt
       #   @return [Integer] the number of times the channel has been viewed.
       delegate :view_count, to: :statistics_set
 
-      # @!attribute [r] comment_count
-      #   @return [Integer] the number of comments for the channel.
-      delegate :comment_count, to: :statistics_set
-
       # @!attribute [r] video_count
       #   @return [Integer] the number of videos uploaded to the channel.
       delegate :video_count, to: :statistics_set
@@ -283,7 +279,8 @@ module Yt
       # @private
       # Tells `has_reports` to retrieve the reports from YouTube Analytics API
       # either as a Channel or as a Content Owner.
-      # @see https://developers.google.com/youtube/analytics/v1/reports
+      # @see https://developers.google.com/youtube/analytics/channel_reports
+      # @see https://developers.google.com/youtube/analytics/content_owner_reports
       def reports_params
         {}.tap do |params|
           if auth.owner_name

data/lib/yt/models/claim.rb

@@ -14,6 +14,17 @@ module Yt
         @asset = options[:asset] if options[:asset]
       end
 
+      # Updates the attributes of a claim.
+      # @note If you are submitting an update request, and your request does
+      #   not specify a value for a property that already has a value, the
+      #   property's existing value will be deleted.
+      # @return [Boolean] whether the claim was successfully updated.
+      def update(attributes = {})
+        underscore_keys! attributes
+        do_patch body: attributes
+        true
+      end
+
       # @!attribute [r] claim_history
       #   @return [Yt::Collections::ClaimHistories] the claim's history.
       has_one :claim_history

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_owner.rb

@@ -46,6 +46,22 @@ module Yt
         @display_name = options[:display_name]
       end
 
+      # Uploads a reference file to YouTube.
+      # @param [String] path_or_url is the video or audio file to upload. Can either be the
+      #   path of a local file or the URL of a remote file.
+      # @param [Hash] params the metadata to add to the uploaded reference.
+      # @option params [String] :asset_id The id of the asset the uploaded reference belongs to.
+      # @option params [String] :content_type The type of content being uploaded.
+      # @return [Yt::Models::Reference] the newly uploaded reference.
+      def upload_reference_file(path_or_url, params = {})
+        file = open path_or_url, 'rb'
+        session = resumable_sessions.insert file.size, params
+
+        session.update(body: file) do |data|
+          Yt::Reference.new id: data['id'], data: data, auth: self
+        end
+      end
+
       def create_reference(params = {})
         references.insert params
       end
@@ -60,6 +76,12 @@ module Yt
 
     ### PRIVATE API ###
 
+      # @private
+      # Tells `has_many :resumable_sessions` what path to hit to upload a file.
+      def upload_path
+        '/upload/youtube/partner/v1/references'
+      end
+
       # @private
       # Tells `has_many :videos` that account.videos should return all the
       # videos *on behalf of* the content owner (public, private, unlisted).
@@ -67,12 +89,39 @@ module Yt
         {for_content_owner: true, on_behalf_of_content_owner: @owner_name}
       end
 
+      # @private
+      # Tells `has_many :resumable_sessions` what params are set for the object
+      # associated to the uploaded file.
+      def upload_params
+        {part: 'snippet,status', on_behalf_of_content_owner: self.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
+
+      def playlist_items_params
+        {on_behalf_of_content_owner: @owner_name}
+      end
+
+      def update_video_params
+        {on_behalf_of_content_owner: @owner_name}
+      end
+
+      def update_playlist_params
+        {on_behalf_of_content_owner: @owner_name}
+      end
+
+      def upload_thumbnail_params
+        {on_behalf_of_content_owner: @owner_name}
+      end
+
+      def insert_playlist_item_params
+        {on_behalf_of_content_owner: @owner_name}
+      end
     end
   end
 end