yt 0.32.3 → 0.33.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13d05d40be2a978569b4d9d95088169b27efbca654c6ac31e8cc80d404a2ccc3
-  data.tar.gz: 5ac7a2bf2c181a01f4f94af8399e1b5896160f4f60964cc8f12f02ab61688e5f
+  metadata.gz: 94422f128aee1411a90f1fcb39a28ef13afa5f456bf15e9722eddcc3139a46c0
+  data.tar.gz: a8ee06716cc4018e217da1eb98ec416511e00f6f760f88cd11ab2b7f24dd6f24
 SHA512:
-  metadata.gz: fc36a64935d1888ee29a6e93bf076a020d249598564117ad8da8df71eadefd4c0030ccb9f213ef9537f2a7f4428d2a37084b8e72126a7ac2c8e4e00772fc818c
-  data.tar.gz: 7442494554ac18854f428149a591cf4f36eacce42b0c9f78053f2ff4cad792bb99f95bb1bfd963c49b5046357515ebd28fe67ecac62338999e933a1e8cfed289
+  metadata.gz: 28cab7081f268473eca6e3165389bd40411955dbc96046e6523bf87b9de1b3e216d121fdfb68dd474bc354fc7c3591bd2c395a03d1baa0d43e5c4e9372b346b3
+  data.tar.gz: 98454281ad9a072638d3a3a2f28d58ab8435258d55c2c167d3ff8dd6b89daf225e2d10dc0d473f3ecece6e9cd2205d1ab9c8957eeb15faf6b8c7ed52209b4966

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
 --color
