yt 0.32.4 → 0.33.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60bee886ed9551a6b9590fa99ad1146472dc90d332a50854a0d7ba490b40f93
-  data.tar.gz: 72e08ae6b64e508e873a1d47f00c71e021d994bfb3bb65b2c1b52e4e6709950a
+  metadata.gz: '070338f88a83b93cdef2c6dfb529f06c15da00bbd8c6fba10f1f98689bf40c7c'
+  data.tar.gz: 298b85fb4bef72439425838c594ebf546f65cff2070d379a9b6a756ff01155fb
 SHA512:
-  metadata.gz: 87f08494b156a1846e63eff41c154cbfc462e1a65c1391bdc530ae1a84ef891150b72b0e604359a2d20d45a5fd0db88a7429c38ffa80b3a2f721b25452ebd119
-  data.tar.gz: 0453b6e46b53d2c3b2c0ffcdccd0daba325c97f96ebfacb37939172e6137c271236f94ef2fc05d25a6df3b8784c84040ab4b71064ea861b10e90e201a3198128
+  metadata.gz: 21fa9971e3d7cb96ecbe373d145c79cd8e665b2ea54acf3869674d0d4745d92e1d0cee7c34fad882670bf229a8833056cfe7bd77da60f1a7cadf4a05281c5af0
+  data.tar.gz: a26557d3e1b563f840f17f07ea6a61bb5b5820a018a2a8dcacb205cd00665304b82bce67af495177ef2c19b84734c0c8194cf7c4ae0c37d2afffe440e765d9bf

data/.rspec

@@ -1,6 +1,3 @@
---format documentation
 --color
---tag ~rate_limited
---tag ~flaky
---tag ~extended_permissions
 --exclude_pattern spec/requests/as_content_owner/*_spec.rb
+--tag=~slow

data/CHANGELOG.md

@@ -6,6 +6,47 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.33.2 - 2020-11-11
+
+* [BUGFIX] No more pages when page token is an empty string, per YouTube change.
+
+## 0.33.1 - 2020-10-19
+
+* [BUGFIX] Only retry once when exchanging a refresh token
+
+## 0.33.0 - 2020-04-10
+
+If your code calls reports methods such as `views`, `likes`, or `reports`,
+do not include `by: :week` option since `7DayTotals` dimension will no longer be
+supported by YouTube API as of [April 15, 2020](https://developers.google.com/youtube/analytics/revision_history#october-15,-2019).
+
+Use `by: :day` option instead and add up the numbers from each day.
+
+If you keep using `by: :week` option after this change it will raise an error
+(before the gem upgrade) or it will run with `day` dimension instead (after
+the gem upgrade, like any other random input).
+
+* [REMOVAL] Remove `by: :week` option for reports.
+* [FEATURE] Add back the option of initializing a resource by its URL.
+* [BUGFIX] Limit retries on refreshing tokens
+
+**Breaking change**
+
+If your code is using constant `Yt::URL::CHANNEL_PATTERNS` etc then it's moved to `Yt::Resource::CHANNEL_PATTERNS`, `Yt::Resource::VIDEO_PATTERNS`, and `Yt::Resource::PLAYLIST_PATTERNS`.
+
+## 0.32.6 - 2020-02-07
+
+* [FEATURE] Allow partnered channels to delete playlist item.
+* [FEATURE] Allow partnered channels to update video.
+* [FEATURE] Allow partnered channels to update playlist.
+* [FEATURE] Allow partnered channels to upload thumbnail.
+* [FEATURE] Allow partnered channels to create playlist item.
+
+## 0.32.5 - 2019-11-06
+
+* [BUGFIX] Fix `MatchPolicy#update` and `Asset#update` by using `PUT` instead of `PATCH`
+* Update `bin/yt` file to keep `yt info` command work
+
 ## 0.32.4 - 2019-06-26
 
 * [FEATURE] Add `ownership_effective` method to access asset ownership ("effective") via the asset object.
@@ -457,11 +498,11 @@ If your code expects reports to return results **by day** then you **must** add
 the `by: :day` option to your report method. The new default is `by: :range`.
 For instance `channel.views` would return
 
-  {Wed, 8 May 2014 => 12.4, Thu, 9 May 2014 => 3.2, Fri, 10 May 2014 => …}
+    {Wed, 8 May 2014 => 12.4, Thu, 9 May 2014 => 3.2, Fri, 10 May 2014 => …}
 
 and now returns the same as calling `channel.views by: :range`:
 
-  {total: 3450}
+    {total: 3450}
 
 Additionally, if you expect reports **by day** then you **must** specify the
 `:since` option to your report method. Previously, this value was set to

data/README.md

@@ -18,7 +18,6 @@ After [registering your app](#configuring-your-app), you can run commands like:
 channel = Yt::Channel.new id: 'UCxO1tY8h1AhOz0T4ENwmpow'
 channel.title #=> "Fullscreen"
 channel.public? #=> true
-channel.comment_count #=> 773
 channel.videos.count #=> 12
 ```
 
@@ -526,44 +525,34 @@ If a variable is set in both places, then `Yt.configure` takes precedence.
 How to test
 ===========
 
-Yt comes with two different sets of tests:
-
-1. tests in `spec/models`, `spec/collections` and `spec/errors` **do not hit** the YouTube API
-1. tests in `spec/requests` **hit** the YouTube API and require authentication
-
-To only run tests against models, collections and errors (which do not hit the API), type:
+To run tests:
 
 ```bash
-rspec spec/models spec/collections spec/errors
+rspec
 ```
 
-To also run live-tests against the YouTube API, type:
+We recommend RSpec >= 3.8.
 
-```bash
-rspec
-```
+Yt comes with two different sets of tests:
+
+1. Unit tests in `spec/models`, `spec/collections` and `spec/errors`
+2. Legacy integration tests in `spec/requests`
+
+Coming soon will be a new set of high-level integration tests.
+
+Integration tests are recorded with VCR. Some of the tests refer to
+fixture data that an arbitrary account may not have access to. If you
+need to modify one of these tests or re-record the cassette, we'd
+suggest working against your own version of the testing setup. Then in
+your pull request, we can help canonize your test/fixtures.
+
+Some of the integration tests require authentication. These can be set
+with the following environment variables:
 
-This will fail unless you have set up a test YouTube application and some
-tests YouTube accounts (with appropriate fixture data) to hit the API.
-Furthermore, tests that require authentication are divided into three
-roles, which correspond to each directory in `spec/requests`:
-
-* Account-based tests, which require a valid refresh token along with
-  the application-level credentials the refresh token was created with
-  (`YT_TEST_DEVICE_REFRESH_TOKEN`, `YT_TEST_DEVICE_CLIENT_ID`, and
-  `YT_TEST_DEVICE_CLIENT_SECRET` respectively).
-* Server application tests, which use a server API key
-  (`YT_TEST_SERVER_API_KEY`).
-* Tests that excercise YouTube's partner functionality. This requires an
-  a partner channel id (`YT_TEST_CONTENT_OWNER_NAME`), a refresh token
-  that's authenticated with that channel
-  (`YT_TEST_CONTENT_OWNER_REFRESH_TOKEN`), and the corresponding
-  application (`YT_TEST_PARTNER_CLIENT_ID` and
-  (`YT_TEST_PARTNER_CLIENT_SECRET`).
-
-The refresh tokens need to be generated with the `youtube`,
-`yt-analytics` and `userinfo.profile` permissions in order for tests to
-pass.
+* `YT_TEST_CLIENT_ID`
+* `YT_TEST_CLIENT_SECRET`
+* `YT_TEST_API_KEY`
+* `YT_TEST_REFRESH_TOKEN`
 
 How to release new versions
 ===========================

data/YOUTUBE_IT.md

@@ -141,7 +141,7 @@ client = YouTubeIt::Client.new
 client.videos_by(:query => "penguin",  :author => "liz")
 # with yt: the 'author' filter was removed from YouTube API V3, so the
 # request must be done using the channel of the requested author
-channel = Yt::Channel.new id: 'UCxxxxxxxxx'
+channel = Yt::Channel.new url: 'youtube.com/liz'
 channel.videos.where(q: 'penguin')
 ```
 
@@ -176,7 +176,7 @@ client = YouTubeIt::Client.new
 client.videos_by(:user => 'liz')
 # with yt: the 'author' filter was removed from YouTube API V3, so the
 # request must be done using the channel of the requested author
-channel = Yt::Channel.new id: 'UCxxxxxxxxx'
+channel = Yt::Channel.new url: 'youtube.com/liz'
 channel.videos.where(q: 'penguin')
 ```
 
@@ -188,7 +188,7 @@ client = YouTubeIt::Client.new
 client.videos_by(:favorites, :user => 'liz')
 # with yt: note that only *old* channels have a "Favorites" playlist, since
 # "Favorites" has been deprecated by YouTube in favor of "Liked Videos".
-channel = Yt::Channel.new id: 'UCxxxxxxxxx'
+channel = Yt::Channel.new url: 'youtube.com/liz'
 channel.related_playlists.find{|p| p.title == 'Favorites'}
 ```
 
@@ -832,4 +832,4 @@ TODO
 
  $ client.activity(user) #default current user
 
--->
+-->

data/bin/yt

@@ -8,20 +8,13 @@ rescue LoadError
 end
 
 Yt.configuration.log_level = :debug
-id = ARGV[1] || 'BPNYv0vd78A'
+id = ARGV[1] || 'rdwz7QiG0lk'
 
 case ARGV[0]
 when 'info'
   puts "Yt version #{Yt::VERSION}"
   video = Yt::Video.new id: id
-  puts video.annotations.first.text
-when 'annotations'
-  video = Yt::Video.new id: id
-  count = video.annotations.size
-  puts "Video #{id} has #{count} #{'annotation'.pluralize count}"
-  video.annotations.each.with_index do |annotation, i|
-    puts "#{i+1}) #{annotation.text}"
-  end
+  puts video.title
 when 'video'
   video = Yt::Video.new id: id
   views = "#{video.view_count} #{'view'.pluralize video.view_count}"

data/lib/yt.rb

@@ -13,7 +13,6 @@ require 'yt/models/video_group'
 require 'yt/models/comment_thread'
 require 'yt/models/ownership'
 require 'yt/models/advertising_options_set'
-require 'yt/models/url'
 
 # An object-oriented Ruby client for YouTube.
 # Helps creating applications that need to interact with YouTube objects.

data/lib/yt/actions/list.rb

@@ -75,7 +75,7 @@ module Yt
       end
 
       def more_pages?
-        @last_index.zero? || !@page_token.nil?
+        @last_index.zero? || @page_token.present?
       end
 
       def next_page

data/lib/yt/associations/has_reports.rb

@@ -10,7 +10,7 @@ module Yt
       #   @option options [Array<Symbol>] :only The metrics to generate reports
       #     for.
       #   @option options [Symbol] :by (:day) The dimension to collect metrics
-      #     by. Accepted values are: +:day+, +:week+, +:month+.
+      #     by. Accepted values are: +:day+, +:month+.
       #   @option options [#to_date] :since The first day of the time-range.
       #     Also aliased as +:from+.
       #   @option options [#to_date] :until The last day of the time-range.
@@ -40,11 +40,6 @@ module Yt
       #   @example Get the $1 for this and last month:
       #     resource.$1 since: 1.month.ago, by: :month
       #     # => {Wed, 01 Apr 2014..Thu, 30 Apr 2014 => 12.0, Fri, 01 May 2014..Sun, 31 May 2014 => 34.0, …}
-      #   @return [Hash<Range<Date, Date>, $2>] if grouped by week, the $1
-      #     for each week in the time-range.
-      #   @example Get the $1 for this and last week:
-      #     resource.$1 since: 1.week.ago, by: :week
-      #     # => {Wed, 01 Apr 2014..Tue, 07 Apr 2014 => 20.0, Wed, 08 Apr 2014..Tue, 14 Apr 2014 => 13.0, …}
       #   @macro report
 
       # @!macro [new] report_with_range
@@ -75,19 +70,19 @@ module Yt
 
       # @!macro [new] report_by_day
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:week+, +:month+.
+      #     Accepted values are: +:day+, +:month+.
       #   @macro report_with_day
 
       # @!macro [new] report_by_day_and_country
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:week+, +:month+, :+range+.
+      #     Accepted values are: +:day+, +:month+, :+range+.
       #   @macro report_with_day
       #   @macro report_with_range
       #   @macro report_with_country
 
       # @!macro [new] report_by_day_and_state
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:week+, +:month+, :+range+.
+      #     Accepted values are: +:day+, +:month+, :+range+.
       #   @macro report_with_day
       #   @macro report_with_range
       #   @macro report_with_country_and_state
@@ -128,7 +123,7 @@ module Yt
 
       # @!macro [new] report_by_video_dimensions
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:week+, +:month+, +:range+,
+      #     Accepted values are: +:day+, +:month+, +:range+,
       #     +:traffic_source+,+:search_term+, +:playback_location+,
       #     +:related_video+, +:embedded_player_location+.
       #   @option options [Array<Symbol>] :includes ([:id]) if grouped by
@@ -162,7 +157,7 @@ module Yt
 
       # @!macro [new] report_by_channel_dimensions
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:week+, +:month+, +:range+,
+      #     Accepted values are: +:day+, +:month+, +:range+,
       #     +:traffic_source+, +:search_term+, +:playback_location+, +:video+,
       #     +:related_video+, +:playlist+, +:embedded_player_location+.
       #   @return [Hash<Symbol, $2>] if grouped by embedded player location,
@@ -175,7 +170,7 @@ module Yt
 
       # @!macro [new] report_by_playlist_dimensions
       #   @option options [Symbol] :by (:day) The dimension to collect $1 by.
-      #     Accepted values are: +:day+, +:week+, +:month+, +:range+,
+      #     Accepted values are: +:day+, +:month+, +:range+,
       #     +:traffic_source+, +:playback_location+, +:related_video+, +:video+,
       #     +:playlist+.
       #   @macro report_with_channel_dimensions
@@ -228,7 +223,7 @@ module Yt
       def define_reports_method(metric, type)
         (@metrics ||= {})[metric] = type
         define_method :reports do |options = {}|
-          from = options[:since] || options[:from] || (options[:by].in?([:day, :week, :month]) ? 5.days.ago : '2005-02-01')
+          from = options[:since] || options[:from] || (options[:by].in?([:day, :month]) ? 5.days.ago : '2005-02-01')
           to = options[:until] || options[:to] || Date.today
           location = options[:in]
           country = location.is_a?(Hash) ? location[:country] : location
@@ -252,7 +247,7 @@ module Yt
 
       def define_metric_method(metric)
         define_method metric do |options = {}|
-          from = options[:since] || options[:from] || (options[:by].in?([:day, :week, :month]) ? 5.days.ago : '2005-02-01')
+          from = options[:since] || options[:from] || (options[:by].in?([:day, :month]) ? 5.days.ago : '2005-02-01')
           to = options[:until] || options[:to] || Date.today
           location = options[:in]
           country = location.is_a?(Hash) ? location[:country] : location

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/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

@@ -17,7 +17,7 @@ module Yt
 
       def update(attributes = {})
         underscore_keys! attributes
-        do_patch body: attributes
+        do_update body: attributes
         true
       end
 
@@ -112,6 +112,15 @@ module Yt
         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

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