---fail-fast
+--exclude_pattern spec/requests/as_content_owner/*_spec.rb
+--tag=~slow

data/.travis.yml

@@ -3,7 +3,5 @@ notifications:
   email: true
 matrix:
   include:
-  - rvm: 1.9.3
-    gemfile: gemfiles/Gemfile.activesupport-3.x
-  - rvm: 2.0.0
-    gemfile: gemfiles/Gemfile.activesupport-4.x
+  - rvm: 2.6.3
+    gemfile: gemfiles/Gemfile.activesupport-4.x

data/CHANGELOG.md

@@ -6,6 +6,52 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.33.0 - 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.
+* [FEATURE] List content owners of others with `content_owner.content_owners`
+* [FEATURE] Add `match_info` to insert claim request.
+* [FEATURE] Add `upload_reference_file` method for Reference file upload (thank you @jcohenho)
+* [FEATURE] Get one asset [by request](https://developers.google.com/youtube/partner/docs/v1/assets/get) (thank you @jcohenho)
+* [FEATURE] Add `update` method to Yt::Claim (thank you @jcohenho)
+
 ## 0.32.3 - 2019-03-15
 
 * [ENHANCEMENT] Add `Yt::URL` to get id, kind, and its resource (channel, video, playlist)
@@ -448,11 +494,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

@@ -8,7 +8,7 @@ The **source code** is available on [GitHub](https://github.com/Fullscreen/yt) a
 [![Build Status](http://img.shields.io/travis/Fullscreen/yt/master.svg)](https://travis-ci.org/Fullscreen/yt)
 [![Coverage Status](http://img.shields.io/coveralls/Fullscreen/yt/master.svg)](https://coveralls.io/r/Fullscreen/yt)
 [![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/yt.svg)](https://gemnasium.com/Fullscreen/yt)
-[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/yt.svg)](https://codeclimate.com/github/Fullscreen/yt)
+[![Code Climate](https://codeclimate.com/github/Fullscreen/yt.png)](https://codeclimate.com/github/Fullscreen/yt)
 [![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/yt/frames)
 [![Gem Version](http://img.shields.io/gem/v/yt.svg)](http://rubygems.org/gems/yt)
 
@@ -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
 ```
 
@@ -44,7 +43,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'yt', '~> 0.28.0'
+    gem 'yt', '~> 0.32.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
@@ -266,6 +265,11 @@ asset = content_owner.assets.where(id: 'A969176766549462', fetch_metadata: 'effe
 asset.metadata_effective.title #=> "Neu la anh" (different due to ownership conflicts)
 ```
 
+```ruby
+asset = content_owner.assets.where(id: 'A125058570526569', fetch_ownership: 'effective').first
+asset.ownership_effective.general_owners.first.owner # => "XOuN81q-MeEUVrsiZeK1lQ"
+```
+
 * to search for an asset
 
 ```ruby
@@ -295,6 +299,32 @@ claim.claim_history #=> #<Yt::Models::ClaimHistory ...>
 claim.claim_history.events[0].type #=> "claim_create"
 
 claim.delete #=> true
+
+data = {
+  is_manual_claim: true,
+  content_type: 'audiovisual',
+  asset_id: 'A123123123123123',
+  policy: { id: 'S123123123123123' },
+  video_id: 'myvIdeoIdYT',
+  match_info: {
+    match_segments: [
+      {
+        manual_segment: {
+          start: '00:00:20.000',
+          finish: '00:01:20.000'
+        }
+      },
+      {
+        manual_segment: {
+          start: '00:02:30.000',
+          finish: '00:03:50.000'
+        }
+      }
+    ]
+  }
+}
+
+content_owner.claims.insert(data)
 ```
 
 *The methods above require to be authenticated as the video’s content owner (see below).*
@@ -492,55 +522,37 @@ end
 so use the approach that you prefer.
 If a variable is set in both places, then `Yt.configure` takes precedence.
 
-Why you should use Yt…
-======================
-
-… and not [youtube_it](https://github.com/kylejginavan/youtube_it)?
-Because youtube_it does not support YouTube API V3, and the YouTube API V2 has
-been [officially deprecated as of March 4, 2014](https://developers.google.com/youtube/2.0/developers_guide_protocol_audience).
-If you need help upgrading your code, check [YOUTUBE_IT.md](https://github.com/Fullscreen/yt/blob/master/YOUTUBE_IT.md),
-a step-by-step comparison between youtube_it and Yt to make upgrade easier.
-
-… and not [Google Api Client](https://github.com/google/google-api-ruby-client)?
-Because Google Api Client is poorly coded, poorly documented and adds many
-dependencies, bloating the size of your project.
-
-… and not your own code? Because Yt is fully tested, well documented,
-has few dependencies and helps you forget about the burden of dealing with
-Google API!
-
 How to test
 ===========
 
-Yt comes with two different sets of tests:
+To run 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
+```bash
+rspec
+```
 
-The reason why some tests actually hit the YouTube API is because they are
-meant to really integrate Yt with YouTube. YouTube API is not exactly
-*the most reliable* API out there, so we need to make sure that the responses
-match the documentation.
+We recommend RSpec >= 3.8.
 
-You don’t have to run all the tests every time you change code.
-Travis CI is already set up to do this for when whenever you push a branch
-or create a pull request for this project.
+Yt comes with two different sets of tests:
 
-To only run tests against models, collections and errors (which do not hit the API), type:
+1. Unit tests in `spec/models`, `spec/collections` and `spec/errors`
+2. Legacy integration tests in `spec/requests`
 
-```bash
-rspec spec/models spec/collections spec/errors
-```
+Coming soon will be a new set of high-level integration tests.
 
-To also run live-tests against the YouTube API, type:
+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.
 
-```bash
-rspec
-```
+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 to hit the API. Once again, you probably don’t need
-this, since Travis CI already takes care of running this kind of tests.
+* `YT_TEST_CLIENT_ID`
+* `YT_TEST_CLIENT_SECRET`
+* `YT_TEST_API_KEY`
+* `YT_TEST_REFRESH_TOKEN`
 
 How to release new versions
 ===========================
@@ -568,3 +580,4 @@ the [YouTube Analytics API](https://developers.google.com/youtube/analytics).
 If you find that a method is missing, fork the project, add the missing code,
 write the appropriate tests, then submit a pull request, and it will gladly
 be merged!
+

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/get.rb

@@ -0,0 +1,33 @@
+require 'yt/request'
+
+module Yt
+  module Actions
+    module Get
+      include Base
+
+      def get
+        response = get_request(get_params).run
+        @data.merge! response.body
+        self
+      end
+
+    private
+
+      def get_request(params = {})
+        @list_request = Yt::Request.new(params).tap do |request|
+          print "#{request.as_curl}\n" if Yt.configuration.developing?
+        end
+      end
+
+      def get_params
+        {}.tap do |params|
+          params[:method] = :get
+          params[:host] = 'www.googleapis.com'
+          params[:auth] = @auth
+          params[:exptected_response] = Net::HTTPOK
+          params[:api_key] = Yt.configuration.api_key if Yt.configuration.api_key
+        end
+      end
+    end
+  end
+end

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/claims.rb

@@ -11,6 +11,7 @@ module Yt
         underscore_keys! attributes
         body = attributes.slice :asset_id, :video_id, :content_type, :policy
         body[:policy] = {id: attributes[:policy_id]} if attributes[:policy_id]
+        body[:match_info] = match_attributes(attributes[:match_info]) if attributes[:match_info]
         params = attributes.slice(:is_manual_claim).merge({on_behalf_of_content_owner: @auth.owner_name})
         do_insert(params: params, body: body)
       end
@@ -38,6 +39,13 @@ module Yt
         super
       end
 
+      def match_attributes(attributes = {})
+        segments = attributes[:match_segments].map do |segment|
+          { manual_segment: (segment[:manual_segment] || segment).slice(:start, :finish) }
+        end
+        { matchSegments: segments }
+      end
+
       # @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